ROSE  0.9.6a
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
SgForInitStatement Class Reference

This class represents the variable declaration or variable initialization withn a for loop. More...

#include <Cxx_Grammar.h>

Inheritance diagram for SgForInitStatement:
Collaboration diagram for SgForInitStatement:

Public Types

enum  { static_variant = V_SgForInitStatement }
 static variant value More...
 
typedef SgStatement base_node_type
 
- Public Types inherited from SgStatement
enum  { static_variant = V_SgStatement }
 static variant value More...
 
typedef SgLocatedNode base_node_type
 
- Public Types inherited from SgLocatedNode
enum  { static_variant = V_SgLocatedNode }
 static variant value More...
 
typedef SgNode base_node_type
 
- Public Types inherited from SgNode
enum  { static_variant = V_SgNode }
 static variant value More...
 

Public Member Functions

virtual SgNodecopy (SgCopyHelp &help) const
 This function clones the current IR node object recursively or not, depending on the argument. More...
 
virtual unsigned int cfgIndexForEnd () const
 Determine the CFG index for the end of this construct. More...
 
virtual std::vector
< VirtualCFG::CFGEdge
cfgOutEdges (unsigned int index)
 Find the out edges of a CFG node – internal version. More...
 
virtual std::vector
< VirtualCFG::CFGEdge
cfgInEdges (unsigned int index)
 Find the in edges of a CFG node – internal version. More...
 
virtual void fixupCopy (SgNode *copy, SgCopyHelp &help) const
 
virtual void append_init_stmt (SgStatement *element)
 
virtual void prepend_init_stmt (SgStatement *element)
 
