Description

This class represents the base class for all IR nodes within Sage III.

This class is used as a base class for all IR nodes in Sage III.

Note

AST attributes should not be used for the following IR nodes:

SgName
SgModifier (and all derived modifier IR nodes)
SgUnparse_Info
SgSymbolTable

Definition at line 9846 of file Cxx_Grammar.h.

Inheritance diagram for SgNode:

[legend]

Collaboration diagram for SgNode:

[legend]

Public Types
enum	{ static_variant = V_SgNode }
	static variant value

Public Member Functions
virtual SgNode *	copy (SgCopyHelp &help) const
	This function clones the current IR node object recursively or not, depending on the argument. More...

virtual std::string	class_name () const
	returns a string representing the class name 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

void	operator delete (void *pointer, size_t size)
	deallocated memory for IR node (returns memory to memory pool for reuse)

void	operator delete (void *pointer)

virtual std::vector< SgNode * >	get_traversalSuccessorContainer ()
	container of pointers to AST successor nodes used in the traversal overridden in every class by generated implementation More...

virtual std::vector< std::string >	get_traversalSuccessorNamesContainer ()
	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 More...

virtual size_t	get_numberOfTraversalSuccessors ()
	return number of children in the traversal successor list

virtual SgNode *	get_traversalSuccessorByIndex (size_t idx)
	index-based access to traversal successors by index number

virtual size_t	get_childIndex (SgNode *child)
	index-based access to traversal successors by child node

virtual RTIReturnType	roseRTI ()
	return C++ Runtime-Time-Information More...

virtual const char *	sage_class_name () const ROSE_DEPRECATED_FUNCTION
	generates string representing the class name: (e.g. for SgNode returns "SgNode"). More...

void	executeVisitorMemberFunction (ROSE_VisitorPattern &visitor)
	FOR INTERNAL USE Support for visitor pattern.

virtual void	accept (ROSE_VisitorPattern &visitor)
	support for the classic visitor pattern done in GoF

virtual bool	isInMemoryPool ()
	FOR INTERNAL USE This is used in internal tests to verify that all IR nodes are allocated from the heap. 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...

	SgNode (const SgNodeStorageClass &source)
	IR node constructor to support AST File I/O.

SgNode *	addRegExpAttribute (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...

SgNode *	get_parent () const
	Access function for parent node. More...

SgNode *	get_raw_parent () const
	Access function for direct access to uncomputed value of parent node.

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...

virtual void	addNewAttribute (std::string s, AstAttribute *a)
	Add a new attribute represented by the named string.

virtual AstAttribute *	getAttribute (std::string s) const
	Returns attribute of name 's'.

virtual void	updateAttribute (std::string s, AstAttribute *a)
	Replace existing attribute of name 's' with new AstAttribute.

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.

virtual void	removeAttribute (std::string s)
	Remove attribute of name 's' if present.

virtual bool	attributeExists (std::string s) const
	Tests if attribute of name 's' is present.

virtual int	numberOfAttributes () const
	Returns the number of attributes on this IR node.

virtual AstAttributeMechanism *	get_attributeMechanism () const
	FOR INTERNAL USE Access function; if an attribute exists then a pointer to it is returned, else error. More...

virtual void	set_attributeMechanism (AstAttributeMechanism *a)
	FOR INTERNAL USE Access function; sets poiner to value AstAttributeMechanism. More...

virtual void	fixupCopy (SgNode *copy, SgCopyHelp &help) const

virtual Sg_File_Info *	get_file_info (void) const
	File information containing filename, line number, column number, and if the SgNode is a part of a new transformation, etc.

virtual Sg_File_Info *	get_startOfConstruct (void) const
	New function interface for Sg_File_Info data stores starting location of contruct (typically the opening brace or first letter of keyword).

virtual Sg_File_Info *	get_endOfConstruct (void) const
	New function interface for Sg_File_Info data stores ending location of contruct (typically the closing brace).

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.

virtual unsigned int	cfgIndexForEnd () const
	Determine the CFG index for the end of this construct.

virtual bool	cfgIsIndexInteresting (unsigned int index) const
	Determine whether a particular CFG node index is "interesting" for this kind of node.

virtual unsigned int	cfgFindChildIndex (SgNode *n)
	Find the index of n in this node's CFG children.

virtual unsigned int	cfgFindNextChildIndex (SgNode *n)
	Find the index just after n in this node's CFG children.

virtual std::vector< VirtualCFG::CFGEdge >	cfgOutEdges (unsigned int index=false)
	Find the out edges of a CFG node – internal version.

virtual std::vector< VirtualCFG::CFGEdge >	cfgInEdges (unsigned int index=false)
	Find the in edges of a CFG node – internal version.

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...

template<class T >
T *	initParentPointer (T child, SgNode parent)
	Generated for tree edge data member initializations. More...

SgNode *	get_freepointer () const

void	set_freepointer (SgNode *freepointer)

virtual	~SgNode ()
	This is the destructor. More...

	SgNode ()
	This is the constructor. More...

Static Public Member Functions
static void	deleteMemoryPool ()

static size_t	numberOfNodes ()
	Returns the total number of IR nodes of this type.

static size_t	memoryUsage ()
	Returns the size in bytes of the total memory allocated for all IR nodes of this type.

static void	traverseMemoryPoolNodes (ROSE_VisitTraversal &visit)
	FOR INTERNAL USE Support for visitor pattern 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 SgNode *	getNodeByNodeId (VariantT variantT, size_t poolIdx, size_t itemIdx)
	Find a node by its variant type, pool index, and item index.

static SgNode *	getNodeByNodeIdInternal (size_t poolIdx, size_t itemIdx)
	FOR INTERNAL USE Find an SgNode from its memory pool and location therin.

static std::string	getNodeIdString (SgNode *sgnode)
	compute the NodeId for a particular SgNode*.

static std::string	getNodeIdStringInternal (SgNode *sgnode)

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::map< SgNode , std::string > > &	get_globalQualifiedNameMapForMapsOfTypes ()
	Access function for name qualification support (for maps of types). More...

static void	set_globalQualifiedNameMapForMapsOfTypes (const std::map< SgNode , std::map< SgNode , std::string > > &X)
	Access function for name qualification support (for maps of types). 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 SgFunctionTypeTable *	get_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 SgTypeTable *	get_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 VariantT	variantFromPool (SgNode const *n)

template<class T >
static std::enable_if< std::is_base_of< SgNode, T >::value, T * >::type	createAndParent (SgNode *parent)
	Allocate and return a new node after setting its parent. More...

Protected Member Functions
virtual 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.

virtual void	destructorHelper ()
	This gets called by all Rosebud-generated destructors. More...

Protected Attributes
SgNode *	p_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

SgNode *	p_freepointer
	This is the pointer to the chain of previously freed objects.

Static Protected Attributes
static std::vector< std::tuple< unsigned char *, unsigned, VariantT > >	all_pools

static SgFunctionTypeTable *	p_globalFunctionTypeTable
	Pointer to symbol table specific to function types.

static SgTypeTable *	p_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

static std::map< SgNode , std::map< SgNode , std::string > >	p_globalQualifiedNameMapForMapsOfTypes

Friends
ROSE_DLL_API friend SgNode *	isSgNode (SgNode *s)
	Casts pointer from base class to derived class. More...

ROSE_DLL_API friend const SgNode *	isSgNode (const SgNode *s)
	Casts pointer from base class to derived class (for const pointers) More...

template<class T >
std::enable_if< std::is_pointer< T >::value, void >::type	changeChildPointer (T &edge, T const &child)
	Set a child edge in a tree to point to a specific child. More...

template<class T >
std::enable_if< !std::is_pointer< T >::value, void >::type	changeChildPointer (T &edge, T const &child)
	Set a child edge in a tree to point to a specific child. More...

virtual void	debugSerializationBegin (const char *className)
	Called by generated serializers. More...

virtual void	debugSerializationEnd (const char *className)
	Called by generated serializers. More...

Traversal Support
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...

Constructor & Destructor Documentation

SgNode::~SgNode ( )

virtual

This is the destructor.

There is nothing to delete in this object.

SgNode::SgNode ( )

This is the constructor.

This constructor builds a SgNode, always used as a base class. All Sage III IR nodes are derived from this class.

See also: Example:create an SgNode object

Member Function Documentation

SgNode::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.

string SgNode::class_name ( ) const

virtual

returns a string representing the class name

generates string representing the class name: (e.g. for SgNode returns "SgNode").

This function is useful for debugging and error reporting. It returns the name of the IR node.

Returns: a C++ string object.

Referenced by SageInterface::getEnclosingNode().

SgNode::variantT ( ) const

virtual

returns new style SageIII enum values

returns enum value "V_SgNode"

This function is useful for debugging and error reporting. It returns the name of the IR node.

Returns: an enum value (type: VariantT).

This function is useful for debugging and error reporting. It returns the name of the IR node.

Returns: an enum value (type: VariantT).

This function is useful for debugging and error reporting. It returns the name of the IR node.

Returns: an enum value (type: VariantT).

This function is useful for debugging and error reporting. It returns the name of the IR node.

Once the variant() function is removed this function will be deprecated and replaced by a new function named "variant()". The new "variant()" function will return the new enum type (with consistant naming convention in place). The name of the enum type might be changed to make it more clear.

Returns: an enum value (type: VariantT).

Referenced by ssa_private::DataflowCfgFilter::operator()().

SgNode::get_traversalSuccessorContainer ( )

virtual

container of pointers to AST successor nodes used in the traversal overridden in every class by generated implementation

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.

Referenced by SageInterface::findDeclarationStatement().

SgNode::get_traversalSuccessorNamesContainer ( )

virtual

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

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.

SgNode::roseRTI ( )

virtual

return C++ Runtime-Time-Information

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).

