#include <Cxx_Grammar.h>
Inheritance diagram for SgEnumDeclaration:
Public Types | |
| typedef SgDeclarationStatement | base_node_type |
| static_variant = V_SgEnumDeclaration | |
| enum | { static_variant = V_SgEnumDeclaration } |
| static variant value More... | |
Public Member Functions | |
| virtual SgNode * | copy (SgCopyHelp &help) const |
| virtual void | append_enumerator (SgInitializedName *element) |
| virtual void | prepend_enumerator (SgInitializedName *element) |
| virtual SgName | get_qualified_name () const |
| virtual SgName | get_mangled_name (void) const |
| virtual bool | hasExplicitScope () const |
| Support for where the scope is explicitly required. | |
| virtual SgSymbol * | get_symbol_from_symbol_table () const |
| FOR INTERNAL USE Get the associated symbol from the symbol table in the stored scope. Users should use the SgDeclarationStatement::search_for_symbol_from_symbol_table() instead. | |
| virtual unsigned int | cfgIndexForEnd () const |
| Determine the CFG index for the end of this construct. | |
| virtual std::vector< VirtualCFG::CFGEdge > | cfgOutEdges (unsigned int index) |
| Find the out edges of a CFG node -- internal version. | |
| virtual std::vector< VirtualCFG::CFGEdge > | cfgInEdges (unsigned int index) |
| Find the in edges of a CFG node -- internal version. | |
| virtual void | fixupCopy (SgNode *copy, SgCopyHelp &help) const |
| virtual std::string | class_name () const |
| Copies AST (whole subtree, depending on the SgCopyHelp class returns a string representing the class name. | |
| virtual VariantT | variantT () const |
| returns new style SageIII enum values | |
| void * | operator new (size_t size) |
| returns pointer to newly allocated IR node | |
| void | operator delete (void *pointer, size_t size) |
| deallocated memory for IR node (returns memory to memory pool for reuse) | |
| void | operator delete (void *pointer) |
| virtual std::vector< SgNode * > | get_traversalSuccessorContainer () |
| FOR INTERNAL USE within ROSE traverals mechanism only. | |
| virtual std::vector< std::string > | get_traversalSuccessorNamesContainer () |
| FOR INTERNAL USE within ROSE traverals mechanism only. | |
| virtual size_t | get_numberOfTraversalSuccessors () |
| virtual SgNode * | get_traversalSuccessorByIndex (size_t idx) |
| virtual size_t | get_childIndex (SgNode *child) |
| virtual RTIReturnType | roseRTI () |
| FOR INTERNAL USE Access to Runtime Type Information (RTI) for this IR nodes. | |
| virtual const char * | sage_class_name () const ROSE_DEPRECATED_FUNCTION |
| void | executeVisitorMemberFunction (ROSE_VisitorPattern &visitor) |
| FOR INTERNAL USE Support for visitor pattern. | |
| virtual void | accept (ROSE_VisitorPattern &visitor) |
| DXN (08/09/2010): support for the classic visitor pattern done in GoF. | |
| virtual bool | isInMemoryPool () |
| FOR INTERNAL USE This is used in internal tests to verify that all IR nodes are allocated from the heap. | |
| virtual void | checkDataMemberPointersIfInMemoryPool () |
| FOR INTERNAL USE This is used in internal tests to verify that all IR nodes are allocated from the heap. | |
| virtual std::vector< std::pair< SgNode *, std::string > > | returnDataMemberPointers () const |
| FOR INTERNAL USE Returns STL vector of pairs of SgNode* and strings for use in AST tools | |
| virtual void | processDataMemberReferenceToPointers (ReferenceToPointerHandler *) |
| FOR INTERNAL USE Processes pairs of references to SgNode* and strings for use in AST tools | |
| virtual long | getChildIndex (SgNode *childNode) const |
| FOR INTERNAL USE Returns a unique index value for the childNode in the list of children at this IR node. | |
| SgEnumDeclaration (const SgEnumDeclarationStorageClass &source) | |
| SgEnumDeclaration * | addRegExpAttribute (std::string s, AstRegExAttribute *a) |
| Support for AST matching using regular expression. | |
| void | post_construction_initialization () |
| Final initialization for constructors This function is called at the end of generated constructors to allow the specification writer to add special initialization functions or tests. Default is to do nothing. Otherwise it should be overridden in the spec file, in NewHeaderCode/NewOutlinedCode. | |
| SgName | get_name () const |
| Access function for p_name. | |
| void | set_name (SgName name) |
| Access function for p_name. | |
| bool | get_embedded () const |
| Access function for p_embedded. | |
| void | set_embedded (bool embedded) |
| Access function for p_embedded. | |
| SgEnumType * | get_type () const |
| Access function for p_type. | |
| void | set_type (SgEnumType *type) |
| const SgInitializedNamePtrList & | get_enumerators () const |
| Access function for p_enumerators. | |
| SgInitializedNamePtrList & | get_enumerators () |
| Access function for p_enumerators. | |
| SgScopeStatement * | get_scope () const |
| Access function for p_scope. | |
| void | set_scope (SgScopeStatement *scope) |
| Support for setting scopes (only meaningful on IR statements that store the scope explicitly). | |
| bool | get_isUnNamed () const |
| void | set_isUnNamed (bool isUnNamed) |
| virtual | ~SgEnumDeclaration () |
| This is the destructor. | |
| SgEnumDeclaration (Sg_File_Info *startOfConstruct, SgName name="", SgEnumType *type=NULL) | |
| SgEnumDeclaration (SgName name, SgEnumType *type) | |
Static Public Member Functions | |
| static size_t | numberOfNodes () |
| Returns the total number of IR nodes of this type. | |
| static size_t | memoryUsage () |
| Returns the size in bytes of the total memory allocated for all IR nodes of this type. | |
| static void | traverseMemoryPoolNodes (ROSE_VisitTraversal &visit) |
| FOR INTERNAL USE Support for visitor pattern. | |
| static void | traverseMemoryPoolVisitorPattern (ROSE_VisitorPattern &visitor) |
| FOR INTERNAL USE Support for visitor pattern. | |
| static void | visitRepresentativeNode (ROSE_VisitTraversal &visit) |
| FOR INTERNAL USE Support for type-based traversal. | |
Protected Attributes | |
| SgName | p_name |
| Name of enum type (empty if not named). | |
| bool | p_embedded |
| Boolean value true if embedded in a typedef declaration (might not be used). | |
| SgEnumType * | p_type |
| SgEnumType generated by this enum declaration. | |
| SgInitializedNamePtrList | p_enumerators |
| STL list of pointers to SgInitializedName object (used for enum variables). | |
| SgScopeStatement * | p_scope |
| Scope of enum declaration. | |
| bool | p_isUnNamed |
Friends | |
| class | AST_FILE_IO |
| class | SgEnumDeclarationStorageClass |
| class | AstSpecificDataManagingClass |
| class | AstSpecificDataManagingClassStorageClass |
| SgEnumDeclaration * | isSgEnumDeclaration (SgNode *s) |
| Casts pointer from base class to derived class. | |
| const SgEnumDeclaration * | isSgEnumDeclaration (const SgNode *s) |
| Casts pointer from base class to derived class (for const pointers). | |
| SgEnumDeclaration * | SgEnumDeclaration_getPointerFromGlobalIndex (unsigned long globalIndex) |
| Constructor for use by AST File I/O MechanismTypedef used for low level memory access. Typedef used to hold memory addresses as values. Methods to find the pointer to a global and local index. | |
| unsigned long | SgEnumDeclaration_getNumberOfValidNodesAndSetGlobalIndexInFreepointer (unsigned long) |
| Get the size of the memory pool. | |
| void | SgEnumDeclaration_clearMemoryPool () |
| void | SgEnumDeclaration_extendMemoryPoolForFileIO (unsigned long) |
| void | SgEnumDeclaration_getNextValidPointer (std::pair< SgEnumDeclaration *, std::vector< unsigned char * >::const_iterator > &) |
| void | SgEnumDeclaration_resetValidFreepointers () |
Reimplemented from SgDeclarationStatement.
| SgEnumDeclaration::SgEnumDeclaration | ( | const SgEnumDeclarationStorageClass & | source | ) |
| SgEnumDeclaration::~SgEnumDeclaration | ( | ) | [virtual] |
This is the destructor.
There are a lot of things to delete, but nothing is deleted in this destructor.
| SgEnumDeclaration::SgEnumDeclaration | ( | Sg_File_Info * | startOfConstruct, | |
| SgName | name = "", |
|||
| SgEnumType * | type = NULL | |||
| ) |
| SgEnumDeclaration::SgEnumDeclaration | ( | SgName | name, | |
| SgEnumType * | type | |||
| ) |
| virtual SgNode* SgEnumDeclaration::copy | ( | SgCopyHelp & | help | ) | const [virtual] |
Reimplemented from SgDeclarationStatement.
| virtual void SgEnumDeclaration::append_enumerator | ( | SgInitializedName * | element | ) | [virtual] |
| virtual void SgEnumDeclaration::prepend_enumerator | ( | SgInitializedName * | element | ) | [virtual] |
| virtual SgName SgEnumDeclaration::get_qualified_name | ( | ) | const [virtual] |
| virtual SgName SgEnumDeclaration::get_mangled_name | ( | void | ) | const [virtual] |
Reimplemented from SgDeclarationStatement.
| virtual bool SgEnumDeclaration::hasExplicitScope | ( | ) | const [virtual] |
| virtual SgSymbol* SgEnumDeclaration::get_symbol_from_symbol_table | ( | ) | const [virtual] |
FOR INTERNAL USE Get the associated symbol from the symbol table in the stored scope. Users should use the SgDeclarationStatement::search_for_symbol_from_symbol_table() instead.
Reimplemented from SgDeclarationStatement.
| virtual unsigned int SgEnumDeclaration::cfgIndexForEnd | ( | ) | const [virtual] |
| virtual std::vector<VirtualCFG::CFGEdge> SgEnumDeclaration::cfgOutEdges | ( | unsigned int | index | ) | [virtual] |
| virtual std::vector<VirtualCFG::CFGEdge> SgEnumDeclaration::cfgInEdges | ( | unsigned int | index | ) | [virtual] |
| virtual void SgEnumDeclaration::fixupCopy | ( | SgNode * | copy, | |
| SgCopyHelp & | help | |||
| ) | const [virtual] |
Reimplemented from SgDeclarationStatement.
| virtual std::string SgEnumDeclaration::class_name | ( | ) | const [virtual] |
Copies AST (whole subtree, depending on the SgCopyHelp class returns a string representing the class name.
Reimplemented from SgDeclarationStatement.
| virtual VariantT SgEnumDeclaration::variantT | ( | ) | const [virtual] |
| void* SgEnumDeclaration::operator new | ( | size_t | size | ) |
| void SgEnumDeclaration::operator delete | ( | void * | pointer, | |
| size_t | size | |||
| ) |
deallocated memory for IR node (returns memory to memory pool for reuse)
Reimplemented from SgDeclarationStatement.
| void SgEnumDeclaration::operator delete | ( | void * | pointer | ) |
Reimplemented from SgDeclarationStatement.
| static size_t SgEnumDeclaration::numberOfNodes | ( | ) | [static] |
| static size_t SgEnumDeclaration::memoryUsage | ( | ) | [static] |
Returns the size in bytes of the total memory allocated for all IR nodes of this type.
Reimplemented from SgDeclarationStatement.
| virtual std::vector<SgNode*> SgEnumDeclaration::get_traversalSuccessorContainer | ( | ) | [virtual] |
FOR INTERNAL USE within ROSE traverals mechanism only.
This function builds and returns a copy of ordered container holding pointers to children of this node in a traversal. It is associated with the definition of a tree that is travered by the AST traversal mechanism; a tree that is embeded in the AST (which is a more general graph). This function is used within the implementation of the AST traversal and has a semantics may change in subtle ways that makes it difficult to use in user code. It can return unexpected data members and thus the order and the number of elements is unpredicable and subject to change.
Reimplemented from SgDeclarationStatement.
| virtual std::vector<std::string> SgEnumDeclaration::get_traversalSuccessorNamesContainer | ( | ) | [virtual] |
FOR INTERNAL USE within ROSE traverals mechanism only.
This function builds and returns a copy of ordered container holding strings used to name data members that are traversed in the IR node. It is associated with the definition of a tree that is travered by the AST traversal mechanism; a tree that is embeded in the AST (which is a more general graph). This function is used within the implementation of the AST traversal and has a semantics may change in subtle ways that makes it difficult to use in user code. It can return unexpected data members and thus the order and the number of elements is unpredicable and subject to change.
Reimplemented from SgDeclarationStatement.
| virtual size_t SgEnumDeclaration::get_numberOfTraversalSuccessors | ( | ) | [virtual] |
Reimplemented from SgDeclarationStatement.
| virtual SgNode* SgEnumDeclaration::get_traversalSuccessorByIndex | ( | size_t | idx | ) | [virtual] |
Reimplemented from SgDeclarationStatement.
| virtual size_t SgEnumDeclaration::get_childIndex | ( | SgNode * | child | ) | [virtual] |
Reimplemented from SgDeclarationStatement.
| virtual RTIReturnType SgEnumDeclaration::roseRTI | ( | ) | [virtual] |
FOR INTERNAL USE Access to Runtime Type Information (RTI) for this IR nodes.
This function provides runtime type information for accessing the structure of the current node. It is useful for generating code which would dump out or rebuild IR nodes.
Reimplemented from SgDeclarationStatement.
| virtual const char* SgEnumDeclaration::sage_class_name | ( | ) | const [virtual] |
returns a C style string (char*) representing the class name
Reimplemented from SgDeclarationStatement.
| void SgEnumDeclaration::executeVisitorMemberFunction | ( | ROSE_VisitorPattern & | visitor | ) |
| virtual void SgEnumDeclaration::accept | ( | ROSE_VisitorPattern & | visitor | ) | [virtual] |
DXN (08/09/2010): support for the classic visitor pattern done in GoF.
Reimplemented from SgDeclarationStatement.
| static void SgEnumDeclaration::traverseMemoryPoolNodes | ( | ROSE_VisitTraversal & | visit | ) | [static] |
| static void SgEnumDeclaration::traverseMemoryPoolVisitorPattern | ( | ROSE_VisitorPattern & | visitor | ) | [static] |
| static void SgEnumDeclaration::visitRepresentativeNode | ( | ROSE_VisitTraversal & | visit | ) | [static] |
| virtual bool SgEnumDeclaration::isInMemoryPool | ( | ) | [virtual] |
FOR INTERNAL USE This is used in internal tests to verify that all IR nodes are allocated from the heap.
The AST File I/O depends upon the allocation of IR nodes being from the heap, stack based or global IR nodes should not appear in the AST if it will be written out to a file and read back in. To enforce this concept, this function implements a test to verify that the IR node can be found on the heap and is part of a larger test of the whole AST. This test must pass before the AST can be written out to a file. This is part of a compromise in the design of the AST File I/O to support binary streaming of data to files; for performance. It is also rather difficult, but possible, to build a useful AST with IR nodes allocated on the stack or frm global scope, this test filters out such cased from being used with the AST File I/O mechanism.
Reimplemented from SgDeclarationStatement.
| virtual void SgEnumDeclaration::checkDataMemberPointersIfInMemoryPool | ( | ) | [virtual] |
FOR INTERNAL USE This is used in internal tests to verify that all IR nodes are allocated from the heap.
The AST File I/O depends upon the allocation of IR nodes being from the heap, stack based or global IR nodes should not appear in the AST if it will be written out to a file and read back in. To enforce this concept, this function implements a test to verify that the IR node can be found on the heap and is part of a larger test of the whole AST. This test must pass before the AST can be written out to a file. This is part of a compromise in the design of the AST File I/O to support binary streaming of data to files; for performance. It is also rather difficult, but possible, to build a useful AST with IR nodes allocated on the stack or frm global scope, this test filters out such cased from being used with the AST File I/O mechanism.
Reimplemented from SgDeclarationStatement.
| virtual std::vector<std::pair<SgNode*,std::string> > SgEnumDeclaration::returnDataMemberPointers | ( | ) | const [virtual] |
FOR INTERNAL USE Returns STL vector of pairs of SgNode* and strings for use in AST tools
This functions is part of general support for many possible tools to operate on the AST. The forms a list of ALL IR node pointers used by each IR node, and is a supperset of the get_traversalSuccessorContainer(). It is (I think) less than the set of pointers used by the AST file I/O. This is part of work implemented by Andreas, and support tools such as the AST graph generation.
Reimplemented from SgDeclarationStatement.
| virtual void SgEnumDeclaration::processDataMemberReferenceToPointers | ( | ReferenceToPointerHandler * | ) | [virtual] |
FOR INTERNAL USE Processes pairs of references to SgNode* and strings for use in AST tools
This functions similar to returnDataMemberPointers() except that it passes references to a handler object. As a result there is FAR more damage that can be done by using this function, but it is type-safe. This is provided for support of internal tools that operate on the AST, e.g the AST Merge mechanism.
Reimplemented from SgDeclarationStatement.
| virtual long SgEnumDeclaration::getChildIndex | ( | SgNode * | childNode | ) | const [virtual] |
FOR INTERNAL USE Returns a unique index value for the childNode in the list of children at this IR node.
This function returns a unique value for the input childNode in set of children at this IR node. Note that a negative value indicates that the input node is not a child. This is the basis for the implementation of the isChild(SgNode*) member function. Data members that are NULL in the IR node are counted internally (so that this function returns value that could be statically defined, and so are not dynamically determined).
Reimplemented from SgDeclarationStatement.
| SgEnumDeclaration* SgEnumDeclaration::addRegExpAttribute | ( | std::string | s, | |
| AstRegExAttribute * | a | |||
| ) |
Support for AST matching using regular expression.
This support is incomplete and the subject of current research to define RegEx trees to support inexact matching.
Reimplemented from SgDeclarationStatement.
| void SgEnumDeclaration::post_construction_initialization | ( | ) | [virtual] |
Final initialization for constructors This function is called at the end of generated constructors to allow the specification writer to add special initialization functions or tests. Default is to do nothing. Otherwise it should be overridden in the spec file, in NewHeaderCode/NewOutlinedCode.
Reimplemented from SgDeclarationStatement.
| SgEnumDeclaration::get_name | ( | ) | const |
| SgEnumDeclaration::set_name | ( | SgName | name | ) |
Access function for p_name.
| SgEnumDeclaration::get_embedded | ( | ) | const |
Access function for p_embedded.
| SgEnumDeclaration::set_embedded | ( | bool | embedded | ) |
Access function for p_embedded.
| SgEnumDeclaration::get_type | ( | ) | const |
| void SgEnumDeclaration::set_type | ( | SgEnumType * | type | ) |
| SgEnumDeclaration::get_enumerators | ( | ) | const |
Access function for p_enumerators.
| SgEnumDeclaration::get_enumerators | ( | ) |
Access function for p_enumerators.
| SgEnumDeclaration::get_scope | ( | void | ) | const [virtual] |
Access function for p_scope.
Reimplemented from SgStatement.
| void SgEnumDeclaration::set_scope | ( | SgScopeStatement * | scope | ) | [virtual] |
Support for setting scopes (only meaningful on IR statements that store the scope explicitly).
Reimplemented from SgStatement.
| bool SgEnumDeclaration::get_isUnNamed | ( | ) | const |
| void SgEnumDeclaration::set_isUnNamed | ( | bool | isUnNamed | ) |
friend class AST_FILE_IO [friend] |
Reimplemented from SgDeclarationStatement.
friend class SgEnumDeclarationStorageClass [friend] |
friend class AstSpecificDataManagingClass [friend] |
Reimplemented from SgDeclarationStatement.
friend class AstSpecificDataManagingClassStorageClass [friend] |
Reimplemented from SgDeclarationStatement.
| SgEnumDeclaration::isSgEnumDeclaration | ( | SgNode * | s | ) | [friend] |
Casts pointer from base class to derived class.
This functions returns a SgEnumDeclaration pointer for any input of a pointer to an object derived from a SgEnumDeclaration.
| SgEnumDeclaration::isSgEnumDeclaration | ( | const SgNode * | s | ) | [friend] |
Casts pointer from base class to derived class (for const pointers).
This functions returns a SgEnumDeclaration pointer for any input of a pointer to an object derived from a SgEnumDeclaration.
| SgEnumDeclaration* SgEnumDeclaration_getPointerFromGlobalIndex | ( | unsigned long | globalIndex | ) | [friend] |
Constructor for use by AST File I/O MechanismTypedef used for low level memory access. Typedef used to hold memory addresses as values. Methods to find the pointer to a global and local index.
| unsigned long SgEnumDeclaration_getNumberOfValidNodesAndSetGlobalIndexInFreepointer | ( | unsigned | long | ) | [friend] |
Get the size of the memory pool.
It actually returns the size of the whole blocks allocated, no matter they contain valid pointers or not.
| void SgEnumDeclaration_clearMemoryPool | ( | ) | [friend] |
| void SgEnumDeclaration_extendMemoryPoolForFileIO | ( | unsigned | long | ) | [friend] |
| void SgEnumDeclaration_getNextValidPointer | ( | std::pair< SgEnumDeclaration *, std::vector< unsigned char * >::const_iterator > & | ) | [friend] |
| void SgEnumDeclaration_resetValidFreepointers | ( | ) | [friend] |
SgEnumDeclaration::p_name [protected] |
Name of enum type (empty if not named).
SgEnumDeclaration::p_embedded [protected] |
Boolean value true if embedded in a typedef declaration (might not be used).
SgEnumDeclaration::p_type [protected] |
SgEnumType generated by this enum declaration.
SgEnumDeclaration::p_enumerators [protected] |
STL list of pointers to SgInitializedName object (used for enum variables).
SgEnumDeclaration::p_scope [protected] |
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.
bool SgEnumDeclaration::p_isUnNamed [protected] |
1.4.7