#include <Cxx_Grammar.h>
Inheritance diagram for SgLabelStatement:
The label statment is used for labels asociated with goto statements.
A label construct in C++ has a statement associated with it, this concept is not represented in ROSE, but is one of the ways that IPR differs from ROSE. It seems that EDG accepts the representation of a label without a statement as an extension (ref Peter). An empty statement is an alternative representation: label:; instead of label:
To handle the case where a label is used without an associated statement ROSE will unparse: "LABEL:;" to avoid generating cases without an associated statement. The "empty statement" represented by ";" is ignored and so will not cause an error or change the semantics.
For internal use only.
Since the label statment does not define a scope, it is not clear that we want to attach a sequence of statements to the label which would only be traversed through the label statement. We could alternatively fixup label statements to internally reference their next statement if it exists, or an empty statement (e.g. ";") if it did not exist. The problem with a internal reference is that it serves on particular purpose, and represent a muptiple refeence to it's associated statement (which could cause bugs within transformations), so the current design might be best.
Public Types | |
| typedef SgStatement | base_node_type |
| static_variant = V_SgLabelStatement | |
| enum | { static_variant = V_SgLabelStatement } |
| static variant value More... | |
Public Member Functions | |
| virtual SgNode * | copy (SgCopyHelp &help) const |
| SgName | get_name () const ROSE_DEPRECATED_FUNCTION |
| 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 SgSymbol * | get_symbol_from_symbol_table () const |
| Get the associated symbol from the symbol table in the stored scope. | |
| virtual void | fixupCopy (SgNode *copy, SgCopyHelp &help) const |
| virtual bool | hasExplicitScope () const |
| Support for where the scope is explicitly required. | |
| 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. | |
| SgLabelStatement (const SgLabelStatementStorageClass &source) | |
| SgLabelStatement * | 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_label () const |
| Returns SgName by value. | |
| void | set_label (SgName label) |
| Access function for p_label. | |
| SgScopeStatement * | get_scope () const |
| Returns scope of current statement. | |
| void | set_scope (SgScopeStatement *scope) |
| Support for setting scopes (only meaningful on IR statements that store the scope explicitly). | |
| SgStatement * | get_statement () const |
| void | set_statement (SgStatement *statement) |
| bool | get_gnu_extension_unused () const |
| void | set_gnu_extension_unused (bool gnu_extension_unused) |
| virtual | ~SgLabelStatement () |
| This is the destructor. | |
| SgLabelStatement (Sg_File_Info *startOfConstruct, SgName label="", SgStatement *statement=NULL) | |
| SgLabelStatement (SgName label, SgStatement *statement) | |
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_label |
| This a SgName object which stores the name of the label. | |
| SgScopeStatement * | p_scope |
| SgStatement * | p_statement |
| bool | p_gnu_extension_unused |
Friends | |
| class | AST_FILE_IO |
| class | SgLabelStatementStorageClass |
| class | AstSpecificDataManagingClass |
| class | AstSpecificDataManagingClassStorageClass |
| SgLabelStatement * | isSgLabelStatement (SgNode *s) |
| Casts pointer from base class to derived class. | |
| const SgLabelStatement * | isSgLabelStatement (const SgNode *s) |
| Casts pointer from base class to derived class (for const pointers). | |
| SgLabelStatement * | SgLabelStatement_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 | SgLabelStatement_getNumberOfValidNodesAndSetGlobalIndexInFreepointer (unsigned long) |
| Get the size of the memory pool. | |
| void | SgLabelStatement_clearMemoryPool () |
| void | SgLabelStatement_extendMemoryPoolForFileIO (unsigned long) |
| void | SgLabelStatement_getNextValidPointer (std::pair< SgLabelStatement *, std::vector< unsigned char * >::const_iterator > &) |
| void | SgLabelStatement_resetValidFreepointers () |
Reimplemented from SgStatement.
| SgLabelStatement::SgLabelStatement | ( | const SgLabelStatementStorageClass & | source | ) |
| SgLabelStatement::~SgLabelStatement | ( | ) | [virtual] |
This is the destructor.
There are a lot of things to delete, but nothing is deleted in this destructor.
| SgLabelStatement::SgLabelStatement | ( | Sg_File_Info * | startOfConstruct, | |
| SgName | label = "", |
|||
| SgStatement * | statement = NULL | |||
| ) |
| SgLabelStatement::SgLabelStatement | ( | SgName | label, | |
| SgStatement * | statement | |||
| ) |
| virtual SgNode* SgLabelStatement::copy | ( | SgCopyHelp & | help | ) | const [virtual] |
Reimplemented from SgStatement.
| SgName SgLabelStatement::get_name | ( | ) | const |
| virtual unsigned int SgLabelStatement::cfgIndexForEnd | ( | ) | const [virtual] |
| virtual std::vector<VirtualCFG::CFGEdge> SgLabelStatement::cfgOutEdges | ( | unsigned int | index | ) | [virtual] |
| virtual std::vector<VirtualCFG::CFGEdge> SgLabelStatement::cfgInEdges | ( | unsigned int | index | ) | [virtual] |
| virtual SgSymbol* SgLabelStatement::get_symbol_from_symbol_table | ( | ) | const [virtual] |
Get the associated symbol from the symbol table in the stored scope.
Reimplemented from SgStatement.
| virtual void SgLabelStatement::fixupCopy | ( | SgNode * | copy, | |
| SgCopyHelp & | help | |||
| ) | const [virtual] |
Reimplemented from SgStatement.
| virtual bool SgLabelStatement::hasExplicitScope | ( | ) | const [virtual] |
| virtual std::string SgLabelStatement::class_name | ( | ) | const [virtual] |
Copies AST (whole subtree, depending on the SgCopyHelp class returns a string representing the class name.
Reimplemented from SgStatement.
| virtual VariantT SgLabelStatement::variantT | ( | ) | const [virtual] |
| void* SgLabelStatement::operator new | ( | size_t | size | ) |
| void SgLabelStatement::operator delete | ( | void * | pointer, | |
| size_t | size | |||
| ) |
deallocated memory for IR node (returns memory to memory pool for reuse)
Reimplemented from SgStatement.
| void SgLabelStatement::operator delete | ( | void * | pointer | ) |
Reimplemented from SgStatement.
| static size_t SgLabelStatement::numberOfNodes | ( | ) | [static] |
| static size_t SgLabelStatement::memoryUsage | ( | ) | [static] |
Returns the size in bytes of the total memory allocated for all IR nodes of this type.
Reimplemented from SgStatement.
| virtual std::vector<SgNode*> SgLabelStatement::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 SgStatement.
| virtual std::vector<std::string> SgLabelStatement::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 SgStatement.
| virtual size_t SgLabelStatement::get_numberOfTraversalSuccessors | ( | ) | [virtual] |
Reimplemented from SgStatement.
| virtual SgNode* SgLabelStatement::get_traversalSuccessorByIndex | ( | size_t | idx | ) | [virtual] |
Reimplemented from SgStatement.
| virtual size_t SgLabelStatement::get_childIndex | ( | SgNode * | child | ) | [virtual] |
Reimplemented from SgStatement.
| virtual RTIReturnType SgLabelStatement::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 SgStatement.
| virtual const char* SgLabelStatement::sage_class_name | ( | ) | const [virtual] |
returns a C style string (char*) representing the class name
Reimplemented from SgStatement.
| void SgLabelStatement::executeVisitorMemberFunction | ( | ROSE_VisitorPattern & | visitor | ) |
| virtual void SgLabelStatement::accept | ( | ROSE_VisitorPattern & | visitor | ) | [virtual] |
DXN (08/09/2010): support for the classic visitor pattern done in GoF.
Reimplemented from SgStatement.
| static void SgLabelStatement::traverseMemoryPoolNodes | ( | ROSE_VisitTraversal & | visit | ) | [static] |
| static void SgLabelStatement::traverseMemoryPoolVisitorPattern | ( | ROSE_VisitorPattern & | visitor | ) | [static] |
| static void SgLabelStatement::visitRepresentativeNode | ( | ROSE_VisitTraversal & | visit | ) | [static] |
| virtual bool SgLabelStatement::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 SgStatement.
| virtual void SgLabelStatement::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 SgStatement.
| virtual std::vector<std::pair<SgNode*,std::string> > SgLabelStatement::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 SgStatement.
| virtual void SgLabelStatement::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 SgStatement.
| virtual long SgLabelStatement::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 SgStatement.
| SgLabelStatement* SgLabelStatement::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 SgStatement.
| void SgLabelStatement::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 SgStatement.
| SgLabelStatement::set_label | ( | SgName | label | ) |
Access function for p_label.
| SgScopeStatement* SgLabelStatement::get_scope | ( | void | ) | const [virtual] |
Returns scope of current statement.
This functions returns a pointer to the inner most SgScopeStatement where the current statement is located. This is a function called after the parents have been set. It is not called by the EDG/SAGE interface and is only called after the SAGE AST has been built and the parent pointers set within a separate phase. Improtant exception: The SgFunctionParameterList should have as it's scope the SgFunctionDefinition, but it is a sibling of the SgFunctionDefinition (both the SgFunctionParameterList and the SgFunctionDefinition have the SgFunctionDeclaration as a parent. Thus the scope of the SgFunctionParameterList is computed to be the SgGlobal (global scope) most often; which is an error). So we handle this case explicitly.
Reimplemented from SgStatement.
| void SgLabelStatement::set_scope | ( | SgScopeStatement * | scope | ) | [virtual] |
Support for setting scopes (only meaningful on IR statements that store the scope explicitly).
Reimplemented from SgStatement.
| SgStatement* SgLabelStatement::get_statement | ( | ) | const |
| void SgLabelStatement::set_statement | ( | SgStatement * | statement | ) |
| bool SgLabelStatement::get_gnu_extension_unused | ( | ) | const |
| void SgLabelStatement::set_gnu_extension_unused | ( | bool | gnu_extension_unused | ) |
friend class AST_FILE_IO [friend] |
Reimplemented from SgStatement.
friend class SgLabelStatementStorageClass [friend] |
friend class AstSpecificDataManagingClass [friend] |
Reimplemented from SgStatement.
friend class AstSpecificDataManagingClassStorageClass [friend] |
Reimplemented from SgStatement.
| SgLabelStatement::isSgLabelStatement | ( | SgNode * | s | ) | [friend] |
Casts pointer from base class to derived class.
This functions returns a SgLabelStatement pointer for any input of a pointer to an object derived from a SgLabelStatement.
| SgLabelStatement::isSgLabelStatement | ( | const SgNode * | s | ) | [friend] |
Casts pointer from base class to derived class (for const pointers).
This functions returns a SgLabelStatement pointer for any input of a pointer to an object derived from a SgLabelStatement.
| SgLabelStatement* SgLabelStatement_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 SgLabelStatement_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 SgLabelStatement_clearMemoryPool | ( | ) | [friend] |
| void SgLabelStatement_extendMemoryPoolForFileIO | ( | unsigned | long | ) | [friend] |
| void SgLabelStatement_getNextValidPointer | ( | std::pair< SgLabelStatement *, std::vector< unsigned char * >::const_iterator > & | ) | [friend] |
| void SgLabelStatement_resetValidFreepointers | ( | ) | [friend] |
SgLabelStatement::p_label [protected] |
This a SgName object which stores the name of the label.
SgScopeStatement* SgLabelStatement::p_scope [protected] |
SgStatement* SgLabelStatement::p_statement [protected] |
bool SgLabelStatement::p_gnu_extension_unused [protected] |
1.4.7