#include <sink.h>

Inheritance diagram for diagnostics::sink:

[legend]

Collaboration diagram for diagnostics::sink:

[legend]

Data Structures
class	extension

Public Member Functions
virtual	~sink ()
virtual text_sink *	dyn_cast_text_sink ()
virtual void	dump_kind (FILE *out) const =0
virtual void	dump (FILE *out, int indent) const
virtual void	set_main_input_filename (const char *)
virtual std::unique_ptr< per_sink_buffer >	make_per_sink_buffer ()=0
virtual void	set_buffer (per_sink_buffer *)=0
virtual void	on_begin_group ()=0
virtual void	on_end_group ()=0
virtual void	on_report_diagnostic (const diagnostic_info &, enum kind orig_diag_kind)=0
virtual void	on_report_verbatim (text_info &)
virtual void	on_diagram (const diagram &diag)=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
virtual void	report_global_digraph (const lazily_created< digraphs::digraph > &)=0
virtual void	report_digraph_for_logical_location (const lazily_created< digraphs::digraph > &, logical_locations::key)=0
context &	get_context () const
pretty_printer *	get_printer () const
text_art::theme *	get_diagram_theme () const
void DEBUG_FUNCTION	dump () const
logging::logger *	get_logger ()
void	add_extension (std::unique_ptr< extension > sink_ext)
void	finalize_extensions ()

Protected Member Functions
	sink (context &dc)

Protected Attributes
context &	m_context
std::unique_ptr< pretty_printer >	m_printer

Private Attributes
std::vector< std::unique_ptr< extension > >	m_extensions

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

◆ ~sink()

virtual diagnostics::sink::~sink ( )

inlinevirtual

◆ sink()

diagnostics::sink::sink ( context & dc )

inlineprotected

References m_context, and m_printer.

Referenced by diagnostics::sink::extension::extension(), diagnostics::sink::extension::get_sink(), diagnostics::html_sink::html_sink(), diagnostics::sarif_sink::sarif_sink(), and diagnostics::text_sink::text_sink().

Member Function Documentation

◆ add_extension()

void diagnostics::sink::add_extension ( std::unique_ptr< extension > sink_ext )

inline

References m_extensions.

◆ after_diagnostic()

virtual void diagnostics::sink::after_diagnostic ( const diagnostic_info & )

pure virtual

Implemented in diagnostics::html_sink, diagnostics::sarif_sink, and diagnostics::text_sink.

◆ dump() [1/2]

void DEBUG_FUNCTION diagnostics::sink::dump ( ) const

inline

References DEBUG_FUNCTION, and dump().

Referenced by diagnostics::html_sink::dump(), diagnostics::sarif_sink::dump(), dump(), and diagnostics::text_sink::dump().

◆ dump() [2/2]

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

virtual

Reimplemented in diagnostics::html_sink, diagnostics::sarif_sink, and diagnostics::text_sink.

References diagnostics::dumping::emit_heading(), diagnostics::dumping::emit_none(), m_extensions, and m_printer.

◆ dump_kind()

virtual void diagnostics::sink::dump_kind ( FILE * out ) const

pure virtual

Implemented in diagnostics::html_file_sink, diagnostics::sarif_file_sink, diagnostics::sarif_socket_sink, diagnostics::sarif_stream_sink, and diagnostics::text_sink.

◆ dyn_cast_text_sink()

virtual text_sink * diagnostics::sink::dyn_cast_text_sink ( )

inlinevirtual

Reimplemented in diagnostics::text_sink.

◆ finalize_extensions()

void sink::finalize_extensions ( )

References m_extensions.

◆ follows_reference_printer_p()

virtual bool diagnostics::sink::follows_reference_printer_p ( ) const

pure virtual

Implemented in diagnostics::html_sink, diagnostics::sarif_sink, and diagnostics::text_sink.

◆ get_context()

context & diagnostics::sink::get_context ( ) const

inline

References m_context.

Referenced by diagnostics::text_sink::append_note(), diagnostics::text_sink::build_indent_prefix(), diagnostics::text_sink::build_prefix(), diagnostics::default_text_finalizer(), diagnostics::text_sink::get_location_text(), lhd_print_error_function(), diagnostics::text_sink::on_report_diagnostic(), diagnostics::text_sink::print_path(), diagnostics::text_sink::show_column_p(), and diagnostics::text_sink::update_printer().

◆ get_diagram_theme()

text_art::theme * diagnostics::sink::get_diagram_theme ( ) const

inline

References m_context.

◆ get_logger()

logging::logger * diagnostics::sink::get_logger ( )

inline

References m_context.

Referenced by diagnostics::html_sink::on_report_diagnostic(), diagnostics::sarif_sink::on_report_diagnostic(), and diagnostics::text_sink::on_report_diagnostic().

◆ get_printer()

pretty_printer * diagnostics::sink::get_printer ( ) const

inline

References m_printer.

