Description

Definition at line 117625 of file Cxx_Grammar.h.

Inheritance diagram for SgNamedType:

[legend]

Collaboration diagram for SgNamedType:

[legend]

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

typedef SgType	base_node_type

Public Types inherited from SgType
enum	fortran_attribute_specifiers_enum { e_unknown_attribute_specifier = 0 , e_public_access , e_private_access , e_allocatable , e_asynchronous , e_bind , e_data , e_dimension , e_intent , e_optional , e_parameter , e_pointer , e_protected , e_save , e_target , e_value , e_volatile , e_last_attribute_specifier }

enum	{ static_variant = V_SgType }
	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

virtual SgName	get_name () const
	Gets name of the type (useful for debugging, unparsing, etc.)

	SgNamedType (const SgNamedType &X)

SgName	get_qualified_name () const
	Used for the SgNamedType object (base class for the SgClassType, SgTypedefType and the SgEnumType object)

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.

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

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

SgDeclarationStatement *	get_declaration () const

void	set_declaration (SgDeclarationStatement *declaration)

bool	get_autonomous_declaration () const

void	set_autonomous_declaration (bool autonomous_declaration)

bool	get_is_from_template_parameter () const

void	set_is_from_template_parameter (bool is_from_template_parameter)

	SgNamedType (SgDeclarationStatement *declaration=NULL)

Public Member Functions inherited from SgType
	SgType ()
	This is the constructor.

	SgType (const SgType &X)
	copy constructor

virtual SgName	get_mangled (void) const

virtual SgExpression *	get_type_kind () const

virtual void	set_type_kind (SgExpression *type_kind)

bool	isUnsignedType () const
	Compute numerical properties of type.

bool	isIntegerType () const
	There are many sorts of integer types (this queries an arbitrary type).

bool	isFloatType () const
	There are several sorts of float types (this queries an arbitrary type).

bool	isPrimativeType () const
	There are many sorts of primative types (this queries an arbitrary type).

bool	hasExplicitType ()
	Some types store internal SgType pointers explicitly while others compute them from other data. This function is true if it has a data member that is a type (pointer, array, etc.).

bool	containsInternalTypes ()
	Some types can hide other type IR nodes internally. This function is true if it can hide another type (pointer, array, etc.).

std::vector< SgType * >	getInternalTypes () const
	Generate a container of types hidden in the input type.

void	reset_base_type (SgType *baseType)
	Reset the base type. This function resets the base type. It is an error to call it for types where containsInternalTypes() == false.

SgType *	findBaseType () const
	Return the base type of the associated type. The base type is important when dealing with pointers, arrays, etc.

SgType *	dereference ()
	Returns type hidden behind pointer of reference.

const SgType *	dereference () const
	Returns type hidden behind pointer of reference.

SgType *	stripType (unsigned char bit_array=STRIP_MODIFIER_TYPE\|STRIP_REFERENCE_TYPE\|STRIP_RVALUE_REFERENCE_TYPE\|STRIP_POINTER_TYPE\|STRIP_ARRAY_TYPE\|STRIP_TYPEDEF_TYPE\|STRIP_POINTER_MEMBER_TYPE) const
	Returns hidden type beneath layers of typedefs, pointers, references, modifiers, array representation, etc.

SgType *	stripTypedefsAndModifiers () const
	This only strips away typedefs and modifiers (specialized usage).

SgDeclarationStatement *	getAssociatedDeclaration () const

bool	isEquivalentType (const SgType *other_type) const
	Type equivalence is the concept of equality between types independent of access permissions (e.g. private or protected types in a class).

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.

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.

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

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

bool	get_isCoArray () const

void	set_isCoArray (bool isCoArray)

int	get_substitutedForTemplateParam () const

void	set_substitutedForTemplateParam (int substitutedForTemplateParam)

SgReferenceType *	get_ref_to () const

void	set_ref_to (SgReferenceType *ref_to)

SgPointerType *	get_ptr_to () const

void	set_ptr_to (SgPointerType *ptr_to)

SgModifierNodes *	get_modifiers () const

void	set_modifiers (SgModifierNodes *modifiers)

SgTypedefSeq *	get_typedefs () const

void	set_typedefs (SgTypedefSeq *typedefs)

SgRvalueReferenceType *	get_rvalue_ref_to () const

void	set_rvalue_ref_to (SgRvalueReferenceType *rvalue_ref_to)

SgDeclType *	get_decltype_ref_to () const

void	set_decltype_ref_to (SgDeclType *decltype_ref_to)

SgTypeOfType *	get_typeof_ref_to () const

void	set_typeof_ref_to (SgTypeOfType *typeof_ref_to)

bool	get_hasTypeKindStar () const

void	set_hasTypeKindStar (bool hasTypeKindStar)

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.

virtual	~SgType ()
	This is the destructor.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

static std::string	getNodeIdStringInternal (SgNamedType *sgnode)

static SgNamedType *	createType (SgExpression *optional_fortran_type_kind=nullptr)
	example of type used where construction is particularly simple

Static Public Member Functions inherited from SgType
static SgType *	arithmetic_conversions (SgType , SgType )
	performs simple conversions

static SgType *	integer_promotion (SgType , SgType )
	handles promotion to integer

static SgType *	float_promotion (SgType , SgType )
	handles promotion to float

static bool	handledUsingLocalTable (SgType *t)

static SgScopeStatement *	getCurrentScope ()

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

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

static std::string	getNodeIdStringInternal (SgType *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 Attributes
SgDeclarationStatement *	p_declaration

bool	p_autonomous_declaration

bool	p_is_from_template_parameter

Protected Attributes inherited from SgType
bool	p_isCoArray

int	p_substitutedForTemplateParam
	This boolean variable marks if the current type was originally a template parameter.

SgReferenceType *	p_ref_to
	This holds the pointer to a SgReferenceType if this type is a reference to another type.

SgPointerType *	p_ptr_to
	This holds the pointer to a SgPointerType if this type is a pointer to another type.

SgModifierNodes *	p_modifiers
	This points to any SgModifierNodes if this type contains type modifiers.

SgTypedefSeq *	p_typedefs
	This points to IR node which holds a list of typedefs where the base_type if this SgType.

SgRvalueReferenceType *	p_rvalue_ref_to

SgDeclType *	p_decltype_ref_to

SgTypeOfType *	p_typeof_ref_to

SgExpression *	p_type_kind

bool	p_hasTypeKindStar

AstAttributeMechanism *	p_attributeMechanism

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.

Static Protected Attributes
static SgNamedType *	p_builtin_type

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

Additional Inherited Members
Static Public Attributes inherited from SgType
static const unsigned char	STRIP_MODIFIER_TYPE = ((unsigned char) 1 << 0)

static const unsigned char	STRIP_REFERENCE_TYPE = ((unsigned char) 1 << 1)

static const unsigned char	STRIP_RVALUE_REFERENCE_TYPE = ((unsigned char) 1 << 2)

static const unsigned char	STRIP_POINTER_TYPE = ((unsigned char) 1 << 3)

static const unsigned char	STRIP_ARRAY_TYPE = ((unsigned char) 1 << 4)

static const unsigned char	STRIP_TYPEDEF_TYPE = ((unsigned char) 1 << 5)

static const unsigned char	STRIP_POINTER_MEMBER_TYPE = ((unsigned char) 1 << 6)

Protected Member Functions inherited from SgType
SgName	mangledNameSupport (SgName &fname, SgUnparse_Info &info)

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

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

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

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

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.

Member Typedef Documentation

◆ base_node_type

typedef SgType SgNamedType::base_node_type

Definition at line 118058 of file Cxx_Grammar.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

static variant value

Definition at line 117679 of file Cxx_Grammar.h.

Member Function Documentation

◆ copy()

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

overridevirtual

Reimplemented from SgType.

◆ get_name()

virtual SgName SgNamedType::get_name ( ) const

virtual

Gets name of the type (useful for debugging, unparsing, etc.)

Avoid making abstract base classes (if we can) because in the automated generation of code we want to avoid placing constraints on derived classes.

Reimplemented in SgClassType, SgJavaParameterType, SgJovialTableType, SgEnumType, SgTypedefType, SgNonrealType, SgJavaParameterizedType, SgJavaQualifiedType, SgJavaWildcardType, SgAdaTaskType, SgAdaProtectedType, SgAdaFormalType, and SgAdaDiscriminatedType.

Referenced by SageInterface::get_name().

◆ class_name()

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

overridevirtual

returns a string representing the class name

Reimplemented from SgType.

Reimplemented in SgClassType, SgJavaParameterType, SgJovialTableType, SgEnumType, SgTypedefType, SgNonrealType, SgJavaParameterizedType, SgJavaQualifiedType, SgJavaWildcardType, SgAdaTaskType, SgAdaProtectedType, SgAdaFormalType, and SgAdaDiscriminatedType.

Referenced by SageBuilder::getTargetFileType(), and SageBuilder::getTargetFileTypeSupport().

◆ variantT()

virtual VariantT SgNamedType::variantT ( ) const

overridevirtual

returns new style SageIII enum values

Reimplemented from SgType.

Reimplemented in SgClassType, SgJavaParameterType, SgJovialTableType, SgEnumType, SgTypedefType, SgNonrealType, SgJavaParameterizedType, SgJavaQualifiedType, SgJavaWildcardType, SgAdaTaskType, SgAdaProtectedType, SgAdaFormalType, and SgAdaDiscriminatedType.

Referenced by SageBuilder::getTargetFileType(), and SageBuilder::getTargetFileTypeSupport().

◆ operator delete()

void SgNamedType::operator delete ( void * pointer )

inline

Definition at line 117734 of file Cxx_Grammar.h.

◆ get_traversalSuccessorContainer()

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

overridevirtual

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

Reimplemented from SgType.

Reimplemented in SgClassType, SgJavaParameterType, SgJovialTableType, SgEnumType, SgTypedefType, SgNonrealType, SgJavaParameterizedType, SgJavaQualifiedType, SgJavaWildcardType, SgAdaTaskType, SgAdaProtectedType, SgAdaFormalType, and SgAdaDiscriminatedType.

◆ get_traversalSuccessorNamesContainer()

virtual std::vector< std::string > SgNamedType::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 SgType.

Reimplemented in SgClassType, SgJavaParameterType, SgJovialTableType, SgEnumType, SgTypedefType, SgNonrealType, SgJavaParameterizedType, SgJavaQualifiedType, SgJavaWildcardType, SgAdaTaskType, SgAdaProtectedType, SgAdaFormalType, and SgAdaDiscriminatedType.

◆ get_numberOfTraversalSuccessors()

virtual size_t SgNamedType::get_numberOfTraversalSuccessors ( )

overridevirtual

return number of children in the traversal successor list

Reimplemented from SgType.

Reimplemented in SgClassType, SgJavaParameterType, SgJovialTableType, SgEnumType, SgTypedefType, SgNonrealType, SgJavaParameterizedType, SgJavaQualifiedType, SgJavaWildcardType, SgAdaTaskType, SgAdaProtectedType, SgAdaFormalType, and SgAdaDiscriminatedType.

◆ get_traversalSuccessorByIndex()

virtual SgNode * SgNamedType::get_traversalSuccessorByIndex ( size_t idx )

overridevirtual

index-based access to traversal successors by index number

Reimplemented from SgType.

Reimplemented in SgClassType, SgJavaParameterType, SgJovialTableType, SgEnumType, SgTypedefType, SgNonrealType, SgJavaParameterizedType, SgJavaQualifiedType, SgJavaWildcardType, SgAdaTaskType, SgAdaProtectedType, SgAdaFormalType, and SgAdaDiscriminatedType.

◆ get_childIndex()

virtual size_t SgNamedType::get_childIndex ( SgNode * child )

overridevirtual

index-based access to traversal successors by child node

Reimplemented from SgType.

Reimplemented in SgClassType, SgJavaParameterType, SgJovialTableType, SgEnumType, SgTypedefType, SgNonrealType, SgJavaParameterizedType, SgJavaQualifiedType, SgJavaWildcardType, SgAdaTaskType, SgAdaProtectedType, SgAdaFormalType, and SgAdaDiscriminatedType.

◆ roseRTI()

virtual RTIReturnType SgNamedType::roseRTI ( )

overridevirtual

return C++ Runtime-Time-Information

Reimplemented from SgType.

Reimplemented in SgClassType, SgJavaParameterType, SgJovialTableType, SgEnumType, SgTypedefType, SgNonrealType, SgJavaParameterizedType, SgJavaQualifiedType, SgJavaWildcardType, SgAdaTaskType, SgAdaProtectedType, SgAdaFormalType, and SgAdaDiscriminatedType.

◆ sage_class_name()

virtual const char * SgNamedType::sage_class_name ( ) const

overridevirtual

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

Reimplemented from SgType.

Reimplemented in SgClassType, SgJavaParameterType, SgJovialTableType, SgEnumType, SgTypedefType, SgNonrealType, SgJavaParameterizedType, SgJavaQualifiedType, SgJavaWildcardType, SgAdaTaskType, SgAdaProtectedType, SgAdaFormalType, and SgAdaDiscriminatedType.

◆ accept()

virtual void SgNamedType::accept ( ROSE_VisitorPattern & visitor )

overridevirtual

support for the classic visitor pattern done in GoF

Reimplemented from SgType.

Reimplemented in SgClassType, SgJavaParameterType, SgJovialTableType, SgEnumType, SgTypedefType, SgNonrealType, SgJavaParameterizedType, SgJavaQualifiedType, SgJavaWildcardType, SgAdaTaskType, SgAdaProtectedType, SgAdaFormalType, and SgAdaDiscriminatedType.

◆ isInMemoryPool()

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

Reimplemented in SgClassType, SgJavaParameterType, SgJovialTableType, SgEnumType, SgTypedefType, SgNonrealType, SgJavaParameterizedType, SgJavaQualifiedType, SgJavaWildcardType, SgAdaTaskType, SgAdaProtectedType, SgAdaFormalType, and SgAdaDiscriminatedType.

◆ checkDataMemberPointersIfInMemoryPool()

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

Reimplemented in SgClassType, SgJavaParameterType, SgJovialTableType, SgEnumType, SgTypedefType, SgNonrealType, SgJavaParameterizedType, SgJavaQualifiedType, SgJavaWildcardType, SgAdaTaskType, SgAdaProtectedType, SgAdaFormalType, and SgAdaDiscriminatedType.

◆ returnDataMemberPointers()

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

Reimplemented in SgClassType, SgJavaParameterType, SgJovialTableType, SgEnumType, SgTypedefType, SgNonrealType, SgJavaParameterizedType, SgJavaQualifiedType, SgJavaWildcardType, SgAdaTaskType, SgAdaProtectedType, SgAdaFormalType, and SgAdaDiscriminatedType.

◆ processDataMemberReferenceToPointers()

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

Reimplemented in SgClassType, SgJavaParameterType, SgJovialTableType, SgEnumType, SgTypedefType, SgNonrealType, SgJavaParameterizedType, SgJavaQualifiedType, SgJavaWildcardType, SgAdaTaskType, SgAdaProtectedType, SgAdaFormalType, and SgAdaDiscriminatedType.

◆ getChildIndex()

virtual long SgNamedType::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 SgType.

Reimplemented in SgClassType, SgJavaParameterType, SgJovialTableType, SgEnumType, SgTypedefType, SgNonrealType, SgJavaParameterizedType, SgJavaQualifiedType, SgJavaWildcardType, SgAdaTaskType, SgAdaProtectedType, SgAdaFormalType, and SgAdaDiscriminatedType.

◆ addRegExpAttribute()

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

◆ createType()

static SgNamedType * SgNamedType::createType ( SgExpression * optional_fortran_type_kind = nullptr )

static

example of type used where construction is particularly simple

function returns example of type

Member Data Documentation

◆ p_builtin_type

SgNamedType* SgNamedType::p_builtin_type

staticprotected

Definition at line 118097 of file Cxx_Grammar.h.

◆ p_declaration

SgDeclarationStatement* SgNamedType::p_declaration

protected

Definition at line 118101 of file Cxx_Grammar.h.

◆ p_autonomous_declaration

bool SgNamedType::p_autonomous_declaration

protected

Definition at line 118105 of file Cxx_Grammar.h.

◆ p_is_from_template_parameter

bool SgNamedType::p_is_from_template_parameter

protected

Definition at line 118109 of file Cxx_Grammar.h.

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

Cxx_Grammar.h

Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Member Typedef Documentation

◆ base_node_type

Member Enumeration Documentation

◆ anonymous enum

Member Function Documentation

◆ copy()

◆ get_name()

◆ 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()

◆ createType()

Member Data Documentation

◆ p_builtin_type

◆ p_declaration

◆ p_autonomous_declaration

◆ p_is_from_template_parameter