SgStorageModifier Class Reference

#include <Cxx_Grammar.h>

Inheritance diagram for SgStorageModifier:

[legend]Collaboration diagram for SgStorageModifier:

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

Public Types

typedef SgModifier base_node_type

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_opencl_global = 19

e_opencl_local = 20

e_opencl_constant = 21

e_opencl_private = 22

e_last_modifier

static_variant = V_SgStorageModifier

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_opencl_global = 19,
  e_opencl_local = 20,
  e_opencl_constant = 21,
  e_opencl_private = 22,
  e_last_modifier
}

Storage Modifiers (only one value can be specified). More...

enum { static_variant = V_SgStorageModifier }

static variant value More...

Public Member Functions

virtual SgNode * copy (SgCopyHelp &help) const

SgStorageModifier (const SgStorageModifier &X)

SgStorageModifier & operator= (const SgStorageModifier &X)

This is the assignment operator.

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.

bool isUnknown () const

Storage modifier is unknown (not set).

void setUnknown ()

Set storage.

bool isDefault () const

Storage modifier is default (default value).

void setDefault ()

Set storage.

bool isExtern () const

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

void setExtern ()

Set storage.

bool isStatic () const

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

void setStatic ()

Set storage.

bool isAuto () const

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

void setAuto ()

Set storage.

bool isUnspecified () const

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

void setUnspecified ()

Set storage.

bool isRegister () const

Storage modifier is register.

void setRegister ()

Set storage.

bool isMutable () const

Storage modifier is mutable (C++ only).

void setMutable ()

Set storage.

bool isTypedef () const

Storage modifier is a typedef.

void setTypedef ()

Set storage.

bool isAsm () const

Storage modifier is an assembler statement.

void setAsm ()

Set storage.

bool isCudaGlobal () const

void setCudaGlobal ()

bool isCudaConstant () const

void setCudaConstant ()

bool isCudaShared () const

void setCudaShared ()

bool isCudaDynamicShared () const

void setCudaDynamicShared ()

bool isOpenclGlobal () const

void setOpenclGlobal ()

bool isOpenclLocal () const

void setOpenclLocal ()

bool isOpenclConstant () const

void setOpenclConstant ()

bool isOpenclPrivate () const

void setOpenclPrivate ()

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 returns a string representing the class name.

virtual VariantT variantT () const

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

FOR INTERNAL USE within ROSE traverals mechanism only.

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

FOR INTERNAL USE within ROSE traverals mechanism only.

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.

virtual const char * sage_class_name () const ROSE_DEPRECATED_FUNCTION

void executeVisitorMemberFunction (ROSE_VisitorPattern &visitor)

FOR INTERNAL USE Support for visitor pattern.

virtual void accept (ROSE_VisitorPattern &visitor)

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

virtual bool isInMemoryPool ()

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

virtual void checkDataMemberPointersIfInMemoryPool ()

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

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

virtual void processDataMemberReferenceToPointers (ReferenceToPointerHandler *)

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

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.

SgStorageModifier (const SgStorageModifierStorageClass &source)

SgStorageModifier * addRegExpAttribute (std::string s, AstRegExAttribute *a)

Support for AST matching using regular expression.

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.

SgStorageModifier ()

This is the constructor.

Static Public Member Functions

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.

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.

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)

SgStorageModifier * isSgStorageModifier (SgNode *s)

Casts pointer from base class to derived class.

const SgStorageModifier * isSgStorageModifier (const SgNode *s)

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

SgStorageModifier * SgStorageModifier_getPointerFromGlobalIndex (unsigned long globalIndex)

Constructor for use by AST File I/O MechanismTypedef 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)

Get the size of the memory pool.

void SgStorageModifier_clearMemoryPool ()

void SgStorageModifier_extendMemoryPoolForFileIO (unsigned long)

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

void SgStorageModifier_resetValidFreepointers ()

Member Typedef Documentation

typedef SgModifier SgStorageModifier::base_node_type

Reimplemented from SgModifier.

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

For internal use only.

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_opencl_global	OpenCL, accessible from all the device
e_opencl_local	OpenCL, accessible for a work-group only
e_opencl_constant	OpenCL, read-only variable accessible from all the device
e_opencl_private	OpenCL, accessible only from one work-item
e_last_modifier	last value (upper bound on range of values, used in error checking)

anonymous enum

static variant value

Enumerator:

static_variant

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]

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

For internal use only.

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

bool SgStorageModifier::isOpenclGlobal ( ) const

void SgStorageModifier::setOpenclGlobal ( )

bool SgStorageModifier::isOpenclLocal ( ) const

void SgStorageModifier::setOpenclLocal ( )

bool SgStorageModifier::isOpenclConstant ( ) const

void SgStorageModifier::setOpenclConstant ( )

bool SgStorageModifier::isOpenclPrivate ( ) const

void SgStorageModifier::setOpenclPrivate ( )

std::string SgStorageModifier::displayString ( ) const

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

Reimplemented from SgModifier.

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

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

Reimplemented from SgModifier.

void SgStorageModifier::operator delete ( void * pointer )

Reimplemented from SgModifier.

static size_t SgStorageModifier::numberOfNodes ( ) [static]

Returns the total number of IR nodes of this type.

Reimplemented from SgModifier.

static size_t SgStorageModifier::memoryUsage ( ) [static]

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

Reimplemented from SgModifier.

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.

Reimplemented from SgModifier.

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.

Reimplemented from SgModifier.

static void SgStorageModifier::traverseMemoryPoolVisitorPattern ( ROSE_VisitorPattern & visitor ) [static]

FOR INTERNAL USE Support for visitor pattern.

Reimplemented from SgModifier.

static void SgStorageModifier::visitRepresentativeNode ( ROSE_VisitTraversal & visit ) [static]

FOR INTERNAL USE Support for type-based traversal.

Reimplemented from SgModifier.

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.

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.

Reimplemented from SgModifier.

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]

Reimplemented from SgModifier.

friend class SgStorageModifierStorageClass [friend]

friend class AstSpecificDataManagingClass [friend]

Reimplemented from SgModifier.

friend class AstSpecificDataManagingClassStorageClass [friend]

Reimplemented from SgModifier.

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.

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

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 MechanismTypedef 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]

bool SgStorageModifier::p_thread_local_storage [protected]

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

Generated on Tue Jan 31 05:43:04 2012 for ROSE by

1.4.7


Public Types
typedef SgModifier	base_node_type
	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_opencl_global = 19
	e_opencl_local = 20
	e_opencl_constant = 21
	e_opencl_private = 22
	e_last_modifier
	static_variant = V_SgStorageModifier
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_opencl_global = 19, e_opencl_local = 20, e_opencl_constant = 21, e_opencl_private = 22, e_last_modifier }
	Storage Modifiers (only one value can be specified). More...
enum	{ static_variant = V_SgStorageModifier }
	static variant value More...
Public Member Functions
virtual SgNode *	copy (SgCopyHelp &help) const
	SgStorageModifier (const SgStorageModifier &X)
SgStorageModifier &	operator= (const SgStorageModifier &X)
	This is the assignment operator.
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.
bool	isUnknown () const
	Storage modifier is unknown (not set).
void	setUnknown ()
	Set storage.
bool	isDefault () const
	Storage modifier is default (default value).
void	setDefault ()
	Set storage.
bool	isExtern () const
	Storage modifier is extern (not the same as extern "C").
void	setExtern ()
	Set storage.
bool	isStatic () const
	Storage modifier is static (always false for the SgStorageModifier in the SgInitializedName).
void	setStatic ()
	Set storage.
bool	isAuto () const
	Storage modifier is auto (most common setting for variables).
void	setAuto ()
	Set storage.
bool	isUnspecified () const
	Storage modifier is not specified (I think this is not used).
void	setUnspecified ()
	Set storage.
bool	isRegister () const
	Storage modifier is register.
void	setRegister ()
	Set storage.
bool	isMutable () const
	Storage modifier is mutable (C++ only).
void	setMutable ()
	Set storage.
bool	isTypedef () const
	Storage modifier is a typedef.
void	setTypedef ()
	Set storage.
bool	isAsm () const
	Storage modifier is an assembler statement.
void	setAsm ()
	Set storage.
bool	isCudaGlobal () const
void	setCudaGlobal ()
bool	isCudaConstant () const
void	setCudaConstant ()
bool	isCudaShared () const
void	setCudaShared ()
bool	isCudaDynamicShared () const
void	setCudaDynamicShared ()
bool	isOpenclGlobal () const
void	setOpenclGlobal ()
bool	isOpenclLocal () const
void	setOpenclLocal ()
bool	isOpenclConstant () const
void	setOpenclConstant ()
bool	isOpenclPrivate () const
void	setOpenclPrivate ()
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 returns a string representing the class name.
virtual VariantT	variantT () const
	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 ()
	FOR INTERNAL USE within ROSE traverals mechanism only.
virtual std::vector< std::string >	get_traversalSuccessorNamesContainer ()
	FOR INTERNAL USE within ROSE traverals mechanism only.
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.
virtual const char *	sage_class_name () const ROSE_DEPRECATED_FUNCTION
void	executeVisitorMemberFunction (ROSE_VisitorPattern &visitor)
	FOR INTERNAL USE Support for visitor pattern.
virtual void	accept (ROSE_VisitorPattern &visitor)
	DXN (08/09/2010): support for the classic visitor pattern done in GoF.
virtual bool	isInMemoryPool ()
	FOR INTERNAL USE This is used in internal tests to verify that all IR nodes are allocated from the heap.
virtual void	checkDataMemberPointersIfInMemoryPool ()
	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
	FOR INTERNAL USE Returns STL vector of pairs of SgNode* and strings for use in AST tools
virtual void	processDataMemberReferenceToPointers (ReferenceToPointerHandler *)
	FOR INTERNAL USE Processes pairs of references to SgNode* and strings for use in AST tools
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.
	SgStorageModifier (const SgStorageModifierStorageClass &source)
SgStorageModifier *	addRegExpAttribute (std::string s, AstRegExAttribute *a)
	Support for AST matching using regular expression.
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.
	SgStorageModifier ()
	This is the constructor.
Static Public Member Functions
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.
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.
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)
SgStorageModifier *	isSgStorageModifier (SgNode *s)
	Casts pointer from base class to derived class.
const SgStorageModifier *	isSgStorageModifier (const SgNode *s)
	Casts pointer from base class to derived class (for const pointers).
SgStorageModifier *	SgStorageModifier_getPointerFromGlobalIndex (unsigned long globalIndex)
	Constructor for use by AST File I/O MechanismTypedef 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)
	Get the size of the memory pool.
void	SgStorageModifier_clearMemoryPool ()
void	SgStorageModifier_extendMemoryPoolForFileIO (unsigned long)
void	SgStorageModifier_getNextValidPointer (std::pair< SgStorageModifier , std::vector< unsigned char >::const_iterator > &)
void	SgStorageModifier_resetValidFreepointers ()