Base type for structs and unions. More...

#include <std_types.h>

Inheritance diagram for struct_union_typet:

Collaboration diagram for struct_union_typet:

Classes
class	componentt

Public Types
typedef std::vector< componentt >	componentst

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.

Public Member Functions
	struct_union_typet (const irep_idt &_id)

	struct_union_typet (const irep_idt &_id, componentst _components)

const componentst &	components () const

componentst &	components ()

bool	has_component (const irep_idt &component_name) const

const componentt &	get_component (const irep_idt &component_name) const
	Get the reference to a component with given name.

std::size_t	component_number (const irep_idt &component_name) const
	Return the sequence number of the component with given name.

const typet &	component_type (const irep_idt &component_name) const

irep_idt	get_tag () const

void	set_tag (const irep_idt &tag)

bool	is_class () const
	A struct may be a class, where members may have access restrictions.

irep_idt	default_access () const
	Return the access specification for members where access has not been modified.

bool	is_incomplete () const
	A struct/union may be incomplete.

void	make_incomplete ()
	A struct/union may be incomplete.

Public Member Functions inherited from typet
	typet ()

	typet (const irep_idt &_id)

	typet (irep_idt _id, typet _subtype)

typet &	add_subtype ()

bool	has_subtypes () const

bool	has_subtype () const

void	remove_subtype ()

const source_locationt &	source_location () const

source_locationt &	add_source_location ()

typet &&	with_source_location (source_locationt location) &&
	This is a 'fluent style' method for creating a new type with an added-on source location.

typet &	with_source_location (source_locationt location) &
	This is a 'fluent style' method for adding a source location.

typet &&	with_source_location (const typet &type) &&
	This is a 'fluent style' method for creating a new type with an added-on source location.

typet &	with_source_location (const typet &type) &
	This is a 'fluent style' method for adding a source location.

typet &	add_type (const irep_idt &name)

const typet &	find_type (const irep_idt &name) 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 ()

Additional Inherited Members
Static Public Member Functions inherited from typet
static void	check (const typet &, const validation_modet=validation_modet::INVARIANT)
	Check that the type is well-formed (shallow checks only, i.e., subtypes are not checked)

static void	validate (const typet &type, const namespacet &, const validation_modet vm=validation_modet::INVARIANT)
	Check that the type is well-formed, assuming that its subtypes have already been checked for well-formedness.

static void	validate_full (const typet &type, const namespacet &ns, const validation_modet vm=validation_modet::INVARIANT)
	Check that the type is well-formed (full check, including checks of subtypes)

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 inherited from sharing_treet< irept, forward_list_as_mapt< irep_idt, irept > >
void	detach ()

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

Base type for structs and unions.

For example C structs, C unions, C++ classes, Java classes.

Definition at line 61 of file std_types.h.

Member Typedef Documentation

◆ componentst

typedef std::vector<componentt> struct_union_typet::componentst

Definition at line 140 of file std_types.h.

Constructor & Destructor Documentation

◆ struct_union_typet() [1/2]

struct_union_typet::struct_union_typet ( const irep_idt & _id )

inlineexplicit

Definition at line 64 of file std_types.h.

◆ struct_union_typet() [2/2]

struct_union_typet::struct_union_typet	(	const irep_idt &	_id,
		componentst	_components
	)

inline

Definition at line 142 of file std_types.h.

Member Function Documentation

◆ component_number()

std::size_t struct_union_typet::component_number ( const irep_idt & component_name ) const

Return the sequence number of the component with given name.

Definition at line 47 of file std_types.cpp.

◆ component_type()

const typet & struct_union_typet::component_type ( const irep_idt & component_name ) const

Definition at line 77 of file std_types.cpp.

◆ components() [1/2]

componentst & struct_union_typet::components ( )

inline

Definition at line 152 of file std_types.h.

◆ components() [2/2]

const componentst & struct_union_typet::components ( ) const

inline

Definition at line 147 of file std_types.h.

◆ default_access()

irep_idt struct_union_typet::default_access ( ) const

inline

Return the access specification for members where access has not been modified.

Definition at line 179 of file std_types.h.

◆ get_component()

const struct_union_typet::componentt & struct_union_typet::get_component ( const irep_idt & component_name ) const

Get the reference to a component with given name.

Definition at line 64 of file std_types.cpp.

◆ get_tag()

irep_idt struct_union_typet::get_tag ( ) const

inline

Definition at line 168 of file std_types.h.

◆ has_component()

bool struct_union_typet::has_component ( const irep_idt & component_name ) const

inline

Definition at line 157 of file std_types.h.

◆ is_class()

bool struct_union_typet::is_class ( ) const

inline

A struct may be a class, where members may have access restrictions.

Definition at line 172 of file std_types.h.

◆ is_incomplete()

bool struct_union_typet::is_incomplete ( ) const

inline

A struct/union may be incomplete.

Definition at line 185 of file std_types.h.

◆ make_incomplete()

void struct_union_typet::make_incomplete ( )

inline

A struct/union may be incomplete.

Definition at line 191 of file std_types.h.

◆ set_tag()

void struct_union_typet::set_tag ( const irep_idt & tag )

inline

Definition at line 169 of file std_types.h.

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

/home/runner/work/cbmc/cbmc/src/util/std_types.h
/home/runner/work/cbmc/cbmc/src/util/std_types.cpp

Classes

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ componentst

Constructor & Destructor Documentation

◆ struct_union_typet() [1/2]

◆ struct_union_typet() [2/2]

Member Function Documentation

◆ component_number()

◆ component_type()

◆ components() [1/2]

◆ components() [2/2]

◆ default_access()

◆ get_component()

◆ get_tag()

◆ has_component()

◆ is_class()

◆ is_incomplete()

◆ make_incomplete()

◆ set_tag()