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.

Definition at line 169704 of file Cxx_Grammar.h.

Inheritance diagram for SgLocatedNode:

[legend]

Collaboration diagram for SgLocatedNode:

[legend]

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

enum	{ static_variant = V_SgNode }
	static variant value More...

Public Member Functions
virtual SgNode *	copy (SgCopyHelp &help) const override

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.

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.

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

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

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

void	unsetCompilerGenerated ()

bool	isCompilerGenerated () const
	Simple test for if this is a compiler generated node.

void	setTransformation ()
	Allow IR nodes (mostly SgLocatedNode) to be marked as a transformation.

void	unsetTransformation ()

bool	isTransformation () const
	Simple test for if this is a part of a transformation.

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

void	unsetFrontendSpecific ()

bool	isFrontendSpecific () const
	Simple test for if this is a frontend specific IR node.

void	setShared ()
	Allow IR nodes (mostly SgLocatedNode) to be marked as shared.

void	unsetShared ()

bool	isShared () const
	Simple test for if this is a shared IR node.

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

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

void	unsetOutputInCodeGeneration ()

bool	isOutputInCodeGeneration () const

int	get_physical_file_id ()
	Allow IR nodes (mostly SgLocatedNode) to be queried for there physical file ID.

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

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

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

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

Sg_File_Info *	generateMatchingFileInfo ()

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

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

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

virtual void	setAttribute (std::string s, AstAttribute *a) 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) override
	Remove attribute of name 's' if present.

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

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

virtual std::string	class_name () const override
	returns a string representing the class name

virtual VariantT	variantT () const 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)

void	operator delete (void *pointer)

virtual std::vector< SgNode * >	get_traversalSuccessorContainer () 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 () 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 () override
	return number of children in the traversal successor list

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

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

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

virtual const char *	sage_class_name () const override

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

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

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

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

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

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

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

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

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

Sg_File_Info *	get_startOfConstruct () const 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.

Sg_File_Info *	get_endOfConstruct () const 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.

AttachedPreprocessingInfoType *	get_attachedPreprocessingInfoPtr () const

void	set_attachedPreprocessingInfoPtr (AttachedPreprocessingInfoType *attachedPreprocessingInfoPtr)

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

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

bool	get_containsTransformationToSurroundingWhitespace () const

void	set_containsTransformationToSurroundingWhitespace (bool containsTransformationToSurroundingWhitespace)

virtual	~SgLocatedNode ()
	This is the destructor.

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

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	operator delete (void *pointer)

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.

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

void	set_isModified (bool isModified)
	All nodes in the AST contain a isModified flag used to track changes to the AST.

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.

bool	get_isModified () const
	Acess function for isModified flag.

bool	get_containsTransformation () const
	Acess function for containsTransformation flag.

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

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

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.

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

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

SgNode *	get_freepointer () const

void	set_freepointer (SgNode *freepointer)

virtual	~SgNode ()
	This is the destructor.

	SgNode ()
	This is the constructor.

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)

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.

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

void	set_isModified (bool isModified)
	All nodes in the AST contain a isModified flag used to track changes to the AST.

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.

bool	get_isModified () const
	Acess function for isModified flag.

bool	get_containsTransformation () const
	Acess function for containsTransformation flag.

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

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

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)

int	variant () const

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

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

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.

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

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

SgNode *	get_freepointer () const

void	set_freepointer (SgNode *freepointer)

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

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

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

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

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

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.

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.

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.

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.

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 SgLocatedNode *	getNodeByNodeIdInternal (size_t poolIdx, size_t itemIdx)
	FOR INTERNAL USE Find an SgNode from its memory pool and location therin.

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

static std::string	getNodeIdStringInternal (SgLocatedNode *sgnode)

Static Public Member Functions inherited from SgNode
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.

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.

static void	clearGlobalMangledNameMap ()
	Support to clear the performance optimizing global mangled name map.

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

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

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

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

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

