SgVariableSymbol¶
This class represents the concept of a variable name within the compiler (a
Synopsis¶
Declared in <src/frontend/SageIII/Cxx_Grammar.h> (not stored in Git)
class [[visibility("default")]] SgVariableSymbol
: public SgSymbol Description¶
shared container for the declaration of a variable (SgInitializedName)). Symbols are a simpler way for the compiler to quickly associate types, declarations and names. This symbol is specific to holding a variable name.
- Internal: Symbols are placed into scopes (more precisely into symbol tables held in each SgScopeStatement). Most symbols are only in a single symbol table, but the SgVariableSymbol can exist in two scopes if it is a static data member declared both in its class (SgClassDefinition) and outside of the class (in global scope or a namespace scope (SgGlobal or SgNamespaceDefinitionStatement)).
- Todo: Need to figure out if it is such a great idea of a single symbol to be in two scopes or if it would be better to use two different symbols (since there are two different SgInitializedName object built (the last one referencing the previous one through the p_prev_decl_item pointer)).
- Todo: The get_type() function can return NULL when the get_definition() is NULL. I think we should have assertiosn to make sure that get_definition is a valid pointer and that get_type() should not return NULL.
- See also: SgInitializedName
- See also: Example of using a SgVariableSymbol object
Member functions
SgVariableSymbol::get_name() const¶
Access function for getting name from declarations or types internally.
- Internal: This is a virtual function.
- Return: Returns SgName.
SgVariableSymbol::get_type() const¶
This function returns the type associated with the named entity.
- Internal: This is a virtual function.
- Return: Returns SgType*.
Base Classes¶
| Name | Description |
|---|---|
SgSymbol | This class represents the concept of a name within the compiler. |
Type Aliases¶
| Name |
|---|
base_node_type |
Enums¶
| Name | Description |
|---|---|
Unnamed enum | static variant value |
Member Functions¶
| Name | Description |
|---|---|
SgVariableSymbolSgVariableSymbol(SgInitializedName* declaration = NULL); [constructor] | Default constructor |
~SgVariableSymbolvirtual ~SgVariableSymbol(); [destructor] [virtual] | Destructor |
acceptvirtual void accept(ROSE_VisitorPattern& visitor) override; [virtual] | support for the classic visitor pattern done in GoF |
appendDestructorOwnedNodesvirtual void appendDestructorOwnedNodes(std::vector<SgNode*>& nodes) const override; [virtual] | |
class_namevirtual std::string class_name() const override; [virtual] | returns a string representing the class name |
copyvirtual SgNode* copy(SgCopyHelp& help) const override; [virtual] | |
get_childIndexvirtual size_t get_childIndex(SgNode* child) const override; [virtual] | index-based access to traversal successors by child node |
get_declarationSgInitializedName* get_declaration() const; | |
get_namevirtual SgName get_name() const override; [virtual] | |
get_numberOfTraversalSuccessorsvirtual size_t get_numberOfTraversalSuccessors() const override; [virtual] | return number of children in the traversal successor list |
get_symbol_basisvirtual SgNode* get_symbol_basis() const override; [virtual] | |
get_traversalSuccessorByIndexvirtual SgNode* get_traversalSuccessorByIndex(size_t idx) const override; [virtual] | index-based access to traversal successors by index number |
get_traversalSuccessorContainervirtual std::vector<SgNode*> get_traversalSuccessorContainer() const override; [virtual] | container of pointers to AST successor nodes used in the traversal overridden in every class by generated implementation |
get_traversalSuccessorIsListElementvirtual std::vector<bool> get_traversalSuccessorIsListElement() const override; [virtual] | |
get_traversalSuccessorNamesContainervirtual std::vector<std::string> get_traversalSuccessorNamesContainer() const override; [virtual] | container of names of variables or container indices used used in the traversal to access AST successor nodes overridden in every class by generated implementation |
get_typevirtual SgType* get_type() const override; [virtual] | |
operator deletevoid operator delete( void* pointer, size_t size); | deallocated memory for IR node (returns memory to memory pool for reuse) |
operator newvoid* operator new(size_t size); | returns pointer to newly allocated IR node |
processDataMemberReferenceToPointersvirtual void processDataMemberReferenceToPointers(ReferenceToPointerHandler*) override; [virtual] | Pass references to stored node pointers to a handler. |
returnDataMemberPointersvirtual std::vector<std::pair<SgNode*, std::string>> returnDataMemberPointers() const override; [virtual] | Return the node pointers stored in this node's data members. |
roseRTIvirtual RTIReturnType roseRTI() override; [virtual] | return C++ Runtime-Time-Information |
sage_class_namevirtual char const* sage_class_name() const override; [virtual] | returns a C style string (char*) representing the class name |
set_declarationvoid set_declaration(SgInitializedName* declaration); | |
variantTvirtual VariantT variantT() const override; [virtual] | returns new style SageIII enum values |
Static Member Functions¶
| Name | Description |
|---|---|
memoryUsagestatic size_t memoryUsage(); | Returns the size in bytes of the total memory allocated for all IR nodes of this type |
numberOfNodesstatic size_t numberOfNodes(); | Returns the total number of IR nodes of this type |
traverseMemoryPoolNodesstatic void traverseMemoryPoolNodes(ROSE_VisitTraversal& visit); | FOR INTERNAL USE Support for visitor pattern over all IR nodes by type of IR node. |
traverseMemoryPoolVisitorPatternstatic void traverseMemoryPoolVisitorPattern(ROSE_VisitorPattern& visitor); | FOR INTERNAL USE Support for visitor pattern. |
visitRepresentativeNodestatic void visitRepresentativeNode(ROSE_VisitTraversal& visit); | FOR INTERNAL USE Support for type-based traversal. |
Static Data Members¶
| Name | Description |
|---|---|
free_slots | Free slots, each numbered pool_index * pool_size + slot_index. The last entry is allocated next. |
pool_live_flags | |
pool_size | |
pools |
Protected Data Members¶
| Name |
|---|
p_declaration |
Friends¶
| Name | Description |
|---|---|
isSgVariableSymbol | Casts pointer from base class to derived class (for const pointers) |
isSgVariableSymbol | Casts pointer from base class to derived class |
Derived Classes¶
| Name | Description |
|---|---|
SgTemplateVariableSymbol |
Created with MrDocs