#include <Cxx_Grammar.h>
Inheritance diagram for SgGlobal:
Namespace definitions are coupled with namespace declarations to defin the namespace (hold the list of declarations in the namespace. Within C++ namespaces are "reentrant" and as a result multiple namespace declarations (SgNamespaceDeclarationStatement) and definitions (SgGlobal) may exist for a single namespace.
For internal use only.
This is a base class for scope statements.
Public Types | |
| typedef SgScopeStatement | base_node_type |
| static_variant = V_SgGlobal | |
| enum | { static_variant = V_SgGlobal } |
| static variant value More... | |
Public Member Functions | |
| virtual SgNode * | copy (SgCopyHelp &help) const |
| virtual SgName | get_qualified_name () const |
| Returns SgName (a string) representing the name of the current scope (empty string). | |
| virtual SgName | get_mangled_name () const |
| 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 bool | cfgIsIndexInteresting (unsigned int idx) const |
| Determine whether a particular CFG node index is "interesting" for this kind of node. | |
| virtual unsigned int | cfgIndexForEnd () const |
| Determine the CFG index for the end of this construct. | |
| void | buildStatementNumbering () |
| virtual void | append_declaration (SgDeclarationStatement *element) |
| virtual void | prepend_declaration (SgDeclarationStatement *element) |
| 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. | |
| SgGlobal (const SgGlobalStorageClass &source) | |
| SgGlobal * | 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. | |
| const SgDeclarationStatementPtrList & | get_declarations () const |
| Returns a const list to the global scope declarations. | |
| SgDeclarationStatementPtrList & | get_declarations () |
| Returns a list to the global scope declarations. | |
| virtual | ~SgGlobal () |
| This is the destructor. | |
| SgGlobal (Sg_File_Info *startOfConstruct) | |
| This is the constructor. | |
| SgGlobal () | |
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 Member Functions | |
| virtual bool | insert_child (SgStatement *, SgStatement *, bool inFront=true, bool extractListFromBasicBlock=false) |
| Private supporting function for low level SageIII rewrite interface. | |
| virtual bool | replace_child (SgStatement *, SgStatement *, bool extractListFromBasicBlock=false) |
| Private supporting function for low level SageIII rewrite interface. | |
Protected Attributes | |
| SgDeclarationStatementPtrList | p_declarations |
| This is an STL list of SgDeclarationStatement objects. | |
Friends | |
| class | AST_FILE_IO |
| class | SgGlobalStorageClass |
| class | AstSpecificDataManagingClass |
| class | AstSpecificDataManagingClassStorageClass |
| SgGlobal * | isSgGlobal (SgNode *s) |
| Casts pointer from base class to derived class. | |
| const SgGlobal * | isSgGlobal (const SgNode *s) |
| Casts pointer from base class to derived class (for const pointers). | |
| SgGlobal * | SgGlobal_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 | SgGlobal_getNumberOfValidNodesAndSetGlobalIndexInFreepointer (unsigned long) |
| Get the size of the memory pool. | |
| void | SgGlobal_clearMemoryPool () |
| void | SgGlobal_extendMemoryPoolForFileIO (unsigned long) |
| void | SgGlobal_getNextValidPointer (std::pair< SgGlobal *, std::vector< unsigned char * >::const_iterator > &) |
| void | SgGlobal_resetValidFreepointers () |
Reimplemented from SgScopeStatement.
| SgGlobal::SgGlobal | ( | const SgGlobalStorageClass & | source | ) |
| SgGlobal::~SgGlobal | ( | ) | [virtual] |
This is the destructor.
There are a lot of things to delete, but nothing is deleted in this destructor.
| SgGlobal::SgGlobal | ( | Sg_File_Info * | startOfConstruct = NULL |
) |
This is the constructor.
This constructor builds the SgGlobal base class.
| startOfConstruct | represents the position in the source code |
| SgGlobal::SgGlobal | ( | ) |
| virtual SgNode* SgGlobal::copy | ( | SgCopyHelp & | help | ) | const [virtual] |
Reimplemented from SgScopeStatement.
| SgGlobal::get_qualified_name | ( | ) | const [virtual] |
Returns SgName (a string) representing the name of the current scope (empty string).
See discussion of mangled names in the documentation.
Reimplemented from SgScopeStatement.
| virtual SgName SgGlobal::get_mangled_name | ( | ) | const [virtual] |
Reimplemented from SgScopeStatement.
| virtual std::vector<VirtualCFG::CFGEdge> SgGlobal::cfgOutEdges | ( | unsigned int | index | ) | [virtual] |
| virtual std::vector<VirtualCFG::CFGEdge> SgGlobal::cfgInEdges | ( | unsigned int | index | ) | [virtual] |
| virtual bool SgGlobal::cfgIsIndexInteresting | ( | unsigned int | idx | ) | const [virtual] |
Determine whether a particular CFG node index is "interesting" for this kind of node.
Reimplemented from SgStatement.
| virtual unsigned int SgGlobal::cfgIndexForEnd | ( | ) | const [virtual] |
| void SgGlobal::buildStatementNumbering | ( | ) |
| virtual void SgGlobal::append_declaration | ( | SgDeclarationStatement * | element | ) | [virtual] |
| virtual void SgGlobal::prepend_declaration | ( | SgDeclarationStatement * | element | ) | [virtual] |
| virtual bool SgGlobal::insert_child | ( | SgStatement * | , | |
| SgStatement * | , | |||
| bool | inFront = true, |
|||
| bool | extractListFromBasicBlock = false | |||
| ) | [protected, virtual] |
Private supporting function for low level SageIII rewrite interface.
This function implements special semantics for the insertion of a collection of statements in a block. If extractListFromBasicBlock is true then the statements in the block are extracts and placed into the same scope as the target position.
Reimplemented from SgStatement.
| virtual bool SgGlobal::replace_child | ( | SgStatement * | , | |
| SgStatement * | , | |||
| bool | extractListFromBasicBlock = false | |||
| ) | [protected, virtual] |
Private supporting function for low level SageIII rewrite interface.
This function implements special semantics for the insertion of a collection of statements in a block. If extractListFromBasicBlock is true then the statements in the block are extracts and placed into the same scope as the target position.
Reimplemented from SgStatement.
| virtual void SgGlobal::fixupCopy | ( | SgNode * | copy, | |
| SgCopyHelp & | help | |||
| ) | const [virtual] |
Reimplemented from SgScopeStatement.
| virtual std::string SgGlobal::class_name | ( | ) | const [virtual] |
Copies AST (whole subtree, depending on the SgCopyHelp class returns a string representing the class name.
Reimplemented from SgScopeStatement.
| virtual VariantT SgGlobal::variantT | ( | ) | const [virtual] |
| void* SgGlobal::operator new | ( | size_t | size | ) |
| void SgGlobal::operator delete | ( | void * | pointer, | |
| size_t | size | |||
| ) |
deallocated memory for IR node (returns memory to memory pool for reuse)
Reimplemented from SgScopeStatement.
| void SgGlobal::operator delete | ( | void * | pointer | ) |
Reimplemented from SgScopeStatement.
| static size_t SgGlobal::numberOfNodes | ( | ) | [static] |
| static size_t SgGlobal::memoryUsage | ( | ) | [static] |
Returns the size in bytes of the total memory allocated for all IR nodes of this type.
Reimplemented from SgScopeStatement.
| virtual std::vector<SgNode*> SgGlobal::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 SgScopeStatement.
| virtual std::vector<std::string> SgGlobal::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 SgScopeStatement.
| virtual size_t SgGlobal::get_numberOfTraversalSuccessors | ( | ) | [virtual] |
Reimplemented from SgScopeStatement.
| virtual SgNode* SgGlobal::get_traversalSuccessorByIndex | ( | size_t | idx | ) | [virtual] |
Reimplemented from SgScopeStatement.
| virtual size_t SgGlobal::get_childIndex | ( | SgNode * | child | ) | [virtual] |
Reimplemented from SgScopeStatement.
| virtual RTIReturnType SgGlobal::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 SgScopeStatement.
| virtual const char* SgGlobal::sage_class_name | ( | ) | const [virtual] |
returns a C style string (char*) representing the class name
Reimplemented from SgScopeStatement.
| void SgGlobal::executeVisitorMemberFunction | ( | ROSE_VisitorPattern & | visitor | ) |
| virtual void SgGlobal::accept | ( | ROSE_VisitorPattern & | visitor | ) | [virtual] |
DXN (08/09/2010): support for the classic visitor pattern done in GoF.
Reimplemented from SgScopeStatement.
| static void SgGlobal::traverseMemoryPoolNodes | ( | ROSE_VisitTraversal & | visit | ) | [static] |
| static void SgGlobal::traverseMemoryPoolVisitorPattern | ( | ROSE_VisitorPattern & | visitor | ) | [static] |
| static void SgGlobal::visitRepresentativeNode | ( | ROSE_VisitTraversal & | visit | ) | [static] |
| virtual bool SgGlobal::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 SgScopeStatement.
| virtual void SgGlobal::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 SgScopeStatement.
| virtual std::vector<std::pair<SgNode*,std::string> > SgGlobal::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 SgScopeStatement.
| virtual void SgGlobal::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 SgScopeStatement.
| virtual long SgGlobal::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 SgScopeStatement.
| SgGlobal* SgGlobal::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 SgScopeStatement.
| void SgGlobal::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 SgScopeStatement.
| SgGlobal::get_declarations | ( | ) | const |
Returns a const list to the global scope declarations.
| SgGlobal::get_declarations | ( | ) |
Returns a list to the global scope declarations.
friend class AST_FILE_IO [friend] |
Reimplemented from SgScopeStatement.
friend class SgGlobalStorageClass [friend] |
friend class AstSpecificDataManagingClass [friend] |
Reimplemented from SgScopeStatement.
friend class AstSpecificDataManagingClassStorageClass [friend] |
Reimplemented from SgScopeStatement.
| SgGlobal::isSgGlobal | ( | SgNode * | s | ) | [friend] |
Casts pointer from base class to derived class.
This functions returns a SgGlobal pointer for any input of a pointer to an object derived from a SgGlobal.
| SgGlobal::isSgGlobal | ( | const SgNode * | s | ) | [friend] |
Casts pointer from base class to derived class (for const pointers).
This functions returns a SgGlobal pointer for any input of a pointer to an object derived from a SgGlobal.
| SgGlobal* SgGlobal_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 SgGlobal_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 SgGlobal_clearMemoryPool | ( | ) | [friend] |
| void SgGlobal_extendMemoryPoolForFileIO | ( | unsigned | long | ) | [friend] |
| void SgGlobal_getNextValidPointer | ( | std::pair< SgGlobal *, std::vector< unsigned char * >::const_iterator > & | ) | [friend] |
| void SgGlobal_resetValidFreepointers | ( | ) | [friend] |
SgGlobal::p_declarations [protected] |
This is an STL list of SgDeclarationStatement objects.
For internal use only.
The name is perhaps all too similar to p_declaration (which exists on many IR nodes).
1.4.7