static std::map< SgNode , std::map< SgNode , std::string > > &	get_globalQualifiedNameMapForMapsOfTypes ()
	Access function for name qualification support (for maps of types).

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

static std::map< SgNode *, std::string > &	get_globalQualifiedNameMapForTemplateHeaders ()
	Access function for name qualification support (for template headers in template declarations).

static void	set_globalQualifiedNameMapForTemplateHeaders (const std::map< SgNode *, std::string > &X)
	Access function for name qualification support (for template headers in template declarations).

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

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

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.

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.

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.

static void	clearGlobalMangledNameMap ()
	Support to clear the performance optimizing global mangled name map.

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

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

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

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

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

static std::map< SgNode , std::map< SgNode , std::string > > &	get_globalQualifiedNameMapForMapsOfTypes ()
	Access function for name qualification support (for maps of types).

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

static std::map< SgNode *, std::string > &	get_globalQualifiedNameMapForTemplateHeaders ()
	Access function for name qualification support (for template headers in template declarations).

static void	set_globalQualifiedNameMapForTemplateHeaders (const std::map< SgNode *, std::string > &X)
	Access function for name qualification support (for template headers in template declarations).

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

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

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.

Protected Member Functions
void	post_construction_initialization () 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.

Protected Member Functions inherited from SgNode
virtual void	destructorHelper ()
	This gets called by all Rosebud-generated destructors.

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

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

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

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

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

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

Sg_File_Info *	p_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
SgNode *	p_parent
	This is the pointer to the parent IR node in the AST.

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

bool	p_containsTransformation

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

Additional Inherited Members
Static Protected Attributes inherited from SgNode
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, uint64_t >	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

Member Typedef Documentation

◆ base_node_type

typedef SgNode SgLocatedNode::base_node_type

Definition at line 170374 of file Cxx_Grammar.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

static variant value

Definition at line 169995 of file Cxx_Grammar.h.

Constructor & Destructor Documentation

◆ ~SgLocatedNode()

SgLocatedNode::~SgLocatedNode ( )

virtual

This is the destructor.

Only the Sg_File_Info object can be deleted in this object.

◆ SgLocatedNode()

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

◆ copy()

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

overridevirtual

◆ post_construction_initialization()

void SgLocatedNode::post_construction_initialization ( )

overrideprotectedvirtual

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.

Reimplemented in SgStatement, SgScopeStatement, SgTemplateFunctionDefinition, SgTemplateInstantiationDefn, SgTemplateClassDefinition, SgWhileStmt, SgSwitchStatement, SgNamespaceDefinitionStatement, SgUpcForAllStatement, SgMatlabForStatement, SgRangeBasedForStatement, SgVariableDeclaration, SgTemplateVariableDeclaration, SgVariableDefinition, SgTemplateDeclaration, SgTemplateInstantiationDirectiveStatement, SgUseStatement, SgParameterStatement, SgNamespaceDeclarationStatement, SgNamespaceAliasDeclarationStatement, SgTypedefDeclaration, SgTemplateTypedefDeclaration, SgTemplateInstantiationTypedefDeclaration, SgStatementFunctionStatement, SgPragmaDeclaration, SgUsingDirectiveStatement, SgTemplateClassDeclaration, SgTemplateInstantiationDecl, SgModuleStatement, SgUsingDeclarationStatement, SgNamelistStatement, SgTemplateFunctionDeclaration, SgMemberFunctionDeclaration, SgTemplateMemberFunctionDeclaration, SgTemplateInstantiationMemberFunctionDecl, SgTemplateInstantiationFunctionDecl, SgProgramHeaderStatement, SgProcedureHeaderStatement, SgUndefDirectiveStatement, SgWarningDirectiveStatement, SgOmpThreadprivateStatement, SgStmtDeclarationStatement, SgStaticAssertionDeclaration, SgOmpDeclareSimdStatement, SgMicrosoftAttributeDeclaration, SgNonrealDecl, SgTryStmt, SgReturnStmt, SgSpawnStmt, SgNullStatement, SgVariantStatement, SgProcessControlStatement, SgPrintStatement, SgReadStatement, SgWriteStatement, SgOpenStatement, SgRewindStatement, SgWaitStatement, SgWhereStatement, SgNullifyStatement, SgUpcNotifyStatement, SgUpcWaitStatement, SgUpcBarrierStatement, SgUpcFenceStatement, SgOmpBarrierStatement, SgOmpTaskwaitStatement, SgOmpFlushStatement, SgOmpBodyStatement, SgOmpMasterStatement, SgOmpOrderedStatement, SgOmpCriticalStatement, SgOmpSectionStatement, SgOmpWorkshareStatement, SgOmpClauseBodyStatement, SgOmpParallelStatement, SgOmpSingleStatement, SgOmpAtomicStatement, SgOmpTaskStatement, SgOmpForStatement, SgOmpDoStatement, SgOmpSectionsStatement, SgOmpTargetStatement, SgOmpTargetDataStatement, SgOmpSimdStatement, SgOmpForSimdStatement, SgSequenceStatement, SgWithStatement, SgPythonPrintStmt, SgPassStatement, SgPythonGlobalStmt, SgWhenStmt, SgSyncAllStatement, SgSyncImagesStatement, SgSyncMemoryStatement, SgSyncTeamStatement, SgLockStatement, SgUnlockStatement, SgUnaryOp, SgMinusOp, SgUnaryAddOp, SgNotOp, SgPointerDerefExp, SgMinusMinusOp, SgPlusPlusOp, SgThrowOp, SgRealPartOp, SgUserDefinedUnaryOp, SgMatrixTransposeOp, SgNotEqualOp, SgSubtractOp, SgMultiplyOp, SgModOp, SgOrOp, SgLshiftOp, SgRshiftOp, SgPntrArrRefExp, SgScopeOp, SgPointerAssignOp, SgUserDefinedBinaryOp, SgPlusAssignOp, SgMinusAssignOp, SgMultAssignOp, SgModAssignOp, SgXorAssignOp, SgLshiftAssignOp, SgRshiftAssignOp, SgMembershipOp, SgSpaceshipOp, SgNonMembershipOp, SgPowerOp, SgRemOp, SgReplicationOp, SgTupleExp, SgMatrixExp, SgVarRefExp, SgMemberFunctionRefExp, SgValueExp, SgStringVal, SgShortVal, SgUnsignedCharVal, SgWcharVal, SgUnsignedShortVal, SgUnsignedIntVal, SgLongIntVal, SgLongLongIntVal, SgUnsignedLongLongIntVal, SgUnsignedLongVal, SgLongDoubleVal, SgUpcThreads, SgUpcMythread, SgTemplateParameterVal, SgNullptrValExp, SgVoidVal, SgSizeOfOp, SgUpcLocalsizeofExpression, SgUpcBlocksizeofExpression, SgUpcElemsizeofExpression, SgSuperExp, SgTypeIdOp, SgNewExp, SgThisExp, SgRefExp, SgVarArgStartOp, SgVarArgOp, SgVarArgEndOp, SgVarArgCopyOp, SgVarArgStartOneOperandOp, SgNullExpression, SgVariantExpression, SgSubscriptExpression, SgStatementExpression, SgUnknownArrayOrFunctionReference, SgPseudoDestructorRefExp, SgSetComprehension, SgNaryOp, SgNaryBooleanOp, SgNaryComparisonOp, SgStringConversion, SgYieldExpression, SgTemplateFunctionRefExp, SgTemplateMemberFunctionRefExp, SgRangeExp, SgMagicColonExp, SgTypeTraitBuiltinOperator, SgTypeExpression, SgNoexceptOp, and SgNonrealRefExp.

◆ addToAttachedPreprocessingInfo()

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.

Referenced by SageInterface::addMessageStatement(), SageInterface::appendStatementWithDependentDeclaration(), SageInterface::attachComment(), SageInterface::insertHeader(), SageInterface::insertHeader(), SageInterface::insertHeader(), SageInterface::insertHeader(), SageInterface::insertStatement(), SageInterface::moveCommentsToNewStatement(), SageInterface::movePreprocessingInfo(), and SageInterface::moveUpInnerDanglingIfEndifDirective().

◆ get_file_info()

virtual Sg_File_Info * SgLocatedNode::get_file_info ( ) const

overridevirtual

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::appendStatementWithDependentDeclaration(), SageBuilder::buildClassDeclaration_nfi(), SageInterface::buildForwardFunctionDeclaration(), SageInterface::buildFunctionPrototype(), SageBuilder::buildNamespaceDeclaration_nfi(), SageBuilder::buildNondefiningClassDeclaration_nfi(), SageBuilder::buildOpaqueType(), SageBuilder::buildOpaqueVarRefExp(), SageBuilder::buildVariableDefinition_nfi(), SageInterface::declarationPreceedsDefinition(), SageInterface::dumpInfo(), SageInterface::dumpPreprocInfo(), SageBuilder::findAssociatedDeclarationInTargetAST(), SageBuilder::findAssociatedSymbolInTargetAST(), SageInterface::findFirstDefiningFunctionDecl(), SageInterface::findSurroundingStatementFromSameFile(), SageBuilder::fixupCopyOfNodeFromSeparateFileInNewTargetAst(), SageInterface::functionCallExpressionPreceedsDeclarationWhichAssociatesScope(), SageInterface::getFirstStatement(), SageInterface::getLoopIndexVariable(), SageInterface::insertHeader(), SageInterface::insertHeader(), SageInterface::insideHeader(), SageInterface::insideSystemHeader(), SageInterface::markNodeToBeUnparsed(), SageInterface::moveCommentsToNewStatement(), SageInterface::outputFileIds(), SageInterface::rebuildSymbolTable(), SageInterface::replaceDefiningFunctionDeclarationWithFunctionPrototype(), SageInterface::resetInternalMapsForTargetStatement(), SageInterface::scopeHasStatementsFromSameFile(), and SageInterface::OutputLocalSymbolTables::visit().

◆ set_file_info()

virtual void SgLocatedNode::set_file_info ( Sg_File_Info * X )

virtual

Access function calls set_startingConstruct(Sg_File_Info*) member function.

Reimplemented in SgExpression.

◆ setCompilerGenerated()

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.

◆ isCompilerGenerated()

bool SgLocatedNode::isCompilerGenerated ( ) const

Simple test for if this is a compiler generated node.

This is a simpler interface to check the settings of this associated flag in the multiple Sg_File_Info objects.

◆ setTransformation()

void SgLocatedNode::setTransformation ( )

Allow IR nodes (mostly SgLocatedNode) to be marked as a transformation.

Since the flag for isTransformation 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.

Referenced by SageInterface::markNodeToBeUnparsed(), SageInterface::resetInternalMapsForTargetStatement(), and SageInterface::set_name().

◆ isTransformation()

bool SgLocatedNode::isTransformation ( ) const

Simple test for if this is a part of a transformation.

This is a simpler interface to check the settings of this associated flag in the multiple Sg_File_Info objects.

Referenced by SageInterface::collectTransformedStatements().

◆ setFrontendSpecific()

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.

◆ isFrontendSpecific()

bool SgLocatedNode::isFrontendSpecific ( ) const

Simple test for if this is a frontend specific IR node.

This is a simpler interface to check the settings of this associated flag in the multiple Sg_File_Info objects.

◆ setShared()

void SgLocatedNode::setShared ( )

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

Since the flag for isShared 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.

◆ isShared()

bool SgLocatedNode::isShared ( ) const

Simple test for if this is a shared IR node.

This is a simpler interface to check the settings of this associated flag in the multiple Sg_File_Info objects.

◆ setSourcePositionUnavailableInFrontend()

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.

◆ setOutputInCodeGeneration()

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.

Referenced by SageInterface::markNodeToBeUnparsed(), and SageInterface::resetInternalMapsForTargetStatement().

◆ get_physical_file_id()

int SgLocatedNode::get_physical_file_id ( )

Allow IR nodes (mostly SgLocatedNode) to be queried for there physical file ID.

Since the value for the physical_file_id 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 queried uniformally. Warnings are issued if they are not set uniformally.

◆ fixupCopy_scopes()

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

overridevirtual

Reimplemented from SgNode.

◆ fixupCopy_symbols()

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

overridevirtual

Reimplemented from SgNode.

◆ fixupCopy_references()

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

overridevirtual

Reimplemented from SgNode.

◆ getAttachedPreprocessingInfo()

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.

Referenced by SageInterface::buildFunctionPrototype(), SageInterface::dumpInfo(), SageInterface::dumpPreprocInfo(), SageInterface::eraseNullPreprocessingInfo(), SageInterface::findHeader(), SageInterface::insertHeader(), SageInterface::insertStatement(), SageInterface::moveCommentsToNewStatement(), SageInterface::movePreprocessingInfo(), SageInterface::moveUpInnerDanglingIfEndifDirective(), SageInterface::printOutComments(), SageInterface::removeStatement(), SageInterface::replaceDefiningFunctionDeclarationWithFunctionPrototype(), SageInterface::translateScopeToUseCppDeclarations(), SageInterface::translateStatementToUseCppDeclarations(), and CollectCppDirectivesTraversal::visit().

◆ addNewAttribute()

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

overridevirtual

Add a new attribute represented by the named string.

Reimplemented from SgNode.

Reimplemented in SgInitializedName.

Referenced by SageInterface::annotateExpressionsWithUniqueNames().

◆ getAttribute()

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

overridevirtual

Returns attribute of name 's'.

Reimplemented from SgNode.

Reimplemented in SgInitializedName.

Referenced by SageInterface::getEnclosingFileNode().

◆ updateAttribute()

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

overridevirtual

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

Reimplemented from SgNode.

Reimplemented in SgInitializedName.

◆ setAttribute()

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

overridevirtual

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.

◆ removeAttribute()

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

overridevirtual

Remove attribute of name 's' if present.

Reimplemented from SgNode.

Reimplemented in SgInitializedName.

◆ attributeExists()

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

overridevirtual

Tests if attribute of name 's' is present.

Reimplemented from SgNode.

Reimplemented in SgInitializedName.

◆ numberOfAttributes()

virtual int SgLocatedNode::numberOfAttributes ( ) const

overridevirtual

Returns the number of attributes on this IR node.

Reimplemented from SgNode.

Reimplemented in SgInitializedName.

◆ class_name()

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

overridevirtual

returns a string representing the class name

Reimplemented from SgNode.

Referenced by SageInterface::collectModifiedLocatedNodes(), SageInterface::dumpPreprocInfo(), SageBuilder::fixupSourcePositionFileSpecification(), SageInterface::insideHeader(), SageInterface::markNodeToBeUnparsed(), SageInterface::outputFileIds(), SageInterface::printOutComments(), and SageInterface::resetModifiedLocatedNodes().

◆ variantT()

virtual VariantT SgLocatedNode::variantT ( ) const

overridevirtual

returns new style SageIII enum values

Reimplemented from SgNode.

Referenced by SageInterface::isBodyStatement(), and SageInterface::makeSingleStatementBodyToBlock().

◆ operator delete()

void SgLocatedNode::operator delete ( void * pointer )

inline

Definition at line 170050 of file Cxx_Grammar.h.

◆ get_traversalSuccessorContainer()

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

overridevirtual

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

Reimplemented from SgNode.

◆ get_traversalSuccessorNamesContainer()

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

overridevirtual

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

Reimplemented from SgNode.

◆ get_numberOfTraversalSuccessors()

virtual size_t SgLocatedNode::get_numberOfTraversalSuccessors ( )

overridevirtual

return number of children in the traversal successor list

Reimplemented from SgNode.

◆ get_traversalSuccessorByIndex()

virtual SgNode * SgLocatedNode::get_traversalSuccessorByIndex ( size_t idx )

overridevirtual

index-based access to traversal successors by index number

Reimplemented from SgNode.

◆ get_childIndex()

virtual size_t SgLocatedNode::get_childIndex ( SgNode * child )

overridevirtual

index-based access to traversal successors by child node

Reimplemented from SgNode.

◆ roseRTI()

virtual RTIReturnType SgLocatedNode::roseRTI ( )

overridevirtual

return C++ Runtime-Time-Information

Reimplemented from SgNode.

◆ sage_class_name()

virtual const char * SgLocatedNode::sage_class_name ( ) const

overridevirtual

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

Reimplemented from SgNode.

Referenced by SageInterface::dumpPreprocInfo(), and CollectCppDirectivesTraversal::visit().

◆ accept()

virtual void SgLocatedNode::accept ( ROSE_VisitorPattern & visitor )

overridevirtual

support for the classic visitor pattern done in GoF

Reimplemented from SgNode.

◆ isInMemoryPool()

virtual bool SgLocatedNode::isInMemoryPool ( )

overridevirtual

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.

◆ checkDataMemberPointersIfInMemoryPool()

virtual void SgLocatedNode::checkDataMemberPointersIfInMemoryPool ( )

overridevirtual

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.

◆ returnDataMemberPointers()

virtual std::vector< std::pair< SgNode *, std::string > > SgLocatedNode::returnDataMemberPointers ( ) const

overridevirtual

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.

◆ processDataMemberReferenceToPointers()

virtual void SgLocatedNode::processDataMemberReferenceToPointers ( ReferenceToPointerHandler * )

overridevirtual

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.

◆ getChildIndex()

virtual long SgLocatedNode::getChildIndex ( SgNode * childNode ) const

overridevirtual

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.

◆ addRegExpAttribute()

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.

◆ get_startOfConstruct()

Sg_File_Info * SgLocatedNode::get_startOfConstruct ( void ) const

overridevirtual

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.

Referenced by SageInterface::addDefaultConstructorIfRequired(), SageBuilder::buildConstructorInitializer_nfi(), SageBuilder::buildDeclarationScope(), SageInterface::buildForwardFunctionDeclaration(), SageBuilder::buildNondefiningTemplateClassDeclaration_nfi(), SageBuilder::buildNonrealDecl(), SageBuilder::buildTemplateClassDeclaration_nfi(), SageBuilder::buildTryStmt(), SageBuilder::buildVariableDeclaration(), SageBuilder::fixupSharingSourcePosition(), SageBuilder::fixupSourcePositionFileSpecification(), SageInterface::insertHeader(), SageInterface::insertHeader(), SageInterface::replaceStatement(), SageInterface::setSourcePositionAsTransformation(), and SageInterface::setSourcePositionPointersToNull().

◆ set_startOfConstruct()

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.

Referenced by SageInterface::setSourcePositionAsTransformation(), and SageInterface::setSourcePositionPointersToNull().

◆ get_endOfConstruct()

Sg_File_Info * SgLocatedNode::get_endOfConstruct ( void ) const

overridevirtual

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

Reimplemented from SgNode.

Referenced by SageInterface::addDefaultConstructorIfRequired(), SageBuilder::buildDeclarationScope(), SageBuilder::buildNondefiningTemplateClassDeclaration_nfi(), SageBuilder::buildNonrealDecl(), SageBuilder::buildTemplateClassDeclaration_nfi(), SageBuilder::buildTryStmt(), SageBuilder::buildVariableDeclaration(), SageBuilder::buildVariableDefinition_nfi(), SageBuilder::fixupSharingSourcePosition(), SageBuilder::fixupSourcePositionFileSpecification(), SageInterface::insertHeader(), SageInterface::replaceStatement(), SageInterface::setSourcePositionAsTransformation(), and SageInterface::setSourcePositionPointersToNull().

◆ set_endOfConstruct()

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.

Referenced by SageBuilder::buildVariableDefinition_nfi(), SageInterface::setSourcePositionAsTransformation(), and SageInterface::setSourcePositionPointersToNull().

◆ get_attributeMechanism()

AstAttributeMechanism * SgLocatedNode::get_attributeMechanism ( ) const

overridevirtual

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.

◆ set_attributeMechanism()

void SgLocatedNode::set_attributeMechanism ( AstAttributeMechanism * a )

overridevirtual

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.

Member Data Documentation

◆ p_startOfConstruct

SgLocatedNode::p_startOfConstruct

protected

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

Definition at line 170409 of file Cxx_Grammar.h.

◆ p_endOfConstruct

SgLocatedNode::p_endOfConstruct

protected

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

Definition at line 170413 of file Cxx_Grammar.h.

◆ p_attachedPreprocessingInfoPtr

SgLocatedNode::p_attachedPreprocessingInfoPtr

protected

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

Definition at line 170417 of file Cxx_Grammar.h.

◆ p_attributeMechanism

AstAttributeMechanism* SgLocatedNode::p_attributeMechanism

protected

Definition at line 170421 of file Cxx_Grammar.h.

◆ p_containsTransformationToSurroundingWhitespace

bool SgLocatedNode::p_containsTransformationToSurroundingWhitespace

protected

Definition at line 170425 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

Additional Inherited Members

Member Typedef Documentation

◆ base_node_type

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ ~SgLocatedNode()

◆ SgLocatedNode()

Member Function Documentation

◆ copy()

◆ post_construction_initialization()

◆ addToAttachedPreprocessingInfo()

◆ get_file_info()

◆ set_file_info()

◆ setCompilerGenerated()

◆ isCompilerGenerated()

◆ setTransformation()

◆ isTransformation()

◆ setFrontendSpecific()

◆ isFrontendSpecific()

◆ setShared()

◆ isShared()

◆ setSourcePositionUnavailableInFrontend()

◆ setOutputInCodeGeneration()

◆ get_physical_file_id()

◆ fixupCopy_scopes()

◆ fixupCopy_symbols()

◆ fixupCopy_references()

◆ getAttachedPreprocessingInfo()

◆ addNewAttribute()

◆ getAttribute()

◆ updateAttribute()

◆ setAttribute()

◆ removeAttribute()

◆ attributeExists()

◆ numberOfAttributes()

◆ class_name()

◆ variantT()

◆ operator delete()

◆ get_traversalSuccessorContainer()

◆ get_traversalSuccessorNamesContainer()

◆ get_numberOfTraversalSuccessors()

◆ get_traversalSuccessorByIndex()

◆ get_childIndex()

◆ roseRTI()

◆ sage_class_name()

◆ accept()

◆ isInMemoryPool()

◆ checkDataMemberPointersIfInMemoryPool()

◆ returnDataMemberPointers()

◆ processDataMemberReferenceToPointers()

◆ getChildIndex()

◆ addRegExpAttribute()

◆ get_startOfConstruct()

◆ set_startOfConstruct()

◆ get_endOfConstruct()

◆ set_endOfConstruct()

◆ get_attributeMechanism()

◆ set_attributeMechanism()

Member Data Documentation

◆ p_startOfConstruct

◆ p_endOfConstruct

◆ p_attachedPreprocessingInfoPtr

◆ p_attributeMechanism

◆ p_containsTransformationToSurroundingWhitespace