SgTemplateArgument Class Reference

This class represents template argument within the use of a template to build an instantiation. More...

#include <Cxx_Grammar.h>

Inheritance diagram for SgTemplateArgument:

Collaboration diagram for SgTemplateArgument:

Public Types
enum	template_argument_enum {   argument_undefined = 0,   type_argument = 1,   nontype_argument = 2,   template_template_argument = 3,   start_of_pack_expansion_argument = 4 }
enum	{ static_variant = V_SgTemplateArgument }
	static variant value More...
typedef SgSupport	base_node_type
Public Types inherited from SgSupport
enum	{ static_variant = V_SgSupport }
	static variant value More...
typedef SgNode	base_node_type
Public Types inherited from SgNode
enum	{ static_variant = V_SgNode }
	static variant value More...

Public Member Functions
virtual SgNode *	copy (SgCopyHelp &help) const
	This function clones the current IR node object recursively or not, depending on the argument. More...
void	post_construction_initialization ()
	Final initialization for constructors This function is called at the end of generated constructors to allow the specification writer to add special initialization functions or tests. Default is to do nothing. Otherwise it should be overridden in the spec file, in NewHeaderCode/NewOutlinedCode. More...
	SgTemplateArgument (SgType *parameter, bool explicitlySpecified)
	Constructor used with types. More...
	SgTemplateArgument (SgExpression *parameter, bool explicitlySpecified)
	Constructor used with expressions. More...
	SgTemplateArgument (SgTemplateDeclaration *parameter, bool explicitlySpecified)
	SgTemplateArgument (bool explicitlySpecified)
SgName	get_mangled_name (void) const
	Returns the template argument in mangled form. More...
SgScopeStatement *	get_scope () const
	Some template arguments have an associated scope (e.g. named types, and template template arguments) More...
virtual void	fixupCopy (SgNode *copy, SgCopyHelp &help) const
SgName	get_qualified_name_prefix () const
	This function generates the qualified name prefix to be used with the template argument type. More...
SgName	get_qualified_name_prefix_for_type () const
	This function generates the qualified name prefix to be used with the named declaration (only applied to restricted set of declarations where name qualification can be used). More...
virtual std::string	class_name () const
	Copies AST (whole subtree, depending on the SgCopyHelp class. More...
virtual VariantT	variantT () const
	returns new style SageIII enum values More...
void *	operator new (size_t size)
	returns pointer to newly allocated IR node More...
void	operator delete (void *pointer, size_t size)
	deallocated memory for IR node (returns memory to memory pool for reuse) More...
void	operator delete (void *pointer)
virtual std::vector< SgNode * >	get_traversalSuccessorContainer ()
	FOR INTERNAL USE within ROSE traverals mechanism only. More...
virtual std::vector< std::string >	get_traversalSuccessorNamesContainer ()
	FOR INTERNAL USE within ROSE traverals mechanism only. More...
virtual size_t	get_numberOfTraversalSuccessors ()
virtual SgNode *	get_traversalSuccessorByIndex (size_t idx)
virtual size_t	get_childIndex (SgNode *child)
virtual RTIReturnType	roseRTI ()
	FOR INTERNAL USE Access to Runtime Type Information (RTI) for this IR nodes. More...
virtual const char *	sage_class_name () const ROSE_DEPRECATED_FUNCTION
void	executeVisitorMemberFunction (ROSE_VisitorPattern &visitor)
	FOR INTERNAL USE Support for visitor pattern. More...
virtual void	accept (ROSE_VisitorPattern &visitor)
	DXN (08/09/2010): support for the classic visitor pattern done in GoF. More...
virtual bool	isInMemoryPool ()
	FOR INTERNAL USE This is used in internal tests to verify that all IR nodes are allocated from the heap. More...
virtual void	checkDataMemberPointersIfInMemoryPool ()
	FOR INTERNAL USE This is used in internal tests to verify that all IR nodes are allocated from the heap. More...
virtual std::vector< std::pair < SgNode *, std::string > >	returnDataMemberPointers () const
	FOR INTERNAL USE Returns STL vector of pairs of SgNode* and strings for use in AST tools More...
virtual void	processDataMemberReferenceToPointers (ReferenceToPointerHandler *)
	FOR INTERNAL USE Processes pairs of references to SgNode* and strings for use in AST tools More...
virtual long	getChildIndex (SgNode *childNode) const
	FOR INTERNAL USE Returns a unique index value for the childNode in the list of children at this IR node. More...
	SgTemplateArgument (const SgTemplateArgumentStorageClass &source)
SgTemplateArgument *	addRegExpAttribute (std::string s, AstRegExAttribute *a)
	Support for AST matching using regular expression. More...
SgTemplateArgument::template_argument_enum	get_argumentType () const
	This function returns argumentType. More...
void	set_argumentType (SgTemplateArgument::template_argument_enum argumentType)
	This function sets argumentType. More...
bool	get_isArrayBoundUnknownType () const
	This function returns isArrayBoundUnknownType. More...
void	set_isArrayBoundUnknownType (bool isArrayBoundUnknownType)
	This function sets isArrayBoundUnknownType. More...
SgType *	get_type () const
	This function returns argumentType. More...
void	set_type (SgType *type)
SgExpression *	get_expression () const
	This function returns argumentExpression. More...
void	set_expression (SgExpression *expression)
SgDeclarationStatement *	get_templateDeclaration () const
void	set_templateDeclaration (SgDeclarationStatement *templateDeclaration)
SgInitializedName *	get_initializedName () const
void	set_initializedName (SgInitializedName *initializedName)
bool	get_explicitlySpecified () const
	This function returns explicitlySpecified. More...
void	set_explicitlySpecified (bool explicitlySpecified)
	This function sets explicitlySpecified. More...
int	get_name_qualification_length () const
void	set_name_qualification_length (int name_qualification_length)
bool	get_type_elaboration_required () const
void	set_type_elaboration_required (bool type_elaboration_required)
bool	get_global_qualification_required () const
void	set_global_qualification_required (bool global_qualification_required)
bool	get_requiresGlobalNameQualificationOnType () const
void	set_requiresGlobalNameQualificationOnType (bool requiresGlobalNameQualificationOnType)
int	get_name_qualification_length_for_type () const
void	set_name_qualification_length_for_type (int name_qualification_length_for_type)
bool	get_type_elaboration_required_for_type () const
void	set_type_elaboration_required_for_type (bool type_elaboration_required_for_type)
bool	get_global_qualification_required_for_type () const
void	set_global_qualification_required_for_type (bool global_qualification_required_for_type)
virtual	~SgTemplateArgument ()
	This is the destructor. More...
	SgTemplateArgument (SgTemplateArgument::template_argument_enum argumentType=argument_undefined, bool isArrayBoundUnknownType=false, SgType *type=NULL, SgExpression *expression=NULL, SgDeclarationStatement *templateDeclaration=NULL, bool explicitlySpecified=true)
Public Member Functions inherited from SgSupport
void *	operator new (size_t size)
	returns pointer to newly allocated IR node More...
void	operator delete (void *pointer, size_t size)
	deallocated memory for IR node (returns memory to memory pool for reuse) More...
void	operator delete (void *pointer)
void	executeVisitorMemberFunction (ROSE_VisitorPattern &visitor)
	FOR INTERNAL USE Support for visitor pattern. More...
	SgSupport (const SgSupportStorageClass &source)
SgSupport *	addRegExpAttribute (std::string s, AstRegExAttribute *a)
	Support for AST matching using regular expression. More...
virtual	~SgSupport ()
	This is the destructor. More...
	SgSupport ()
	This is the constructor. More...
Public Member Functions inherited from SgNode
void *	operator new (size_t size)
	returns pointer to newly allocated IR node More...
void	operator delete (void *pointer, size_t size)
	deallocated memory for IR node (returns memory to memory pool for reuse) More...
void	operator delete (void *pointer)
void	executeVisitorMemberFunction (ROSE_VisitorPattern &visitor)
	FOR INTERNAL USE Support for visitor pattern. More...
	SgNode (const SgNodeStorageClass &source)
SgNode *	addRegExpAttribute (std::string s, AstRegExAttribute *a)
	Support for AST matching using regular expression. More...
void	set_isModified (bool isModified)
	All nodes in the AST contain a isModified flag used to track changes to the AST. More...
bool	get_isModified () const
	Acess function for isModified flag This flag records if the current IR node has been modified. It is set to false after and ROSE front-end processing. More...
void	set_parent (SgNode *parent)
	All nodes in the AST contain a reference to a parent node. More...
SgNode *	get_parent () const
	Access function for parent node. More...
bool	isChild (SgNode *node) const
	Query function for if the input IR nodes is a child of the current IR node. More...
virtual std::string	unparseToString (SgUnparse_Info *info) const
	This function unparses the AST node (excluding comments and unnecessary white space) More...
std::string	unparseToString () const
std::string	unparseToCompleteString ()
	This function unparses the AST node (including comments and white space) More...
int	variant () const ROSE_DEPRECATED_FUNCTION
	Older version function returns enum value "NODE". More...
virtual void	addNewAttribute (std::string s, AstAttribute *a)
	Add a new attribute represented by the named string. More...
virtual AstAttribute *	getAttribute (std::string s) const
	Returns attribute of name 's'. More...
virtual void	updateAttribute (std::string s, AstAttribute *a)
	Replace existing attribute of name 's' with new AstAttribute. More...
virtual void	setAttribute (std::string s, AstAttribute *a)
	This is a wrapper function with the following semantics: if no attribute of name 's' exists then addNewAttribute(s,a); is called, otherwise updateAttribute(s,a); is called. More...
virtual void	removeAttribute (std::string s)
	Remove attribute of name 's' if present. More...
virtual bool	attributeExists (std::string s) const
	Tests if attribute of name 's' is present. More...
virtual int	numberOfAttributes () const
	Returns the number of attributes on this IR node. More...
virtual AstAttributeMechanism *	get_attributeMechanism () const
	FOR INTERNAL USE Access function; if an attribute exists then a pointer to it is returned, else error. More...
virtual void	set_attributeMechanism (AstAttributeMechanism *a)
	FOR INTERNAL USE Access function; sets poiner to value AstAttributeMechanism. More...
virtual 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. More...
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). More...
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). More...
VirtualCFG::CFGNode	cfgForBeginning ()
	Returns the CFG node for just before this AST node. More...
VirtualCFG::CFGNode	cfgForEnd ()
	Returns the CFG node for just after this AST node. More...
virtual unsigned int	cfgIndexForEnd () const
	Determine the CFG index for the end of this construct. More...
virtual bool	cfgIsIndexInteresting (unsigned int index) const
	Determine whether a particular CFG node index is "interesting" for this kind of node. More...
virtual unsigned int	cfgFindChildIndex (SgNode *n)
	Find the index of n in this node's CFG children. More...
virtual unsigned int	cfgFindNextChildIndex (SgNode *n)
	Find the index just after n in this node's CFG children. More...
virtual std::vector < VirtualCFG::CFGEdge >	cfgOutEdges (unsigned int index=false)
	Find the out edges of a CFG node – internal version. More...
virtual std::vector < VirtualCFG::CFGEdge >	cfgInEdges (unsigned int index=false)
	Find the in edges of a CFG node – internal version. More...
int	numberOfNodesInSubtree ()
	Computes the number of nodes in the defined subtree of the AST. More...
int	depthOfSubtree ()
	Computes the depth of the current defined subtree of the AST. More...
SgNode *	get_freepointer () const
void	set_freepointer (SgNode *freepointer)
virtual	~SgNode ()
	This is the destructor. More...
	SgNode ()
	This is the constructor. More...
bool	get_isVisited () const ROSE_DEPRECATED_FUNCTION
	DOCS IN HEADER: Access function for p_isVisited flag used previously by the AST traversals. More...
void	set_isVisited (bool isVisited) ROSE_DEPRECATED_FUNCTION
	Access function for p_isVisited flag used previously by the AST traversals. More...

Static Public Member Functions
static bool	is_matching_type (const SgTemplateArgument &X, const SgTemplateArgument &Y)
static bool	is_matching_nontype (const SgTemplateArgument &X, const SgTemplateArgument &Y)
static bool	is_matching_template (const SgTemplateArgument &X, const SgTemplateArgument &Y)
static bool	is_matching_kind (const SgTemplateArgument &X, const SgTemplateArgument &Y)
static size_t	numberOfNodes ()
	Returns the total number of IR nodes of this type. More...
static size_t	memoryUsage ()
	Returns the size in bytes of the total memory allocated for all IR nodes of this type. More...
static void	traverseMemoryPoolNodes (ROSE_VisitTraversal &visit)
	FOR INTERNAL USE Support for visitor pattern. More...
static void	traverseMemoryPoolVisitorPattern (ROSE_VisitorPattern &visitor)
	FOR INTERNAL USE Support for visitor pattern. More...
static void	visitRepresentativeNode (ROSE_VisitTraversal &visit)
	FOR INTERNAL USE Support for type-based traversal. More...
Static Public Member Functions inherited from SgSupport
static size_t	numberOfNodes ()
	Returns the total number of IR nodes of this type. More...
static size_t	memoryUsage ()
	Returns the size in bytes of the total memory allocated for all IR nodes of this type. More...
static void	traverseMemoryPoolNodes (ROSE_VisitTraversal &visit)
	FOR INTERNAL USE Support for visitor pattern. More...
static void	traverseMemoryPoolVisitorPattern (ROSE_VisitorPattern &visitor)
	FOR INTERNAL USE Support for visitor pattern. More...
static void	visitRepresentativeNode (ROSE_VisitTraversal &visit)
	FOR INTERNAL USE Support for type-based traversal. More...
Static Public Member Functions inherited from SgNode
static size_t	numberOfNodes ()
	Returns the total number of IR nodes of this type. More...
static size_t	memoryUsage ()
	Returns the size in bytes of the total memory allocated for all IR nodes of this type. More...
static void	traverseMemoryPoolNodes (ROSE_VisitTraversal &visit)
	FOR INTERNAL USE Support for visitor pattern. More...
static void	traverseMemoryPoolVisitorPattern (ROSE_VisitorPattern &visitor)
	FOR INTERNAL USE Support for visitor pattern. More...
static void	visitRepresentativeNode (ROSE_VisitTraversal &visit)
	FOR INTERNAL USE Support for type-based traversal. More...
static std::vector< std::string >	buildCommandLineToSubstituteTransformationFile (const std::vector< std::string > &argv, std::string newFileName)
	Command line support for this compilation The command line is saved as a static variable so that it will be available to support the rewrite mechanism. More...
static std::vector< VariantT >	getClassHierarchySubTreeFunction (VariantT v)
static void	getClassHierarchySubTreeFunction (VariantT v, std::vector< VariantT > &)
static std::map< SgNode *, std::string > &	get_globalMangledNameMap ()
	Access function for performance optimizing global mangled name map. More...
static void	clearGlobalMangledNameMap ()
	Support to clear the performance optimizing global mangled name map. More...
static std::map< std::string, int > &	get_shortMangledNameCache ()
	Access function for lower level optimizing of global mangled name map. More...
static std::map< SgNode *, std::string > &	get_globalQualifiedNameMapForNames ()
	Access function for name qualification support (for names). More...
static void	set_globalQualifiedNameMapForNames (const std::map< SgNode *, std::string > &X)
	Access function for name qualification support (for names). More...
static std::map< SgNode *, std::string > &	get_globalQualifiedNameMapForTypes ()
	Access function for name qualification support (for type). More...
static void	set_globalQualifiedNameMapForTypes (const std::map< SgNode *, std::string > &X)
	Access function for name qualification support (for type). More...
static std::map< SgNode *, std::string > &	get_globalTypeNameMap ()
	Access function for name qualification support (for names of types). More...
static void	set_globalTypeNameMap (const std::map< SgNode *, std::string > &X)
	Access function for name qualification support (for names of types). More...
static SgFunctionTypeTable *	get_globalFunctionTypeTable ()
	Access function for symbol table specific to function types. More...
static void	set_globalFunctionTypeTable (SgFunctionTypeTable *globalFunctionTypeTable)
	Access function for symbol table specific to function types. More...
static SgTypeTable *	get_globalTypeTable ()
	Access function for symbol table specific to non-function types. More...
static void	set_globalTypeTable (SgTypeTable *globalTypeTable)
	Access function for symbol table specific to non-function types. More...

Protected Attributes
SgTemplateArgument::template_argument_enum	p_argumentType
bool	p_isArrayBoundUnknownType
	Template arguments can be used as array bounds, if so this this marks the arguments use as such. More...
SgType *	p_type
	This is the template argument's reference to a type (if it is a type). More...
SgExpression *	p_expression
	This is the template argument's reference to an expression (if it is an expression). More...
SgDeclarationStatement *	p_templateDeclaration
SgInitializedName *	p_initializedName
bool	p_explicitlySpecified
	This true only if for a function template the argument is explicit in the source code (it need not always be.) More...
int	p_name_qualification_length
bool	p_type_elaboration_required
bool	p_global_qualification_required
bool	p_requiresGlobalNameQualificationOnType
int	p_name_qualification_length_for_type
bool	p_type_elaboration_required_for_type
bool	p_global_qualification_required_for_type

Friends
class	AST_FILE_IO
class	SgTemplateArgumentStorageClass
class	AstSpecificDataManagingClass
class	AstSpecificDataManagingClassStorageClass
ROSE_DLL_API friend SgTemplateArgument *	isSgTemplateArgument (SgNode *s)
	Casts pointer from base class to derived class. More...
ROSE_DLL_API friend const SgTemplateArgument *	isSgTemplateArgument (const SgNode *s)
	Casts pointer from base class to derived class (for const pointers) More...
SgTemplateArgument *	SgTemplateArgument_getPointerFromGlobalIndex (unsigned long globalIndex)
	Constructor for use by AST File I/O Mechanism. More...
unsigned long	SgTemplateArgument_getNumberOfValidNodesAndSetGlobalIndexInFreepointer (unsigned long)
	Get the size of the memory pool. More...
void	SgTemplateArgument_clearMemoryPool ()
void	SgTemplateArgument_extendMemoryPoolForFileIO (unsigned long)
void	SgTemplateArgument_getNextValidPointer (std::pair< SgTemplateArgument *, std::vector< unsigned char * >::const_iterator > &)
void	SgTemplateArgument_resetValidFreepointers ()

Additional Inherited Members
Static Protected Attributes inherited from SgNode
static SgFunctionTypeTable *	p_globalFunctionTypeTable
	Pointer to symbol table specific to function types. More...
static SgTypeTable *	p_globalTypeTable
static std::map< SgNode *, std::string >	p_globalMangledNameMap
	Cache of mangled names to avoid regeneration of previously build mangled names or parts of mangled names. This is a performance optimization. More...
static std::map< std::string, int >	p_shortMangledNameCache
	STL map used as a cache to shorten generated mangled names. This is mostly a space optimization ofr mangled names of templates. More...
static std::map< SgNode *, std::string >	p_globalQualifiedNameMapForNames
static std::map< SgNode *, std::string >	p_globalQualifiedNameMapForTypes
static std::map< SgNode *, std::string >	p_globalTypeNameMap

Detailed Description

This class represents template argument within the use of a template to build an instantiation.

The template argument is used for the instatiation of templates.  They can also have
default values and not be specified explicitly.

Note that this is not the same as a template parameter, which appears in the template declaration as a placeholder for template argument in the declaration of the template.

Todo:

Move this be a SgLocatedNode since it should have a position in the source code.

See Also

Example of using a SgTemplateArgument object

Definition at line 28446 of file Cxx_Grammar.h.

Member Typedef Documentation

typedef SgSupport SgTemplateArgument::base_node_type

Definition at line 28850 of file Cxx_Grammar.h.

Member Enumeration Documentation

enum SgTemplateArgument::template_argument_enum

Different uses of a template argument

Enumerator
argument_undefined	undefined (error)
type_argument	type parameter
nontype_argument	nontype parameter
template_template_argument	template template parameter
start_of_pack_expansion_argument	start of pack expansion parameter

Definition at line 28460 of file Cxx_Grammar.h.

anonymous enum

static variant value

Enumerator
static_variant

Definition at line 28538 of file Cxx_Grammar.h.

Constructor & Destructor Documentation

SgTemplateArgument::SgTemplateArgument	(	SgType *	arg,
		bool	isExplicitlySpecified
	)

Constructor used with types.

See Also

Example:create an SgTemplateArgument object

SgTemplateArgument::SgTemplateArgument	(	SgExpression *	arg,
		bool	isExplicitlySpecified
	)

Constructor used with expressions.

See Also

Example:create an SgTemplateArgument object

SgTemplateArgument::SgTemplateArgument	(	SgTemplateDeclaration *	parameter,
		bool	explicitlySpecified
	)

SgTemplateArgument::SgTemplateArgument

(

bool

explicitlySpecified)

SgTemplateArgument::SgTemplateArgument

(

const SgTemplateArgumentStorageClass &

source)

SgTemplateArgument::~SgTemplateArgument ( )

virtual

This is the destructor.

There is nothing to delete in this object.

SgTemplateArgument::SgTemplateArgument	(	SgTemplateArgument::template_argument_enum	argumentType = argument_undefined,
		bool	isArrayBoundUnknownType = false,
		SgType *	type = NULL,
		SgExpression *	expression = NULL,
		SgDeclarationStatement *	templateDeclaration = NULL,
		bool	explicitlySpecified = true
	)

Member Function Documentation

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

virtual

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

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

Parameters

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

Returns

a pointer to the new clone.

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

Exceptions

none	No exceptions are thrown by this function.

Reimplemented from SgSupport.

void SgTemplateArgument::post_construction_initialization ( )

virtual

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.

SgName SgTemplateArgument::get_mangled_name

(

void

)

const

Returns the template argument in mangled form.

SgScopeStatement* SgTemplateArgument::get_scope

(

)

const

Some template arguments have an associated scope (e.g. named types, and template template arguments)

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

virtual

Reimplemented from SgNode.

SgName SgTemplateArgument::get_qualified_name_prefix

(

)

const

This function generates the qualified name prefix to be used with the template argument type.

SgName SgTemplateArgument::get_qualified_name_prefix_for_type

(

)

const

This function generates the qualified name prefix to be used with the named declaration (only applied to restricted set of declarations where name qualification can be used).

static bool SgTemplateArgument::is_matching_type ( const SgTemplateArgument &  X, const SgTemplateArgument &  Y  )

static

static bool SgTemplateArgument::is_matching_nontype ( const SgTemplateArgument &  X, const SgTemplateArgument &  Y  )

static

static bool SgTemplateArgument::is_matching_template ( const SgTemplateArgument &  X, const SgTemplateArgument &  Y  )

static

static bool SgTemplateArgument::is_matching_kind ( const SgTemplateArgument &  X, const SgTemplateArgument &  Y  )

static

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

virtual

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

returns a string representing the class name

Reimplemented from SgSupport.

virtual VariantT SgTemplateArgument::variantT ( ) const

virtual

returns new style SageIII enum values

Reimplemented from SgSupport.

void* SgTemplateArgument::operator new

(

size_t

size)

returns pointer to newly allocated IR node

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

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

void SgTemplateArgument::operator delete

(

void *

pointer)

static size_t SgTemplateArgument::numberOfNodes ( )

static

Returns the total number of IR nodes of this type.

static size_t SgTemplateArgument::memoryUsage ( )

static

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

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

virtual

FOR INTERNAL USE within ROSE traverals mechanism only.

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

Warning

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

Returns

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

Reimplemented from SgSupport.

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

virtual

FOR INTERNAL USE within ROSE traverals mechanism only.

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

Warning

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

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

Returns

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

Reimplemented from SgSupport.

virtual size_t SgTemplateArgument::get_numberOfTraversalSuccessors ( )

virtual

Reimplemented from SgSupport.

virtual SgNode* SgTemplateArgument::get_traversalSuccessorByIndex ( size_t  idx)

virtual

Reimplemented from SgSupport.

virtual size_t SgTemplateArgument::get_childIndex ( SgNode *  child)

virtual

Reimplemented from SgSupport.

virtual RTIReturnType SgTemplateArgument::roseRTI ( )

virtual

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

 This function provides runtime type information for accessing the

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

Returns

Returns a RTIReturnType object (runtime type information).

Reimplemented from SgSupport.

virtual const char* SgTemplateArgument::sage_class_name ( ) const

virtual

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

Reimplemented from SgSupport.

void SgTemplateArgument::executeVisitorMemberFunction

(

ROSE_VisitorPattern &

visitor)

FOR INTERNAL USE Support for visitor pattern.

virtual void SgTemplateArgument::accept ( ROSE_VisitorPattern &  visitor)

virtual

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

Reimplemented from SgSupport.

static void SgTemplateArgument::traverseMemoryPoolNodes ( ROSE_VisitTraversal &  visit)

static

FOR INTERNAL USE Support for visitor pattern.

static void SgTemplateArgument::traverseMemoryPoolVisitorPattern ( ROSE_VisitorPattern &  visitor)

static

FOR INTERNAL USE Support for visitor pattern.

static void SgTemplateArgument::visitRepresentativeNode ( ROSE_VisitTraversal &  visit)

static

FOR INTERNAL USE Support for type-based traversal.

virtual bool SgTemplateArgument::isInMemoryPool ( )

virtual

FOR INTERNAL USE This is used in internal tests to verify that all IR nodes are allocated from the heap.

The AST File I/O depends upon the allocation of IR nodes being from the heap, stack based or global IR nodes should not appear in the AST if it will be written out to a file and read back in. To enforce this concept, this function implements a test to verify that the IR node can be found on the heap and is part of a larger test of the whole AST. This test must pass before the AST can be written out to a file. This is part of a compromise in the design of the AST File I/O to support binary streaming of data to files; for performance. It is also rather difficult, but possible, to build a useful AST with IR nodes allocated on the stack or frm global scope, this test filters out such cased from being used with the AST File I/O mechanism.

Reimplemented from SgSupport.

virtual void SgTemplateArgument::checkDataMemberPointersIfInMemoryPool ( )

virtual

FOR INTERNAL USE This is used in internal tests to verify that all IR nodes are allocated from the heap.

The AST File I/O depends upon the allocation of IR nodes being from the heap, stack based or global IR nodes should not appear in the AST if it will be written out to a file and read back in. To enforce this concept, this function implements a test to verify that the IR node can be found on the heap and is part of a larger test of the whole AST. This test must pass before the AST can be written out to a file. This is part of a compromise in the design of the AST File I/O to support binary streaming of data to files; for performance. It is also rather difficult, but possible, to build a useful AST with IR nodes allocated on the stack or frm global scope, this test filters out such cased from being used with the AST File I/O mechanism.

Reimplemented from SgSupport.

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

virtual

FOR INTERNAL USE Returns STL vector of pairs of SgNode* and strings for use in AST tools

This functions is part of general support for many possible tools to operate on the AST. The forms a list of ALL IR node pointers used by each IR node, and is a supperset of the get_traversalSuccessorContainer(). It is (I think) less than the set of pointers used by the AST file I/O. This is part of work implemented by Andreas, and support tools such as the AST graph generation.

Warning

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

Returns

STL vector of pairs of SgNode* and strings

Reimplemented from SgSupport.

virtual void SgTemplateArgument::processDataMemberReferenceToPointers ( ReferenceToPointerHandler *  )

virtual

FOR INTERNAL USE Processes pairs of references to SgNode* and strings for use in AST tools

This functions similar to returnDataMemberPointers() except that it passes references to a handler object. As a result there is FAR more damage that can be done by using this function, but it is type-safe. This is provided for support of internal tools that operate on the AST, e.g the AST Merge mechanism.

Warning

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

Reimplemented from SgSupport.

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

virtual

FOR INTERNAL USE Returns a unique index value for the childNode in the list of children at this IR node.

This function returns a unique value for the input childNode in set of children at this IR node. Note that a negative value indicates that the input node is not a child. This is the basis for the implementation of the isChild(SgNode*) member function. Data members that are NULL in the IR node are counted internally (so that this function returns value that could be statically defined, and so are not dynamically determined).

Warning

The mapping on children to integer values could change from release to release of ROSE.

Returns

long

Reimplemented from SgSupport.

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

SgTemplateArgument::template_argument_enum SgTemplateArgument::get_argumentType

(

)

const

This function returns argumentType.

Returns

Returns SgTemplateArgument::template_argument_enum.

SgTemplateArgument::set_argumentType

(

SgTemplateArgument::template_argument_enum

argumentType)

This function sets argumentType.

Returns

Returns void.

bool SgTemplateArgument::get_isArrayBoundUnknownType

(

)

const

This function returns isArrayBoundUnknownType.

Returns

Returns bool.

SgTemplateArgument::set_isArrayBoundUnknownType

(

bool

isArrayBoundUnknownType)

This function sets isArrayBoundUnknownType.

Returns

Returns void.

SgType * SgTemplateArgument::get_type

(

)

const

This function returns argumentType.

Returns

Returns SgType pointer.

void SgTemplateArgument::set_type

(

SgType *

type)

SgExpression * SgTemplateArgument::get_expression

(

)

const

This function returns argumentExpression.

Returns

Returns SgExpression pointer.

void SgTemplateArgument::set_expression

(

SgExpression *

expression)

SgDeclarationStatement* SgTemplateArgument::get_templateDeclaration

(

)

const

void SgTemplateArgument::set_templateDeclaration

(

SgDeclarationStatement *

templateDeclaration)

SgInitializedName* SgTemplateArgument::get_initializedName

(

)

const

void SgTemplateArgument::set_initializedName

(

SgInitializedName *

initializedName)

bool SgTemplateArgument::get_explicitlySpecified

(

)

const

This function returns explicitlySpecified.

Returns

Returns bool.

SgTemplateArgument::set_explicitlySpecified

(

bool

explicitlySpecified)

This function sets explicitlySpecified.

Returns

Returns void.

int SgTemplateArgument::get_name_qualification_length

(

)

const

void SgTemplateArgument::set_name_qualification_length

(

int

name_qualification_length)

bool SgTemplateArgument::get_type_elaboration_required

(

)

const

void SgTemplateArgument::set_type_elaboration_required

(

bool

type_elaboration_required)

bool SgTemplateArgument::get_global_qualification_required

(

)

const

void SgTemplateArgument::set_global_qualification_required

(

bool

global_qualification_required)

bool SgTemplateArgument::get_requiresGlobalNameQualificationOnType

(

)

const

void SgTemplateArgument::set_requiresGlobalNameQualificationOnType

(

bool

requiresGlobalNameQualificationOnType)

int SgTemplateArgument::get_name_qualification_length_for_type

(

)

const

void SgTemplateArgument::set_name_qualification_length_for_type

(

int

name_qualification_length_for_type)

bool SgTemplateArgument::get_type_elaboration_required_for_type

(

)

const

void SgTemplateArgument::set_type_elaboration_required_for_type

(

bool

type_elaboration_required_for_type)

bool SgTemplateArgument::get_global_qualification_required_for_type

(

)

const

void SgTemplateArgument::set_global_qualification_required_for_type

(

bool

global_qualification_required_for_type)

Friends And Related Function Documentation

friend class AST_FILE_IO

friend

Definition at line 28809 of file Cxx_Grammar.h.

friend class SgTemplateArgumentStorageClass

friend

Definition at line 28810 of file Cxx_Grammar.h.

friend class AstSpecificDataManagingClass

friend

Definition at line 28811 of file Cxx_Grammar.h.

friend class AstSpecificDataManagingClassStorageClass

friend

Definition at line 28812 of file Cxx_Grammar.h.

SgTemplateArgument::isSgTemplateArgument ( SgNode *  s)

friend

Casts pointer from base class to derived class.

Cast function (from derived class to SgTemplateArgument pointer).

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

Returns

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

SgTemplateArgument::isSgTemplateArgument ( const SgNode *  s)

friend

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

Cast function (from derived class to SgTemplateArgument pointer).

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

Returns

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

SgTemplateArgument* SgTemplateArgument_getPointerFromGlobalIndex ( unsigned long  globalIndex)

friend

Constructor for use by AST File I/O Mechanism.

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

Typedef used for low level memory access.

Typedef used to hold memory addresses as values.

Methods to find the pointer to a global and local index

unsigned long SgTemplateArgument_getNumberOfValidNodesAndSetGlobalIndexInFreepointer ( unsigned  long)

friend

Get the size of the memory pool.

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

void SgTemplateArgument_clearMemoryPool ( )

friend

void SgTemplateArgument_extendMemoryPoolForFileIO ( unsigned  long)

friend

void SgTemplateArgument_getNextValidPointer ( std::pair< SgTemplateArgument *, std::vector< unsigned char * >::const_iterator > &  )

friend

void SgTemplateArgument_resetValidFreepointers ( )

friend

Member Data Documentation

SgTemplateArgument::template_argument_enum SgTemplateArgument::p_argumentType

protected

Definition at line 28921 of file Cxx_Grammar.h.

SgTemplateArgument::p_isArrayBoundUnknownType

protected

Template arguments can be used as array bounds, if so this this marks the arguments use as such.

Definition at line 28925 of file Cxx_Grammar.h.

SgTemplateArgument::p_type

protected

This is the template argument's reference to a type (if it is a type).

This pointer is valid if the argumentType is "type_argument".

Definition at line 28929 of file Cxx_Grammar.h.

SgTemplateArgument::p_expression

protected

This is the template argument's reference to an expression (if it is an expression).

This pointer is valid if the argumentType is "nontype_argument".

Definition at line 28933 of file Cxx_Grammar.h.

SgDeclarationStatement* SgTemplateArgument::p_templateDeclaration

protected

Definition at line 28937 of file Cxx_Grammar.h.

SgInitializedName* SgTemplateArgument::p_initializedName

protected

Definition at line 28941 of file Cxx_Grammar.h.

SgTemplateArgument::p_explicitlySpecified

protected

This true only if for a function template the argument is explicit in the source code (it need not always be.)

For template<typename T> void foo(T t); we could specify:

1. foo(1.0); or:
2. foo<float>(1.0); only in the second case is the template argument explicit. For all instantiated member function templates the value is false.

Definition at line 28945 of file Cxx_Grammar.h.

int SgTemplateArgument::p_name_qualification_length

protected

Definition at line 28949 of file Cxx_Grammar.h.

bool SgTemplateArgument::p_type_elaboration_required

protected

Definition at line 28953 of file Cxx_Grammar.h.

bool SgTemplateArgument::p_global_qualification_required

protected

Definition at line 28957 of file Cxx_Grammar.h.

bool SgTemplateArgument::p_requiresGlobalNameQualificationOnType

protected

Definition at line 28961 of file Cxx_Grammar.h.

int SgTemplateArgument::p_name_qualification_length_for_type

protected

Definition at line 28965 of file Cxx_Grammar.h.

bool SgTemplateArgument::p_type_elaboration_required_for_type

protected

Definition at line 28969 of file Cxx_Grammar.h.

bool SgTemplateArgument::p_global_qualification_required_for_type

protected

Definition at line 28973 of file Cxx_Grammar.h.

---

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

• Cxx_Grammar.h
• SgTemplateArgument.docs