GCC Middle and Back End API Reference
json::object Class Reference

#include <json.h>

Inheritance diagram for json::object:
Collaboration diagram for json::object:

Public Member Functions

 ~object ()
 
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)
 
valueget (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

map_t m_map
 
auto_vec< const char * > m_keys
 

Detailed Description

Subclass of value for objects: a collection of key/value pairs
preserving the ordering in which keys were inserted.

Preserving the order eliminates non-determinism in the output,
making it easier for the user to compare repeated invocations.   

Member Typedef Documentation

◆ map_t

Constructor & Destructor Documentation

◆ ~object()

object::~object ( )
class json::object, a subclass of json::value, representing
an ordered collection of key/value pairs.   
json:object's dtor.   

References hash_map< KeyId, Value, Traits >::begin(), hash_map< KeyId, Value, Traits >::end(), free(), and m_map.

Member Function Documentation

◆ 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().

◆ get()

◆ get_kind()

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

Implements json::value.

References json::JSON_OBJECT.

◆ is_empty()

bool json::object::is_empty ( ) const
inline

◆ print()

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

◆ set() [1/2]

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

References set().

◆ set() [2/2]

void object::set ( const char * key,
value * v )
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(), m_keys, 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(), sarif_artifact::populate_contents(), sarif_artifact::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(), set(), sarif_builder::set_any_logical_locs_arr(), set_bool(), set_float(), set_integer(), and set_string().

◆ set_bool()

void object::set_bool ( const char * key,
bool v )
Set value of KEY within this object to the JSON
literal true or false, based on V.   

References 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 )
Set value of KEY within this object to a JSON
floating point value based on V.   

References set().

◆ set_integer()

◆ set_string()

Field Documentation

◆ m_keys

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

Referenced by print(), and set().

◆ m_map

map_t json::object::m_map
private

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


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