Inheritance diagram for sarif_artifact:

[legend]

Collaboration diagram for sarif_artifact:

[legend]

Public Member Functions
	sarif_artifact (const char *filename)

void	add_role (enum diagnostic_artifact_role role, bool embed_contents)

bool	embed_contents_p () const

void	populate_contents (sarif_builder &builder)

void	populate_roles ()

sarif_property_bag &	get_or_create_properties ()

enum kind	get_kind () const final override

void	print (pretty_printer *pp, bool formatted) const final override

bool	is_empty () const

void	set (const char key, value v)

template<typename JsonType >
void	set (const char *key, std::unique_ptr< JsonType > v)

value *	get (const char *key) const

void	set_string (const char key, const char utf8_value)

void	set_integer (const char *key, long v)

void	set_float (const char *key, double v)

void	set_bool (const char *key, bool v)

void	dump (FILE *, bool formatted) const

void DEBUG_FUNCTION	dump () const

Private Types
typedef hash_map< char , value , simple_hashmap_traits< nofree_string_hash, value * > >	map_t

Private Attributes
const char *	m_filename

auto_sbitmap	m_roles

bool	m_embed_contents

map_t	m_map

auto_vec< const char * >	m_keys

Detailed Description

Subclass of sarif_object for SARIF artifact objects
(SARIF v2.1.0 section 3.24).

Member Typedef Documentation

◆ map_t

hash_map<char *, value *, simple_hashmap_traits<nofree_string_hash, value *> > json::object::map_t

privateinherited

Constructor & Destructor Documentation

◆ sarif_artifact()

sarif_artifact::sarif_artifact ( const char * filename )

inline

References bitmap_clear(), and m_roles.

Member Function Documentation

◆ add_role()

void sarif_artifact::add_role	(	enum diagnostic_artifact_role	role,
		bool	embed_contents )

class sarif_artifact : public sarif_object.

Add ROLE to this artifact's roles.
If EMBED_CONTENTS is true, then flag that we will attempt to embed the
contents of this artifact when writing it out.

References analysis_target, bitmap_bit_p, bitmap_set_bit, m_embed_contents, m_roles, result_file, and scanned_file.

Referenced by sarif_builder::get_or_create_artifact().

◆ dump() [1/2]

void value::dump ( ) const

inherited

A convenience function for debugging.
Dump to stderr with formatting, and a trailing newline.

References json::value::dump().

Referenced by json::value::dump().

◆ dump() [2/2]

void value::dump	(	FILE *	outf,
		bool	formatted ) const

inherited

class json::value.

Dump this json::value tree to OUTF.

The key/value pairs of json::objects are printed in the order
in which the keys were originally inserted.

References output_buffer::m_stream, pp_buffer(), pp_flush(), and json::value::print().

Referenced by generate_results().

◆ embed_contents_p()

bool sarif_artifact::embed_contents_p ( ) const

inline

References m_embed_contents.

Referenced by sarif_builder::make_run_object().

◆ get()

value * object::get ( const char * key ) const

inherited

Get the json::value * for KEY.

The object retains ownership of the value.

References gcc_assert, json::object::get(), json::object::m_map, and NULL.

Referenced by json::object::get(), sarif_location::get_id(), sarif_code_flow::get_or_append_thread_flow(), sarif_object::get_or_create_properties(), sarif_location_relationship::get_target_id(), sarif_location_relationship::lazily_add_kind(), sarif_location::lazily_add_relationship_object(), sarif_location::lazily_add_relationships_array(), sarif_builder::make_code_flow_object(), sarif_builder::make_location_object(), sarif_builder::make_location_object(), sarif_builder::make_location_object(), and sarif_location_manager::process_worklist_item().

◆ get_kind()

enum kind json::object::get_kind ( ) const

inlinefinaloverridevirtualinherited

Implements json::value.

References json::JSON_OBJECT.

◆ get_or_create_properties()

sarif_property_bag & sarif_object::get_or_create_properties ( )

inherited

class sarif_object : public json::object.

References json::object::get(), json::value::get_kind(), json::JSON_OBJECT, and json::object::set().

Referenced by sarif_ice_notification::sarif_ice_notification().

◆ is_empty()

bool json::object::is_empty ( ) const

inlineinherited

References hash_map< KeyId, Value, Traits >::is_empty(), and json::object::m_map.

◆ populate_contents()

void sarif_artifact::populate_contents ( sarif_builder & builder )

Populate the "contents" property (SARIF v2.1.0 section 3.24.8).
We do this after initialization to
(a) ensure that any charset options have been set
(b) only populate it for artifacts that are referenced by a location.

References m_filename, sarif_builder::maybe_make_artifact_content_object(), and json::object::set().

Referenced by sarif_builder::make_run_object().

◆ populate_roles()

void sarif_artifact::populate_roles ( )

Populate the "roles" property of this sarif_artifact with a new
json::array for the artifact.roles property (SARIF v2.1.0 section 3.24.6)
containing strings such as "analysisTarget", "resultFile"
and/or "tracedFile".

References bitmap_bit_p, bitmap_empty_p(), get_artifact_role_string(), i, m_roles, make_unique(), NUM_ROLES, and json::object::set().

Referenced by sarif_builder::make_run_object().

◆ print()

void object::print	(	pretty_printer *	pp,
		bool	formatted ) const

finaloverridevirtualinherited

Implementation of json::value::print for json::object.

Implements json::value.

References FOR_EACH_VEC_ELT, hash_map< KeyId, Value, Traits >::get(), i, json::object::m_keys, json::object::m_map, pp_character(), pp_indent(), pp_indentation(), pp_newline(), pp_space, pp_string(), json::value::print(), and print_escaped_json_string().

Referenced by generate_results().

◆ set() [1/2]

template<typename JsonType >

void json::object::set	(	const char *	key,
		std::unique_ptr< JsonType >	v )

inlineinherited

References json::object::set().

◆ set() [2/2]

void object::set	(	const char *	key,
		value *	v )

inherited

Set the json::value * for KEY, taking ownership of V
(and taking a copy of KEY if necessary).

References gcc_assert, hash_map< KeyId, Value, Traits >::get(), json::object::m_keys, json::object::m_map, and hash_map< KeyId, Value, Traits >::put().

Referenced by optrecord_json_writer::add_pass_list(), optrecord_json_writer::add_record(), sarif_location_manager::add_related_location(), compiler_data_hooks::add_sarif_invocation_properties(), generate_results(), sarif_builder::get_or_create_artifact(), sarif_object::get_or_create_properties(), optrecord_json_writer::inlining_chain_to_json(), sarif_location_relationship::lazily_add_kind(), sarif_location::lazily_add_relationships_array(), sarif_builder::make_fix_object(), sarif_builder::make_replacement_object(), sarif_builder::make_result_object(), sarif_builder::make_run_object(), sarif_builder::make_tool_object(), sarif_builder::make_top_level_object(), infinite_loop_diagnostic::maybe_add_sarif_properties(), sarif_builder::maybe_make_cwe_taxonomy_object(), sarif_builder::maybe_make_physical_location_object(), json_output_format::on_report_diagnostic(), optrecord_json_writer::optinfo_to_json(), optrecord_json_writer::optrecord_json_writer(), output_intermediate_json_line(), output_json_intermediate_file(), optrecord_json_writer::pass_to_json(), populate_contents(), populate_roles(), sarif_builder::populate_thread_flow_location_object(), sarif_invocation::prepare_to_flush(), sarif_code_flow::sarif_code_flow(), sarif_ice_notification::sarif_ice_notification(), sarif_invocation::sarif_invocation(), sarif_thread_flow::sarif_thread_flow(), json::object::set(), sarif_builder::set_any_logical_locs_arr(), json::object::set_bool(), json::object::set_float(), json::object::set_integer(), and json::object::set_string().

◆ set_bool()

void object::set_bool	(	const char *	key,
		bool	v )

inherited

Set value of KEY within this object to the JSON
literal true or false, based on V.

References json::object::set().

Referenced by sarif_builder::make_location_object(), json_output_format::on_report_diagnostic(), output_intermediate_json_line(), and sarif_invocation::prepare_to_flush().

◆ set_float()

void object::set_float	(	const char *	key,
		double	v )

inherited

Set value of KEY within this object to a JSON
floating point value based on V.

References json::object::set().

◆ set_integer()

void object::set_integer	(	const char *	key,
		long	v )

inherited

Set value of KEY within this object to a JSON
integer value based on V.

References json::object::set().

Referenced by optrecord_json_writer::impl_location_to_json(), sarif_location::lazily_add_id(), optrecord_json_writer::location_to_json(), infinite_recursion_diagnostic::maybe_add_sarif_properties(), sarif_result::on_nested_diagnostic(), json_output_format::on_report_diagnostic(), output_intermediate_json_line(), optrecord_json_writer::pass_to_json(), sarif_builder::populate_thread_flow_location_object(), optrecord_json_writer::profile_count_to_json(), and sarif_location_relationship::sarif_location_relationship().

◆ set_string()

void object::set_string	(	const char *	key,
		const char *	utf8_value )

inherited

Set value of KEY within this object to a JSON
string value based on UTF8_VALUE.

References json::object::set().

Field Documentation

◆ m_embed_contents

bool sarif_artifact::m_embed_contents

private

Referenced by add_role(), and embed_contents_p().

◆ m_filename

const char* sarif_artifact::m_filename

private

Referenced by populate_contents().

◆ m_keys

auto_vec<const char *> json::object::m_keys

privateinherited

Referenced by json::object::print(), and json::object::set().

◆ m_map

map_t json::object::m_map

privateinherited

Referenced by json::object::get(), json::object::is_empty(), json::object::print(), json::object::set(), and json::object::~object().

◆ m_roles

auto_sbitmap sarif_artifact::m_roles

private

Referenced by add_role(), populate_roles(), and sarif_artifact().

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

diagnostic-format-sarif.cc

Public Member Functions

Private Types

Private Attributes

Detailed Description

Member Typedef Documentation

◆ map_t

Constructor & Destructor Documentation

◆ sarif_artifact()

Member Function Documentation

◆ add_role()

◆ dump() [1/2]

◆ dump() [2/2]

◆ embed_contents_p()

◆ get()

◆ get_kind()

◆ get_or_create_properties()

◆ is_empty()

◆ populate_contents()

◆ populate_roles()

◆ print()

◆ set() [1/2]

◆ set() [2/2]

◆ set_bool()

◆ set_float()

◆ set_integer()

◆ set_string()

Field Documentation

◆ m_embed_contents

◆ m_filename

◆ m_keys

◆ m_map

◆ m_roles