Description

Definition at line 7829 of file Cxx_Grammar.h.

Inheritance diagram for SgFunctionModifier:

Collaboration diagram for SgFunctionModifier:

[legend]

Classes
struct	opencl_work_group_size_t

Public Types
enum	function_modifier_enum { e_unknown = 0 , e_default = 1 , e_inline = 2 , e_virtual = 3 , e_pure_virtual = 4 , e_explicit = 5 , e_pure = 7 , e_elemental = 8 , e_recursive = 9 , e_gnu_attribute__constructor__ = 10 , e_gnu_attribute__destructor__ = 11 , e_gnu_attribute__pure__ = 12 , e_gnu_attribute__weak__ = 13 , e_gnu_attribute__unused__ = 14 , e_gnu_attribute__used__ = 15 , e_gnu_attribute__deprecated__ = 16 , e_gnu_attribute__malloc__ = 17 , e_gnu_attribute__naked__ = 18 , e_gnu_attribute__no_instrument_function__ = 19 , e_gnu_attribute__no_check_memory_usage__ = 20 , e_gnu_attribute__noinline__ = 21 , e_gnu_attribute__always_inline__ = 22 , e_gnu_attribute__nothrow__ = 23 , e_gnu_attribute__weakref__ = 24 , e_cuda_device = 25 , e_cuda_kernel = 26 , e_cuda_host = 27 , e_cuda_global_function = 28 , e_cuda_grid_global = 29 , e_opencl_kernel = 30 , e_opencl_vec_type_hint = 31 , e_opencl_work_group_size_hint = 32 , e_opencl_work_group_size_req = 33 , e_java_native = 34 , e_java_synchronized = 35 , e_java_strictfp = 36 , e_java_initializer = 37 , e_marked_default = 38 , e_marked_delete = 39 , e_reentrant = 40 , e_last_modifier }
	Function Modifiers (bitvector implementation permits multiple values to be specified) More...

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

typedef SgModifier	base_node_type

Public Types inherited from SgModifier
enum	{ static_variant = V_SgModifier }
	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...

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

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

	SgFunctionModifier (const SgFunctionModifier &X)

SgFunctionModifier &	operator= (const SgFunctionModifier &X)

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.

bool	isUnknown () const

void	setUnknown ()

void	unsetUnknown ()

bool	isDefault () const

void	setDefault ()

void	unsetDefault ()

bool	isInline () const

void	setInline ()

void	unsetInline ()

bool	isVirtual () const

void	setVirtual ()

void	unsetVirtual ()

bool	isPureVirtual () const

void	setPureVirtual ()

void	unsetPureVirtual ()

bool	isExplicit () const

void	setExplicit ()

void	unsetExplicit ()

bool	isPure () const

void	setPure ()

void	unsetPure ()

bool	isElemental () const

void	setElemental ()

void	unsetElemental ()

bool	isRecursive () const

void	setRecursive ()

void	unsetRecursive ()

bool	isReentrant () const

void	setReentrant ()

void	unsetReentrant ()

bool	isGnuAttributeConstructor () const

void	setGnuAttributeConstructor ()

void	unsetGnuAttributeConstructor ()

bool	isGnuAttributeDestructor () const

void	setGnuAttributeDestructor ()

void	unsetGnuAttributeDestructor ()

bool	isGnuAttributePure () const

void	setGnuAttributePure ()

void	unsetGnuAttributePure ()

bool	isGnuAttributeWeak () const

void	setGnuAttributeWeak ()

void	unsetGnuAttributeWeak ()

bool	isGnuAttributeUnused () const

void	setGnuAttributeUnused ()

void	unsetGnuAttributeUnused ()

bool	isGnuAttributeUsed () const

void	setGnuAttributeUsed ()

void	unsetGnuAttributeUsed ()

bool	isGnuAttributeDeprecated () const

void	setGnuAttributeDeprecated ()

void	unsetGnuAttributeDeprecated ()

bool	isGnuAttributeMalloc () const

void	setGnuAttributeMalloc ()

void	unsetGnuAttributeMalloc ()

bool	isGnuAttributeNaked () const

void	setGnuAttributeNaked ()

void	unsetGnuAttributeNaked ()

bool	isGnuAttributeNoInstrumentFunction () const

void	setGnuAttributeNoInstrumentFunction ()

void	unsetGnuAttributeNoInstrumentFunction ()

bool	isGnuAttributeNoCheckMemoryUsage () const

void	setGnuAttributeNoCheckMemoryUsage ()

void	unsetGnuAttributeNoCheckMemoryUsage ()

bool	isGnuAttributeNoInline () const

void	setGnuAttributeNoInline ()

void	unsetGnuAttributeNoInline ()

bool	isGnuAttributeAlwaysInline () const

void	setGnuAttributeAlwaysInline ()

void	unsetGnuAttributeAlwaysInline ()

bool	isGnuAttributeNoThrow () const

void	setGnuAttributeNoThrow ()

void	unsetGnuAttributeNoThrow ()

bool	isGnuAttributeWeakReference () const

void	setGnuAttributeWeakReference ()

void	unsetGnuAttributeWeakReference ()

bool	isCudaDevice () const

void	setCudaDevice ()

void	unsetCudaDevice ()

bool	isCudaKernel () const

void	setCudaKernel ()

void	unsetCudaKernel ()

bool	isCudaHost () const

void	setCudaHost ()

void	unsetCudaHost ()

bool	isCudaGlobalFunction () const

void	setCudaGlobalFunction ()

void	unsetCudaGlobalFunction ()

bool	isCudaGridGlobal () const

void	setCudaGridGlobal ()

void	unsetCudaGridGlobal ()

bool	isOpenclKernel () const

void	setOpenclKernel ()

void	unsetOpenclKernel ()

bool	hasOpenclVecTypeHint () const

void	setOpenclVecTypeHint ()

void	unsetOpenclVecTypeHint ()

bool	hasOpenclWorkGroupSizeHint () const

void	setOpenclWorkGroupSizeHint ()

void	unsetOpenclWorkGroupSizeHint ()

bool	hasOpenclWorkGroupSizeReq () const

void	setOpenclWorkGroupSizeReq ()

void	unsetOpenclWorkGroupSizeReq ()

bool	isJavaNative () const

void	setJavaNative ()

void	unsetJavaNative ()

bool	isJavaSynchronized () const

void	setJavaSynchronized ()

void	unsetJavaSynchronized ()

bool	isJavaStrictfp () const

void	setJavaStrictfp ()

void	unsetJavaStrictfp ()

bool	isJavaInitializer () const

void	setJavaInitializer ()

void	unsetJavaInitializer ()

bool	isMarkedDefault () const

void	setMarkedDefault ()

void	unsetMarkedDefault ()

bool	isMarkedDelete () const

void	setMarkedDelete ()

void	unsetMarkedDelete ()

std::string	displayString () const

void	display (std::string label) const

void	reset ()

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.

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

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

SgBitVector	get_modifierVector () const

void	set_modifierVector (SgBitVector modifierVector)

unsigned long int	get_gnu_attribute_constructor_destructor_priority () const

void	set_gnu_attribute_constructor_destructor_priority (unsigned long int gnu_attribute_constructor_destructor_priority)

std::string	get_gnu_attribute_named_weak_reference () const

void	set_gnu_attribute_named_weak_reference (std::string gnu_attribute_named_weak_reference)

std::string	get_gnu_attribute_named_alias () const

void	set_gnu_attribute_named_alias (std::string gnu_attribute_named_alias)

SgType *	get_opencl_vec_type () const

void	set_opencl_vec_type (SgType *opencl_vec_type)

SgFunctionModifier::opencl_work_group_size_t	get_opencl_work_group_size () const

void	set_opencl_work_group_size (SgFunctionModifier::opencl_work_group_size_t opencl_work_group_size)

Public Member Functions inherited from SgModifier
	SgModifier (const SgModifier &X)

SgModifier &	operator= (const SgModifier &X)
	This is the assignment operator.

bool	checkBit (unsigned int bit, const SgBitVector &bitVector) const
	This function returns the value of the bit in the STL vector<bool> object.

void	setBit (unsigned int bit, SgBitVector &bitVector) const
	This function sets the bit in the STL vector<bool> object (sets value to true).

void	unsetBit (unsigned int bit, SgBitVector &bitVector) const
	This function clears the bit in the STL vector<bool> object (sets value to false).

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.

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

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

virtual	~SgModifier ()
	This is the destructor.

	SgModifier ()
	This is the constructor.

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

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

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

virtual	~SgSupport ()
	This is the destructor.

	SgSupport ()
	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".

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

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

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

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

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

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

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

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

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

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	addNewAttribute (std::string s, AstAttribute *a)
	Add a new attribute represented by the named string.

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

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

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

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

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

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

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

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

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

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

static std::string	getNodeIdStringInternal (SgFunctionModifier *sgnode)

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

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

static std::string	getNodeIdStringInternal (SgModifier *sgnode)

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

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

static std::string	getNodeIdStringInternal (SgSupport *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
SgBitVector	p_modifierVector

unsigned long int	p_gnu_attribute_constructor_destructor_priority

std::string	p_gnu_attribute_named_weak_reference

std::string	p_gnu_attribute_named_alias

SgType *	p_opencl_vec_type

SgFunctionModifier::opencl_work_group_size_t	p_opencl_work_group_size

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

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 SgModifier SgFunctionModifier::base_node_type

Definition at line 8514 of file Cxx_Grammar.h.

Member Enumeration Documentation

◆ function_modifier_enum

enum SgFunctionModifier::function_modifier_enum

Function Modifiers (bitvector implementation permits multiple values to be specified)

Function modifiers (inline, virtual, pure-virtual, explicit).

Enumerator
e_unknown	error value
e_default	default value
e_inline	inlined function
e_virtual	virtual function
e_pure_virtual	pure virtual function
e_explicit	explicit function (avoids type resolution through auto type promotion of function arguments)
e_pure	Fortran pure attribute for functions (see also type modifier)
e_elemental	Fortran elemental attribute for functions (see also type modifier)
e_recursive	Fortran recursive attribute for functions (see also type modifier)
e_gnu_attribute__constructor__	GNU specific attribute for (GNU extension) (a separately stored value permits the priority to be specified).
e_gnu_attribute__destructor__	GNU specific attribute for (GNU extension)
e_gnu_attribute__pure__	GNU specific attribute for (GNU extension)
e_gnu_attribute__weak__	GNU specific attribute for (GNU extension)
e_gnu_attribute__unused__	GNU specific attribute for (GNU extension)
e_gnu_attribute__used__	GNU specific attribute for (GNU extension)
e_gnu_attribute__deprecated__	GNU specific attribute for (GNU extension)
e_gnu_attribute__malloc__	GNU specific attribute for (GNU extension)
e_gnu_attribute__naked__	GNU specific attribute for (GNU extension)
e_gnu_attribute__no_instrument_function__	GNU specific attribute for (GNU extension)
e_gnu_attribute__no_check_memory_usage__	GNU specific attribute for (GNU extension)
e_gnu_attribute__noinline__	GNU specific attribute for (GNU extension)
e_gnu_attribute__always_inline__	GNU specific attribute for (GNU extension)
e_gnu_attribute__nothrow__	GNU specific attribute for (GNU extension)
e_gnu_attribute__weakref__	GNU specific attribute for (GNU extension)
e_cuda_device	CUDA device function called from device
e_cuda_kernel	CUDA kernel
e_cuda_host	CUDA host function
e_cuda_global_function	CUDA device function called from host
e_cuda_grid_global	CUDA device function called from host
e_opencl_kernel	OpenCL kernel
e_opencl_vec_type_hint	OpenCL
e_opencl_work_group_size_hint	OpenCL
e_opencl_work_group_size_req	OpenCL
e_java_native	Java native keyword used for JNI function specification
e_java_synchronized	Java synchronized keyword used to only allow one thread at a time into a particular section of code
e_java_strictfp	Java strictfp keyword used to specify strict floating point evaluation by JVM
e_java_initializer	Java initializer keyword used to specify that this "synthetic" function is, in fact, an initializer block
e_marked_default	marked using "= default" syntax (different from default enum value)
e_marked_delete	marked using "= delete" syntax
e_reentrant	re-entrant function
e_last_modifier	last value (upper bound on range of values, used in error checking)

Definition at line 7847 of file Cxx_Grammar.h.

◆ anonymous enum

anonymous enum

static variant value

Definition at line 8135 of file Cxx_Grammar.h.

Member Function Documentation

◆ copy()

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

overridevirtual

Reimplemented from SgModifier.

◆ post_construction_initialization()

void SgFunctionModifier::post_construction_initialization ( )

overridevirtual

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.

◆ class_name()

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

overridevirtual

returns a string representing the class name

Reimplemented from SgModifier.

◆ variantT()

virtual VariantT SgFunctionModifier::variantT ( ) const

overridevirtual

returns new style SageIII enum values

Reimplemented from SgModifier.

◆ operator delete()

void SgFunctionModifier::operator delete ( void * pointer )

inline

Definition at line 8190 of file Cxx_Grammar.h.

◆ get_traversalSuccessorContainer()

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

overridevirtual

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

Reimplemented from SgModifier.

◆ get_traversalSuccessorNamesContainer()

virtual std::vector< std::string > SgFunctionModifier::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 SgModifier.

◆ get_numberOfTraversalSuccessors()

virtual size_t SgFunctionModifier::get_numberOfTraversalSuccessors ( )

overridevirtual

return number of children in the traversal successor list

Reimplemented from SgModifier.

◆ get_traversalSuccessorByIndex()

virtual SgNode * SgFunctionModifier::get_traversalSuccessorByIndex ( size_t idx )

overridevirtual

index-based access to traversal successors by index number

Reimplemented from SgModifier.

◆ get_childIndex()

virtual size_t SgFunctionModifier::get_childIndex ( SgNode * child )

overridevirtual

index-based access to traversal successors by child node

Reimplemented from SgModifier.

◆ roseRTI()

virtual RTIReturnType SgFunctionModifier::roseRTI ( )

overridevirtual

return C++ Runtime-Time-Information

Reimplemented from SgModifier.

◆ sage_class_name()

virtual const char * SgFunctionModifier::sage_class_name ( ) const

overridevirtual

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

Reimplemented from SgModifier.

◆ accept()

virtual void SgFunctionModifier::accept ( ROSE_VisitorPattern & visitor )

overridevirtual

support for the classic visitor pattern done in GoF

Reimplemented from SgModifier.

◆ isInMemoryPool()

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

◆ checkDataMemberPointersIfInMemoryPool()

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

◆ returnDataMemberPointers()

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

◆ processDataMemberReferenceToPointers()

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

◆ getChildIndex()

virtual long SgFunctionModifier::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 SgModifier.

◆ addRegExpAttribute()

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

Member Data Documentation

◆ p_modifierVector

SgBitVector SgFunctionModifier::p_modifierVector

protected

Definition at line 8553 of file Cxx_Grammar.h.

◆ p_gnu_attribute_constructor_destructor_priority

unsigned long int SgFunctionModifier::p_gnu_attribute_constructor_destructor_priority

protected

Definition at line 8557 of file Cxx_Grammar.h.

◆ p_gnu_attribute_named_weak_reference

std::string SgFunctionModifier::p_gnu_attribute_named_weak_reference

protected

Definition at line 8561 of file Cxx_Grammar.h.

◆ p_gnu_attribute_named_alias

std::string SgFunctionModifier::p_gnu_attribute_named_alias

protected

Definition at line 8565 of file Cxx_Grammar.h.

◆ p_opencl_vec_type

SgType* SgFunctionModifier::p_opencl_vec_type

protected

Definition at line 8569 of file Cxx_Grammar.h.

◆ p_opencl_work_group_size

SgFunctionModifier::opencl_work_group_size_t SgFunctionModifier::p_opencl_work_group_size

protected

Definition at line 8573 of file Cxx_Grammar.h.

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

Cxx_Grammar.h

Description

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Member Typedef Documentation

◆ base_node_type

Member Enumeration Documentation

◆ function_modifier_enum

◆ anonymous enum

Member Function Documentation

◆ copy()

◆ post_construction_initialization()

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

Member Data Documentation

◆ p_modifierVector

◆ p_gnu_attribute_constructor_destructor_priority

◆ p_gnu_attribute_named_weak_reference

◆ p_gnu_attribute_named_alias

◆ p_opencl_vec_type

◆ p_opencl_work_group_size