Skip to content

SgProcedureHeaderStatement

Synopsis

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

class [[visibility("default")]] SgProcedureHeaderStatement
    : public SgFunctionDeclaration

Base Classes

Name Description
SgFunctionDeclaration

Type Aliases

Name
base_node_type

Enums

Name Description
Unnamed enum static variant value
block_data_name_kind_enum Source-level naming of a BLOCK DATA program unit.
fortran_procedure_source_form_enum Exact Fortran source surface represented by this procedure.
fortran_result_type_spec_enum Exact source type-spec spelling for a Fortran function result.
subprogram_kind_enum Classification for different types of Fortran subprograms.

Member Functions

Name Description
SgProcedureHeaderStatement
SgProcedureHeaderStatement( SgName name, SgFunctionType* type, SgFunctionDefinition* definition, SgFunctionType* declared_exception_signature); [constructor]
Constructors
~SgProcedureHeaderStatement
virtual ~SgProcedureHeaderStatement(); [destructor] [virtual]
Destructor
accept
virtual void accept(ROSE_VisitorPattern& visitor) override; [virtual]
support for the classic visitor pattern done in GoF
appendDestructorOwnedNodes
virtual void appendDestructorOwnedNodes(std::vector<SgNode*>& nodes) const override; [virtual]
class_name
virtual std::string class_name() const override; [virtual]
returns a string representing the class name
copy
virtual SgNode* copy(SgCopyHelp& help) const override; [virtual]
get_block_data_name_kind
SgProcedureHeaderStatement::block_data_name_kind_enum get_block_data_name_kind() const;
get_childIndex
virtual size_t get_childIndex(SgNode* child) const override; [virtual]
index-based access to traversal successors by child node
get_end_numeric_label
virtual SgLabelRefExp* get_end_numeric_label() const override; [virtual]
get_fortran_binding_name
SgName get_fortran_binding_name() const;
get_fortran_procedure_source_form
SgProcedureHeaderStatement::fortran_procedure_source_form_enum get_fortran_procedure_source_form() const;
get_fortran_result_type_spec
SgProcedureHeaderStatement::fortran_result_type_spec_enum get_fortran_result_type_spec() const;
get_fortran_source_derived_type_symbol
SgSymbol* get_fortran_source_derived_type_symbol() 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_result_name
SgInitializedName* get_result_name() const;
get_subprogram_kind
SgProcedureHeaderStatement::subprogram_kind_enum get_subprogram_kind() const;
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
isBlockData
bool isBlockData() const;
isFunction
bool isFunction() const;
isSubroutine
bool isSubroutine() 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]
processDataMemberReferenceToPointers
virtual void processDataMemberReferenceToPointers(ReferenceToPointerHandler*) override; [virtual]
Pass references to stored node pointers to a handler.
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_block_data_name_kind
void set_block_data_name_kind(SgProcedureHeaderStatement::block_data_name_kind_enum block_data_name_kind);
set_end_numeric_label
virtual void set_end_numeric_label(SgLabelRefExp* end_numeric_label) override; [virtual]
set_fortran_binding_name
void set_fortran_binding_name(SgName fortran_binding_name);
set_fortran_procedure_source_form
void set_fortran_procedure_source_form(SgProcedureHeaderStatement::fortran_procedure_source_form_enum fortran_procedure_source_form);
set_fortran_result_type_spec
void set_fortran_result_type_spec(SgProcedureHeaderStatement::fortran_result_type_spec_enum fortran_result_type_spec);
set_fortran_source_derived_type_symbol
void set_fortran_source_derived_type_symbol(SgSymbol* fortran_source_derived_type_symbol);
set_result_name
void set_result_name(SgInitializedName* result_name);
set_subprogram_kind
void set_subprogram_kind(SgProcedureHeaderStatement::subprogram_kind_enum subprogram_kind);
variantT
virtual VariantT variantT() const override; [virtual]
returns new style SageIII enum values

Static Member Functions

Name Description
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 Data Members

Name
p_block_data_name_kind
p_end_numeric_label
p_fortran_binding_name
p_fortran_procedure_source_form
p_fortran_result_type_spec
p_fortran_source_derived_type_symbol
p_result_name
p_subprogram_kind

Friends

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

Created with MrDocs