SgNode::sage_class_name ( ) const

virtual

generates string representing the class name: (e.g. for SgNode returns "SgNode").

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

This function is useful for debugging and error reporting. It returns the name of the IR node.

Returns: a char* pointer to a C style string.

This function is useful for debugging and error reporting. It returns the name of the IR node.

Returns: a char* pointer to a C style string.

This function is useful for debugging and error reporting. It returns the name of the IR node.

Returns: a char* pointer to a C style string.

This function is useful for debugging and error reporting. It returns the name of the IR node.

Returns: a char* pointer to a C style string.

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

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

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

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

virtual long SgNode::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

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

SgNode::set_isModified ( bool isModified )

All nodes in the AST contain a isModified flag used to track changes to the AST.

Acess function for isModified flag.

This flag can be set but this is typically an internal function used to track the modifications to AST. Within future unparsing this flag will control where the token stream is used alternatively to the code generation from the AST.

This flag records if the current IR node has been modified. It is set to false after and ROSE front-end processing.

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

This flag is required to support the unparsing using the token stream.

SgNode::get_isModified ( ) const

Acess function for isModified flag.

FOR INTERNAL USE All nodes in the AST contain a isModified flag.

This flag records if the current IR node has been modified. It is set to false after and ROSE front-end processing.

This flag can be set but this is typically an internal function used to track the updates to AST.

Returns: Returns bool; true if IR node has been modified.

bool SgNode::get_containsTransformation ( ) const

Acess function for containsTransformation flag.

This flag records if the current IR node has a nested AST node that is marked as being modified.

SgNode::set_parent ( SgNode * parent )

All nodes in the AST contain a reference to a parent node.

Sets parent node for any IR node. The parent node in the AST can be set but this is typically an internal function used to build the AST.

Parameters

parent - Pointer to parent node to store within the current IR node.

Returns: returns void.

Referenced by Rose::BinaryAnalysis::ControlFlow::apply_to_ast(), SageBuilder::buildBinaryExpression(), SageBuilder::buildBinaryExpression_nfi(), SageBuilder::buildUnaryExpression(), SageBuilder::buildUnaryExpression_nfi(), and SageInterface::setParameterList().

SgNode::get_parent ( ) const

Access function for parent node.

Access function for parent node in AST.

