SgEnumDeclaration¶
This class represents the concept of an enum declaration.
Synopsis¶
Declared in <src/frontend/SageIII/Cxx_Grammar.h> (not stored in Git)
class [[visibility("default")]] SgEnumDeclaration
: public SgDeclarationStatement Description¶
- See also: Example of using a SgEnumDeclaration object
Data members
SgEnumDeclaration::p_name¶
Name of enum type (empty if not named).
SgEnumDeclaration::p_embedded¶
Boolean value true if embedded in a typedef declaration (might not be used).
SgEnumDeclaration::p_type¶
SgEnumType generated by this enum declaration.
SgEnumDeclaration::p_enumerators¶
STL list of pointers to SgInitializedName object (used for enum variables).
SgEnumDeclaration::p_scope¶
Scope of enum declaration. Note that the scope of the enum must be stored explicitly since it can be declared in a namespace and defined outside the namespace (note that forward declarations of enum types.
Member functions
SgEnumDeclaration::get_name() const¶
Access function for p_name.
- Return: Returns SgName by value.
SgEnumDeclaration::set_name(SgName name)¶
Access function for p_name.
- Return: Returns void.
SgEnumDeclaration::get_embedded() const¶
Access function for p_embedded.
- Return: Returns bool by value.
SgEnumDeclaration::set_embedded(bool embedded)¶
Access function for p_embedded.
- Return: Returns void.
SgEnumDeclaration::get_type() const¶
Access function for p_type.
- Return: Returns pointer to SgType.
SgEnumDeclaration::set_type(SgType* type)¶
Access function for p_type.
- Return: Returns void.
SgEnumDeclaration::get_enumerators() const¶
Access function for p_enumerators.
- Return: Returns a const reference to SgInitializedNamePtrList.
SgEnumDeclaration::get_enumerators()¶
Access function for p_enumerators.
- Return: Returns reference to SgInitializedNamePtrList.
SgEnumDeclaration::get_scope() const¶
Access function for p_scope.
- Return: Returns pointer to SgScopeStatement.
SgEnumDeclaration::set_scope(SgScopeStatment* scope)¶
Access function for p_scope.
- 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 |
Member Functions¶
| Name | Description |
|---|---|
SgEnumDeclarationSgEnumDeclaration( SgName name, SgEnumType* type, SgScopeStatement* scope); [constructor] | Constructors |
~SgEnumDeclarationvirtual ~SgEnumDeclaration(); [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_enumeratorvirtual void append_enumerator(SgInitializedName* element); [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_childIndexvirtual size_t get_childIndex(SgNode* child) const override; [virtual] | index-based access to traversal successors by child node |
get_embeddedbool get_embedded() const; | |
get_end_numeric_labelvirtual SgLabelRefExp* get_end_numeric_label() const override; [virtual] | |
get_enumeratorsSgInitializedNamePtrList const& get_enumerators() const; | |
get_field_typeSgType* get_field_type() const; | |
get_global_qualification_requiredbool get_global_qualification_required() const; | |
get_isAutonomousDeclarationbool get_isAutonomousDeclaration() const; | |
get_isScopedEnumbool get_isScopedEnum() const; | |
get_isUnNamedbool get_isUnNamed() const; | |
get_mangled_namevirtual SgName get_mangled_name() const override; [virtual] | |
get_nameSgName get_name() const; | |
get_name_qualification_lengthint get_name_qualification_length() const; | |
get_numberOfTraversalSuccessorsvirtual size_t get_numberOfTraversalSuccessors() const override; [virtual] | return number of children in the traversal successor list |
get_promotion_typeSgType* get_promotion_type() const; | |
get_qualified_namevirtual SgName get_qualified_name() const; [virtual] | |
get_scopevirtual SgScopeStatement* get_scope() const override; [virtual] | |
get_symbol_from_symbol_tablevirtual SgSymbol* get_symbol_from_symbol_table() 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_typeSgEnumType* get_type() const; | |
get_type_elaboration_requiredbool get_type_elaboration_required() const; | |
get_underlying_type_source_spelledbool get_underlying_type_source_spelled() const; | |
hasExplicitScopevirtual bool hasExplicitScope() const override; [virtual] | Support for where the scope is explicitly required |
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] | |
prepend_enumeratorvirtual void prepend_enumerator(SgInitializedName* element); [virtual] | |
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_embeddedvoid set_embedded(bool embedded); | |
set_end_numeric_labelvirtual void set_end_numeric_label(SgLabelRefExp* end_numeric_label) override; [virtual] | |
set_field_typevoid set_field_type(SgType* field_type); | |
set_global_qualification_requiredvoid set_global_qualification_required(bool global_qualification_required); | |
set_isAutonomousDeclarationvoid set_isAutonomousDeclaration(bool isAutonomousDeclaration); | |
set_isScopedEnumvoid set_isScopedEnum(bool isScopedEnum); | |
set_isUnNamedvoid set_isUnNamed(bool isUnNamed); | |
set_namevoid set_name(SgName name); | |
set_name_qualification_lengthvoid set_name_qualification_length(int name_qualification_length); | |
set_promotion_typevoid set_promotion_type(SgType* promotion_type); | |
set_scopevirtual void set_scope(SgScopeStatement* scope) override; [virtual] | |
set_typevoid set_type(SgEnumType* type); | |
set_type_elaboration_requiredvoid set_type_elaboration_required(bool type_elaboration_required); | |
set_underlying_type_source_spelledvoid set_underlying_type_source_spelled(bool underlying_type_source_spelled); | |
validate_enumerator_source_ownershipvoid validate_enumerator_source_ownership() const; | Validate the construction-time lexical source role of every semantic enum constant. Source consumers must call this before selecting constants for preprocessing placement or emission. |
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¶
Friends¶
| Name | Description |
|---|---|
isSgEnumDeclaration | Casts pointer from base class to derived class (for const pointers) |
isSgEnumDeclaration | Casts pointer from base class to derived class |
Created with MrDocs