Skip to content

SgFunctionDefinition

Synopsis

Declared in <src/frontend/SageIII/Cxx_Grammar.h> (not stored in Git)

class [[visibility("default")]] SgFunctionDefinition
    : public SgScopeStatement

Base Classes

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

Type Aliases

Name
base_node_type

Enums

Name Description
Unnamed enum static variant value

Member Functions

Name Description
SgFunctionDefinition
SgFunctionDefinition(SgBasicBlock* body); [constructor]
Constructors
~SgFunctionDefinition
virtual ~SgFunctionDefinition(); [destructor] [virtual]
Destructor
accept
virtual void accept(ROSE_VisitorPattern& visitor) override; [virtual]
support for the classic visitor pattern done in GoF
adopt_destructor_epilogue
void adopt_destructor_epilogue( SgExprListExp* epilogue, SgInitializedNamePtrList const& members);
appendDestructorOwnedNodes
virtual void appendDestructorOwnedNodes(std::vector<SgNode*>& nodes) const override; [virtual]
append_statement
void append_statement(SgStatement* what);
cfgFindChildIndex
virtual unsigned int cfgFindChildIndex(SgNode* n) override; [virtual]
cfgInEdges
virtual std::vector<VirtualCFG::CFGEdge> cfgInEdges(unsigned int index) override; [virtual]
cfgIndexForEnd
virtual unsigned int cfgIndexForEnd() const override; [virtual]
cfgIsIndexInteresting
virtual bool cfgIsIndexInteresting(unsigned int) const override; [virtual]
cfgOutEdges
virtual std::vector<VirtualCFG::CFGEdge> cfgOutEdges(unsigned int index) override; [virtual]
class_name
virtual std::string class_name() const override; [virtual]
returns a string representing the class name
clearScopeNumbers
void clearScopeNumbers();
copy
virtual SgNode* copy(SgCopyHelp& help) const override; [virtual]
defer_destructor_epilogue
void defer_destructor_epilogue();
fixupCopy_references
virtual void fixupCopy_references( SgNode* copy, SgCopyHelp& help) const override; [virtual]
fixupCopy_scopes
virtual void fixupCopy_scopes( SgNode* copy, SgCopyHelp& help) const override; [virtual]
fixupCopy_symbols
virtual void fixupCopy_symbols( SgNode* copy, SgCopyHelp& help) const override; [virtual]
get_CtorInitializerList
virtual SgCtorInitializerList* get_CtorInitializerList() const; [virtual]
get_body
SgBasicBlock* get_body() const;
get_childIndex
virtual size_t get_childIndex(SgNode* child) const override; [virtual]
index-based access to traversal successors by child node
get_construction_physical_output_owner
SgScopeStatement* get_construction_physical_output_owner() const;
get_declaration
SgFunctionDeclaration* get_declaration() const;
get_destructor_epilogue
SgExprListExp* get_destructor_epilogue() const;
get_destructor_epilogue_dependent
bool get_destructor_epilogue_dependent() const;
get_fortran_construction_name
SgName get_fortran_construction_name() const;
get_mangled_name
virtual SgName get_mangled_name() const override; [virtual]
get_numberOfTraversalSuccessors
virtual size_t get_numberOfTraversalSuccessors() const override; [virtual]
return number of children in the traversal successor list
get_qualified_name
virtual SgName get_qualified_name() const override; [virtual]
get_scope_number
int get_scope_number(SgNode const* scope) const;
get_scope_number_list
std::map<SgNode*, int>& get_scope_number_list();
get_traversalSuccessorByIndex
virtual SgNode* get_traversalSuccessorByIndex(size_t idx) const override; [virtual]
index-based access to traversal successors by index number
get_traversalSuccessorContainer
virtual std::vector<SgNode*> get_traversalSuccessorContainer() const override; [virtual]
container of pointers to AST successor nodes used in the traversal overridden in every class by generated implementation
get_traversalSuccessorIsListElement
virtual std::vector<bool> get_traversalSuccessorIsListElement() const override; [virtual]
get_traversalSuccessorNamesContainer
virtual std::vector<std::string> get_traversalSuccessorNamesContainer() const override; [virtual]
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
has_dependent_destructor_context
bool has_dependent_destructor_context() const;
operator delete
void operator delete( void* pointer, size_t size);
deallocated memory for IR node (returns memory to memory pool for reuse)
operator new
void* operator new(size_t size);
returns pointer to newly allocated IR node
post_construction_initialization
virtual void post_construction_initialization() override; [virtual]
prepend_statement
void prepend_statement(SgStatement* what);
processDataMemberReferenceToPointers
virtual void processDataMemberReferenceToPointers(ReferenceToPointerHandler*) override; [virtual]
Pass references to stored node pointers to a handler.
resetScopeNumbers
void resetScopeNumbers();
returnDataMemberPointers
virtual std::vector<std::pair<SgNode*, std::string>> returnDataMemberPointers() const override; [virtual]
Return the node pointers stored in this node's data members.
roseRTI
virtual RTIReturnType roseRTI() override; [virtual]
return C++ Runtime-Time-Information
sage_class_name
virtual char const* sage_class_name() const override; [virtual]
returns a C style string (char*) representing the class name
set_body
void set_body(SgBasicBlock* body);
set_construction_physical_output_owner
void set_construction_physical_output_owner(SgScopeStatement* construction_physical_output_owner);
set_declaration
void set_declaration(SgFunctionDeclaration* new_val);
set_fortran_construction_name
void set_fortran_construction_name(SgName fortran_construction_name);
variantT
virtual VariantT variantT() const override; [virtual]
returns new style SageIII enum values

Static Member Functions

Name Description
has_complete_member_destruction
static bool has_complete_member_destruction( SgExpressionPtrList const& steps, SgInitializedNamePtrList const& members);
memoryUsage
static size_t memoryUsage();
Returns the size in bytes of the total memory allocated for all IR nodes of this type
numberOfNodes
static size_t numberOfNodes();
Returns the total number of IR nodes of this type
traverseMemoryPoolNodes
static void traverseMemoryPoolNodes(ROSE_VisitTraversal& visit);
FOR INTERNAL USE Support for visitor pattern over all IR nodes by type of IR node.
traverseMemoryPoolVisitorPattern
static void traverseMemoryPoolVisitorPattern(ROSE_VisitorPattern& visitor);
FOR INTERNAL USE Support for visitor pattern.
visitRepresentativeNode
static void visitRepresentativeNode(ROSE_VisitTraversal& visit);
FOR INTERNAL USE Support for type-based traversal.

Static Data Members

Name Description
free_slots Free slots, each numbered pool_index * pool_size + slot_index. The last entry is allocated next.
pool_live_flags
pool_size
pools

Protected Member Functions

Name
insert_child
virtual bool insert_child( SgStatement*, SgStatement*, bool inFront = true, bool extractListFromBasicBlock = false) override; [virtual]
replace_child
virtual bool replace_child( SgStatement*, SgStatement*, bool extractListFromBasicBlock = false) override; [virtual]

Protected Data Members

Name
p_body
p_construction_physical_output_owner
p_destructor_epilogue
p_destructor_epilogue_dependent
p_fortran_construction_name
p_scope_number_list

Friends

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

Derived Classes

Name Description
SgTemplateFunctionDefinition

Created with MrDocs