This class represents modifiers specific to storage. More...

#include <Cxx_Grammar.h>

Inheritance diagram for SgStorageModifier:

Collaboration diagram for SgStorageModifier:

Public Types
enum	storage_modifier_enum { e_unknown = 0, e_default = 1, e_extern = 2, e_static = 3, e_auto = 4, e_unspecified = 5, e_register = 6, e_mutable = 7, e_typedef = 8, e_asm = 9, e_cuda_global = 15, e_cuda_constant = 16, e_cuda_shared = 17, e_cuda_dynamic_shared = 18, e_last_modifier }
	Storage Modifiers (only one value can be specified) More...

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

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

	SgStorageModifier (const SgStorageModifier &X)

SgStorageModifier &	operator= (const SgStorageModifier &X)
	This is the assignment operator. 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...

bool	isUnknown () const
	Storage modifier is unknown (not set). More...

void	setUnknown ()
	Set storage. More...

bool	isDefault () const
	Storage modifier is default (default value). More...

void	setDefault ()
	Set storage. More...

bool	isExtern () const
	Storage modifier is extern (not the same as extern "C"). More...

void	setExtern ()
	Set storage. More...

bool	isStatic () const
	Storage modifier is static (always false for the SgStorageModifier in the SgInitializedName). More...

void	setStatic ()
	Set storage. More...

bool	isAuto () const
	Storage modifier is auto (most common setting for variables). More...

void	setAuto ()
	Set storage. More...

bool	isUnspecified () const
	Storage modifier is not specified (I think this is not used). More...

void	setUnspecified ()
	Set storage. More...

bool	isRegister () const
	Storage modifier is register. More...

void	setRegister ()
	Set storage. More...

bool	isMutable () const
	Storage modifier is mutable (C++ only). More...

void	setMutable ()
	Set storage. More...

bool	isTypedef () const
	Storage modifier is a typedef. More...

void	setTypedef ()
	Set storage. More...

bool	isAsm () const
	Storage modifier is an assembler statement. More...

void	setAsm ()
	Set storage. More...

bool	isCudaGlobal () const

void	setCudaGlobal ()

bool	isCudaConstant () const

void	setCudaConstant ()

bool	isCudaShared () const

void	setCudaShared ()

bool	isCudaDynamicShared () const

void	setCudaDynamicShared ()

std::string	displayString () const

void	display (std::string label) const

void	reset ()

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

	SgStorageModifier (const SgStorageModifierStorageClass &source)

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

SgStorageModifier::storage_modifier_enum	get_modifier () const

void	set_modifier (SgStorageModifier::storage_modifier_enum modifier)

bool	get_thread_local_storage () const

void	set_thread_local_storage (bool thread_local_storage)

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

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

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

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

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

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

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

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

	SgModifier (const SgModifierStorageClass &source)

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

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

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

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 void	fixupCopy (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. 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 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 SgModifier
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
SgStorageModifier::storage_modifier_enum	p_modifier

bool	p_thread_local_storage

Friends
class	AST_FILE_IO

class	SgStorageModifierStorageClass

class	AstSpecificDataManagingClass

class	AstSpecificDataManagingClassStorageClass

std::ostream &	operator<< (std::ostream &os, const SgStorageModifier &m)

bool	operator== (const SgStorageModifier &lhs, const SgStorageModifier &rhs)

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

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

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

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

void	SgStorageModifier_clearMemoryPool ()

void	SgStorageModifier_extendMemoryPoolForFileIO (unsigned long)

void	SgStorageModifier_getNextValidPointer (std::pair< SgStorageModifier , std::vector< unsigned char >::const_iterator > &)

void	SgStorageModifier_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 modifiers specific to storage.

This modifier is set to only one of a collection of values. To

unset any value (e.g. "extern") just call "setDefault()" to restore the default value.

Note: For more detail see the C++ grammar specification in Bjarne's book, Appendix B.

See Also: Example of using a SgStorageModifier object

Definition at line 10586 of file Cxx_Grammar.h.

Member Typedef Documentation

typedef SgModifier SgStorageModifier::base_node_type

Definition at line 11063 of file Cxx_Grammar.h.

Member Enumeration Documentation

enum SgStorageModifier::storage_modifier_enum

Storage Modifiers (only one value can be specified)

Storage modifiers are used to specify location or properties of declarations. For example, static variables in functions are stored in global scope, register variables are a hint to store the value in a CPU register (mosty ignored by modern compilers).

Only one value can be specified (at least in C and C++)

Enumerator
e_unknown	error value
e_default	default value
e_extern	extern storage modifier
e_static	static storage modifier
e_auto	auto storage value
e_unspecified	previous (old) default value, not included in C++ grammar definition of storage modifier
e_register	register storage modifier
e_mutable	mutable storage modifier
e_typedef	not used, not included in C++ grammar definition of storage modifier
e_asm	not used, not included in C++ grammar definition of storage modifier
e_cuda_global	CUDA, in device's global memory
e_cuda_constant	CUDA, in device's constant memory
e_cuda_shared	CUDA, in device's shared memory
e_cuda_dynamic_shared	CUDA, in device's shared memory, dynamically allocated
e_last_modifier	last value (upper bound on range of values, used in error checking)

Definition at line 10612 of file Cxx_Grammar.h.

anonymous enum

static variant value

Enumerator
static_variant

Definition at line 10751 of file Cxx_Grammar.h.

Constructor & Destructor Documentation

SgStorageModifier::SgStorageModifier ( const SgStorageModifier & X)

SgStorageModifier::SgStorageModifier ( const SgStorageModifierStorageClass & source)

SgStorageModifier::~SgStorageModifier ( )

virtual

This is the destructor.

There is nothing to delete in this object.

SgStorageModifier::SgStorageModifier ( )

This is the constructor.

This constructor builds the SgStorageModifier base class.

See Also: Example:create an SgStorageModifier object

Member Function Documentation

virtual SgNode* SgStorageModifier::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 SgModifier.

SgStorageModifier::operator= ( const SgStorageModifier & X)

This is the assignment operator.

This is a simple assignment of the SgBitVector from X to the current object.

void SgStorageModifier::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.

SgStorageModifier::isUnknown ( ) const

Storage modifier is unknown (not set).

Returns: Returns bool.

SgStorageModifier::setUnknown ( )

Set storage.

Returns: Returns bool.

SgStorageModifier::isDefault ( ) const

Storage modifier is default (default value).

Returns: Returns bool.

SgStorageModifier::setDefault ( )

Set storage.

Returns: Returns bool.

SgStorageModifier::isExtern ( ) const

Storage modifier is extern (not the same as extern "C").

Returns: Returns bool.

SgStorageModifier::setExtern ( )

Set storage.

Returns: Returns bool.

SgStorageModifier::isStatic ( ) const

Storage modifier is static (always false for the SgStorageModifier in the SgInitializedName).

Note that the isStatic() for variable declarations is stored in the SgStorageModifier of theSgDeclarationModifier in the SgVariableDeclaration, and not in the SgStorageModifier stored in the SgInitializedName. This is a result of the structure of code, where the static keyword can not be used to selectively apply to individual variables in a list of names in a variable declaration.

Returns: Returns bool.

SgStorageModifier::setStatic ( )

Set storage.

Returns: Returns bool.

SgStorageModifier::isAuto ( ) const

Storage modifier is auto (most common setting for variables).

Returns: Returns bool.

SgStorageModifier::setAuto ( )

Set storage.

Returns: Returns bool.

SgStorageModifier::isUnspecified ( ) const

Storage modifier is not specified (I think this is not used).

Returns: Returns bool.

SgStorageModifier::setUnspecified ( )

Set storage.

Returns: Returns bool.

SgStorageModifier::isRegister ( ) const

Storage modifier is register.

Returns: Returns bool.

SgStorageModifier::setRegister ( )

Set storage.

Returns: Returns bool.

SgStorageModifier::isMutable ( ) const

Storage modifier is mutable (C++ only).

Returns: Returns bool.

SgStorageModifier::setMutable ( )

Set storage.

Returns: Returns bool.

SgStorageModifier::isTypedef ( ) const

Storage modifier is a typedef.

Returns: Returns bool.

SgStorageModifier::setTypedef ( )

Set storage.

Returns: Returns bool.

SgStorageModifier::isAsm ( ) const

Storage modifier is an assembler statement.

Returns: Returns bool.

SgStorageModifier::setAsm ( )

Set storage.

Returns: Returns bool.

bool SgStorageModifier::isCudaGlobal ( ) const

void SgStorageModifier::setCudaGlobal ( )

bool SgStorageModifier::isCudaConstant ( ) const

void SgStorageModifier::setCudaConstant ( )

bool SgStorageModifier::isCudaShared ( ) const

void SgStorageModifier::setCudaShared ( )

bool SgStorageModifier::isCudaDynamicShared ( ) const

void SgStorageModifier::setCudaDynamicShared ( )

std::string SgStorageModifier::displayString ( ) const

Referenced by toStringForRTI().

void SgStorageModifier::display ( std::string label) const

void SgStorageModifier::reset ( )

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

virtual

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

returns a string representing the class name

Reimplemented from SgModifier.

virtual VariantT SgStorageModifier::variantT ( ) const

virtual

returns new style SageIII enum values

Reimplemented from SgModifier.

void* SgStorageModifier::operator new ( size_t size)

returns pointer to newly allocated IR node

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

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

void SgStorageModifier::operator delete ( void * pointer)

static size_t SgStorageModifier::numberOfNodes ( )

static

Returns the total number of IR nodes of this type.

static size_t SgStorageModifier::memoryUsage ( )

static

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

virtual std::vector<SgNode*> SgStorageModifier::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 SgModifier.

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

virtual size_t SgStorageModifier::get_numberOfTraversalSuccessors ( )

virtual

Reimplemented from SgModifier.

virtual SgNode* SgStorageModifier::get_traversalSuccessorByIndex ( size_t idx)

virtual

Reimplemented from SgModifier.

virtual size_t SgStorageModifier::get_childIndex ( SgNode * child)

virtual

Reimplemented from SgModifier.

virtual RTIReturnType SgStorageModifier::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 SgModifier.

virtual const char* SgStorageModifier::sage_class_name ( ) const

virtual

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

Reimplemented from SgModifier.

void SgStorageModifier::executeVisitorMemberFunction ( ROSE_VisitorPattern & visitor)

FOR INTERNAL USE Support for visitor pattern.

virtual void SgStorageModifier::accept ( ROSE_VisitorPattern & visitor)

virtual

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

Reimplemented from SgModifier.

static void SgStorageModifier::traverseMemoryPoolNodes ( ROSE_VisitTraversal & visit)

static

FOR INTERNAL USE Support for visitor pattern.

static void SgStorageModifier::traverseMemoryPoolVisitorPattern ( ROSE_VisitorPattern & visitor)

static

FOR INTERNAL USE Support for visitor pattern.

static void SgStorageModifier::visitRepresentativeNode ( ROSE_VisitTraversal & visit)

static

FOR INTERNAL USE Support for type-based traversal.

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

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

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

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

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

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

SgStorageModifier::storage_modifier_enum SgStorageModifier::get_modifier ( ) const

void SgStorageModifier::set_modifier ( SgStorageModifier::storage_modifier_enum modifier)

bool SgStorageModifier::get_thread_local_storage ( ) const

void SgStorageModifier::set_thread_local_storage ( bool thread_local_storage)

Friends And Related Function Documentation

friend class AST_FILE_IO

friend

Definition at line 11022 of file Cxx_Grammar.h.

friend class SgStorageModifierStorageClass

friend

Definition at line 11023 of file Cxx_Grammar.h.

friend class AstSpecificDataManagingClass

friend

Definition at line 11024 of file Cxx_Grammar.h.

friend class AstSpecificDataManagingClassStorageClass

friend

Definition at line 11025 of file Cxx_Grammar.h.

std::ostream& operator<<	(	std::ostream &	os,
		const SgStorageModifier &	m
	)

friend

bool operator==	(	const SgStorageModifier &	lhs,
		const SgStorageModifier &	rhs
	)

friend

SgStorageModifier::isSgStorageModifier ( SgNode * s)

friend

Casts pointer from base class to derived class.

Cast function (from derived class to SgStorageModifier pointer).

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

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

SgStorageModifier::isSgStorageModifier ( const SgNode * s)

friend

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

Cast function (from derived class to SgStorageModifier pointer).

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

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

SgStorageModifier* SgStorageModifier_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 SgStorageModifier_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 SgStorageModifier_clearMemoryPool ( )

friend

void SgStorageModifier_extendMemoryPoolForFileIO ( unsigned long)

friend

void SgStorageModifier_getNextValidPointer ( std::pair< SgStorageModifier *, std::vector< unsigned char * >::const_iterator > & )

friend

void SgStorageModifier_resetValidFreepointers ( )

friend

Member Data Documentation

SgStorageModifier::storage_modifier_enum SgStorageModifier::p_modifier

protected

Definition at line 11086 of file Cxx_Grammar.h.

bool SgStorageModifier::p_thread_local_storage

protected

Definition at line 11090 of file Cxx_Grammar.h.

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation