This class represents the notion of an expression or statement which has a position within the source code. More...

#include <Cxx_Grammar.h>

Inheritance diagram for SgLocatedNode:

Collaboration diagram for SgLocatedNode:

Public Types
enum	{ static_variant = V_SgLocatedNode }
	static variant value More...

typedef SgNode	base_node_type

Public Types inherited from SgNode
enum	{ static_variant = V_SgNode }
	static variant value More...

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

const std::string &	getFilenameString () const

void	addToAttachedPreprocessingInfo (PreprocessingInfo *prepInfoPtr, PreprocessingInfo::RelativePositionType locationInList=PreprocessingInfo::after)
	This function adds comment or CPP directives to the current IR node. More...

virtual Sg_File_Info *	get_file_info () const
	Interface function to implement original SAGE interface to SgFile_Info objects. More...

virtual void	set_file_info (Sg_File_Info *X)
	Access function calls set_startingConstruct(Sg_File_Info*) member function. More...

void	setCompilerGenerated ()
	Allow IR nodes (mostly SgLocatedNode) to be marked as compiler generated. More...

void	unsetCompilerGenerated ()

void	setFrontendSpecific ()
	Allow IR nodes (mostly SgLocatedNode) to be marked as front-end specific (generated by the front-end to support a specific backend compiler; e.g. GNU gcc and g++). More...

void	unsetFrontendSpecific ()

void	setSourcePositionUnavailableInFrontend ()
	Allow IR nodes (mostly SgLocatedNode) to be marked as to when the information was unavilable in the front-end (even if it typically is there are special cases). More...

void	unsetSourcePositionUnavailableInFrontend ()

void	setOutputInCodeGeneration ()
	Allow IR nodes (mostly SgLocatedNode) to be marked as to when the information was unavilable in the front-end (even if it typically is there are special cases). More...

void	unsetOutputInCodeGeneration ()

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

AttachedPreprocessingInfoType *&	getAttachedPreprocessingInfo (void)
	Computes the number of nodes in the defined subtree of the AST. More...

Sg_File_Info *	generateMatchingFileInfo ()

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

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

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

virtual void	setAttribute (std::string s, AstAttribute *a)
	This is a wrapper function with the following semantics: if no attribute of name 's' exists then addNewAttribute(s,a); is called, otherwise updateAttribute(s,a); is called. More...

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

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

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

virtual std::string	class_name () const
	Copies AST (whole subtree, depending on the SgCopyHelp class. More...

virtual VariantT	variantT () const
	returns new style SageIII enum values More...

void *	operator new (size_t size)
	returns pointer to newly allocated IR node More...

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

void	operator delete (void *pointer)

virtual std::vector< SgNode * >	get_traversalSuccessorContainer ()
	FOR INTERNAL USE within ROSE traverals mechanism only. More...

virtual std::vector< std::string >	get_traversalSuccessorNamesContainer ()
	FOR INTERNAL USE within ROSE traverals mechanism only. More...

virtual size_t	get_numberOfTraversalSuccessors ()

virtual SgNode *	get_traversalSuccessorByIndex (size_t idx)

virtual size_t	get_childIndex (SgNode *child)

virtual RTIReturnType	roseRTI ()
	FOR INTERNAL USE Access to Runtime Type Information (RTI) for this IR nodes. More...

virtual const char *	sage_class_name () const ROSE_DEPRECATED_FUNCTION

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

virtual void	accept (ROSE_VisitorPattern &visitor)
	DXN (08/09/2010): support for the classic visitor pattern done in GoF. More...

virtual bool	isInMemoryPool ()
	FOR INTERNAL USE This is used in internal tests to verify that all IR nodes are allocated from the heap. More...

virtual void	checkDataMemberPointersIfInMemoryPool ()
	FOR INTERNAL USE This is used in internal tests to verify that all IR nodes are allocated from the heap. More...

virtual std::vector< std::pair < SgNode *, std::string > >	returnDataMemberPointers () const
	FOR INTERNAL USE Returns STL vector of pairs of SgNode* and strings for use in AST tools More...

virtual void	processDataMemberReferenceToPointers (ReferenceToPointerHandler *)
	FOR INTERNAL USE Processes pairs of references to SgNode* and strings for use in AST tools More...

virtual long	getChildIndex (SgNode *childNode) const
	FOR INTERNAL USE Returns a unique index value for the childNode in the list of children at this IR node. More...

	SgLocatedNode (const SgLocatedNodeStorageClass &source)

SgLocatedNode *	addRegExpAttribute (std::string s, AstRegExAttribute *a)
	Support for AST matching using regular expression. More...

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

void	set_startOfConstruct (Sg_File_Info *startOfConstruct)
	This function sets the current source location position of the start of the current construct. More...

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

void	set_endOfConstruct (Sg_File_Info *endOfConstruct)
	This function sets the current source location position of the end of the current construct. More...

AttachedPreprocessingInfoType *	get_attachedPreprocessingInfoPtr () const

void	set_attachedPreprocessingInfoPtr (AttachedPreprocessingInfoType *attachedPreprocessingInfoPtr)

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

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

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

	SgLocatedNode (Sg_File_Info *startOfConstruct=NULL)
	This is the constructor. More...

Public Member Functions inherited from SgNode
void *	operator new (size_t size)
	returns pointer to newly allocated IR node More...

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

void	operator delete (void *pointer)

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

	SgNode (const SgNodeStorageClass &source)

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

bool	get_isModified () const
	Acess function for isModified flag This flag records if the current IR node has been modified. It is set to false after and ROSE front-end processing. More...

void	set_parent (SgNode *parent)
	All nodes in the AST contain a reference to a parent node. More...

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

bool	isChild (SgNode *node) const
	Query function for if the input IR nodes is a child of the current IR node. More...

virtual std::string	unparseToString (SgUnparse_Info *info) const
	This function unparses the AST node (excluding comments and unnecessary white space) More...

std::string	unparseToString () const

std::string	unparseToCompleteString ()
	This function unparses the AST node (including comments and white space) More...

int	variant () const ROSE_DEPRECATED_FUNCTION
	Older version function returns enum value "NODE". More...

VirtualCFG::CFGNode	cfgForBeginning ()
	Returns the CFG node for just before this AST node. More...

VirtualCFG::CFGNode	cfgForEnd ()
	Returns the CFG node for just after this AST node. More...

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

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

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

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

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

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

int	numberOfNodesInSubtree ()
	Computes the number of nodes in the defined subtree of the AST. More...

int	depthOfSubtree ()
	Computes the depth of the current defined subtree of the AST. More...

SgNode *	get_freepointer () const

void	set_freepointer (SgNode *freepointer)

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

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

bool	get_isVisited () const ROSE_DEPRECATED_FUNCTION
	DOCS IN HEADER: Access function for p_isVisited flag used previously by the AST traversals. More...

void	set_isVisited (bool isVisited) ROSE_DEPRECATED_FUNCTION
	Access function for p_isVisited flag used previously by the AST traversals. More...

Static Public Member Functions
static size_t	numberOfNodes ()
	Returns the total number of IR nodes of this type. More...

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

static void	traverseMemoryPoolNodes (ROSE_VisitTraversal &visit)
	FOR INTERNAL USE Support for visitor pattern. More...

static void	traverseMemoryPoolVisitorPattern (ROSE_VisitorPattern &visitor)
	FOR INTERNAL USE Support for visitor pattern. More...

static void	visitRepresentativeNode (ROSE_VisitTraversal &visit)
	FOR INTERNAL USE Support for type-based traversal. More...

Static Public Member Functions inherited from SgNode
static size_t	numberOfNodes ()
	Returns the total number of IR nodes of this type. More...

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

static void	traverseMemoryPoolNodes (ROSE_VisitTraversal &visit)
	FOR INTERNAL USE Support for visitor pattern. More...

static void	traverseMemoryPoolVisitorPattern (ROSE_VisitorPattern &visitor)
	FOR INTERNAL USE Support for visitor pattern. More...

static void	visitRepresentativeNode (ROSE_VisitTraversal &visit)
	FOR INTERNAL USE Support for type-based traversal. More...

static std::vector< std::string >	buildCommandLineToSubstituteTransformationFile (const std::vector< std::string > &argv, std::string newFileName)
	Command line support for this compilation The command line is saved as a static variable so that it will be available to support the rewrite mechanism. More...

static std::vector< 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. More...

static std::map< std::string, int > &	get_shortMangledNameCache ()
	Access function for lower level optimizing of global mangled name map. More...

static std::map< SgNode *, std::string > &	get_globalQualifiedNameMapForNames ()
	Access function for name qualification support (for names). More...

static void	set_globalQualifiedNameMapForNames (const std::map< SgNode *, std::string > &X)
	Access function for name qualification support (for names). More...

static std::map< SgNode *, std::string > &	get_globalQualifiedNameMapForTypes ()
	Access function for name qualification support (for type). More...

static void	set_globalQualifiedNameMapForTypes (const std::map< SgNode *, std::string > &X)
	Access function for name qualification support (for type). More...

static std::map< SgNode *, std::string > &	get_globalTypeNameMap ()
	Access function for name qualification support (for names of types). More...

static void	set_globalTypeNameMap (const std::map< SgNode *, std::string > &X)
	Access function for name qualification support (for names of types). More...

static SgFunctionTypeTable *	get_globalFunctionTypeTable ()
	Access function for symbol table specific to function types. More...

static void	set_globalFunctionTypeTable (SgFunctionTypeTable *globalFunctionTypeTable)
	Access function for symbol table specific to function types. More...

static SgTypeTable *	get_globalTypeTable ()
	Access function for symbol table specific to non-function types. More...

static void	set_globalTypeTable (SgTypeTable *globalTypeTable)
	Access function for symbol table specific to non-function types. More...

Protected Member Functions
void	post_construction_initialization ()
	Final initialization for constructors This function is called at the end of generated constructors to allow the specification writer to add special initialization functions or tests. Default is to do nothing. Otherwise it should be overridden in the spec file, in NewHeaderCode/NewOutlinedCode. More...

Protected Attributes
Sg_File_Info *	p_startOfConstruct
	This pointer is always valid and stores the source position of the start of the current construct. More...

Sg_File_Info *	p_endOfConstruct
	This pointer is always valid and stores the source position of the end of the current construct. More...

AttachedPreprocessingInfoType *	p_attachedPreprocessingInfoPtr
	Holds comments and/or preprocessor directives located before or after the current statement of expression. More...

AstAttributeMechanism *	p_attributeMechanism

Protected Attributes inherited from SgNode
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...

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

Private Member Functions
	SgLocatedNode (const SgLocatedNode &X)
	Copy constructor (made private to prevent being called by accident). More...

Friends
class	AST_FILE_IO

class	SgLocatedNodeStorageClass

class	AstSpecificDataManagingClass

class	AstSpecificDataManagingClassStorageClass

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

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

SgLocatedNode *	SgLocatedNode_getPointerFromGlobalIndex (unsigned long globalIndex)
	Constructor for use by AST File I/O Mechanism. More...

unsigned long	SgLocatedNode_getNumberOfValidNodesAndSetGlobalIndexInFreepointer (unsigned long)
	Get the size of the memory pool. More...

void	SgLocatedNode_clearMemoryPool ()

void	SgLocatedNode_extendMemoryPoolForFileIO (unsigned long)

void	SgLocatedNode_getNextValidPointer (std::pair< SgLocatedNode , std::vector< unsigned char >::const_iterator > &)

void	SgLocatedNode_resetValidFreepointers ()

Additional Inherited Members
Static Protected Attributes inherited from SgNode
static SgFunctionTypeTable *	p_globalFunctionTypeTable
	Pointer to symbol table specific to function types. More...

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

static std::map< std::string, int >	p_shortMangledNameCache
	STL map used as a cache to shorten generated mangled names. This is mostly a space optimization ofr mangled names of templates. More...

static std::map< SgNode *, std::string >	p_globalQualifiedNameMapForNames

static std::map< SgNode *, std::string >	p_globalQualifiedNameMapForTypes

static std::map< SgNode *, std::string >	p_globalTypeNameMap

Detailed Description

This class represents the notion of an expression or statement which has a position within the source code.

There are no uses of this IR node anywhere.  All expressions and statements

are derived from this IR node to build either SgExpression or SgStatement derived classes.

Note: SgLocatedNode objects have a set_startOfConstruct() and a set_endOfConstruct() these must be set explicitly to define a proper AST. The set_startOfConstruct() will be called if the constructor taking a Sg_File_Info object is called (depreicated) but the set_endOfConstruct() should be called explicitly.

The AttachedPreprocessingInfoType *p_attachedPreprocessingInfoPtr and the AstAttributeMechanism *p_attribute are implemented as pointers because they would take up 12 bytes each as STL lists and that would be wasteful when we have 20 million IR nodes held in memory. This is a violation of general rule in the IR design that we have STL containers as data member instead of pointers to data members (the file I/O handles this as a special case).

Todo:: The AstAttributeMechanism type should be handed as other IR nodes with it's own memory pool, except that in all cases where it would be used, it would be a base class to a user-defined derived type and thus would not fix in our memory pool.

Todo:: Consider name change of "SgLocatedNode" to "SgSourceNode".

Todo:

Consider moving some of the IR nodes currently in SgSupport to this IR node. IR nodes that might be moved would include:

This is a base class for all expressions and statements.

See Also: Example of using a SgLocatedNode object

Definition at line 67104 of file Cxx_Grammar.h.

Member Typedef Documentation

typedef SgNode SgLocatedNode::base_node_type

Definition at line 67650 of file Cxx_Grammar.h.

Member Enumeration Documentation

anonymous enum

static variant value

Enumerator
static_variant

Definition at line 67338 of file Cxx_Grammar.h.

Constructor & Destructor Documentation

SgLocatedNode::SgLocatedNode ( const SgLocatedNode & X)

private

Copy constructor (made private to prevent being called by accident).

SgLocatedNode::SgLocatedNode ( const SgLocatedNodeStorageClass & source)

SgLocatedNode::~SgLocatedNode ( )

virtual

This is the destructor.

Only the Sg_File_Info object can be deleted in this object.

SgLocatedNode::SgLocatedNode ( Sg_File_Info * startOfConstruct = NULL)

This is the constructor.

This constructor builds the SgLocatedNode base class.

Parameters

startOfConstruct represents the position in the source code

See Also: Example:create an SgLocatedNode object

Member Function Documentation

virtual SgNode* SgLocatedNode::copy ( SgCopyHelp & help) const

virtual

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

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

Parameters

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

Returns: a pointer to the new clone.

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

Exceptions

none	No exceptions are thrown by this function.

Reimplemented from SgNode.

const std::string& SgLocatedNode::getFilenameString ( ) const

void SgLocatedNode::post_construction_initialization ( )

protectedvirtual

Final initialization for constructors This function is called at the end of generated constructors to allow the specification writer to add special initialization functions or tests. Default is to do nothing. Otherwise it should be overridden in the spec file, in NewHeaderCode/NewOutlinedCode.

Reimplemented from SgNode.

SgLocatedNode::addToAttachedPreprocessingInfo	(	PreprocessingInfo *	prepInfoPtr,
		PreprocessingInfo::RelativePositionType	locationInList = `PreprocessingInfo::after`
	)

This function adds comment or CPP directives to the current IR node.

Parameters

prepInfoPtr	- This parameter is a pointer to the container for the comment/directive. It is used to specify if the new new comment/directive is added to the front or back of the current list of comments/directives. It does not change relative position field of the PreprocessingInfo object.
locationInList	- adds container before or after the current IR node.

Returns: Returns void.

virtual Sg_File_Info* SgLocatedNode::get_file_info ( ) 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 SgNode.

Reimplemented in SgExpression.

Referenced by SageInterface::getEnclosingNode(), ssa_unfiltered_cfg::FunctionFilter::operator()(), ssa_private::FunctionFilter::operator()(), and yicesCheck().

virtual void SgLocatedNode::set_file_info ( Sg_File_Info * X)

virtual

Access function calls set_startingConstruct(Sg_File_Info*) member function.

Reimplemented in SgExpression.

void SgLocatedNode::setCompilerGenerated ( )

Allow IR nodes (mostly SgLocatedNode) to be marked as compiler generated.

Since the flag for isCompilerGenerated is stored in the Sg_File_Info, and because there are up to three of these for the source position information to be comprehensive, this function permits a mechanism to have them be set uniformally. Warnings are issued if they are not set uniformally.

This function marks the Sg_File_Info objects that must already be present.

void SgLocatedNode::unsetCompilerGenerated ( )

void SgLocatedNode::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++).

Since the flag for isFrontendSpecific is stored in the Sg_File_Info, and because there are up to three of these for the source position information to be comprehensive, this function permits a mechanism to have them be set uniformally. Warnings are issued if they are not set uniformally.

This function marks the Sg_File_Info objects that must already be present.

void SgLocatedNode::unsetFrontendSpecific ( )

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

Since the flag for isSourcePositionUnavailableInFrontend is stored in the Sg_File_Info, and because there are up to three of these for the source position information to be comprehensive, this function permits a mechanism to have them be set uniformally. Warnings are issued if they are not set uniformally.

This function marks the Sg_File_Info objects that must already be present.

void SgLocatedNode::unsetSourcePositionUnavailableInFrontend ( )

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

Since the flag for isOutputInCodeGeneration is stored in the Sg_File_Info, and because there are up to three of these for the source position information to be comprehensive, this function permits a mechanism to have them be set uniformally. Warnings are issued if they are not set uniformally.

This function marks the Sg_File_Info objects that must already be present.

void SgLocatedNode::unsetOutputInCodeGeneration ( )

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

virtual

Reimplemented from SgNode.

Reimplemented in SgExpression, SgCatchStatementSeq, SgForInitStatement, SgGotoStatement, SgDefaultOptionStmt, SgTryStmt, SgCaseOptionStmt, SgLabelStatement, SgExprStatement, SgTemplateInstantiationFunctionDecl, SgTemplateInstantiationMemberFunctionDecl, SgMemberFunctionDeclaration, SgFunctionDeclaration, SgTemplateInstantiationDecl, SgClassDeclaration, SgTypedefDeclaration, SgNamespaceDeclarationStatement, SgTemplateInstantiationDirectiveStatement, SgTemplateDeclaration, SgEnumDeclaration, SgVariableDeclaration, SgFunctionParameterList, SgDeclarationStatement, SgNamespaceDefinitionStatement, SgCatchOptionStmt, SgSwitchStatement, SgDoWhileStmt, SgWhileStmt, SgTemplateInstantiationDefn, SgClassDefinition, SgFunctionDefinition, SgForStatement, SgIfStmt, SgBasicBlock, SgGlobal, SgScopeStatement, SgStatement, and SgInitializedName.

SgLocatedNode::getAttachedPreprocessingInfo ( void )

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

This function gets the adds comment or CPP directives to the current IR node.

This function is used as a basis for steps in AST isomophism tests.

Parameters

prepInfoPtr	- This parameter is a pointer to the container for the comment/directive.
locationInList	- adds container before or after the current IR node.

Returns: Returns void.

Sg_File_Info* SgLocatedNode::generateMatchingFileInfo ( )

Referenced by New_File_Info().

virtual void SgLocatedNode::addNewAttribute	(	std::string	s,
		AstAttribute *	a
	)

virtual

Add a new attribute represented by the named string.

Reimplemented from SgNode.

Reimplemented in SgInitializedName.

virtual AstAttribute* SgLocatedNode::getAttribute ( std::string s) const

virtual

Returns attribute of name 's'.

Reimplemented from SgNode.

Reimplemented in SgInitializedName.

virtual void SgLocatedNode::updateAttribute	(	std::string	s,
		AstAttribute *	a
	)

virtual

Replace existing attribute of name 's' with new AstAttribute.

Reimplemented from SgNode.

Reimplemented in SgInitializedName.

virtual void SgLocatedNode::setAttribute	(	std::string	s,
		AstAttribute *	a
	)

virtual

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.

Reimplemented from SgNode.

Reimplemented in SgInitializedName.

virtual void SgLocatedNode::removeAttribute ( std::string s)

virtual

Remove attribute of name 's' if present.

Reimplemented from SgNode.

Reimplemented in SgInitializedName.

virtual bool SgLocatedNode::attributeExists ( std::string s) const

virtual

Tests if attribute of name 's' is present.

Reimplemented from SgNode.

Reimplemented in SgInitializedName.

virtual int SgLocatedNode::numberOfAttributes ( ) const

virtual

Returns the number of attributes on this IR node.

Reimplemented from SgNode.

Reimplemented in SgInitializedName.

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

virtual

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

returns a string representing the class name

Reimplemented from SgNode.

virtual VariantT SgLocatedNode::variantT ( ) const

virtual

returns new style SageIII enum values

Reimplemented from SgNode.

void* SgLocatedNode::operator new ( size_t size)

returns pointer to newly allocated IR node

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

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

void SgLocatedNode::operator delete ( void * pointer)

static size_t SgLocatedNode::numberOfNodes ( )

static

Returns the total number of IR nodes of this type.

static size_t SgLocatedNode::memoryUsage ( )

static

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

virtual std::vector<SgNode*> SgLocatedNode::get_traversalSuccessorContainer ( )

virtual

FOR INTERNAL USE within ROSE traverals mechanism only.

This function builds and returns a copy of ordered container holding pointers to children of this node in a traversal. It is associated with the definition of a tree that is travered by the AST traversal mechanism; a tree that is embeded in the AST (which is a more general graph). This function is used within the implementation of the AST traversal and has a semantics may change in subtle ways that makes it difficult to use in user code. It can return unexpected data members and thus the order and the number of elements is unpredicable and subject to change.

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

Returns: Returns ordered STL Container of pointers to children nodes in AST.

Reimplemented from SgNode.

virtual std::vector<std::string> SgLocatedNode::get_traversalSuccessorNamesContainer ( )

virtual

FOR INTERNAL USE within ROSE traverals mechanism only.

This function builds and returns a copy of ordered container holding strings used to name data members that are traversed in the IR node. It is associated with the definition of a tree that is travered by the AST traversal mechanism; a tree that is embeded in the AST (which is a more general graph). This function is used within the implementation of the AST traversal and has a semantics may change in subtle ways that makes it difficult to use in user code. It can return unexpected data members and thus the order and the number of elements is unpredicable and subject to change.

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

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

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

Reimplemented from SgNode.

virtual size_t SgLocatedNode::get_numberOfTraversalSuccessors ( )

virtual

Reimplemented from SgNode.

virtual SgNode* SgLocatedNode::get_traversalSuccessorByIndex ( size_t idx)

virtual

Reimplemented from SgNode.

virtual size_t SgLocatedNode::get_childIndex ( SgNode * child)

virtual

Reimplemented from SgNode.

virtual RTIReturnType SgLocatedNode::roseRTI ( )

virtual

FOR INTERNAL USE Access to Runtime Type Information (RTI) for this IR nodes.

 This function provides runtime type information for accessing the

structure of the current node. It is useful for generating code which would dump out or rebuild IR nodes.

Returns: Returns a RTIReturnType object (runtime type information).

Reimplemented from SgNode.

virtual const char* SgLocatedNode::sage_class_name ( ) const

virtual

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

Reimplemented from SgNode.

void SgLocatedNode::executeVisitorMemberFunction ( ROSE_VisitorPattern & visitor)

FOR INTERNAL USE Support for visitor pattern.

virtual void SgLocatedNode::accept ( ROSE_VisitorPattern & visitor)

virtual

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

Reimplemented from SgNode.

static void SgLocatedNode::traverseMemoryPoolNodes ( ROSE_VisitTraversal & visit)

static

FOR INTERNAL USE Support for visitor pattern.

static void SgLocatedNode::traverseMemoryPoolVisitorPattern ( ROSE_VisitorPattern & visitor)

static

FOR INTERNAL USE Support for visitor pattern.

static void SgLocatedNode::visitRepresentativeNode ( ROSE_VisitTraversal & visit)

static

FOR INTERNAL USE Support for type-based traversal.

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

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

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

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

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

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

Sg_File_Info* SgLocatedNode::get_startOfConstruct ( void ) const

virtual

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

Reimplemented from SgNode.

SgLocatedNode::set_startOfConstruct ( Sg_File_Info * startOfConstruct)

This function sets the current source location position of the start of the current construct.

Parameters

startOfConstruct - Pointer to Sg_File_Info object containing source location information.

Returns: Returns void.

Sg_File_Info* SgLocatedNode::get_endOfConstruct ( void ) const

virtual

New function interface for Sg_File_Info data stores ending location of contruct (typically the closing brace).

Reimplemented from SgNode.

SgLocatedNode::set_endOfConstruct ( Sg_File_Info * endOfConstruct)

This function sets the current source location position of the end of the current construct.

Parameters

endOfConstruct - Pointer to Sg_File_Info object containing source location information.

Returns: Returns void.

AttachedPreprocessingInfoType* SgLocatedNode::get_attachedPreprocessingInfoPtr ( ) const

void SgLocatedNode::set_attachedPreprocessingInfoPtr ( AttachedPreprocessingInfoType * attachedPreprocessingInfoPtr)

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

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

Friends And Related Function Documentation

friend class AST_FILE_IO

friend

Definition at line 67609 of file Cxx_Grammar.h.

friend class SgLocatedNodeStorageClass

friend

Definition at line 67610 of file Cxx_Grammar.h.

friend class AstSpecificDataManagingClass

friend

Definition at line 67611 of file Cxx_Grammar.h.

friend class AstSpecificDataManagingClassStorageClass

friend

Definition at line 67612 of file Cxx_Grammar.h.

SgLocatedNode::isSgLocatedNode ( SgNode * s)

friend

Casts pointer from base class to derived class.

Cast function (from derived class to SgLocatedNode pointer).

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

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

SgLocatedNode::isSgLocatedNode ( const SgNode * s)

friend

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

Cast function (from derived class to SgLocatedNode pointer).

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

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

SgLocatedNode* SgLocatedNode_getPointerFromGlobalIndex ( unsigned long globalIndex)

friend

Constructor for use by AST File I/O Mechanism.

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

Typedef used for low level memory access.

Typedef used to hold memory addresses as values.

Methods to find the pointer to a global and local index

unsigned long SgLocatedNode_getNumberOfValidNodesAndSetGlobalIndexInFreepointer ( unsigned long)

friend

Get the size of the memory pool.

It actually returns the size of the whole blocks allocated, no matter they contain valid pointers or not.

void SgLocatedNode_clearMemoryPool ( )

friend

void SgLocatedNode_extendMemoryPoolForFileIO ( unsigned long)

friend

void SgLocatedNode_getNextValidPointer ( std::pair< SgLocatedNode *, std::vector< unsigned char * >::const_iterator > & )

friend

void SgLocatedNode_resetValidFreepointers ( )

friend

Member Data Documentation

SgLocatedNode::p_startOfConstruct

protected

This pointer is always valid and stores the source position of the start of the current construct.

Definition at line 67681 of file Cxx_Grammar.h.

SgLocatedNode::p_endOfConstruct

protected

This pointer is always valid and stores the source position of the end of the current construct.

Definition at line 67685 of file Cxx_Grammar.h.

SgLocatedNode::p_attachedPreprocessingInfoPtr

protected

Holds comments and/or preprocessor directives located before or after the current statement of expression.

Definition at line 67689 of file Cxx_Grammar.h.

AstAttributeMechanism* SgLocatedNode::p_attributeMechanism

protected

Definition at line 67693 of file Cxx_Grammar.h.

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation