SgAttributeSpecificationStatement Class Reference

#include <Cxx_Grammar.h>

Inheritance diagram for SgAttributeSpecificationStatement:

[legend]Collaboration diagram for SgAttributeSpecificationStatement:


Public Types
typedef SgDeclarationStatement	base_node_type
	e_unknown_attribute_spec
	e_accessStatement_private
	e_accessStatement_public
	e_allocatableStatement
	e_asynchronousStatement
	e_bindStatement
	e_dataStatement
	e_dimensionStatement
	e_externalStatement
	e_intentStatement
	e_intrinsicStatement
	e_optionalStatement
	e_parameterStatement
	e_pointerStatement
	e_protectedStatement
	e_saveStatement
	e_targetStatement
	e_valueStatement
	e_volatileStatement
	e_last_attribute_spec
	static_variant = V_SgAttributeSpecificationStatement
enum	attribute_spec_enum { e_unknown_attribute_spec, e_accessStatement_private, e_accessStatement_public, e_allocatableStatement, e_asynchronousStatement, e_bindStatement, e_dataStatement, e_dimensionStatement, e_externalStatement, e_intentStatement, e_intrinsicStatement, e_optionalStatement, e_parameterStatement, e_pointerStatement, e_protectedStatement, e_saveStatement, e_targetStatement, e_valueStatement, e_volatileStatement, e_last_attribute_spec }
	Fortran specific classification of attribute statements (each corresponds to a declaration attribute). More...
enum	{ static_variant = V_SgAttributeSpecificationStatement }
	static variant value More...
Public Member Functions
virtual SgNode *	copy (SgCopyHelp &help) const
virtual unsigned int	cfgIndexForEnd () const
	Determine the CFG index for the end of this construct.
virtual std::vector< VirtualCFG::CFGEdge >	cfgOutEdges (unsigned int index)
	Find the out edges of a CFG node -- internal version.
virtual std::vector< VirtualCFG::CFGEdge >	cfgInEdges (unsigned int index)
	Find the in edges of a CFG node -- internal version.
virtual SgName	get_mangled_name () const
const SgStringList &	get_name_list () const
SgStringList &	get_name_list ()
const SgDataStatementGroupPtrList &	get_data_statement_group_list () const
	Support for Fortran data statement.
SgDataStatementGroupPtrList &	get_data_statement_group_list ()
const SgDimensionObjectPtrList &	get_dimension_object_list () const
	Support for Fortran data statement.
SgDimensionObjectPtrList &	get_dimension_object_list ()
SgSymbol *	search_for_symbol_from_symbol_table () const
	User interface for retrieving the associated symbol from the declaration.
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.
	SgAttributeSpecificationStatement (const SgAttributeSpecificationStatementStorageClass &source)
SgAttributeSpecificationStatement *	addRegExpAttribute (std::string s, AstRegExAttribute *a)
	Support for AST matching using regular expression.
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.
SgAttributeSpecificationStatement::attribute_spec_enum	get_attribute_kind () const
void	set_attribute_kind (SgAttributeSpecificationStatement::attribute_spec_enum attribute_kind)
int	get_intent () const
void	set_intent (int intent)
SgExprListExp *	get_parameter_list () const
void	set_parameter_list (SgExprListExp *parameter_list)
SgExprListExp *	get_bind_list () const
void	set_bind_list (SgExprListExp *bind_list)
virtual	~SgAttributeSpecificationStatement ()
	SgAttributeSpecificationStatement (Sg_File_Info *startOfConstruct)
	SgAttributeSpecificationStatement ()
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
SgStringList	p_name_list
SgAttributeSpecificationStatement::attribute_spec_enum	p_attribute_kind
int	p_intent
SgExprListExp *	p_parameter_list
SgDataStatementGroupPtrList	p_data_statement_group_list
SgExprListExp *	p_bind_list
SgDimensionObjectPtrList	p_dimension_object_list
Friends
class	AST_FILE_IO
class	SgAttributeSpecificationStatementStorageClass
class	AstSpecificDataManagingClass
class	AstSpecificDataManagingClassStorageClass
SgAttributeSpecificationStatement *	isSgAttributeSpecificationStatement (SgNode *s)
	Casts pointer from base class to derived class.
const SgAttributeSpecificationStatement *	isSgAttributeSpecificationStatement (const SgNode *s)
	Casts pointer from base class to derived class (for const pointers).
SgAttributeSpecificationStatement *	SgAttributeSpecificationStatement_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	SgAttributeSpecificationStatement_getNumberOfValidNodesAndSetGlobalIndexInFreepointer (unsigned long)
	Get the size of the memory pool.
void	SgAttributeSpecificationStatement_clearMemoryPool ()
void	SgAttributeSpecificationStatement_extendMemoryPoolForFileIO (unsigned long)
void	SgAttributeSpecificationStatement_getNextValidPointer (std::pair< SgAttributeSpecificationStatement , std::vector< unsigned char >::const_iterator > &)
void	SgAttributeSpecificationStatement_resetValidFreepointers ()

Member Typedef Documentation

typedef SgDeclarationStatement SgAttributeSpecificationStatement::base_node_type

Reimplemented from SgDeclarationStatement.

Member Enumeration Documentation

enum SgAttributeSpecificationStatement::attribute_spec_enum

Fortran specific classification of attribute statements (each corresponds to a declaration attribute).

Enumerator:

e_unknown_attribute_spec
e_accessStatement_private
e_accessStatement_public
e_allocatableStatement
e_asynchronousStatement
e_bindStatement
e_dataStatement
e_dimensionStatement
e_externalStatement
e_intentStatement
e_intrinsicStatement
e_optionalStatement
e_parameterStatement
e_pointerStatement
e_protectedStatement
e_saveStatement
e_targetStatement
e_valueStatement
e_volatileStatement
e_last_attribute_spec

anonymous enum

static variant value

Enumerator:

static_variant

Constructor & Destructor Documentation

SgAttributeSpecificationStatement::SgAttributeSpecificationStatement ( const SgAttributeSpecificationStatementStorageClass & source )

virtual SgAttributeSpecificationStatement::~SgAttributeSpecificationStatement ( ) [virtual]

SgAttributeSpecificationStatement::SgAttributeSpecificationStatement ( Sg_File_Info * startOfConstruct )

SgAttributeSpecificationStatement::SgAttributeSpecificationStatement ( )

Member Function Documentation

virtual SgNode* SgAttributeSpecificationStatement::copy ( SgCopyHelp & help ) const [virtual]

Reimplemented from SgDeclarationStatement.

virtual unsigned int SgAttributeSpecificationStatement::cfgIndexForEnd ( ) const [virtual]

Determine the CFG index for the end of this construct.

Reimplemented from SgStatement.

virtual std::vector<VirtualCFG::CFGEdge> SgAttributeSpecificationStatement::cfgOutEdges ( unsigned int index ) [virtual]

Find the out edges of a CFG node -- internal version.

Reimplemented from SgStatement.

virtual std::vector<VirtualCFG::CFGEdge> SgAttributeSpecificationStatement::cfgInEdges ( unsigned int index ) [virtual]

Find the in edges of a CFG node -- internal version.

Reimplemented from SgStatement.

virtual SgName SgAttributeSpecificationStatement::get_mangled_name ( ) const [virtual]

Reimplemented from SgDeclarationStatement.

const SgStringList& SgAttributeSpecificationStatement::get_name_list ( ) const

SgStringList& SgAttributeSpecificationStatement::get_name_list ( )

const SgDataStatementGroupPtrList& SgAttributeSpecificationStatement::get_data_statement_group_list ( ) const

Support for Fortran data statement.

SgDataStatementGroupPtrList& SgAttributeSpecificationStatement::get_data_statement_group_list ( )

const SgDimensionObjectPtrList& SgAttributeSpecificationStatement::get_dimension_object_list ( ) const

Support for Fortran data statement.

SgDimensionObjectPtrList& SgAttributeSpecificationStatement::get_dimension_object_list ( )

SgSymbol* SgAttributeSpecificationStatement::search_for_symbol_from_symbol_table ( ) const

User interface for retrieving the associated symbol from the declaration.

Returns:: Returns SgSymbol pointer.

Reimplemented from SgDeclarationStatement.

virtual std::string SgAttributeSpecificationStatement::class_name ( ) const [virtual]

Copies AST (whole subtree, depending on the SgCopyHelp class returns a string representing the class name.

Reimplemented from SgDeclarationStatement.

virtual VariantT SgAttributeSpecificationStatement::variantT ( ) const [virtual]

returns new style SageIII enum values

Reimplemented from SgDeclarationStatement.

void* SgAttributeSpecificationStatement::operator new ( size_t size )

returns pointer to newly allocated IR node

Reimplemented from SgDeclarationStatement.

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

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

Reimplemented from SgDeclarationStatement.

void SgAttributeSpecificationStatement::operator delete ( void * pointer )

Reimplemented from SgDeclarationStatement.

static size_t SgAttributeSpecificationStatement::numberOfNodes ( ) [static]

Returns the total number of IR nodes of this type.

Reimplemented from SgDeclarationStatement.

static size_t SgAttributeSpecificationStatement::memoryUsage ( ) [static]

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

Reimplemented from SgDeclarationStatement.

virtual std::vector<SgNode*> SgAttributeSpecificationStatement::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 SgDeclarationStatement.

virtual std::vector<std::string> SgAttributeSpecificationStatement::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 SgDeclarationStatement.

virtual size_t SgAttributeSpecificationStatement::get_numberOfTraversalSuccessors ( ) [virtual]

Reimplemented from SgDeclarationStatement.

virtual SgNode* SgAttributeSpecificationStatement::get_traversalSuccessorByIndex ( size_t idx ) [virtual]

Reimplemented from SgDeclarationStatement.

virtual size_t SgAttributeSpecificationStatement::get_childIndex ( SgNode * child ) [virtual]

Reimplemented from SgDeclarationStatement.

virtual RTIReturnType SgAttributeSpecificationStatement::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 SgDeclarationStatement.

virtual const char* SgAttributeSpecificationStatement::sage_class_name ( ) const [virtual]

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

Reimplemented from SgDeclarationStatement.

void SgAttributeSpecificationStatement::executeVisitorMemberFunction ( ROSE_VisitorPattern & visitor )

FOR INTERNAL USE Support for visitor pattern.

Reimplemented from SgDeclarationStatement.

virtual void SgAttributeSpecificationStatement::accept ( ROSE_VisitorPattern & visitor ) [virtual]

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

Reimplemented from SgDeclarationStatement.

static void SgAttributeSpecificationStatement::traverseMemoryPoolNodes ( ROSE_VisitTraversal & visit ) [static]

FOR INTERNAL USE Support for visitor pattern.

Reimplemented from SgDeclarationStatement.

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

FOR INTERNAL USE Support for visitor pattern.

Reimplemented from SgDeclarationStatement.

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

FOR INTERNAL USE Support for type-based traversal.

Reimplemented from SgDeclarationStatement.

virtual bool SgAttributeSpecificationStatement::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 SgDeclarationStatement.

virtual void SgAttributeSpecificationStatement::checkDataMemberPointersIfInMemoryPool ( ) [virtual]

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

Reimplemented from SgDeclarationStatement.

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

virtual void SgAttributeSpecificationStatement::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 SgDeclarationStatement.

virtual long SgAttributeSpecificationStatement::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 SgDeclarationStatement.

SgAttributeSpecificationStatement* SgAttributeSpecificationStatement::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 SgDeclarationStatement.

void SgAttributeSpecificationStatement::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 SgDeclarationStatement.

SgAttributeSpecificationStatement::attribute_spec_enum SgAttributeSpecificationStatement::get_attribute_kind ( ) const

void SgAttributeSpecificationStatement::set_attribute_kind ( SgAttributeSpecificationStatement::attribute_spec_enum attribute_kind )

int SgAttributeSpecificationStatement::get_intent ( ) const

void SgAttributeSpecificationStatement::set_intent ( int intent )

SgExprListExp* SgAttributeSpecificationStatement::get_parameter_list ( ) const

void SgAttributeSpecificationStatement::set_parameter_list ( SgExprListExp * parameter_list )

SgExprListExp* SgAttributeSpecificationStatement::get_bind_list ( ) const

void SgAttributeSpecificationStatement::set_bind_list ( SgExprListExp * bind_list )

Friends And Related Function Documentation

friend class AST_FILE_IO [friend]

Reimplemented from SgDeclarationStatement.

friend class SgAttributeSpecificationStatementStorageClass [friend]

friend class AstSpecificDataManagingClass [friend]

Reimplemented from SgDeclarationStatement.

friend class AstSpecificDataManagingClassStorageClass [friend]

Reimplemented from SgDeclarationStatement.

SgAttributeSpecificationStatement* isSgAttributeSpecificationStatement ( SgNode * s ) [friend]

Casts pointer from base class to derived class.

const SgAttributeSpecificationStatement* isSgAttributeSpecificationStatement ( const SgNode * s ) [friend]

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

SgAttributeSpecificationStatement* SgAttributeSpecificationStatement_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 SgAttributeSpecificationStatement_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 SgAttributeSpecificationStatement_clearMemoryPool ( ) [friend]

void SgAttributeSpecificationStatement_extendMemoryPoolForFileIO ( unsigned long ) [friend]

void SgAttributeSpecificationStatement_getNextValidPointer ( std::pair< SgAttributeSpecificationStatement *, std::vector< unsigned char * >::const_iterator > & ) [friend]