GCC Middle and Back End API Reference
Public Member Functions | Protected Attributes | Private Member Functions
diagnostic_text_output_format Class Reference

#include <diagnostic-format-text.h>

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

Public Member Functions

 diagnostic_text_output_format (diagnostic_context &context)
 
 ~diagnostic_text_output_format ()
 
void on_begin_group () override
 
void on_end_group () override
 
void on_report_diagnostic (const diagnostic_info &, diagnostic_t orig_diag_kind) override
 
void on_diagram (const diagnostic_diagram &diagram) override
 
bool machine_readable_stderr_p () const final override
 

Protected Attributes

diagnostic_context & m_context
 

Private Member Functions

void print_any_cwe (const diagnostic_info &diagnostic)
 
void print_any_rules (const diagnostic_info &diagnostic)
 
void print_option_information (const diagnostic_info &diagnostic, diagnostic_t orig_diag_kind)
 

Detailed Description

Classic text-based output of diagnostics.
   Copyright (C) 2023-2024 Free Software Foundation, Inc.
   Contributed by David Malcolm <dmalcolm@redhat.com>.

This file is part of GCC.

GCC is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free
Software Foundation; either version 3, or (at your option) any later
version.

GCC is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
for more details.

You should have received a copy of the GNU General Public License
along with GCC; see the file COPYING3.  If not see
<http://www.gnu.org/licenses/>.   
Subclass of diagnostic_output_format for classic text-based output
to stderr.

Uses diagnostic_context.m_text_callbacks to provide client-specific
textual output (e.g. include paths, macro expansions, etc).

Constructor & Destructor Documentation

◆ diagnostic_text_output_format()

diagnostic_text_output_format::diagnostic_text_output_format ( diagnostic_context & context)
inline

◆ ~diagnostic_text_output_format()

diagnostic_text_output_format::~diagnostic_text_output_format ( ) 
class diagnostic_text_output_format : public diagnostic_output_format.

References _, diagnostic_context::diagnostic_count(), diagnostic_output_format::m_context, pp_newline_and_flush(), pp_verbatim(), diagnostic_context::printer, progname, and diagnostic_context::warning_as_error_requested_p().

Member Function Documentation

◆ machine_readable_stderr_p()

bool diagnostic_text_output_format::machine_readable_stderr_p ( ) const
inlinefinaloverridevirtual

Implements diagnostic_output_format.

◆ on_begin_group()

void diagnostic_text_output_format::on_begin_group ( )
inlineoverridevirtual

Implements diagnostic_output_format.

◆ on_diagram()

void diagnostic_text_output_format::on_diagram ( const diagnostic_diagram & diagram)
overridevirtual

Implements diagnostic_output_format.

References diagnostic_diagram::get_canvas(), diagnostic_output_format::m_context, NULL, pp_flush(), pp_newline(), pp_set_prefix(), pp_take_prefix(), and diagnostic_context::printer.

◆ on_end_group()

void diagnostic_text_output_format::on_end_group ( )
inlineoverridevirtual

Implements diagnostic_output_format.

◆ on_report_diagnostic()

void diagnostic_text_output_format::on_report_diagnostic ( const diagnostic_info & diagnostic,
diagnostic_t orig_diag_kind )
overridevirtual 
Implementation of diagnostic_output_format::on_report_diagnostic vfunc
for GCC's standard textual output.

Implements diagnostic_output_format.

References diagnostic_finalizer(), diagnostic_starter(), diagnostic_context::get_urlifier(), diagnostic_output_format::m_context, diagnostic_context::m_show_cwe, diagnostic_context::m_show_option_requested, diagnostic_context::m_show_rules, pp_output_formatted_text(), print_any_cwe(), print_any_rules(), print_option_information(), and diagnostic_context::printer.

◆ print_any_cwe()

void diagnostic_text_output_format::print_any_cwe ( const diagnostic_info & diagnostic)
private 
If DIAGNOSTIC has a CWE identifier, print it.

For example, if the diagnostic metadata associates it with CWE-119,
" [CWE-119]" will be printed, suitably colorized, and with a URL of a
description of the security issue.

References colorize_start(), colorize_stop(), diagnostic_get_color_for_kind(), free(), diagnostic_metadata::get_cwe(), get_cwe_url(), diagnostic_info::kind, diagnostic_output_format::m_context, diagnostic_info::metadata, NULL, pp_begin_url(), pp_character(), pp_end_url(), pp_printf(), pp_set_prefix(), pp_show_color(), pp_string(), pp_take_prefix(), diagnostic_context::printer, and pretty_printer::supports_urls_p().

Referenced by on_report_diagnostic().

◆ print_any_rules()

void diagnostic_text_output_format::print_any_rules ( const diagnostic_info & diagnostic)
private 
If DIAGNOSTIC has any rules associated with it, print them.

For example, if the diagnostic metadata associates it with a rule
named "STR34-C", then " [STR34-C]" will be printed, suitably colorized,
with any URL provided by the rule.

References colorize_start(), colorize_stop(), diagnostic_get_color_for_kind(), free(), diagnostic_metadata::get_num_rules(), diagnostic_metadata::get_rule(), diagnostic_info::kind, diagnostic_output_format::m_context, diagnostic_metadata::rule::make_description(), diagnostic_metadata::rule::make_url(), diagnostic_info::metadata, NULL, pp_begin_url(), pp_character(), pp_end_url(), pp_set_prefix(), pp_show_color(), pp_string(), pp_take_prefix(), diagnostic_context::printer, and pretty_printer::supports_urls_p().

Referenced by on_report_diagnostic().

◆ print_option_information()

void diagnostic_text_output_format::print_option_information ( const diagnostic_info & diagnostic,
diagnostic_t orig_diag_kind )
private 
Print any metadata about the option used to control DIAGNOSTIC to CONTEXT's
printer, e.g. " [-Werror=uninitialized]".
Subroutine of diagnostic_context::report_diagnostic.

References colorize_start(), colorize_stop(), diagnostic_get_color_for_kind(), free(), diagnostic_info::kind, diagnostic_output_format::m_context, diagnostic_context::make_option_name(), diagnostic_context::make_option_url(), diagnostic_info::option_index, pp_begin_url(), pp_character(), pp_end_url(), pp_show_color(), pp_string(), diagnostic_context::printer, and pretty_printer::supports_urls_p().

Referenced by on_report_diagnostic().

Field Documentation

◆ m_context

diagnostic_context& diagnostic_output_format::m_context
protectedinherited

Referenced by on_diagram(), sarif_output_format::on_diagram(), on_report_diagnostic(), json_output_format::on_report_diagnostic(), sarif_output_format::on_report_diagnostic(), print_any_cwe(), print_any_rules(), print_option_information(), and ~diagnostic_text_output_format().

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