ROSE  0.9.6a
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
SgFunctionDeclaration Class Reference

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

#include <Cxx_Grammar.h>

Inheritance diagram for SgFunctionDeclaration:
Collaboration diagram for SgFunctionDeclaration:

Public Types

enum  { static_variant = V_SgFunctionDeclaration }
 static variant value More...
 
typedef SgDeclarationStatement base_node_type
 
- Public Types inherited from SgDeclarationStatement
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 SgNodecopy (SgCopyHelp &help) const
 This function clones the current IR node object recursively or not, depending on the argument. More...
 
SgTypeget_orig_return_type () const
 Support for C++ covariant return types (used in virtual function overloading). More...
 
virtual SgName get_mangled_name (void) const
 
bool isTemplateFunction () const
 Determines if function is a template or non-template function. More...
 
SgInitializedNamePtrListget_args ()
 
const SgInitializedNamePtrListget_args () const
 
virtual bool hasExplicitScope () const
 Support for where the scope is explicitly required. More...
 
virtual SgSymbolget_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...
 
virtual void fixupCopy (SgNode *copy, SgCopyHelp &help) const
 
virtual void append_arg (SgInitializedName *element)
 
virtual void prepend_arg (SgInitializedName *element)
 
void hasEllipses ()
 
virtual SgName get_qualified_name () const
 
virtual unsigned int cfgIndexForEnd () const
 Determine the CFG index for the end of this construct. 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...
 
SgName get_qualified_name_prefix_for_return_type () const
 This function generates the qualified name prefix to be used with the return type. More...
 
bool isSpecialization () const
 
bool isPartialSpecialization () 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 SgNodeget_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...
 
 SgFunctionDeclaration (const SgFunctionDeclarationStorageClass &source)
 
SgFunctionDeclarationaddRegExpAttribute (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...
 
SgName get_name () const
 
void set_name (SgName name)
 
SgFunctionParameterListget_parameterList () const
 
void set_parameterList (SgFunctionParameterList *parameterList)
 
const SgFunctionModifierget_functionModifier () const
 
SgFunctionModifierget_functionModifier ()
 
const SgSpecialFunctionModifierget_specialFunctionModifier () const
 
SgSpecialFunctionModifierget_specialFunctionModifier ()
 
SgTypePtrList get_exceptionSpecification () const
 
void set_exceptionSpecification (SgTypePtrList exceptionSpecification)
 
bool get_named_in_end_statement () const
 
void set_named_in_end_statement (bool named_in_end_statement)
 
std::string get_asm_name () const
 
void set_asm_name (std::string asm_name)
 
SgExprListExpget_decoratorList () const
 
void set_decoratorList (SgExprListExp *decoratorList)
 
SgFunctionTypeget_type () const
 
void set_type (SgFunctionType *type)
 
SgFunctionDefinitionget_definition () const
 
void set_definition (SgFunctionDefinition *definition)
 
bool get_oldStyleDefinition () const
 
void set_oldStyleDefinition (bool oldStyleDefinition)
 
SgScopeStatementget_scope () const
 Returns scope of current statement. More...
 
void set_scope (SgScopeStatement *scope)
 Support for setting scopes (only meaningful on IR statements that store the scope explicitly). More...
 
SgDeclarationStatement::template_specialization_enum get_specialization () const
 
void set_specialization (SgDeclarationStatement::template_specialization_enum specialization)
 
bool get_requiresNameQualificationOnReturnType () const
 
void set_requiresNameQualificationOnReturnType (bool requiresNameQualificationOnReturnType)
 
std::string get_gnu_extension_section () const
 
void set_gnu_extension_section (std::string gnu_extension_section)
 
std::string get_gnu_extension_alias () const
 
void set_gnu_extension_alias (std::string gnu_extension_alias)
 
SgDeclarationStatement::gnu_extension_visability_attribute_enum get_gnu_extension_visability () const
 
void set_gnu_extension_visability (SgDeclarationStatement::gnu_extension_visability_attribute_enum gnu_extension_visability)
 
int get_name_qualification_length () const
 
void set_name_qualification_length (int name_qualification_length)
 
bool get_type_elaboration_required () const
 
void set_type_elaboration_required (bool type_elaboration_required)
 
bool get_global_qualification_required () const
 
void set_global_qualification_required (bool global_qualification_required)
 
int get_name_qualification_length_for_return_type () const
 
void set_name_qualification_length_for_return_type (int name_qualification_length_for_return_type)
 
bool get_type_elaboration_required_for_return_type () const
 
void set_type_elaboration_required_for_return_type (bool type_elaboration_required_for_return_type)
 
bool get_global_qualification_required_for_return_type () const
 
void set_global_qualification_required_for_return_type (bool global_qualification_required_for_return_type)
 
bool get_prototypeIsWithoutParameters () const
 
void set_prototypeIsWithoutParameters (bool prototypeIsWithoutParameters)
 
int get_gnu_regparm_attribute () const
 
void set_gnu_regparm_attribute (int gnu_regparm_attribute)
 
virtual ~SgFunctionDeclaration ()
 This is the destructor. More...
 
 SgFunctionDeclaration (Sg_File_Info *startOfConstruct, SgName name="", SgFunctionType *type=NULL, SgFunctionDefinition *definition=NULL)
 
 SgFunctionDeclaration (SgName name, SgFunctionType *type, SgFunctionDefinition *definition)
 
- Public Member Functions inherited from SgDeclarationStatement
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 ()
 
SgQualifiedNamePtrListget_qualifiedNameList ()
 
const SgQualifiedNamePtrListget_qualifiedNameList () const
 
void set_qualifiedNameList (const SgQualifiedNamePtrList &x)
 
SgDeclarationStatementget_declaration_associated_with_symbol () const
 
SgSymbolsearch_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...
 
SgDeclarationStatementget_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...
 
SgDeclarationStatementget_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...
 
SgTypeget_type () const
 
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...
 
 SgDeclarationStatement (const SgDeclarationStatementStorageClass &source)
 
SgDeclarationStatementaddRegExpAttribute (std::string s, AstRegExAttribute *a)
 Support for AST matching using regular expression. 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 SgDeclarationModifierget_declarationModifier () const
 
SgDeclarationModifierget_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 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 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 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)
 
SgStatementaddRegExpAttribute (std::string s, AstRegExAttribute *a)
 Support for AST matching using regular expression. More...
 
SgLabelRefExpget_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_Infoget_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_InfogenerateMatchingFileInfo ()
 
virtual void addNewAttribute (std::string s, AstAttribute *a)
 Add a new attribute represented by the named string. More...
 
virtual AstAttributegetAttribute (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)
 
SgLocatedNodeaddRegExpAttribute (std::string s, AstRegExAttribute *a)
 Support for AST matching using regular expression. More...
 
Sg_File_Infoget_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_Infoget_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...
 
AttachedPreprocessingInfoTypeget_attachedPreprocessingInfoPtr () const
 
void set_attachedPreprocessingInfoPtr (AttachedPreprocessingInfoType *attachedPreprocessingInfoPtr)
 
AstAttributeMechanismget_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)
 
SgNodeaddRegExpAttribute (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...
 
SgNodeget_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...
 
SgNodeget_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 SgDeclarationStatement
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< VariantTgetClassHierarchySubTreeFunction (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 SgFunctionTypeTableget_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 SgTypeTableget_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

virtual bool replace_child (SgStatement *, SgStatement *, bool extractListFromBasicBlock=false)
 Private supporting function for low level SageIII rewrite interface. More...
 
- Protected Member Functions inherited from SgDeclarationStatement
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 insert_child (SgStatement *, SgStatement *, bool inFront=true, bool extractListFromBasicBlock=false)
 Private supporting function for low level SageIII rewrite interface. More...
 

Protected Attributes

SgName p_name
 This variable stores the string representing the function name. More...
 
SgFunctionParameterListp_parameterList
 
SgFunctionModifier p_functionModifier
 This variable stores flags representing use of inline, virtual, etc. More...
 
SgSpecialFunctionModifier p_specialFunctionModifier
 This variable stores flags representing use of constructor, destructor, etc. More...
 
SgTypePtrList p_exceptionSpecification
 
bool p_named_in_end_statement
 
std::string p_asm_name
 
SgExprListExpp_decoratorList
 This variable stores a list of decorators. More...
 
SgFunctionTypep_type
 This variable stores the SgFunctionType. More...
 
SgFunctionDefinitionp_definition
 This variable stores the SgFunctionDefinition. More...
 
bool p_oldStyleDefinition
 This boolean variable records if the function uses the old style definition. More...
 
SgScopeStatementp_scope
 
SgDeclarationStatement::template_specialization_enum p_specialization
 
bool p_requiresNameQualificationOnReturnType
 
std::string p_gnu_extension_section
 
std::string p_gnu_extension_alias
 
SgDeclarationStatement::gnu_extension_visability_attribute_enum p_gnu_extension_visability
 
int p_name_qualification_length
 
bool p_type_elaboration_required
 
bool p_global_qualification_required
 
int p_name_qualification_length_for_return_type
 
bool p_type_elaboration_required_for_return_type
 
bool p_global_qualification_required_for_return_type
 
bool p_prototypeIsWithoutParameters
 
int p_gnu_regparm_attribute
 
- Protected Attributes inherited from SgDeclarationStatement
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...
 
SgDeclarationStatementp_definingDeclaration
 This pointer is valid only if a defining declaration exists, and stores the defining declaration where the declaration was defined. More...
 
SgDeclarationStatementp_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
SgLabelRefExpp_numeric_label
 
int p_source_sequence_value
 
- Protected Attributes inherited from SgLocatedNode
Sg_File_Infop_startOfConstruct
 This pointer is always valid and stores the source position of the start of the current construct. More...
 
Sg_File_Infop_endOfConstruct
 This pointer is always valid and stores the source position of the end of the current construct. More...
 
AttachedPreprocessingInfoTypep_attachedPreprocessingInfoPtr
 Holds comments and/or preprocessor directives located before or after the current statement of expression. More...
 
AstAttributeMechanismp_attributeMechanism
 
- Protected Attributes inherited from SgNode
SgNodep_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...
 
SgNodep_freepointer
 This is the pointer to the chain of previously freed objects. More...
 

Friends

class AST_FILE_IO
 
class SgFunctionDeclarationStorageClass
 
class AstSpecificDataManagingClass
 
class AstSpecificDataManagingClassStorageClass
 
ROSE_DLL_API friend
SgFunctionDeclaration
isSgFunctionDeclaration (SgNode *s)
 Casts pointer from base class to derived class. More...
 
ROSE_DLL_API friend const
SgFunctionDeclaration
isSgFunctionDeclaration (const SgNode *s)
 Casts pointer from base class to derived class (for const pointers) More...
 
SgFunctionDeclarationSgFunctionDeclaration_getPointerFromGlobalIndex (unsigned long globalIndex)
 Constructor for use by AST File I/O Mechanism. More...
 
unsigned long SgFunctionDeclaration_getNumberOfValidNodesAndSetGlobalIndexInFreepointer (unsigned long)
 Get the size of the memory pool. More...
 
void SgFunctionDeclaration_clearMemoryPool ()
 
void SgFunctionDeclaration_extendMemoryPoolForFileIO (unsigned long)
 
void SgFunctionDeclaration_getNextValidPointer (std::pair< SgFunctionDeclaration *, std::vector< unsigned char * >::const_iterator > &)
 
void SgFunctionDeclaration_resetValidFreepointers ()
 

Additional Inherited Members

- Static Protected Attributes inherited from SgNode
static SgFunctionTypeTablep_globalFunctionTypeTable
 Pointer to symbol table specific to function types. More...
 
static SgTypeTablep_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 function declaration statement.

A function declaration can be either a forward declaration or a defining declaration.

If it is a defining declaration then it contains a pointer to the function definition. Future work will allow this class to have a valide defining and non-defining declaration similar to the class declaration, but this is not yet implemented.

This class is used as a base class for member function declarations and both template functions and template member function declarations.

The name of the function is stored in "p_name". However, if the function is a constructor or destructor the value of "p_name" is ignored (should be unset, perhaps) and the name is generated from the unqualified class name. This handles the complexity of resetting templated names which likely have been stored in the constructor before the template names have been reset from the form "ABC____L8" to "ABC<int>" as requied to compile the unparsed code.

This is a base class for all function and member declaration statments (including templated functions and member functions).

Todo:
Need to mark function declarations appearing in the file rose_edg_required_macros_and_functions.h as compiler generated since they are either builtin functions for gcc and g++ or those those builtin function that gcc and g++ required and which EDG fails to include as builtin when compiling with EDG's GNU_COMPATABILITY_MODE (current default for ROSE).
Todo:
Need to better handle fiend injection rules, currently the SgFunctionSymbol for a friend function is placed into the global scope. It likely should be the outer scope for a non-defining declaration and the class scope for a defining declaration. But the exact rules for this are more complex. So the location of the SgFunctionSymbol in the symbol table of SgGlobal is a poor approximation.

Definition at line 126067 of file Cxx_Grammar.h.

Member Typedef Documentation

Member Enumeration Documentation

anonymous enum

static variant value

Enumerator
static_variant 

Definition at line 126205 of file Cxx_Grammar.h.

Constructor & Destructor Documentation

SgFunctionDeclaration::SgFunctionDeclaration ( const SgFunctionDeclarationStorageClass source)
SgFunctionDeclaration::~SgFunctionDeclaration ( )
virtual

This is the destructor.

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

SgFunctionDeclaration::SgFunctionDeclaration ( Sg_File_Info startOfConstruct,
SgName  name = "",
SgFunctionType type = NULL,
SgFunctionDefinition definition = NULL 
)
SgFunctionDeclaration::SgFunctionDeclaration ( SgName  name,
SgFunctionType type,
SgFunctionDefinition definition 
)

Member Function Documentation

virtual SgNode* SgFunctionDeclaration::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
noneNo exceptions are thrown by this function.

Reimplemented from SgDeclarationStatement.

Reimplemented in SgEntryStatement, SgProcedureHeaderStatement, SgProgramHeaderStatement, SgTemplateInstantiationFunctionDecl, SgTemplateInstantiationMemberFunctionDecl, SgTemplateMemberFunctionDeclaration, SgMemberFunctionDeclaration, and SgTemplateFunctionDeclaration.

SgType* SgFunctionDeclaration::get_orig_return_type ( ) const

Support for C++ covariant return types (used in virtual function overloading).

Referenced by mainParse().

virtual SgName SgFunctionDeclaration::get_mangled_name ( void  ) const
virtual
SgFunctionDeclaration::isTemplateFunction ( ) const

Determines if function is a template or non-template function.

This function returns true if the current function is explicitly declared to be a template function. It returns fals if it is a normal function, member function, or member function of a templated class.

This function is required because member function of template are represented by SgTemplateInstantiationMemberFunction IR nodea the same as explicitly templated member functions. This function helps distinguish between the two types and is used in determining which functions to output as template specializations (which is now ROSE puts out template instantiations that it generates).

Returns
Returns bool value.
SgInitializedNamePtrList& SgFunctionDeclaration::get_args ( )
const SgInitializedNamePtrList& SgFunctionDeclaration::get_args ( ) const
virtual bool SgFunctionDeclaration::hasExplicitScope ( ) const
virtual

Support for where the scope is explicitly required.

Reimplemented from SgStatement.

virtual SgSymbol* SgFunctionDeclaration::get_symbol_from_symbol_table ( ) const
virtual

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

Reimplemented from SgDeclarationStatement.

Reimplemented in SgTemplateInstantiationFunctionDecl, SgTemplateInstantiationMemberFunctionDecl, and SgMemberFunctionDeclaration.

virtual void SgFunctionDeclaration::fixupCopy ( SgNode copy,
SgCopyHelp help 
) const
virtual
virtual void SgFunctionDeclaration::append_arg ( SgInitializedName element)
virtual
virtual void SgFunctionDeclaration::prepend_arg ( SgInitializedName element)
virtual
void SgFunctionDeclaration::hasEllipses ( )
virtual SgName SgFunctionDeclaration::get_qualified_name ( ) const
virtual
virtual bool SgFunctionDeclaration::replace_child ( SgStatement target,
SgStatement newStmt,
bool  extractListFromBasicBlock = false 
)
protectedvirtual

Private supporting function for low level SageIII rewrite interface.

 This function implements special semantics for the insertion of a collection of

statements in a block. If extractListFromBasicBlock is true then the statements in the block are extracts and placed into the same scope as the target position.

Returns
Returns bool.

Reimplemented from SgStatement.

Reimplemented in SgProgramHeaderStatement, and SgMemberFunctionDeclaration.

virtual unsigned int SgFunctionDeclaration::cfgIndexForEnd ( ) const
virtual

Determine the CFG index for the end of this construct.

Reimplemented from SgStatement.

Reimplemented in SgMemberFunctionDeclaration.

virtual std::vector<VirtualCFG::CFGEdge> SgFunctionDeclaration::cfgOutEdges ( unsigned int  index)
virtual

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

Reimplemented from SgStatement.

Reimplemented in SgMemberFunctionDeclaration.

virtual std::vector<VirtualCFG::CFGEdge> SgFunctionDeclaration::cfgInEdges ( unsigned int  index)
virtual

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

Reimplemented from SgStatement.

Reimplemented in SgMemberFunctionDeclaration.

SgName SgFunctionDeclaration::get_qualified_name_prefix_for_return_type ( ) const

This function generates the qualified name prefix to be used with the return type.

bool SgFunctionDeclaration::isSpecialization ( ) const
bool SgFunctionDeclaration::isPartialSpecialization ( ) const
virtual std::string SgFunctionDeclaration::class_name ( ) const
virtual
void* SgFunctionDeclaration::operator new ( size_t  size)

returns pointer to newly allocated IR node

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

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

void SgFunctionDeclaration::operator delete ( void *  pointer)
static size_t SgFunctionDeclaration::numberOfNodes ( )
static

Returns the total number of IR nodes of this type.

static size_t SgFunctionDeclaration::memoryUsage ( )
static

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

virtual std::vector<SgNode*> SgFunctionDeclaration::get_traversalSuccessorContainer ( )
virtual

FOR INTERNAL USE within ROSE traverals mechanism only.

This function builds and returns a copy of ordered container holding pointers to children of this node in a traversal. It is associated with the definition of a tree that is travered by the AST traversal mechanism; a tree that is embeded in the AST (which is a more general graph). This function is used within the implementation of the AST traversal and has a semantics may change in subtle ways that makes it difficult to use in user code. It can return unexpected data members and thus the order and the number of elements is unpredicable and subject to change.

Warning
This function can return unexpected data members and thus the order and the number of elements is unpredicable and subject to change.
Returns
Returns ordered STL Container of pointers to children nodes in AST.

Reimplemented from SgDeclarationStatement.

Reimplemented in SgEntryStatement, SgProcedureHeaderStatement, SgProgramHeaderStatement, SgTemplateInstantiationFunctionDecl, SgTemplateInstantiationMemberFunctionDecl, SgTemplateMemberFunctionDeclaration, SgMemberFunctionDeclaration, and SgTemplateFunctionDeclaration.

virtual std::vector<std::string> SgFunctionDeclaration::get_traversalSuccessorNamesContainer ( )
virtual

FOR INTERNAL USE within ROSE traverals mechanism only.

This function builds and returns a copy of ordered container holding strings used to name data members that are traversed in the IR node. It is associated with the definition of a tree that is travered by the AST traversal mechanism; a tree that is embeded in the AST (which is a more general graph). This function is used within the implementation of the AST traversal and has a semantics may change in subtle ways that makes it difficult to use in user code. It can return unexpected data members and thus the order and the number of elements is unpredicable and subject to change.

Warning
This function can return unexpected data members and thus the order and the number of elements is unpredicable and subject to change.

Each string is a name of a member variable holding a pointer to a child in the AST. The names are the same as used in the generated enums for accessing attributes in a traversal. The order is the same in which they are traversed and the same in which the access enums are defined. Therefore this method can be used to get the corresponding name (string) of an access enum which allows to produce more meaningful messages for attribute computations.

Returns
Returns ordered STL container of names (strings) of access names to children nodes in AST.

Reimplemented from SgDeclarationStatement.

Reimplemented in SgEntryStatement, SgProcedureHeaderStatement, SgProgramHeaderStatement, SgTemplateInstantiationFunctionDecl, SgTemplateInstantiationMemberFunctionDecl, SgTemplateMemberFunctionDeclaration, SgMemberFunctionDeclaration, and SgTemplateFunctionDeclaration.

virtual RTIReturnType SgFunctionDeclaration::roseRTI ( )
virtual

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

 This function provides runtime type information for accessing the

structure of the current node. It is useful for generating code which would dump out or rebuild IR nodes.

Returns
Returns a RTIReturnType object (runtime type information).

Reimplemented from SgDeclarationStatement.

Reimplemented in SgEntryStatement, SgProcedureHeaderStatement, SgProgramHeaderStatement, SgTemplateInstantiationFunctionDecl, SgTemplateInstantiationMemberFunctionDecl, SgTemplateMemberFunctionDeclaration, SgMemberFunctionDeclaration, and SgTemplateFunctionDeclaration.

virtual const char* SgFunctionDeclaration::sage_class_name ( ) const
virtual
void SgFunctionDeclaration::executeVisitorMemberFunction ( ROSE_VisitorPattern visitor)

FOR INTERNAL USE Support for visitor pattern.

virtual void SgFunctionDeclaration::accept ( ROSE_VisitorPattern visitor)
virtual
static void SgFunctionDeclaration::traverseMemoryPoolNodes ( ROSE_VisitTraversal visit)
static

FOR INTERNAL USE Support for visitor pattern.

static void SgFunctionDeclaration::traverseMemoryPoolVisitorPattern ( ROSE_VisitorPattern visitor)
static

FOR INTERNAL USE Support for visitor pattern.

static void SgFunctionDeclaration::visitRepresentativeNode ( ROSE_VisitTraversal visit)
static

FOR INTERNAL USE Support for type-based traversal.

virtual bool SgFunctionDeclaration::isInMemoryPool ( )
virtual

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

The AST File I/O depends upon the allocation of IR nodes being from the heap, stack based or global IR nodes should not appear in the AST if it will be written out to a file and read back in. To enforce this concept, this function implements a test to verify that the IR node can be found on the heap and is part of a larger test of the whole AST. This test must pass before the AST can be written out to a file. This is part of a compromise in the design of the AST File I/O to support binary streaming of data to files; for performance. It is also rather difficult, but possible, to build a useful AST with IR nodes allocated on the stack or frm global scope, this test filters out such cased from being used with the AST File I/O mechanism.

Reimplemented from SgDeclarationStatement.

Reimplemented in SgEntryStatement, SgProcedureHeaderStatement, SgProgramHeaderStatement, SgTemplateInstantiationFunctionDecl, SgTemplateInstantiationMemberFunctionDecl, SgTemplateMemberFunctionDeclaration, SgMemberFunctionDeclaration, and SgTemplateFunctionDeclaration.

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

Reimplemented in SgEntryStatement, SgProcedureHeaderStatement, SgProgramHeaderStatement, SgTemplateInstantiationFunctionDecl, SgTemplateInstantiationMemberFunctionDecl, SgTemplateMemberFunctionDeclaration, SgMemberFunctionDeclaration, and SgTemplateFunctionDeclaration.

virtual std::vector<std::pair<SgNode*,std::string> > SgFunctionDeclaration::returnDataMemberPointers ( ) const
virtual

FOR INTERNAL USE Returns STL vector of pairs of SgNode* and strings for use in AST tools

This functions is part of general support for many possible tools to operate on the AST. The forms a list of ALL IR node pointers used by each IR node, and is a supperset of the get_traversalSuccessorContainer(). It is (I think) less than the set of pointers used by the AST file I/O. This is part of work implemented by Andreas, and support tools such as the AST graph generation.

Warning
This function can return unexpected data members and thus the order and the number of elements is unpredicable and subject to change.
Returns
STL vector of pairs of SgNode* and strings

Reimplemented from SgDeclarationStatement.

Reimplemented in SgEntryStatement, SgProcedureHeaderStatement, SgProgramHeaderStatement, SgTemplateInstantiationFunctionDecl, SgTemplateInstantiationMemberFunctionDecl, SgTemplateMemberFunctionDeclaration, SgMemberFunctionDeclaration, and SgTemplateFunctionDeclaration.

virtual void SgFunctionDeclaration::processDataMemberReferenceToPointers ( ReferenceToPointerHandler *  )
virtual

FOR INTERNAL USE Processes pairs of references to SgNode* and strings for use in AST tools

This functions similar to returnDataMemberPointers() except that it passes references to a handler object. As a result there is FAR more damage that can be done by using this function, but it is type-safe. This is provided for support of internal tools that operate on the AST, e.g the AST Merge mechanism.

Warning
This function can return unexpected data members and thus the order and the number of elements is unpredicable and subject to change.

Reimplemented from SgDeclarationStatement.

Reimplemented in SgEntryStatement, SgProcedureHeaderStatement, SgProgramHeaderStatement, SgTemplateInstantiationFunctionDecl, SgTemplateInstantiationMemberFunctionDecl, SgTemplateMemberFunctionDeclaration, SgMemberFunctionDeclaration, and SgTemplateFunctionDeclaration.

virtual long SgFunctionDeclaration::getChildIndex ( SgNode childNode) const
virtual

FOR INTERNAL USE Returns a unique index value for the childNode in the list of children at this IR node.

This function returns a unique value for the input childNode in set of children at this IR node. Note that a negative value indicates that the input node is not a child. This is the basis for the implementation of the isChild(SgNode*) member function. Data members that are NULL in the IR node are counted internally (so that this function returns value that could be statically defined, and so are not dynamically determined).

Warning
The mapping on children to integer values could change from release to release of ROSE.
Returns
long

Reimplemented from SgDeclarationStatement.

Reimplemented in SgEntryStatement, SgProcedureHeaderStatement, SgProgramHeaderStatement, SgTemplateInstantiationFunctionDecl, SgTemplateInstantiationMemberFunctionDecl, SgTemplateMemberFunctionDeclaration, SgMemberFunctionDeclaration, and SgTemplateFunctionDeclaration.

SgFunctionDeclaration* SgFunctionDeclaration::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 SgFunctionDeclaration::post_construction_initialization ( )
virtual

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

Reimplemented from SgDeclarationStatement.

Reimplemented in SgEntryStatement, SgProcedureHeaderStatement, SgProgramHeaderStatement, SgTemplateInstantiationFunctionDecl, SgTemplateInstantiationMemberFunctionDecl, SgTemplateMemberFunctionDeclaration, SgMemberFunctionDeclaration, and SgTemplateFunctionDeclaration.

void SgFunctionDeclaration::set_name ( SgName  name)
SgFunctionParameterList* SgFunctionDeclaration::get_parameterList ( ) const

Referenced by mainParse().

void SgFunctionDeclaration::set_parameterList ( SgFunctionParameterList parameterList)
const SgFunctionModifier& SgFunctionDeclaration::get_functionModifier ( ) const
SgFunctionModifier& SgFunctionDeclaration::get_functionModifier ( )
const SgSpecialFunctionModifier& SgFunctionDeclaration::get_specialFunctionModifier ( ) const
SgSpecialFunctionModifier& SgFunctionDeclaration::get_specialFunctionModifier ( )
SgTypePtrList SgFunctionDeclaration::get_exceptionSpecification ( ) const
void SgFunctionDeclaration::set_exceptionSpecification ( SgTypePtrList  exceptionSpecification)
bool SgFunctionDeclaration::get_named_in_end_statement ( ) const
void SgFunctionDeclaration::set_named_in_end_statement ( bool  named_in_end_statement)
std::string SgFunctionDeclaration::get_asm_name ( ) const
void SgFunctionDeclaration::set_asm_name ( std::string  asm_name)
SgExprListExp* SgFunctionDeclaration::get_decoratorList ( ) const
void SgFunctionDeclaration::set_decoratorList ( SgExprListExp decoratorList)
SgFunctionType* SgFunctionDeclaration::get_type ( ) const
void SgFunctionDeclaration::set_type ( SgFunctionType type)
void SgFunctionDeclaration::set_definition ( SgFunctionDefinition definition)
bool SgFunctionDeclaration::get_oldStyleDefinition ( ) const
void SgFunctionDeclaration::set_oldStyleDefinition ( bool  oldStyleDefinition)
SgScopeStatement* SgFunctionDeclaration::get_scope ( void  ) const
virtual

Returns scope of current statement.

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

Returns
Returns valid pointer to SgScopeStatement.

Reimplemented from SgStatement.

void SgFunctionDeclaration::set_scope ( SgScopeStatement newScope)
virtual

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

Reimplemented from SgStatement.

SgDeclarationStatement::template_specialization_enum SgFunctionDeclaration::get_specialization ( ) const
void SgFunctionDeclaration::set_specialization ( SgDeclarationStatement::template_specialization_enum  specialization)
bool SgFunctionDeclaration::get_requiresNameQualificationOnReturnType ( ) const
void SgFunctionDeclaration::set_requiresNameQualificationOnReturnType ( bool  requiresNameQualificationOnReturnType)
std::string SgFunctionDeclaration::get_gnu_extension_section ( ) const
void SgFunctionDeclaration::set_gnu_extension_section ( std::string  gnu_extension_section)
std::string SgFunctionDeclaration::get_gnu_extension_alias ( ) const
void SgFunctionDeclaration::set_gnu_extension_alias ( std::string  gnu_extension_alias)
SgDeclarationStatement::gnu_extension_visability_attribute_enum SgFunctionDeclaration::get_gnu_extension_visability ( ) const
void SgFunctionDeclaration::set_gnu_extension_visability ( SgDeclarationStatement::gnu_extension_visability_attribute_enum  gnu_extension_visability)
int SgFunctionDeclaration::get_name_qualification_length ( ) const
void SgFunctionDeclaration::set_name_qualification_length ( int  name_qualification_length)
bool SgFunctionDeclaration::get_type_elaboration_required ( ) const
void SgFunctionDeclaration::set_type_elaboration_required ( bool  type_elaboration_required)
bool SgFunctionDeclaration::get_global_qualification_required ( ) const
void SgFunctionDeclaration::set_global_qualification_required ( bool  global_qualification_required)
int SgFunctionDeclaration::get_name_qualification_length_for_return_type ( ) const
void SgFunctionDeclaration::set_name_qualification_length_for_return_type ( int  name_qualification_length_for_return_type)
bool SgFunctionDeclaration::get_type_elaboration_required_for_return_type ( ) const
void SgFunctionDeclaration::set_type_elaboration_required_for_return_type ( bool  type_elaboration_required_for_return_type)
bool SgFunctionDeclaration::get_global_qualification_required_for_return_type ( ) const
void SgFunctionDeclaration::set_global_qualification_required_for_return_type ( bool  global_qualification_required_for_return_type)
bool SgFunctionDeclaration::get_prototypeIsWithoutParameters ( ) const
void SgFunctionDeclaration::set_prototypeIsWithoutParameters ( bool  prototypeIsWithoutParameters)
int SgFunctionDeclaration::get_gnu_regparm_attribute ( ) const
void SgFunctionDeclaration::set_gnu_regparm_attribute ( int  gnu_regparm_attribute)

Friends And Related Function Documentation

friend class AST_FILE_IO
friend

Definition at line 126476 of file Cxx_Grammar.h.

friend class SgFunctionDeclarationStorageClass
friend

Definition at line 126477 of file Cxx_Grammar.h.

friend class AstSpecificDataManagingClass
friend

Definition at line 126478 of file Cxx_Grammar.h.

friend class AstSpecificDataManagingClassStorageClass
friend

Definition at line 126479 of file Cxx_Grammar.h.

SgFunctionDeclaration::isSgFunctionDeclaration ( SgNode s)
friend

Casts pointer from base class to derived class.

Cast function (from derived class to SgFunctionDeclaration pointer).

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

Returns
Returns valid pointer to SgFunctionDeclaration if input is derived from a SgLocatedNode.
SgFunctionDeclaration::isSgFunctionDeclaration ( const SgNode s)
friend

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

Cast function (from derived class to SgFunctionDeclaration pointer).

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

Returns
Returns valid pointer to SgFunctionDeclaration if input is derived from a SgLocatedNode.
SgFunctionDeclaration* SgFunctionDeclaration_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 SgFunctionDeclaration_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 SgFunctionDeclaration_clearMemoryPool ( )
friend
void SgFunctionDeclaration_extendMemoryPoolForFileIO ( unsigned  long)
friend
void SgFunctionDeclaration_getNextValidPointer ( std::pair< SgFunctionDeclaration *, std::vector< unsigned char * >::const_iterator > &  )
friend
void SgFunctionDeclaration_resetValidFreepointers ( )
friend

Member Data Documentation

SgFunctionDeclaration::p_name
protected

This variable stores the string representing the function name.

This variable stores the string representing the function name. The value is ignored in the case of a member function constructor or destructor (where upon the name returned from get_name() is generated from the class name). This handling is important for constructors and constructor initializer handling associated with instantiated template class declarations).

The name of the function is stored in "p_name". However, if the function is a constructor or destructor the value of "p_name" is ignored (should be unset, perhaps) and the name is generated from the unqualified class name. This handles the complexity of resetting templated names which likely have been stored in the constructor before the template names have been reset from the form "ABC____L8" to "ABC<int>" as requied to compile the unparsed code.

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

Definition at line 126640 of file Cxx_Grammar.h.

SgFunctionParameterList* SgFunctionDeclaration::p_parameterList
protected

Definition at line 126644 of file Cxx_Grammar.h.

SgFunctionDeclaration::p_functionModifier
protected

This variable stores flags representing use of inline, virtual, etc.

This variable stores what the C++ grammar referes to as "function modifiers". Values held here are: inline, virtual, pure virtual, default, explicit.

Definition at line 126648 of file Cxx_Grammar.h.

SgFunctionDeclaration::p_specialFunctionModifier
protected

This variable stores flags representing use of constructor, destructor, etc.

This variable stores what the C++ grammar referes to as "special function modifiers". Values held here are: default, not special, constructor, destructor, conversion operator, operator.

Definition at line 126652 of file Cxx_Grammar.h.

SgTypePtrList SgFunctionDeclaration::p_exceptionSpecification
protected

Definition at line 126656 of file Cxx_Grammar.h.

bool SgFunctionDeclaration::p_named_in_end_statement
protected

Definition at line 126660 of file Cxx_Grammar.h.

std::string SgFunctionDeclaration::p_asm_name
protected

Definition at line 126664 of file Cxx_Grammar.h.

SgFunctionDeclaration::p_decoratorList
protected

This variable stores a list of decorators.

This variable stores a list of expressions that decorate this function. This member is intended for use with Python, and should be NULL otherwise.

Definition at line 126668 of file Cxx_Grammar.h.

SgFunctionDeclaration::p_type
protected

This variable stores the SgFunctionType.

This variable stores the SgFunctionType. All types are shared within the Sage III AST.

Definition at line 126672 of file Cxx_Grammar.h.

SgFunctionDeclaration::p_definition
protected

This variable stores the SgFunctionDefinition.

This variable stores the SgFunctionDefinition. It is presently NULL if the declaration is a forward declaration. This will be made more uniform with how defining vs. non-defining declarations are handled in the SgClassDeclaration.

Deprecated:
This is now redundant with the more general mechanism of defining and non-defining declarations which is implemented at the SgDeclaration level.

The handling via defining and non-defining declaration for function declarations is not yet implemented and will be implemented similar to that done for class declarations.

Definition at line 126676 of file Cxx_Grammar.h.

SgFunctionDeclaration::p_oldStyleDefinition
protected

This boolean variable records if the function uses the old style definition.

This boolean variable records if the function was declared using the old style definition.

This should maybe be moved to the SgFunctionParameterList class.

Definition at line 126680 of file Cxx_Grammar.h.

SgScopeStatement* SgFunctionDeclaration::p_scope
protected

Definition at line 126684 of file Cxx_Grammar.h.

SgDeclarationStatement::template_specialization_enum SgFunctionDeclaration::p_specialization
protected

Definition at line 126688 of file Cxx_Grammar.h.

bool SgFunctionDeclaration::p_requiresNameQualificationOnReturnType
protected

Definition at line 126692 of file Cxx_Grammar.h.

std::string SgFunctionDeclaration::p_gnu_extension_section
protected

Definition at line 126696 of file Cxx_Grammar.h.

std::string SgFunctionDeclaration::p_gnu_extension_alias
protected

Definition at line 126700 of file Cxx_Grammar.h.

SgDeclarationStatement::gnu_extension_visability_attribute_enum SgFunctionDeclaration::p_gnu_extension_visability
protected

Definition at line 126704 of file Cxx_Grammar.h.

int SgFunctionDeclaration::p_name_qualification_length
protected

Definition at line 126708 of file Cxx_Grammar.h.

bool SgFunctionDeclaration::p_type_elaboration_required
protected

Definition at line 126712 of file Cxx_Grammar.h.

bool SgFunctionDeclaration::p_global_qualification_required
protected

Definition at line 126716 of file Cxx_Grammar.h.

int SgFunctionDeclaration::p_name_qualification_length_for_return_type
protected

Definition at line 126720 of file Cxx_Grammar.h.

bool SgFunctionDeclaration::p_type_elaboration_required_for_return_type
protected

Definition at line 126724 of file Cxx_Grammar.h.

bool SgFunctionDeclaration::p_global_qualification_required_for_return_type
protected

Definition at line 126728 of file Cxx_Grammar.h.

bool SgFunctionDeclaration::p_prototypeIsWithoutParameters
protected

Definition at line 126732 of file Cxx_Grammar.h.

int SgFunctionDeclaration::p_gnu_regparm_attribute
protected

Definition at line 126736 of file Cxx_Grammar.h.


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