CBMC
•All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
source_locationt Class Reference

#include <source_location.h>

+ Inheritance diagram for source_locationt:
+ Collaboration diagram for source_locationt:

Public Member Functions

 source_locationt ()
 
std::string as_string () const
 
std::string as_string_with_cwd () const
 
const irep_idt & get_file () const
 
const irep_idt & get_working_directory () const
 
const irep_idt & get_line () const
 
const irep_idt & get_column () const
 
const irep_idt & get_function () const
 
const irep_idt & get_property_id () const
 
const irep_idt & get_property_class () const
 
const irep_idt & get_comment () const
 
const irep_idt & get_case_number () const
 
const irep_idt & get_java_bytecode_index () const
 
const irept & get_basic_block_source_lines () const
 
bool property_fatal () const
 
void set_file (const irep_idt &file)
 
void set_working_directory (const irep_idt &cwd)
 
void set_line (const irep_idt &line)
 
void set_line (unsigned line)
 
void set_column (const irep_idt &column)
 
void set_column (unsigned column)
 
void set_function (const irep_idt &function)
 
void set_property_id (const irep_idt &property_id)
 
void set_property_class (const irep_idt &property_class)
 
void set_comment (const irep_idt &comment)
 
void set_case_number (const irep_idt &number)
 
void set_java_bytecode_index (const irep_idt &index)
 
void set_basic_block_source_lines (irept source_lines)
 
void property_fatal (bool _property_fatal)
 
void set_hide ()
 
bool get_hide () const
 
bool is_built_in () const
 
void merge (const source_locationt &from)
 Set all unset source-location fields in this object to their values in 'from'.
 
std::optional< std::string > full_path () const
 Get a path to the file, including working directory.
 
void add_pragma (const irep_idt &pragma)
 
const irept::named_subt & get_pragmas () const
 
- Public Member Functions inherited from irept
bool is_nil () const
 
bool is_not_nil () const
 
 irept (const irep_idt &_id)
 
 irept (const irep_idt &_id, const named_subt &_named_sub, const subt &_sub)
 
 irept ()=default
 
const irep_idt & id () const
 
const std::string & id_string () const
 
void id (const irep_idt &_data)
 
const irept & find (const irep_idt &name) const
 
irept & add (const irep_idt &name)
 
irept & add (const irep_idt &name, irept irep)
 
const std::string & get_string (const irep_idt &name) const
 
const irep_idt & get (const irep_idt &name) const
 
bool get_bool (const irep_idt &name) const
 
signed int get_int (const irep_idt &name) const
 
std::size_t get_size_t (const irep_idt &name) const
 
long long get_long_long (const irep_idt &name) const
 
void set (const irep_idt &name, const irep_idt &value)
 
void set (const irep_idt &name, irept irep)
 
void set (const irep_idt &name, const long long value)
 
void set_size_t (const irep_idt &name, const std::size_t value)
 
void remove (const irep_idt &name)
 
void move_to_sub (irept &irep)
 
void move_to_named_sub (const irep_idt &name, irept &irep)
 
bool operator== (const irept &other) const
 
bool operator!= (const irept &other) const
 
void swap (irept &irep)
 
bool operator< (const irept &other) const
 defines ordering on the internal representation
 
bool ordering (const irept &other) const
 defines ordering on the internal representation
 
int compare (const irept &i) const
 defines ordering on the internal representation comments are ignored
 
void clear ()
 
void make_nil ()
 
subt & get_sub ()
 
const subt & get_sub () const
 
named_subt & get_named_sub ()
 
const named_subt & get_named_sub () const
 
std::size_t hash () const
 
std::size_t full_hash () const
 
bool full_eq (const irept &other) const
 
std::string pretty (unsigned indent=0, unsigned max_indent=0) const
 
- Public Member Functions inherited from sharing_treet< irept, forward_list_as_mapt< irep_idt, irept > >
 sharing_treet (irep_idt _id)
 
 sharing_treet (irep_idt _id, named_subt _named_sub, subt _sub)
 
 sharing_treet ()
 
 sharing_treet (const sharing_treet &irep)
 
 sharing_treet (sharing_treet &&irep)
 
sharing_treet & operator= (const sharing_treet &irep)
 
sharing_treet & operator= (sharing_treet &&irep)
 
 ~sharing_treet ()
 
const dt & read () const
 
dt & write ()
 

Static Public Member Functions

static bool is_built_in (const std::string &s)
 
static const source_locationt & nil ()
 
- Static Public Member Functions inherited from irept
static bool is_comment (const irep_idt &name)
 
static std::size_t number_of_non_comments (const named_subt &)
 count the number of named_sub elements that are not comments
 

Protected Member Functions

std::string as_string (bool print_cwd) const
 
- Protected Member Functions inherited from sharing_treet< irept, forward_list_as_mapt< irep_idt, irept > >
void detach ()
 

Additional Inherited Members

- Public Types inherited from irept
using baset = tree_implementationt
 
- Public Types inherited from sharing_treet< irept, forward_list_as_mapt< irep_idt, irept > >
using dt = tree_nodet< irept, forward_list_as_mapt< irep_idt, irept >, true >
 
using subt = typename dt::subt
 
using named_subt = typename dt::named_subt
 
using tree_implementationt = sharing_treet
 Used to refer to this class from derived classes.
 
- Static Protected Member Functions inherited from sharing_treet< irept, forward_list_as_mapt< irep_idt, irept > >
static void remove_ref (dt *old_data)
 
static void nonrecursive_destructor (dt *old_data)
 Does the same as remove_ref, but using an explicit stack instead of recursion.
 
- Protected Attributes inherited from sharing_treet< irept, forward_list_as_mapt< irep_idt, irept > >
dt * data
 
- Static Protected Attributes inherited from sharing_treet< irept, forward_list_as_mapt< irep_idt, irept > >
static dt empty_d
 

Detailed Description

Definition at line 19 of file source_location.h.

Constructor & Destructor Documentation

◆ source_locationt()

source_locationt::source_locationt ( )
inline

Definition at line 22 of file source_location.h.

Member Function Documentation

◆ add_pragma()

void source_locationt::add_pragma ( const irep_idt &  pragma)
inline

Definition at line 207 of file source_location.h.

◆ as_string() [1/2]

std::string source_locationt::as_string ( ) const
inline

Definition at line 26 of file source_location.h.

◆ as_string() [2/2]

std::string source_locationt::as_string ( bool  print_cwd) const
protected
parameters: print_cwd, print the absolute path to the file

Definition at line 24 of file source_location.cpp.

◆ as_string_with_cwd()

std::string source_locationt::as_string_with_cwd ( ) const
inline

Definition at line 31 of file source_location.h.

◆ full_path()

std::optional< std::string > source_locationt::full_path ( ) const

Get a path to the file, including working directory.

Returns
Full path unless the file name is empty or refers to a built-in, in which case {} is returned.

Definition at line 88 of file source_location.cpp.

◆ get_basic_block_source_lines()

const irept & source_locationt::get_basic_block_source_lines ( ) const
inline

Definition at line 94 of file source_location.h.

◆ get_case_number()

const irep_idt & source_locationt::get_case_number ( ) const
inline

Definition at line 84 of file source_location.h.

◆ get_column()

const irep_idt & source_locationt::get_column ( ) const
inline

Definition at line 51 of file source_location.h.

◆ get_comment()

const irep_idt & source_locationt::get_comment ( ) const
inline

Definition at line 79 of file source_location.h.

◆ get_file()

const irep_idt & source_locationt::get_file ( ) const
inline

Definition at line 36 of file source_location.h.

◆ get_function()

const irep_idt & source_locationt::get_function ( ) const
inline
Deprecated:
"deprecated since " "2022" "-" "10" "-" "13" "; " "use identifier of containing function"

Definition at line 64 of file source_location.h.

◆ get_hide()

bool source_locationt::get_hide ( ) const
inline

Definition at line 184 of file source_location.h.

◆ get_java_bytecode_index()

const irep_idt & source_locationt::get_java_bytecode_index ( ) const
inline

Definition at line 89 of file source_location.h.

◆ get_line()

const irep_idt & source_locationt::get_line ( ) const
inline

Definition at line 46 of file source_location.h.

◆ get_pragmas()

const irept::named_subt & source_locationt::get_pragmas ( ) const
inline

Definition at line 212 of file source_location.h.

◆ get_property_class()

const irep_idt & source_locationt::get_property_class ( ) const
inline

Definition at line 74 of file source_location.h.

◆ get_property_id()

const irep_idt & source_locationt::get_property_id ( ) const
inline

Definition at line 69 of file source_location.h.

◆ get_working_directory()

const irep_idt & source_locationt::get_working_directory ( ) const
inline

Definition at line 41 of file source_location.h.

◆ is_built_in() [1/2]

bool source_locationt::is_built_in ( ) const
inline

Definition at line 191 of file source_location.h.

◆ is_built_in() [2/2]

bool source_locationt::is_built_in ( const std::string &  s)
static

Definition at line 16 of file source_location.cpp.

◆ merge()

void source_locationt::merge ( const source_locationt &  from)

Set all unset source-location fields in this object to their values in 'from'.

Leave set fields in this object alone.

Definition at line 76 of file source_location.cpp.

◆ nil()

static const source_locationt & source_locationt::nil ( )
inlinestatic

Definition at line 200 of file source_location.h.

◆ property_fatal() [1/2]

bool source_locationt::property_fatal ( ) const
inline

Definition at line 99 of file source_location.h.

◆ property_fatal() [2/2]

void source_locationt::property_fatal ( bool  _property_fatal)
inline

Definition at line 171 of file source_location.h.

◆ set_basic_block_source_lines()

void source_locationt::set_basic_block_source_lines ( irept  source_lines)
inline

Definition at line 166 of file source_location.h.

◆ set_case_number()

void source_locationt::set_case_number ( const irep_idt &  number)
inline

Definition at line 156 of file source_location.h.

◆ set_column() [1/2]

void source_locationt::set_column ( const irep_idt &  column)
inline

Definition at line 124 of file source_location.h.

◆ set_column() [2/2]

void source_locationt::set_column ( unsigned  column)
inline

Definition at line 129 of file source_location.h.

◆ set_comment()

void source_locationt::set_comment ( const irep_idt &  comment)
inline

Definition at line 150 of file source_location.h.

◆ set_file()

void source_locationt::set_file ( const irep_idt &  file)
inline

Definition at line 104 of file source_location.h.

◆ set_function()

void source_locationt::set_function ( const irep_idt &  function)
inline
Deprecated:
"deprecated since " "2022" "-" "10" "-" "13" "; " "use identifier of containing function"

Definition at line 135 of file source_location.h.

◆ set_hide()

void source_locationt::set_hide ( )
inline

Definition at line 179 of file source_location.h.

◆ set_java_bytecode_index()

void source_locationt::set_java_bytecode_index ( const irep_idt &  index)
inline

Definition at line 161 of file source_location.h.

◆ set_line() [1/2]

void source_locationt::set_line ( const irep_idt &  line)
inline

Definition at line 114 of file source_location.h.

◆ set_line() [2/2]

void source_locationt::set_line ( unsigned  line)
inline

Definition at line 119 of file source_location.h.

◆ set_property_class()

void source_locationt::set_property_class ( const irep_idt &  property_class)
inline

Definition at line 145 of file source_location.h.

◆ set_property_id()

void source_locationt::set_property_id ( const irep_idt &  property_id)
inline

Definition at line 140 of file source_location.h.

◆ set_working_directory()

void source_locationt::set_working_directory ( const irep_idt &  cwd)
inline

Definition at line 109 of file source_location.h.

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