The parent node in the AST can be accessed, in general only the project node, symbols and types should be NULL. Since parent nodes are set within post processing (and using the ROSE AST traveral mechanism) the parents are guarenteed to match the traversal, and no other concept of what could be a parent within the AST (e.g a parent concept based on scope). Because the traversal is based on the source code layout, what is a parent is similarly based on the source code layout and not any concept of scope. Note that the scope of relavant IR nodes is stored explicitly in the AST, precisely because it is not always related to the layout of the source code (and thus not related to the concept of parent in the AST).

Returns: Returns pointer to SgNode

Referenced by Rose::BinaryAnalysis::InstructionSemantics::StaticSemantics::SValue::ast(), SageInterface::getEnclosingNode(), and SageInterface::setParameterList().

SgNode::unparseToCompleteString ( )

This function unparses the AST node (including comments and white space)

This function is a complement to the unparseToString() function and includes any associated comments and preprocessor control directives. Because C preprocessor control directive can be included string generated using this function may or may not be appropriate for use as input to the AST rewrite mechanism.

Returns: Returns std::string

This function is a complement to the unparseToString() function and includes any associated comments and preprocessor control directives. Because C preprocessor control directive can be included string generated using this function may or may not be appropriate for use as input to the AST rewrite mechanism.

Returns: Returns std::string

This function is a complement to the unparseToString() function and includes any associated comments and preprocessor control directives. Because C preprocessor control directive can be included string generated using this function may or may not be appropriate for use as input to the AST rewrite mechanism.

Returns: Returns std::string

This function is a complement to the unparseToString() function and includes any associated comments and preprocessor control directives. Because C preprocessor control directive can be included string generated using this function may or may not be appropriate for use as input to the AST rewrite mechanism.

Returns: Returns std::string

static std::vector<std::string> SgNode::buildCommandLineToSubstituteTransformationFile	(	const std::vector< std::string > &	argv,
		std::string	newFileName
	)

static

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.

Parameters

argv	- vector of strings holding command line arguments
newFileName	- current file name being used (part of support for multiple files on command line).

Returns: returns vector of strings.

SgNode::variant ( ) const

inline

Older version function returns enum value "NODE".

This function is an older version of the variant function. This function is useful for debugging and error reporting. It returns the name of the IR node.

Returns: an int value.

This function is an older version of the variant function. This function is useful for debugging and error reporting. It returns the name of the IR node.

Returns: an int value.

This function is an older version of the variant function. This function is useful for debugging and error reporting. It returns the name of the IR node.

Returns: an int value.

This function is an older version of the variant function. This function is useful for debugging and error reporting. It returns the name of the IR node.

Returns: an int value.

Definition at line 10340 of file Cxx_Grammar.h.

SgNode::get_isVisited ( ) const

DOCS IN HEADER: Access function for p_isVisited flag used previously by the AST traversals.

DOCS IN SgNode.docs: Access function for p_isVisited flag used previously by the AST traversals.

SgNode::set_isVisited ( bool isVisited )

Access function for p_isVisited flag used previously by the AST traversals.

DOCS IN SgNode.docs: Access function for p_isVisited flag used previously by the AST traversals.

static std::map<SgNode*,std::string>& SgNode::get_globalMangledNameMap ( )

static

Access function for performance optimizing global mangled name map.

This mangle name caching is implemented to support better performance.

static std::map<std::string, int>& SgNode::get_shortMangledNameCache ( )

static

Access function for lower level optimizing of global mangled name map.

This mangle name caching is implemented to shorter strings used in the globalMangledNameMap mechanism.

static std::map<SgNode*,std::string>& SgNode::get_globalQualifiedNameMapForNames ( )

static

Access function for name qualification support (for names).

This qualified name is stored with reference to where the name is used (as required) instead of with the IR node of what is names (e.g. function declaration, variable declaration, etc.).

static void SgNode::set_globalQualifiedNameMapForNames ( const std::map< SgNode *, std::string > & X )

static

Access function for name qualification support (for names).

This qualified name is stored with reference to where the name is used (as required) instead of with the IR node of what is names (e.g. function declaration, variable declaration, etc.).

static std::map<SgNode*,std::string>& SgNode::get_globalQualifiedNameMapForTypes ( )

static

Access function for name qualification support (for type).

This qualified name is stored with reference to where the type is used (as required) instead of with the IR node representing the type (which are typically shared) (e.g. function return type, variable type, etc.).

static void SgNode::set_globalQualifiedNameMapForTypes ( const std::map< SgNode *, std::string > & X )

static

Access function for name qualification support (for type).

This qualified name is stored with reference to where the type is used (as required) instead of with the IR node representing the type (which are typically shared) (e.g. function return type, variable type, etc.).

static std::map<SgNode*,std::map<SgNode*,std::string> >& SgNode::get_globalQualifiedNameMapForMapsOfTypes ( )

static

Access function for name qualification support (for maps of types).

This qualified name is stored with reference to where the type is used (as required) instead of with the IR node representing the type (which are typically shared) (e.g. function return type, variable type, etc.).

static void SgNode::set_globalQualifiedNameMapForMapsOfTypes ( const std::map< SgNode *, std::map< SgNode *, std::string > > & X )

static

Access function for name qualification support (for maps of types).

This qualified name is stored with reference to where the type is used (as required) instead of with the IR node representing the type (which are typically shared) (e.g. function return type, variable type, etc.).

static std::map<SgNode*,std::string>& SgNode::get_globalQualifiedNameMapForTemplateHeaders ( )

static

Access function for name qualification support (for template headers in template declarations).

This name is stored with reference to where the template declaration is used (as required) instead of with the IR node (where it could be incorrect). This design allows it to be computed as needed. Note that template headers are the substrings "template<typename T>" that apepar in header declarations. These can be repeated as required for deeply nested templated classes and thus are associated with name qualification of template declarations (along with the more common form of name qualication that also applies to template declarations).

static void SgNode::set_globalQualifiedNameMapForTemplateHeaders ( const std::map< SgNode *, std::string > & X )

static

Access function for name qualification support (for template headers in template declarations).

See documentation in get_globalQualifiedNameMapForTemplateHeaders() (above).

static std::map<SgNode*,std::string>& SgNode::get_globalTypeNameMap ( )

static

Access function for name qualification support (for names of types).

This type name is stored with reference to where the type is used (as required) instead of with the IR node representing the type (which are typically shared) (e.g. function return type, variable type, etc.).

static void SgNode::set_globalTypeNameMap ( const std::map< SgNode *, std::string > & X )

static

Access function for name qualification support (for names of types).

This qualified name is stored with reference to where the name is used (as required) instead of with the IR node of what is names (e.g. function declaration, variable declaration, etc.).

virtual AstAttributeMechanism* SgNode::get_attributeMechanism ( ) const

virtual

FOR INTERNAL USE Access function; if an attribute exists then a pointer to it is returned, else error.

This is an access function used for getting the interally held pointer to a valid AstAttributeMechanism. It provides access to lower level functionality of the AstAttributeMechanism, put is mostly of use to internal tools.

Reimplemented in SgSymbol, SgLocatedNode, SgType, SgGraphEdge, SgGraphNode, SgGraph, SgFileList, SgDirectory, SgProject, SgFile, and SgPragma.

virtual void SgNode::set_attributeMechanism ( AstAttributeMechanism * a )

virtual

FOR INTERNAL USE Access function; sets poiner to value AstAttributeMechanism.

This is an access function used for setting the interally held pointer to a valid AstAttributeMechanism.

Reimplemented in SgSymbol, SgLocatedNode, SgType, SgGraphEdge, SgGraphNode, SgGraph, SgFileList, SgDirectory, SgProject, SgFile, and SgPragma.

int SgNode::numberOfNodesInSubtree ( )

Computes the number of nodes in the defined subtree of the AST.

This function is used as a basis for steps in AST isomophism tests. The implementation uses a traversal of the AST subtree to count the number of IR nodes. So the complexity if order N in the size of the subtree.

int SgNode::depthOfSubtree ( )

Computes the depth of the current defined subtree of the AST.

This function is used as a basis for steps in AST isomophism tests. The implementation uses a traversal of the AST subtree to count the depth of the AST traversal. So the complexity if order N in the size of the subtree.

