GCC Middle and Back End API Reference
diagnostic Struct Reference
Collaboration diagram for diagnostic:
Collaboration graph
[legend]

Public Member Functions

 diagnostic (diagnostic_manager &diag_mgr, enum diagnostic_level level)
diagnostic_manager & get_manager () const
enum diagnostic_level get_level () const
rich_location * get_rich_location ()
const diagnostics::metadata * get_metadata ()
void set_cwe (unsigned cwe_id)
void add_rule (const char *title, const char *url)
void set_location (const diagnostic_physical_location *loc)
void add_location (const diagnostic_physical_location *loc)
void add_location_with_label (const diagnostic_physical_location *loc, const char *text)
void add_location_with_label (const diagnostic_physical_location *loc, std::unique_ptr< diagnostic_message_buffer > msg_buf)
void set_logical_location (const diagnostic_logical_location *logical_loc)
const diagnostic_logical_location * get_logical_location () const
diagnostic_execution_path * add_execution_path ()
void take_execution_path (diagnostic_execution_path *path)
void take_graph (std::unique_ptr< diagnostic_graph > graph)
const prebuilt_digraphs & get_graphs () const
int get_nesting_level () const
void set_nesting_level (int value)

Private Attributes

diagnostic_manager & m_diag_mgr
enum diagnostic_level m_level
impl_rich_location m_rich_loc
const diagnostic_logical_location * m_logical_loc
diagnostics::metadata m_metadata
prebuilt_digraphs m_graphs
std::vector< std::unique_ptr< range_label > > m_labels
std::vector< std::unique_ptr< impl_rule > > m_rules
std::unique_ptr< diagnostic_execution_path > m_path
int m_nesting_level

Detailed Description

This has to be a "struct" as it is exposed in the C API.

Constructor & Destructor Documentation

◆ diagnostic()

diagnostic::diagnostic ( diagnostic_manager & diag_mgr,
enum diagnostic_level level )
inline

References m_diag_mgr, m_graphs, m_level, m_logical_loc, m_metadata, m_nesting_level, m_path, and m_rich_loc.

Member Function Documentation

◆ add_execution_path()

diagnostic_execution_path * diagnostic::add_execution_path ( )
inline

References m_diag_mgr, m_path, and m_rich_loc.

Referenced by diagnostic_add_execution_path().

◆ add_location()

void diagnostic::add_location ( const diagnostic_physical_location * loc)
inline

References as_location_t(), and m_rich_loc.

Referenced by diagnostic_add_location().

◆ add_location_with_label() [1/2]

void diagnostic::add_location_with_label ( const diagnostic_physical_location * loc,
const char * text )
inline

References as_location_t(), m_labels, and m_rich_loc.

Referenced by diagnostic_add_location_with_label(), and diagnostic_add_location_with_label_via_msg_buf().

◆ add_location_with_label() [2/2]

void diagnostic::add_location_with_label ( const diagnostic_physical_location * loc,
std::unique_ptr< diagnostic_message_buffer > msg_buf )
inline

References as_location_t(), m_labels, and m_rich_loc.

◆ add_rule()

void diagnostic::add_rule ( const char * title,
const char * url )
inline

References m_metadata, and m_rules.

Referenced by diagnostic_add_rule().

◆ get_graphs()

const prebuilt_digraphs & diagnostic::get_graphs ( ) const
inline

References m_graphs.

◆ get_level()

enum diagnostic_level diagnostic::get_level ( ) const
inline

References m_level.

Referenced by diagnostic_manager::emit_va().

◆ get_logical_location()

const diagnostic_logical_location * diagnostic::get_logical_location ( ) const
inline

References m_logical_loc.

Referenced by diagnostic_manager::emit_va(), and diagnostic_text_sink::text_starter().

◆ get_manager()

diagnostic_manager & diagnostic::get_manager ( ) const
inline

References m_diag_mgr.

Referenced by diagnostic_add_fix_it_hint_delete(), diagnostic_add_fix_it_hint_insert_after(), diagnostic_add_fix_it_hint_insert_before(), diagnostic_add_fix_it_hint_replace(), diagnostic_add_location(), diagnostic_add_location_with_label(), diagnostic_add_location_with_label_via_msg_buf(), diagnostic_finish_va(), diagnostic_finish_via_msg_buf(), diagnostic_set_location(), and diagnostic_text_sink::text_starter().

◆ get_metadata()

const diagnostics::metadata * diagnostic::get_metadata ( )
inline

References m_metadata.

Referenced by diagnostic_manager::emit_va().

◆ get_nesting_level()

int diagnostic::get_nesting_level ( ) const
inline

References m_nesting_level.

Referenced by diagnostic_manager::emit_va().

◆ get_rich_location()

rich_location * diagnostic::get_rich_location ( )
inline

References m_rich_loc.

Referenced by diagnostic_add_fix_it_hint_delete(), diagnostic_add_fix_it_hint_insert_after(), diagnostic_add_fix_it_hint_insert_before(), diagnostic_add_fix_it_hint_replace(), and diagnostic_manager::emit_va().

◆ set_cwe()

void diagnostic::set_cwe ( unsigned cwe_id)
inline

References m_metadata.

Referenced by diagnostic_set_cwe().

◆ set_location()

void diagnostic::set_location ( const diagnostic_physical_location * loc)
inline

References as_location_t(), and m_rich_loc.

Referenced by diagnostic_set_location().

◆ set_logical_location()

void diagnostic::set_logical_location ( const diagnostic_logical_location * logical_loc)
inline

References m_logical_loc.

Referenced by diagnostic_set_logical_location().

◆ set_nesting_level()

void diagnostic::set_nesting_level ( int value)
inline

References m_nesting_level.

Referenced by private_diagnostic_set_nesting_level().

◆ take_execution_path()

void diagnostic::take_execution_path ( diagnostic_execution_path * path)
inline

References m_path, m_rich_loc, and path.

Referenced by diagnostic_take_execution_path().

◆ take_graph()

void diagnostic::take_graph ( std::unique_ptr< diagnostic_graph > graph)
inline

References m_graphs.

Referenced by diagnostic_take_graph().

Field Documentation

◆ m_diag_mgr

diagnostic_manager& diagnostic::m_diag_mgr
private

Referenced by add_execution_path(), diagnostic(), and get_manager().

◆ m_graphs

prebuilt_digraphs diagnostic::m_graphs
private

Referenced by diagnostic(), get_graphs(), and take_graph().

◆ m_labels

std::vector<std::unique_ptr<range_label> > diagnostic::m_labels
private

Referenced by add_location_with_label(), and add_location_with_label().

◆ m_level

enum diagnostic_level diagnostic::m_level
private

Referenced by diagnostic(), and get_level().

◆ m_logical_loc

const diagnostic_logical_location* diagnostic::m_logical_loc
private

Referenced by diagnostic(), get_logical_location(), and set_logical_location().

◆ m_metadata

diagnostics::metadata diagnostic::m_metadata
private

Referenced by add_rule(), diagnostic(), diagnostics::context::diagnostic_impl(), diagnostics::context::diagnostic_n_impl(), diagnostic_set_info_translated(), get_metadata(), diagnostics::html_builder::make_element_for_diagnostic(), diagnostics::sarif_builder::make_result_object(), diagnostics::text_sink::print_any_cwe(), diagnostics::text_sink::print_any_rules(), and set_cwe().

◆ m_nesting_level

int diagnostic::m_nesting_level
private

Referenced by diagnostic(), get_nesting_level(), and set_nesting_level().

◆ m_path

std::unique_ptr<diagnostic_execution_path> diagnostic::m_path
private

Referenced by add_execution_path(), diagnostic(), and take_execution_path().

◆ m_rich_loc

impl_rich_location diagnostic::m_rich_loc
private

Referenced by add_execution_path(), add_location(), add_location_with_label(), add_location_with_label(), diagnostic(), get_rich_location(), set_location(), and take_execution_path().

◆ m_rules

std::vector<std::unique_ptr<impl_rule> > diagnostic::m_rules
private

Referenced by add_rule().

The documentation for this struct was generated from the following file: