#include <c_types.h>

Inheritance diagram for code_with_contract_typet:

Collaboration diagram for code_with_contract_typet:

Public Member Functions
	code_with_contract_typet (parameterst _parameters, typet _return_type)
	Constructs a new 'code with contract' type, i.e., a function type decorated with a function contract. More...

bool	has_contract () const

const exprt::operandst &	assigns () const

exprt::operandst &	assigns ()

const exprt::operandst &	requires_contract () const

exprt::operandst &	requires_contract ()

const exprt::operandst &	requires () const

exprt::operandst &	requires ()

const exprt::operandst &	ensures_contract () const

exprt::operandst &	ensures_contract ()

const exprt::operandst &	ensures () const

exprt::operandst &	ensures ()

Public Member Functions inherited from code_typet
	code_typet (parameterst _parameters, typet _return_type)
	Constructs a new code type, i.e., function type. More...

bool	has_ellipsis () const

bool	has_this () const

const parametert *	get_this () const

bool	is_KnR () const

void	make_ellipsis ()

void	remove_ellipsis ()

const typet &	return_type () const

typet &	return_type ()

const parameterst &	parameters () const

parameterst &	parameters ()

bool	get_inlined () const

void	set_inlined (bool value)

const irep_idt &	get_access () const

void	set_access (const irep_idt &access)

bool	get_is_constructor () const

void	set_is_constructor ()

std::vector< irep_idt >	parameter_identifiers () const
	Produces the list of parameter identifiers. More...

parameter_indicest	parameter_indices () const
	Get a map from parameter name to its index. More...

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 &	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 ()

Additional Inherited Members
Public Types inherited from code_typet
typedef std::vector< parametert >	parameterst

typedef std::unordered_map< irep_idt, std::size_t >	parameter_indicest

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

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

Protected Member Functions inherited from typet
const typet &	subtype () const

typet &	subtype ()

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

Definition at line 357 of file c_types.h.

Constructor & Destructor Documentation

◆ code_with_contract_typet()

code_with_contract_typet::code_with_contract_typet	(	parameterst	_parameters,
		typet	_return_type
	)

inline

Constructs a new 'code with contract' type, i.e., a function type decorated with a function contract.

Parameters

_parameters	The vector of function parameters.
_return_type	The return type.

Definition at line 364 of file c_types.h.

Member Function Documentation

◆ assigns() [1/2]

exprt::operandst& code_with_contract_typet::assigns ( )

inline

Definition at line 381 of file c_types.h.

◆ assigns() [2/2]

const exprt::operandst& code_with_contract_typet::assigns ( ) const

inline

Definition at line 376 of file c_types.h.

◆ ensures() [1/2]

exprt::operandst& code_with_contract_typet::ensures ( )

inline

Definition at line 423 of file c_types.h.

◆ ensures() [2/2]

const exprt::operandst& code_with_contract_typet::ensures ( ) const

inline

Definition at line 418 of file c_types.h.

◆ ensures_contract() [1/2]

exprt::operandst& code_with_contract_typet::ensures_contract ( )

inline

Definition at line 413 of file c_types.h.

◆ ensures_contract() [2/2]

const exprt::operandst& code_with_contract_typet::ensures_contract ( ) const

inline

Definition at line 407 of file c_types.h.

◆ has_contract()

bool code_with_contract_typet::has_contract ( ) const

inline

Definition at line 369 of file c_types.h.

◆ requires() [1/2]

exprt::operandst& code_with_contract_typet::requires ( )

inline

Definition at line 402 of file c_types.h.

◆ requires() [2/2]

const exprt::operandst& code_with_contract_typet::requires ( ) const

inline

Definition at line 397 of file c_types.h.

◆ requires_contract() [1/2]

exprt::operandst& code_with_contract_typet::requires_contract ( )

inline

Definition at line 392 of file c_types.h.

◆ requires_contract() [2/2]

const exprt::operandst& code_with_contract_typet::requires_contract ( ) const

inline

Definition at line 386 of file c_types.h.

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

/home/runner/work/cbmc-documentation/cbmc-documentation/src/util/c_types.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ code_with_contract_typet()

Member Function Documentation

◆ assigns() [1/2]

◆ assigns() [2/2]

◆ ensures() [1/2]

◆ ensures() [2/2]

◆ ensures_contract() [1/2]

◆ ensures_contract() [2/2]

◆ has_contract()

◆ requires() [1/2]

◆ requires() [2/2]

◆ requires_contract() [1/2]

◆ requires_contract() [2/2]