GCC Middle and Back End API Reference
Public Member Functions | Private Attributes | Friends
pretty_printer Class Reference

#include <pretty-print.h>

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

Public Member Functions

 pretty_printer (int=0)
 
 pretty_printer (const pretty_printer &other)
 
virtual ~pretty_printer ()
 
virtual std::unique_ptr< pretty_printer > clone () const
 
void set_output_stream (FILE *outfile)
 
void set_token_printer (token_printer *tp)
 
void set_prefix (char *prefix)
 
void emit_prefix ()
 
void format (text_info &text)
 
void maybe_space ()
 
bool supports_urls_p () const
 
diagnostic_url_format get_url_format () const
 
void set_url_format (diagnostic_url_format url_format)
 
void begin_url (const char *url)
 
void end_url ()
 
pp_wrapping_mode_t set_verbatim_wrapping ()
 
void set_padding (pp_padding padding)
 
pp_padding get_padding () const
 
void clear_state ()
 
void set_real_maximum_length ()
 
int remaining_character_count_for_line ()
 
void dump (FILE *out, int indent) const
 
void DEBUG_FUNCTION dump () const
 

Private Attributes

output_buffer * m_buffer
 
char * m_prefix
 
pp_padding m_padding
 
int m_maximum_length
 
int m_indent_skip
 
pp_wrapping_mode_t m_wrapping
 
printer_fn m_format_decoder
 
format_postprocessor * m_format_postprocessor
 
token_printer * m_token_printer
 
bool m_emitted_prefix
 
bool m_need_newline
 
bool m_translate_identifiers
 
bool m_show_color
 
bool m_show_highlight_colors
 
diagnostic_url_format m_url_format
 
bool m_skipping_null_url
 

Friends

output_buffer *& pp_buffer (pretty_printer *pp)
 
output_buffer * pp_buffer (const pretty_printer *pp)
 
const char * pp_get_prefix (const pretty_printer *pp)
 
char * pp_take_prefix (pretty_printer *pp)
 
void pp_destroy_prefix (pretty_printer *pp)
 
int & pp_line_cutoff (pretty_printer *pp)
 
diagnostic_prefixing_rule_t & pp_prefixing_rule (pretty_printer *pp)
 
const diagnostic_prefixing_rule_t & pp_prefixing_rule (const pretty_printer *pp)
 
pp_wrapping_mode_t & pp_wrapping_mode (pretty_printer *pp)
 
bool & pp_needs_newline (pretty_printer *pp)
 
int & pp_indentation (pretty_printer *pp)
 
bool & pp_translate_identifiers (pretty_printer *pp)
 
bool & pp_show_color (pretty_printer *pp)
 
printer_fn & pp_format_decoder (pretty_printer *pp)
 
format_postprocessor *& pp_format_postprocessor (pretty_printer *pp)
 
bool & pp_show_highlight_colors (pretty_printer *pp)
 
void pp_output_formatted_text (pretty_printer *pp, const urlifier *urlifier=nullptr)
 

Detailed Description

The data structure that contains the bare minimum required to do
proper pretty-printing.  Clients may derive from this structure
and add additional fields they need.

Constructor & Destructor Documentation

◆ pretty_printer() [1/2]

pretty_printer::pretty_printer ( int maximum_length = 0)
explicit 
Construct a PRETTY-PRINTER of MAXIMUM_LENGTH characters per line.

References DIAGNOSTICS_SHOW_PREFIX_ONCE, NULL, pp_line_cutoff, pp_prefixing_rule, and pp_set_prefix().

◆ pretty_printer() [2/2]

pretty_printer::pretty_printer ( const pretty_printer & other)
explicit 
Copy constructor for pretty_printer.

References format_postprocessor::clone(), m_format_postprocessor, m_maximum_length, NULL, pp_line_cutoff, pp_prefixing_rule, and pp_set_prefix().

◆ ~pretty_printer()

pretty_printer::~pretty_printer ( )
virtual

References free(), m_buffer, m_format_postprocessor, m_prefix, and output_buffer::~output_buffer().

Member Function Documentation

◆ begin_url()

void pretty_printer::begin_url ( const char * url) 
Support for encoding URLs.
See egmontkob/Hyperlinks_in_Terminal_Emulators.md
( https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda ).

