SgClassDeclaration Class Reference

#include <Cxx_Grammar.h>

Inheritance diagram for SgClassDeclaration:

[legend]Collaboration diagram for SgClassDeclaration:

Detailed Description

This class represents the concept of a class declaration statement. It includes the concept of an instantiated class template as well.

Declaration statements are where variables and types are defined and become available for use within a program. Declarations are strored in symbols (SgSymbol) and used to associate the symbol with a location within a scope within the application source code. There are many different types of declarations, within Sage III the SgDeclaration forms a base class for numerous IR nodes such as: class declarations (including structs and unions), enum declarations, function declarations, namespace declarations, pragma declarations, template declarations, typedef declarations, using declarations, using directives, variable declarations, etc.

An important concept for a few types fo declarations is that of defining vs. non-defining. Defining declarations are associated with definitions, for example a class definition or function definition. A class declaration where a class is defined (instead of a forward declaration) is a defining declaration. A forward declaration is a non-defining declaration. Some declarations are not explicitly forward declarations, they are non-defining declarations. Only declarations where there is a definition are defining declarations. Because definitions can at most appear once within a translation unit (a source file and it included header files), there is at most one defining declaration. The defining declaration is never shared, however the non-defining declaration can be shared and is required to be shared if there is more than one location in the AST where a non-defining declaration is required. There is at most one defining and one non-defining declaration (at some point they will also share their name, but this is not implemented yet). If a variable is defined to be extern or only defined through a refererence or pointer, then there would be no defining declaration (only a non-defining declaration).

The following code contains no defining declaration for the type "foobar":
typedef struct foobar *((FunctionPointer)(void);
foobar* foobar_pointer = NULL;
and yet is vailid code (even though there is no explicit forward declaration of "foobar" as a class (or struct). In this case foobar is represented using a non-defining declaration internally and that declaration is reference multiple types (once within each statement). Note that the code abouve is valid C++, and not valid C code (to make it valid C code we would have to add "struct" the pointer declaration, for example: struct foobar* foobar_pointer = NULL;
So C++ is not always a super set of C :-).

Different types of declarations explained:
C and C++ declarations can come in several forms, for example:
typedef struct { int A; } A; // unnamed class declaration (which gets a name from the typedef)
struct A { int i; }; // autonomous declaration
struct B { int i; } b; // non autonomous declaration
In these cases "struct" and "class" can be used interchangablily. Internally "struct" and "class" are he same (but with a different enum to classify them, see SgNameType and SgClassType). Clearly most C++ code uses autonomous declarations.

There are no uses of this IR node anywhere. All statements are derived from this SgClassDeclaration class.

For internal use only.

This is a base class for all statements.

See also:: Example of using a SgClassDeclaration object

Public Types

typedef SgDeclarationStatement base_node_type

e_class

e_struct

e_union

e_template_parameter

static_variant = V_SgClassDeclaration

enum class_types {
  e_class,
  e_struct,
  e_union,
  e_template_parameter
}

enum { static_variant = V_SgClassDeclaration }

static variant value More...

Public Member Functions

virtual SgNode * copy (SgCopyHelp &help) const

virtual SgName get_qualified_name () const

virtual SgName get_mangled_name (void) const

SgName get_mangled_qualified_name (int &cnt)

virtual bool hasExplicitScope () const

Support for where the scope is explicitly required.

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 SgSymbol * get_symbol_from_symbol_table () const

FOR INTERNAL USE Get the associated symbol from the symbol table in the stored scope. Users should use the SgDeclarationStatement::search_for_symbol_from_symbol_table() instead.

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

bool isSpecialization () const

bool isPartialSpecialization () const

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.

SgClassDeclaration (const SgClassDeclarationStorageClass &source)

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

SgName get_name () const

void set_name (SgName name)

SgClassDeclaration::class_types get_class_type () const

void set_class_type (SgClassDeclaration::class_types class_type)

SgClassType * get_type () const

void set_type (SgClassType *type)

SgClassDefinition * get_definition () const

void set_definition (SgClassDefinition *definition)

SgScopeStatement * get_scope () const

Returns scope of current statement.

void set_scope (SgScopeStatement *scope)

Support for setting scopes (only meaningful on IR statements that store the scope explicitly).

SgDeclarationStatement::template_specialization_enum get_specialization () const

void set_specialization (SgDeclarationStatement::template_specialization_enum specialization)

bool get_from_template () const

void set_from_template (bool from_template)

bool get_fixupScope () const

void set_fixupScope (bool fixupScope)

bool get_isUnNamed () const

void set_isUnNamed (bool isUnNamed)

bool get_explicit_interface () const

void set_explicit_interface (bool explicit_interface)

SgExprListExp * get_decoratorList () const

void set_decoratorList (SgExprListExp *decoratorList)

int get_name_qualification_length () const

void set_name_qualification_length (int name_qualification_length)

bool get_type_elaboration_required () const

void set_type_elaboration_required (bool type_elaboration_required)

bool get_global_qualification_required () const

void set_global_qualification_required (bool global_qualification_required)

virtual ~SgClassDeclaration ()

This is the destructor.

SgClassDeclaration (Sg_File_Info *startOfConstruct, SgName name="", SgClassDeclaration::class_types class_type=SgClassDeclaration::e_class, SgClassType *type=NULL, SgClassDefinition *definition=NULL)

SgClassDeclaration (SgName name, SgClassDeclaration::class_types class_type, SgClassType *type, SgClassDefinition *definition)

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 Member Functions

virtual bool replace_child (SgStatement *, SgStatement *, bool extractListFromBasicBlock=false)

Private supporting function for low level SageIII rewrite interface.

SgClassDefinition * compute_classDefinition () const

Protected Attributes

SgName p_name

This is the name of the class or instantiated class template.

SgClassDeclaration::class_types p_class_type

Enum value classifying this as a class,struct,or union.

SgClassType * p_type

This is the type used in the declaration (SgClassType).

SgClassDefinition * p_definition

This is the class definition (alway a valid pointer, except for explicitly marked forward declarations).

SgScopeStatement * p_scope

SgDeclarationStatement::template_specialization_enum p_specialization

bool p_from_template

This records if the class declaration is associated with a template.

bool p_fixupScope

bool p_isUnNamed

bool p_explicit_interface

SgExprListExp * p_decoratorList

int p_name_qualification_length

bool p_type_elaboration_required

bool p_global_qualification_required

Friends

class AST_FILE_IO

class SgClassDeclarationStorageClass

class AstSpecificDataManagingClass

class AstSpecificDataManagingClassStorageClass

SgClassDeclaration * isSgClassDeclaration (SgNode *s)

Casts pointer from base class to derived class.

const SgClassDeclaration * isSgClassDeclaration (const SgNode *s)

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

SgClassDeclaration * SgClassDeclaration_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 SgClassDeclaration_getNumberOfValidNodesAndSetGlobalIndexInFreepointer (unsigned long)

Get the size of the memory pool.

void SgClassDeclaration_clearMemoryPool ()

void SgClassDeclaration_extendMemoryPoolForFileIO (unsigned long)

void SgClassDeclaration_getNextValidPointer (std::pair< SgClassDeclaration *, std::vector< unsigned char * >::const_iterator > &)

void SgClassDeclaration_resetValidFreepointers ()

Member Typedef Documentation

typedef SgDeclarationStatement SgClassDeclaration::base_node_type

Reimplemented from SgDeclarationStatement.

Reimplemented in SgTemplateInstantiationDecl, SgDerivedTypeStatement, and SgModuleStatement.

Member Enumeration Documentation

enum SgClassDeclaration::class_types

A declaration can be of either class, struct, or union

Enumerator:

e_class	class declaration (default)
e_struct	struct declaration
e_union	union declaration
e_template_parameter	type parameter in a template declaration

anonymous enum

static variant value

Enumerator:

static_variant

Constructor & Destructor Documentation

SgClassDeclaration::SgClassDeclaration ( const SgClassDeclarationStorageClass & source )

SgClassDeclaration::~SgClassDeclaration ( ) [virtual]

This is the destructor.

There are a lot of things to delete, but nothing is deleted in this destructor.

SgClassDeclaration::SgClassDeclaration	(	Sg_File_Info *	startOfConstruct,
		SgName	name = `""`,
		SgClassDeclaration::class_types	class_type = `SgClassDeclaration::e_class`,
		SgClassType *	type = `NULL`,
		SgClassDefinition *	definition = `NULL`
	)

SgClassDeclaration::SgClassDeclaration	(	SgName	name,
		SgClassDeclaration::class_types	class_type,
		SgClassType *	type,
		SgClassDefinition *	definition
	)

Member Function Documentation

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

Reimplemented from SgDeclarationStatement.

Reimplemented in SgTemplateInstantiationDecl, SgDerivedTypeStatement, and SgModuleStatement.

virtual SgName SgClassDeclaration::get_qualified_name ( ) const [virtual]

Reimplemented in SgTemplateInstantiationDecl.

virtual SgName SgClassDeclaration::get_mangled_name ( void ) const [virtual]

Reimplemented from SgDeclarationStatement.

Reimplemented in SgTemplateInstantiationDecl, SgDerivedTypeStatement, and SgModuleStatement.

SgName SgClassDeclaration::get_mangled_qualified_name ( int & cnt )

Deprecated:: by RV (1/31/2006)

virtual bool SgClassDeclaration::replace_child	(	SgStatement *	,
		SgStatement *	,
		bool	extractListFromBasicBlock = `false`
	)			`[protected, virtual]`

Private supporting function for low level SageIII rewrite interface.

This function implements special semantics for the insertion of a collection of statements in a block. If extractListFromBasicBlock is true then the statements in the block are extracts and placed into the same scope as the target position.

Returns:: Returns bool.

Reimplemented from SgStatement.

virtual bool SgClassDeclaration::hasExplicitScope ( ) const [virtual]

Support for where the scope is explicitly required.

Reimplemented from SgStatement.

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

Determine the CFG index for the end of this construct.

Reimplemented from SgStatement.

Reimplemented in SgModuleStatement.

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

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

Reimplemented from SgStatement.

Reimplemented in SgModuleStatement.

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

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

Reimplemented from SgStatement.

Reimplemented in SgModuleStatement.

virtual SgSymbol* SgClassDeclaration::get_symbol_from_symbol_table ( ) const [virtual]

FOR INTERNAL USE Get the associated symbol from the symbol table in the stored scope. Users should use the SgDeclarationStatement::search_for_symbol_from_symbol_table() instead.

Reimplemented from SgDeclarationStatement.

Reimplemented in SgTemplateInstantiationDecl.

virtual void SgClassDeclaration::fixupCopy	(	SgNode *	copy,
		SgCopyHelp &	help
	)			const `[virtual]`

Reimplemented from SgDeclarationStatement.

Reimplemented in SgTemplateInstantiationDecl.

SgClassDefinition* SgClassDeclaration::compute_classDefinition ( ) const [protected]

bool SgClassDeclaration::isSpecialization ( ) const

bool SgClassDeclaration::isPartialSpecialization ( ) const

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

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

Reimplemented from SgDeclarationStatement.

Reimplemented in SgTemplateInstantiationDecl, SgDerivedTypeStatement, and SgModuleStatement.

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

returns new style SageIII enum values

Reimplemented from SgDeclarationStatement.

Reimplemented in SgTemplateInstantiationDecl, SgDerivedTypeStatement, and SgModuleStatement.

void* SgClassDeclaration::operator new ( size_t size )

returns pointer to newly allocated IR node

Reimplemented from SgDeclarationStatement.

Reimplemented in SgTemplateInstantiationDecl, SgDerivedTypeStatement, and SgModuleStatement.

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

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

Reimplemented from SgDeclarationStatement.

Reimplemented in SgTemplateInstantiationDecl, SgDerivedTypeStatement, and SgModuleStatement.

void SgClassDeclaration::operator delete ( void * pointer )

Reimplemented from SgDeclarationStatement.

Reimplemented in SgTemplateInstantiationDecl, SgDerivedTypeStatement, and SgModuleStatement.

static size_t SgClassDeclaration::numberOfNodes ( ) [static]

Returns the total number of IR nodes of this type.

Reimplemented from SgDeclarationStatement.

Reimplemented in SgTemplateInstantiationDecl, SgDerivedTypeStatement, and SgModuleStatement.

static size_t SgClassDeclaration::memoryUsage ( ) [static]

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

Reimplemented from SgDeclarationStatement.

Reimplemented in SgTemplateInstantiationDecl, SgDerivedTypeStatement, and SgModuleStatement.

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

Reimplemented in SgTemplateInstantiationDecl, SgDerivedTypeStatement, and SgModuleStatement.

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

Reimplemented in SgTemplateInstantiationDecl, SgDerivedTypeStatement, and SgModuleStatement.

virtual size_t SgClassDeclaration::get_numberOfTraversalSuccessors ( ) [virtual]

Reimplemented from SgDeclarationStatement.

Reimplemented in SgTemplateInstantiationDecl, SgDerivedTypeStatement, and SgModuleStatement.

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

Reimplemented from SgDeclarationStatement.

Reimplemented in SgTemplateInstantiationDecl, SgDerivedTypeStatement, and SgModuleStatement.

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

Reimplemented from SgDeclarationStatement.

Reimplemented in SgTemplateInstantiationDecl, SgDerivedTypeStatement, and SgModuleStatement.

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

Reimplemented in SgTemplateInstantiationDecl, SgDerivedTypeStatement, and SgModuleStatement.

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

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

Reimplemented from SgDeclarationStatement.

Reimplemented in SgTemplateInstantiationDecl, SgDerivedTypeStatement, and SgModuleStatement.

void SgClassDeclaration::executeVisitorMemberFunction ( ROSE_VisitorPattern & visitor )

FOR INTERNAL USE Support for visitor pattern.

Reimplemented from SgDeclarationStatement.

Reimplemented in SgTemplateInstantiationDecl, SgDerivedTypeStatement, and SgModuleStatement.

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

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

Reimplemented from SgDeclarationStatement.

Reimplemented in SgTemplateInstantiationDecl, SgDerivedTypeStatement, and SgModuleStatement.

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

FOR INTERNAL USE Support for visitor pattern.

Reimplemented from SgDeclarationStatement.

Reimplemented in SgTemplateInstantiationDecl, SgDerivedTypeStatement, and SgModuleStatement.

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

FOR INTERNAL USE Support for visitor pattern.

Reimplemented from SgDeclarationStatement.

Reimplemented in SgTemplateInstantiationDecl, SgDerivedTypeStatement, and SgModuleStatement.

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

FOR INTERNAL USE Support for type-based traversal.

Reimplemented from SgDeclarationStatement.

Reimplemented in SgTemplateInstantiationDecl, SgDerivedTypeStatement, and SgModuleStatement.

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

Reimplemented in SgTemplateInstantiationDecl, SgDerivedTypeStatement, and SgModuleStatement.

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

Reimplemented in SgTemplateInstantiationDecl, SgDerivedTypeStatement, and SgModuleStatement.

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

Reimplemented in SgTemplateInstantiationDecl, SgDerivedTypeStatement, and SgModuleStatement.

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

Reimplemented in SgTemplateInstantiationDecl, SgDerivedTypeStatement, and SgModuleStatement.

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

Reimplemented in SgTemplateInstantiationDecl, SgDerivedTypeStatement, and SgModuleStatement.

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

Reimplemented in SgTemplateInstantiationDecl, SgDerivedTypeStatement, and SgModuleStatement.

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

Reimplemented in SgTemplateInstantiationDecl, SgDerivedTypeStatement, and SgModuleStatement.

SgName SgClassDeclaration::get_name ( ) const

void SgClassDeclaration::set_name ( SgName name )

SgClassDeclaration::class_types SgClassDeclaration::get_class_type ( ) const

void SgClassDeclaration::set_class_type ( SgClassDeclaration::class_types class_type )

SgClassType* SgClassDeclaration::get_type ( ) const

void SgClassDeclaration::set_type ( SgClassType * type )

SgClassDefinition* SgClassDeclaration::get_definition ( ) const

void SgClassDeclaration::set_definition ( SgClassDefinition * definition )

SgScopeStatement* SgClassDeclaration::get_scope ( void ) const [virtual]

Returns scope of current statement.

This functions returns a pointer to the inner most SgScopeStatement where the current statement is located. This is a function called after the parents have been set. It is not called by the EDG/SAGE interface and is only called after the SAGE AST has been built and the parent pointers set within a separate phase. Improtant exception: The SgFunctionParameterList should have as it's scope the SgFunctionDefinition, but it is a sibling of the SgFunctionDefinition (both the SgFunctionParameterList and the SgFunctionDefinition have the SgFunctionDeclaration as a parent. Thus the scope of the SgFunctionParameterList is computed to be the SgGlobal (global scope) most often; which is an error). So we handle this case explicitly.

Returns:: Returns valid pointer to SgScopeStatement.

Reimplemented from SgStatement.

void SgClassDeclaration::set_scope ( SgScopeStatement * scope ) [virtual]

Support for setting scopes (only meaningful on IR statements that store the scope explicitly).

Reimplemented from SgStatement.

SgDeclarationStatement::template_specialization_enum SgClassDeclaration::get_specialization ( ) const

void SgClassDeclaration::set_specialization ( SgDeclarationStatement::template_specialization_enum specialization )

bool SgClassDeclaration::get_from_template ( ) const

void SgClassDeclaration::set_from_template ( bool from_template )

bool SgClassDeclaration::get_fixupScope ( ) const

void SgClassDeclaration::set_fixupScope ( bool fixupScope )

bool SgClassDeclaration::get_isUnNamed ( ) const

void SgClassDeclaration::set_isUnNamed ( bool isUnNamed )

bool SgClassDeclaration::get_explicit_interface ( ) const

void SgClassDeclaration::set_explicit_interface ( bool explicit_interface )

SgExprListExp* SgClassDeclaration::get_decoratorList ( ) const

void SgClassDeclaration::set_decoratorList ( SgExprListExp * decoratorList )

int SgClassDeclaration::get_name_qualification_length ( ) const

void SgClassDeclaration::set_name_qualification_length ( int name_qualification_length )

bool SgClassDeclaration::get_type_elaboration_required ( ) const

void SgClassDeclaration::set_type_elaboration_required ( bool type_elaboration_required )

bool SgClassDeclaration::get_global_qualification_required ( ) const

void SgClassDeclaration::set_global_qualification_required ( bool global_qualification_required )

Friends And Related Function Documentation

friend class AST_FILE_IO [friend]

Reimplemented from SgDeclarationStatement.

Reimplemented in SgTemplateInstantiationDecl, SgDerivedTypeStatement, and SgModuleStatement.

friend class SgClassDeclarationStorageClass [friend]

friend class AstSpecificDataManagingClass [friend]

Reimplemented from SgDeclarationStatement.

Reimplemented in SgTemplateInstantiationDecl, SgDerivedTypeStatement, and SgModuleStatement.

friend class AstSpecificDataManagingClassStorageClass [friend]

Reimplemented from SgDeclarationStatement.

Reimplemented in SgTemplateInstantiationDecl, SgDerivedTypeStatement, and SgModuleStatement.

SgClassDeclaration::isSgClassDeclaration ( SgNode * s ) [friend]

Casts pointer from base class to derived class.

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

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

SgClassDeclaration::isSgClassDeclaration ( const SgNode * s ) [friend]

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

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

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

SgClassDeclaration* SgClassDeclaration_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 SgClassDeclaration_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 SgClassDeclaration_clearMemoryPool ( ) [friend]

void SgClassDeclaration_extendMemoryPoolForFileIO ( unsigned long ) [friend]

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

void SgClassDeclaration_resetValidFreepointers ( ) [friend]

Member Data Documentation

SgClassDeclaration::p_name [protected]

This is the name of the class or instantiated class template.

For internal use only.

The value held is not shared within the Sage III AST.

SgClassDeclaration::p_class_type [protected]

Enum value classifying this as a class,struct,or union.

For internal use only.

The enum type is also defined in this class.

SgClassDeclaration::p_type [protected]

This is the type used in the declaration (SgClassType).

SgClassDeclaration::p_definition [protected]

This is the class definition (alway a valid pointer, except for explicitly marked forward declarations).

When this is a defining or nondefining declartion the p_definition pointer is always valid. However, as a separate rule, all forward declarations are both makred explicit as forward declarations AND have a NULL value for their p_definition pointer.

For internal use only.

The declaration associated with the definition is the defining declaration and may not be the same as that pointed to by the "this" pointer.

SgScopeStatement* SgClassDeclaration::p_scope [protected]

SgDeclarationStatement::template_specialization_enum SgClassDeclaration::p_specialization [protected]

SgClassDeclaration::p_from_template [protected]

This records if the class declaration is associated with a template.

This boolean value is set to true if this is a non-template class nested in a templated class. We have an explicit IR node for template classes, but this is only flag to indicate that several template specific rules apply to the declaration of this class if the value is true. For example, the class will not be output unless it is transformed, then the required specialization is required for the parent templated class.

For internal use only.

It is set internally and there is no need for it to be set by the user!

bool SgClassDeclaration::p_fixupScope [protected]

bool SgClassDeclaration::p_isUnNamed [protected]

bool SgClassDeclaration::p_explicit_interface [protected]

SgExprListExp* SgClassDeclaration::p_decoratorList [protected]

int SgClassDeclaration::p_name_qualification_length [protected]

bool SgClassDeclaration::p_type_elaboration_required [protected]

bool SgClassDeclaration::p_global_qualification_required [protected]

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

Generated on Tue Jan 31 05:38:50 2012 for ROSE by

1.4.7


Public Types
typedef SgDeclarationStatement	base_node_type
	e_class
	e_struct
	e_union
	e_template_parameter
	static_variant = V_SgClassDeclaration
enum	class_types { e_class, e_struct, e_union, e_template_parameter }
enum	{ static_variant = V_SgClassDeclaration }
	static variant value More...
Public Member Functions
virtual SgNode *	copy (SgCopyHelp &help) const
virtual SgName	get_qualified_name () const
virtual SgName	get_mangled_name (void) const
SgName	get_mangled_qualified_name (int &cnt)
virtual bool	hasExplicitScope () const
	Support for where the scope is explicitly required.
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 SgSymbol *	get_symbol_from_symbol_table () const
	FOR INTERNAL USE Get the associated symbol from the symbol table in the stored scope. Users should use the SgDeclarationStatement::search_for_symbol_from_symbol_table() instead.
virtual void	fixupCopy (SgNode *copy, SgCopyHelp &help) const
bool	isSpecialization () const
bool	isPartialSpecialization () const
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.
	SgClassDeclaration (const SgClassDeclarationStorageClass &source)
SgClassDeclaration *	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.
SgName	get_name () const
void	set_name (SgName name)
SgClassDeclaration::class_types	get_class_type () const
void	set_class_type (SgClassDeclaration::class_types class_type)
SgClassType *	get_type () const
void	set_type (SgClassType *type)
SgClassDefinition *	get_definition () const
void	set_definition (SgClassDefinition *definition)
SgScopeStatement *	get_scope () const
	Returns scope of current statement.
void	set_scope (SgScopeStatement *scope)
	Support for setting scopes (only meaningful on IR statements that store the scope explicitly).
SgDeclarationStatement::template_specialization_enum	get_specialization () const
void	set_specialization (SgDeclarationStatement::template_specialization_enum specialization)
bool	get_from_template () const
void	set_from_template (bool from_template)
bool	get_fixupScope () const
void	set_fixupScope (bool fixupScope)
bool	get_isUnNamed () const
void	set_isUnNamed (bool isUnNamed)
bool	get_explicit_interface () const
void	set_explicit_interface (bool explicit_interface)
SgExprListExp *	get_decoratorList () const
void	set_decoratorList (SgExprListExp *decoratorList)
int	get_name_qualification_length () const
void	set_name_qualification_length (int name_qualification_length)
bool	get_type_elaboration_required () const
void	set_type_elaboration_required (bool type_elaboration_required)
bool	get_global_qualification_required () const
void	set_global_qualification_required (bool global_qualification_required)
virtual	~SgClassDeclaration ()
	This is the destructor.
	SgClassDeclaration (Sg_File_Info startOfConstruct, SgName name="", SgClassDeclaration::class_types class_type=SgClassDeclaration::e_class, SgClassType type=NULL, SgClassDefinition *definition=NULL)
	SgClassDeclaration (SgName name, SgClassDeclaration::class_types class_type, SgClassType type, SgClassDefinition definition)
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 Member Functions
virtual bool	replace_child (SgStatement , SgStatement , bool extractListFromBasicBlock=false)
	Private supporting function for low level SageIII rewrite interface.
SgClassDefinition *	compute_classDefinition () const
Protected Attributes
SgName	p_name
	This is the name of the class or instantiated class template.
SgClassDeclaration::class_types	p_class_type
	Enum value classifying this as a class,struct,or union.
SgClassType *	p_type
	This is the type used in the declaration (SgClassType).
SgClassDefinition *	p_definition
	This is the class definition (alway a valid pointer, except for explicitly marked forward declarations).
SgScopeStatement *	p_scope
SgDeclarationStatement::template_specialization_enum	p_specialization
bool	p_from_template
	This records if the class declaration is associated with a template.
bool	p_fixupScope
bool	p_isUnNamed
bool	p_explicit_interface
SgExprListExp *	p_decoratorList
int	p_name_qualification_length
bool	p_type_elaboration_required
bool	p_global_qualification_required
Friends
class	AST_FILE_IO
class	SgClassDeclarationStorageClass
class	AstSpecificDataManagingClass
class	AstSpecificDataManagingClassStorageClass
SgClassDeclaration *	isSgClassDeclaration (SgNode *s)
	Casts pointer from base class to derived class.
const SgClassDeclaration *	isSgClassDeclaration (const SgNode *s)
	Casts pointer from base class to derived class (for const pointers).
SgClassDeclaration *	SgClassDeclaration_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	SgClassDeclaration_getNumberOfValidNodesAndSetGlobalIndexInFreepointer (unsigned long)
	Get the size of the memory pool.
void	SgClassDeclaration_clearMemoryPool ()
void	SgClassDeclaration_extendMemoryPoolForFileIO (unsigned long)
void	SgClassDeclaration_getNextValidPointer (std::pair< SgClassDeclaration , std::vector< unsigned char >::const_iterator > &)
void	SgClassDeclaration_resetValidFreepointers ()