Referenced by diagnostics::default_text_finalizer(), diagnostics::default_text_starter(), default_tree_diagnostic_text_starter(), diagnostics::text_sink::get_location_text(), diagnostics::html_sink::html_sink(), lhd_print_error_function(), diagnostics::sarif_builder::make_location_object(), diagnostics::output_spec::text_scheme_handler::make_sink(), diagnostics::text_sink::on_report_verbatim(), diagnostics::sarif_sink::sarif_sink(), diagnostic_text_sink::text_starter(), diagnostics::html_sink::update_printer(), and diagnostics::sarif_sink::update_printer().

◆ machine_readable_stderr_p()

virtual bool diagnostics::sink::machine_readable_stderr_p ( ) const

pure virtual

Implemented in diagnostics::html_file_sink, diagnostics::sarif_file_sink, diagnostics::sarif_socket_sink, diagnostics::sarif_stream_sink, and diagnostics::text_sink.

◆ make_per_sink_buffer()

virtual std::unique_ptr< per_sink_buffer > diagnostics::sink::make_per_sink_buffer ( )

pure virtual

Implemented in diagnostics::html_sink, diagnostics::sarif_sink, and diagnostics::text_sink.

◆ on_begin_group()

virtual void diagnostics::sink::on_begin_group ( )

pure virtual

Implemented in diagnostics::html_sink, diagnostics::sarif_sink, and diagnostics::text_sink.

◆ on_diagram()

virtual void diagnostics::sink::on_diagram ( const diagram & diag )

pure virtual

Implemented in diagnostics::html_sink, diagnostics::sarif_sink, and diagnostics::text_sink.

◆ on_end_group()

virtual void diagnostics::sink::on_end_group ( )

pure virtual

Implemented in diagnostics::html_sink, diagnostics::sarif_sink, diagnostics::sarif_socket_sink, and diagnostics::text_sink.

◆ on_report_diagnostic()

virtual void diagnostics::sink::on_report_diagnostic	(	const diagnostic_info &	,
		enum kind	orig_diag_kind )

pure virtual

Implemented in diagnostics::html_sink, diagnostics::sarif_sink, and diagnostics::text_sink.

◆ on_report_verbatim()

void sink::on_report_verbatim ( text_info & )

virtual

Reimplemented in diagnostics::text_sink.

◆ report_digraph_for_logical_location()

virtual void diagnostics::sink::report_digraph_for_logical_location	(	const lazily_created< digraphs::digraph > &	,
		logical_locations::key	)

pure virtual

Implemented in diagnostics::html_sink, diagnostics::sarif_sink, and diagnostics::text_sink.

◆ report_global_digraph()

virtual void diagnostics::sink::report_global_digraph ( const lazily_created< digraphs::digraph > & )

pure virtual

Implemented in diagnostics::html_sink, diagnostics::sarif_sink, and diagnostics::text_sink.

◆ set_buffer()

virtual void diagnostics::sink::set_buffer ( per_sink_buffer * )

pure virtual

Implemented in diagnostics::html_sink, diagnostics::sarif_sink, and diagnostics::text_sink.

◆ set_main_input_filename()

virtual void diagnostics::sink::set_main_input_filename ( const char * )

inlinevirtual

Reimplemented in diagnostics::html_sink, and diagnostics::sarif_sink.

Referenced by diagnostics::output_format_init().

◆ update_printer()

virtual void diagnostics::sink::update_printer ( )

pure virtual

Implemented in diagnostics::html_sink, diagnostics::sarif_sink, and diagnostics::text_sink.

Referenced by diagnostics::init_sarif_sink(), diagnostics::make_html_sink(), and diagnostics::make_sarif_sink().

Field Documentation

◆ m_context

context& diagnostics::sink::m_context

protected

Referenced by get_context(), get_diagram_theme(), get_logger(), diagnostics::text_sink::on_report_diagnostic(), diagnostics::text_sink::print_option_information(), diagnostics::sarif_socket_sink::send_rpc_notification(), sink(), diagnostics::html_sink::update_printer(), diagnostics::sarif_sink::update_printer(), and diagnostics::text_sink::~text_sink().

◆ m_extensions

std::vector<std::unique_ptr<extension> > diagnostics::sink::m_extensions

private

Referenced by add_extension(), dump(), and finalize_extensions().

◆ m_printer

std::unique_ptr<pretty_printer> diagnostics::sink::m_printer

protected

Referenced by dump(), get_printer(), sink(), diagnostics::html_sink::update_printer(), diagnostics::sarif_sink::update_printer(), and diagnostics::text_sink::update_printer().

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

Data Structures

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ~sink()

◆ sink()

Member Function Documentation

◆ add_extension()

◆ after_diagnostic()

◆ dump() [1/2]

◆ dump() [2/2]

◆ dump_kind()

◆ dyn_cast_text_sink()

◆ finalize_extensions()

◆ follows_reference_printer_p()

◆ get_context()

◆ get_diagram_theme()

◆ get_logger()

◆ get_printer()

◆ machine_readable_stderr_p()

◆ make_per_sink_buffer()

◆ on_begin_group()

◆ on_diagram()

◆ on_end_group()

◆ on_report_diagnostic()

◆ on_report_verbatim()

◆ report_digraph_for_logical_location()

◆ report_global_digraph()

◆ set_buffer()

◆ set_main_input_filename()

◆ update_printer()

Field Documentation

◆ m_context

◆ m_extensions

◆ m_printer