template<class T >

static std::enable_if<std::is_base_of<SgNode, T>::value, T*>::type SgNode::createAndParent ( SgNode * parent )

inlinestatic

Allocate and return a new node after setting its parent.

ROSE's AST has this annoying, error-prone process for adding a node to the tree. One has to not only add the downward edge from parent to child, but also explicitly add the upward edge from child to parent. This two-step process makes it difficult to create child nodes and link them into the parent while the parent is being constructed. This function attempts to make this easier by doing everything in one step.

Use it like this:

Parent::Parent(int foo, int bar)

: p_child(createAndParent<Child>(this), p_foo(foo), p_bar(bar) {}

Definition at line 10678 of file Cxx_Grammar.h.

template<class T >

T* SgNode::initParentPointer	(	T *	child,
		SgNode *	parent
	)

inline

Generated for tree edge data member initializations.

When initializing a data member that's an edge in the tree, this sets the nodes parent pointer to this object and then returns the node. It is used in generated code for constructors, like this:

Foo::Foo(Bar *bar)

: p_bar(adjustParent(bar, this)) {}

Definition at line 10694 of file Cxx_Grammar.h.

template<class T >

std::enable_if< std::is_pointer<T>::value, void>::type SgNode::changeChildPointer	(	T &	edge,
		T const &	child
	)

inline

Set a child edge in a tree to point to a specific child.

Normally one has to remember to set the parent pointer when adding a child to a tree, and also be careful that the result is still a tree. This helper function tries to make that easier by checking some things and setting the parent pointer automatically.

For instance, this should work:

SgAsmBinaryExpression *parent = ...;
SgAsmBinaryExpression *child1 = ...;
SgAsmBinaryExpression *child2 = ...;
parent->set_lhs(child1);
ASSERT_require(child1->get_parent() == parent);
parent->set_lhs(child2);
ASSERT_require(child1->get_parent() == nullptr);
ASSERT_require(child2->get_parent() == parent);
parent->set_lhs(nullptr);
ASSERT_require(child2->get_parent() == nullptr);

The following should not work when assertions are enabled:

SgAsmBinaryExpression *parent = ...;
SgAsmBinaryExpression *child1 = ...;
SgAsmBinaryExpression *child2 = ...;
parent->set_lhs(child1);
parent->set_rhs(child1); // no longer a tree, but still acyclic

Definition at line 10756 of file Cxx_Grammar.h.

template<class T >

std::enable_if< !std::is_pointer<T>::value, void>::type SgNode::changeChildPointer	(	T &	edge,
		T const &	child
	)

inline

Set a child edge in a tree to point to a specific child.

Normally one has to remember to set the parent pointer when adding a child to a tree, and also be careful that the result is still a tree. This helper function tries to make that easier by checking some things and setting the parent pointer automatically.

For instance, this should work:

SgAsmBinaryExpression *parent = ...;
SgAsmBinaryExpression *child1 = ...;
SgAsmBinaryExpression *child2 = ...;
parent->set_lhs(child1);
ASSERT_require(child1->get_parent() == parent);
parent->set_lhs(child2);
ASSERT_require(child1->get_parent() == nullptr);
ASSERT_require(child2->get_parent() == parent);
parent->set_lhs(nullptr);
ASSERT_require(child2->get_parent() == nullptr);

The following should not work when assertions are enabled:

SgAsmBinaryExpression *parent = ...;
SgAsmBinaryExpression *child1 = ...;
SgAsmBinaryExpression *child2 = ...;
parent->set_lhs(child1);
parent->set_rhs(child1); // no longer a tree, but still acyclic

Definition at line 10802 of file Cxx_Grammar.h.

virtual void SgNode::destructorHelper ( )

inlineprotectedvirtual

This gets called by all Rosebud-generated destructors.

Rosebud generates a call to destructorHelper from every destructor implementation. This gives the user a chance to do something special. There are some things to be aware of when reimplementing this function, and you should be well versed in the C++ rules about calling virtual functions from destructors.

The implementation must not attempt to access any data members of derived classes. These data members have already been destroyed by time this function is called.

Any calls you make to virtual functions declared in this class will dispatch only to implementations in this class or its base classes, not any derived classes.

Your implementation must expect to be called multiple times for the same object. This occurs when this class implements this function but its derived class does not. During destruction of a derived object, the derived class's Rosebud-generated destructor will call destructorHelper, which will dispatch to the implementation in this class. Then, when the part of the object corresponding to this class is being destroyed, the destructor will call destructorHelper again, which will dispatch to this implementation again. This may happen recursively mutliple times.

Your implementation should not destroy anything that a subclass might need during its destruction. This follows from the rule above, but is generally not a problem in practice. The reason it's not a problem is that the derived classes are usually Rosebud-generated and thus their destructors only call destructorHelper. Therefore, in order for any derived class to any work, it must be done in its destructorHelper, which would be called before the implementation of destructorHelper in this class is called.

All attempts should be made to avoid having to implement a destructorHelper in any class but the most base class (and that one does nothing). Instead, use data members whose own destructors do their cleanup. For instance, if this class needs a pointer to data allocated on the stack, then instead of using a raw pointer which needs to be deleted in this class's destructor, use a smart pointer whose own destructor deletes the data. If you follow this advice, then you don't need to be well-versed in the details of C++ object destruction.

Reimplemented in SgAsmGenericSection, SgAsmCoffStrtab, SgAsmGenericHeader, SgAsmElfStrtab, SgAsmGenericFile, SgAsmJvmConstantPool, and SgAsmJvmFileHeader.

Definition at line 10870 of file Cxx_Grammar.h.

virtual void SgNode::debugSerializationBegin ( const char * className )

inlineprotectedvirtual

Called by generated serializers.

All generated serialization functions call this function as the first or last thing they do. This is a convenient place to put temporary debugging code or breakpoints if you're trying to figure out what went wrong. You can also it in particular derived classes if you need to debug just one class.

Definition at line 10880 of file Cxx_Grammar.h.

virtual void SgNode::debugSerializationEnd ( const char * className )

inlineprotectedvirtual

Called by generated serializers.

All generated serialization functions call this function as the first or last thing they do. This is a convenient place to put temporary debugging code or breakpoints if you're trying to figure out what went wrong. You can also it in particular derived classes if you need to debug just one class.

Definition at line 10883 of file Cxx_Grammar.h.

Friends And Related Function Documentation

SgNode::isSgNode ( SgNode * s )

friend

Casts pointer from base class to derived class.

Cast function (from derived class to SgNode pointer).

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

Returns: Returns valid pointer to SgNode if input is derived from a SgNode.

SgNode::isSgNode ( const SgNode * s )

friend

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

Cast function (from derived class to SgNode pointer).

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

Returns: Returns valid pointer to SgNode if input is derived from a SgNode.

Member Data Documentation

SgNode::p_parent

protected

This is the pointer to the parent IR node in the AST.

This is the pointer to the parent IR node in the AST. This is the pointer to the parent IR node. It is a valid pointer on all nodes that are traversed (SgExpressions, SgStatements, SgInitializedName, etc.) However it is not set on SgTypes and SgSymbols,both of which are shared internally. This pointer is mostly set in post processing of the Sage III AST, until this point it is not reliable.

This is the pointer to the parent IR node. It is a valid pointer on all nodes that are traversed (SgExpressions, SgStatements, SgInitializedName, etc.) However it is not set on SgTypes and SgSymbols,both of which are shared internally. This pointer is mostly set in post processing of the Sage III AST, until this point it is not reliable.

Definition at line 10920 of file Cxx_Grammar.h.

SgNode::p_isModified

protected

Records if IR node has been modified (data members reset).

This is part of an internal mechanism that records if IR nodes have been modified, either by a transformation or a access function to set a value on the IR node. All access functions that set IR node data members are automatically generated (except the ones for this data member) and include code to set this boolean flag to true. This is also part of the support for copy based code generation where source file is copied except where the AST was modified an for these subtrees new code is generated from the AST.

Definition at line 10924 of file Cxx_Grammar.h.

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

Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Friends

Traversal Support

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation