SgScopeStatement Class Reference

#include <Cxx_Grammar.h>

Inheritance diagram for SgScopeStatement:

[legend]Collaboration diagram for SgScopeStatement:

Detailed Description

This class represents the concept of a scope in C++ (e.g. global scope, fuction scope, etc.).

Scopes are an important aspect of language design. They allow declarations to have a local context and so promote good programming style. Scope statments in C++ include a number of different kinds of statements; the SgScopeStatement is a base class for these. Each scope statement contains a symbol table and the SgScopeStatements role is mostly to provide this symbol table and an interface to accessing it.

For internal use only.

This is a base class for scope statements.

Todo:

Where current derived IR nodes from SgScopeStatement contain SgBasicBlock objects, we should consider having them contain SgStatement objects instead of SgBasicBlock. This would avoid current normalizations which are cute, but perhaps unwelcome. We need to discuss and rule on this detail. An alternative would be to let there be a SgBasicBlock and mark it as compiler-generated if it does not appear in the original source code. then the unparser (code generator) could be made to avoid output of the SgBasicblock (and enforce that the number of statements in the block is not greater than one). Effected IR nodes include:

SgCatchOptionStmt (should contain SgStatement)
SgDoWhileStmt (should contain SgStatement)
SgForStatement (should contain SgStatement)
SgIfStmt (should contain true and false SgStatement)
SgSwitchStatement (should contain SgStatement)
SgWhileStmt (should contain SgStatement)
these are currently correct:
SgFunctionDefinition (should contain a SgBasicBlock)
SgGlobal (constains a list of declarations (SgDeclarationStatement objects))
SgNamespaceDefinitionStatement (constains a list of declarations (SgDeclarationStatement objects))
SgClassDefinition (constains a list of declarations (SgDeclarationStatement objects))

Note:

Note about "conditions" used in loop constructs. "Conditionals" are either:

an expression, or
a declaration with initializer
Note also that a SgConditional is different (a ternary operator (<test expr>="">) ? <true part>=""> : <false part>="">;) There are a few errors in ROSE, locations in the IR where statements are used instead of expressions and expression used instead of statements. (reference Appendix A.6)

The following should have the "conditional" concept:

(SgIfStmt) if ( condition ) statement // Currently correct
(SgSwitchStatement) switch ( condition ) statement // Currently uses SgExpression (wrong)
(SgWhileStmt) while ( condition ) statement // Currently correct
(SgForStatement) for ( for-init-statment; condition; expression ) statement // Currently uses SgExpression (wrong)

The following should have an expression:

(SgDoWhileStmt) do statement while ( expression ); // currently uses SgStatement instead of SgExpression

Public Types

typedef SgStatement base_node_type

static_variant = V_SgScopeStatement

enum { static_variant = V_SgScopeStatement }

static variant value More...

Public Member Functions

virtual SgNode * copy (SgCopyHelp &help) const

SgScopeStatement (Sg_File_Info *file_info=NULL)

This is the constructor.

virtual SgName get_qualified_name () const

Returns SgName (a string) representing the name of the current scope.

virtual SgName get_mangled_name () const

size_t count_symbol (const SgName &n)

return number of entries in symbol table for the specified name (note that it is sometime OK for there to be more than 1).

size_t count_alias_symbol (const SgName &n)

Count for alias symbols of a specific name, used in name qualification support.

void insert_symbol (const SgName &n, SgSymbol *s)

Puts a SgSymbol object into the local symbol table.

int lookup_symbol (const SgName &n, SgSymbol *s) const ROSE_DEPRECATED_FUNCTION

bool symbol_exists (const SgName &, SgSymbol *sp) const

bool symbol_exists (const SgName &name) const

bool symbol_exists (const SgSymbol *sp) const

void remove_symbol (SgSymbol *s)

SgSymbol * lookup_symbol (const SgName &n) const

get the first symbol with name (note that "" is a valid name and is used for unnamed declarations) the input name is stored as internal state to support the use of next_XXX_symbol() member function.

SgVariableSymbol * lookup_var_symbol (const SgName &n) const ROSE_DEPRECATED_FUNCTION

SgVariableSymbol * lookup_variable_symbol (const SgName &n) const

SgClassSymbol * lookup_class_symbol (const SgName &n) const

SgFunctionSymbol * lookup_function_symbol (const SgName &n) const

SgFunctionSymbol * lookup_function_symbol (const SgName &n, const SgType *t) const

SgTypedefSymbol * lookup_typedef_symbol (const SgName &n) const

SgEnumSymbol * lookup_enum_symbol (const SgName &n) const

SgEnumFieldSymbol * lookup_enum_field_symbol (const SgName &n) const

SgLabelSymbol * lookup_label_symbol (const SgName &n) const

SgJavaLabelSymbol * lookup_java_label_symbol (const SgName &n) const

SgNamespaceSymbol * lookup_namespace_symbol (const SgName &n) const

SgTemplateSymbol * lookup_template_symbol (const SgName &n) const

SgSymbol * first_any_symbol () const

get the first symbol independent of name (lack of name is stored as internal state)

SgVariableSymbol * first_variable_symbol () const

SgClassSymbol * first_class_symbol () const

SgFunctionSymbol * first_function_symbol () const

SgTypedefSymbol * first_typedef_symbol () const

SgEnumSymbol * first_enum_symbol () const

SgEnumFieldSymbol * first_enum_field_symbol () const

SgLabelSymbol * first_label_symbol () const

SgNamespaceSymbol * first_namespace_symbol () const

SgTemplateSymbol * first_template_symbol () const

SgSymbol * next_any_symbol () const

Only use after lookup_XXX_symbol(const SgName&) or after first_XXX_symbol() These functions use the stored state of the name or lack of name (from the lookup_XXX_symbol(const SgName&) or after first_XXX_symbol() member function) and return the next symbol.

SgVariableSymbol * next_variable_symbol () const

SgClassSymbol * next_class_symbol () const

SgFunctionSymbol * next_function_symbol () const

SgTypedefSymbol * next_typedef_symbol () const

SgEnumSymbol * next_enum_symbol () const

SgEnumFieldSymbol * next_enum_field_symbol () const

SgLabelSymbol * next_label_symbol () const

SgNamespaceSymbol * next_namespace_symbol () const

SgTemplateSymbol * next_template_symbol () const

void print_symboltable (const std::string &str, std::ostream &os=std::cout)

bool containsOnlyDeclarations () const

This function is used to indicate if either the getDeclarationList() or getStatementList() can be called to return a reference to the list of IR nodes (manipulation of the list is then possible).

void insertStatementInScope (SgStatement *newTransformationStatement, bool atTop)

SgDeclarationStatementPtrList & getDeclarationList ()

Gets reference to internal STL list of pointers to SgDeclarationStatement objects (only defined for scopes containing declarations, see bool containsOnlyDeclarations()).

SgStatementPtrList & getStatementList ()

Gets reference to internal STL list of pointers to SgStatement objects (only defined for scopes containing declarations, see bool containsOnlyDeclarations()).

const SgDeclarationStatementPtrList & getDeclarationList () const

const SgStatementPtrList & getStatementList () const

const SgStatementPtrList generateStatementList () const

Generate s list of statements from either the existing list of statements or the list of declarations.

bool supportsDefiningFunctionDeclaration ()

Reports if scope can support defining function declarations. Not all scopes permit function declarations. Any function prototype in a scope appropriate for a function definition triggers requirements for name qualification. This function returns true if the scope is appropriate for the definition of a function or member function (i.e. is a SgGlobal, SgClassDefinition, or SgNamespaceDefinitionStatement).

unsigned int generateUniqueStatementNumberForScope (SgStatement *statement)

Generate a unique number for the statement in the scope.

bool generateUniqueStatementNumberForScopeHelper (unsigned int &counter, SgStatement *statement)

Helper for generateUniqueStatementNumberForScope: return true if the element is found, incrementing the counter once for each element of tree up to either the element of the end of the sub-statements in the current statement.

std::set< SgSymbol * > & get_type_elaboration_list ()

This list of symbols represent types that will require type elaboration when source code is generated.

std::set< SgSymbol * > & get_hidden_type_list ()

This list of symbols represent types that will require name qualification when the type name is output.

std::set< SgSymbol * > & get_hidden_declaration_list ()

This list of symbols represent declarations that will require name qualification when the identifier name is output.

void set_type_elaboration_list (const std::set< SgSymbol * > &type_elaboration_list)

void set_hidden_type_list (const std::set< SgSymbol * > &hidden_type_list)

void set_hidden_declaration_list (const std::set< SgSymbol * > &hidden_declaration_list)

void append_statement (SgStatement *stmt)

Higher level function to handle statements and declarations is scopes.

void prepend_statement (SgStatement *stmt)

SgStatement * firstStatement () const

SgStatement * lastStatement () const

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

bool isCaseInsensitive () const

Query of scope symbol table behavior (is symbol table behavior case sensitive (C/C++) or case insensitive (Fortran).

void setCaseInsensitive (bool b)

bool isNamedScope ()

Some scopes have associated names for purposed of name qualification. This returns true if the scope has a name, false if not.

SgName associatedScopeName ()

Some scopes have associated names for purposed of name qualification. This generates the associated name.

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.

SgScopeStatement (const SgScopeStatementStorageClass &source)

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

SgSymbolTable * get_symbol_table () const

void set_symbol_table (SgSymbolTable *symbol_table)

Sets the pointer to the locally strored SgSymbolTable.

SgTypeTable * get_type_table () const

void set_type_table (SgTypeTable *type_table)

virtual ~SgScopeStatement ()

This is the destructor.

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

SgSymbolTable * p_symbol_table

This pointer is always valid and stores the symbl table.

SgTypeTable * p_type_table

std::set< SgSymbol * > p_type_elaboration_list

std::set< SgSymbol * > p_hidden_type_list

std::set< SgSymbol * > p_hidden_declaration_list

Friends

class AST_FILE_IO

class SgScopeStatementStorageClass

class AstSpecificDataManagingClass

class AstSpecificDataManagingClassStorageClass

SgScopeStatement * isSgScopeStatement (SgNode *s)

Casts pointer from base class to derived class.

const SgScopeStatement * isSgScopeStatement (const SgNode *s)

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

SgScopeStatement * SgScopeStatement_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 SgScopeStatement_getNumberOfValidNodesAndSetGlobalIndexInFreepointer (unsigned long)

Get the size of the memory pool.

void SgScopeStatement_clearMemoryPool ()

void SgScopeStatement_extendMemoryPoolForFileIO (unsigned long)

void SgScopeStatement_getNextValidPointer (std::pair< SgScopeStatement *, std::vector< unsigned char * >::const_iterator > &)

void SgScopeStatement_resetValidFreepointers ()

Member Typedef Documentation

Member Enumeration Documentation

anonymous enum

static variant value

Enumerator:

static_variant

Constructor & Destructor Documentation

SgScopeStatement::SgScopeStatement ( Sg_File_Info * startOfConstruct = NULL )

This is the constructor.

This constructor builds the SgScopeStatement base class.

Parameters:

startOfConstruct

represents the position in the source code

SgScopeStatement::SgScopeStatement ( const SgScopeStatementStorageClass & source )

SgScopeStatement::~SgScopeStatement ( ) [virtual]

This is the destructor.

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

Member Function Documentation

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

SgScopeStatement::get_qualified_name ( ) const [virtual]

Returns SgName (a string) representing the name of the current scope.

See discussion of mangled names in the documentation.

Returns:: Returns SgName (a string).

Reimplemented in SgGlobal, SgBasicBlock, SgFunctionDefinition, SgClassDefinition, SgTemplateInstantiationDefn, SgTemplateClassDefinition, and SgNamespaceDefinitionStatement.

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

Reimplemented in SgGlobal, SgBasicBlock, SgIfStmt, SgForStatement, SgFunctionDefinition, SgClassDefinition, SgTemplateClassDefinition, SgWhileStmt, SgDoWhileStmt, SgSwitchStatement, SgCatchOptionStmt, SgNamespaceDefinitionStatement, SgAssociateStatement, SgFortranDo, SgUpcForAllStatement, and SgJavaForEachStatement.

size_t SgScopeStatement::count_symbol ( const SgName & n )

return number of entries in symbol table for the specified name (note that it is sometime OK for there to be more than 1).

size_t SgScopeStatement::count_alias_symbol ( const SgName & n )

Count for alias symbols of a specific name, used in name qualification support.

SgScopeStatement::insert_symbol	(	const SgName &	name,
		SgSymbol *	symbol
	)

Puts a SgSymbol object into the local symbol table.

Returns:: Returns void.

int SgScopeStatement::lookup_symbol	(	const SgName &	n,
		SgSymbol *	s
	)			const

bool SgScopeStatement::symbol_exists	(	const SgName &	,
		SgSymbol *	sp
	)			const

bool SgScopeStatement::symbol_exists ( const SgName & name ) const

bool SgScopeStatement::symbol_exists ( const SgSymbol * sp ) const

void SgScopeStatement::remove_symbol ( SgSymbol * s )

SgSymbol* SgScopeStatement::lookup_symbol ( const SgName & n ) const

get the first symbol with name (note that "" is a valid name and is used for unnamed declarations) the input name is stored as internal state to support the use of next_XXX_symbol() member function.

SgVariableSymbol* SgScopeStatement::lookup_var_symbol ( const SgName & n ) const

SgVariableSymbol* SgScopeStatement::lookup_variable_symbol ( const SgName & n ) const

SgClassSymbol* SgScopeStatement::lookup_class_symbol ( const SgName & n ) const

SgFunctionSymbol* SgScopeStatement::lookup_function_symbol ( const SgName & n ) const

SgFunctionSymbol* SgScopeStatement::lookup_function_symbol	(	const SgName &	n,
		const SgType *	t
	)			const

SgTypedefSymbol* SgScopeStatement::lookup_typedef_symbol ( const SgName & n ) const

SgEnumSymbol* SgScopeStatement::lookup_enum_symbol ( const SgName & n ) const

SgEnumFieldSymbol* SgScopeStatement::lookup_enum_field_symbol ( const SgName & n ) const

SgLabelSymbol* SgScopeStatement::lookup_label_symbol ( const SgName & n ) const

SgJavaLabelSymbol* SgScopeStatement::lookup_java_label_symbol ( const SgName & n ) const

SgNamespaceSymbol* SgScopeStatement::lookup_namespace_symbol ( const SgName & n ) const

SgTemplateSymbol* SgScopeStatement::lookup_template_symbol ( const SgName & n ) const

SgSymbol* SgScopeStatement::first_any_symbol ( ) const

get the first symbol independent of name (lack of name is stored as internal state)

SgVariableSymbol* SgScopeStatement::first_variable_symbol ( ) const

SgClassSymbol* SgScopeStatement::first_class_symbol ( ) const

SgFunctionSymbol* SgScopeStatement::first_function_symbol ( ) const

SgTypedefSymbol* SgScopeStatement::first_typedef_symbol ( ) const

SgEnumSymbol* SgScopeStatement::first_enum_symbol ( ) const

SgEnumFieldSymbol* SgScopeStatement::first_enum_field_symbol ( ) const

SgLabelSymbol* SgScopeStatement::first_label_symbol ( ) const

SgNamespaceSymbol* SgScopeStatement::first_namespace_symbol ( ) const

SgTemplateSymbol* SgScopeStatement::first_template_symbol ( ) const

SgSymbol* SgScopeStatement::next_any_symbol ( ) const

Only use after lookup_XXX_symbol(const SgName&) or after first_XXX_symbol() These functions use the stored state of the name or lack of name (from the lookup_XXX_symbol(const SgName&) or after first_XXX_symbol() member function) and return the next symbol.

SgVariableSymbol* SgScopeStatement::next_variable_symbol ( ) const

SgClassSymbol* SgScopeStatement::next_class_symbol ( ) const

SgFunctionSymbol* SgScopeStatement::next_function_symbol ( ) const

SgTypedefSymbol* SgScopeStatement::next_typedef_symbol ( ) const

SgEnumSymbol* SgScopeStatement::next_enum_symbol ( ) const

SgEnumFieldSymbol* SgScopeStatement::next_enum_field_symbol ( ) const

SgLabelSymbol* SgScopeStatement::next_label_symbol ( ) const

SgNamespaceSymbol* SgScopeStatement::next_namespace_symbol ( ) const

SgTemplateSymbol* SgScopeStatement::next_template_symbol ( ) const

void SgScopeStatement::print_symboltable	(	const std::string &	str,
		std::ostream &	os = `std::cout`
	)

bool SgScopeStatement::containsOnlyDeclarations ( ) const

This function is used to indicate if either the getDeclarationList() or getStatementList() can be called to return a reference to the list of IR nodes (manipulation of the list is then possible).

void SgScopeStatement::insertStatementInScope	(	SgStatement *	newTransformationStatement,
		bool	atTop
	)

SgScopeStatement::getDeclarationList ( )

Gets reference to internal STL list of pointers to SgDeclarationStatement objects (only defined for scopes containing declarations, see bool containsOnlyDeclarations()).

This function is useful for SgScopeStatement objects that contain declarations, and is not defined (returns an error) if called on a SgClassDefinition, SgTemplateInstantiationDefn, SgGlobal, SgNamespaceDefinitionStatement. To test if a scope contains only declarations use "bool containsOnlyDeclarations()". Because this function returns a reference to the list (instead of a list of pointers to the declarations or statements) any modification of the list is a modification of the AST.

Returns:: STL list of pointers to SgDeclarationStatement objects.

SgScopeStatement::getStatementList ( )

Gets reference to internal STL list of pointers to SgStatement objects (only defined for scopes containing declarations, see bool containsOnlyDeclarations()).

This function is useful for SgScopeStatement objects that contain non-declarations (lists of SgStatement instead of lists of SgDeclarationStatement IR nodes). Because this function returns a reference to the list (instead of a list of pointers to the declarations or statements) any modification of the list is a modification of the AST.

Returns:: STL list of pointers to SgStatement objects.

const SgDeclarationStatementPtrList& SgScopeStatement::getDeclarationList ( ) const

const SgStatementPtrList& SgScopeStatement::getStatementList ( ) const

const SgStatementPtrList SgScopeStatement::generateStatementList ( ) const

Generate s list of statements from either the existing list of statements or the list of declarations.

This permits access via a common type (SgStatement). (this list is constructed and manipulation of it will not effect the scope's SgStatementPtrList or SgDeclarationStatementPtrList. So this should be considered to be a read only list.

bool SgScopeStatement::supportsDefiningFunctionDeclaration ( )

Reports if scope can support defining function declarations. Not all scopes permit function declarations. Any function prototype in a scope appropriate for a function definition triggers requirements for name qualification. This function returns true if the scope is appropriate for the definition of a function or member function (i.e. is a SgGlobal, SgClassDefinition, or SgNamespaceDefinitionStatement).

unsigned int SgScopeStatement::generateUniqueStatementNumberForScope ( SgStatement * statement )

Generate a unique number for the statement in the scope.

bool SgScopeStatement::generateUniqueStatementNumberForScopeHelper	(	unsigned int &	counter,
		SgStatement *	statement
	)

Helper for generateUniqueStatementNumberForScope: return true if the element is found, incrementing the counter once for each element of tree up to either the element of the end of the sub-statements in the current statement.

std::set<SgSymbol*>& SgScopeStatement::get_type_elaboration_list ( )

This list of symbols represent types that will require type elaboration when source code is generated.

std::set<SgSymbol*>& SgScopeStatement::get_hidden_type_list ( )

This list of symbols represent types that will require name qualification when the type name is output.

std::set<SgSymbol*>& SgScopeStatement::get_hidden_declaration_list ( )

This list of symbols represent declarations that will require name qualification when the identifier name is output.

void SgScopeStatement::set_type_elaboration_list ( const std::set< SgSymbol * > & type_elaboration_list )

void SgScopeStatement::set_hidden_type_list ( const std::set< SgSymbol * > & hidden_type_list )

void SgScopeStatement::set_hidden_declaration_list ( const std::set< SgSymbol * > & hidden_declaration_list )

void SgScopeStatement::append_statement ( SgStatement * stmt )

Higher level function to handle statements and declarations is scopes.

Reimplemented in SgBasicBlock, and SgFunctionDefinition.

void SgScopeStatement::prepend_statement ( SgStatement * stmt )

Reimplemented in SgBasicBlock, and SgFunctionDefinition.

SgStatement* SgScopeStatement::firstStatement ( ) const

SgStatement* SgScopeStatement::lastStatement ( ) const

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

Reimplemented from SgStatement.

Reimplemented in SgGlobal, SgBasicBlock, SgIfStmt, SgForStatement, SgFunctionDefinition, SgClassDefinition, SgTemplateInstantiationDefn, SgWhileStmt, SgDoWhileStmt, SgSwitchStatement, SgCatchOptionStmt, and SgNamespaceDefinitionStatement.

bool SgScopeStatement::isCaseInsensitive ( ) const

Query of scope symbol table behavior (is symbol table behavior case sensitive (C/C++) or case insensitive (Fortran).

void SgScopeStatement::setCaseInsensitive ( bool b )

bool SgScopeStatement::isNamedScope ( )

Some scopes have associated names for purposed of name qualification. This returns true if the scope has a name, false if not.

SgName SgScopeStatement::associatedScopeName ( )

Some scopes have associated names for purposed of name qualification. This generates the associated name.

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

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

Reimplemented from SgStatement.

Reimplemented in SgGlobal, SgBasicBlock, SgIfStmt, SgForStatement, SgFunctionDefinition, SgTemplateFunctionDefinition, SgClassDefinition, SgTemplateInstantiationDefn, SgTemplateClassDefinition, SgWhileStmt, SgDoWhileStmt, SgSwitchStatement, SgCatchOptionStmt, SgNamespaceDefinitionStatement, SgBlockDataStatement, SgAssociateStatement, SgFortranDo, SgFortranNonblockedDo, SgForAllStatement, SgUpcForAllStatement, SgCAFWithTeamStatement, SgJavaForEachStatement, and SgJavaLabelStatement.

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

returns new style SageIII enum values

Reimplemented from SgStatement.

void* SgScopeStatement::operator new ( size_t size )

returns pointer to newly allocated IR node

Reimplemented from SgStatement.

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

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

Reimplemented from SgStatement.

void SgScopeStatement::operator delete ( void * pointer )

static size_t SgScopeStatement::numberOfNodes ( ) [static]

Returns the total number of IR nodes of this type.

Reimplemented from SgStatement.

static size_t SgScopeStatement::memoryUsage ( ) [static]

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

Reimplemented from SgStatement.

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

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

virtual size_t SgScopeStatement::get_numberOfTraversalSuccessors ( ) [virtual]

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

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

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

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

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

Reimplemented from SgStatement.

void SgScopeStatement::executeVisitorMemberFunction ( ROSE_VisitorPattern & visitor )

FOR INTERNAL USE Support for visitor pattern.

Reimplemented from SgStatement.

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

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

Reimplemented from SgStatement.

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

FOR INTERNAL USE Support for visitor pattern.

Reimplemented from SgStatement.

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

FOR INTERNAL USE Support for visitor pattern.

Reimplemented from SgStatement.

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

FOR INTERNAL USE Support for type-based traversal.

Reimplemented from SgStatement.

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

virtual void SgScopeStatement::checkDataMemberPointersIfInMemoryPool ( ) [virtual]

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

Reimplemented from SgStatement.

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

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

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

SgScopeStatement* SgScopeStatement::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 SgStatement.

void SgScopeStatement::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 SgStatement.

SgSymbolTable* SgScopeStatement::get_symbol_table ( ) const

SgScopeStatement::set_symbol_table ( SgSymbolTable * symbolTable )

Sets the pointer to the locally strored SgSymbolTable.

Returns:: Returns void.

SgTypeTable* SgScopeStatement::get_type_table ( ) const

void SgScopeStatement::set_type_table ( SgTypeTable * type_table )

Friends And Related Function Documentation

friend class AST_FILE_IO [friend]

friend class SgScopeStatementStorageClass [friend]

friend class AstSpecificDataManagingClass [friend]

friend class AstSpecificDataManagingClassStorageClass [friend]

SgScopeStatement::isSgScopeStatement ( SgNode * s ) [friend]

Casts pointer from base class to derived class.

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

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

SgScopeStatement::isSgScopeStatement ( const SgNode * s ) [friend]

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

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

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

SgScopeStatement* SgScopeStatement_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 SgScopeStatement_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 SgScopeStatement_clearMemoryPool ( ) [friend]

void SgScopeStatement_extendMemoryPoolForFileIO ( unsigned long ) [friend]

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

void SgScopeStatement_resetValidFreepointers ( ) [friend]

Member Data Documentation

SgScopeStatement::p_symbol_table [protected]

This pointer is always valid and stores the symbl table.

For internal use only.

The symbol table implementation was changed in fall of 2004, by Alin. It is not simple and leverages STL and provides more features.

SgTypeTable* SgScopeStatement::p_type_table [protected]

std::set<SgSymbol*> SgScopeStatement::p_type_elaboration_list [protected]

std::set<SgSymbol*> SgScopeStatement::p_hidden_type_list [protected]

std::set<SgSymbol*> SgScopeStatement::p_hidden_declaration_list [protected]

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

Generated on Tue Jan 31 05:42:52 2012 for ROSE by

1.4.7


Public Types
typedef SgStatement	base_node_type
	static_variant = V_SgScopeStatement
enum	{ static_variant = V_SgScopeStatement }
	static variant value More...
Public Member Functions
virtual SgNode *	copy (SgCopyHelp &help) const
	SgScopeStatement (Sg_File_Info *file_info=NULL)
	This is the constructor.
virtual SgName	get_qualified_name () const
	Returns SgName (a string) representing the name of the current scope.
virtual SgName	get_mangled_name () const
size_t	count_symbol (const SgName &n)
	return number of entries in symbol table for the specified name (note that it is sometime OK for there to be more than 1).
size_t	count_alias_symbol (const SgName &n)
	Count for alias symbols of a specific name, used in name qualification support.
void	insert_symbol (const SgName &n, SgSymbol *s)
	Puts a SgSymbol object into the local symbol table.
int	lookup_symbol (const SgName &n, SgSymbol *s) const ROSE_DEPRECATED_FUNCTION
bool	symbol_exists (const SgName &, SgSymbol *sp) const
bool	symbol_exists (const SgName &name) const
bool	symbol_exists (const SgSymbol *sp) const
void	remove_symbol (SgSymbol *s)
SgSymbol *	lookup_symbol (const SgName &n) const
	get the first symbol with name (note that "" is a valid name and is used for unnamed declarations) the input name is stored as internal state to support the use of next_XXX_symbol() member function.
SgVariableSymbol *	lookup_var_symbol (const SgName &n) const ROSE_DEPRECATED_FUNCTION
SgVariableSymbol *	lookup_variable_symbol (const SgName &n) const
SgClassSymbol *	lookup_class_symbol (const SgName &n) const
SgFunctionSymbol *	lookup_function_symbol (const SgName &n) const
SgFunctionSymbol *	lookup_function_symbol (const SgName &n, const SgType *t) const
SgTypedefSymbol *	lookup_typedef_symbol (const SgName &n) const
SgEnumSymbol *	lookup_enum_symbol (const SgName &n) const
SgEnumFieldSymbol *	lookup_enum_field_symbol (const SgName &n) const
SgLabelSymbol *	lookup_label_symbol (const SgName &n) const
SgJavaLabelSymbol *	lookup_java_label_symbol (const SgName &n) const
SgNamespaceSymbol *	lookup_namespace_symbol (const SgName &n) const
SgTemplateSymbol *	lookup_template_symbol (const SgName &n) const
SgSymbol *	first_any_symbol () const
	get the first symbol independent of name (lack of name is stored as internal state)
SgVariableSymbol *	first_variable_symbol () const
SgClassSymbol *	first_class_symbol () const
SgFunctionSymbol *	first_function_symbol () const
SgTypedefSymbol *	first_typedef_symbol () const
SgEnumSymbol *	first_enum_symbol () const
SgEnumFieldSymbol *	first_enum_field_symbol () const
SgLabelSymbol *	first_label_symbol () const
SgNamespaceSymbol *	first_namespace_symbol () const
SgTemplateSymbol *	first_template_symbol () const
SgSymbol *	next_any_symbol () const
	Only use after lookup_XXX_symbol(const SgName&) or after first_XXX_symbol() These functions use the stored state of the name or lack of name (from the lookup_XXX_symbol(const SgName&) or after first_XXX_symbol() member function) and return the next symbol.
SgVariableSymbol *	next_variable_symbol () const
SgClassSymbol *	next_class_symbol () const
SgFunctionSymbol *	next_function_symbol () const
SgTypedefSymbol *	next_typedef_symbol () const
SgEnumSymbol *	next_enum_symbol () const
SgEnumFieldSymbol *	next_enum_field_symbol () const
SgLabelSymbol *	next_label_symbol () const
SgNamespaceSymbol *	next_namespace_symbol () const
SgTemplateSymbol *	next_template_symbol () const
void	print_symboltable (const std::string &str, std::ostream &os=std::cout)
bool	containsOnlyDeclarations () const
	This function is used to indicate if either the getDeclarationList() or getStatementList() can be called to return a reference to the list of IR nodes (manipulation of the list is then possible).
void	insertStatementInScope (SgStatement *newTransformationStatement, bool atTop)
SgDeclarationStatementPtrList &	getDeclarationList ()
	Gets reference to internal STL list of pointers to SgDeclarationStatement objects (only defined for scopes containing declarations, see bool containsOnlyDeclarations()).
SgStatementPtrList &	getStatementList ()
	Gets reference to internal STL list of pointers to SgStatement objects (only defined for scopes containing declarations, see bool containsOnlyDeclarations()).
const SgDeclarationStatementPtrList &	getDeclarationList () const
const SgStatementPtrList &	getStatementList () const
const SgStatementPtrList	generateStatementList () const
	Generate s list of statements from either the existing list of statements or the list of declarations.
bool	supportsDefiningFunctionDeclaration ()
	Reports if scope can support defining function declarations. Not all scopes permit function declarations. Any function prototype in a scope appropriate for a function definition triggers requirements for name qualification. This function returns true if the scope is appropriate for the definition of a function or member function (i.e. is a SgGlobal, SgClassDefinition, or SgNamespaceDefinitionStatement).
unsigned int	generateUniqueStatementNumberForScope (SgStatement *statement)
	Generate a unique number for the statement in the scope.
bool	generateUniqueStatementNumberForScopeHelper (unsigned int &counter, SgStatement *statement)
	Helper for generateUniqueStatementNumberForScope: return true if the element is found, incrementing the counter once for each element of tree up to either the element of the end of the sub-statements in the current statement.
std::set< SgSymbol * > &	get_type_elaboration_list ()
	This list of symbols represent types that will require type elaboration when source code is generated.
std::set< SgSymbol * > &	get_hidden_type_list ()
	This list of symbols represent types that will require name qualification when the type name is output.
std::set< SgSymbol * > &	get_hidden_declaration_list ()
	This list of symbols represent declarations that will require name qualification when the identifier name is output.
void	set_type_elaboration_list (const std::set< SgSymbol * > &type_elaboration_list)
void	set_hidden_type_list (const std::set< SgSymbol * > &hidden_type_list)
void	set_hidden_declaration_list (const std::set< SgSymbol * > &hidden_declaration_list)
void	append_statement (SgStatement *stmt)
	Higher level function to handle statements and declarations is scopes.
void	prepend_statement (SgStatement *stmt)
SgStatement *	firstStatement () const
SgStatement *	lastStatement () const
virtual void	fixupCopy (SgNode *copy, SgCopyHelp &help) const
bool	isCaseInsensitive () const
	Query of scope symbol table behavior (is symbol table behavior case sensitive (C/C++) or case insensitive (Fortran).
void	setCaseInsensitive (bool b)
bool	isNamedScope ()
	Some scopes have associated names for purposed of name qualification. This returns true if the scope has a name, false if not.
SgName	associatedScopeName ()
	Some scopes have associated names for purposed of name qualification. This generates the associated name.
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.
	SgScopeStatement (const SgScopeStatementStorageClass &source)
SgScopeStatement *	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.
SgSymbolTable *	get_symbol_table () const
void	set_symbol_table (SgSymbolTable *symbol_table)
	Sets the pointer to the locally strored SgSymbolTable.
SgTypeTable *	get_type_table () const
void	set_type_table (SgTypeTable *type_table)
virtual	~SgScopeStatement ()
	This is the destructor.
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
SgSymbolTable *	p_symbol_table
	This pointer is always valid and stores the symbl table.
SgTypeTable *	p_type_table
std::set< SgSymbol * >	p_type_elaboration_list
std::set< SgSymbol * >	p_hidden_type_list
std::set< SgSymbol * >	p_hidden_declaration_list
Friends
class	AST_FILE_IO
class	SgScopeStatementStorageClass
class	AstSpecificDataManagingClass
class	AstSpecificDataManagingClassStorageClass
SgScopeStatement *	isSgScopeStatement (SgNode *s)
	Casts pointer from base class to derived class.
const SgScopeStatement *	isSgScopeStatement (const SgNode *s)
	Casts pointer from base class to derived class (for const pointers).
SgScopeStatement *	SgScopeStatement_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	SgScopeStatement_getNumberOfValidNodesAndSetGlobalIndexInFreepointer (unsigned long)
	Get the size of the memory pool.
void	SgScopeStatement_clearMemoryPool ()
void	SgScopeStatement_extendMemoryPoolForFileIO (unsigned long)
void	SgScopeStatement_getNextValidPointer (std::pair< SgScopeStatement , std::vector< unsigned char >::const_iterator > &)
void	SgScopeStatement_resetValidFreepointers ()