Skip to content

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
SgEnumDeclaration
SgEnumDeclaration( SgName name, SgEnumType* type, SgScopeStatement* scope); [constructor]
Constructors
~SgEnumDeclaration
virtual ~SgEnumDeclaration(); [destructor] [virtual]
Destructor
accept
virtual void accept(ROSE_VisitorPattern& visitor) override; [virtual]
support for the classic visitor pattern done in GoF
appendDestructorOwnedNodes
virtual void appendDestructorOwnedNodes(std::vector<SgNode*>& nodes) const override; [virtual]
append_enumerator
virtual void append_enumerator(SgInitializedName* element); [virtual]
cfgInEdges
virtual std::vector<VirtualCFG::CFGEdge> cfgInEdges(unsigned int index) override; [virtual]
cfgIndexForEnd
virtual unsigned int cfgIndexForEnd() const override; [virtual]
cfgOutEdges
virtual std::vector<VirtualCFG::CFGEdge> cfgOutEdges(unsigned int index) override; [virtual]
class_name
virtual std::string class_name() const override; [virtual]
returns a string representing the class name
copy
virtual SgNode* copy(SgCopyHelp& help) const override; [virtual]
fixupCopy_references
virtual void fixupCopy_references( SgNode* copy, SgCopyHelp& help) const override; [virtual]
fixupCopy_scopes
virtual void fixupCopy_scopes( SgNode* copy, SgCopyHelp& help) const override; [virtual]
fixupCopy_symbols
virtual void fixupCopy_symbols( SgNode* copy, SgCopyHelp& help) const override; [virtual]
get_childIndex
virtual size_t get_childIndex(SgNode* child) const override; [virtual]
index-based access to traversal successors by child node
get_embedded
bool get_embedded() const;
get_end_numeric_label
virtual SgLabelRefExp* get_end_numeric_label() const override; [virtual]
get_enumerators
SgInitializedNamePtrList const& get_enumerators() const;
get_field_type
SgType* get_field_type() const;
get_global_qualification_required
bool get_global_qualification_required() const;
get_isAutonomousDeclaration
bool get_isAutonomousDeclaration() const;
get_isScopedEnum
bool get_isScopedEnum() const;
get_isUnNamed
bool get_isUnNamed() const;
get_mangled_name
virtual SgName get_mangled_name() const override; [virtual]
get_name
SgName get_name() const;
get_name_qualification_length
int get_name_qualification_length() const;
get_numberOfTraversalSuccessors
virtual size_t get_numberOfTraversalSuccessors() const override; [virtual]
return number of children in the traversal successor list
get_promotion_type
SgType* get_promotion_type() const;
get_qualified_name
virtual SgName get_qualified_name() const; [virtual]
get_scope
virtual SgScopeStatement* get_scope() const override; [virtual]
get_symbol_from_symbol_table
virtual SgSymbol* get_symbol_from_symbol_table() const override; [virtual]
get_traversalSuccessorByIndex
virtual SgNode* get_traversalSuccessorByIndex(size_t idx) const override; [virtual]
index-based access to traversal successors by index number
get_traversalSuccessorContainer
virtual 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_traversalSuccessorIsListElement
virtual std::vector<bool> get_traversalSuccessorIsListElement() const override; [virtual]
get_traversalSuccessorNamesContainer
virtual 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
SgEnumType* get_type() const;
get_type_elaboration_required
bool get_type_elaboration_required() const;
get_underlying_type_source_spelled
bool get_underlying_type_source_spelled() const;
hasExplicitScope
virtual bool hasExplicitScope() const override; [virtual]
Support for where the scope is explicitly required
operator delete
void operator delete( void* pointer, size_t size);
deallocated memory for IR node (returns memory to memory pool for reuse)
operator new
void* operator new(size_t size);
returns pointer to newly allocated IR node
post_construction_initialization
virtual void post_construction_initialization() override; [virtual]
prepend_enumerator
virtual void prepend_enumerator(SgInitializedName* element); [virtual]
processDataMemberReferenceToPointers
virtual void processDataMemberReferenceToPointers(ReferenceToPointerHandler*) override; [virtual]
Pass references to stored node pointers to a handler.
returnDataMemberPointers
virtual std::vector<std::pair<SgNode*, std::string>> returnDataMemberPointers() const override; [virtual]
Return the node pointers stored in this node's data members.
roseRTI
virtual RTIReturnType roseRTI() override; [virtual]
return C++ Runtime-Time-Information
sage_class_name
virtual char const* sage_class_name() const override; [virtual]
returns a C style string (char*) representing the class name
set_embedded
void set_embedded(bool embedded);
set_end_numeric_label
virtual void set_end_numeric_label(SgLabelRefExp* end_numeric_label) override; [virtual]
set_field_type
void set_field_type(SgType* field_type);
set_global_qualification_required
void set_global_qualification_required(bool global_qualification_required);
set_isAutonomousDeclaration
void set_isAutonomousDeclaration(bool isAutonomousDeclaration);
set_isScopedEnum
void set_isScopedEnum(bool isScopedEnum);
set_isUnNamed
void set_isUnNamed(bool isUnNamed);
set_name
void set_name(SgName name);
set_name_qualification_length
void set_name_qualification_length(int name_qualification_length);
set_promotion_type
void set_promotion_type(SgType* promotion_type);
set_scope
virtual void set_scope(SgScopeStatement* scope) override; [virtual]
set_type
void set_type(SgEnumType* type);
set_type_elaboration_required
void set_type_elaboration_required(bool type_elaboration_required);
set_underlying_type_source_spelled
void set_underlying_type_source_spelled(bool underlying_type_source_spelled);
validate_enumerator_source_ownership
void 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.
variantT
virtual VariantT variantT() const override; [virtual]
returns new style SageIII enum values

Static Member Functions

Name Description
memoryUsage
static size_t memoryUsage();
Returns the size in bytes of the total memory allocated for all IR nodes of this type
numberOfNodes
static size_t numberOfNodes();
Returns the total number of IR nodes of this type
traverseMemoryPoolNodes
static void traverseMemoryPoolNodes(ROSE_VisitTraversal& visit);
FOR INTERNAL USE Support for visitor pattern over all IR nodes by type of IR node.
traverseMemoryPoolVisitorPattern
static void traverseMemoryPoolVisitorPattern(ROSE_VisitorPattern& visitor);
FOR INTERNAL USE Support for visitor pattern.
visitRepresentativeNode
static 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_embedded
p_end_numeric_label
p_enumerators
p_field_type
p_global_qualification_required
p_isAutonomousDeclaration
p_isScopedEnum
p_isUnNamed
p_name
p_name_qualification_length
p_promotion_type
p_scope
p_type
p_type_elaboration_required
p_underlying_type_source_spelled

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