ROSE  0.9.10.69
Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes | Friends | List of all members
SgExpression Class Reference

Description

This class represents the notion of an expression. Expressions are derived from SgLocatedNodes, since similar to statement, expressions have a concrete location within the user's source code.

There are no direct uses of this IR node anywhere. All expressions are derived from this IR node to build derived classes such as unary and binary operators, conditional expressions, delete expression, variable reference expressions, etc.

Note
The SgExpression class has a virtual get_type() member function which returns the type associated with any expression. The get_type() support has the following properties:
get_type() vs. get_expression_type(). Note that there is of some IR nodes a get_expression_type() which is always a data access function to a stored type. The get_expression_type() function is for internal use only. Where used, this function can return NULL if the explicitly stored p_expression_type variable is not needed (this is to support it later being removed). Although the type should be computed most of the time, there are some IR nodes where it must be stored explicitly (detailed above; for example where the SgTypeDefault is used and for SgCastExp, etc.). The function get_expression_type() is not a part of the user interface and users should call get_type() instead.

Definition at line 235032 of file Cxx_Grammar.h.

Inheritance diagram for SgExpression:
Inheritance graph
[legend]
Collaboration diagram for SgExpression:
Collaboration graph
[legend]

Public Types

enum  { static_variant = V_SgExpression }
 static variant value
 
typedef SgLocatedNode base_node_type
 
- Public Types inherited from SgLocatedNode
enum  { static_variant = V_SgLocatedNode }
 static variant value
 
typedef SgNode base_node_type
 
- Public Types inherited from SgNode
enum  { static_variant = V_SgNode }
 static variant value
 

Public Member Functions

virtual SgNodecopy (SgCopyHelp &help) const ROSE_OVERRIDE
 This function clones the current IR node object recursively or not, depending on the argument. More...
 
virtual int replace_expression (SgExpression *oldChild, SgExpression *newChild)
 This class represents the base class of all the expressions within this grammar. More...
 
virtual SgTypeget_type () const
 unparsing support for pragmas More...
 
virtual int precedence () const
 return precedence (scale of 0-10, as I recall)
 
virtual unsigned int cfgIndexForEnd () const ROSE_OVERRIDE
 Determine the CFG index for the end of this construct.
 
virtual bool cfgIsIndexInteresting (unsigned int index) const ROSE_OVERRIDE
 Determine whether a particular CFG node index is "interesting" for this kind of node.
 
virtual unsigned int cfgFindChildIndex (SgNode *n) ROSE_OVERRIDE
 Find the index of n in this node's CFG children.
 
virtual unsigned int cfgFindNextChildIndex (SgNode *n) ROSE_OVERRIDE
 Find the index just after n in this node's CFG children.
 
virtual std::vector< VirtualCFG::CFGEdgecfgOutEdges (unsigned int index) ROSE_OVERRIDE
 Find the out edges of a CFG node – internal version.
 
virtual std::vector< VirtualCFG::CFGEdgecfgInEdges (unsigned int index) ROSE_OVERRIDE
 Find the in edges of a CFG node – internal version.
 
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 ROSE_OVERRIDE
 Interface function to implement original SAGE interface to SgFile_Info objects. More...
 
virtual void set_file_info (Sg_File_Info *X) ROSE_OVERRIDE
 Access function calls set_startingConstruct(Sg_File_Info*) member function.
 
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.
 
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.
 
virtual int get_name_qualification_length () const
 
virtual void set_name_qualification_length (int name_qualification_length)
 
virtual bool get_type_elaboration_required () const
 
virtual void set_type_elaboration_required (bool type_elaboration_required)
 
virtual bool get_global_qualification_required () const
 
virtual void set_global_qualification_required (bool global_qualification_required)
 
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).
 
void post_construction_initialization () ROSE_OVERRIDE
 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.
 
virtual std::string class_name () const ROSE_OVERRIDE
 returns a string representing the class name
 
virtual VariantT variantT () const ROSE_OVERRIDE
 returns new style SageIII enum values
 
void * operator new (size_t size)
 returns pointer to newly allocated IR node
 
void operator delete (void *pointer, size_t size)
 deallocated memory for IR node (returns memory to memory pool for reuse)
 
virtual std::vector< SgNode * > get_traversalSuccessorContainer () ROSE_OVERRIDE
 container of pointers to AST successor nodes used in the traversal overridden in every class by generated implementation
 
virtual std::vector< std::string > get_traversalSuccessorNamesContainer () ROSE_OVERRIDE
 container of names of variables or container indices used used in the traversal to access AST successor nodes overridden in every class by generated implementation
 
virtual size_t get_numberOfTraversalSuccessors () ROSE_OVERRIDE
 return number of children in the traversal successor list
 
virtual SgNodeget_traversalSuccessorByIndex (size_t idx) ROSE_OVERRIDE
 index-based access to traversal successors by index number
 
virtual size_t get_childIndex (SgNode *child) ROSE_OVERRIDE
 index-based access to traversal successors by child node
 
virtual RTIReturnType roseRTI () ROSE_OVERRIDE
 return C++ Runtime-Time-Information
 
virtual const char * sage_class_name () const ROSE_OVERRIDE ROSE_DEPRECATED_FUNCTION
 
void executeVisitorMemberFunction (ROSE_VisitorPattern &visitor)
 FOR INTERNAL USE Support for visitor pattern.
 
virtual void accept (ROSE_VisitorPattern &visitor) ROSE_OVERRIDE
 support for the classic visitor pattern done in GoF
 
virtual bool isInMemoryPool () ROSE_OVERRIDE
 FOR INTERNAL USE This is used in internal tests to verify that all IR nodes are allocated from the heap. More...
 
virtual void checkDataMemberPointersIfInMemoryPool () ROSE_OVERRIDE
 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 ROSE_OVERRIDE
 FOR INTERNAL USE Returns STL vector of pairs of SgNode* and strings for use in AST tools More...
 
virtual void processDataMemberReferenceToPointers (ReferenceToPointerHandler *) ROSE_OVERRIDE
 FOR INTERNAL USE Processes pairs of references to SgNode* and strings for use in AST tools More...
 
virtual long getChildIndex (SgNode *childNode) const ROSE_OVERRIDE
 FOR INTERNAL USE Returns a unique index value for the childNode in the list of children at this IR node. More...
 
 SgExpression (const SgExpressionStorageClass &source)
 IR node constructor to support AST File I/O.
 
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...
 
- 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 insertToAttachedPreprocessingInfo (PreprocessingInfo *prepInfoPtr, PreprocessingInfo *anchorInfoPtr, bool insertAfter=true)
 Insert prepInfo After (or before if last parameter is false) an anchor info ptr in the list of preprocessing info attached to the current node. This is useful to insert things in the middle.
 
void setCompilerGenerated ()
 Allow IR nodes (mostly SgLocatedNode) to be marked as compiler generated. More...
 
void unsetCompilerGenerated ()
 
bool isCompilerGenerated () const
 Simple test for if this is a compiler generated node. More...
 
void setTransformation ()
 Allow IR nodes (mostly SgLocatedNode) to be marked as a transformation. More...
 
void unsetTransformation ()
 
bool isTransformation () const
 Simple test for if this is a part of a transformation. More...
 
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) ROSE_OVERRIDE
 Add a new attribute represented by the named string.
 
virtual AstAttribute * getAttribute (std::string s) const ROSE_OVERRIDE
 Returns attribute of name 's'.
 
virtual void updateAttribute (std::string s, AstAttribute *a) ROSE_OVERRIDE
 Replace existing attribute of name 's' with new AstAttribute.
 
virtual void setAttribute (std::string s, AstAttribute *a) ROSE_OVERRIDE
 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.
 
virtual void removeAttribute (std::string s) ROSE_OVERRIDE
 Remove attribute of name 's' if present.
 
virtual bool attributeExists (std::string s) const ROSE_OVERRIDE
 Tests if attribute of name 's' is present.
 
virtual int numberOfAttributes () const ROSE_OVERRIDE
 Returns the number of attributes on this IR node.
 
void * operator new (size_t size)
 returns pointer to newly allocated IR node
 
void operator delete (void *pointer, size_t size)
 deallocated memory for IR node (returns memory to memory pool for reuse)
 
void executeVisitorMemberFunction (ROSE_VisitorPattern &visitor)
 FOR INTERNAL USE Support for visitor pattern.
 
 SgLocatedNode (const SgLocatedNodeStorageClass &source)
 IR node constructor to support AST File I/O.
 
SgLocatedNodeaddRegExpAttribute (std::string s, AstRegExAttribute *a)
 Support for AST matching using regular expression. More...
 
Sg_File_Infoget_startOfConstruct () const ROSE_OVERRIDE
 New function interface for Sg_File_Info data stores starting location of contruct (typically the opening brace or first letter of keyword).
 
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 ROSE_OVERRIDE
 New function interface for Sg_File_Info data stores ending location of contruct (typically the closing brace).
 
void set_endOfConstruct (Sg_File_Info *endOfConstruct)
 This function sets the current source location position of the end of the current construct. More...
 
AttachedPreprocessingInfoType * get_attachedPreprocessingInfoPtr () const
 
void set_attachedPreprocessingInfoPtr (AttachedPreprocessingInfoType *attachedPreprocessingInfoPtr)
 
AstAttributeMechanism * get_attributeMechanism () const ROSE_OVERRIDE
 FOR INTERNAL USE Access function; if an attribute exists then a pointer to it is returned, else error. More...
 
void set_attributeMechanism (AstAttributeMechanism *attributeMechanism) ROSE_OVERRIDE
 FOR INTERNAL USE Access function; sets poiner to value AstAttributeMechanism. More...
 
bool get_containsTransformationToSurroundingWhitespace () const
 
void set_containsTransformationToSurroundingWhitespace (bool containsTransformationToSurroundingWhitespace)
 
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
 
void operator delete (void *pointer, size_t size)
 deallocated memory for IR node (returns memory to memory pool for reuse)
 
void executeVisitorMemberFunction (ROSE_VisitorPattern &visitor)
 FOR INTERNAL USE Support for visitor pattern.
 
 SgNode (const SgNodeStorageClass &source)
 IR node constructor to support AST File I/O.
 
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...
 
void set_containsTransformation (bool containsTransformation)
 Many nodes can hide other AST nodes and we need to track when outer nodes contain modified nodes even if they are not themselves modified. More...
 
bool get_isModified () const
 Acess function for isModified flag. More...
 
bool get_containsTransformation () const
 Acess function for containsTransformation flag. 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.
 
virtual std::string unparseToString (SgUnparse_Info *info) const
 This function unparses the AST node (excluding comments and unnecessary white space)
 
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.
 
VirtualCFG::CFGNode cfgForEnd ()
 Returns the CFG node for just after this AST node.
 
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 ()
 ROSETTA generated delete operator: deletes all non-traversed members. More...
 
static size_t memoryUsage ()
 Returns the size in bytes of the total memory allocated for all IR nodes of this type.
 
static void traverseMemoryPoolNodes (ROSE_VisitTraversal &visit)
 FOR INTERNAL USE Support for visitor pattern over all IR nodes by type of IR node.
 
static void traverseMemoryPoolVisitorPattern (ROSE_VisitorPattern &visitor)
 FOR INTERNAL USE Support for visitor pattern.
 
static void visitRepresentativeNode (ROSE_VisitTraversal &visit)
 FOR INTERNAL USE Support for type-based traversal.
 
static SgExpressionbuild_node_from_nonlist_children (Sg_File_Info *startOfConstruct=NULL)
 
- Static Public Member Functions inherited from SgLocatedNode
static size_t numberOfNodes ()
 ROSETTA generated delete operator: deletes all non-traversed members. More...
 
static size_t memoryUsage ()
 Returns the size in bytes of the total memory allocated for all IR nodes of this type.
 
static void traverseMemoryPoolNodes (ROSE_VisitTraversal &visit)
 FOR INTERNAL USE Support for visitor pattern over all IR nodes by type of IR node.
 
static void traverseMemoryPoolVisitorPattern (ROSE_VisitorPattern &visitor)
 FOR INTERNAL USE Support for visitor pattern.
 
static void visitRepresentativeNode (ROSE_VisitTraversal &visit)
 FOR INTERNAL USE Support for type-based traversal.
 
static SgLocatedNodebuild_node_from_nonlist_children (Sg_File_Info *startOfConstruct=NULL)
 
- Static Public Member Functions inherited from SgNode
static size_t numberOfNodes ()
 ROSETTA generated delete operator: deletes all non-traversed members. More...
 
static size_t memoryUsage ()
 Returns the size in bytes of the total memory allocated for all IR nodes of this type.
 
static void traverseMemoryPoolNodes (ROSE_VisitTraversal &visit)
 FOR INTERNAL USE Support for visitor pattern over all IR nodes by type of IR node.
 
static void traverseMemoryPoolVisitorPattern (ROSE_VisitorPattern &visitor)
 FOR INTERNAL USE Support for visitor pattern.
 
