GCC Middle and Back End API Reference
sarif_output_format Class Referenceabstract
Inheritance diagram for sarif_output_format:
Inheritance graph
[legend]
Collaboration diagram for sarif_output_format:
Collaboration graph
[legend]

Public Member Functions

 ~sarif_output_format ()
void dump (FILE *out, int indent) const override
void set_main_input_filename (const char *name) final override
std::unique_ptr< diagnostic_per_format_buffer > make_per_format_buffer () final override
void set_buffer (diagnostic_per_format_buffer *base_buffer) final override
bool follows_reference_printer_p () const final override
void update_printer () final override
void on_begin_group () final override
void on_end_group () final override
void on_report_diagnostic (const diagnostic_info &diagnostic, diagnostic_t orig_diag_kind) final override
void on_diagram (const diagnostic_diagram &diagram) final override
void after_diagnostic (const diagnostic_info &) final override
sarif_builder & get_builder ()
size_t num_results () const
sarif_result & get_result (size_t idx)
void DEBUG_FUNCTION dump () const
virtual void on_report_verbatim (text_info &)
virtual bool machine_readable_stderr_p () const =0
diagnostic_context & get_context () const
pretty_printer * get_printer () const
text_art::theme * get_diagram_theme () const

Protected Member Functions

 sarif_output_format (diagnostic_context &context, const line_maps *line_maps, std::unique_ptr< sarif_serialization_format > serialization_format, const sarif_generation_options &sarif_gen_opts)

Protected Attributes

sarif_builder m_builder
diagnostic_sarif_format_buffer * m_buffer
diagnostic_context & m_context
std::unique_ptr< pretty_printer > m_printer

Constructor & Destructor Documentation

◆ ~sarif_output_format()

sarif_output_format::~sarif_output_format ( )
inline

References gcc_assert, and m_builder.

◆ sarif_output_format()

sarif_output_format::sarif_output_format ( diagnostic_context & context,
const line_maps * line_maps,
std::unique_ptr< sarif_serialization_format > serialization_format,
const sarif_generation_options & sarif_gen_opts )
inlineprotected

References diagnostic_output_format::diagnostic_output_format(), diagnostic_output_format::get_printer(), m_buffer, and m_builder.

Referenced by sarif_file_output_format::sarif_file_output_format(), and sarif_stream_output_format::sarif_stream_output_format().

Member Function Documentation

◆ after_diagnostic()

void sarif_output_format::after_diagnostic ( const diagnostic_info & )
inlinefinaloverridevirtual

Implements diagnostic_output_format.

◆ dump() [1/2]

void DEBUG_FUNCTION diagnostic_output_format::dump ( ) const
inlineinherited

References DEBUG_FUNCTION, and dump().

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

◆ dump() [2/2]

void sarif_output_format::dump ( FILE * out,
int indent ) const
inlineoverridevirtual

Reimplemented from diagnostic_output_format.

References diagnostic_output_format::dump().

◆ follows_reference_printer_p()

bool sarif_output_format::follows_reference_printer_p ( ) const
inlinefinaloverridevirtual

Implements diagnostic_output_format.

References final().

◆ get_builder()

sarif_builder & sarif_output_format::get_builder ( )
inline

References m_builder.

◆ get_context()

diagnostic_context & diagnostic_output_format::get_context ( ) const
inlineinherited

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
inlineinherited

References m_context.

◆ get_printer()

pretty_printer * diagnostic_output_format::get_printer ( ) const
inlineinherited

References m_printer.

Referenced by default_diagnostic_text_finalizer(), default_diagnostic_text_starter(), default_tree_diagnostic_text_starter(), diagnostic_text_output_format::get_location_text(), html_output_format::html_output_format(), lhd_print_error_function(), sarif_builder::make_location_object(), json_output_format::on_report_diagnostic(), diagnostic_text_output_format::on_report_verbatim(), sarif_output_format::sarif_output_format(), diagnostic_text_sink::text_starter(), html_output_format::update_printer(), and sarif_output_format::update_printer().

◆ get_result()

sarif_result & sarif_output_format::get_result ( size_t idx)
inline

References m_builder.

◆ machine_readable_stderr_p()

virtual bool diagnostic_output_format::machine_readable_stderr_p ( ) const
pure virtualinherited

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

◆ make_per_format_buffer()

std::unique_ptr< diagnostic_per_format_buffer > sarif_output_format::make_per_format_buffer ( )
inlinefinaloverridevirtual

Implements diagnostic_output_format.

References final(), and m_builder.

◆ num_results()

size_t sarif_output_format::num_results ( ) const
inline

References m_builder.

◆ on_begin_group()

void sarif_output_format::on_begin_group ( )
inlinefinaloverridevirtual

Implements diagnostic_output_format.

References final().

◆ on_diagram()

void sarif_output_format::on_diagram ( const diagnostic_diagram & diagram)
inlinefinaloverridevirtual

Implements diagnostic_output_format.

References m_builder.

◆ on_end_group()

void sarif_output_format::on_end_group ( )
inlinefinaloverridevirtual

Implements diagnostic_output_format.

References final(), and m_builder.

◆ on_report_diagnostic()

void sarif_output_format::on_report_diagnostic ( const diagnostic_info & diagnostic,
diagnostic_t orig_diag_kind )
inlinefinaloverridevirtual

Implements diagnostic_output_format.

References m_buffer, and m_builder.

◆ on_report_verbatim()

void diagnostic_output_format::on_report_verbatim ( text_info & )
virtualinherited

Reimplemented in diagnostic_text_output_format.

◆ set_buffer()

void sarif_output_format::set_buffer ( diagnostic_per_format_buffer * base_buffer)
inlinefinaloverridevirtual

Implements diagnostic_output_format.

References m_buffer.

◆ set_main_input_filename()

void sarif_output_format::set_main_input_filename ( const char * name)
inlinefinaloverridevirtual

Reimplemented from diagnostic_output_format.

References m_builder.

◆ update_printer()

void sarif_output_format::update_printer ( )
inlinefinaloverridevirtual

Implements diagnostic_output_format.

References final(), diagnostic_output_format::get_printer(), m_builder, diagnostic_output_format::m_context, diagnostic_output_format::m_printer, pp_show_color(), pretty_printer::set_token_printer(), and URL_FORMAT_NONE.

Field Documentation

◆ m_buffer

diagnostic_sarif_format_buffer* sarif_output_format::m_buffer
protected

Referenced by on_report_diagnostic(), sarif_output_format(), and set_buffer().

◆ m_builder

sarif_builder sarif_output_format::m_builder
protected

Referenced by get_builder(), get_result(), make_per_format_buffer(), num_results(), on_diagram(), on_end_group(), on_report_diagnostic(), sarif_output_format(), set_main_input_filename(), update_printer(), sarif_file_output_format::~sarif_file_output_format(), ~sarif_output_format(), and sarif_stream_output_format::~sarif_stream_output_format().

◆ m_context

diagnostic_context& diagnostic_output_format::m_context
protectedinherited

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(), html_output_format::update_printer(), 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
protectedinherited

Referenced by diagnostic_output_format(), dump(), get_printer(), diagnostic_text_output_format::update_printer(), html_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 file: