SgVariableDeclaration¶
This class represents the concept of a C or C++ variable declaration.
Synopsis¶
Declared in <src/frontend/SageIII/Cxx_Grammar.h> (not stored in Git)
class [[visibility("default")]] SgVariableDeclaration
: public SgDeclarationStatement Description¶
A variable declaration can be either a forward declaration (specified as "extern") or a defining declaration (typical case). Because of this separation (as with classes, functions, etc.) the scope of a variable must be stored explicitly because name qualification can associate a definition in a scope different from the original declaration (see test2005_34.C for examples).
- Internal: Since multiple variables may be declared in a single variable declaration, the scope information is held in the SgInitializedName object directly, and not the SgVariableDeclaration. The scope of a SgVariableDeclaration is ...
- Todo: Finish explaination of variable declaration, relationship to variable definition, and the scope issue.
- Todo: template static variable declaration are instantiated and this is at least sometimes an error (at least when not part of a transformation). See test2005_69.C for example of this problem.
- See also: Example of using a SgVariableDeclaration object
Data members
SgVariableDeclaration::p_baseTypeDefiningDeclaration¶
This is used to traverse type definitions within variable declarations. In cases where a class or other named type is defined within (and as the base type of) a variable declaration, the traversal code must be able to traverse this definition. The traversal code computes the appropriate value for this pointer when needed.
SgVariableDeclaration::p_variables¶
This is an STL list of pointers to SgInitializedName objects. Each variable is a SgInitializedName object, their can be a list of then, so this list holds that collection of variables.
SgVariableDeclaration::p_specialization¶
This is part of template support (variables of templated types). This is most often set to SgDeclarationStatement::e_no_specialization, but where templates are involved can be set to either SgDeclarationStatement::e_specialization or SgDeclarationStatement::e_partial_specialization.
Member functions
SgVariableDeclaration::get_variables() const¶
Access function for p_variables.
- Return: Returns a const reference to SgInitializedNamePtrList.
SgVariableDeclaration::get_variables()¶
Access function for p_variables.
- Return: Returns a non-const reference to SgInitializedNamePtrList.
SgVariableDeclaration::get_baseTypeDefiningDeclaration() const¶
Returns the exact class or enum definition structurally owned by this declaration, or null when the declaration only references its base type.
SgVariableDeclaration::set_baseTypeDefiningDeclaration(SgDeclarationStatement*) Sets the exact owned, non-autonomous class or enum definition. Null is not a valid setter argument; absence is the construction-time default. The definition must already have this variable declaration as its parent and must be the base definition named by every declarator type.¶
SgVariableDeclaration::get_specialization() const¶
Access function for p_specialization.
- Return: Returns value of type SgDeclarationStatement::template_specialization_enum.
`SgVariableDeclaration::set_specialization(SgDeclarationStatement::template_specialization_enum specialization)` Access function for p_specialization.¶
- Return: Returns void.
Base Classes¶
| Name | Description |
|---|---|
SgDeclarationStatement | This class represents the concept of a declaration statement. |
Type Aliases¶
| Name |
|---|
base_node_type |
Enums¶
| Name | Description |
|---|---|
Unnamed enum | static variant value |
fortran_declaration_origin_enum | |
gnu_extension_declaration_attributes_enum | GNU extension for declaration modifiers (multiple values may be specified) |
inline_kind |
Member Functions¶
| Name | Description |
|---|---|
SgVariableDeclarationSgVariableDeclaration(); [constructor] | Constructors |
~SgVariableDeclarationvirtual ~SgVariableDeclaration(); [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] | |
append_variablevoid append_variable( SgInitializedName* what, SgInitializer* init); | |
cfgFindChildIndexvirtual unsigned int cfgFindChildIndex(SgNode* n) override; [virtual] | |
cfgInEdgesvirtual std::vector<VirtualCFG::CFGEdge> cfgInEdges(unsigned int index) override; [virtual] | |
cfgIndexForEndvirtual unsigned int cfgIndexForEnd() const override; [virtual] | |
cfgOutEdgesvirtual std::vector<VirtualCFG::CFGEdge> cfgOutEdges(unsigned int index) 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] | |
fixupCopy_referencesvirtual void fixupCopy_references( SgNode* copy, SgCopyHelp& help) const override; [virtual] | |
fixupCopy_scopesvirtual void fixupCopy_scopes( SgNode* copy, SgCopyHelp& help) const override; [virtual] | |
fixupCopy_symbolsvirtual void fixupCopy_symbols( SgNode* copy, SgCopyHelp& help) const override; [virtual] | |
get_baseTypeDefiningDeclarationSgDeclarationStatement* get_baseTypeDefiningDeclaration() const; | Returns the exact defining declaration structurally owned by this variable declaration, or NULL when the declared type is only referenced. |
get_baseTypeNondefiningDeclarationSgDeclarationStatement* get_baseTypeNondefiningDeclaration() const; | Returns the exact nondefining tag introduction structurally owned by this variable declaration, or NULL when no declarator introduces a tag. |
get_bitfieldSgExpression* get_bitfield(); | |
get_childIndexvirtual size_t get_childIndex(SgNode* child) const override; [virtual] | index-based access to traversal successors by child node |
get_decl_itemSgInitializedName* get_decl_item(SgName const&); | |
get_definitionSgVariableDefinition* get_definition(SgInitializedName* ditem = 0); | |
get_explicitTemplateSpecializationHeaderCountunsigned int get_explicitTemplateSpecializationHeaderCount() const; | |
get_fortran_declaration_originSgVariableDeclaration::fortran_declaration_origin_enum get_fortran_declaration_origin() const; | |
get_global_qualification_requiredbool get_global_qualification_required() const; | |
get_gnu_extension_aliasstd::string get_gnu_extension_alias() const; | |
get_gnu_extension_declaration_attributeSgVariableDeclaration::gnu_extension_declaration_attributes_enum get_gnu_extension_declaration_attribute() const; | |
get_gnu_extension_initialization_priorityunsigned short get_gnu_extension_initialization_priority() const; | |
get_gnu_extension_sectionstd::string get_gnu_extension_section() const; | |
get_inline_kindinline_kind get_inline_kind() const; | |
get_isAssociatedWithDeclarationListbool get_isAssociatedWithDeclarationList() const; | |
get_is_constexprbool get_is_constexpr() const; | |
get_is_thread_localbool get_is_thread_local() const; | |
get_mangled_namevirtual SgName get_mangled_name() const override; [virtual] | |
get_name_qualification_lengthint get_name_qualification_length() const; | |
get_nextSgStatement* get_next(int&) const; | |
get_numberOfTraversalSuccessorsvirtual size_t get_numberOfTraversalSuccessors() const override; [virtual] | return number of children in the traversal successor list |
get_requiresClauseSgExpression* get_requiresClause() const; | |
get_requiresGlobalNameQualificationOnTypebool get_requiresGlobalNameQualificationOnType() const; | |
get_sourceSpelledTemplateHeadersSgTemplateParameterListPtrList const& get_sourceSpelledTemplateHeaders() const; | |
get_sourceSpelledTemplateOwnerTypeSgNamedType* get_sourceSpelledTemplateOwnerType() const; | |
get_specializationSgDeclarationStatement::template_specialization_enum get_specialization() const; | |
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_type_elaboration_requiredbool get_type_elaboration_required() const; | |
get_variablesSgInitializedNamePtrList const& get_variables() const; | |
initializeDatavoid initializeData( Sg_File_Info* info, SgInitializedName* c_item); | |
isPartialSpecializationbool isPartialSpecialization() const; | |
isSpecializationbool isSpecialization() const; | |
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 |
post_construction_initializationvirtual void post_construction_initialization() override; [virtual] | |
processDataMemberReferenceToPointersvirtual void processDataMemberReferenceToPointers(ReferenceToPointerHandler*) override; [virtual] | Pass references to stored node pointers to a handler. |
reset_initializervoid reset_initializer(SgInitializer*); | |
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_baseTypeDefiningDeclarationvoid set_baseTypeDefiningDeclaration(SgDeclarationStatement* d); | Publishes a non-null, non-autonomous class or enum definition already owned by this declaration and named by every declarator type. |
set_baseTypeNondefiningDeclarationvoid set_baseTypeNondefiningDeclaration(SgDeclarationStatement* d); | Publishes a non-null, non-autonomous class or enum forward declaration already owned by this declaration and named by every declarator type. |
set_bitfieldvoid set_bitfield(SgExpression*); | |
set_explicitTemplateSpecializationHeaderCountvoid set_explicitTemplateSpecializationHeaderCount(unsigned int explicitTemplateSpecializationHeaderCount); | |
set_fortran_declaration_originvoid set_fortran_declaration_origin(SgVariableDeclaration::fortran_declaration_origin_enum fortran_declaration_origin); | |
set_global_qualification_requiredvoid set_global_qualification_required(bool global_qualification_required); | |
set_gnu_extension_aliasvoid set_gnu_extension_alias(std::string gnu_extension_alias); | |
set_gnu_extension_declaration_attributevoid set_gnu_extension_declaration_attribute(SgVariableDeclaration::gnu_extension_declaration_attributes_enum gnu_extension_declaration_attribute); | |
set_gnu_extension_initialization_priorityvoid set_gnu_extension_initialization_priority(unsigned short gnu_extension_initialization_priority); | |
set_gnu_extension_sectionvoid set_gnu_extension_section(std::string gnu_extension_section); | |
set_inline_kindvoid set_inline_kind(inline_kind kind); | |
set_isAssociatedWithDeclarationListvoid set_isAssociatedWithDeclarationList(bool isAssociatedWithDeclarationList); | |
set_is_constexprvoid set_is_constexpr(bool is_constexpr); | |
set_is_thread_localvoid set_is_thread_local(bool is_thread_local); | |
set_name_qualification_lengthvoid set_name_qualification_length(int name_qualification_length); | |
set_requiresClausevoid set_requiresClause(SgExpression* requiresClause); | |
set_requiresGlobalNameQualificationOnTypevoid set_requiresGlobalNameQualificationOnType(bool requiresGlobalNameQualificationOnType); | |
set_sourceSpelledTemplateOwnerTypevoid set_sourceSpelledTemplateOwnerType(SgNamedType* sourceSpelledTemplateOwnerType); | |
set_specializationvoid set_specialization(SgDeclarationStatement::template_specialization_enum specialization); | |
set_type_elaboration_requiredvoid set_type_elaboration_required(bool type_elaboration_required); | |
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 Member Functions¶
| Name |
|---|
compute_baseTypeDefiningDeclarationSgDeclarationStatement* compute_baseTypeDefiningDeclaration() const; |
Protected Data Members¶
Friends¶
| Name | Description |
|---|---|
isSgVariableDeclaration | Casts pointer from base class to derived class (for const pointers) |
isSgVariableDeclaration | Casts pointer from base class to derived class |
Derived Classes¶
| Name | Description |
|---|---|
SgTemplateVariableDeclaration |
Created with MrDocs