> A hyperlink is opened upon encountering an OSC 8 escape sequence with
> the target URI. The syntax is
>
>  OSC 8 ; params ; URI ST
>
> A hyperlink is closed with the same escape sequence, omitting the
> parameters and the URI but keeping the separators:
>
> OSC 8 ; ; ST
>
> OSC (operating system command) is typically ESC ].

Use BEL instead of ST, as that is currently rendered better in some
terminal emulators that don't support OSC 8, like konsole.   
If URL-printing is enabled, write an "open URL" escape sequence to PP
for the given URL.

References gcc_unreachable, m_skipping_null_url, m_url_format, pp_string(), URL_FORMAT_BEL, URL_FORMAT_NONE, and URL_FORMAT_ST.

◆ clear_state()

void pretty_printer::clear_state ( )
inline 
Clear this pretty_printer's output state.

References m_emitted_prefix, and pp_indentation.

Referenced by format(), pp_flush(), and pp_really_flush().

◆ clone()

std::unique_ptr< pretty_printer > pretty_printer::clone ( ) const
virtual 
Base class implementation of pretty_printer::clone vfunc.

Referenced by element_event_desc::add_to_phase_2(), diagnostic_context::clone_printer(), diagnostic_event::get_desc(), make_json_for_path(), and sarif_builder::make_location_object().

◆ dump() [1/2]

void DEBUG_FUNCTION pretty_printer::dump ( ) const
inline

References dump().

Referenced by dump().

◆ dump() [2/2]

void pretty_printer::dump ( FILE * out,
int indent ) const 
Dump state of this pretty_printer to OUT, for debugging.

References output_buffer::dump(), gcc_unreachable, m_buffer, m_show_color, m_url_format, URL_FORMAT_BEL, URL_FORMAT_NONE, and URL_FORMAT_ST.

Referenced by diagnostic_context::dump().

◆ emit_prefix()

void pretty_printer::emit_prefix ( ) 
Write out this pretty_printer's prefix.

References DIAGNOSTICS_SHOW_PREFIX_EVERY_LINE, DIAGNOSTICS_SHOW_PREFIX_NEVER, DIAGNOSTICS_SHOW_PREFIX_ONCE, m_emitted_prefix, m_prefix, pp_append_r(), pp_indent(), pp_indentation, and pp_prefixing_rule.

Referenced by pp_append_text().

◆ end_url()

void pretty_printer::end_url ( ) 
If URL-printing is enabled, write a "close URL" escape sequence to PP.

References get_end_url_string(), m_skipping_null_url, m_url_format, pp_string(), and URL_FORMAT_NONE.

◆ format()

void pretty_printer::format ( text_info & text)

References clear_state(), format_phase_1(), format_phase_2(), format_postprocessor::handle(), pp_formatted_chunks::m_args, m_buffer, output_buffer::m_chunk_obstack, m_format_postprocessor, output_buffer::m_formatted_obstack, output_buffer::m_line_length, output_buffer::m_obstack, PP_NL_ARGMAX, pp_set_verbatim_wrapping(), pp_wrapping_mode, and output_buffer::push_formatted_chunks().

Referenced by dump_printf(), dump_printf_loc(), dump_context::dump_printf_loc_va(), and dump_context::dump_printf_va().

◆ get_padding()

pp_padding pretty_printer::get_padding ( ) const
inline

References m_padding.

◆ get_url_format()

diagnostic_url_format pretty_printer::get_url_format ( ) const
inline

References m_url_format.

Referenced by get_end_url_string(), diagnostic_text_output_format::update_printer(), and diagnostic_context::urls_init().

◆ maybe_space()

void pretty_printer::maybe_space ( ) 
Maybe print out a whitespace if needed.

References m_padding, pp_none, and pp_space.

◆ remaining_character_count_for_line()

int pretty_printer::remaining_character_count_for_line ( ) 
Return the amount of characters PRETTY-PRINTER can accept to
make a full line.  Meaningful only in line-wrapping mode.

References output_buffer::m_line_length, m_maximum_length, and pp_buffer.

Referenced by pp_character(), and pp_wrap_text().

◆ set_output_stream()

void pretty_printer::set_output_stream ( FILE * outfile)
inline

References m_buffer, and output_buffer::m_stream.

Referenced by dot_rdg_1(), ana::one_way_id_map< T >::dump(), irange_bitmask::dump(), vrange::dump(), digraph< GraphTraits >::dump_dot_to_file(), dump_insn_slim(), dump_rtl_slim(), dump_ssaname_info_to_file(), dump_value_slim(), gimple_dump_bb(), libgdiagnostics_path_event::make_desc(), maybe_init_pretty_print(), print_gimple_expr(), print_gimple_seq(), print_gimple_stmt(), print_graph_cfg(), print_node(), start_graph_dump(), tree_dump_pretty_printer::tree_dump_pretty_printer(), and diagnostic_manager::write_patch().

◆ set_padding()

void pretty_printer::set_padding ( pp_padding padding)
inline

References m_padding.

◆ set_prefix()

void pretty_printer::set_prefix ( char * prefix) 
Set PREFIX for PRETTY-PRINTER, taking ownership of PREFIX, which
will eventually be free-ed.

References free(), m_emitted_prefix, m_prefix, pp_indentation, and set_real_maximum_length().

Referenced by lhd_print_error_function().

◆ set_real_maximum_length()

void pretty_printer::set_real_maximum_length ( ) 
Subroutine of pp_set_maximum_length.  Set up PRETTY-PRINTER's
internal maximum characters per line.

References DIAGNOSTICS_SHOW_PREFIX_NEVER, DIAGNOSTICS_SHOW_PREFIX_ONCE, m_maximum_length, m_prefix, pp_is_wrapping_line, pp_line_cutoff, and pp_prefixing_rule.

Referenced by pp_set_line_maximum_length(), and set_prefix().

◆ set_token_printer()

void pretty_printer::set_token_printer ( token_printer * tp)
inline

References m_token_printer.

Referenced by dump_pretty_printer::dump_pretty_printer(), and sarif_output_format::update_printer().

◆ set_url_format()

void pretty_printer::set_url_format ( diagnostic_url_format url_format)
inline

References m_url_format.

Referenced by diagnostic_context::urls_init().

◆ set_verbatim_wrapping()

pp_wrapping_mode_t pretty_printer::set_verbatim_wrapping ( )
inline

References DIAGNOSTICS_SHOW_PREFIX_NEVER, pp_line_cutoff, pp_prefixing_rule, and pp_wrapping_mode.

◆ supports_urls_p()

bool pretty_printer::supports_urls_p ( ) const
inline

References m_url_format, and URL_FORMAT_NONE.

Referenced by diagnostic_text_output_format::print_any_cwe(), diagnostic_text_output_format::print_any_rules(), and diagnostic_text_output_format::print_option_information().

Friends And Related Symbol Documentation

◆ pp_buffer [1/2]

output_buffer * pp_buffer ( const pretty_printer * pp)
friend

◆ pp_buffer [2/2]

output_buffer *& pp_buffer ( pretty_printer * pp)
friend

Referenced by dump_pretty_printer::custom_token_printer::emit_any_pending_textual_chunks(), and remaining_character_count_for_line().

◆ pp_destroy_prefix

void pp_destroy_prefix ( pretty_printer * pp)
friend 
Free PRETTY-PRINTER's prefix, a previously malloc()'d string.

◆ pp_format_decoder

printer_fn & pp_format_decoder ( pretty_printer * pp)
friend

Referenced by dump_pretty_printer::dump_pretty_printer(), and tree_dump_pretty_printer::tree_dump_pretty_printer().

◆ pp_format_postprocessor

format_postprocessor *& pp_format_postprocessor ( pretty_printer * pp)
friend

◆ pp_get_prefix

const char * pp_get_prefix ( const pretty_printer * pp)
friend

◆ pp_indentation

int & pp_indentation ( pretty_printer * pp)
friend 
The amount of whitespace to be emitted when starting a new line.

Referenced by clear_state(), emit_prefix(), and set_prefix().

◆ pp_line_cutoff

int & pp_line_cutoff ( pretty_printer * pp)
friend 
Maximum characters per line in automatic line wrapping mode.
Zero means don't wrap lines.

Referenced by pretty_printer(), pretty_printer(), set_real_maximum_length(), and set_verbatim_wrapping().

◆ pp_needs_newline

bool & pp_needs_newline ( pretty_printer * pp)
friend 
TRUE if a newline character needs to be added before further
formatting.

◆ pp_output_formatted_text

void pp_output_formatted_text ( pretty_printer * pp,
const urlifier * urlifier = nullptr )
friend 
Phase 3 of formatting a message (phases 1 and 2 done by pp_format).

Pop a pp_formatted_chunks from chunk_obstack, collecting all the tokens from
phases 1 and 2 of formatting, and writing into text in formatted_obstack.

If URLIFIER is non-null then use it on any quoted text that was not
handled in phases 1 or 2 to potentially add URLs.

Referenced by dump_context::dump_printf_va().

◆ pp_prefixing_rule [1/2]

const diagnostic_prefixing_rule_t & pp_prefixing_rule ( const pretty_printer * pp)
friend

◆ pp_prefixing_rule [2/2]

diagnostic_prefixing_rule_t & pp_prefixing_rule ( pretty_printer * pp)
friend 
Prefixing rule used in formatting a diagnostic message.

Referenced by emit_prefix(), pretty_printer(), pretty_printer(), set_real_maximum_length(), and set_verbatim_wrapping().

◆ pp_show_color

bool & pp_show_color ( pretty_printer * pp)
friend 
True if colors should be shown.

Referenced by dump_pretty_printer::custom_token_printer::print_tokens(), and tree_dump_pretty_printer::tree_dump_pretty_printer().

◆ pp_show_highlight_colors

bool & pp_show_highlight_colors ( pretty_printer * pp)
friend

◆ pp_take_prefix

char * pp_take_prefix ( pretty_printer * pp)
friend 
Take ownership of PP's prefix, setting it to NULL.
This allows clients to save, override, and then restore an existing
prefix, without it being free-ed.

◆ pp_translate_identifiers

bool & pp_translate_identifiers ( pretty_printer * pp)
friend 
True if identifiers are translated to the locale character set on
output.

◆ pp_wrapping_mode

pp_wrapping_mode_t & pp_wrapping_mode ( pretty_printer * pp)
friend 
Get or set the wrapping mode as a single entity.

Referenced by format(), and set_verbatim_wrapping().

Field Documentation

◆ m_buffer

output_buffer* pretty_printer::m_buffer
private

Referenced by dump(), format(), set_output_stream(), and ~pretty_printer().

◆ m_emitted_prefix

bool pretty_printer::m_emitted_prefix
private

Referenced by clear_state(), emit_prefix(), and set_prefix().

◆ m_format_decoder

printer_fn pretty_printer::m_format_decoder
private

◆ m_format_postprocessor

format_postprocessor* pretty_printer::m_format_postprocessor
private

Referenced by format(), pretty_printer(), and ~pretty_printer().

◆ m_indent_skip

int pretty_printer::m_indent_skip
private

◆ m_maximum_length

int pretty_printer::m_maximum_length
private

Referenced by pretty_printer(), remaining_character_count_for_line(), and set_real_maximum_length().

◆ m_need_newline

bool pretty_printer::m_need_newline
private

◆ m_padding

pp_padding pretty_printer::m_padding
private

Referenced by get_padding(), maybe_space(), and set_padding().

◆ m_prefix

char* pretty_printer::m_prefix
private

Referenced by emit_prefix(), set_prefix(), set_real_maximum_length(), and ~pretty_printer().

◆ m_show_color

bool pretty_printer::m_show_color
private

Referenced by dump().

◆ m_show_highlight_colors

bool pretty_printer::m_show_highlight_colors
private

◆ m_skipping_null_url

bool pretty_printer::m_skipping_null_url
private

Referenced by begin_url(), and end_url().

◆ m_token_printer

token_printer* pretty_printer::m_token_printer
private

Referenced by set_token_printer().

◆ m_translate_identifiers

bool pretty_printer::m_translate_identifiers
private

◆ m_url_format

diagnostic_url_format pretty_printer::m_url_format
private

Referenced by begin_url(), dump(), end_url(), get_url_format(), set_url_format(), and supports_urls_p().

◆ m_wrapping

pp_wrapping_mode_t pretty_printer::m_wrapping
private
The documentation for this class was generated from the following files: