ROSE 0.11.145.147
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
SgFunctionDeclaration Class Reference

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.

Definition at line 312363 of file Cxx_Grammar.h.

Inheritance diagram for SgFunctionDeclaration:
Inheritance graph
[legend]
Collaboration diagram for SgFunctionDeclaration:
Collaboration graph
[legend]

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...
 
enum  { static_variant = V_SgNode }
 static variant value More...
 

Public Member Functions

virtual SgNodecopy (SgCopyHelp &help) const override
 
SgTypeget_orig_return_type () const
 Support for C++ covariant return types (used in virtual function overloading).
 
virtual SgName get_mangled_name (void) const override
 
bool isTemplateFunction () const
 Determines if function is a template or non-template function.
 
SgInitializedNamePtrList & get_args ()
 
const SgInitializedNamePtrList & get_args () const
 
virtual bool hasExplicitScope () const override
 Support for where the scope is explicitly required.
 
virtual SgSymbolget_symbol_from_symbol_table () const override
 FOR INTERNAL USE Get the associated symbol from the symbol table in the stored scope. Users should use the SgDeclarationStatement::search_for_symbol_from_symbol_table() instead.
 
virtual void fixupCopy_scopes (SgNode *copy, SgCopyHelp &help) const override
 
virtual void fixupCopy_symbols (SgNode *copy, SgCopyHelp &help) const override
 
virtual void fixupCopy_references (SgNode *copy, SgCopyHelp &help) const override
 
virtual void append_arg (SgInitializedName *element)
 
virtual void prepend_arg (SgInitializedName *element)
 
void hasEllipses ()
 
virtual SgName get_qualified_name () const
 
SgName get_template_header () const
 
virtual unsigned int cfgIndexForEnd () const override
 Determine the CFG index for the end of this construct.
 
virtual std::vector< VirtualCFG::CFGEdgecfgOutEdges (unsigned int index) override
 Find the out edges of a CFG node – internal version.
 
virtual std::vector< VirtualCFG::CFGEdgecfgInEdges (unsigned int index) override
 Find the in edges of a CFG node – internal version.
 
SgName get_qualified_name_prefix_for_return_type () const
 This function generates the qualified name prefix to be used with the return type.
 
bool isNormalizedTemplateFunction () const
 
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_requiresNameQualificationOnReturnType () const
 
void set_requiresNameQualificationOnReturnType (bool requiresNameQualificationOnReturnType)
 
bool isSpecialization () const
 
bool isPartialSpecialization () const
 
virtual std::string class_name () const override
 returns a string representing the class name
 
virtual VariantT variantT () const override
 returns new style SageIII enum values
 
void * operator new (size_t size)
 returns pointer to newly allocated IR node
 
void operator delete (void *pointer, size_t size)
 deallocated memory for IR node (returns memory to memory pool for reuse)
 
void operator delete (void *pointer)
 
virtual std::vector< SgNode * > get_traversalSuccessorContainer () override
 container of pointers to AST successor nodes used in the traversal overridden in every class by generated implementation
 
virtual std::vector< std::string > get_traversalSuccessorNamesContainer () override
 container of names of variables or container indices used used in the traversal to access AST successor nodes overridden in every class by generated implementation
 
virtual size_t get_numberOfTraversalSuccessors () override
 return number of children in the traversal successor list
 
virtual SgNodeget_traversalSuccessorByIndex (size_t idx) override
 index-based access to traversal successors by index number
 
virtual size_t get_childIndex (SgNode *child) override
 index-based access to traversal successors by child node
 
virtual RTIReturnType roseRTI () override
 return C++ Runtime-Time-Information
 
virtual const char * sage_class_name () const override
 
void executeVisitorMemberFunction (ROSE_VisitorPattern &visitor)
 FOR INTERNAL USE Support for visitor pattern.
 
virtual void accept (ROSE_VisitorPattern &visitor) override
 support for the classic visitor pattern done in GoF
 
virtual bool isInMemoryPool () override
 FOR INTERNAL USE This is used in internal tests to verify that all IR nodes are allocated from the heap.
 
virtual void checkDataMemberPointersIfInMemoryPool () override
 FOR INTERNAL USE This is used in internal tests to verify that all IR nodes are allocated from the heap.
 
virtual std::vector< std::pair< SgNode *, std::string > > returnDataMemberPointers () const override
 FOR INTERNAL USE Returns STL vector of pairs of SgNode* and strings for use in AST tools
 
virtual void processDataMemberReferenceToPointers (ReferenceToPointerHandler *) override
 FOR INTERNAL USE Processes pairs of references to SgNode* and strings for use in AST tools
 
virtual long getChildIndex (SgNode *childNode) const override
 FOR INTERNAL USE Returns a unique index value for the childNode in the list of children at this IR node.
 
 SgFunctionDeclaration (const SgFunctionDeclarationStorageClass &source)
 IR node constructor to support AST File I/O.
 
SgFunctionDeclarationaddRegExpAttribute (std::string s, AstRegExAttribute *a)
 Support for AST matching using regular expression.
 
void post_construction_initialization () override
 Final initialization for constructors This function is called at the end of generated constructors to allow the specification writer to add special initialization functions or tests. Default is to do nothing. Otherwise it should be overridden in the spec file, in NewHeaderCode/NewOutlinedCode.
 
SgName get_name () const
 
void set_name (SgName name)
 
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)
 
bool get_ada_formal_subprogram_decl () const
 
void set_ada_formal_subprogram_decl (bool ada_formal_subprogram_decl)
 
bool get_ada_formal_decl_with_box () const
 
void set_ada_formal_decl_with_box (bool ada_formal_decl_with_box)
 
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 override
 Returns scope of current statement.
 
void set_scope (SgScopeStatement *scope) override
 Support for setting scopes (only meaningful on IR statements that store the scope explicitly).
 
SgDeclarationStatement::template_specialization_enum get_specialization () const
 
void set_specialization (SgDeclarationStatement::template_specialization_enum specialization)
 
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)
 
bool get_prototypeIsWithoutParameters () const
 
void set_prototypeIsWithoutParameters (bool prototypeIsWithoutParameters)
 
int get_gnu_regparm_attribute () const
 
void set_gnu_regparm_attribute (int gnu_regparm_attribute)
 
SgFunctionTypeget_type_syntax () const
 
void set_type_syntax (SgFunctionType *type_syntax)
 
bool get_type_syntax_is_available () const
 
void set_type_syntax_is_available (bool type_syntax_is_available)
 
SgFunctionParameterListget_parameterList_syntax () const
 
void set_parameterList_syntax (SgFunctionParameterList *parameterList_syntax)
 
bool get_using_C11_Noreturn_keyword () const
 