virtual std::string class_name () const
 Copies AST (whole subtree, depending on the SgCopyHelp class. More...
 
virtual VariantT variantT () const
 returns new style SageIII enum values More...
 
void * operator new (size_t size)
 returns pointer to newly allocated IR node More...
 
void operator delete (void *pointer, size_t size)
 deallocated memory for IR node (returns memory to memory pool for reuse) More...
 
void operator delete (void *pointer)
 
virtual std::vector< SgNode * > get_traversalSuccessorContainer ()
 FOR INTERNAL USE within ROSE traverals mechanism only. More...
 
virtual std::vector< std::string > get_traversalSuccessorNamesContainer ()
 FOR INTERNAL USE within ROSE traverals mechanism only. More...
 
virtual size_t get_numberOfTraversalSuccessors ()
 
virtual SgNodeget_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. More...
 
virtual const char * sage_class_name () const ROSE_DEPRECATED_FUNCTION
 
void executeVisitorMemberFunction (ROSE_VisitorPattern &visitor)
 FOR INTERNAL USE Support for visitor pattern. More...
 
virtual void accept (ROSE_VisitorPattern &visitor)
 DXN (08/09/2010): support for the classic visitor pattern done in GoF. More...
 
virtual bool isInMemoryPool ()
 FOR INTERNAL USE This is used in internal tests to verify that all IR nodes are allocated from the heap. More...
 
virtual void checkDataMemberPointersIfInMemoryPool ()
 FOR INTERNAL USE This is used in internal tests to verify that all IR nodes are allocated from the heap. More...
 
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 More...
 
virtual void processDataMemberReferenceToPointers (ReferenceToPointerHandler *)
 FOR INTERNAL USE Processes pairs of references to SgNode* and strings for use in AST tools More...
 
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. More...
 
 SgForInitStatement (const SgForInitStatementStorageClass &source)
 
SgForInitStatementaddRegExpAttribute (std::string s, AstRegExAttribute *a)
 Support for AST matching using regular expression. More...
 
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. More...
 
const SgStatementPtrListget_init_stmt () const
 Returns const reference to a SgStatementPtrList (typedef to a STL list). More...
 
SgStatementPtrListget_init_stmt ()
 Returns non-const reference to a SgStatementPtrList (typedef to a STL list). More...
 
virtual ~SgForInitStatement ()
 This is the destructor. More...
 
 SgForInitStatement (Sg_File_Info *startOfConstruct)
 This is the constructor. More...
 
 SgForInitStatement ()
 
- Public Member Functions inherited from SgStatement
virtual SgScopeStatementget_scope (void) const
 Returns scope of current statement. More...
 
virtual void setExtern () ROSE_DEPRECATED_FUNCTION
 This function sets "extern" status for the current statement. More...
 
virtual void setStatic () ROSE_DEPRECATED_FUNCTION
 This function sets "static" status for the current statement. More...
 
void insert_statement (SgStatement *target, SgStatement *newstmt, bool inFront=true)
 This function inserts a single statement at the position indicated by target. More...
 
void insert_statement (SgStatement *target, const SgStatementPtrList &newstmtList, bool inFront=true)
 This function inserts a list of statements at the position indicated by target. More...
 
void replace_statement (SgStatement *target, SgStatement *newstmt)
 This function replaces the target statement with a single statement. More...
 
void replace_statement (SgStatement *target, const SgStatementPtrList &newstmtList)
 This function replaces the target statement with a list of statements. More...
 
void remove_statement (SgStatement *)
 This function removes the target statement from the AST. More...
 
void insert_statement_from_basicBlock (SgStatement *target, SgStatement *newstmt, bool inFront=true)
 This function inserts a statement at the position indicated by target. If newstmt is a basicBlock, statements inside newstmt are extracted and then inserted. More...
 
void replace_statement_from_basicBlock (SgStatement *target, SgStatement *newstmt)
 This function replaces the target statement with a new statement. If newstmt is a basicBlock, statements inside newstmt are extracted and then inserted. More...
 
virtual int replace_expression (SgExpression *, SgExpression *)
 support general replace functions, used in statements that directly contain SgExpression IR nodes. More...
 
virtual void set_scope (SgScopeStatement *newScope)
 Support for setting scopes (only meaningful on IR statements that store the scope explicitly). More...
 
virtual bool hasExplicitScope () const
 Support for where the scope is explicitly required. More...
 
virtual SgSymbolget_symbol_from_symbol_table () const
 Get the associated symbol from the symbol table in the stored scope. More...
 
virtual bool cfgIsIndexInteresting (unsigned int index) const
 Determine whether a particular CFG node index is "interesting" for this kind of node. More...
 
virtual unsigned int cfgFindChildIndex (SgNode *n)
 Find the index of n in this node's CFG children. More...
 
virtual unsigned int cfgFindNextChildIndex (SgNode *n)
 Find the index just after n in this node's CFG children. More...
 
virtual bool isChildUsedAsLValue (const SgExpression *child) const
 Virtual function to determine if the provided expression is used as an l-value within the cotext of this statement. More...
 
virtual void set_end_numeric_label (SgLabelRefExp *end_numeric_label)
 
virtual bool has_end_numeric_label () const
 
bool hasExplicitType ()
 Some statement store internal SgType pointers explicitly. This function is true if it has a data member that is a type (only applies to SgTypedefDeclaration). More...
 
void * operator new (size_t size)
 returns pointer to newly allocated IR node More...
 
void operator delete (void *pointer, size_t size)
 deallocated memory for IR node (returns memory to memory pool for reuse) More...
 
void operator delete (void *pointer)
 
void executeVisitorMemberFunction (ROSE_VisitorPattern &visitor)
 FOR INTERNAL USE Support for visitor pattern. More...
 
 SgStatement (const SgStatementStorageClass &source)
 
SgStatementaddRegExpAttribute (std::string s, AstRegExAttribute *a)
 Support for AST matching using regular expression. More...
 
SgLabelRefExpget_numeric_label () const
 
void set_numeric_label (SgLabelRefExp *numeric_label)
 
int get_source_sequence_value () const
 
void set_source_sequence_value (int source_sequence_value)
 
virtual ~SgStatement ()
 This is the destructor. More...
 
 SgStatement (Sg_File_Info *startOfConstruct)
 This is the constructor. More...
 
 SgStatement ()
 
- Public Member Functions inherited from SgLocatedNode
const std::string & getFilenameString () const
 
void addToAttachedPreprocessingInfo (PreprocessingInfo *prepInfoPtr, PreprocessingInfo::RelativePositionType locationInList=PreprocessingInfo::after)
 This function adds comment or CPP directives to the current IR node. More...
 
virtual Sg_File_Infoget_file_info () const
 Interface function to implement original SAGE interface to SgFile_Info objects. More...
 
virtual void set_file_info (Sg_File_Info *X)
 Access function calls set_startingConstruct(Sg_File_Info*) member function. More...
 
void setCompilerGenerated ()
 Allow IR nodes (mostly SgLocatedNode) to be marked as compiler generated. More...
 
void unsetCompilerGenerated ()
 
void setFrontendSpecific ()
 Allow IR nodes (mostly SgLocatedNode) to be marked as front-end specific (generated by the front-end to support a specific backend compiler; e.g. GNU gcc and g++). More...
 
void unsetFrontendSpecific ()
 
void setSourcePositionUnavailableInFrontend ()
 Allow IR nodes (mostly SgLocatedNode) to be marked as to when the information was unavilable in the front-end (even if it typically is there are special cases). More...
 
void unsetSourcePositionUnavailableInFrontend ()
 
void setOutputInCodeGeneration ()
 Allow IR nodes (mostly SgLocatedNode) to be marked as to when the information was unavilable in the front-end (even if it typically is there are special cases). More...
 
void unsetOutputInCodeGeneration ()
 
AttachedPreprocessingInfoType *& getAttachedPreprocessingInfo (void)
 Computes the number of nodes in the defined subtree of the AST. More...
 
Sg_File_InfogenerateMatchingFileInfo ()
 
virtual void addNewAttribute (std::string s, AstAttribute *a)
 Add a new attribute represented by the named string. More...
 
virtual AstAttributegetAttribute (std::string s) const
 Returns attribute of name 's'. More...
 
virtual void updateAttribute (std::string s, AstAttribute *a)
 Replace existing attribute of name 's' with new AstAttribute. More...
 
virtual void setAttribute (std::string s, AstAttribute *a)
 This is a wrapper function with the following semantics: if no attribute of name 's' exists then addNewAttribute(s,a); is called, otherwise updateAttribute(s,a); is called. More...
 
virtual void removeAttribute (std::string s)
 Remove attribute of name 's' if present. More...
 
virtual bool attributeExists (std::string s) const
 Tests if attribute of name 's' is present. More...
 
virtual int numberOfAttributes () const
 Returns the number of attributes on this IR node. More...
 
void * operator new (size_t size)
 returns pointer to newly allocated IR node More...
 
void operator delete (void *pointer, size_t size)
 deallocated memory for IR node (returns memory to memory pool for reuse) More...
 
void operator delete (void *pointer)
 
void executeVisitorMemberFunction (ROSE_VisitorPattern &visitor)
 FOR INTERNAL USE Support for visitor pattern. More...
 
 SgLocatedNode (const SgLocatedNodeStorageClass &source)
 
SgLocatedNodeaddRegExpAttribute (std::string s, AstRegExAttribute *a)
 Support for AST matching using regular expression. More...
 
Sg_File_Infoget_startOfConstruct () const
 New function interface for Sg_File_Info data stores starting location of contruct (typically the opening brace or first letter of keyword). More...
 
void set_startOfConstruct (Sg_File_Info *startOfConstruct)
 This function sets the current source location position of the start of the current construct. More...
 
Sg_File_Infoget_endOfConstruct () const
 New function interface for Sg_File_Info data stores ending location of contruct (typically the closing brace). More...
 
void set_endOfConstruct (Sg_File_Info *endOfConstruct)
 This function sets the current source location position of the end of the current construct. More...
 
AttachedPreprocessingInfoTypeget_attachedPreprocessingInfoPtr () const
 
void set_attachedPreprocessingInfoPtr (AttachedPreprocessingInfoType *attachedPreprocessingInfoPtr)
 
AstAttributeMechanismget_attributeMechanism () const
 FOR INTERNAL USE Access function; if an attribute exists then a pointer to it is returned, else error. More...
 
void set_attributeMechanism (AstAttributeMechanism *attributeMechanism)
 FOR INTERNAL USE Access function; sets poiner to value AstAttributeMechanism. More...
 
virtual ~SgLocatedNode ()
 This is the destructor. More...
 
 SgLocatedNode (Sg_File_Info *startOfConstruct=NULL)
 This is the constructor. More...
 
- Public Member Functions inherited from SgNode
void * operator new (size_t size)
 returns pointer to newly allocated IR node More...
 
void operator delete (void *pointer, size_t size)
 deallocated memory for IR node (returns memory to memory pool for reuse) More...
 
void operator delete (void *pointer)
 
void executeVisitorMemberFunction (ROSE_VisitorPattern &visitor)
 FOR INTERNAL USE Support for visitor pattern. More...
 
 SgNode (const SgNodeStorageClass &source)
 
SgNodeaddRegExpAttribute (std::string s, AstRegExAttribute *a)
 Support for AST matching using regular expression. More...
 
void set_isModified (bool isModified)
 All nodes in the AST contain a isModified flag used to track changes to the AST. More...
 
bool get_isModified () const
 Acess function for isModified flag This flag records if the current IR node has been modified. It is set to false after and ROSE front-end processing. More...
 
void set_parent (SgNode *parent)
 All nodes in the AST contain a reference to a parent node. More...
 
SgNodeget_parent () const
 Access function for parent node. More...
 
bool isChild (SgNode *node) const
 Query function for if the input IR nodes is a child of the current IR node. More...
 
virtual std::string unparseToString (SgUnparse_Info *info) const
 This function unparses the AST node (excluding comments and unnecessary white space) More...
 
std::string unparseToString () const
 
std::string unparseToCompleteString ()
 This function unparses the AST node (including comments and white space) More...
 
int variant () const ROSE_DEPRECATED_FUNCTION
 Older version function returns enum value "NODE". More...
 
VirtualCFG::CFGNode cfgForBeginning ()
 Returns the CFG node for just before this AST node. More...
 
VirtualCFG::CFGNode cfgForEnd ()
 Returns the CFG node for just after this AST node. More...
 
int numberOfNodesInSubtree ()
 Computes the number of nodes in the defined subtree of the AST. More...
 
int depthOfSubtree ()
 Computes the depth of the current defined subtree of the AST. More...
 
SgNodeget_freepointer () const
 
void set_freepointer (SgNode *freepointer)
 
virtual ~SgNode ()
 This is the destructor. More...
 
 SgNode ()
 This is the constructor. More...
 
bool get_isVisited () const ROSE_DEPRECATED_FUNCTION
 DOCS IN HEADER: Access function for p_isVisited flag used previously by the AST traversals. More...
 
void set_isVisited (bool isVisited) ROSE_DEPRECATED_FUNCTION
 Access function for p_isVisited flag used previously by the AST traversals. More...
 

Static Public Member Functions

static size_t numberOfNodes ()
 Returns the total number of IR nodes of this type. More...
 
static size_t memoryUsage ()
 Returns the size in bytes of the total memory allocated for all IR nodes of this type. More...
 
static void traverseMemoryPoolNodes (ROSE_VisitTraversal &visit)
 FOR INTERNAL USE Support for visitor pattern. More...
 
static void traverseMemoryPoolVisitorPattern (ROSE_VisitorPattern &visitor)
 FOR INTERNAL USE Support for visitor pattern. More...
 
static void visitRepresentativeNode (ROSE_VisitTraversal &visit)
 FOR INTERNAL USE Support for type-based traversal. More...
 
- Static Public Member Functions inherited from SgStatement
static size_t numberOfNodes ()
 Returns the total number of IR nodes of this type. More...
 
static size_t memoryUsage ()
 Returns the size in bytes of the total memory allocated for all IR nodes of this type. More...
 
static void traverseMemoryPoolNodes (ROSE_VisitTraversal &visit)
 FOR INTERNAL USE Support for visitor pattern. More...
 
static void traverseMemoryPoolVisitorPattern (ROSE_VisitorPattern &visitor)
 FOR INTERNAL USE Support for visitor pattern. More...
 
static void visitRepresentativeNode (ROSE_VisitTraversal &visit)
 FOR INTERNAL USE Support for type-based traversal. More...
 
- Static Public Member Functions inherited from SgLocatedNode
static size_t numberOfNodes ()
 Returns the total number of IR nodes of this type. More...
 
static size_t memoryUsage ()
 Returns the size in bytes of the total memory allocated for all IR nodes of this type. More...
 
static void traverseMemoryPoolNodes (ROSE_VisitTraversal &visit)
 FOR INTERNAL USE Support for visitor pattern. More...
 
static void traverseMemoryPoolVisitorPattern (ROSE_VisitorPattern &visitor)
 FOR INTERNAL USE Support for visitor pattern. More...
 
static void visitRepresentativeNode (ROSE_VisitTraversal &visit)
 FOR INTERNAL USE Support for type-based traversal. More...
 
- Static Public Member Functions inherited from SgNode
static size_t numberOfNodes ()
 Returns the total number of IR nodes of this type. More...
 
static size_t memoryUsage ()
 Returns the size in bytes of the total memory allocated for all IR nodes of this type. More...
 
static void traverseMemoryPoolNodes (ROSE_VisitTraversal &visit)
 FOR INTERNAL USE Support for visitor pattern. More...
 
static void traverseMemoryPoolVisitorPattern (ROSE_VisitorPattern &visitor)
 FOR INTERNAL USE Support for visitor pattern. More...
 
static void visitRepresentativeNode (ROSE_VisitTraversal &visit)
 FOR INTERNAL USE Support for type-based traversal. More...
 
static std::vector< std::string > buildCommandLineToSubstituteTransformationFile (const std::vector< std::string > &argv, std::string newFileName)
 Command line support for this compilation The command line is saved as a static variable so that it will be available to support the rewrite mechanism. More...
 
static std::vector< VariantTgetClassHierarchySubTreeFunction (VariantT v)
 
static void getClassHierarchySubTreeFunction (VariantT v, std::vector< VariantT > &)
 
static std::map< SgNode
*, std::string > & 
get_globalMangledNameMap ()
 Access function for performance optimizing global mangled name map. More...
 
static void clearGlobalMangledNameMap ()
 Support to clear the performance optimizing global mangled name map. More...
 
static std::map< std::string,
int > & 
get_shortMangledNameCache ()
 Access function for lower level optimizing of global mangled name map. More...
 
static std::map< SgNode
*, std::string > & 
get_globalQualifiedNameMapForNames ()
 Access function for name qualification support (for names). More...
 
static void set_globalQualifiedNameMapForNames (const std::map< SgNode *, std::string > &X)
 Access function for name qualification support (for names). More...
 
static std::map< SgNode
*, std::string > & 
get_globalQualifiedNameMapForTypes ()
 Access function for name qualification support (for type). More...
 
static void set_globalQualifiedNameMapForTypes (const std::map< SgNode *, std::string > &X)
 Access function for name qualification support (for type). More...
 
static std::map< SgNode
*, std::string > & 
get_globalTypeNameMap ()
 Access function for name qualification support (for names of types). More...
 
static void set_globalTypeNameMap (const std::map< SgNode *, std::string > &X)
 Access function for name qualification support (for names of types). More...
 
static SgFunctionTypeTableget_globalFunctionTypeTable ()
 Access function for symbol table specific to function types. More...
 
static void set_globalFunctionTypeTable (SgFunctionTypeTable *globalFunctionTypeTable)
 Access function for symbol table specific to function types. More...
 
static SgTypeTableget_globalTypeTable ()
 Access function for symbol table specific to non-function types. More...
 
static void set_globalTypeTable (SgTypeTable *globalTypeTable)
 Access function for symbol table specific to non-function types. More...
 

Protected Member Functions

virtual bool replace_child (SgStatement *, SgStatement *, bool extractListFromBasicBlock=false)
 Private supporting function for low level SageIII rewrite interface. More...
 
virtual bool insert_child (SgStatement *, SgStatement *, bool inFront=true, bool extractListFromBasicBlock=false)
 Private supporting function for low level SageIII rewrite interface. More...
 
Private Supporting Functions for Low-Level Rewrite Interface

Low-level Support for mutation of the AST.

This is the lowest level of support for the mutation of the AST.

Need to document this section more fully.

Protected Attributes

SgStatementPtrList p_init_stmt
 This pointer points to list of initializers in a SgForStatement. More...
 
- Protected Attributes inherited from SgStatement
SgLabelRefExpp_numeric_label
 
int p_source_sequence_value
 
- Protected Attributes inherited from SgLocatedNode
Sg_File_Infop_startOfConstruct
 This pointer is always valid and stores the source position of the start of the current construct. More...
 
Sg_File_Infop_endOfConstruct
 This pointer is always valid and stores the source position of the end of the current construct. More...
 
AttachedPreprocessingInfoTypep_attachedPreprocessingInfoPtr
 Holds comments and/or preprocessor directives located before or after the current statement of expression. More...
 
AstAttributeMechanismp_attributeMechanism
 
- Protected Attributes inherited from SgNode
SgNodep_parent
 This is the pointer to the parent IR node in the AST. More...
 
bool p_isModified
 Records if IR node has been modified (data members reset). More...
 
SgNodep_freepointer
 This is the pointer to the chain of previously freed objects. More...
 

Friends

class AST_FILE_IO
 
class SgForInitStatementStorageClass
 
class AstSpecificDataManagingClass
 
class AstSpecificDataManagingClassStorageClass
 
ROSE_DLL_API friend
SgForInitStatement
isSgForInitStatement (SgNode *s)
 Casts pointer from base class to derived class. More...
 
ROSE_DLL_API friend const
SgForInitStatement
isSgForInitStatement (const SgNode *s)
 Casts pointer from base class to derived class (for const pointers) More...
 
SgForInitStatementSgForInitStatement_getPointerFromGlobalIndex (unsigned long globalIndex)
 Constructor for use by AST File I/O Mechanism. More...
 
unsigned long SgForInitStatement_getNumberOfValidNodesAndSetGlobalIndexInFreepointer (unsigned long)
 Get the size of the memory pool. More...
 
void SgForInitStatement_clearMemoryPool ()
 
void SgForInitStatement_extendMemoryPoolForFileIO (unsigned long)
 
void SgForInitStatement_getNextValidPointer (std::pair< SgForInitStatement *, std::vector< unsigned char * >::const_iterator > &)
 
void SgForInitStatement_resetValidFreepointers ()
 

Additional Inherited Members

- Static Protected Attributes inherited from SgNode
static SgFunctionTypeTablep_globalFunctionTypeTable
 Pointer to symbol table specific to function types. More...
 
static SgTypeTablep_globalTypeTable
 
static std::map< SgNode
*, std::string > 
p_globalMangledNameMap
 Cache of mangled names to avoid regeneration of previously build mangled names or parts of mangled names. This is a performance optimization. More...
 
static std::map< std::string, int > p_shortMangledNameCache
 STL map used as a cache to shorten generated mangled names. This is mostly a space optimization ofr mangled names of templates. More...
 
static std::map< SgNode
*, std::string > 
p_globalQualifiedNameMapForNames
 
static std::map< SgNode
*, std::string > 
p_globalQualifiedNameMapForTypes
 
static std::map< SgNode
*, std::string > 
p_globalTypeNameMap
 

Detailed Description

This class represents the variable declaration or variable initialization withn a for loop.

This class is only used in a SgForStatement; and represents "*" within 
     "for(*; <condition>; <expression>)".

The design of the ROSE traversal mechanism requires that the child list at any IR node be a list or a collection of data members (but not both, since it would not be clear when the list ended and another list or data member begain). this class is required so that list of initializers in a for loop (an arbitary length list) can be isolated from the other data members in the SgForStatement.

Todo:
Evaluate if this should be derived from SgSupport, like other "list" based IR nodes.
Todo:
Evaluate if we should even have this IR node. If the SgVariableDeclaration were to be fixed to really use the list of SgInitializedName objects where multiple variables are declared in the same variable declaration then we might not need this (I think). And if it didn't exist it would make the use of the SgForStatement a little bit simpler.
See Also
Example of using a SgForInitStatement object

Definition at line 145745 of file Cxx_Grammar.h.

Member Typedef Documentation

Member Enumeration Documentation

anonymous enum

static variant value

Enumerator
static_variant 

Definition at line 145823 of file Cxx_Grammar.h.

Constructor & Destructor Documentation

SgForInitStatement::SgForInitStatement ( const SgForInitStatementStorageClass source)
SgForInitStatement::~SgForInitStatement ( )
virtual

This is the destructor.

There are a lot of things to delete, but nothing is deleted in this destructor.

SgForInitStatement::SgForInitStatement ( Sg_File_Info startOfConstruct = NULL)

This is the constructor.

This constructor builds the SgForInitStatement base class.

Parameters
startOfConstructrepresents the position in the source code
SgForInitStatement::SgForInitStatement ( )

Member Function Documentation

virtual SgNode* SgForInitStatement::copy ( SgCopyHelp help) const
virtual

This function clones the current IR node object recursively or not, depending on the argument.

This function performs a copy based on the specification of the input parameter. The input parameter is used to determin which data members are copied by reference and which are copied by value.

Parameters
help- If this argument is of type SgTreeCopy, then the IR node is cloned recursively. If its of type SgShallowCopy only the first level of the IR node is copied, everything else is left pointing to the the original IR node's object's data members.
Returns
a pointer to the new clone.

It appears the the copy functions don't set the parents of anything that they do a deep copy of! This can cause AST tests to fail. In particular some functions that require the parent pointers to be valid will return NULL pointers (e.g. SgInitializedName::get_declaration()). It might be that we should allow this to be done as part of the SgCopyHelp::clone function or perhaps another member function of SgCopyHelp would be useful for this support. It is not serious if the AST post processing is done since that will set any NULL pointers that are found within its traversal.

Exceptions
noneNo exceptions are thrown by this function.

Reimplemented from SgStatement.

virtual bool SgForInitStatement::replace_child ( SgStatement target,
SgStatement newStmt,
bool  extractListFromBasicBlock = false 
)
protectedvirtual

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.

Returns
Returns bool.

Reimplemented from SgStatement.

virtual bool SgForInitStatement::insert_child ( SgStatement ,
SgStatement ,
bool  inFront = true,
bool  extractListFromBasicBlock = false 
)
protectedvirtual

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.

Returns
Returns bool.

Reimplemented from SgStatement.

virtual unsigned int SgForInitStatement::cfgIndexForEnd ( ) const
virtual

Determine the CFG index for the end of this construct.

Reimplemented from SgStatement.

virtual std::vector<VirtualCFG::CFGEdge> SgForInitStatement::cfgOutEdges ( unsigned int  index)
virtual

Find the out edges of a CFG node – internal version.

Reimplemented from SgStatement.

virtual std::vector<VirtualCFG::CFGEdge> SgForInitStatement::cfgInEdges ( unsigned int  index)
virtual

Find the in edges of a CFG node – internal version.

Reimplemented from SgStatement.

virtual void SgForInitStatement::fixupCopy ( SgNode copy,
SgCopyHelp help 
) const
virtual

Reimplemented from SgStatement.

virtual void SgForInitStatement::append_init_stmt ( SgStatement element)
virtual
virtual void SgForInitStatement::prepend_init_stmt ( SgStatement element)
virtual
virtual std::string SgForInitStatement::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 SgForInitStatement::variantT ( ) const
virtual

returns new style SageIII enum values

Reimplemented from SgStatement.

void* SgForInitStatement::operator new ( size_t  size)

returns pointer to newly allocated IR node

void SgForInitStatement::operator delete ( void *  pointer,
size_t  size 
)

deallocated memory for IR node (returns memory to memory pool for reuse)

void SgForInitStatement::operator delete ( void *  pointer)
static size_t SgForInitStatement::numberOfNodes ( )
static

Returns the total number of IR nodes of this type.

static size_t SgForInitStatement::memoryUsage ( )
static

Returns the size in bytes of the total memory allocated for all IR nodes of this type.

virtual std::vector<SgNode*> SgForInitStatement::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.

Warning
This function can return unexpected data members and thus the order and the number of elements is unpredicable and subject to change.
Returns
Returns ordered STL Container of pointers to children nodes in AST.

Reimplemented from SgStatement.

virtual std::vector<std::string> SgForInitStatement::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.

Warning
This function can return unexpected data members and thus the order and the number of elements is unpredicable and subject to change.

Each string is a name of a member variable holding a pointer to a child in the AST. The names are the same as used in the generated enums for accessing attributes in a traversal. The order is the same in which they are traversed and the same in which the access enums are defined. Therefore this method can be used to get the corresponding name (string) of an access enum which allows to produce more meaningful messages for attribute computations.

Returns
Returns ordered STL container of names (strings) of access names to children nodes in AST.

Reimplemented from SgStatement.

virtual size_t SgForInitStatement::get_numberOfTraversalSuccessors ( )
virtual

Reimplemented from SgStatement.

virtual SgNode* SgForInitStatement::get_traversalSuccessorByIndex ( size_t  idx)
virtual

Reimplemented from SgStatement.

virtual size_t SgForInitStatement::get_childIndex ( SgNode child)
virtual

Reimplemented from SgStatement.

virtual RTIReturnType SgForInitStatement::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.

Returns
Returns a RTIReturnType object (runtime type information).

Reimplemented from SgStatement.

virtual const char* SgForInitStatement::sage_class_name ( ) const
virtual

returns a C style string (char*) representing the class name

Reimplemented from SgStatement.

void SgForInitStatement::executeVisitorMemberFunction ( ROSE_VisitorPattern visitor)

FOR INTERNAL USE Support for visitor pattern.

virtual void SgForInitStatement::accept ( ROSE_VisitorPattern visitor)
virtual

DXN (08/09/2010): support for the classic visitor pattern done in GoF.

Reimplemented from SgStatement.

static void SgForInitStatement::traverseMemoryPoolNodes ( ROSE_VisitTraversal visit)
static

FOR INTERNAL USE Support for visitor pattern.

static void SgForInitStatement::traverseMemoryPoolVisitorPattern ( ROSE_VisitorPattern visitor)
static

FOR INTERNAL USE Support for visitor pattern.

static void SgForInitStatement::visitRepresentativeNode ( ROSE_VisitTraversal visit)
static

FOR INTERNAL USE Support for type-based traversal.

virtual bool SgForInitStatement::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 SgForInitStatement::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> > SgForInitStatement::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.

Warning
This function can return unexpected data members and thus the order and the number of elements is unpredicable and subject to change.
Returns
STL vector of pairs of SgNode* and strings

Reimplemented from SgStatement.

virtual void SgForInitStatement::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.

Warning
This function can return unexpected data members and thus the order and the number of elements is unpredicable and subject to change.

Reimplemented from SgStatement.

virtual long SgForInitStatement::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).

Warning
The mapping on children to integer values could change from release to release of ROSE.
Returns
long

Reimplemented from SgStatement.

SgForInitStatement* SgForInitStatement::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.

void SgForInitStatement::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.

SgForInitStatement::get_init_stmt ( ) const

Returns const reference to a SgStatementPtrList (typedef to a STL list).

Returns
Returns const reference to STL list.
SgForInitStatement::get_init_stmt ( )

Returns non-const reference to a SgStatementPtrList (typedef to a STL list).

Returns
Returns non-const reference to STL list.

Friends And Related Function Documentation

friend class AST_FILE_IO
friend

Definition at line 146094 of file Cxx_Grammar.h.

friend class SgForInitStatementStorageClass
friend

Definition at line 146095 of file Cxx_Grammar.h.

friend class AstSpecificDataManagingClass
friend

Definition at line 146096 of file Cxx_Grammar.h.

friend class AstSpecificDataManagingClassStorageClass
friend

Definition at line 146097 of file Cxx_Grammar.h.

SgForInitStatement::isSgForInitStatement ( SgNode s)
friend

Casts pointer from base class to derived class.

Cast function (from derived class to SgForInitStatement pointer).

This functions returns a SgForInitStatement pointer for any input of a pointer to an object derived from a SgForInitStatement.

Returns
Returns valid pointer to SgForInitStatement if input is derived from a SgLocatedNode.
SgForInitStatement::isSgForInitStatement ( const SgNode s)
friend

Casts pointer from base class to derived class (for const pointers)

Cast function (from derived class to SgForInitStatement pointer).

This functions returns a SgForInitStatement pointer for any input of a pointer to an object derived from a SgForInitStatement.

Returns
Returns valid pointer to SgForInitStatement if input is derived from a SgLocatedNode.
SgForInitStatement* SgForInitStatement_getPointerFromGlobalIndex ( unsigned long  globalIndex)
friend

Constructor for use by AST File I/O Mechanism.

This constructor permits the IR node to be rebuilt from the contiguously arranged data in memory which obtained via fast binary file I/O from disk.

Typedef 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 SgForInitStatement_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 SgForInitStatement_clearMemoryPool ( )
friend
void SgForInitStatement_extendMemoryPoolForFileIO ( unsigned  long)
friend
void SgForInitStatement_getNextValidPointer ( std::pair< SgForInitStatement *, std::vector< unsigned char * >::const_iterator > &  )
friend
void SgForInitStatement_resetValidFreepointers ( )
friend

Member Data Documentation

SgForInitStatement::p_init_stmt
protected

This pointer points to list of initializers in a SgForStatement.

Definition at line 146162 of file Cxx_Grammar.h.


The documentation for this class was generated from the following files: