Skip to content

SgPragmaDeclaration

A pragma declaration containing an SgPragma node.

Synopsis

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

class [[visibility("default")]] SgPragmaDeclaration
    : public SgDeclarationStatement

Description

  • See also: Example of using a SgPragmaDeclaration object

Base Classes

Name Description
SgDeclarationStatement This class represents the concept of a declaration statement.

Types

Name
fortran_selected_token

Type Aliases

Name
base_node_type
fortran_selected_tokens

Enums

Name Description
Unnamed enum static variant value
cxx_pragma_payload_kind_enum
fortran_directive_family_enum

Member Functions

Name Description
SgPragmaDeclaration
SgPragmaDeclaration( SgPragma* pragma, SgPragmaDeclaration::fortran_directive_family_enum fortran_directive_family); [constructor]
Constructors
~SgPragmaDeclaration
virtual ~SgPragmaDeclaration(); [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]
cfgInEdges
virtual std::vector<VirtualCFG::CFGEdge> cfgInEdges(unsigned int index) override; [virtual]
cfgIndexForEnd
virtual unsigned int cfgIndexForEnd() 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
copy
virtual SgNode* copy(SgCopyHelp& help) const override; [virtual]
get_childIndex
virtual size_t get_childIndex(SgNode* child) const override; [virtual]
index-based access to traversal successors by child node
get_cxx_pragma_payload_kind
SgPragmaDeclaration::cxx_pragma_payload_kind_enum get_cxx_pragma_payload_kind() const;
get_cxx_source_text
std::string get_cxx_source_text() const;
get_cxx_top_level_macro_expansion
bool get_cxx_top_level_macro_expansion() const;
get_fortran_compiler_directive_sentinel
std::string get_fortran_compiler_directive_sentinel() const;
get_fortran_directive_family
SgPragmaDeclaration::fortran_directive_family_enum get_fortran_directive_family() const;
get_fortran_directive_group_id
std::string get_fortran_directive_group_id() const;
get_fortran_directive_logical_text
std::string get_fortran_directive_logical_text() const;
get_fortran_directive_member_count
unsigned long get_fortran_directive_member_count() const;
get_fortran_directive_member_index
unsigned long get_fortran_directive_member_index() const;
get_fortran_directive_primary
bool get_fortran_directive_primary() const;
get_fortran_directive_raw_text
std::string get_fortran_directive_raw_text() const;
get_fortran_directive_semantic_text
std::string get_fortran_directive_semantic_text() const;
get_fortran_selected_output_text
std::optional<std::string> get_fortran_selected_output_text() const;
get_fortran_selected_output_tokens
SgPragmaDeclaration::fortran_selected_tokens get_fortran_selected_output_tokens() 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_pragma
SgPragma* get_pragma() 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
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_cxx_pragma_payload_kind
void set_cxx_pragma_payload_kind(SgPragmaDeclaration::cxx_pragma_payload_kind_enum cxx_pragma_payload_kind);
set_cxx_source_text
void set_cxx_source_text(std::string cxx_source_text);
set_cxx_top_level_macro_expansion
void set_cxx_top_level_macro_expansion(bool cxx_top_level_macro_expansion);
set_fortran_compiler_directive_sentinel
void set_fortran_compiler_directive_sentinel(std::string fortran_compiler_directive_sentinel);
set_fortran_directive_family
void set_fortran_directive_family(SgPragmaDeclaration::fortran_directive_family_enum fortran_directive_family);
set_fortran_directive_group_id
void set_fortran_directive_group_id(std::string fortran_directive_group_id);
set_fortran_directive_logical_text
void set_fortran_directive_logical_text(std::string fortran_directive_logical_text);
set_fortran_directive_member_count
void set_fortran_directive_member_count(unsigned long fortran_directive_member_count);
set_fortran_directive_member_index
void set_fortran_directive_member_index(unsigned long fortran_directive_member_index);
set_fortran_directive_primary
void set_fortran_directive_primary(bool fortran_directive_primary);
set_fortran_directive_raw_text
void set_fortran_directive_raw_text(std::string fortran_directive_raw_text);
set_fortran_directive_semantic_text
void set_fortran_directive_semantic_text(std::string fortran_directive_semantic_text);
set_fortran_selected_output_text
void set_fortran_selected_output_text(std::optional<std::string> fortran_selected_output_text);
set_fortran_selected_output_tokens
void set_fortran_selected_output_tokens(SgPragmaDeclaration::fortran_selected_tokens fortran_selected_output_tokens);
set_pragma
void set_pragma(SgPragma* pragma);
variantT
virtual VariantT variantT() const override; [virtual]
returns new style SageIII enum values

Static Member Functions

Name Description
fortran_selected_output_is_valid
static bool fortran_selected_output_is_valid( std::optional<std::string> const& text, fortran_selected_tokens const& tokens);
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_cxx_pragma_payload_kind
p_cxx_source_text
p_cxx_top_level_macro_expansion
p_fortran_compiler_directive_sentinel
p_fortran_directive_family
p_fortran_directive_group_id
p_fortran_directive_logical_text
p_fortran_directive_member_count
p_fortran_directive_member_index
p_fortran_directive_primary
p_fortran_directive_raw_text
p_fortran_directive_semantic_text
p_fortran_selected_output_text
p_fortran_selected_output_tokens
p_pragma

Friends

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

Created with MrDocs