void set_using_C11_Noreturn_keyword (bool using_C11_Noreturn_keyword)
 
bool get_is_constexpr () const
 
void set_is_constexpr (bool is_constexpr)
 
bool get_using_new_function_return_type_syntax () const
 
void set_using_new_function_return_type_syntax (bool using_new_function_return_type_syntax)
 
SgFunctionParameterScopeget_functionParameterScope () const
 
void set_functionParameterScope (SgFunctionParameterScope *functionParameterScope)
 
bool get_marked_as_edg_normalization () const
 
void set_marked_as_edg_normalization (bool marked_as_edg_normalization)
 
bool get_is_implicit_function () const
 
void set_is_implicit_function (bool is_implicit_function)
 
virtual ~SgFunctionDeclaration ()
 This is the destructor.
 
 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.
 
void setForward ()
 Marks a declaration as a forward declaration.
 
void unsetForward ()
 Marks a forward declaration as a non-forward declaration.
 
bool isNameOnly () const
 
void setNameOnly ()
 
void unsetNameOnly ()
 
bool isExternBrace () const
 
void setExternBrace ()
 
void unsetExternBrace ()
 
bool skipElaborateType () const
 
void setSkipElaborateType ()
 
void unsetSkipElaborateType ()
 
SgQualifiedNamePtrList & get_qualifiedNameList ()
 
const SgQualifiedNamePtrList & get_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.
 
bool hasAssociatedSymbol () const
 Returns boolean value true of this type of declaration has an associated sysmbol.
 
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).
 
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).
 
SgDeclarationStatementget_definingDeclaration () const
 This is an access function for the SgDeclarationStatement::p_definingDeclaration data member (see that variable's documentation for details).
 
void set_definingDeclaration (SgDeclarationStatement *definingDeclaration)
 This is an access function for the SgDeclarationStatement::p_definingDeclaration data member (see that variable's documentation for details).
 
SgDeclarationStatementget_firstNondefiningDeclaration () const
 This is an access function for the SgDeclarationStatement::p_firstNondefiningDeclaration data member (see that variable's documentation for details).
 
void set_firstNondefiningDeclaration (SgDeclarationStatement *firstNondefiningDeclaration)
 This is an access function for the SgDeclarationStatement::p_firstNondefiningDeclaration data member (see that variable's documentation for details).
 
SgTypeget_type () const
 
std::string unparseNameToString ()
 
void * operator new (size_t size)
 returns pointer to newly allocated IR node
 
void operator delete (void *pointer, size_t size)
 deallocated memory for IR node (returns memory to memory pool for reuse)
 
void operator delete (void *pointer)
 
void executeVisitorMemberFunction (ROSE_VisitorPattern &visitor)
 FOR INTERNAL USE Support for visitor pattern.
 
 SgDeclarationStatement (const SgDeclarationStatementStorageClass &source)
 IR node constructor to support AST File I/O.
 
SgDeclarationStatementaddRegExpAttribute (std::string s, AstRegExAttribute *a)
 Support for AST matching using regular expression.
 
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).
 
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)
 
SgDeclarationScopeget_declarationScope () const
 
void set_declarationScope (SgDeclarationScope *declarationScope)
 
bool get_unparse_template_ast () const
 
void set_unparse_template_ast (bool unparse_template_ast)
 
SgExprListExpget_adaAspects () const
 
void set_adaAspects (SgExprListExp *adaAspects)
 
virtual ~SgDeclarationStatement ()
 This is the destructor.
 
 SgDeclarationStatement (Sg_File_Info *startOfConstruct)
 This is the constructor.
 
- Public Member Functions inherited from SgStatement
virtual void setExtern ()
 This function sets "extern" status for the current statement.
 
virtual void setStatic ()
 This function sets "static" status for the current statement.
 
void insert_statement (SgStatement *target, SgStatement *newstmt, bool inFront=true)
 This function inserts a single statement at the position indicated by target.
 
void insert_statement (SgStatement *target, const SgStatementPtrList &newstmtList, bool inFront=true)
 This function inserts a list of statements at the position indicated by target.
 
void replace_statement (SgStatement *target, SgStatement *newstmt)
 This function replaces the target statement with a single statement.
 
void replace_statement (SgStatement *target, const SgStatementPtrList &newstmtList)
 This function replaces the target statement with a list of statements.
 
void remove_statement (SgStatement *)
 This function removes the target statement from the AST.
 
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.
 
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.
 
virtual int replace_expression (SgExpression *original_expression, SgExpression *new_expression)
 support general replace functions, used in statements that directly contain SgExpression IR nodes.
 
virtual bool cfgIsIndexInteresting (unsigned int index) const override
 Determine whether a particular CFG node index is "interesting" for this kind of node.
 
virtual unsigned int cfgFindChildIndex (SgNode *n) override
 Find the index of n in this node's CFG children.
 
virtual unsigned int cfgFindNextChildIndex (SgNode *n) override
 Find the index just after n in this node's CFG children.
 
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.
 
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).
 
void post_construction_initialization () override
 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.
 
void * operator new (size_t size)
 returns pointer to newly allocated IR node
 
void operator delete (void *pointer, size_t size)
 deallocated memory for IR node (returns memory to memory pool for reuse)
 
void operator delete (void *pointer)
 
void executeVisitorMemberFunction (ROSE_VisitorPattern &visitor)
 FOR INTERNAL USE Support for visitor pattern.
 
 SgStatement (const SgStatementStorageClass &source)
 IR node constructor to support AST File I/O.
 
SgStatementaddRegExpAttribute (std::string s, AstRegExAttribute *a)
 Support for AST matching using regular expression.
 
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.
 
 SgStatement (Sg_File_Info *startOfConstruct)
 This is the constructor.
 
- 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.
 
void insertToAttachedPreprocessingInfo (PreprocessingInfo *prepInfoPtr, PreprocessingInfo *anchorInfoPtr, bool insertAfter=true)
 Insert prepInfo After (or before if last parameter is false) an anchor info ptr in the list of preprocessing info attached to the current node. This is useful to insert things in the middle.
 
virtual Sg_File_Infoget_file_info () const override
 Interface function to implement original SAGE interface to SgFile_Info objects.
 
virtual void set_file_info (Sg_File_Info *X)
 Access function calls set_startingConstruct(Sg_File_Info*) member function.
 
void setCompilerGenerated ()
 Allow IR nodes (mostly SgLocatedNode) to be marked as compiler generated.
 
void unsetCompilerGenerated ()
 
bool isCompilerGenerated () const
 Simple test for if this is a compiler generated node.
 
void setTransformation ()
 Allow IR nodes (mostly SgLocatedNode) to be marked as a transformation.
 
void unsetTransformation ()
 
bool isTransformation () const
 Simple test for if this is a part of a transformation.
 
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++).
 
void unsetFrontendSpecific ()
 
bool isFrontendSpecific () const
 Simple test for if this is a frontend specific IR node.
 
void setShared ()
 Allow IR nodes (mostly SgLocatedNode) to be marked as shared.
 
void unsetShared ()
 
bool isShared () const
 Simple test for if this is a shared IR node.
 
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).
 
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).
 
void unsetOutputInCodeGeneration ()
 
bool isOutputInCodeGeneration () const
 
int get_physical_file_id ()
 Allow IR nodes (mostly SgLocatedNode) to be queried for there physical file ID.
 
AttachedPreprocessingInfoType *& getAttachedPreprocessingInfo (void)
 Computes the number of nodes in the defined subtree of the AST.
 
Sg_File_InfogenerateMatchingFileInfo ()
 
virtual void addNewAttribute (std::string s, AstAttribute *a) override
 Add a new attribute represented by the named string.
 
virtual AstAttributegetAttribute (std::string s) const override
 Returns attribute of name 's'.
 
virtual void updateAttribute (std::string s, AstAttribute *a) override
 Replace existing attribute of name 's' with new AstAttribute.
 
virtual void setAttribute (std::string s, AstAttribute *a) override
 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.
 
virtual void removeAttribute (std::string s) override
 Remove attribute of name 's' if present.
 
virtual bool attributeExists (std::string s) const override
 Tests if attribute of name 's' is present.
 
virtual int numberOfAttributes () const override
 Returns the number of attributes on this IR node.
 
void * operator new (size_t size)
 returns pointer to newly allocated IR node
 
void operator delete (void *pointer, size_t size)
 deallocated memory for IR node (returns memory to memory pool for reuse)
 
void operator delete (void *pointer)
 
void executeVisitorMemberFunction (ROSE_VisitorPattern &visitor)
 FOR INTERNAL USE Support for visitor pattern.
 
 SgLocatedNode (const SgLocatedNodeStorageClass &source)
 IR node constructor to support AST File I/O.
 
SgLocatedNodeaddRegExpAttribute (std::string s, AstRegExAttribute *a)
 Support for AST matching using regular expression.
 
Sg_File_Infoget_startOfConstruct () const override
 New function interface for Sg_File_Info data stores starting location of contruct (typically the opening brace or first letter of keyword).
 
void set_startOfConstruct (Sg_File_Info *startOfConstruct)
 This function sets the current source location position of the start of the current construct.
 
Sg_File_Infoget_endOfConstruct () const override
 New function interface for Sg_File_Info data stores ending location of contruct (typically the closing brace).
 
void set_endOfConstruct (Sg_File_Info *endOfConstruct)
 This function sets the current source location position of the end of the current construct.
 
AttachedPreprocessingInfoType * get_attachedPreprocessingInfoPtr () const
 
void set_attachedPreprocessingInfoPtr (AttachedPreprocessingInfoType *attachedPreprocessingInfoPtr)
 
AstAttributeMechanismget_attributeMechanism () const override
 FOR INTERNAL USE Access function; if an attribute exists then a pointer to it is returned, else error.
 
void set_attributeMechanism (AstAttributeMechanism *attributeMechanism) override
 FOR INTERNAL USE Access function; sets poiner to value AstAttributeMechanism.
 
bool get_containsTransformationToSurroundingWhitespace () const
 
void set_containsTransformationToSurroundingWhitespace (bool containsTransformationToSurroundingWhitespace)
 
virtual ~SgLocatedNode ()
 This is the destructor.
 
 SgLocatedNode (Sg_File_Info *startOfConstruct=NULL)
 This is the constructor.
 
- Public Member Functions inherited from SgNode
void * operator new (size_t size)
 returns pointer to newly allocated IR node
 
void operator delete (void *pointer, size_t size)
 deallocated memory for IR node (returns memory to memory pool for reuse)
 
void operator delete (void *pointer)
 
void executeVisitorMemberFunction (ROSE_VisitorPattern &visitor)
 FOR INTERNAL USE Support for visitor pattern.
 
 SgNode (const SgNodeStorageClass &source)
 IR node constructor to support AST File I/O.
 
SgNodeaddRegExpAttribute (std::string s, AstRegExAttribute *a)
 Support for AST matching using regular expression.
 
void set_isModified (bool isModified)
 All nodes in the AST contain a isModified flag used to track changes to the AST.
 
void set_containsTransformation (bool containsTransformation)
 Many nodes can hide other AST nodes and we need to track when outer nodes contain modified nodes even if they are not themselves modified.
 
bool get_isModified () const
 Acess function for isModified flag.
 
bool get_containsTransformation () const
 Acess function for containsTransformation flag.
 
SgNodeget_raw_parent () const
 Access function for direct access to uncomputed value of parent node.
 
bool isChild (SgNode *node) const
 Query function for if the input IR nodes is a child of the current IR node.
 
virtual std::string unparseToString (SgUnparse_Info *info) const
 This function unparses the AST node (excluding comments and unnecessary white space)
 
std::string unparseToString () const
 
int variant () const
 Older version function returns enum value "NODE".
 
VirtualCFG::CFGNode cfgForBeginning ()
 Returns the CFG node for just before this AST node.
 
VirtualCFG::CFGNode cfgForEnd ()
 Returns the CFG node for just after this AST node.
 
int numberOfNodesInSubtree ()
 Computes the number of nodes in the defined subtree of the AST.
 
int depthOfSubtree ()
 Computes the depth of the current defined subtree of the AST.
 
template<class T >
T * initParentPointer (T *child, SgNode *parent)
 Generated for tree edge data member initializations.
 
SgNodeget_freepointer () const
 
void set_freepointer (SgNode *freepointer)
 
virtual ~SgNode ()
 This is the destructor.
 
 SgNode ()
 This is the constructor.
 
void * operator new (size_t size)
 returns pointer to newly allocated IR node
 
void operator delete (void *pointer, size_t size)
 deallocated memory for IR node (returns memory to memory pool for reuse)
 
void operator delete (void *pointer)
 
void executeVisitorMemberFunction (ROSE_VisitorPattern &visitor)
 FOR INTERNAL USE Support for visitor pattern.
 
 SgNode (const SgNodeStorageClass &source)
 IR node constructor to support AST File I/O.
 
SgNodeaddRegExpAttribute (std::string s, AstRegExAttribute *a)
 Support for AST matching using regular expression.
 
void set_isModified (bool isModified)
 All nodes in the AST contain a isModified flag used to track changes to the AST.
 
void set_containsTransformation (bool containsTransformation)
 Many nodes can hide other AST nodes and we need to track when outer nodes contain modified nodes even if they are not themselves modified.
 
