GCC Middle and Back End API Reference
Public Member Functions | Protected Member Functions | Protected Attributes
diagnostic_output_format Class Referenceabstract

#include <diagnostic-format.h>

Inheritance diagram for diagnostic_output_format:
Inheritance graph
[legend]
Collaboration diagram for diagnostic_output_format:
Collaboration graph
[legend]

Public Member Functions

virtual ~diagnostic_output_format ()
 
virtual void dump (FILE *out, int indent) const
 
virtual std::unique_ptr< diagnostic_per_format_buffer > make_per_format_buffer ()=0
 
virtual void set_buffer (diagnostic_per_format_buffer *)=0
 
virtual void on_begin_group ()=0
 
virtual void on_end_group ()=0
 
virtual void on_report_diagnostic (const diagnostic_info &, diagnostic_t orig_diag_kind)=0
 
virtual void on_report_verbatim (text_info &)
 
virtual void on_diagram (const diagnostic_diagram &diagram)=0
 
virtual void after_diagnostic (const diagnostic_info &)=0
 
virtual bool machine_readable_stderr_p () const =0
 
virtual bool follows_reference_printer_p () const =0
 
virtual void update_printer ()=0
 
diagnostic_context & get_context () const
 
pretty_printer * get_printer () const
 
text_art::theme * get_diagram_theme () const
 
void DEBUG_FUNCTION dump () const
 

Protected Member Functions

 diagnostic_output_format (diagnostic_context &context)
 

Protected Attributes

diagnostic_context & m_context
 
std::unique_ptr< pretty_printer > m_printer
 

Detailed Description

Abstract base class for a particular output format for diagnostics;
each value of -fdiagnostics-output-format= will have its own
implementation.

Constructor & Destructor Documentation

◆ ~diagnostic_output_format()

virtual diagnostic_output_format::~diagnostic_output_format ( )
inlinevirtual

◆ diagnostic_output_format()

diagnostic_output_format::diagnostic_output_format ( diagnostic_context & context)
inlineprotected

References m_context, and m_printer.

Referenced by diagnostic_text_output_format::diagnostic_text_output_format(), json_output_format::json_output_format(), and sarif_output_format::sarif_output_format().

Member Function Documentation

◆ after_diagnostic()

virtual void diagnostic_output_format::after_diagnostic ( const diagnostic_info & )
pure virtual

Implemented in diagnostic_text_output_format, json_output_format, and sarif_output_format.

◆ dump() [1/2]

void DEBUG_FUNCTION diagnostic_output_format::dump ( ) const
inline

References DEBUG_FUNCTION, and dump().

Referenced by dump(), diagnostic_text_output_format::dump(), json_output_format::dump(), sarif_file_output_format::dump(), and sarif_output_format::dump().

◆ dump() [2/2]

void diagnostic_output_format::dump ( FILE * out,
int indent ) const
virtual

Reimplemented in diagnostic_text_output_format, json_output_format, sarif_file_output_format, and sarif_output_format.

References m_printer.

◆ follows_reference_printer_p()

virtual bool diagnostic_output_format::follows_reference_printer_p ( ) const
pure virtual

Implemented in diagnostic_text_output_format, json_output_format, and sarif_output_format.

◆ get_context()

diagnostic_context & diagnostic_output_format::get_context ( ) const
inline

References m_context.

Referenced by diagnostic_text_output_format::append_note(), diagnostic_text_output_format::build_indent_prefix(), diagnostic_text_output_format::build_prefix(), default_diagnostic_text_finalizer(), diagnostic_text_output_format::get_location_text(), lhd_print_error_function(), diagnostic_text_output_format::on_report_diagnostic(), diagnostic_text_output_format::print_path(), diagnostic_text_output_format::show_column_p(), and diagnostic_text_output_format::update_printer().

◆ get_diagram_theme()

text_art::theme * diagnostic_output_format::get_diagram_theme ( ) const
inline

References m_context.

