This class represents the concept of a declaration statement. More...

#include <Cxx_Grammar.h>

Inheritance diagram for SgDeclarationStatement:

Collaboration diagram for SgDeclarationStatement:

Public Types
enum	template_specialization_enum { e_unknown = 0, e_no_specialization = 1, e_partial_specialization = 2, e_specialization = 3, e_template_specialization_last = 4 }
	Template Specialization Support. More...

enum	gnu_extension_visability_attribute_enum { e_gnu_attribute_visability_unknown = 0, e_gnu_attribute_visability_unspecified = 1, e_gnu_attribute_visability_hidden = 2, e_gnu_attribute_visability_protected = 3, e_gnu_attribute_visability_internal = 4, e_last_gnu_visability_attribute }
	GNU extension for visibility modifier (only one value can be specified) More...

enum	{ static_variant = V_SgDeclarationStatement }
	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
	This function clones the current IR node object recursively or not, depending on the argument. More...

bool	isForward () const
	Returns boolean value indicating if this is a forward declaration. More...

void	setForward ()
	Marks a declaration as a forward declaration. More...

void	unsetForward ()
	Marks a forward declaration as a non-forward declaration. More...

bool	isNameOnly () const

void	setNameOnly ()

void	unsetNameOnly ()

bool	isExternBrace () const

void	setExternBrace ()

void	unsetExternBrace ()

bool	skipElaborateType () const

void	setSkipElaborateType ()

void	unsetSkipElaborateType ()

virtual SgName	get_mangled_name (void) const

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

SgQualifiedNamePtrList &	get_qualifiedNameList ()

const SgQualifiedNamePtrList &	get_qualifiedNameList () const

void	set_qualifiedNameList (const SgQualifiedNamePtrList &x)

virtual SgSymbol *	get_symbol_from_symbol_table () const
	FOR INTERNAL USE Get the associated symbol from the symbol table in the stored scope. Users should use the SgDeclarationStatement::search_for_symbol_from_symbol_table() instead. More...

SgDeclarationStatement *	get_declaration_associated_with_symbol () const

SgSymbol *	search_for_symbol_from_symbol_table () const
	User interface for retrieving the associated symbol from the declaration. More...

bool	hasAssociatedSymbol () const
	Returns boolean value true of this type of declaration has an associated sysmbol. More...

SgName	get_qualified_name_prefix () const
	This function generates the qualified name prefix to be used with the named declaration (only applied to restricted set of declarations where name qualification can be used). More...

SgName	get_template_name () const
	This function returns the template name (taken from the template declaration for the class, function, member function, or variable template declaration). More...

SgDeclarationStatement *	get_definingDeclaration () const
	This is an access function for the SgDeclarationStatement::p_definingDeclaration data member (see that variable's documentation for details). More...

void	set_definingDeclaration (SgDeclarationStatement *definingDeclaration)
	This is an access function for the SgDeclarationStatement::p_definingDeclaration data member (see that variable's documentation for details). More...

SgDeclarationStatement *	get_firstNondefiningDeclaration () const
	This is an access function for the SgDeclarationStatement::p_firstNondefiningDeclaration data member (see that variable's documentation for details). More...

void	set_firstNondefiningDeclaration (SgDeclarationStatement *firstNondefiningDeclaration)
	This is an access function for the SgDeclarationStatement::p_firstNondefiningDeclaration data member (see that variable's documentation for details). More...

SgType *	get_type () 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...

	SgDeclarationStatement (const SgDeclarationStatementStorageClass &source)

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

unsigned int	get_decl_attributes () const

void	set_decl_attributes (unsigned int decl_attributes)

std::string	get_linkage () const

void	set_linkage (std::string linkage)

const SgDeclarationModifier &	get_declarationModifier () const

SgDeclarationModifier &	get_declarationModifier ()
	Returns SgDeclarationModifier object by reference (so that it can be set). More...

bool	get_nameOnly () const

void	set_nameOnly (bool nameOnly)

bool	get_forward () const

void	set_forward (bool forward)

bool	get_externBrace () const

void	set_externBrace (bool externBrace)

bool	get_skipElaborateType () const

void	set_skipElaborateType (bool skipElaborateType)

std::string	get_binding_label () const

void	set_binding_label (std::string binding_label)

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

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

	SgDeclarationStatement ()

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 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 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 Member Functions
void	resetTemplateNameSupport (bool &nameResetFromMangledForm, SgName &name)

void	testForBadGenerateTemplateName (const std::string &name)

bool	skipEmptyTemplateArgumentListTest (SgFunctionDeclaration *functionDeclaration)

SgName	fixupTemplateNameForMangledNameSupport (const SgName &s) const

SgName	generate_alternative_name_for_unnamed_declaration (SgNode *parent) const

SgName	generate_alternative_name_for_unnamed_declaration_in_scope (SgScopeStatement *scope) const

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

Protected Attributes
unsigned int	p_decl_attributes
	This is old and used to be used to hold modifiers. More...

std::string	p_linkage
	This string stores the value "C", "C++", or "fortran" to define the external linkage for generating linkable names. More...

SgDeclarationModifier	p_declarationModifier
	This is the mechanism to handle declaration modifiers. More...

bool	p_nameOnly
	I think this is somewhat redundant with the purpose of specifying a forward declaration. Either that or it is information used by the unparser (Oh, I hope not!). More...

bool	p_forward
	This marks a declaration as being an explicit forward declaration. More...

bool	p_externBrace
	This marks that the declaration appeared with "extern". More...

bool	p_skipElaborateType
	This marks "type elaboration" which is the use of the keyword "class" before variables of type class. More...

SgDeclarationStatement *	p_definingDeclaration
	This pointer is valid only if a defining declaration exists, and stores the defining declaration where the declaration was defined. More...

SgDeclarationStatement *	p_firstNondefiningDeclaration
	This pointer is valid if there is a non-defining declaration, and stores the first non-defining declaration where a declaration was made explicitly (as in forward declaration) or implicitly as in the case of a few IR nodes (e.g. SgClassDeclaration). See description of SgDeclarationStatement. More...

SgQualifiedNamePtrList	p_qualifiedNameList

std::string	p_binding_label

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	SgDeclarationStatementStorageClass

class	AstSpecificDataManagingClass

class	AstSpecificDataManagingClassStorageClass

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

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

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

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

void	SgDeclarationStatement_clearMemoryPool ()

void	SgDeclarationStatement_extendMemoryPoolForFileIO (unsigned long)

void	SgDeclarationStatement_getNextValidPointer (std::pair< SgDeclarationStatement , std::vector< unsigned char >::const_iterator > &)

void	SgDeclarationStatement_resetValidFreepointers ()

Additional Inherited Members
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 declaration statement.

Declaration statements are where variables and types are

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

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

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

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

There are no uses of this IR node anywhere.  All statements

are derived from this SgDeclarationStatement class.

This is a base class for all statements.

Todo:

Current issues to look at:

Current classes derived from SgDeclarationStatement and the SgInitializedName class have ways of generating names, qualified names, and mangled names, but we lack a uniform mechanism to generate mangled qualified names. The implementation is not uniform within the IR and this is a problem for applications which must generate unique names for C++ constructs. Specific to functions names:
- We have:
  1. get_name()
  2. get_qualified_name()
  3. get_mangled_name()
- While we need (on ALL SgDeclarationStatement IR nodes):
  1. get_name()
  2. get_qualified_name()
  3. get_mangled_name()
  4. get_qualified_mangled_name()

It has been suggested that we eliminate get_qualified_mangled_name() and have get_mangled_name() return a mangled qualified name. Thus the semantics of get_mangled_name() would be changed to generate a mangled qualified name. The purpose of get_mangled_name is to generate a unique name for all declarations. Note that some declarations should not return a unique name:
1. SgAsmStmt
2. SgCtorInitializerList
3. SgFunctionParameterList
4. SgUsingDeclarationStatement
5. SgVariableDefinition \ It may be that this should be the same as for the SgVariableDeclaration.
Related to the above problem we wish to provide a definition under which all declarations (SgDeclarationStatement IR nodes) can be defined to be unique. Under One-time Definition Rule (ODR) definitions must be the same within a linked application (in each compilation unit). We define a unique name for a declaration IR node as:
- Any declaration which matches another declaration under ODR must generate the same unique string.
- Any two declarations that are different must generate different unique strings.
- Important cases are:
  - The IR nodes for which there is an obvious mangled name (and a get_mangled_name() exists) are:
  - IR nodes for which it is less obvious (or for which there is no present get_mangled_name() member function) are:
    - SgAsmStmt
    - SgCtorInitializerList
    - SgFunctionParameterList
    - SgNamespaceAliasDeclarationStatement
    - SgPragmaDeclaration
    - SgTemplateDeclaration (can this have a mangled name?)
    - SgTemplateInstantiationDirectiveStatement
    - SgUsingDeclarationStatement
    - SgUsingDirectiveStatement
    - SgVariableDeclaration
    - SgVariableDefinition
  - Other IR nodes (not derived from SgDeclarationStatement) but for which we need to generate mangled names (and a get_mangled_name() member functions exists) are:
    - SgTemplateArgument
    - SgFunctionDefinition
    - SgNamespaceDefinitionStatement
    - SgClassDefinition
    - SgType (and all IR nodes derived from SgType)
  - Other IR nodes (not derived from SgDeclarationStatement) but for which I think we need to generate mangled names (and a get_mangled_name() member functions does NOT exist) are:
    - SgInitializedName
    - SgFile (this might not really be required, but it might make sense)
    - SgDirectory (this might not really be required, but it might make sense)
    - SgBaseClass (this is questionable)
    - SgQualifiedName (this is questionable)
Class declarations often point to their definition independently of if they are defining or non-defining declaration (true at least for SgTemplateInstantiationDecl objects). This is different from how function declarations are handled, where only the defining declaration has a valid pointer to the function definition. This should be made more consistant. There are more comments about this is the documentation for SgTemplateInstantiationDecl.
The specification of "extern" is not the same as extern "C", one is handled in the SgDeclarationStatement (extern "C") and the other is handled in the SgStorageModifier (extern). It is confusing that the two are so far a part. Perhaps they could be together so that setting "C" linkage could declare a SgDeclarationStatement as "extern" at the same time. It makes no sense to have something marked as "C" linkage and have it not be extern (I think); so this could be considered an error (I think).
To support debugging of applications using the mangled names to build unique strings we should provide a global map between the unique names and the associated declarations. This would avoid the creation of alternative name mangling mechanisms whose sole purpose it to fold into the mangled name debugging information.

Test:: To test the mangled name generation we should construct a program using the mangled names and compile it to verify uniquenss of the veriable names. Since functions of the same name can be repeated, mangled names from functions should generate functions in the test program and mangled names of veriables should generate variables, etc.

See Also: Example of using a SgDeclarationStatement object

Definition at line 108996 of file Cxx_Grammar.h.

Member Typedef Documentation

typedef SgStatement SgDeclarationStatement::base_node_type

Definition at line 109501 of file Cxx_Grammar.h.

Member Enumeration Documentation

enum SgDeclarationStatement::template_specialization_enum

Template Specialization Support.

different forms of template specialization for - classes, functions, and variable declarations

Enumerator
e_unknown	unknown value (error value)
e_no_specialization	not a specialization (default value)
e_partial_specialization	partial specialization
e_specialization	specialization
e_template_specialization_last	last value (unused)

Definition at line 109013 of file Cxx_Grammar.h.

enum SgDeclarationStatement::gnu_extension_visability_attribute_enum

GNU extension for visibility modifier (only one value can be specified)

Visibility modifier information about (unspecified, hidden, protected, internal).

Only one value can be specified.

Enumerator
e_gnu_attribute_visability_unknown	Unknown value (error)
e_gnu_attribute_visability_unspecified	Default value
e_gnu_attribute_visability_hidden	hidden visibility attribute
e_gnu_attribute_visability_protected	protected visibility attribute
e_gnu_attribute_visability_internal	internal visibility attribute
e_last_gnu_visability_attribute	last visibility attribute value (upper bound on range of values, used in error checking)

Definition at line 109028 of file Cxx_Grammar.h.

anonymous enum

static variant value

Enumerator
static_variant

Definition at line 109189 of file Cxx_Grammar.h.

Constructor & Destructor Documentation

SgDeclarationStatement::SgDeclarationStatement ( const SgDeclarationStatementStorageClass & source)

SgDeclarationStatement::~SgDeclarationStatement ( )

virtual

This is the destructor.

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

SgDeclarationStatement::SgDeclarationStatement ( Sg_File_Info * startOfConstruct = NULL)

This is the constructor.

This constructor builds the SgDeclarationStatement base class.

Parameters

startOfConstruct represents the position in the source code

SgDeclarationStatement::SgDeclarationStatement ( )

Member Function Documentation

virtual SgNode* SgDeclarationStatement::copy ( SgCopyHelp & help) const

virtual

This function clones the current IR node object recursively or not, depending on the argument.

This function performs a copy based on the specification of the input parameter. The input parameter is used to determin which data members are copied by reference and which are copied by value.

Parameters

help	- If this argument is of type SgTreeCopy, then the IR node is cloned recursively. If its of type SgShallowCopy only the first level of the IR node is copied, everything else is left pointing to the the original IR node's object's data members.

Returns: a pointer to the new clone.

It appears the the copy functions don't set the parents of anything that they do a deep copy of! This can cause AST tests to fail. In particular some functions that require the parent pointers to be valid will return NULL pointers (e.g. SgInitializedName::get_declaration()). It might be that we should allow this to be done as part of the SgCopyHelp::clone function or perhaps another member function of SgCopyHelp would be useful for this support. It is not serious if the AST post processing is done since that will set any NULL pointers that are found within its traversal.

Exceptions

none	No exceptions are thrown by this function.

Reimplemented from SgStatement.

SgDeclarationStatement::isForward ( ) const

Returns boolean value indicating if this is a forward declaration.

Returns: Returns bool.

SgDeclarationStatement::setForward ( )

Marks a declaration as a forward declaration.

Returns: Returns void.

SgDeclarationStatement::unsetForward ( )

Marks a forward declaration as a non-forward declaration.

Returns: Returns void.

bool SgDeclarationStatement::isNameOnly ( ) const

void SgDeclarationStatement::setNameOnly ( )

void SgDeclarationStatement::unsetNameOnly ( )

bool SgDeclarationStatement::isExternBrace ( ) const

void SgDeclarationStatement::setExternBrace ( )

void SgDeclarationStatement::unsetExternBrace ( )

bool SgDeclarationStatement::skipElaborateType ( ) const

void SgDeclarationStatement::setSkipElaborateType ( )

void SgDeclarationStatement::unsetSkipElaborateType ( )

virtual SgName SgDeclarationStatement::get_mangled_name ( void ) const

virtual

Reimplemented in SgStmtDeclarationStatement, SgJavaPackageStatement, SgJavaImportStatement, SgFortranIncludeLine, SgOmpThreadprivateStatement, SgC_PreprocessorDirectiveStatement, SgContainsStatement, SgEntryStatement, SgProcedureHeaderStatement, SgProgramHeaderStatement, SgTemplateInstantiationFunctionDecl, SgTemplateInstantiationMemberFunctionDecl, SgFunctionDeclaration, SgImportStatement, SgNamelistStatement, SgUsingDeclarationStatement, SgImplicitStatement, SgJavaPackageDeclaration, SgModuleStatement, SgDerivedTypeStatement, SgTemplateInstantiationDecl, SgTemplateClassDeclaration, SgClassDeclaration, SgUsingDirectiveStatement, SgPragmaDeclaration, SgCtorInitializerList, SgStatementFunctionStatement, SgTypedefDeclaration, SgCommonBlock, SgNamespaceAliasDeclarationStatement, SgInterfaceStatement, SgEquivalenceStatement, SgNamespaceDeclarationStatement, SgUseStatement, SgTemplateInstantiationDirectiveStatement, SgTemplateDeclaration, SgFormatStatement, SgAttributeSpecificationStatement, SgAsmStmt, SgEnumDeclaration, SgVariableDefinition, SgVariableDeclaration, and SgFunctionParameterList.

void SgDeclarationStatement::resetTemplateNameSupport	(	bool &	nameResetFromMangledForm,
		SgName &	name
	)

protected

void SgDeclarationStatement::testForBadGenerateTemplateName ( const std::string & name)

protected

bool SgDeclarationStatement::skipEmptyTemplateArgumentListTest ( SgFunctionDeclaration * functionDeclaration)

protected

SgName SgDeclarationStatement::fixupTemplateNameForMangledNameSupport ( const SgName & s) const

protected

SgName SgDeclarationStatement::generate_alternative_name_for_unnamed_declaration ( SgNode * parent) const

protected

SgName SgDeclarationStatement::generate_alternative_name_for_unnamed_declaration_in_scope ( SgScopeStatement * scope) const

protected

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

virtual

Reimplemented from SgStatement.

Reimplemented in SgTemplateInstantiationFunctionDecl, SgTemplateInstantiationMemberFunctionDecl, SgMemberFunctionDeclaration, SgFunctionDeclaration, SgTemplateInstantiationDecl, SgClassDeclaration, SgTypedefDeclaration, SgNamespaceDeclarationStatement, SgTemplateInstantiationDirectiveStatement, SgTemplateDeclaration, SgEnumDeclaration, SgVariableDeclaration, and SgFunctionParameterList.

SgQualifiedNamePtrList& SgDeclarationStatement::get_qualifiedNameList ( )

const SgQualifiedNamePtrList& SgDeclarationStatement::get_qualifiedNameList ( ) const

void SgDeclarationStatement::set_qualifiedNameList ( const SgQualifiedNamePtrList & x)

SgDeclarationStatement::get_symbol_from_symbol_table ( ) const

virtual

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

Reimplemented from SgStatement.

Reimplemented in SgTemplateInstantiationFunctionDecl, SgTemplateInstantiationMemberFunctionDecl, SgMemberFunctionDeclaration, SgFunctionDeclaration, SgTemplateInstantiationDecl, SgClassDeclaration, SgTypedefDeclaration, SgNamespaceAliasDeclarationStatement, SgNamespaceDeclarationStatement, SgTemplateDeclaration, and SgEnumDeclaration.

SgDeclarationStatement* SgDeclarationStatement::get_declaration_associated_with_symbol ( ) const

SgDeclarationStatement::search_for_symbol_from_symbol_table ( ) const

User interface for retrieving the associated symbol from the declaration.

Returns: Returns SgSymbol pointer.

SgDeclarationStatement::hasAssociatedSymbol ( ) const

Returns boolean value true of this type of declaration has an associated sysmbol.

Returns: Returns bool.

Only a few types of declarations do not have associated symbols (SgFunctionParameterList, SgCtorInitializerList, SgPragmaDeclaration, SgVariableDeclaration, SgVariableDefinition).

SgName SgDeclarationStatement::get_qualified_name_prefix ( ) const

This function generates the qualified name prefix to be used with the named declaration (only applied to restricted set of declarations where name qualification can be used).

SgName SgDeclarationStatement::get_template_name ( ) const

This function returns the template name (taken from the template declaration for the class, function, member function, or variable template declaration).

SgDeclarationStatement::get_definingDeclaration ( ) const

This is an access function for the SgDeclarationStatement::p_definingDeclaration data member (see that variable's documentation for details).

Referenced by SageInterface::getEnclosingNode(), ssa_unfiltered_cfg::FunctionFilter::operator()(), and ssa_private::FunctionFilter::operator()().

SgDeclarationStatement::set_definingDeclaration ( SgDeclarationStatement * definingDeclaration)

This is an access function for the SgDeclarationStatement::p_definingDeclaration data member (see that variable's documentation for details).

SgDeclarationStatement::get_firstNondefiningDeclaration ( ) const

This is an access function for the SgDeclarationStatement::p_firstNondefiningDeclaration data member (see that variable's documentation for details).

Referenced by CallGraphBuilder::buildCallGraph(), and SageInterface::getEnclosingNode().

SgDeclarationStatement::set_firstNondefiningDeclaration ( SgDeclarationStatement * firstNondefiningDeclaration)

This is an access function for the SgDeclarationStatement::p_firstNondefiningDeclaration data member (see that variable's documentation for details).

SgType* SgDeclarationStatement::get_type ( ) const

virtual std::string SgDeclarationStatement::class_name ( ) const

virtual

Copies AST (whole subtree, depending on the SgCopyHelp class.

returns a string representing the class name

Reimplemented from SgStatement.

Referenced by SageInterface::getEnclosingNode().

virtual VariantT SgDeclarationStatement::variantT ( ) const

virtual

returns new style SageIII enum values

Reimplemented from SgStatement.

void* SgDeclarationStatement::operator new ( size_t size)

returns pointer to newly allocated IR node

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

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

void SgDeclarationStatement::operator delete ( void * pointer)

static size_t SgDeclarationStatement::numberOfNodes ( )

static

Returns the total number of IR nodes of this type.

static size_t SgDeclarationStatement::memoryUsage ( )

static

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

virtual std::vector<SgNode*> SgDeclarationStatement::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> SgDeclarationStatement::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 SgDeclarationStatement::get_numberOfTraversalSuccessors ( )

virtual

Reimplemented from SgStatement.

virtual SgNode* SgDeclarationStatement::get_traversalSuccessorByIndex ( size_t idx)

virtual

Reimplemented from SgStatement.

virtual size_t SgDeclarationStatement::get_childIndex ( SgNode * child)

virtual

Reimplemented from SgStatement.

virtual RTIReturnType SgDeclarationStatement::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* SgDeclarationStatement::sage_class_name ( ) const

virtual

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

Reimplemented from SgStatement.

void SgDeclarationStatement::executeVisitorMemberFunction ( ROSE_VisitorPattern & visitor)

FOR INTERNAL USE Support for visitor pattern.

virtual void SgDeclarationStatement::accept ( ROSE_VisitorPattern & visitor)

virtual

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

Reimplemented from SgStatement.

static void SgDeclarationStatement::traverseMemoryPoolNodes ( ROSE_VisitTraversal & visit)

static

FOR INTERNAL USE Support for visitor pattern.

static void SgDeclarationStatement::traverseMemoryPoolVisitorPattern ( ROSE_VisitorPattern & visitor)

static

FOR INTERNAL USE Support for visitor pattern.

static void SgDeclarationStatement::visitRepresentativeNode ( ROSE_VisitTraversal & visit)

static

FOR INTERNAL USE Support for type-based traversal.

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

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

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

unsigned int SgDeclarationStatement::get_decl_attributes ( ) const

void SgDeclarationStatement::set_decl_attributes ( unsigned int decl_attributes)

std::string SgDeclarationStatement::get_linkage ( ) const

void SgDeclarationStatement::set_linkage ( std::string linkage)

const SgDeclarationModifier& SgDeclarationStatement::get_declarationModifier ( ) const

SgDeclarationStatement::get_declarationModifier ( )

Returns SgDeclarationModifier object by reference (so that it can be set).

Returns: Returns SgDeclarationModifier by reference.

bool SgDeclarationStatement::get_nameOnly ( ) const

void SgDeclarationStatement::set_nameOnly ( bool nameOnly)

bool SgDeclarationStatement::get_forward ( ) const

void SgDeclarationStatement::set_forward ( bool forward)

bool SgDeclarationStatement::get_externBrace ( ) const

void SgDeclarationStatement::set_externBrace ( bool externBrace)

bool SgDeclarationStatement::get_skipElaborateType ( ) const

void SgDeclarationStatement::set_skipElaborateType ( bool skipElaborateType)

std::string SgDeclarationStatement::get_binding_label ( ) const

void SgDeclarationStatement::set_binding_label ( std::string binding_label)

Friends And Related Function Documentation

friend class AST_FILE_IO

friend

Definition at line 109460 of file Cxx_Grammar.h.

friend class SgDeclarationStatementStorageClass

friend

Definition at line 109461 of file Cxx_Grammar.h.

friend class AstSpecificDataManagingClass

friend

Definition at line 109462 of file Cxx_Grammar.h.

friend class AstSpecificDataManagingClassStorageClass

friend

Definition at line 109463 of file Cxx_Grammar.h.

SgDeclarationStatement::isSgDeclarationStatement ( SgNode * s)

friend

Casts pointer from base class to derived class.

Cast function (from derived class to SgDeclarationStatement pointer).

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

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

SgDeclarationStatement::isSgDeclarationStatement ( const SgNode * s)

friend

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

Cast function (from derived class to SgDeclarationStatement pointer).

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

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

SgDeclarationStatement* SgDeclarationStatement_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 SgDeclarationStatement_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 SgDeclarationStatement_clearMemoryPool ( )

friend

void SgDeclarationStatement_extendMemoryPoolForFileIO ( unsigned long)

friend

void SgDeclarationStatement_getNextValidPointer ( std::pair< SgDeclarationStatement *, std::vector< unsigned char * >::const_iterator > & )

friend

void SgDeclarationStatement_resetValidFreepointers ( )

friend

Member Data Documentation

SgDeclarationStatement::p_decl_attributes

protected

This is old and used to be used to hold modifiers.

Deprecated:: This is part of an older modifier interface that was not fully implemented.

This data member will be removed at some point.

Definition at line 109559 of file Cxx_Grammar.h.

SgDeclarationStatement::p_linkage

protected

This string stores the value "C", "C++", or "fortran" to define the external linkage for generating linkable names.

The only values that make sense here are "C", "C++" is the assumed default and requires a NULL pointer value. And the use of "fortran" would be backend specific (may be rejected by some backend vendor compilers).

Definition at line 109563 of file Cxx_Grammar.h.

SgDeclarationStatement::p_declarationModifier

protected

This is the mechanism to handle declaration modifiers.

See Stroustrup 3rd edition, Appendix A, for details of how modifiers are represented
in ROSE.

There is no interface to declaration modifiers implemented directly in this SgDeclarationStatement class. This was done to simplify the implementation. Users are expected to access the SgDeclarationmodifier object (returned by reference) directly to get/set its values.

Definition at line 109567 of file Cxx_Grammar.h.

SgDeclarationStatement::p_nameOnly

protected

I think this is somewhat redundant with the purpose of specifying a forward declaration. Either that or it is information used by the unparser (Oh, I hope not!).

Deprecated:: This will likely be removed at some point.

This mechanism is now redundnat with the better support for defining/nondefining declarations.

Definition at line 109571 of file Cxx_Grammar.h.

SgDeclarationStatement::p_forward

protected

This marks a declaration as being an explicit forward declaration.

All non-defining declaations are marked as forward declarations, while a defining declaration is NOT a marked as a forward declaration.

It is not clear enough to just use defining vs. nondefining declarations to know when something is a forward declaration!

Definition at line 109575 of file Cxx_Grammar.h.

SgDeclarationStatement::p_externBrace

protected

This marks that the declaration appeared with "extern".

Note that I think this is also set even if it appears between "extern {" and "}". It might be that this is a way to specify the first "extern {", but I don't think it is used interanlly and it is not clear if attaching the "extern {" to a declaration is a great way to handle this problem generally (appears to be overlly sensative to transformations that would add, remove, or move declarations (e.g in inlining and outlining transformations).

Currently the lex pass saves all "extern \"C" {" declarations and treats them as CPP directive (along with comments), they are then woven back into the AST as a separate pass.

Deprecated:: This is now redundant with the seperate preprocessing phase.

Not sure that we need or want this mechanism (or this implementation of it). Not that the mechanism that we have is better and based on the scanning for extern "X" in the source code directly (where "X" is either "C", "C++", or "fortran".

Definition at line 109579 of file Cxx_Grammar.h.

SgDeclarationStatement::p_skipElaborateType

protected

This marks "type elaboration" which is the use of the keyword "class" before variables of type class.

This is not often required, but is routinely output by the unparser to be
conservative.  The support for hidden lists allows the unparser to more
precisely output the type elaboration, and so this variable is redundant.

Deprecated:: This is now redundant with the hidden list analysis done to support more accurate code generation.

This field is used in a default mode and could be set to be more accurate.

Definition at line 109583 of file Cxx_Grammar.h.

SgDeclarationStatement::p_definingDeclaration

protected

This pointer is valid only if a defining declaration exists, and stores the defining declaration where the declaration was defined.

It is important to note that this is the only defining declaration as

opposed to the non-defining declarations (where there can, depending on IR node, often be many).

The value held is not shared within the Sage III AST (except though this data member in each defining and non-defining declaration).

Definition at line 109587 of file Cxx_Grammar.h.

SgDeclarationStatement::p_firstNondefiningDeclaration

protected

This pointer is valid if there is a non-defining declaration, and stores the first non-defining declaration where a declaration was made explicitly (as in forward declaration) or implicitly as in the case of a few IR nodes (e.g. SgClassDeclaration). See description of SgDeclarationStatement.

It is important to note that this is the first non-defining declaration as

opposed to the defining declaration. Thus it is usually the first forward declaration.

The value held is sharable across many references where as the defining declaration (not held by this variable) should have one unique reference within the AST, except where reference though the declarations definingDeclaration data member pointer. See declarations for details (SgDeclarationStatements).

Definition at line 109591 of file Cxx_Grammar.h.

SgQualifiedNamePtrList SgDeclarationStatement::p_qualifiedNameList

protected

Definition at line 109595 of file Cxx_Grammar.h.

std::string SgDeclarationStatement::p_binding_label

protected

Definition at line 109599 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 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