bool get_isModified () const
 Acess function for isModified flag.
 
bool get_containsTransformation () const
 Acess function for containsTransformation flag.
 
void set_parent (SgNode *parent)
 All nodes in the AST contain a reference to a parent node.
 
SgNodeget_parent () const
 Access function for parent node.
 
SgNodeget_raw_parent () const
 Access function for direct access to uncomputed value of parent node.
 
bool isChild (SgNode *node) const
 Query function for if the input IR nodes is a child of the current IR node.
 
virtual std::string unparseToString (SgUnparse_Info *info) const
 This function unparses the AST node (excluding comments and unnecessary white space)
 
std::string unparseToString () const
 
std::string unparseToCompleteString ()
 This function unparses the AST node (including comments and white space)
 
int variant () const
 
bool get_isVisited () const
 DOCS IN HEADER: Access function for p_isVisited flag used previously by the AST traversals.
 
void set_isVisited (bool isVisited)
 Access function for p_isVisited flag used previously by the AST traversals.
 
VirtualCFG::CFGNode cfgForBeginning ()
 Returns the CFG node for just before this AST node.
 
VirtualCFG::CFGNode cfgForEnd ()
 Returns the CFG node for just after this AST node.
 
int numberOfNodesInSubtree ()
 Computes the number of nodes in the defined subtree of the AST.
 
int depthOfSubtree ()
 Computes the depth of the current defined subtree of the AST.
 
template<class T >
T * initParentPointer (T *child, SgNode *parent)
 Generated for tree edge data member initializations.
 
SgNodeget_freepointer () const
 
void set_freepointer (SgNode *freepointer)
 
void set_parent (SgNode *parent)
 All nodes in the AST contain a reference to a parent node.
 
SgNodeget_parent () const
 Access function for parent node.
 
std::string unparseToCompleteString ()
 This function unparses the AST node (including comments and white space)
 
bool get_isVisited () const
 DOCS IN HEADER: Access function for p_isVisited flag used previously by the AST traversals.
 
void set_isVisited (bool isVisited)
 Access function for p_isVisited flag used previously by the AST traversals.
 
template<class T >
std::enable_if< std::is_pointer< T >::value, void >::type changeChildPointer (T &edge, T const &child)
 Set a child edge in a tree to point to a specific child.
 
template<class T >
std::enable_if<!std::is_pointer< T >::value, void >::type changeChildPointer (T &edge, T const &child)
 Set a child edge in a tree to point to a specific child.
 
template<class T >
std::enable_if< std::is_pointer< T >::value, void >::type changeChildPointer (T &edge, T const &child)
 Set a child edge in a tree to point to a specific child.
 
template<class T >
std::enable_if<!std::is_pointer< T >::value, void >::type changeChildPointer (T &edge, T const &child)
 Set a child edge in a tree to point to a specific child.
 

Static Public Member Functions

static void deleteMemoryPool ()
 
static size_t numberOfNodes ()
 Returns the total number of IR nodes of this type.
 
static size_t memoryUsage ()
 Returns the size in bytes of the total memory allocated for all IR nodes of this type.
 
static void traverseMemoryPoolNodes (ROSE_VisitTraversal &visit)
 FOR INTERNAL USE Support for visitor pattern over all IR nodes by type of IR node.
 
static void traverseMemoryPoolVisitorPattern (ROSE_VisitorPattern &visitor)
 FOR INTERNAL USE Support for visitor pattern.
 
static void visitRepresentativeNode (ROSE_VisitTraversal &visit)
 FOR INTERNAL USE Support for type-based traversal.
 
static SgNodegetNodeByNodeId (VariantT variantT, size_t poolIdx, size_t itemIdx)
 Find a node by its variant type, pool index, and item index.
 
static SgFunctionDeclarationgetNodeByNodeIdInternal (size_t poolIdx, size_t itemIdx)
 FOR INTERNAL USE Find an SgNode from its memory pool and location therin.
 
static std::string getNodeIdString (SgFunctionDeclaration *sgnode)
 compute the NodeId for a particular SgNode*.
 
static std::string getNodeIdStringInternal (SgFunctionDeclaration *sgnode)
 
- Static Public Member Functions inherited from SgDeclarationStatement
static void deleteMemoryPool ()
 
static size_t numberOfNodes ()
 Returns the total number of IR nodes of this type.
 
static size_t memoryUsage ()
 Returns the size in bytes of the total memory allocated for all IR nodes of this type.
 
static void traverseMemoryPoolNodes (ROSE_VisitTraversal &visit)
 FOR INTERNAL USE Support for visitor pattern over all IR nodes by type of IR node.
 
static void traverseMemoryPoolVisitorPattern (ROSE_VisitorPattern &visitor)
 FOR INTERNAL USE Support for visitor pattern.
 
static void visitRepresentativeNode (ROSE_VisitTraversal &visit)
 FOR INTERNAL USE Support for type-based traversal.
 
static SgNodegetNodeByNodeId (VariantT variantT, size_t poolIdx, size_t itemIdx)
 Find a node by its variant type, pool index, and item index.
 
static SgDeclarationStatementgetNodeByNodeIdInternal (size_t poolIdx, size_t itemIdx)
 FOR INTERNAL USE Find an SgNode from its memory pool and location therin.
 
static std::string getNodeIdString (SgDeclarationStatement *sgnode)
 compute the NodeId for a particular SgNode*.
 
static std::string getNodeIdStringInternal (SgDeclarationStatement *sgnode)
 
- Static Public Member Functions inherited from SgStatement
static void deleteMemoryPool ()
 
static size_t numberOfNodes ()
 Returns the total number of IR nodes of this type.
 
static size_t memoryUsage ()
 Returns the size in bytes of the total memory allocated for all IR nodes of this type.
 
static void traverseMemoryPoolNodes (ROSE_VisitTraversal &visit)
 FOR INTERNAL USE Support for visitor pattern over all IR nodes by type of IR node.
 
static void traverseMemoryPoolVisitorPattern (ROSE_VisitorPattern &visitor)
 FOR INTERNAL USE Support for visitor pattern.
 
static void visitRepresentativeNode (ROSE_VisitTraversal &visit)
 FOR INTERNAL USE Support for type-based traversal.
 
static SgNodegetNodeByNodeId (VariantT variantT, size_t poolIdx, size_t itemIdx)
 Find a node by its variant type, pool index, and item index.
 
static SgStatementgetNodeByNodeIdInternal (size_t poolIdx, size_t itemIdx)
 FOR INTERNAL USE Find an SgNode from its memory pool and location therin.
 
static std::string getNodeIdString (SgStatement *sgnode)
 compute the NodeId for a particular SgNode*.
 
static std::string getNodeIdStringInternal (SgStatement *sgnode)
 
- Static Public Member Functions inherited from SgLocatedNode
static void deleteMemoryPool ()
 
static size_t numberOfNodes ()
 Returns the total number of IR nodes of this type.
 
static size_t memoryUsage ()
 Returns the size in bytes of the total memory allocated for all IR nodes of this type.
 
static void traverseMemoryPoolNodes (ROSE_VisitTraversal &visit)
 FOR INTERNAL USE Support for visitor pattern over all IR nodes by type of IR node.
 
static void traverseMemoryPoolVisitorPattern (ROSE_VisitorPattern &visitor)
 FOR INTERNAL USE Support for visitor pattern.
 
static void visitRepresentativeNode (ROSE_VisitTraversal &visit)
 FOR INTERNAL USE Support for type-based traversal.
 
static SgNodegetNodeByNodeId (VariantT variantT, size_t poolIdx, size_t itemIdx)
 Find a node by its variant type, pool index, and item index.
 
static SgLocatedNodegetNodeByNodeIdInternal (size_t poolIdx, size_t itemIdx)
 FOR INTERNAL USE Find an SgNode from its memory pool and location therin.
 
static std::string getNodeIdString (SgLocatedNode *sgnode)
 compute the NodeId for a particular SgNode*.
 
static std::string getNodeIdStringInternal (SgLocatedNode *sgnode)
 
- Static Public Member Functions inherited from SgNode
static void deleteMemoryPool ()
 
static size_t numberOfNodes ()
 Returns the total number of IR nodes of this type.
 
static size_t memoryUsage ()
 Returns the size in bytes of the total memory allocated for all IR nodes of this type.
 
static void traverseMemoryPoolNodes (ROSE_VisitTraversal &visit)
 FOR INTERNAL USE Support for visitor pattern over all IR nodes by type of IR node.
 
static void traverseMemoryPoolVisitorPattern (ROSE_VisitorPattern &visitor)
 FOR INTERNAL USE Support for visitor pattern.
 
static void visitRepresentativeNode (ROSE_VisitTraversal &visit)
 FOR INTERNAL USE Support for type-based traversal.
 
static SgNodegetNodeByNodeId (VariantT variantT, size_t poolIdx, size_t itemIdx)
 Find a node by its variant type, pool index, and item index.
 
static SgNodegetNodeByNodeIdInternal (size_t poolIdx, size_t itemIdx)
 FOR INTERNAL USE Find an SgNode from its memory pool and location therin.
 
static std::string getNodeIdString (SgNode *sgnode)
 compute the NodeId for a particular SgNode*.
 
static std::string getNodeIdStringInternal (SgNode *sgnode)
 
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.
 
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.
 
static void clearGlobalMangledNameMap ()
 Support to clear the performance optimizing global mangled name map.
 
static std::map< std::string, uint64_t > & get_shortMangledNameCache ()
 Access function for lower level optimizing of global mangled name map.
 
static std::map< SgNode *, std::string > & get_globalQualifiedNameMapForNames ()
 Access function for name qualification support (for names).
 
static void set_globalQualifiedNameMapForNames (const std::map< SgNode *, std::string > &X)
 Access function for name qualification support (for names).
 
static std::map< SgNode *, std::string > & get_globalQualifiedNameMapForTypes ()
 Access function for name qualification support (for type).
 
static void set_globalQualifiedNameMapForTypes (const std::map< SgNode *, std::string > &X)
 Access function for name qualification support (for type).
 
static std::map< SgNode *, std::map< SgNode *, std::string > > & get_globalQualifiedNameMapForMapsOfTypes ()
 Access function for name qualification support (for maps of types).
 
static void set_globalQualifiedNameMapForMapsOfTypes (const std::map< SgNode *, std::map< SgNode *, std::string > > &X)
 Access function for name qualification support (for maps of types).
 
static std::map< SgNode *, std::string > & get_globalQualifiedNameMapForTemplateHeaders ()
 Access function for name qualification support (for template headers in template declarations).
 
static void set_globalQualifiedNameMapForTemplateHeaders (const std::map< SgNode *, std::string > &X)
 Access function for name qualification support (for template headers in template declarations).
 
static std::map< SgNode *, std::string > & get_globalTypeNameMap ()
 Access function for name qualification support (for names of types).
 
static void set_globalTypeNameMap (const std::map< SgNode *, std::string > &X)
 Access function for name qualification support (for names of types).
 
static SgFunctionTypeTableget_globalFunctionTypeTable ()
 Access function for symbol table specific to function types.
 
static void set_globalFunctionTypeTable (SgFunctionTypeTable *globalFunctionTypeTable)
 Access function for symbol table specific to function types.
 
static SgTypeTableget_globalTypeTable ()
 Access function for symbol table specific to non-function types.
 
static void set_globalTypeTable (SgTypeTable *globalTypeTable)
 Access function for symbol table specific to non-function types.
 
static VariantT variantFromPool (SgNode const *n)
 
template<class T >
static std::enable_if< std::is_base_of< SgNode, T >::value, T * >::type createAndParent (SgNode *parent)
 Allocate and return a new node after setting its parent.
 
static void deleteMemoryPool ()
 
static size_t numberOfNodes ()
 Returns the total number of IR nodes of this type.
 
static size_t memoryUsage ()
 Returns the size in bytes of the total memory allocated for all IR nodes of this type.
 
static void traverseMemoryPoolNodes (ROSE_VisitTraversal &visit)
 FOR INTERNAL USE Support for visitor pattern over all IR nodes by type of IR node.
 
static void traverseMemoryPoolVisitorPattern (ROSE_VisitorPattern &visitor)
 FOR INTERNAL USE Support for visitor pattern.
 
static void visitRepresentativeNode (ROSE_VisitTraversal &visit)
 FOR INTERNAL USE Support for type-based traversal.
 
static SgNodegetNodeByNodeId (VariantT variantT, size_t poolIdx, size_t itemIdx)
 Find a node by its variant type, pool index, and item index.
 
static SgNodegetNodeByNodeIdInternal (size_t poolIdx, size_t itemIdx)
 FOR INTERNAL USE Find an SgNode from its memory pool and location therin.
 
static std::string getNodeIdString (SgNode *sgnode)
 compute the NodeId for a particular SgNode*.
 
static std::string getNodeIdStringInternal (SgNode *sgnode)
 
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.
 
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.
 
static void clearGlobalMangledNameMap ()
 Support to clear the performance optimizing global mangled name map.
 
static std::map< std::string, uint64_t > & get_shortMangledNameCache ()
 Access function for lower level optimizing of global mangled name map.
 
static std::map< SgNode *, std::string > & get_globalQualifiedNameMapForNames ()
 Access function for name qualification support (for names).
 
static void set_globalQualifiedNameMapForNames (const std::map< SgNode *, std::string > &X)
 Access function for name qualification support (for names).
 
static std::map< SgNode *, std::string > & get_globalQualifiedNameMapForTypes ()
 Access function for name qualification support (for type).
 
static void set_globalQualifiedNameMapForTypes (const std::map< SgNode *, std::string > &X)
 Access function for name qualification support (for type).
 
static std::map< SgNode *, std::map< SgNode *, std::string > > & get_globalQualifiedNameMapForMapsOfTypes ()
 Access function for name qualification support (for maps of types).
 
static void set_globalQualifiedNameMapForMapsOfTypes (const std::map< SgNode *, std::map< SgNode *, std::string > > &X)
 Access function for name qualification support (for maps of types).
 
static std::map< SgNode *, std::string > & get_globalQualifiedNameMapForTemplateHeaders ()
 Access function for name qualification support (for template headers in template declarations).
 
static void set_globalQualifiedNameMapForTemplateHeaders (const std::map< SgNode *, std::string > &X)
 Access function for name qualification support (for template headers in template declarations).
 
static std::map< SgNode *, std::string > & get_globalTypeNameMap ()
 Access function for name qualification support (for names of types).
 
static void set_globalTypeNameMap (const std::map< SgNode *, std::string > &X)
 Access function for name qualification support (for names of types).
 
static SgFunctionTypeTableget_globalFunctionTypeTable ()
 Access function for symbol table specific to function types.
 
static void set_globalFunctionTypeTable (SgFunctionTypeTable *globalFunctionTypeTable)
 Access function for symbol table specific to function types.
 
static SgTypeTableget_globalTypeTable ()
 Access function for symbol table specific to non-function types.
 
static void set_globalTypeTable (SgTypeTable *globalTypeTable)
 Access function for symbol table specific to non-function types.
 
static VariantT variantFromPool (SgNode const *n)
 
template<class T >
static std::enable_if< std::is_base_of< SgNode, T >::value, T * >::type createAndParent (SgNode *parent)
 Allocate and return a new node after setting its parent.
 

Protected Member Functions

virtual bool replace_child (SgStatement *, SgStatement *, bool extractListFromBasicBlock=false) override
 Private supporting function for low level SageIII rewrite interface.
 
- 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.
 
- Protected Member Functions inherited from SgNode
virtual void destructorHelper ()
 This gets called by all Rosebud-generated destructors.
 
virtual void destructorHelper ()
 This gets called by all Rosebud-generated destructors.
 
virtual void debugSerializationBegin (const char *className)
 Called by generated serializers.
 
virtual void debugSerializationEnd (const char *className)
 Called by generated serializers.
 
virtual void debugSerializationBegin (const char *className)
 Called by generated serializers.
 
virtual void debugSerializationEnd (const char *className)
 Called by generated serializers.
 

Protected Attributes

SgName p_name
 This variable stores the string representing the function name.
 
SgFunctionParameterListp_parameterList
 
SgFunctionModifier p_functionModifier
 This variable stores flags representing use of inline, virtual, etc.
 
SgSpecialFunctionModifier p_specialFunctionModifier
 This variable stores flags representing use of constructor, destructor, etc.
 
SgTypePtrList p_exceptionSpecification
 
bool p_named_in_end_statement
 
std::string p_asm_name
 
SgExprListExpp_decoratorList
 This variable stores a list of decorators.
 
bool p_ada_formal_subprogram_decl
 
bool p_ada_formal_decl_with_box
 
SgFunctionTypep_type
 This variable stores the SgFunctionType.
 
SgFunctionDefinitionp_definition
 This variable stores the SgFunctionDefinition.
 
bool p_oldStyleDefinition
 This boolean variable records if the function uses the old style definition.
 
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
 
SgFunctionTypep_type_syntax
 
bool p_type_syntax_is_available
 
SgFunctionParameterListp_parameterList_syntax
 
bool p_using_C11_Noreturn_keyword
 
bool p_is_constexpr
 
bool p_using_new_function_return_type_syntax
 
SgFunctionParameterScopep_functionParameterScope
 
bool p_marked_as_edg_normalization
 
bool p_is_implicit_function
 
- Protected Attributes inherited from SgDeclarationStatement
unsigned int p_decl_attributes
 This is old and used to be used to hold modifiers.
 
std::string p_linkage
 This string stores the value "C", "C++", or "fortran" to define the external linkage for generating linkable names.
 
SgDeclarationModifier p_declarationModifier
 This is the mechanism to handle declaration modifiers.
 
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!).
 
bool p_forward
 This marks a declaration as being an explicit forward declaration.
 
bool p_externBrace
 This marks that the declaration appeared with "extern".
 
bool p_skipElaborateType
 This marks "type elaboration" which is the use of the keyword "class" before variables of type class.
 
SgDeclarationStatementp_definingDeclaration
 This pointer is valid only if a defining declaration exists, and stores the defining declaration where the declaration was defined.
 
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.
 
SgQualifiedNamePtrList p_qualifiedNameList
 
std::string p_binding_label
 
SgDeclarationScopep_declarationScope
 
bool p_unparse_template_ast
 
SgExprListExpp_adaAspects
 
- 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.
 
Sg_File_Infop_endOfConstruct
 This pointer is always valid and stores the source position of the end of the current construct.
 
AttachedPreprocessingInfoType * p_attachedPreprocessingInfoPtr
 Holds comments and/or preprocessor directives located before or after the current statement of expression.
 
AstAttributeMechanismp_attributeMechanism
 
bool p_containsTransformationToSurroundingWhitespace
 
- Protected Attributes inherited from SgNode
SgNodep_parent
 This is the pointer to the parent IR node in the AST.
 
bool p_isModified
 Records if IR node has been modified (data members reset).
 
bool p_containsTransformation
 
SgNodep_freepointer
 This is the pointer to the chain of previously freed objects.
 

Additional Inherited Members

- Static Protected Attributes inherited from SgNode
static std::vector< std::tuple< unsigned char *, unsigned, VariantT > > all_pools
 
static SgFunctionTypeTablep_globalFunctionTypeTable
 Pointer to symbol table specific to function types.
 
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.
 
static std::map< std::string, uint64_t > p_shortMangledNameCache
 STL map used as a cache to shorten generated mangled names. This is mostly a space optimization ofr mangled names of templates.
 
static std::map< SgNode *, std::string > p_globalQualifiedNameMapForNames
 
static std::map< SgNode *, std::string > p_globalQualifiedNameMapForTypes
 
static std::map< SgNode *, std::string > p_globalQualifiedNameMapForTemplateHeaders
 
static std::map< SgNode *, std::string > p_globalTypeNameMap
 
static std::map< SgNode *, std::map< SgNode *, std::string > > p_globalQualifiedNameMapForMapsOfTypes
 

Member Typedef Documentation

◆ base_node_type

Definition at line 312918 of file Cxx_Grammar.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

static variant value

Definition at line 312539 of file Cxx_Grammar.h.

Constructor & Destructor Documentation

◆ ~SgFunctionDeclaration()

SgFunctionDeclaration::~SgFunctionDeclaration ( )
virtual

This is the destructor.

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

Member Function Documentation

◆ copy()

virtual SgNode * SgFunctionDeclaration::copy ( SgCopyHelp help) const
overridevirtual

Reimplemented from SgDeclarationStatement.

◆ get_mangled_name()

virtual SgName SgFunctionDeclaration::get_mangled_name ( void  ) const
overridevirtual

◆ isTemplateFunction()

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.

◆ hasExplicitScope()

virtual bool SgFunctionDeclaration::hasExplicitScope ( ) const
overridevirtual

Support for where the scope is explicitly required.

Reimplemented from SgStatement.

◆ get_symbol_from_symbol_table()

virtual SgSymbol * SgFunctionDeclaration::get_symbol_from_symbol_table ( ) const
overridevirtual

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 SgMemberFunctionDeclaration, SgTemplateInstantiationMemberFunctionDecl, and SgTemplateInstantiationFunctionDecl.

◆ fixupCopy_scopes()

virtual void SgFunctionDeclaration::fixupCopy_scopes ( SgNode copy,
SgCopyHelp help 
) const
overridevirtual

Reimplemented from SgDeclarationStatement.

◆ fixupCopy_symbols()

virtual void SgFunctionDeclaration::fixupCopy_symbols ( SgNode copy,
SgCopyHelp help 
) const
overridevirtual

Reimplemented from SgDeclarationStatement.

◆ fixupCopy_references()

virtual void SgFunctionDeclaration::fixupCopy_references ( SgNode copy,
SgCopyHelp help 
) const
overridevirtual

Reimplemented from SgDeclarationStatement.

◆ replace_child()

virtual bool SgFunctionDeclaration::replace_child ( SgStatement target,
SgStatement newStmt,
bool  extractListFromBasicBlock = false 
)
overrideprotectedvirtual

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 SgMemberFunctionDeclaration, and SgProgramHeaderStatement.

◆ cfgIndexForEnd()

virtual unsigned int SgFunctionDeclaration::cfgIndexForEnd ( ) const
overridevirtual

Determine the CFG index for the end of this construct.

Reimplemented from SgStatement.

Reimplemented in SgMemberFunctionDeclaration.

◆ cfgOutEdges()

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

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

Reimplemented from SgStatement.

Reimplemented in SgMemberFunctionDeclaration.

◆ cfgInEdges()

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

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

Reimplemented from SgStatement.

Reimplemented in SgMemberFunctionDeclaration.

◆ class_name()

virtual std::string SgFunctionDeclaration::class_name ( ) const
overridevirtual

◆ variantT()

virtual VariantT SgFunctionDeclaration::variantT ( ) const
overridevirtual

◆ operator delete()

void SgFunctionDeclaration::operator delete ( void *  pointer)
inline

Definition at line 312594 of file Cxx_Grammar.h.

◆ get_traversalSuccessorContainer()

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

◆ get_traversalSuccessorNamesContainer()

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

container of names of variables or container indices used used in the traversal to access AST successor nodes overridden in every class by generated implementation

Reimplemented from SgDeclarationStatement.

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

◆ get_numberOfTraversalSuccessors()

virtual size_t SgFunctionDeclaration::get_numberOfTraversalSuccessors ( )
overridevirtual

◆ get_traversalSuccessorByIndex()

virtual SgNode * SgFunctionDeclaration::get_traversalSuccessorByIndex ( size_t  idx)
overridevirtual

◆ get_childIndex()

virtual size_t SgFunctionDeclaration::get_childIndex ( SgNode child)
overridevirtual

◆ roseRTI()

virtual RTIReturnType SgFunctionDeclaration::roseRTI ( )
overridevirtual

◆ sage_class_name()

virtual const char * SgFunctionDeclaration::sage_class_name ( ) const
overridevirtual

◆ accept()

virtual void SgFunctionDeclaration::accept ( ROSE_VisitorPattern visitor)
overridevirtual

◆ isInMemoryPool()

virtual bool SgFunctionDeclaration::isInMemoryPool ( )
overridevirtual

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 SgTemplateFunctionDeclaration, SgMemberFunctionDeclaration, SgTemplateMemberFunctionDeclaration, SgTemplateInstantiationMemberFunctionDecl, SgTemplateInstantiationFunctionDecl, SgProgramHeaderStatement, SgProcedureHeaderStatement, SgEntryStatement, SgAdaEntryDecl, and SgAdaFunctionRenamingDecl.

◆ checkDataMemberPointersIfInMemoryPool()

virtual void SgFunctionDeclaration::checkDataMemberPointersIfInMemoryPool ( )
overridevirtual

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 SgTemplateFunctionDeclaration, SgMemberFunctionDeclaration, SgTemplateMemberFunctionDeclaration, SgTemplateInstantiationMemberFunctionDecl, SgTemplateInstantiationFunctionDecl, SgProgramHeaderStatement, SgProcedureHeaderStatement, SgEntryStatement, SgAdaEntryDecl, and SgAdaFunctionRenamingDecl.

◆ returnDataMemberPointers()

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

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 SgTemplateFunctionDeclaration, SgMemberFunctionDeclaration, SgTemplateMemberFunctionDeclaration, SgTemplateInstantiationMemberFunctionDecl, SgTemplateInstantiationFunctionDecl, SgProgramHeaderStatement, SgProcedureHeaderStatement, SgEntryStatement, SgAdaEntryDecl, and SgAdaFunctionRenamingDecl.

◆ processDataMemberReferenceToPointers()

virtual void SgFunctionDeclaration::processDataMemberReferenceToPointers ( ReferenceToPointerHandler )
overridevirtual

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 SgTemplateFunctionDeclaration, SgMemberFunctionDeclaration, SgTemplateMemberFunctionDeclaration, SgTemplateInstantiationMemberFunctionDecl, SgTemplateInstantiationFunctionDecl, SgProgramHeaderStatement, SgProcedureHeaderStatement, SgEntryStatement, SgAdaEntryDecl, and SgAdaFunctionRenamingDecl.

◆ getChildIndex()

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

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 SgTemplateFunctionDeclaration, SgMemberFunctionDeclaration, SgTemplateMemberFunctionDeclaration, SgTemplateInstantiationMemberFunctionDecl, SgTemplateInstantiationFunctionDecl, SgProgramHeaderStatement, SgProcedureHeaderStatement, SgEntryStatement, SgAdaEntryDecl, and SgAdaFunctionRenamingDecl.

◆ addRegExpAttribute()

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.

◆ post_construction_initialization()

void SgFunctionDeclaration::post_construction_initialization ( )
overridevirtual

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 SgTemplateFunctionDeclaration, SgMemberFunctionDeclaration, SgTemplateMemberFunctionDeclaration, SgTemplateInstantiationMemberFunctionDecl, SgTemplateInstantiationFunctionDecl, SgProgramHeaderStatement, and SgProcedureHeaderStatement.

◆ get_scope()

SgScopeStatement * SgFunctionDeclaration::get_scope ( void  ) const
overridevirtual

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.

◆ set_scope()

void SgFunctionDeclaration::set_scope ( SgScopeStatement newScope)
overridevirtual

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

Reimplemented from SgStatement.

Member Data Documentation

◆ p_name

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.

Definition at line 313064 of file Cxx_Grammar.h.

◆ p_parameterList

SgFunctionParameterList* SgFunctionDeclaration::p_parameterList
protected

Definition at line 313068 of file Cxx_Grammar.h.

◆ p_functionModifier

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 313072 of file Cxx_Grammar.h.

◆ p_specialFunctionModifier

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 313076 of file Cxx_Grammar.h.

◆ p_exceptionSpecification

SgTypePtrList SgFunctionDeclaration::p_exceptionSpecification
protected

Definition at line 313080 of file Cxx_Grammar.h.

◆ p_named_in_end_statement

bool SgFunctionDeclaration::p_named_in_end_statement
protected

Definition at line 313084 of file Cxx_Grammar.h.

◆ p_asm_name

std::string SgFunctionDeclaration::p_asm_name
protected

Definition at line 313088 of file Cxx_Grammar.h.

◆ p_decoratorList

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 313092 of file Cxx_Grammar.h.

◆ p_ada_formal_subprogram_decl

bool SgFunctionDeclaration::p_ada_formal_subprogram_decl
protected

Definition at line 313096 of file Cxx_Grammar.h.

◆ p_ada_formal_decl_with_box

bool SgFunctionDeclaration::p_ada_formal_decl_with_box
protected

Definition at line 313100 of file Cxx_Grammar.h.

◆ p_type

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 313104 of file Cxx_Grammar.h.

◆ p_definition

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.

Definition at line 313108 of file Cxx_Grammar.h.

◆ p_oldStyleDefinition

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.

Definition at line 313112 of file Cxx_Grammar.h.

◆ p_scope

SgScopeStatement* SgFunctionDeclaration::p_scope
protected

Definition at line 313116 of file Cxx_Grammar.h.

◆ p_specialization

SgDeclarationStatement::template_specialization_enum SgFunctionDeclaration::p_specialization
protected

Definition at line 313120 of file Cxx_Grammar.h.

◆ p_requiresNameQualificationOnReturnType

bool SgFunctionDeclaration::p_requiresNameQualificationOnReturnType
protected

Definition at line 313124 of file Cxx_Grammar.h.

◆ p_gnu_extension_section

std::string SgFunctionDeclaration::p_gnu_extension_section
protected

Definition at line 313128 of file Cxx_Grammar.h.

◆ p_gnu_extension_alias

std::string SgFunctionDeclaration::p_gnu_extension_alias
protected

Definition at line 313132 of file Cxx_Grammar.h.

◆ p_gnu_extension_visability

SgDeclarationStatement::gnu_extension_visability_attribute_enum SgFunctionDeclaration::p_gnu_extension_visability
protected

Definition at line 313136 of file Cxx_Grammar.h.

◆ p_name_qualification_length

int SgFunctionDeclaration::p_name_qualification_length
protected

Definition at line 313140 of file Cxx_Grammar.h.

◆ p_type_elaboration_required

bool SgFunctionDeclaration::p_type_elaboration_required
protected

Definition at line 313144 of file Cxx_Grammar.h.

◆ p_global_qualification_required

bool SgFunctionDeclaration::p_global_qualification_required
protected

Definition at line 313148 of file Cxx_Grammar.h.

◆ p_name_qualification_length_for_return_type

int SgFunctionDeclaration::p_name_qualification_length_for_return_type
protected

Definition at line 313152 of file Cxx_Grammar.h.

◆ p_type_elaboration_required_for_return_type

bool SgFunctionDeclaration::p_type_elaboration_required_for_return_type
protected

Definition at line 313156 of file Cxx_Grammar.h.

◆ p_global_qualification_required_for_return_type

bool SgFunctionDeclaration::p_global_qualification_required_for_return_type
protected

Definition at line 313160 of file Cxx_Grammar.h.

◆ p_prototypeIsWithoutParameters

bool SgFunctionDeclaration::p_prototypeIsWithoutParameters
protected

Definition at line 313164 of file Cxx_Grammar.h.

◆ p_gnu_regparm_attribute

int SgFunctionDeclaration::p_gnu_regparm_attribute
protected

Definition at line 313168 of file Cxx_Grammar.h.

◆ p_type_syntax

SgFunctionType* SgFunctionDeclaration::p_type_syntax
protected

Definition at line 313172 of file Cxx_Grammar.h.

◆ p_type_syntax_is_available

bool SgFunctionDeclaration::p_type_syntax_is_available
protected

Definition at line 313176 of file Cxx_Grammar.h.

◆ p_parameterList_syntax

SgFunctionParameterList* SgFunctionDeclaration::p_parameterList_syntax
protected

Definition at line 313180 of file Cxx_Grammar.h.

◆ p_using_C11_Noreturn_keyword

bool SgFunctionDeclaration::p_using_C11_Noreturn_keyword
protected

Definition at line 313184 of file Cxx_Grammar.h.

◆ p_is_constexpr

bool SgFunctionDeclaration::p_is_constexpr
protected

Definition at line 313188 of file Cxx_Grammar.h.

◆ p_using_new_function_return_type_syntax

bool SgFunctionDeclaration::p_using_new_function_return_type_syntax
protected

Definition at line 313192 of file Cxx_Grammar.h.

◆ p_functionParameterScope

SgFunctionParameterScope* SgFunctionDeclaration::p_functionParameterScope
protected

Definition at line 313196 of file Cxx_Grammar.h.

◆ p_marked_as_edg_normalization

bool SgFunctionDeclaration::p_marked_as_edg_normalization
protected

Definition at line 313200 of file Cxx_Grammar.h.

◆ p_is_implicit_function

bool SgFunctionDeclaration::p_is_implicit_function
protected

Definition at line 313204 of file Cxx_Grammar.h.


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