◆ get_printer()

pretty_printer * diagnostic_output_format::get_printer ( ) const
inline

References m_printer.

Referenced by diagnostic_text_output_format::append_note(), diagnostic_text_output_format::build_prefix(), default_diagnostic_text_finalizer(), default_diagnostic_text_starter(), default_tree_diagnostic_text_starter(), diagnostic_text_output_format::file_name_as_prefix(), diagnostic_text_output_format::get_location_text(), lhd_print_error_function(), sarif_builder::make_location_object(), diagnostic_text_output_format::on_diagram(), diagnostic_text_output_format::on_report_diagnostic(), json_output_format::on_report_diagnostic(), diagnostic_text_output_format::on_report_verbatim(), diagnostic_text_output_format::print_any_cwe(), diagnostic_text_output_format::print_any_rules(), diagnostic_text_output_format::print_option_information(), diagnostic_text_output_format::print_path(), diagnostic_text_output_format::report_current_module(), sarif_output_format::sarif_output_format(), diagnostic_text_output_format::set_buffer(), diagnostic_text_sink::text_starter(), sarif_output_format::update_printer(), and diagnostic_text_output_format::~diagnostic_text_output_format().

◆ machine_readable_stderr_p()

virtual bool diagnostic_output_format::machine_readable_stderr_p ( ) const
pure virtual

Implemented in diagnostic_text_output_format, json_file_output_format, json_stderr_output_format, sarif_file_output_format, and sarif_stream_output_format.

◆ make_per_format_buffer()

virtual std::unique_ptr< diagnostic_per_format_buffer > diagnostic_output_format::make_per_format_buffer ( )
pure virtual

Implemented in diagnostic_text_output_format, json_output_format, and sarif_output_format.

◆ on_begin_group()

virtual void diagnostic_output_format::on_begin_group ( )
pure virtual

Implemented in diagnostic_text_output_format, json_output_format, and sarif_output_format.

◆ on_diagram()

virtual void diagnostic_output_format::on_diagram ( const diagnostic_diagram & diagram)
pure virtual

Implemented in diagnostic_text_output_format, json_output_format, and sarif_output_format.

◆ on_end_group()

virtual void diagnostic_output_format::on_end_group ( )
pure virtual

Implemented in diagnostic_text_output_format, json_output_format, and sarif_output_format.

◆ on_report_diagnostic()

virtual void diagnostic_output_format::on_report_diagnostic ( const diagnostic_info & ,
diagnostic_t orig_diag_kind )
pure virtual

Implemented in diagnostic_text_output_format, json_output_format, and sarif_output_format.

◆ on_report_verbatim()

void diagnostic_output_format::on_report_verbatim ( text_info & )
virtual

Reimplemented in diagnostic_text_output_format.

◆ set_buffer()

virtual void diagnostic_output_format::set_buffer ( diagnostic_per_format_buffer * )
pure virtual

Implemented in diagnostic_text_output_format, json_output_format, and sarif_output_format.

◆ update_printer()

virtual void diagnostic_output_format::update_printer ( )
pure virtual

Implemented in diagnostic_text_output_format, json_output_format, and sarif_output_format.

Field Documentation

◆ m_context

diagnostic_context& diagnostic_output_format::m_context
protected

Referenced by diagnostic_output_format(), get_context(), get_diagram_theme(), diagnostic_text_output_format::on_report_diagnostic(), json_output_format::on_report_diagnostic(), diagnostic_text_output_format::print_option_information(), json_output_format::update_printer(), sarif_output_format::update_printer(), and diagnostic_text_output_format::~diagnostic_text_output_format().

◆ m_printer

std::unique_ptr<pretty_printer> diagnostic_output_format::m_printer
protected

Referenced by diagnostic_output_format(), dump(), get_printer(), diagnostic_text_output_format::update_printer(), json_output_format::update_printer(), and sarif_output_format::update_printer().

The documentation for this class was generated from the following files: