diagnostics::client_data_hooks Class Reference

#include <client-data-hooks.h>

Inheritance diagram for diagnostics::client_data_hooks:

Public Member Functions
virtual	~client_data_hooks ()
void	dump (FILE *out, int indent) const
void DEBUG_FUNCTION	dump () const
virtual const client_version_info *	get_any_version_info () const =0
virtual const logical_locations::manager *	get_logical_location_manager () const =0
virtual logical_locations::key	get_current_logical_location () const =0
virtual const char *	maybe_get_sarif_source_language (const char *filename) const =0
virtual void	add_sarif_invocation_properties (sarif_object &invocation_obj) const =0

Detailed Description

A bundle of additional metadata, owned by the diagnostics::context,
for querying things about the client, like version data.   

Constructor & Destructor Documentation

~client_data_hooks()

virtual diagnostics::client_data_hooks::~client_data_hooks ( )

inlinevirtual

Member Function Documentation

add_sarif_invocation_properties()

virtual void diagnostics::client_data_hooks::add_sarif_invocation_properties ( sarif_object & invocation_obj ) const

pure virtual

Implemented in compiler_data_hooks, diagnostics::client_data_hooks_decorator, and impl_diagnostic_client_data_hooks.

Referenced by diagnostics::client_data_hooks_decorator::add_sarif_invocation_properties(), and diagnostics::sarif_invocation::prepare_to_flush().

dump() [1/2]

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

inline

References DEBUG_FUNCTION, and dump().

Referenced by dump().

dump() [2/2]

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

References diagnostics::dumping::emit_heading(), diagnostics::dumping::emit_none(), and get_logical_location_manager().

Referenced by diagnostics::context::dump().

get_any_version_info()

virtual const client_version_info * diagnostics::client_data_hooks::get_any_version_info ( ) const

pure virtual

Implemented in compiler_data_hooks, diagnostics::client_data_hooks_decorator, and impl_diagnostic_client_data_hooks.

Referenced by diagnostics::client_data_hooks_decorator::get_any_version_info(), diagnostics::sarif_builder::make_driver_tool_component_object(), and diagnostics::sarif_builder::make_tool_object().

get_current_logical_location()

virtual logical_locations::key diagnostics::client_data_hooks::get_current_logical_location ( ) const

pure virtual

Implemented in compiler_data_hooks, diagnostics::client_data_hooks_decorator, impl_diagnostic_client_data_hooks, and json_client_data_hooks.

Referenced by diagnostics::client_data_hooks_decorator::get_current_logical_location(), diagnostics::html_builder::make_element_for_diagnostic(), and diagnostics::sarif_builder::make_locations_arr().

get_logical_location_manager()

virtual const logical_locations::manager * diagnostics::client_data_hooks::get_logical_location_manager ( ) const

pure virtual

Implemented in compiler_data_hooks, diagnostics::client_data_hooks_decorator, impl_diagnostic_client_data_hooks, and json_client_data_hooks.

Referenced by dump(), diagnostics::client_data_hooks_decorator::get_logical_location_manager(), diagnostics::context::get_logical_location_manager(), and diagnostics::sarif_builder::get_logical_location_manager().

maybe_get_sarif_source_language()

virtual const char * diagnostics::client_data_hooks::maybe_get_sarif_source_language ( const char * filename ) const

pure virtual

Implemented in compiler_data_hooks, diagnostics::client_data_hooks_decorator, impl_diagnostic_client_data_hooks, and json_client_data_hooks.

Referenced by diagnostics::sarif_builder::get_or_create_artifact(), and diagnostics::client_data_hooks_decorator::maybe_get_sarif_source_language().

---

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

• client-data-hooks.h
• diagnostics/context.cc