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

#include <Cxx_Grammar.h>

Inheritance diagram for SgScopeStatement:

Collaboration diagram for SgScopeStatement:

Public Types
enum	{ static_variant = V_SgScopeStatement }
	static variant value More...

typedef SgStatement	base_node_type

Public Types inherited from SgStatement
enum	{ static_variant = V_SgStatement }
	static variant value More...

typedef SgLocatedNode	base_node_type

Public Types inherited from SgLocatedNode
enum	{ static_variant = V_SgLocatedNode }
	static variant value More...

typedef SgNode	base_node_type

Public Types inherited from SgNode
enum	{ static_variant = V_SgNode }
	static variant value More...

Public Member Functions
virtual SgNode *	copy (SgCopyHelp &help) const
	Makes a copy (deap of shallow depending on SgCopyHelp). More...

	SgScopeStatement (Sg_File_Info *file_info=NULL)
	This is the constructor. More...

virtual SgName	get_qualified_name () const
	Returns SgName (a string) representing the name of the current scope. More...

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

size_t	count_alias_symbol (const SgName &n)
	Count for alias symbols of a specific name, used in name qualification support. More...

size_t	symbol_table_size ()
	Return the size of the symbol table. More...

void	insert_symbol (const SgName &n, SgSymbol *s)
	Puts a SgSymbol object into the local symbol table. More...

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, SgTemplateParameterPtrList templateParameterList=NULL, SgTemplateArgumentPtrList templateArgumentList=NULL) 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. More...

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, SgTemplateArgumentPtrList *templateArgumentsList=NULL) const

SgFunctionSymbol *	lookup_function_symbol (const SgName &n) const

SgFunctionSymbol *	lookup_function_symbol (const SgName &n, const SgType t, SgTemplateArgumentPtrList templateArgumentsList=NULL) 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

SgTemplateClassSymbol *	lookup_template_class_symbol (const SgName &n, SgTemplateParameterPtrList templateParameterList, SgTemplateArgumentPtrList templateSpecializationArgumentList) const

SgClassSymbol *	lookup_nontemplate_class_symbol (const SgName &n, SgTemplateArgumentPtrList *templateArgumentsList) const

SgTemplateFunctionSymbol *	lookup_template_function_symbol (const SgName &n, const SgType t, SgTemplateParameterPtrList templateParameterList) const

SgFunctionSymbol *	lookup_nontemplate_function_symbol (const SgName &n, const SgType t, SgTemplateArgumentPtrList templateArgumentsList=NULL) const

SgTemplateMemberFunctionSymbol *	lookup_template_member_function_symbol (const SgName &n, const SgType t, SgTemplateParameterPtrList templateParameterList) const

SgMemberFunctionSymbol *	lookup_nontemplate_member_function_symbol (const SgName &n, const SgType t, SgTemplateArgumentPtrList templateArgumentsList=NULL) const

SgSymbol *	first_any_symbol () const
	get the first symbol independent of name (lack of name is stored as internal state) More...

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

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)

void	print_symboltable (const std::string &label, VariantT nodeType)

void	print_symboltable (const std::string &str)

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

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

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

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

bool	statementExistsInScope (SgStatement *statement)
	Test for existence of statement is scope. More...

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

unsigned int	generateUniqueStatementNumberForScope (SgStatement *statement)
	Generate a unique number for the statement in the scope. More...

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

std::set< SgSymbol * > &	get_type_elaboration_list ()
	This list of symbols represent types that will require type elaboration when source code is generated. More...

std::set< SgSymbol * > &	get_hidden_type_list ()
	This list of symbols represent types that will require name qualification when the type name is output. More...

std::set< SgSymbol * > &	get_hidden_declaration_list ()
	This list of symbols represent declarations that will require name qualification when the identifier name is output. More...

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

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

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

SgName	associatedScopeName ()
	Some scopes have associated names for purposed of name qualification. This generates the associated name. More...

SgSymbolTable *	get_symbol_table () const
	Returns a pointer to the locally strored SgSymbolTable. More...

void	set_symbol_table (SgSymbolTable *symbol_table)
	Sets the pointer to the locally strored SgSymbolTable. More...

template<class T >
SgFunctionSymbol *	find_symbol_by_type_of_function (const SgName &name, const SgType func_type, SgTemplateParameterPtrList templateParameterList, SgTemplateArgumentPtrList *templateArgumentList)

template<class T >
SgSymbol *	find_symbol_from_declaration (const T *node) const

virtual std::string	class_name () const
	Copies AST (whole subtree, depending on the SgCopyHelp class. More...

virtual VariantT	variantT () const
	returns new style SageIII enum values More...

void *	operator new (size_t size)
	returns pointer to newly allocated IR node More...

void	operator delete (void *pointer, size_t size)
	deallocated memory for IR node (returns memory to memory pool for reuse) More...

void	operator delete (void *pointer)

virtual std::vector< SgNode * >	get_traversalSuccessorContainer ()
	FOR INTERNAL USE within ROSE traverals mechanism only. More...

virtual std::vector< std::string >	get_traversalSuccessorNamesContainer ()
	FOR INTERNAL USE within ROSE traverals mechanism only. More...

virtual size_t	get_numberOfTraversalSuccessors ()

virtual SgNode *	get_traversalSuccessorByIndex (size_t idx)

virtual size_t	get_childIndex (SgNode *child)

virtual RTIReturnType	roseRTI ()
	FOR INTERNAL USE Access to Runtime Type Information (RTI) for this IR nodes. More...

virtual const char *	sage_class_name () const ROSE_DEPRECATED_FUNCTION

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

virtual void	accept (ROSE_VisitorPattern &visitor)
	DXN (08/09/2010): support for the classic visitor pattern done in GoF. More...

virtual bool	isInMemoryPool ()
	FOR INTERNAL USE This is used in internal tests to verify that all IR nodes are allocated from the heap. More...

virtual void	checkDataMemberPointersIfInMemoryPool ()
	FOR INTERNAL USE This is used in internal tests to verify that all IR nodes are allocated from the heap. More...

virtual std::vector< std::pair < SgNode *, std::string > >	returnDataMemberPointers () const
	FOR INTERNAL USE Returns STL vector of pairs of SgNode* and strings for use in AST tools More...

virtual void	processDataMemberReferenceToPointers (ReferenceToPointerHandler *)
	FOR INTERNAL USE Processes pairs of references to SgNode* and strings for use in AST tools More...

virtual long	getChildIndex (SgNode *childNode) const
	FOR INTERNAL USE Returns a unique index value for the childNode in the list of children at this IR node. More...

	SgScopeStatement (const SgScopeStatementStorageClass &source)

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

void	post_construction_initialization ()
	Final initialization for constructors This function is called at the end of generated constructors to allow the specification writer to add special initialization functions or tests. Default is to do nothing. Otherwise it should be overridden in the spec file, in NewHeaderCode/NewOutlinedCode. More...

SgTypeTable *	get_type_table () const

void	set_type_table (SgTypeTable *type_table)

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

Public Member Functions inherited from SgStatement
virtual SgScopeStatement *	get_scope (void) const
	Returns scope of current statement. More...

virtual void	setExtern () ROSE_DEPRECATED_FUNCTION
	This function sets "extern" status for the current statement. More...

virtual void	setStatic () ROSE_DEPRECATED_FUNCTION
	This function sets "static" status for the current statement. More...

void	insert_statement (SgStatement target, SgStatement newstmt, bool inFront=true)
	This function inserts a single statement at the position indicated by target. More...

void	insert_statement (SgStatement *target, const SgStatementPtrList &newstmtList, bool inFront=true)
	This function inserts a list of statements at the position indicated by target. More...

void	replace_statement (SgStatement target, SgStatement newstmt)
	This function replaces the target statement with a single statement. More...

void	replace_statement (SgStatement *target, const SgStatementPtrList &newstmtList)
	This function replaces the target statement with a list of statements. More...

void	remove_statement (SgStatement *)
	This function removes the target statement from the AST. More...

void	insert_statement_from_basicBlock (SgStatement target, SgStatement newstmt, bool inFront=true)
	This function inserts a statement at the position indicated by target. If newstmt is a basicBlock, statements inside newstmt are extracted and then inserted. More...

void	replace_statement_from_basicBlock (SgStatement target, SgStatement newstmt)
	This function replaces the target statement with a new statement. If newstmt is a basicBlock, statements inside newstmt are extracted and then inserted. More...

virtual int	replace_expression (SgExpression , SgExpression )
	support general replace functions, used in statements that directly contain SgExpression IR nodes. More...

virtual void	set_scope (SgScopeStatement *newScope)
	Support for setting scopes (only meaningful on IR statements that store the scope explicitly). More...

virtual bool	hasExplicitScope () const
	Support for where the scope is explicitly required. More...

virtual SgSymbol *	get_symbol_from_symbol_table () const
	Get the associated symbol from the symbol table in the stored scope. More...

virtual unsigned int	cfgIndexForEnd () const
	Determine the CFG index for the end of this construct. More...

virtual bool	cfgIsIndexInteresting (unsigned int index) const
	Determine whether a particular CFG node index is "interesting" for this kind of node. More...

virtual unsigned int	cfgFindChildIndex (SgNode *n)
	Find the index of n in this node's CFG children. More...

virtual unsigned int	cfgFindNextChildIndex (SgNode *n)
	Find the index just after n in this node's CFG children. More...

virtual std::vector < VirtualCFG::CFGEdge >	cfgOutEdges (unsigned int index)
	Find the out edges of a CFG node – internal version. More...

virtual std::vector < VirtualCFG::CFGEdge >	cfgInEdges (unsigned int index)
	Find the in edges of a CFG node – internal version. More...

virtual bool	isChildUsedAsLValue (const SgExpression *child) const
	Virtual function to determine if the provided expression is used as an l-value within the cotext of this statement. More...

virtual void	set_end_numeric_label (SgLabelRefExp *end_numeric_label)

virtual bool	has_end_numeric_label () const

bool	hasExplicitType ()
	Some statement store internal SgType pointers explicitly. This function is true if it has a data member that is a type (only applies to SgTypedefDeclaration). More...

void *	operator new (size_t size)
	returns pointer to newly allocated IR node More...

void	operator delete (void *pointer, size_t size)
	deallocated memory for IR node (returns memory to memory pool for reuse) More...

void	operator delete (void *pointer)

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

	SgStatement (const SgStatementStorageClass &source)

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

SgLabelRefExp *	get_numeric_label () const

void	set_numeric_label (SgLabelRefExp *numeric_label)

int	get_source_sequence_value () const

void	set_source_sequence_value (int source_sequence_value)

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

	SgStatement (Sg_File_Info *startOfConstruct)
	This is the constructor. More...

	SgStatement ()

Public Member Functions inherited from SgLocatedNode
const std::string &	getFilenameString () const

void	addToAttachedPreprocessingInfo (PreprocessingInfo *prepInfoPtr, PreprocessingInfo::RelativePositionType locationInList=PreprocessingInfo::after)
	This function adds comment or CPP directives to the current IR node. More...

virtual Sg_File_Info *	get_file_info () const
	Interface function to implement original SAGE interface to SgFile_Info objects. More...

virtual void	set_file_info (Sg_File_Info *X)
	Access function calls set_startingConstruct(Sg_File_Info*) member function. More...

void	setCompilerGenerated ()
	Allow IR nodes (mostly SgLocatedNode) to be marked as compiler generated. More...

void	unsetCompilerGenerated ()

void	setFrontendSpecific ()
	Allow IR nodes (mostly SgLocatedNode) to be marked as front-end specific (generated by the front-end to support a specific backend compiler; e.g. GNU gcc and g++). More...

void	unsetFrontendSpecific ()

void	setSourcePositionUnavailableInFrontend ()
	Allow IR nodes (mostly SgLocatedNode) to be marked as to when the information was unavilable in the front-end (even if it typically is there are special cases). More...

void	unsetSourcePositionUnavailableInFrontend ()

void	setOutputInCodeGeneration ()
	Allow IR nodes (mostly SgLocatedNode) to be marked as to when the information was unavilable in the front-end (even if it typically is there are special cases). More...

void	unsetOutputInCodeGeneration ()

AttachedPreprocessingInfoType *&	getAttachedPreprocessingInfo (void)
	Computes the number of nodes in the defined subtree of the AST. More...

Sg_File_Info *	generateMatchingFileInfo ()

virtual void	addNewAttribute (std::string s, AstAttribute *a)
	Add a new attribute represented by the named string. More...

virtual AstAttribute *	getAttribute (std::string s) const
	Returns attribute of name 's'. More...

virtual void	updateAttribute (std::string s, AstAttribute *a)
	Replace existing attribute of name 's' with new AstAttribute. More...

virtual void	setAttribute (std::string s, AstAttribute *a)
	This is a wrapper function with the following semantics: if no attribute of name 's' exists then addNewAttribute(s,a); is called, otherwise updateAttribute(s,a); is called. More...

virtual void	removeAttribute (std::string s)
	Remove attribute of name 's' if present. More...

virtual bool	attributeExists (std::string s) const
	Tests if attribute of name 's' is present. More...

virtual int	numberOfAttributes () const
	Returns the number of attributes on this IR node. More...

void *	operator new (size_t size)
	returns pointer to newly allocated IR node More...

void	operator delete (void *pointer, size_t size)
	deallocated memory for IR node (returns memory to memory pool for reuse) More...

void	operator delete (void *pointer)

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

	SgLocatedNode (const SgLocatedNodeStorageClass &source)

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

Sg_File_Info *	get_startOfConstruct () const
	New function interface for Sg_File_Info data stores starting location of contruct (typically the opening brace or first letter of keyword). More...

void	set_startOfConstruct (Sg_File_Info *startOfConstruct)
	This function sets the current source location position of the start of the current construct. More...

Sg_File_Info *	get_endOfConstruct () const
	New function interface for Sg_File_Info data stores ending location of contruct (typically the closing brace). More...

void	set_endOfConstruct (Sg_File_Info *endOfConstruct)
	This function sets the current source location position of the end of the current construct. More...

AttachedPreprocessingInfoType *	get_attachedPreprocessingInfoPtr () const

void	set_attachedPreprocessingInfoPtr (AttachedPreprocessingInfoType *attachedPreprocessingInfoPtr)

AstAttributeMechanism *	get_attributeMechanism () const
	FOR INTERNAL USE Access function; if an attribute exists then a pointer to it is returned, else error. More...

void	set_attributeMechanism (AstAttributeMechanism *attributeMechanism)
	FOR INTERNAL USE Access function; sets poiner to value AstAttributeMechanism. More...

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

	SgLocatedNode (Sg_File_Info *startOfConstruct=NULL)
	This is the constructor. More...

Public Member Functions inherited from SgNode
void *	operator new (size_t size)
	returns pointer to newly allocated IR node More...

void	operator delete (void *pointer, size_t size)
	deallocated memory for IR node (returns memory to memory pool for reuse) More...

void	operator delete (void *pointer)

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

	SgNode (const SgNodeStorageClass &source)

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

void	set_isModified (bool isModified)
	All nodes in the AST contain a isModified flag used to track changes to the AST. More...

bool	get_isModified () const
	Acess function for isModified flag This flag records if the current IR node has been modified. It is set to false after and ROSE front-end processing. More...

void	set_parent (SgNode *parent)
	All nodes in the AST contain a reference to a parent node. More...

SgNode *	get_parent () const
	Access function for parent node. More...

bool	isChild (SgNode *node) const
	Query function for if the input IR nodes is a child of the current IR node. More...

virtual std::string	unparseToString (SgUnparse_Info *info) const
	This function unparses the AST node (excluding comments and unnecessary white space) More...

std::string	unparseToString () const

std::string	unparseToCompleteString ()
	This function unparses the AST node (including comments and white space) More...

int	variant () const ROSE_DEPRECATED_FUNCTION
	Older version function returns enum value "NODE". More...

VirtualCFG::CFGNode	cfgForBeginning ()
	Returns the CFG node for just before this AST node. More...

VirtualCFG::CFGNode	cfgForEnd ()
	Returns the CFG node for just after this AST node. More...

int	numberOfNodesInSubtree ()
	Computes the number of nodes in the defined subtree of the AST. More...

int	depthOfSubtree ()
	Computes the depth of the current defined subtree of the AST. More...

SgNode *	get_freepointer () const

void	set_freepointer (SgNode *freepointer)

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

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

bool	get_isVisited () const ROSE_DEPRECATED_FUNCTION
	DOCS IN HEADER: Access function for p_isVisited flag used previously by the AST traversals. More...

void	set_isVisited (bool isVisited) ROSE_DEPRECATED_FUNCTION
	Access function for p_isVisited flag used previously by the AST traversals. More...

Static Public Member Functions
static bool	isEquivalentScope (SgScopeStatement scope1, SgScopeStatement scope2)

static size_t	numberOfNodes ()
	Returns the total number of IR nodes of this type. More...

static size_t	memoryUsage ()
	Returns the size in bytes of the total memory allocated for all IR nodes of this type. More...

static void	traverseMemoryPoolNodes (ROSE_VisitTraversal &visit)
	FOR INTERNAL USE Support for visitor pattern. More...

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

static void	visitRepresentativeNode (ROSE_VisitTraversal &visit)
	FOR INTERNAL USE Support for type-based traversal. More...

Static Public Member Functions inherited from SgStatement
static size_t	numberOfNodes ()
	Returns the total number of IR nodes of this type. More...

static size_t	memoryUsage ()
	Returns the size in bytes of the total memory allocated for all IR nodes of this type. More...

static void	traverseMemoryPoolNodes (ROSE_VisitTraversal &visit)
	FOR INTERNAL USE Support for visitor pattern. More...

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

static void	visitRepresentativeNode (ROSE_VisitTraversal &visit)
	FOR INTERNAL USE Support for type-based traversal. More...

Static Public Member Functions inherited from SgLocatedNode
static size_t	numberOfNodes ()
	Returns the total number of IR nodes of this type. More...

static size_t	memoryUsage ()
	Returns the size in bytes of the total memory allocated for all IR nodes of this type. More...

static void	traverseMemoryPoolNodes (ROSE_VisitTraversal &visit)
	FOR INTERNAL USE Support for visitor pattern. More...

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

static void	visitRepresentativeNode (ROSE_VisitTraversal &visit)
	FOR INTERNAL USE Support for type-based traversal. More...

Static Public Member Functions inherited from SgNode
static size_t	numberOfNodes ()
	Returns the total number of IR nodes of this type. More...

static size_t	memoryUsage ()
	Returns the size in bytes of the total memory allocated for all IR nodes of this type. More...

static void	traverseMemoryPoolNodes (ROSE_VisitTraversal &visit)
	FOR INTERNAL USE Support for visitor pattern. More...

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

static void	visitRepresentativeNode (ROSE_VisitTraversal &visit)
	FOR INTERNAL USE Support for type-based traversal. More...

static std::vector< std::string >	buildCommandLineToSubstituteTransformationFile (const std::vector< std::string > &argv, std::string newFileName)
	Command line support for this compilation The command line is saved as a static variable so that it will be available to support the rewrite mechanism. More...

static std::vector< VariantT >	getClassHierarchySubTreeFunction (VariantT v)

static void	getClassHierarchySubTreeFunction (VariantT v, std::vector< VariantT > &)

static std::map< SgNode *, std::string > &	get_globalMangledNameMap ()
	Access function for performance optimizing global mangled name map. More...

static void	clearGlobalMangledNameMap ()
	Support to clear the performance optimizing global mangled name map. More...

static std::map< std::string, int > &	get_shortMangledNameCache ()
	Access function for lower level optimizing of global mangled name map. More...

static std::map< SgNode *, std::string > &	get_globalQualifiedNameMapForNames ()
	Access function for name qualification support (for names). More...

static void	set_globalQualifiedNameMapForNames (const std::map< SgNode *, std::string > &X)
	Access function for name qualification support (for names). More...

static std::map< SgNode *, std::string > &	get_globalQualifiedNameMapForTypes ()
	Access function for name qualification support (for type). More...

static void	set_globalQualifiedNameMapForTypes (const std::map< SgNode *, std::string > &X)
	Access function for name qualification support (for type). More...

static std::map< SgNode *, std::string > &	get_globalTypeNameMap ()
	Access function for name qualification support (for names of types). More...

static void	set_globalTypeNameMap (const std::map< SgNode *, std::string > &X)
	Access function for name qualification support (for names of types). More...

static SgFunctionTypeTable *	get_globalFunctionTypeTable ()
	Access function for symbol table specific to function types. More...

static void	set_globalFunctionTypeTable (SgFunctionTypeTable *globalFunctionTypeTable)
	Access function for symbol table specific to function types. More...

static SgTypeTable *	get_globalTypeTable ()
	Access function for symbol table specific to non-function types. More...

static void	set_globalTypeTable (SgTypeTable *globalTypeTable)
	Access function for symbol table specific to non-function types. More...

Protected Attributes
SgSymbolTable *	p_symbol_table
	This pointer is always valid and stores the symbl table. More...

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

Protected Attributes inherited from SgStatement
SgLabelRefExp *	p_numeric_label

int	p_source_sequence_value

Protected Attributes inherited from SgLocatedNode
Sg_File_Info *	p_startOfConstruct
	This pointer is always valid and stores the source position of the start of the current construct. More...

Sg_File_Info *	p_endOfConstruct
	This pointer is always valid and stores the source position of the end of the current construct. More...

AttachedPreprocessingInfoType *	p_attachedPreprocessingInfoPtr
	Holds comments and/or preprocessor directives located before or after the current statement of expression. More...

AstAttributeMechanism *	p_attributeMechanism

Protected Attributes inherited from SgNode
SgNode *	p_parent
	This is the pointer to the parent IR node in the AST. More...

bool	p_isModified
	Records if IR node has been modified (data members reset). More...

SgNode *	p_freepointer
	This is the pointer to the chain of previously freed objects. More...

Friends
class	AST_FILE_IO

class	SgScopeStatementStorageClass

class	AstSpecificDataManagingClass

class	AstSpecificDataManagingClassStorageClass

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

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

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

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

void	SgScopeStatement_clearMemoryPool ()

void	SgScopeStatement_extendMemoryPoolForFileIO (unsigned long)

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

void	SgScopeStatement_resetValidFreepointers ()

Additional Inherited Members
Protected Member Functions inherited from SgStatement
virtual bool	replace_child (SgStatement target, SgStatement newStmt, bool extractListFromBasicBlock=false)
	Private supporting function for low level SageIII rewrite interface. More...

virtual bool	insert_child (SgStatement , SgStatement , bool inFront=true, bool extractListFromBasicBlock=false)
	Private supporting function for low level SageIII rewrite interface. More...

Static Protected Attributes inherited from SgNode
static SgFunctionTypeTable *	p_globalFunctionTypeTable
	Pointer to symbol table specific to function types. More...

static SgTypeTable *	p_globalTypeTable

static std::map< SgNode *, std::string >	p_globalMangledNameMap
	Cache of mangled names to avoid regeneration of previously build mangled names or parts of mangled names. This is a performance optimization. More...

static std::map< std::string, int >	p_shortMangledNameCache
	STL map used as a cache to shorten generated mangled names. This is mostly a space optimization ofr mangled names of templates. More...

static std::map< SgNode *, std::string >	p_globalQualifiedNameMapForNames

static std::map< SgNode *, std::string >	p_globalQualifiedNameMapForTypes

static std::map< SgNode *, std::string >	p_globalTypeNameMap

Detailed Description

This class represents 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.

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

Definition at line 97011 of file Cxx_Grammar.h.

Member Typedef Documentation

typedef SgStatement SgScopeStatement::base_node_type

Definition at line 97717 of file Cxx_Grammar.h.

Member Enumeration Documentation

anonymous enum

static variant value

Enumerator
static_variant

Definition at line 97405 of file Cxx_Grammar.h.

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

SgScopeStatement::copy ( SgCopyHelp & help) const

virtual

Makes a copy (deap of shallow depending on SgCopyHelp).

Returns: Returns pointer to copy of SgScopeStatement.

Reimplemented from SgStatement.

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

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 SgNamespaceDefinitionStatement, SgTemplateClassDefinition, SgTemplateInstantiationDefn, SgClassDefinition, SgFunctionDefinition, SgBasicBlock, and SgGlobal.

virtual SgName SgScopeStatement::get_mangled_name ( ) const

virtual

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

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.

size_t SgScopeStatement::symbol_table_size ( )

Return the size of the symbol table.

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,
		SgTemplateParameterPtrList *	templateParameterList = `NULL`,
		SgTemplateArgumentPtrList *	templateArgumentList = `NULL`
	)		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,
		SgTemplateArgumentPtrList *	templateArgumentsList = `NULL`
	)		const

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

SgFunctionSymbol* SgScopeStatement::lookup_function_symbol	(	const SgName &	n,
		const SgType *	t,
		SgTemplateArgumentPtrList *	templateArgumentsList = `NULL`
	)		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

SgTemplateClassSymbol* SgScopeStatement::lookup_template_class_symbol	(	const SgName &	n,
		SgTemplateParameterPtrList *	templateParameterList,
		SgTemplateArgumentPtrList *	templateSpecializationArgumentList
	)		const

SgClassSymbol* SgScopeStatement::lookup_nontemplate_class_symbol	(	const SgName &	n,
		SgTemplateArgumentPtrList *	templateArgumentsList
	)		const

SgTemplateFunctionSymbol* SgScopeStatement::lookup_template_function_symbol	(	const SgName &	n,
		const SgType *	t,
		SgTemplateParameterPtrList *	templateParameterList
	)		const

SgFunctionSymbol* SgScopeStatement::lookup_nontemplate_function_symbol	(	const SgName &	n,
		const SgType *	t,
		SgTemplateArgumentPtrList *	templateArgumentsList = `NULL`
	)		const

SgTemplateMemberFunctionSymbol* SgScopeStatement::lookup_template_member_function_symbol	(	const SgName &	n,
		const SgType *	t,
		SgTemplateParameterPtrList *	templateParameterList
	)		const

SgMemberFunctionSymbol* SgScopeStatement::lookup_nontemplate_member_function_symbol	(	const SgName &	n,
		const SgType *	t,
		SgTemplateArgumentPtrList *	templateArgumentsList = `NULL`
	)		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
	)

void SgScopeStatement::print_symboltable	(	const std::string &	label,
		VariantT	nodeType
	)

void SgScopeStatement::print_symboltable ( const std::string & str)

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

boolean member function to distinquish if getStatementList() or getDeclarationList() is appropriate for the SgScopeStatment IR node.

Returns: bool.

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

SgScopeStatement::generateStatementList ( ) const

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

Builds list of pointers to SgStatement objects (useful for all SgScopeStatement objects, independent of whether they contain lists of SgDeclarationStatements or lists of SgStatements).

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.

This function is useful for any SgScopeStatement object, but since it returns by value any modification of the list is not reflected in the AST.

Todo:: This runtion should return a const value so that it would be more clear that it could not be modified (since such modifications would not be reflected in the AST).

Returns: STL list of pointers to SgStatement objects (returns by value).

bool SgScopeStatement::statementExistsInScope ( SgStatement * statement)

Test for existence of statement is scope.

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.

void SgScopeStatement::prepend_statement ( SgStatement * stmt)

SgStatement* SgScopeStatement::firstStatement ( ) const

SgStatement* SgScopeStatement::lastStatement ( ) const

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

virtual

Reimplemented from SgStatement.

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

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.

static bool SgScopeStatement::isEquivalentScope	(	SgScopeStatement *	scope1,
		SgScopeStatement *	scope2
	)

static

SgScopeStatement::get_symbol_table ( ) const

Returns a pointer to the locally strored SgSymbolTable.

Returns: Returns a pointer.

SgScopeStatement::set_symbol_table ( SgSymbolTable * symbolTable)

Sets the pointer to the locally strored SgSymbolTable.

Returns: Returns void.

template<class T >

SgFunctionSymbol* SgScopeStatement::find_symbol_by_type_of_function	(	const SgName &	name,
		const SgType *	func_type,
		SgTemplateParameterPtrList *	templateParameterList,
		SgTemplateArgumentPtrList *	templateArgumentList
	)

template<class T >

SgSymbol* SgScopeStatement::find_symbol_from_declaration ( const T * node) const

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 SgJavaLabelStatement, SgJavaForEachStatement, SgCAFWithTeamStatement, SgUpcForAllStatement, SgForAllStatement, SgFortranNonblockedDo, SgFortranDo, SgAssociateStatement, SgBlockDataStatement, SgNamespaceDefinitionStatement, SgCatchOptionStmt, SgSwitchStatement, SgDoWhileStmt, SgWhileStmt, SgTemplateClassDefinition, SgTemplateInstantiationDefn, SgClassDefinition, SgTemplateFunctionDefinition, SgFunctionDefinition, SgForStatement, SgIfStmt, SgBasicBlock, and SgGlobal.

virtual VariantT SgScopeStatement::variantT ( ) const

virtual

returns new style SageIII enum values

Reimplemented from SgStatement.

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

void* SgScopeStatement::operator new ( size_t size)

returns pointer to newly allocated IR node

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

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

void SgScopeStatement::operator delete ( void * pointer)

static size_t SgScopeStatement::numberOfNodes ( )

static

Returns the total number of IR nodes of this type.

static size_t SgScopeStatement::memoryUsage ( )

static

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

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.

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

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.

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

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.

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

virtual const char* SgScopeStatement::sage_class_name ( ) const

virtual

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

Reimplemented from SgStatement.

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

void SgScopeStatement::executeVisitorMemberFunction ( ROSE_VisitorPattern & visitor)

FOR INTERNAL USE Support for visitor pattern.

virtual void SgScopeStatement::accept ( ROSE_VisitorPattern & visitor)

virtual

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

Reimplemented from SgStatement.

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

static void SgScopeStatement::traverseMemoryPoolNodes ( ROSE_VisitTraversal & visit)

static

FOR INTERNAL USE Support for visitor pattern.

static void SgScopeStatement::traverseMemoryPoolVisitorPattern ( ROSE_VisitorPattern & visitor)

static

FOR INTERNAL USE Support for visitor pattern.

static void SgScopeStatement::visitRepresentativeNode ( ROSE_VisitTraversal & visit)

static

FOR INTERNAL USE Support for type-based traversal.

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.

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

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.

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.

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

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.

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

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.

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

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.

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

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.

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.

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

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

Definition at line 97676 of file Cxx_Grammar.h.

friend class SgScopeStatementStorageClass

friend

Definition at line 97677 of file Cxx_Grammar.h.

friend class AstSpecificDataManagingClass

friend

Definition at line 97678 of file Cxx_Grammar.h.

friend class AstSpecificDataManagingClassStorageClass

friend

Definition at line 97679 of file Cxx_Grammar.h.

SgScopeStatement::isSgScopeStatement ( SgNode * s)

friend

Casts pointer from base class to derived class.

Cast function (from derived class to SgScopeStatement pointer).

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)

Cast function (from derived class to SgScopeStatement pointer).

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

This constructor permits the IR node to be rebuilt from the contiguously arranged data in memory which obtained via fast binary file I/O from disk.

Typedef used for low level memory access.

Typedef used to hold memory addresses as values.

Methods to find the pointer to a global and local index

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

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

Definition at line 97743 of file Cxx_Grammar.h.

SgTypeTable* SgScopeStatement::p_type_table

protected

Definition at line 97747 of file Cxx_Grammar.h.

std::set<SgSymbol*> SgScopeStatement::p_type_elaboration_list

protected

Definition at line 97751 of file Cxx_Grammar.h.

std::set<SgSymbol*> SgScopeStatement::p_hidden_type_list

protected

Definition at line 97755 of file Cxx_Grammar.h.

std::set<SgSymbol*> SgScopeStatement::p_hidden_declaration_list

protected

Definition at line 97759 of file Cxx_Grammar.h.

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation