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

This class represents the notion of an initializer for a variable declaration or expression in a function call argument list. More...

#include <Cxx_Grammar.h>

Inheritance diagram for SgConstructorInitializer:
Collaboration diagram for SgConstructorInitializer:

Public Types

enum  { static_variant = V_SgConstructorInitializer }
 static variant value More...
 
typedef SgInitializer base_node_type
 
- Public Types inherited from SgInitializer
enum  { static_variant = V_SgInitializer }
 static variant value More...
 
typedef SgExpression base_node_type
 
- Public Types inherited from SgExpression
enum  { static_variant = V_SgExpression }
 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 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 unsigned int cfgIndexForEnd () const
 Determine the CFG index for the end of this construct. More...
 
SgClassDeclarationget_class_decl () const
 Get the SgClassDeclaration associated with this constructor call. More...
 
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...
 
 SgConstructorInitializer (const SgConstructorInitializerStorageClass &source)
 
SgConstructorInitializeraddRegExpAttribute (std::string s, AstRegExAttribute *a)
 Support for AST matching using regular expression. More...
 
SgTypeget_type () const
 unparsing support for pragmas 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...
 
SgExpressionget_next (int &n) const ROSE_DEPRECATED_FUNCTION
 
int replace_expression (SgExpression *, SgExpression *) ROSE_DEPRECATED_FUNCTION
 This class represents the base class of all the expressions within this grammar. More...
 
SgMemberFunctionDeclarationget_declaration () const
 
void set_declaration (SgMemberFunctionDeclaration *declaration)
 
SgExprListExpget_args () const
 
void set_args (SgExprListExp *args)
 
SgTypeget_expression_type () const
 Access function for p_expression_type, returns pointer to SgType associated with constructor. More...
 
void set_expression_type (SgType *expression_type)
 Access function for p_expression_type. More...
 
bool get_need_name () const
 returns bool value if name is required in code generation then return true. More...
 
void set_need_name (bool need_name)
 This function allows the p_need_name flag to be set (used internally). More...
 
bool get_need_qualifier () const
 
void set_need_qualifier (bool need_qualifier)
 
bool get_need_parenthesis_after_name () const
 
void set_need_parenthesis_after_name (bool need_parenthesis_after_name)
 
bool get_associated_class_unknown () const
 
void set_associated_class_unknown (bool associated_class_unknown)
 
int get_name_qualification_length () const
 
void set_name_qualification_length (int name_qualification_length)
 
bool get_type_elaboration_required () const
 
void set_type_elaboration_required (bool type_elaboration_required)
 
bool get_global_qualification_required () const
 
void set_global_qualification_required (bool global_qualification_required)
 
virtual ~SgConstructorInitializer ()
 This is the destructor. More...
 
 SgConstructorInitializer (Sg_File_Info *startOfConstruct, SgMemberFunctionDeclaration *declaration=NULL, SgExprListExp *args=NULL, SgType *expression_type=NULL, bool need_name=false, bool need_qualifier=false, bool need_parenthesis_after_name=false, bool associated_class_unknown=false)
 
 SgConstructorInitializer (SgMemberFunctionDeclaration *declaration, SgExprListExp *args, SgType *expression_type, bool need_name, bool need_qualifier, bool need_parenthesis_after_name, bool associated_class_unknown)
 
- Public Member Functions inherited from SgInitializer
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...
 
 SgInitializer (const SgInitializerStorageClass &source)
 
SgInitializeraddRegExpAttribute (std::string s, AstRegExAttribute *a)
 Support for AST matching using regular expression. More...
 
bool get_is_explicit_cast () const
 returns bool value if front-end considers this cast as explicit. More...
 
void set_is_explicit_cast (bool is_explicit_cast)
 This function allows the p_is_explicit_cast flag to be set (used internally). More...
 
virtual ~SgInitializer ()
 This is the destructor. More...
 
 SgInitializer (Sg_File_Info *startOfConstruct)
 This is the constructor. More...
 
 SgInitializer ()
 
- Public Member Functions inherited from SgExpression
virtual int precedence () const
 return precedence (scale of 0-10, as I recall) 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 isDefinable () const
 For Fortran. When called from a node of any other language, behavior is undefined (see SageInterface::is_Fortran_language). Returns a bool value which is true if the current expression is "almost definable". "Almost definable" here means as defined by the Fortran standard (2.5.5), with the caveat that allocatable variables are always called an lvalue. The Fortran standard dictates that an allocatable variable which has not been allocated is not definable. In the general case, it cannot be statically determined whether an allocatable variable has been allocated or not. Note: constants in Fortran are not lvalues, while in C and C++ lvalues may be const. More...
 
virtual bool isUsedAsDefinable () const
 For Fortran. When called from a node of any other language, behavior is undefined (see SageInterface::is_Fortran_language). More...
 
virtual bool isLValue () const
 For C and C++. When called from a node of any other language, behavior is undefined (see SageInterface::is_C*_language). Returns a bool value which is true if the current expression is an lvalue, as defined by the C++ standard. More...
 
virtual bool isUsedAsLValue () const
 For C and C++. When called from a node of any other language, behavior is undefined (see SageInterface::is_C*_language). More...
 
virtual bool isChildUsedAsLValue (const SgExpression *child) const
 For C and C++. When called from a node of any other language, behavior is undefined (see SageInterface::is_C*_language). More...
 
virtual Sg_File_Infoget_file_info (void) 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...
 
virtual void fixupCopy (SgNode *copy, SgCopyHelp &help) const
 
SgName get_qualified_name_prefix () const
 This function generates the qualified name prefix to be used with the type referenced by this expression. More...
 
SgName get_qualified_name_prefix_for_referenced_type () const
 This function generates the qualified name prefix to be used with the type referenced by this expression. More...
 
virtual SgExpressionget_originalExpressionTree () const
 
virtual void set_originalExpressionTree (SgExpression *X)
 
bool hasExplicitType ()
 Some expressions store internal SgType pointers explicitly while others compute them from other expressions. This function is true if it has a data member that is a type (pointer, array, etc.). More...
 
void set_explicitly_stored_type (SgType *type)
 Some expressions store internal SgType pointers explicitly, this allows these IR nodes to be reset with new types (used in the snippet support). 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...
 
 SgExpression (const SgExpressionStorageClass &source)
 
SgExpressionaddRegExpAttribute (std::string s, AstRegExAttribute *a)
 Support for AST matching using regular expression. More...
 
bool get_need_paren () const
 returns bool value if front-end considers parenthesis to be required. More...
 
void set_need_paren (bool need_paren)
 This function allows the p_need_paren flag to be set (used internally). More...
 
bool get_lvalue () const
 Returns a bool value if the current expression is assigned to. More...
 
void set_lvalue (bool lvalue)
 This function allows the p_lvalue flag to be set (used internally). More...
 
bool get_global_qualified_name () const
 
void set_global_qualified_name (bool global_qualified_name)
 
Sg_File_Infoget_operatorPosition () const
 
void set_operatorPosition (Sg_File_Info *operatorPosition)
 
virtual ~SgExpression ()
 This is the destructor. More...
 
 SgExpression (Sg_File_Info *startOfConstruct)
 This is the constructor. More...
 
 SgExpression ()
 
- 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...
 
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 SgInitializer
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 SgExpression
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 Attributes

SgMemberFunctionDeclarationp_declaration
 This points to the associated member function declaration (a constructor). More...
 
SgExprListExpp_args
 This points to the argument list of the associated constructor call. More...
 
SgTypep_expression_type
 This points to the associated type for this constructor. More...
 
bool p_need_name
 This bool value controls the output of the class name. More...
 
bool p_need_qualifier
 This bool value controls the output of the class names qualifier. More...
 
bool p_need_parenthesis_after_name
 This bool value controls the output of "()" after the class name. More...
 
bool p_associated_class_unknown
 This bool value indicates when p_declaration should be a valid pointer. More...
 
int p_name_qualification_length
 
bool p_type_elaboration_required
 
bool p_global_qualification_required
 
- Protected Attributes inherited from SgInitializer
bool p_is_explicit_cast
 This boolean variable marks the initializer ans part of an explicit or implicit cast. It is used for all of the different types of initalizers. More...
 
- Protected Attributes inherited from SgExpression
bool p_need_paren
 This boolean value marks the current expression as requiring parenthises. More...
 
bool p_lvalue
 This boolean variable marks the current expression as a left hand side value (lvalue). More...
 
bool p_global_qualified_name
 
Sg_File_Infop_operatorPosition
 
- 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 SgConstructorInitializerStorageClass
 
class AstSpecificDataManagingClass
 
class AstSpecificDataManagingClassStorageClass
 
ROSE_DLL_API friend
SgConstructorInitializer
isSgConstructorInitializer (SgNode *s)
 Casts pointer from base class to derived class. More...
 
ROSE_DLL_API friend const
SgConstructorInitializer
isSgConstructorInitializer (const SgNode *s)
 Casts pointer from base class to derived class (for const pointers) More...
 
SgConstructorInitializerSgConstructorInitializer_getPointerFromGlobalIndex (unsigned long globalIndex)
 Constructor for use by AST File I/O Mechanism. More...
 
unsigned long SgConstructorInitializer_getNumberOfValidNodesAndSetGlobalIndexInFreepointer (unsigned long)
 Get the size of the memory pool. More...
 
void SgConstructorInitializer_clearMemoryPool ()
 
void SgConstructorInitializer_extendMemoryPoolForFileIO (unsigned long)
 
void SgConstructorInitializer_getNextValidPointer (std::pair< SgConstructorInitializer *, std::vector< unsigned char * >::const_iterator > &)
 
void SgConstructorInitializer_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 notion of an initializer for a variable declaration or expression in a function call argument list.

There are no direct uses of this IR node anywhere.  All initializers

are derived from this IR node to build derived classes such as SgConstructorInitializer, SgAssignInitializer, and SgAggregateInitializer.

This is a base class for all initializers.

See Also
Example of using a SgConstructorInitializer object

Definition at line 220240 of file Cxx_Grammar.h.

Member Typedef Documentation

Member Enumeration Documentation

anonymous enum

static variant value

Enumerator
static_variant 

Definition at line 220293 of file Cxx_Grammar.h.

Constructor & Destructor Documentation

SgConstructorInitializer::SgConstructorInitializer ( const SgConstructorInitializerStorageClass source)
SgConstructorInitializer::~SgConstructorInitializer ( )
virtual

This is the destructor.

Only the Sg_File_Info object can be deleted in this object.

SgConstructorInitializer::SgConstructorInitializer ( Sg_File_Info startOfConstruct,
SgMemberFunctionDeclaration declaration = NULL,
SgExprListExp args = NULL,
SgType expression_type = NULL,
bool  need_name = false,
bool  need_qualifier = false,
bool  need_parenthesis_after_name = false,
bool  associated_class_unknown = false 
)
SgConstructorInitializer::SgConstructorInitializer ( SgMemberFunctionDeclaration declaration,
SgExprListExp args,
SgType expression_type,
bool  need_name,
bool  need_qualifier,
bool  need_parenthesis_after_name,
bool  associated_class_unknown 
)

Member Function Documentation

virtual SgNode* SgConstructorInitializer::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 SgInitializer.

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

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

Reimplemented from SgExpression.

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

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

Reimplemented from SgExpression.

virtual unsigned int SgConstructorInitializer::cfgIndexForEnd ( ) const
virtual

Determine the CFG index for the end of this construct.

Reimplemented from SgInitializer.

SgClassDeclaration* SgConstructorInitializer::get_class_decl ( ) const

Get the SgClassDeclaration associated with this constructor call.

Note that in rare cases where the constructor is associated with a primative type this function will return a NULL pointer. In which case p_expression_type is a pointer to a SgType which is not a SgClassType, but is a valid pointer to a primative type.

if p_declaration is NULL then p_associated_class_unknown is true.

virtual std::string SgConstructorInitializer::class_name ( ) const
virtual

Copies AST (whole subtree, depending on the SgCopyHelp class.

returns a string representing the class name

Reimplemented from SgInitializer.

virtual VariantT SgConstructorInitializer::variantT ( ) const
virtual

returns new style SageIII enum values

Reimplemented from SgInitializer.

void* SgConstructorInitializer::operator new ( size_t  size)

returns pointer to newly allocated IR node

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

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

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

Returns the total number of IR nodes of this type.

static size_t SgConstructorInitializer::memoryUsage ( )
static

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

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

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

virtual size_t SgConstructorInitializer::get_numberOfTraversalSuccessors ( )
virtual

Reimplemented from SgInitializer.

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

Reimplemented from SgInitializer.

virtual size_t SgConstructorInitializer::get_childIndex ( SgNode child)
virtual

Reimplemented from SgInitializer.

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

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

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

Reimplemented from SgInitializer.

void SgConstructorInitializer::executeVisitorMemberFunction ( ROSE_VisitorPattern visitor)

FOR INTERNAL USE Support for visitor pattern.

virtual void SgConstructorInitializer::accept ( ROSE_VisitorPattern visitor)
virtual

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

Reimplemented from SgInitializer.

static void SgConstructorInitializer::traverseMemoryPoolNodes ( ROSE_VisitTraversal visit)
static

FOR INTERNAL USE Support for visitor pattern.

static void SgConstructorInitializer::traverseMemoryPoolVisitorPattern ( ROSE_VisitorPattern visitor)
static

FOR INTERNAL USE Support for visitor pattern.

static void SgConstructorInitializer::visitRepresentativeNode ( ROSE_VisitTraversal visit)
static

FOR INTERNAL USE Support for type-based traversal.

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

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

virtual std::vector<std::pair<SgNode*,std::string> > SgConstructorInitializer::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 SgInitializer.

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

virtual long SgConstructorInitializer::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 SgInitializer.

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

SgType* SgConstructorInitializer::get_type ( ) const
virtual

unparsing support for pragmas

Get the type associated with this expression.

get the type associated with this expression

This function is the correct user function to call to get the type (note that get_expression_type() is for internal use only).

Returns
Returns pointer to SgType (base class for all possible types)

Reimplemented from SgExpression.

void SgConstructorInitializer::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 SgInitializer.

SgExpression* SgConstructorInitializer::get_next ( int &  n) const
int SgConstructorInitializer::replace_expression ( SgExpression oldChild,
SgExpression newChild 
)
virtual

This class represents the base class of all the expressions within this grammar.

It contains all the base functionality for the construction, manipulation, and unparsing support.Function to get user defined attributes (as I recall) Replace an expression child of this node with another one.

Reimplemented from SgExpression.

SgMemberFunctionDeclaration* SgConstructorInitializer::get_declaration ( ) const
void SgConstructorInitializer::set_declaration ( SgMemberFunctionDeclaration declaration)
SgExprListExp* SgConstructorInitializer::get_args ( ) const
void SgConstructorInitializer::set_args ( SgExprListExp args)
SgConstructorInitializer::get_expression_type ( ) const

Access function for p_expression_type, returns pointer to SgType associated with constructor.

This is usually a SgClassType, but it can also be a primative type (typically in association with a new operator).

Returns
Returns pointer to SgType.
SgConstructorInitializer::set_expression_type ( SgType type)

Access function for p_expression_type.

Parameters
required- sets value of internal p_expression_type.
Returns
Returns void.
SgConstructorInitializer::get_need_name ( ) const

returns bool value if name is required in code generation then return true.

Returns
Returns bool value.
SgConstructorInitializer::set_need_name ( bool  required)

This function allows the p_need_name flag to be set (used internally).

Parameters
required- sets value of internal p_need_name flag.
Returns
Returns void.
bool SgConstructorInitializer::get_need_qualifier ( ) const
void SgConstructorInitializer::set_need_qualifier ( bool  need_qualifier)
bool SgConstructorInitializer::get_need_parenthesis_after_name ( ) const
void SgConstructorInitializer::set_need_parenthesis_after_name ( bool  need_parenthesis_after_name)
bool SgConstructorInitializer::get_associated_class_unknown ( ) const
void SgConstructorInitializer::set_associated_class_unknown ( bool  associated_class_unknown)
int SgConstructorInitializer::get_name_qualification_length ( ) const
virtual

Reimplemented from SgExpression.

void SgConstructorInitializer::set_name_qualification_length ( int  name_qualification_length)
virtual

Reimplemented from SgExpression.

bool SgConstructorInitializer::get_type_elaboration_required ( ) const
virtual

Reimplemented from SgExpression.

void SgConstructorInitializer::set_type_elaboration_required ( bool  type_elaboration_required)
virtual

Reimplemented from SgExpression.

bool SgConstructorInitializer::get_global_qualification_required ( ) const
virtual

Reimplemented from SgExpression.

void SgConstructorInitializer::set_global_qualification_required ( bool  global_qualification_required)
virtual

Reimplemented from SgExpression.

Friends And Related Function Documentation

friend class AST_FILE_IO
friend

Definition at line 220564 of file Cxx_Grammar.h.

friend class SgConstructorInitializerStorageClass
friend

Definition at line 220565 of file Cxx_Grammar.h.

friend class AstSpecificDataManagingClass
friend

Definition at line 220566 of file Cxx_Grammar.h.

friend class AstSpecificDataManagingClassStorageClass
friend

Definition at line 220567 of file Cxx_Grammar.h.

SgConstructorInitializer::isSgConstructorInitializer ( SgNode s)
friend

Casts pointer from base class to derived class.

Cast function (from derived class to SgConstructorInitializer pointer).

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

Returns
Returns valid pointer to SgConstructorInitializer if input is derived from a SgConstructorInitializer.
SgConstructorInitializer::isSgConstructorInitializer ( const SgNode s)
friend

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

Cast function (from derived class to SgConstructorInitializer pointer).

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

Returns
Returns valid pointer to SgConstructorInitializer if input is derived from a SgConstructorInitializer.
SgConstructorInitializer* SgConstructorInitializer_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 SgConstructorInitializer_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 SgConstructorInitializer_clearMemoryPool ( )
friend
void SgConstructorInitializer_extendMemoryPoolForFileIO ( unsigned  long)
friend
void SgConstructorInitializer_getNextValidPointer ( std::pair< SgConstructorInitializer *, std::vector< unsigned char * >::const_iterator > &  )
friend
void SgConstructorInitializer_resetValidFreepointers ( )
friend

Member Data Documentation

SgConstructorInitializer::p_declaration
protected

This points to the associated member function declaration (a constructor).

Note that this pointer can be NULL if no such constructor is defined (e.g. compiler generated default constructor).

Constructors not explicit in the source code are not presently generated in ROSE if there were to be generated in the future they will be marked as compiler generated and likely we can then enforce that this be a valid pointer. This variable is an exception to the general rule that we have no NULL pointes within the AST.

Definition at line 220683 of file Cxx_Grammar.h.

SgConstructorInitializer::p_args
protected

This points to the argument list of the associated constructor call.

Note that this pointer is always a valid pointer, even if the constructor and class declaration pointers are NULL. This list can also be empty, but the poitner to the list is always valid.

Definition at line 220687 of file Cxx_Grammar.h.

SgConstructorInitializer::p_expression_type
protected

This points to the associated type for this constructor.

This pointer should always be valid, "p_associated_class_unknown" is true iff "p_expression_type" is not a SgClassType.

Definition at line 220691 of file Cxx_Grammar.h.

SgConstructorInitializer::p_need_name
protected

This bool value controls the output of the class name.

This might be somewhat redundant with the explicit vs. implement representation in the source code (recorded in another flag of the SgExpression base class).

Definition at line 220695 of file Cxx_Grammar.h.

SgConstructorInitializer::p_need_qualifier
protected

This bool value controls the output of the class names qualifier.

The qualifier is currently always output. This variable is not used.

Definition at line 220699 of file Cxx_Grammar.h.

SgConstructorInitializer::p_need_parenthesis_after_name
protected

This bool value controls the output of "()" after the class name.

The controls the output at "class X x;" or "class X x();".

Definition at line 220703 of file Cxx_Grammar.h.

SgConstructorInitializer::p_associated_class_unknown
protected

This bool value indicates when p_declaration should be a valid pointer.

If true, then p_declaration is NULL, else if false, then p_declaration should 

be a valid pointer.

Todo:
Enforce p_declaration is valid pointer when p_associated_class_unknown is false within AST consistency tests.

Definition at line 220707 of file Cxx_Grammar.h.

int SgConstructorInitializer::p_name_qualification_length
protected

Definition at line 220711 of file Cxx_Grammar.h.

bool SgConstructorInitializer::p_type_elaboration_required
protected

Definition at line 220715 of file Cxx_Grammar.h.

bool SgConstructorInitializer::p_global_qualification_required
protected

Definition at line 220719 of file Cxx_Grammar.h.


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