#include <diagnostic.h>

Collaboration diagram for diagnostic_source_print_policy:

[legend]

Public Member Functions
	diagnostic_source_print_policy (const diagnostic_context &)
	diagnostic_source_print_policy (const diagnostic_context &, const diagnostic_source_printing_options &)
void	print (pretty_printer &pp, const rich_location &richloc, diagnostic_t diagnostic_kind, diagnostic_source_effect_info *effect_info) const
void	print_as_html (xml::printer &xp, const rich_location &richloc, diagnostic_t diagnostic_kind, diagnostic_source_effect_info effect_info, html_label_writer label_writer) const
const diagnostic_source_printing_options &	get_options () const
diagnostic_start_span_fn< to_text >	get_text_start_span_fn () const
diagnostic_start_span_fn< to_html >	get_html_start_span_fn () const
file_cache &	get_file_cache () const
enum diagnostics_escape_format	get_escape_format () const
text_art::theme *	get_diagram_theme () const
const diagnostic_column_policy &	get_column_policy () const
const diagnostic_location_print_policy &	get_location_policy () const

Private Attributes
const diagnostic_source_printing_options &	m_options
class diagnostic_location_print_policy	m_location_policy
diagnostic_start_span_fn< to_text >	m_text_start_span_cb
diagnostic_start_span_fn< to_html >	m_html_start_span_cb
file_cache &	m_file_cache
text_art::theme *	m_diagram_theme
enum diagnostics_escape_format	m_escape_format

Detailed Description

A bundle of state for printing source within a diagnostic,
to isolate the interactions between diagnostic_context and the
implementation of diagnostic_show_locus.

Constructor & Destructor Documentation

◆ diagnostic_source_print_policy() [1/2]

diagnostic_source_print_policy::diagnostic_source_print_policy ( const diagnostic_context & dc )

References get_diagram_theme(), get_escape_format(), get_file_cache(), m_diagram_theme, m_escape_format, m_file_cache, m_html_start_span_cb, m_location_policy, m_options, and m_text_start_span_cb.

◆ diagnostic_source_print_policy() [2/2]

diagnostic_source_print_policy::diagnostic_source_print_policy	(	const diagnostic_context &	dc,
		const diagnostic_source_printing_options &	opts )

References get_diagram_theme(), get_escape_format(), get_file_cache(), m_diagram_theme, m_escape_format, m_file_cache, m_html_start_span_cb, m_location_policy, m_options, and m_text_start_span_cb.

Member Function Documentation

◆ get_column_policy()

const diagnostic_column_policy & diagnostic_source_print_policy::get_column_policy ( ) const

inline

References m_location_policy.

◆ get_diagram_theme()

text_art::theme * diagnostic_source_print_policy::get_diagram_theme ( ) const

inline

References m_diagram_theme.

Referenced by diagnostic_source_print_policy(), and diagnostic_source_print_policy().

◆ get_escape_format()

enum diagnostics_escape_format diagnostic_source_print_policy::get_escape_format ( ) const

inline

References m_escape_format.

Referenced by diagnostic_source_print_policy(), and diagnostic_source_print_policy().

◆ get_file_cache()

file_cache & diagnostic_source_print_policy::get_file_cache ( ) const

inline

References m_file_cache.

Referenced by diagnostic_source_print_policy(), and diagnostic_source_print_policy().

◆ get_html_start_span_fn()

diagnostic_start_span_fn< to_html > diagnostic_source_print_policy::get_html_start_span_fn ( ) const

inline

References m_html_start_span_cb.

Referenced by to_html::invoke_start_span_fn(), and diagnostic_location_print_policy::print_html_span_start().

◆ get_location_policy()

const diagnostic_location_print_policy & diagnostic_source_print_policy::get_location_policy ( ) const

inline

References m_location_policy.

◆ get_options()

const diagnostic_source_printing_options & diagnostic_source_print_policy::get_options ( ) const

inline

References m_options.

Referenced by print_path_as_html().

◆ get_text_start_span_fn()

diagnostic_start_span_fn< to_text > diagnostic_source_print_policy::get_text_start_span_fn ( ) const

inline

References m_text_start_span_cb.

Referenced by to_text::invoke_start_span_fn(), and diagnostic_location_print_policy::print_text_span_start().

◆ print()

void diagnostic_source_print_policy::print	(	pretty_printer &	pp,
		const rich_location &	richloc,
		diagnostic_t	diagnostic_kind,
		diagnostic_source_effect_info *	effects ) const

Print to PP the physical source code corresponding to the location(s)
in RICHLOC, with additional annotations, as if for a diagnostic of the
given DIAGNOSTIC_KIND.
If EFFECTS is non-null, then use and update it.

Referenced by sarif_builder::make_location_object(), and diagnostic_context::maybe_show_locus().

◆ print_as_html()

void diagnostic_source_print_policy::print_as_html	(	xml::printer &	xp,
		const rich_location &	richloc,
		diagnostic_t	diagnostic_kind,
		diagnostic_source_effect_info *	effects,
		html_label_writer *	label_writer ) const

As above, but print in HTML form to XP.
If non-null, use LABEL_WRITER when writing labelled ranges.

Referenced by diagnostic_context::maybe_show_locus_as_html().

Field Documentation

◆ m_diagram_theme

text_art::theme* diagnostic_source_print_policy::m_diagram_theme

private

Referenced by diagnostic_source_print_policy(), diagnostic_source_print_policy(), and get_diagram_theme().

◆ m_escape_format

enum diagnostics_escape_format diagnostic_source_print_policy::m_escape_format

private

Referenced by diagnostic_source_print_policy(), diagnostic_source_print_policy(), and get_escape_format().

◆ m_file_cache

file_cache& diagnostic_source_print_policy::m_file_cache

private

Referenced by diagnostic_source_print_policy(), diagnostic_source_print_policy(), and get_file_cache().

◆ m_html_start_span_cb

diagnostic_start_span_fn<to_html> diagnostic_source_print_policy::m_html_start_span_cb

private

Referenced by diagnostic_source_print_policy(), diagnostic_source_print_policy(), and get_html_start_span_fn().

◆ m_location_policy

class diagnostic_location_print_policy diagnostic_source_print_policy::m_location_policy

private

Referenced by diagnostic_source_print_policy(), diagnostic_source_print_policy(), get_column_policy(), and get_location_policy().

◆ m_options

const diagnostic_source_printing_options& diagnostic_source_print_policy::m_options

private

Referenced by diagnostic_source_print_policy(), diagnostic_source_print_policy(), and get_options().

◆ m_text_start_span_cb

diagnostic_start_span_fn<to_text> diagnostic_source_print_policy::m_text_start_span_cb

private

Referenced by diagnostic_source_print_policy(), diagnostic_source_print_policy(), and get_text_start_span_fn().

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

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ diagnostic_source_print_policy() [1/2]

◆ diagnostic_source_print_policy() [2/2]

Member Function Documentation

◆ get_column_policy()

◆ get_diagram_theme()

◆ get_escape_format()

◆ get_file_cache()

◆ get_html_start_span_fn()

◆ get_location_policy()

◆ get_options()

◆ get_text_start_span_fn()

◆ print()

◆ print_as_html()

Field Documentation

◆ m_diagram_theme

◆ m_escape_format

◆ m_file_cache

◆ m_html_start_span_cb

◆ m_location_policy

◆ m_options

◆ m_text_start_span_cb