The type of an expression, extends irept. More...

#include <type.h>

Inheritance diagram for typet:

Collaboration diagram for typet:

Public Member Functions
	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. More...

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

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

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

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 More...

bool	ordering (const irept &other) const
	defines ordering on the internal representation More...

int	compare (const irept &i) const
	defines ordering on the internal representation comments are ignored More...

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 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) More...

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. More...

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) More...

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 More...

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. More...

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. More...

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

The type of an expression, extends irept.

Types may have subtypes. This is modeled with two subs named “subtype” (a single type) and “subtypes” (a vector of types). The class typet only adds specialized methods for accessing the subtype information to the interface of irept. For pre-defined types see std_types.h and mathematical_types.h.

Definition at line 28 of file type.h.

Constructor & Destructor Documentation

◆ typet() [1/3]

typet::typet ( )

inline

Definition at line 31 of file type.h.

◆ typet() [2/3]

typet::typet ( const irep_idt & _id )

inlineexplicit

Definition at line 33 of file type.h.

◆ typet() [3/3]

typet::typet	(	irep_idt	_id,
		typet	_subtype
	)

inline

Definition at line 37 of file type.h.

Member Function Documentation

◆ add_source_location()

source_locationt& typet::add_source_location ( )

inline

Definition at line 77 of file type.h.

◆ add_subtype()

typet& typet::add_subtype ( )

inline

Definition at line 53 of file type.h.

◆ add_type()

typet& typet::add_type ( const irep_idt & name )

inline

Definition at line 115 of file type.h.

◆ check()

static void typet::check	(	const typet &	,
		const	validation_modet = `validation_modet::INVARIANT`
	)

inlinestatic

Check that the type is well-formed (shallow checks only, i.e., subtypes are not checked)

Subclasses may override this function to provide specific well-formedness checks for the corresponding types.

The validation mode indicates whether well-formedness check failures are reported via DATA_INVARIANT violations or exceptions.

Definition at line 134 of file type.h.

◆ find_type()

const typet& typet::find_type ( const irep_idt & name ) const

inline

Definition at line 120 of file type.h.

◆ has_subtype()

bool typet::has_subtype ( ) const

inline

Definition at line 64 of file type.h.

◆ has_subtypes()

bool typet::has_subtypes ( ) const

inline

Definition at line 61 of file type.h.

◆ remove_subtype()

void typet::remove_subtype ( )

inline

Definition at line 69 of file type.h.

◆ source_location()

const source_locationt& typet::source_location ( ) const

inline

Definition at line 72 of file type.h.

◆ validate()

static void typet::validate	(	const typet &	type,
		const namespacet &	,
		const validation_modet	vm = `validation_modet::INVARIANT`
	)

inlinestatic

Check that the type is well-formed, assuming that its subtypes have already been checked for well-formedness.

Subclasses may override this function to provide specific well-formedness checks for the corresponding types.

The validation mode indicates whether well-formedness check failures are reported via DATA_INVARIANT violations or exceptions.

Definition at line 146 of file type.h.

◆ validate_full()

static void typet::validate_full	(	const typet &	type,
		const namespacet &	ns,
		const validation_modet	vm = `validation_modet::INVARIANT`
	)

inlinestatic

Check that the type is well-formed (full check, including checks of subtypes)

Subclasses may override this function, though in most cases the provided implementation should be sufficient.

The validation mode indicates whether well-formedness check failures are reported via DATA_INVARIANT violations or exceptions.

Definition at line 162 of file type.h.

◆ with_source_location() [1/4]

typet& typet::with_source_location ( const typet & type ) &

inline

This is a 'fluent style' method for adding a source location.

Definition at line 107 of file type.h.

◆ with_source_location() [2/4]

typet&& typet::with_source_location ( const typet & type ) &&

inline

This is a 'fluent style' method for creating a new type with an added-on source location.

Definition at line 101 of file type.h.

◆ with_source_location() [3/4]

typet& typet::with_source_location ( source_locationt location ) &

inline

This is a 'fluent style' method for adding a source location.

Definition at line 92 of file type.h.

◆ with_source_location() [4/4]

typet&& typet::with_source_location ( source_locationt location ) &&

inline

This is a 'fluent style' method for creating a new type with an added-on source location.

Definition at line 84 of file type.h.

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

/home/runner/work/cbmc/cbmc/src/util/type.h

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ typet() [1/3]

◆ typet() [2/3]

◆ typet() [3/3]

Member Function Documentation

◆ add_source_location()

◆ add_subtype()

◆ add_type()

◆ check()

◆ find_type()

◆ has_subtype()

◆ has_subtypes()

◆ remove_subtype()

◆ source_location()

◆ validate()

◆ validate_full()

◆ with_source_location() [1/4]

◆ with_source_location() [2/4]

◆ with_source_location() [3/4]

◆ with_source_location() [4/4]