Basic interface for a namespace. More...

#include <namespace.h>

Inheritance diagram for namespace_baset:

Public Member Functions
const symbolt &	lookup (const irep_idt &name) const
	Lookup a symbol in the namespace.

const symbolt &	lookup (const symbol_exprt &) const
	Generic lookup function for a symbol expression in a symbol table.

const symbolt &	lookup (const tag_typet &) const
	Generic lookup function for a tag type in a symbol table.

virtual	~namespace_baset ()

void	follow_macros (exprt &) const
	Follow macros to their values in a given expression.

const union_typet &	follow_tag (const union_tag_typet &) const
	Follow type tag of union type.

const struct_typet &	follow_tag (const struct_tag_typet &) const
	Follow type tag of struct type.

const c_enum_typet &	follow_tag (const c_enum_tag_typet &) const
	Follow type tag of enum type.

const struct_union_typet &	follow_tag (const struct_or_union_tag_typet &) const
	Resolve a `struct_tag_typet` or `union_tag_typet` to the complete version.

virtual std::size_t	smallest_unused_suffix (const std::string &prefix) const =0
	Returns the minimal integer n such that there is no symbol (in any of the symbol tables) whose name is of the form "An" where A is `prefix`.

virtual bool	lookup (const irep_idt &name, const symbolt *&symbol) const =0
	Searches for a symbol named `name`.

Detailed Description

Basic interface for a namespace.

This is not used in practice, as the one being used is namespacet which uses two symbol tables, and multi_namespacet which can combine more than two.

Definition at line 35 of file namespace.h.

Constructor & Destructor Documentation

◆ ~namespace_baset()

namespace_baset::~namespace_baset ( )

virtual

Definition at line 20 of file namespace.cpp.

Member Function Documentation

◆ follow_macros()

void namespace_baset::follow_macros ( exprt & expr ) const

Follow macros to their values in a given expression.

Parameters

expr	The expression to follow macros in.

Definition at line 93 of file namespace.cpp.

◆ follow_tag() [1/4]

const c_enum_typet & namespace_baset::follow_tag ( const c_enum_tag_typet & src ) const

Follow type tag of enum type.

Parameters

src	The enum tag type to dispatch on.

Returns: The type of the enum tag in the symbol table.

Definition at line 73 of file namespace.cpp.

◆ follow_tag() [2/4]

const struct_union_typet & namespace_baset::follow_tag ( const struct_or_union_tag_typet & src ) const

Resolve a struct_tag_typet or union_tag_typet to the complete version.

Definition at line 83 of file namespace.cpp.

◆ follow_tag() [3/4]

const struct_typet & namespace_baset::follow_tag ( const struct_tag_typet & src ) const

Follow type tag of struct type.

Parameters

src	The struct tag type to dispatch on.

Returns: The type of the struct tag in the symbol table.

Definition at line 61 of file namespace.cpp.

◆ follow_tag() [4/4]

const union_typet & namespace_baset::follow_tag ( const union_tag_typet & src ) const

Follow type tag of union type.

Parameters

src	The union tag type to dispatch on.

Returns: The type of the union tag in the symbol table.

Definition at line 49 of file namespace.cpp.

◆ lookup() [1/4]

const symbolt & namespace_baset::lookup ( const irep_idt & name ) const

inline

Lookup a symbol in the namespace.

Parameters

name	The name of the symbol to lookup.

Returns: A reference to the symbol found.

Remarks: : It is a PRECONDITION that the symbol name exists in the namespace.

Definition at line 45 of file namespace.h.

◆ lookup() [2/4]

virtual bool namespace_baset::lookup	(	const irep_idt &	name,
		const symbolt *&	symbol
	)		const

pure virtual

Searches for a symbol named name.

Iff found, set symbol to point to the symbol and return false; else symbol is unmodified and true is returned. With multiple symbol tables, symbol_table1 is searched first and then symbol_table2.

Returns: False iff the requested symbol is found in at least one of the tables.

Implemented in namespacet, multi_namespacet, namespacet, and multi_namespacet.

◆ lookup() [3/4]

const symbolt & namespace_baset::lookup ( const symbol_exprt & expr ) const

Generic lookup function for a symbol expression in a symbol table.

Parameters

expr	The symbol expression to lookup.

Returns: The symbol found in the namespace.

Remarks: The lookup function called assumes that the symbol we are looking for exists in the symbol table. If it doesn't, it hits an INVARIANT.

Definition at line 30 of file namespace.cpp.

◆ lookup() [4/4]

const symbolt & namespace_baset::lookup ( const tag_typet & type ) const

Generic lookup function for a tag type in a symbol table.

Parameters

type	The tag type to lookup.

Returns: The symbol found in the namespace.

Remarks: The lookup function called assumes that the tag symbol we are looking for exists in the symbol table. If it doesn't, it hits an INVARIANT.

Definition at line 41 of file namespace.cpp.

◆ smallest_unused_suffix()

virtual std::size_t namespace_baset::smallest_unused_suffix ( const std::string & prefix ) const

pure virtual

Returns the minimal integer n such that there is no symbol (in any of the symbol tables) whose name is of the form "An" where A is prefix.

The intended use case is finding the next available symbol name for a sequence of auto-generated symbols.

Implemented in namespacet, and multi_namespacet.

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

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

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~namespace_baset()

Member Function Documentation

◆ follow_macros()

◆ follow_tag() [1/4]

◆ follow_tag() [2/4]

◆ follow_tag() [3/4]

◆ follow_tag() [4/4]

◆ lookup() [1/4]

◆ lookup() [2/4]

◆ lookup() [3/4]

◆ lookup() [4/4]

◆ smallest_unused_suffix()