static void visitRepresentativeNode (ROSE_VisitTraversal &visit)
 FOR INTERNAL USE Support for type-based traversal.
 
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< VariantT > getClassHierarchySubTreeFunction (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.
 
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_globalQualifiedNameMapForTemplateHeaders ()
 Access function for name qualification support (for template headers in template declarations). More...
 
static void set_globalQualifiedNameMapForTemplateHeaders (const std::map< SgNode *, std::string > &X)
 Access function for name qualification support (for template headers in template declarations). 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.
 
static void set_globalFunctionTypeTable (SgFunctionTypeTable *globalFunctionTypeTable)
 Access function for symbol table specific to function types.
 
static SgTypeTableget_globalTypeTable ()
 Access function for symbol table specific to non-function types.
 
static void set_globalTypeTable (SgTypeTable *globalTypeTable)
 Access function for symbol table specific to non-function types.
 
static SgNodebuild_node_from_nonlist_children ()
 

Protected Attributes

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.
 
Sg_File_Infop_endOfConstruct
 This pointer is always valid and stores the source position of the end of the current construct.
 
AttachedPreprocessingInfoType * p_attachedPreprocessingInfoPtr
 Holds comments and/or preprocessor directives located before or after the current statement of expression.
 
AstAttributeMechanism * p_attributeMechanism
 
bool p_containsTransformationToSurroundingWhitespace
 
- 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...
 
bool p_containsTransformation
 
SgNodep_freepointer
 This is the pointer to the chain of previously freed objects.
 

Friends

ROSE_DLL_API friend SgExpressionisSgExpression (SgNode *s)
 Casts pointer from base class to derived class. More...
 
ROSE_DLL_API friend const SgExpressionisSgExpression (const SgNode *s)
 Casts pointer from base class to derived class (for const pointers) More...
 
SgExpressionSgExpression_getPointerFromGlobalIndex (unsigned long globalIndex)
 Methods to find the pointer to a global and local index.
 
unsigned long SgExpression_getNumberOfValidNodesAndSetGlobalIndexInFreepointer (unsigned long)
 Get the size of the memory pool. More...
 
void SgExpression_clearMemoryPool ()
 clear the memory pool
 
void SgExpression_extendMemoryPoolForFileIO (unsigned long)
 internal support for AST file I/O (operating on the memory pools)
 
void SgExpression_getNextValidPointer (std::pair< SgExpression *, std::vector< unsigned char * >::const_iterator > &)
 internal support for AST file I/O (operating on the memory pools)
 
void SgExpression_resetValidFreepointers ()
 internal support for AST file I/O (operating on the memory pools)
 

Additional Inherited Members

- Static Protected Attributes inherited from SgNode
static SgFunctionTypeTablep_globalFunctionTypeTable
 Pointer to symbol table specific to function types.
 
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.
 
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.
 
static std::map< SgNode *, std::string > p_globalQualifiedNameMapForNames
 
static std::map< SgNode *, std::string > p_globalQualifiedNameMapForTypes
 
static std::map< SgNode *, std::string > p_globalQualifiedNameMapForTemplateHeaders
 
static std::map< SgNode *, std::string > p_globalTypeNameMap
 

Constructor & Destructor Documentation

SgExpression::~SgExpression ( )
virtual

This is the destructor.

Only the Sg_File_Info object can be deleted in this object.

SgExpression::SgExpression ( Sg_File_Info startOfConstruct = NULL)

This is the constructor.

This constructor builds the SgExpression base class.

Parameters
startOfConstructrepresents the position in the source code
See also
Example:create an SgExpression object

Member Function Documentation

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

Reimplemented from SgLocatedNode.

Reimplemented in SgNoexceptOp, SgFinishExp, SgAtExp, SgHereExp, SgLambdaExp, SgFunctionParameterRefExp, SgClassExp, SgTypeExpression, SgJavaTypeExpression, SgJavaNormalAnnotation, SgJavaSingleMemberAnnotation, SgJavaMarkerAnnotation, SgJavaAnnotation, SgCompoundLiteralExp, SgTypeTraitBuiltinOperator, SgMagicColonExp, SgRangeExp, SgAlignOfOp, SgTemplateMemberFunctionRefExp, SgTemplateFunctionRefExp, SgYieldExpression, SgStringConversion, SgNaryComparisonOp, SgNaryBooleanOp, SgNaryOp, SgDictionaryComprehension, SgSetComprehension, SgListComprehension, SgComprehension, SgKeyDatumPair, SgDictionaryExp, SgLambdaRefExp, SgCudaKernelExecConfig, SgCAFCoExpression, SgPseudoDestructorRefExp, SgUnknownArrayOrFunctionReference, SgActualArgumentExpression, SgLabelRefExp, SgAsmOp, SgStatementExpression, SgIOItemExpression, SgImpliedDo, SgAsteriskShapeExp, SgColonShapeExp, SgSubscriptExpression, SgVariantExpression, SgNullExpression, SgVarArgStartOneOperandOp, SgVarArgCopyOp, SgVarArgEndOp, SgVarArgOp, SgVarArgStartOp, SgBracedInitializer, SgDesignatedInitializer, SgAssignInitializer, SgConstructorInitializer, SgCompoundInitializer, SgAggregateInitializer, SgInitializer, SgRefExp, SgThisExp, SgDeleteExp, SgNewExp, SgConditionalExp, SgTypeIdOp, SgSuperExp, SgJavaInstanceOfOp, SgUpcElemsizeofExpression, SgUpcBlocksizeofExpression, SgUpcLocalsizeofExpression, SgSizeOfOp, SgCudaKernelCallExp, SgFunctionCallExp, SgCallExpression, SgChar32Val, SgChar16Val, SgNullptrValExp, SgTemplateParameterVal, SgUpcMythread, SgUpcThreads, SgComplexVal, SgLongDoubleVal, SgDoubleVal, SgFloatVal, SgUnsignedLongVal, SgUnsignedLongLongIntVal, SgLongLongIntVal, SgLongIntVal, SgUnsignedIntVal, SgEnumVal, SgIntVal, SgUnsignedShortVal, SgWcharVal, SgUnsignedCharVal, SgCharVal, SgShortVal, SgStringVal, SgBoolValExp, SgValueExp, SgMemberFunctionRefExp, SgFunctionRefExp, SgClassNameRefExp, SgVarRefExp, SgMatrixExp, SgTupleExp, SgListExp, SgExprListExp, SgLeftDivideOp, SgPowerOp, SgElementwiseSubtractOp, SgElementwiseAddOp, SgElementwiseDivideOp, SgElementwiseLeftDivideOp, SgElementwisePowerOp, SgElementwiseMultiplyOp, SgElementwiseOp, SgDotDotExp, SgIsNotOp, SgIsOp, SgNonMembershipOp, SgMembershipOp, SgExponentiationAssignOp, SgIntegerDivideAssignOp, SgJavaUnsignedRshiftAssignOp, SgRshiftAssignOp, SgLshiftAssignOp, SgXorAssignOp, SgModAssignOp, SgDivAssignOp, SgMultAssignOp, SgIorAssignOp, SgAndAssignOp, SgMinusAssignOp, SgPlusAssignOp, SgCompoundAssignOp, SgUserDefinedBinaryOp, SgPointerAssignOp, SgConcatenationOp, SgJavaUnsignedRshiftOp, SgExponentiationOp, SgAssignOp, SgScopeOp, SgPntrArrRefExp, SgRshiftOp, SgLshiftOp, SgCommaOpExp, SgBitOrOp, SgBitAndOp, SgBitXorOp, SgOrOp, SgAndOp, SgModOp, SgIntegerDivideOp, SgDivideOp, SgMultiplyOp, SgSubtractOp, SgAddOp, SgGreaterOrEqualOp, SgLessOrEqualOp, SgNotEqualOp, SgGreaterThanOp, SgLessThanOp, SgEqualityOp, SgArrowStarOp, SgDotStarOp, SgDotExp, SgArrowExp, SgBinaryOp, SgMatrixTransposeOp, SgUserDefinedUnaryOp, SgConjugateOp, SgImagPartOp, SgRealPartOp, SgThrowOp, SgCastExp, SgBitComplementOp, SgPlusPlusOp, SgMinusMinusOp, SgAddressOfOp, SgPointerDerefExp, SgNotOp, SgUnaryAddOp, SgMinusOp, SgExpressionRoot, and SgUnaryOp.

virtual int SgExpression::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 in SgAlignOfOp, SgNaryOp, SgVarArgEndOp, SgVarArgOp, SgBracedInitializer, SgDesignatedInitializer, SgAssignInitializer, SgConstructorInitializer, SgCompoundInitializer, SgAggregateInitializer, SgDeleteExp, SgNewExp, SgConditionalExp, SgSizeOfOp, SgCallExpression, SgExprListExp, SgBinaryOp, and SgUnaryOp.

SgExpression::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 in SgNoexceptOp, SgFinishExp, SgAtExp, SgHereExp, SgLambdaExp, SgFunctionParameterRefExp, SgClassExp, SgTypeExpression, SgJavaTypeExpression, SgJavaAnnotation, SgCompoundLiteralExp, SgTypeTraitBuiltinOperator, SgMagicColonExp, SgRangeExp, SgAlignOfOp, SgTemplateMemberFunctionRefExp, SgTemplateFunctionRefExp, SgYieldExpression, SgStringConversion, SgNaryComparisonOp, SgNaryBooleanOp, SgDictionaryComprehension, SgSetComprehension, SgListComprehension, SgComprehension, SgKeyDatumPair, SgDictionaryExp, SgLambdaRefExp, SgCudaKernelExecConfig, SgCAFCoExpression, SgPseudoDestructorRefExp, SgUnknownArrayOrFunctionReference, SgActualArgumentExpression, SgLabelRefExp, SgAsmOp, SgStatementExpression, SgIOItemExpression, SgImpliedDo, SgAsteriskShapeExp, SgColonShapeExp, SgSubscriptExpression, SgVariantExpression, SgNullExpression, SgVarArgStartOneOperandOp, SgVarArgCopyOp, SgVarArgEndOp, SgVarArgOp, SgVarArgStartOp, SgBracedInitializer, SgDesignatedInitializer, SgAssignInitializer, SgConstructorInitializer, SgCompoundInitializer, SgAggregateInitializer, SgThisExp, SgDeleteExp, SgNewExp, SgConditionalExp, SgTypeIdOp, SgSuperExp, SgJavaInstanceOfOp, SgUpcElemsizeofExpression, SgUpcBlocksizeofExpression, SgUpcLocalsizeofExpression, SgSizeOfOp, SgCudaKernelCallExp, SgFunctionCallExp, SgCallExpression, SgChar32Val, SgChar16Val, SgNullptrValExp, SgTemplateParameterVal, SgUpcMythread, SgUpcThreads, SgComplexVal, SgLongDoubleVal, SgDoubleVal, SgFloatVal, SgUnsignedLongVal, SgUnsignedLongLongIntVal, SgLongLongIntVal, SgLongIntVal, SgUnsignedIntVal, SgEnumVal, SgIntVal, SgUnsignedShortVal, SgWcharVal, SgUnsignedCharVal, SgCharVal, SgShortVal, SgStringVal, SgBoolValExp, SgMemberFunctionRefExp, SgFunctionRefExp, SgVarRefExp, SgMatrixExp, SgTupleExp, SgListExp, SgExprListExp, SgDotDotExp, SgIsNotOp, SgIsOp, SgNonMembershipOp, SgMembershipOp, SgUserDefinedBinaryOp, SgPntrArrRefExp, SgCommaOpExp, SgOrOp, SgAndOp, SgGreaterOrEqualOp, SgLessOrEqualOp, SgNotEqualOp, SgGreaterThanOp, SgLessThanOp, SgEqualityOp, SgArrowStarOp, SgDotStarOp, SgDotExp, SgArrowExp, SgBinaryOp, SgUserDefinedUnaryOp, SgThrowOp, SgCastExp, SgAddressOfOp, SgPointerDerefExp, SgNotOp, and SgUnaryOp.

SgExpression::isDefinable ( void  ) const
virtual

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.

Returns
Returns true if the current expression is almost definable.

Reimplemented in SgCompoundLiteralExp, SgVarRefExp, and SgPointerAssignOp.

SgExpression::isUsedAsDefinable ( void  ) const
virtual

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 used as a definable value. That is, it is definable (assigned to).

Returns
Returns true if the current expression is used as a definable value.
SgExpression::isLValue ( void  ) const
virtual

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.

Returns
Returns true if the current expression is an lvalue.

Reimplemented in SgCompoundLiteralExp, SgAssignInitializer, SgConditionalExp, SgTypeIdOp, SgFunctionCallExp, SgStringVal, SgMemberFunctionRefExp, SgVarRefExp, SgCompoundAssignOp, SgAssignOp, SgScopeOp, SgPntrArrRefExp, SgCommaOpExp, SgArrowStarOp, SgDotStarOp, SgDotExp, SgArrowExp, SgCastExp, SgPlusPlusOp, SgMinusMinusOp, SgAddressOfOp, and SgPointerDerefExp.

SgExpression::isUsedAsLValue ( void  ) const
virtual

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 used as an lvalue. That is, it is an lvalue and does not get converted to an rvalue by its parent expression.

Returns
Returns true if the current expression is used as an lvalue.
SgExpression::isChildUsedAsLValue ( const SgExpression child) const
virtual

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 specified expression is used as an lvalue. That is, it is an lvalue and does not get converted to an rvalue by its parent expression.

Reimplemented in SgCompoundLiteralExp, SgAssignInitializer, SgConditionalExp, SgTypeIdOp, SgFunctionCallExp, SgStringVal, SgMemberFunctionRefExp, SgVarRefExp, SgExprListExp, SgCompoundAssignOp, SgAssignOp, SgScopeOp, SgPntrArrRefExp, SgCommaOpExp, SgArrowStarOp, SgDotStarOp, SgDotExp, SgArrowExp, SgCastExp, SgPlusPlusOp, SgMinusMinusOp, SgAddressOfOp, and SgPointerDerefExp.

virtual Sg_File_Info* SgExpression::get_file_info ( void  ) const
virtual

Interface function to implement original SAGE interface to SgFile_Info objects.

This function is added explicitly to provide the older interface to the file_info pointer which has been removed and replaced with two Sg_File_Info pointers to mark the start and end of the located node object (previously we only stored the starting location). This function still returns the starting location of the construct.

Reimplemented from SgLocatedNode.

bool SgExpression::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.).

Result is true if it stores a type explicitly as a data member, else false.

static size_t SgExpression::numberOfNodes ( )
static

ROSETTA generated delete operator: deletes all non-traversed members.

Returns the total number of IR nodes of this type

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

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

Reimplemented from SgLocatedNode.

Reimplemented in SgNoexceptOp, SgFinishExp, SgAtExp, SgHereExp, SgLambdaExp, SgFunctionParameterRefExp, SgClassExp, SgTypeExpression, SgJavaTypeExpression, SgJavaNormalAnnotation, SgJavaSingleMemberAnnotation, SgJavaMarkerAnnotation, SgJavaAnnotation, SgCompoundLiteralExp, SgTypeTraitBuiltinOperator, SgMagicColonExp, SgRangeExp, SgAlignOfOp, SgTemplateMemberFunctionRefExp, SgTemplateFunctionRefExp, SgYieldExpression, SgStringConversion, SgNaryComparisonOp, SgNaryBooleanOp, SgNaryOp, SgDictionaryComprehension, SgSetComprehension, SgListComprehension, SgComprehension, SgKeyDatumPair, SgDictionaryExp, SgLambdaRefExp, SgCudaKernelExecConfig, SgCAFCoExpression, SgPseudoDestructorRefExp, SgUnknownArrayOrFunctionReference, SgActualArgumentExpression, SgLabelRefExp, SgAsmOp, SgStatementExpression, SgIOItemExpression, SgImpliedDo, SgAsteriskShapeExp, SgColonShapeExp, SgSubscriptExpression, SgVariantExpression, SgNullExpression, SgVarArgStartOneOperandOp, SgVarArgCopyOp, SgVarArgEndOp, SgVarArgOp, SgVarArgStartOp, SgBracedInitializer, SgDesignatedInitializer, SgAssignInitializer, SgConstructorInitializer, SgCompoundInitializer, SgAggregateInitializer, SgInitializer, SgRefExp, SgThisExp, SgDeleteExp, SgNewExp, SgConditionalExp, SgTypeIdOp, SgSuperExp, SgJavaInstanceOfOp, SgUpcElemsizeofExpression, SgUpcBlocksizeofExpression, SgUpcLocalsizeofExpression, SgSizeOfOp, SgCudaKernelCallExp, SgFunctionCallExp, SgCallExpression, SgChar32Val, SgChar16Val, SgNullptrValExp, SgTemplateParameterVal, SgUpcMythread, SgUpcThreads, SgComplexVal, SgLongDoubleVal, SgDoubleVal, SgFloatVal, SgUnsignedLongVal, SgUnsignedLongLongIntVal, SgLongLongIntVal, SgLongIntVal, SgUnsignedIntVal, SgEnumVal, SgIntVal, SgUnsignedShortVal, SgWcharVal, SgUnsignedCharVal, SgCharVal, SgShortVal, SgStringVal, SgBoolValExp, SgValueExp, SgMemberFunctionRefExp, SgFunctionRefExp, SgClassNameRefExp, SgVarRefExp, SgMatrixExp, SgTupleExp, SgListExp, SgExprListExp, SgLeftDivideOp, SgPowerOp, SgElementwiseSubtractOp, SgElementwiseAddOp, SgElementwiseDivideOp, SgElementwiseLeftDivideOp, SgElementwisePowerOp, SgElementwiseMultiplyOp, SgElementwiseOp, SgDotDotExp, SgIsNotOp, SgIsOp, SgNonMembershipOp, SgMembershipOp, SgExponentiationAssignOp, SgIntegerDivideAssignOp, SgJavaUnsignedRshiftAssignOp, SgRshiftAssignOp, SgLshiftAssignOp, SgXorAssignOp, SgModAssignOp, SgDivAssignOp, SgMultAssignOp, SgIorAssignOp, SgAndAssignOp, SgMinusAssignOp, SgPlusAssignOp, SgCompoundAssignOp, SgUserDefinedBinaryOp, SgPointerAssignOp, SgConcatenationOp, SgJavaUnsignedRshiftOp, SgExponentiationOp, SgAssignOp, SgScopeOp, SgPntrArrRefExp, SgRshiftOp, SgLshiftOp, SgCommaOpExp, SgBitOrOp, SgBitAndOp, SgBitXorOp, SgOrOp, SgAndOp, SgModOp, SgIntegerDivideOp, SgDivideOp, SgMultiplyOp, SgSubtractOp, SgAddOp, SgGreaterOrEqualOp, SgLessOrEqualOp, SgNotEqualOp, SgGreaterThanOp, SgLessThanOp, SgEqualityOp, SgArrowStarOp, SgDotStarOp, SgDotExp, SgArrowExp, SgBinaryOp, SgMatrixTransposeOp, SgUserDefinedUnaryOp, SgConjugateOp, SgImagPartOp, SgRealPartOp, SgThrowOp, SgCastExp, SgBitComplementOp, SgPlusPlusOp, SgMinusMinusOp, SgAddressOfOp, SgPointerDerefExp, SgNotOp, SgUnaryAddOp, SgMinusOp, SgExpressionRoot, and SgUnaryOp.

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

Reimplemented in SgNoexceptOp, SgFinishExp, SgAtExp, SgHereExp, SgLambdaExp, SgFunctionParameterRefExp, SgClassExp, SgTypeExpression, SgJavaTypeExpression, SgJavaNormalAnnotation, SgJavaSingleMemberAnnotation, SgJavaMarkerAnnotation, SgJavaAnnotation, SgCompoundLiteralExp, SgTypeTraitBuiltinOperator, SgMagicColonExp, SgRangeExp, SgAlignOfOp, SgTemplateMemberFunctionRefExp, SgTemplateFunctionRefExp, SgYieldExpression, SgStringConversion, SgNaryComparisonOp, SgNaryBooleanOp, SgNaryOp, SgDictionaryComprehension, SgSetComprehension, SgListComprehension, SgComprehension, SgKeyDatumPair, SgDictionaryExp, SgLambdaRefExp, SgCudaKernelExecConfig, SgCAFCoExpression, SgPseudoDestructorRefExp, SgUnknownArrayOrFunctionReference, SgActualArgumentExpression, SgLabelRefExp, SgAsmOp, SgStatementExpression, SgIOItemExpression, SgImpliedDo, SgAsteriskShapeExp, SgColonShapeExp, SgSubscriptExpression, SgVariantExpression, SgNullExpression, SgVarArgStartOneOperandOp, SgVarArgCopyOp, SgVarArgEndOp, SgVarArgOp, SgVarArgStartOp, SgBracedInitializer, SgDesignatedInitializer, SgAssignInitializer, SgConstructorInitializer, SgCompoundInitializer, SgAggregateInitializer, SgInitializer, SgRefExp, SgThisExp, SgDeleteExp, SgNewExp, SgConditionalExp, SgTypeIdOp, SgSuperExp, SgJavaInstanceOfOp, SgUpcElemsizeofExpression, SgUpcBlocksizeofExpression, SgUpcLocalsizeofExpression, SgSizeOfOp, SgCudaKernelCallExp, SgFunctionCallExp, SgCallExpression, SgChar32Val, SgChar16Val, SgNullptrValExp, SgTemplateParameterVal, SgUpcMythread, SgUpcThreads, SgComplexVal, SgLongDoubleVal, SgDoubleVal, SgFloatVal, SgUnsignedLongVal, SgUnsignedLongLongIntVal, SgLongLongIntVal, SgLongIntVal, SgUnsignedIntVal, SgEnumVal, SgIntVal, SgUnsignedShortVal, SgWcharVal, SgUnsignedCharVal, SgCharVal, SgShortVal, SgStringVal, SgBoolValExp, SgValueExp, SgMemberFunctionRefExp, SgFunctionRefExp, SgClassNameRefExp, SgVarRefExp, SgMatrixExp, SgTupleExp, SgListExp, SgExprListExp, SgLeftDivideOp, SgPowerOp, SgElementwiseSubtractOp, SgElementwiseAddOp, SgElementwiseDivideOp, SgElementwiseLeftDivideOp, SgElementwisePowerOp, SgElementwiseMultiplyOp, SgElementwiseOp, SgDotDotExp, SgIsNotOp, SgIsOp, SgNonMembershipOp, SgMembershipOp, SgExponentiationAssignOp, SgIntegerDivideAssignOp, SgJavaUnsignedRshiftAssignOp, SgRshiftAssignOp, SgLshiftAssignOp, SgXorAssignOp, SgModAssignOp, SgDivAssignOp, SgMultAssignOp, SgIorAssignOp, SgAndAssignOp, SgMinusAssignOp, SgPlusAssignOp, SgCompoundAssignOp, SgUserDefinedBinaryOp, SgPointerAssignOp, SgConcatenationOp, SgJavaUnsignedRshiftOp, SgExponentiationOp, SgAssignOp, SgScopeOp, SgPntrArrRefExp, SgRshiftOp, SgLshiftOp, SgCommaOpExp, SgBitOrOp, SgBitAndOp, SgBitXorOp, SgOrOp, SgAndOp, SgModOp, SgIntegerDivideOp, SgDivideOp, SgMultiplyOp, SgSubtractOp, SgAddOp, SgGreaterOrEqualOp, SgLessOrEqualOp, SgNotEqualOp, SgGreaterThanOp, SgLessThanOp, SgEqualityOp, SgArrowStarOp, SgDotStarOp, SgDotExp, SgArrowExp, SgBinaryOp, SgMatrixTransposeOp, SgUserDefinedUnaryOp, SgConjugateOp, SgImagPartOp, SgRealPartOp, SgThrowOp, SgCastExp, SgBitComplementOp, SgPlusPlusOp, SgMinusMinusOp, SgAddressOfOp, SgPointerDerefExp, SgNotOp, SgUnaryAddOp, SgMinusOp, SgExpressionRoot, and SgUnaryOp.

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

Reimplemented in SgNoexceptOp, SgFinishExp, SgAtExp, SgHereExp, SgLambdaExp, SgFunctionParameterRefExp, SgClassExp, SgTypeExpression, SgJavaTypeExpression, SgJavaNormalAnnotation, SgJavaSingleMemberAnnotation, SgJavaMarkerAnnotation, SgJavaAnnotation, SgCompoundLiteralExp, SgTypeTraitBuiltinOperator, SgMagicColonExp, SgRangeExp, SgAlignOfOp, SgTemplateMemberFunctionRefExp, SgTemplateFunctionRefExp, SgYieldExpression, SgStringConversion, SgNaryComparisonOp, SgNaryBooleanOp, SgNaryOp, SgDictionaryComprehension, SgSetComprehension, SgListComprehension, SgComprehension, SgKeyDatumPair, SgDictionaryExp, SgLambdaRefExp, SgCudaKernelExecConfig, SgCAFCoExpression, SgPseudoDestructorRefExp, SgUnknownArrayOrFunctionReference, SgActualArgumentExpression, SgLabelRefExp, SgAsmOp, SgStatementExpression, SgIOItemExpression, SgImpliedDo, SgAsteriskShapeExp, SgColonShapeExp, SgSubscriptExpression, SgVariantExpression, SgNullExpression, SgVarArgStartOneOperandOp, SgVarArgCopyOp, SgVarArgEndOp, SgVarArgOp, SgVarArgStartOp, SgBracedInitializer, SgDesignatedInitializer, SgAssignInitializer, SgConstructorInitializer, SgCompoundInitializer, SgAggregateInitializer, SgInitializer, SgRefExp, SgThisExp, SgDeleteExp, SgNewExp, SgConditionalExp, SgTypeIdOp, SgSuperExp, SgJavaInstanceOfOp, SgUpcElemsizeofExpression, SgUpcBlocksizeofExpression, SgUpcLocalsizeofExpression, SgSizeOfOp, SgCudaKernelCallExp, SgFunctionCallExp, SgCallExpression, SgChar32Val, SgChar16Val, SgNullptrValExp, SgTemplateParameterVal, SgUpcMythread, SgUpcThreads, SgComplexVal, SgLongDoubleVal, SgDoubleVal, SgFloatVal, SgUnsignedLongVal, SgUnsignedLongLongIntVal, SgLongLongIntVal, SgLongIntVal, SgUnsignedIntVal, SgEnumVal, SgIntVal, SgUnsignedShortVal, SgWcharVal, SgUnsignedCharVal, SgCharVal, SgShortVal, SgStringVal, SgBoolValExp, SgValueExp, SgMemberFunctionRefExp, SgFunctionRefExp, SgClassNameRefExp, SgVarRefExp, SgMatrixExp, SgTupleExp, SgListExp, SgExprListExp, SgLeftDivideOp, SgPowerOp, SgElementwiseSubtractOp, SgElementwiseAddOp, SgElementwiseDivideOp, SgElementwiseLeftDivideOp, SgElementwisePowerOp, SgElementwiseMultiplyOp, SgElementwiseOp, SgDotDotExp, SgIsNotOp, SgIsOp, SgNonMembershipOp, SgMembershipOp, SgExponentiationAssignOp, SgIntegerDivideAssignOp, SgJavaUnsignedRshiftAssignOp, SgRshiftAssignOp, SgLshiftAssignOp, SgXorAssignOp, SgModAssignOp, SgDivAssignOp, SgMultAssignOp, SgIorAssignOp, SgAndAssignOp, SgMinusAssignOp, SgPlusAssignOp, SgCompoundAssignOp, SgUserDefinedBinaryOp, SgPointerAssignOp, SgConcatenationOp, SgJavaUnsignedRshiftOp, SgExponentiationOp, SgAssignOp, SgScopeOp, SgPntrArrRefExp, SgRshiftOp, SgLshiftOp, SgCommaOpExp, SgBitOrOp, SgBitAndOp, SgBitXorOp, SgOrOp, SgAndOp, SgModOp, SgIntegerDivideOp, SgDivideOp, SgMultiplyOp, SgSubtractOp, SgAddOp, SgGreaterOrEqualOp, SgLessOrEqualOp, SgNotEqualOp, SgGreaterThanOp, SgLessThanOp, SgEqualityOp, SgArrowStarOp, SgDotStarOp, SgDotExp, SgArrowExp, SgBinaryOp, SgMatrixTransposeOp, SgUserDefinedUnaryOp, SgConjugateOp, SgImagPartOp, SgRealPartOp, SgThrowOp, SgCastExp, SgBitComplementOp, SgPlusPlusOp, SgMinusMinusOp, SgAddressOfOp, SgPointerDerefExp, SgNotOp, SgUnaryAddOp, SgMinusOp, SgExpressionRoot, and SgUnaryOp.

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

Reimplemented in SgNoexceptOp, SgFinishExp, SgAtExp, SgHereExp, SgLambdaExp, SgFunctionParameterRefExp, SgClassExp, SgTypeExpression, SgJavaTypeExpression, SgJavaNormalAnnotation, SgJavaSingleMemberAnnotation, SgJavaMarkerAnnotation, SgJavaAnnotation, SgCompoundLiteralExp, SgTypeTraitBuiltinOperator, SgMagicColonExp, SgRangeExp, SgAlignOfOp, SgTemplateMemberFunctionRefExp, SgTemplateFunctionRefExp, SgYieldExpression, SgStringConversion, SgNaryComparisonOp, SgNaryBooleanOp, SgNaryOp, SgDictionaryComprehension, SgSetComprehension, SgListComprehension, SgComprehension, SgKeyDatumPair, SgDictionaryExp, SgLambdaRefExp, SgCudaKernelExecConfig, SgCAFCoExpression, SgPseudoDestructorRefExp, SgUnknownArrayOrFunctionReference, SgActualArgumentExpression, SgLabelRefExp, SgAsmOp, SgStatementExpression, SgIOItemExpression, SgImpliedDo, SgAsteriskShapeExp, SgColonShapeExp, SgSubscriptExpression, SgVariantExpression, SgNullExpression, SgVarArgStartOneOperandOp, SgVarArgCopyOp, SgVarArgEndOp, SgVarArgOp, SgVarArgStartOp, SgBracedInitializer, SgDesignatedInitializer, SgAssignInitializer, SgConstructorInitializer, SgCompoundInitializer, SgAggregateInitializer, SgInitializer, SgRefExp, SgThisExp, SgDeleteExp, SgNewExp, SgConditionalExp, SgTypeIdOp, SgSuperExp, SgJavaInstanceOfOp, SgUpcElemsizeofExpression, SgUpcBlocksizeofExpression, SgUpcLocalsizeofExpression, SgSizeOfOp, SgCudaKernelCallExp, SgFunctionCallExp, SgCallExpression, SgChar32Val, SgChar16Val, SgNullptrValExp, SgTemplateParameterVal, SgUpcMythread, SgUpcThreads, SgComplexVal, SgLongDoubleVal, SgDoubleVal, SgFloatVal, SgUnsignedLongVal, SgUnsignedLongLongIntVal, SgLongLongIntVal, SgLongIntVal, SgUnsignedIntVal, SgEnumVal, SgIntVal, SgUnsignedShortVal, SgWcharVal, SgUnsignedCharVal, SgCharVal, SgShortVal, SgStringVal, SgBoolValExp, SgValueExp, SgMemberFunctionRefExp, SgFunctionRefExp, SgClassNameRefExp, SgVarRefExp, SgMatrixExp, SgTupleExp, SgListExp, SgExprListExp, SgLeftDivideOp, SgPowerOp, SgElementwiseSubtractOp, SgElementwiseAddOp, SgElementwiseDivideOp, SgElementwiseLeftDivideOp, SgElementwisePowerOp, SgElementwiseMultiplyOp, SgElementwiseOp, SgDotDotExp, SgIsNotOp, SgIsOp, SgNonMembershipOp, SgMembershipOp, SgExponentiationAssignOp, SgIntegerDivideAssignOp, SgJavaUnsignedRshiftAssignOp, SgRshiftAssignOp, SgLshiftAssignOp, SgXorAssignOp, SgModAssignOp, SgDivAssignOp, SgMultAssignOp, SgIorAssignOp, SgAndAssignOp, SgMinusAssignOp, SgPlusAssignOp, SgCompoundAssignOp, SgUserDefinedBinaryOp, SgPointerAssignOp, SgConcatenationOp, SgJavaUnsignedRshiftOp, SgExponentiationOp, SgAssignOp, SgScopeOp, SgPntrArrRefExp, SgRshiftOp, SgLshiftOp, SgCommaOpExp, SgBitOrOp, SgBitAndOp, SgBitXorOp, SgOrOp, SgAndOp, SgModOp, SgIntegerDivideOp, SgDivideOp, SgMultiplyOp, SgSubtractOp, SgAddOp, SgGreaterOrEqualOp, SgLessOrEqualOp, SgNotEqualOp, SgGreaterThanOp, SgLessThanOp, SgEqualityOp, SgArrowStarOp, SgDotStarOp, SgDotExp, SgArrowExp, SgBinaryOp, SgMatrixTransposeOp, SgUserDefinedUnaryOp, SgConjugateOp, SgImagPartOp, SgRealPartOp, SgThrowOp, SgCastExp, SgBitComplementOp, SgPlusPlusOp, SgMinusMinusOp, SgAddressOfOp, SgPointerDerefExp, SgNotOp, SgUnaryAddOp, SgMinusOp, SgExpressionRoot, and SgUnaryOp.

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

Reimplemented in SgNoexceptOp, SgFinishExp, SgAtExp, SgHereExp, SgLambdaExp, SgFunctionParameterRefExp, SgClassExp, SgTypeExpression, SgJavaTypeExpression, SgJavaNormalAnnotation, SgJavaSingleMemberAnnotation, SgJavaMarkerAnnotation, SgJavaAnnotation, SgCompoundLiteralExp, SgTypeTraitBuiltinOperator, SgMagicColonExp, SgRangeExp, SgAlignOfOp, SgTemplateMemberFunctionRefExp, SgTemplateFunctionRefExp, SgYieldExpression, SgStringConversion, SgNaryComparisonOp, SgNaryBooleanOp, SgNaryOp, SgDictionaryComprehension, SgSetComprehension, SgListComprehension, SgComprehension, SgKeyDatumPair, SgDictionaryExp, SgLambdaRefExp, SgCudaKernelExecConfig, SgCAFCoExpression, SgPseudoDestructorRefExp, SgUnknownArrayOrFunctionReference, SgActualArgumentExpression, SgLabelRefExp, SgAsmOp, SgStatementExpression, SgIOItemExpression, SgImpliedDo, SgAsteriskShapeExp, SgColonShapeExp, SgSubscriptExpression, SgVariantExpression, SgNullExpression, SgVarArgStartOneOperandOp, SgVarArgCopyOp, SgVarArgEndOp, SgVarArgOp, SgVarArgStartOp, SgBracedInitializer, SgDesignatedInitializer, SgAssignInitializer, SgConstructorInitializer, SgCompoundInitializer, SgAggregateInitializer, SgInitializer, SgRefExp, SgThisExp, SgDeleteExp, SgNewExp, SgConditionalExp, SgTypeIdOp, SgSuperExp, SgJavaInstanceOfOp, SgUpcElemsizeofExpression, SgUpcBlocksizeofExpression, SgUpcLocalsizeofExpression, SgSizeOfOp, SgCudaKernelCallExp, SgFunctionCallExp, SgCallExpression, SgChar32Val, SgChar16Val, SgNullptrValExp, SgTemplateParameterVal, SgUpcMythread, SgUpcThreads, SgComplexVal, SgLongDoubleVal, SgDoubleVal, SgFloatVal, SgUnsignedLongVal, SgUnsignedLongLongIntVal, SgLongLongIntVal, SgLongIntVal, SgUnsignedIntVal, SgEnumVal, SgIntVal, SgUnsignedShortVal, SgWcharVal, SgUnsignedCharVal, SgCharVal, SgShortVal, SgStringVal, SgBoolValExp, SgValueExp, SgMemberFunctionRefExp, SgFunctionRefExp, SgClassNameRefExp, SgVarRefExp, SgMatrixExp, SgTupleExp, SgListExp, SgExprListExp, SgLeftDivideOp, SgPowerOp, SgElementwiseSubtractOp, SgElementwiseAddOp, SgElementwiseDivideOp, SgElementwiseLeftDivideOp, SgElementwisePowerOp, SgElementwiseMultiplyOp, SgElementwiseOp, SgDotDotExp, SgIsNotOp, SgIsOp, SgNonMembershipOp, SgMembershipOp, SgExponentiationAssignOp, SgIntegerDivideAssignOp, SgJavaUnsignedRshiftAssignOp, SgRshiftAssignOp, SgLshiftAssignOp, SgXorAssignOp, SgModAssignOp, SgDivAssignOp, SgMultAssignOp, SgIorAssignOp, SgAndAssignOp, SgMinusAssignOp, SgPlusAssignOp, SgCompoundAssignOp, SgUserDefinedBinaryOp, SgPointerAssignOp, SgConcatenationOp, SgJavaUnsignedRshiftOp, SgExponentiationOp, SgAssignOp, SgScopeOp, SgPntrArrRefExp, SgRshiftOp, SgLshiftOp, SgCommaOpExp, SgBitOrOp, SgBitAndOp, SgBitXorOp, SgOrOp, SgAndOp, SgModOp, SgIntegerDivideOp, SgDivideOp, SgMultiplyOp, SgSubtractOp, SgAddOp, SgGreaterOrEqualOp, SgLessOrEqualOp, SgNotEqualOp, SgGreaterThanOp, SgLessThanOp, SgEqualityOp, SgArrowStarOp, SgDotStarOp, SgDotExp, SgArrowExp, SgBinaryOp, SgMatrixTransposeOp, SgUserDefinedUnaryOp, SgConjugateOp, SgImagPartOp, SgRealPartOp, SgThrowOp, SgCastExp, SgBitComplementOp, SgPlusPlusOp, SgMinusMinusOp, SgAddressOfOp, SgPointerDerefExp, SgNotOp, SgUnaryAddOp, SgMinusOp, SgExpressionRoot, and SgUnaryOp.

virtual long SgExpression::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 SgLocatedNode.

Reimplemented in SgNoexceptOp, SgFinishExp, SgAtExp, SgHereExp, SgLambdaExp, SgFunctionParameterRefExp, SgClassExp, SgTypeExpression, SgJavaTypeExpression, SgJavaNormalAnnotation, SgJavaSingleMemberAnnotation, SgJavaMarkerAnnotation, SgJavaAnnotation, SgCompoundLiteralExp, SgTypeTraitBuiltinOperator, SgMagicColonExp, SgRangeExp, SgAlignOfOp, SgTemplateMemberFunctionRefExp, SgTemplateFunctionRefExp, SgYieldExpression, SgStringConversion, SgNaryComparisonOp, SgNaryBooleanOp, SgNaryOp, SgDictionaryComprehension, SgSetComprehension, SgListComprehension, SgComprehension, SgKeyDatumPair, SgDictionaryExp, SgLambdaRefExp, SgCudaKernelExecConfig, SgCAFCoExpression, SgPseudoDestructorRefExp, SgUnknownArrayOrFunctionReference, SgActualArgumentExpression, SgLabelRefExp, SgAsmOp, SgStatementExpression, SgIOItemExpression, SgImpliedDo, SgAsteriskShapeExp, SgColonShapeExp, SgSubscriptExpression, SgVariantExpression, SgNullExpression, SgVarArgStartOneOperandOp, SgVarArgCopyOp, SgVarArgEndOp, SgVarArgOp, SgVarArgStartOp, SgBracedInitializer, SgDesignatedInitializer, SgAssignInitializer, SgConstructorInitializer, SgCompoundInitializer, SgAggregateInitializer, SgInitializer, SgRefExp, SgThisExp, SgDeleteExp, SgNewExp, SgConditionalExp, SgTypeIdOp, SgSuperExp, SgJavaInstanceOfOp, SgUpcElemsizeofExpression, SgUpcBlocksizeofExpression, SgUpcLocalsizeofExpression, SgSizeOfOp, SgCudaKernelCallExp, SgFunctionCallExp, SgCallExpression, SgChar32Val, SgChar16Val, SgNullptrValExp, SgTemplateParameterVal, SgUpcMythread, SgUpcThreads, SgComplexVal, SgLongDoubleVal, SgDoubleVal, SgFloatVal, SgUnsignedLongVal, SgUnsignedLongLongIntVal, SgLongLongIntVal, SgLongIntVal, SgUnsignedIntVal, SgEnumVal, SgIntVal, SgUnsignedShortVal, SgWcharVal, SgUnsignedCharVal, SgCharVal, SgShortVal, SgStringVal, SgBoolValExp, SgValueExp, SgMemberFunctionRefExp, SgFunctionRefExp, SgClassNameRefExp, SgVarRefExp, SgMatrixExp, SgTupleExp, SgListExp, SgExprListExp, SgLeftDivideOp, SgPowerOp, SgElementwiseSubtractOp, SgElementwiseAddOp, SgElementwiseDivideOp, SgElementwiseLeftDivideOp, SgElementwisePowerOp, SgElementwiseMultiplyOp, SgElementwiseOp, SgDotDotExp, SgIsNotOp, SgIsOp, SgNonMembershipOp, SgMembershipOp, SgExponentiationAssignOp, SgIntegerDivideAssignOp, SgJavaUnsignedRshiftAssignOp, SgRshiftAssignOp, SgLshiftAssignOp, SgXorAssignOp, SgModAssignOp, SgDivAssignOp, SgMultAssignOp, SgIorAssignOp, SgAndAssignOp, SgMinusAssignOp, SgPlusAssignOp, SgCompoundAssignOp, SgUserDefinedBinaryOp, SgPointerAssignOp, SgConcatenationOp, SgJavaUnsignedRshiftOp, SgExponentiationOp, SgAssignOp, SgScopeOp, SgPntrArrRefExp, SgRshiftOp, SgLshiftOp, SgCommaOpExp, SgBitOrOp, SgBitAndOp, SgBitXorOp, SgOrOp, SgAndOp, SgModOp, SgIntegerDivideOp, SgDivideOp, SgMultiplyOp, SgSubtractOp, SgAddOp, SgGreaterOrEqualOp, SgLessOrEqualOp, SgNotEqualOp, SgGreaterThanOp, SgLessThanOp, SgEqualityOp, SgArrowStarOp, SgDotStarOp, SgDotExp, SgArrowExp, SgBinaryOp, SgMatrixTransposeOp, SgUserDefinedUnaryOp, SgConjugateOp, SgImagPartOp, SgRealPartOp, SgThrowOp, SgCastExp, SgBitComplementOp, SgPlusPlusOp, SgMinusMinusOp, SgAddressOfOp, SgPointerDerefExp, SgNotOp, SgUnaryAddOp, SgMinusOp, SgExpressionRoot, and SgUnaryOp.

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

SgExpression::get_need_paren ( void  ) const

returns bool value if front-end considers parenthesis to be required.

This function returns a boolean value which is true if parenthesis are required for the proper eveluation of the current expression. The frontend is however overly conservative and introduces parenthesis too often. The value as determined by the frontend is saved in the SAGE III AST because it is sometimes required for more complex expressions and contructor calls with initializers. At present the unparser applies operator precedence rules to eliminate some of the redundent parenthesis within expressions (this makes the output more appealing).

Returns
Returns bool value (true if parenthesis are needed around the expression).
SgExpression::set_need_paren ( bool  need_paren)

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

This function is mostly used internally but would required for the construction of specific expression trees where the operator precedence would be insufficent to generate the correct code (which si the purpose of adding parenthesis in source code).

Parameters
need_paren- sets value of internal p_need_paren flag (true if parenthesis are needed around the expression).
Returns
Returns void.
SgExpression::get_lvalue ( void  ) const

Returns a bool value if the current expression is assigned to.

SgExpression::set_lvalue ( bool  lvalue)

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

This function is mostly used internally but would required for the construction of specific expression trees. In general it is set by the frontend, but not used elsewhere within SAGE III (will be tested in the future).

Parameters
lvalue- sets value of internal p_lvalue flag (true if the current is to be a left hand side value (lvalue)).
Returns
Returns void.

Friends And Related Function Documentation

SgExpression::isSgExpression ( SgNode s)
friend

Casts pointer from base class to derived class.

Cast function (from derived class to SgExpression pointer).

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

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

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

Cast function (from derived class to SgExpression pointer).

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

Returns
Returns valid pointer to SgExpression if input is derived from a SgExpression.
unsigned long SgExpression_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.

Member Data Documentation

SgExpression::p_need_paren
protected

This boolean value marks the current expression as requiring parenthises.

This boolean value marks the current expression as requiring parenthises (the information comes from the frontend's interpretation of the requirement and is almost always overly conservative. The unparser currently backs out more accurate rules based on operator precedence and removed then where they are not truely required. Thus the purpose of this variable is to capture the interpritation of the frontend regarding the use of parenthesis.

Definition at line 235609 of file Cxx_Grammar.h.

SgExpression::p_lvalue
protected

This boolean variable marks the current expression as a left hand side value (lvalue).

Definition at line 235613 of file Cxx_Grammar.h.


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