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. More... | |
| const symbolt & | lookup (const symbol_exprt &) const |
| Generic lookup function for a symbol expression in a symbol table. More... | |
| const symbolt & | lookup (const tag_typet &) const |
| Generic lookup function for a tag type in a symbol table. More... | |
| virtual | ~namespace_baset () |
| void | follow_macros (exprt &) const |
| Follow macros to their values in a given expression. More... | |
| const typet & | follow (const typet &) const |
| Resolve type symbol to the type it points to. More... | |
| const union_typet & | follow_tag (const union_tag_typet &) const |
| Follow type tag of union type. More... | |
| const struct_typet & | follow_tag (const struct_tag_typet &) const |
| Follow type tag of struct type. More... | |
| const c_enum_typet & | follow_tag (const c_enum_tag_typet &) const |
| Follow type tag of enum type. More... | |
| 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. More... | |
| 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. More... | |
| virtual bool | lookup (const irep_idt &name, const symbolt *&symbol) const =0 |
Searches for a symbol named name. More... | |
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 36 of file namespace.h.
Constructor & Destructor Documentation
◆ ~namespace_baset()
|
virtual |
Definition at line 20 of file namespace.cpp.
Member Function Documentation
◆ follow()
Resolve type symbol to the type it points to.
- Deprecated:
- "deprecated since " "2024" "-" "2" "-" "19" "; " "use follow_tag(...) instead"
- Parameters
-
src The type we want to resolve in the symbol table.
- Returns
- The resolved type.
Definition at line 49 of file namespace.cpp.
◆ 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 107 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 87 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 97 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 75 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 63 of file namespace.cpp.
◆ lookup() [1/4]
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 46 of file namespace.h.
◆ lookup() [2/4]
|
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 multi_namespacet, and 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]
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()
|
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 multi_namespacet, and 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
