Skip to content

SgIfStmt

This class represents the concept of an "if" construct.

Synopsis

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

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

Description

  • Internal:
  • Todo: The unparse function "unparseIfStmt" associated with this IR node is implemented using a loop. I think this should be changed to be more conventional and structural (consistant with the design of the rest of the unparsing).

Data members

SgIfStmt::p_conditional

This pointer a SgStatement.

SgIfStmt::p_true_body

This pointer a SgStatement, and holds the statements in the "true" body of if statement.

SgIfStmt::p_false_body

This pointer a SgStatement, and holds the statements in the "false" body of if statement.

Member functions

SgIfStmt::copy(const SgCopyHelp & help)

Makes a copy (deap of shallow depending on SgCopyHelp).

  • Return: Returns pointer to copy of SgIfStmt.

SgIfStmt::get_conditional() const

Access function for p_conditional.

  • Return: Returns a pointer to a SgStatement.

SgIfStmt::set_conditional(SgStatement* conditional)

Access function for p_conditional.

  • Param conditional: SgStatement pointer
  • Return: Returns void.

SgIfStmt::get_true_body() const

Access function for p_true_body.

  • Return: Returns a pointer to a SgStatement.

SgIfStmt::set_true_body(SgStatement* true_body)

Access function for p_true_body.

  • Param true_body: SgStatement pointer
  • Return: Returns void.

SgIfStmt::get_false_body() const

Access function for p_false_body.

  • Return: Returns a pointer to a SgStatement.

SgIfStmt::set_false_body(SgStatement* false_body)

Access function for p_false_body.

  • Param false_body: SgStatement pointer
  • Return: Returns void.

SgIfStmt::set_else_numeric_label(SgLabelRefExp* label)

Access function for p_else_numeric_label (Fortran only).

  • Param lable: used for end of if statement (Fortran only).
  • Return: Returns void.

SgIfStmt::get_else_numeric_label()

Access function for p_else_numeric_label (Fortran only).

  • Param lable: used for end of if statement (Fortran only).
  • Return: Returns SgLabelRefExp pointer.

SgIfStmt::set_end_numeric_label(SgLabelRefExp* label)

Access function for p_end_numeric_label (Fortran only).

  • Param lable: used for end of if statement (Fortran only).
  • Return: Returns void.

SgIfStmt::get_end_numeric_label()

Access function for p_end_numeric_label (Fortran only).

  • Param lable: used for end of if statement (Fortran only).
  • Return: Returns SgLabelRefExp pointer.

SgIfStmt::set_string_label(std::string label)

Access function for p_string_label (Fortran only; string required to addess generality of Fortran numeric and named labels).

  • Param label: used for Fortran only.
  • Return: Returns void.

SgIfStmt::get_string_label()

Access function for p_string_label (Fortran only; string required to addess generality of Fortran numeric and named labels).

  • Return: Returns std::string.

SgIfStmt::get_has_end_statement()

Fortran specific function to indicate if the Fortran "if" statement has an "end" construct (C/C++ useage always returns false).

  • Return: Returns bool.

SgIfStmt::set_has_end_statement(bool value)

Fortran specific function to indicate if the Fortran "if" statement has an "end" construct (C/C++ useage always returns false).

  • Param value: to use in setting associated (Fortran specific) data member.
  • Return: Returns void.

SgIfStmt::get_use_then_keyword()

Fortran specific function to indicate if the Fortran "if" statement uses the "then" construct (C/C++ useage always returns false).

  • Return: Returns bool.

SgIfStmt::set_use_then_keyword(bool value)

Fortran specific function to indicate if the Fortran "if" statement uses the "then" construct (C/C++ useage always returns false).

  • Param value: to use in setting associated (Fortran specific) data member.
  • Return: Returns void.

SgIfStmt::get_is_else_if_statement()

Fortran-specific function to indicate "else if" form of "if" construct (C/C++ useage always returns false).

  • Return: Returns bool.

SgIfStmt::set_is_else_if_statement(bool value)

Fortran-specific function to indicate "else if" form of "if" construct (C/C++ useage always returns false).

  • Param value: to use in setting associated (Fortran specific) data member.
  • Return: Returns void.

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
if_statement_kind_enum

Member Functions

Name Description
SgIfStmt
SgIfStmt( SgStatement* conditional, SgStatement* true_body, SgStatement* false_body); [constructor]
Constructors
~SgIfStmt
virtual ~SgIfStmt(); [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]
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
copy
virtual SgNode* copy(SgCopyHelp& help) const override; [virtual]
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_childIndex
virtual size_t get_childIndex(SgNode* child) const override; [virtual]
index-based access to traversal successors by child node
get_condition_value
SgExpression* get_condition_value() const;
get_conditional
SgStatement* get_conditional() const;
get_else_construct_name
std::string get_else_construct_name() const;
get_else_numeric_label
SgLabelRefExp* get_else_numeric_label() const;
get_end_numeric_label
virtual SgLabelRefExp* get_end_numeric_label() const override; [virtual]
get_false_body
SgStatement* get_false_body() const;
get_has_end_statement
bool get_has_end_statement() const;
get_if_constexpr_value
bool get_if_constexpr_value() const;
get_if_constexpr_value_known
bool get_if_constexpr_value_known() const;
get_if_statement_kind
SgIfStmt::if_statement_kind_enum get_if_statement_kind() const;
get_is_else_if_statement
bool get_is_else_if_statement() const;
get_is_if_consteval_statement
bool get_is_if_consteval_statement() const;
get_is_if_constexpr_statement
bool get_is_if_constexpr_statement() 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_string_label
std::string get_string_label() 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
get_true_body
SgStatement* get_true_body() const;
get_use_then_keyword
bool get_use_then_keyword() 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
runtime_branch_is_known
bool runtime_branch_is_known() const;
runtime_branch_is_true
bool runtime_branch_is_true() const;
sage_class_name
virtual char const* sage_class_name() const override; [virtual]
returns a C style string (char*) representing the class name
set_condition_value
void set_condition_value(SgExpression* condition_value);
set_conditional
void set_conditional(SgStatement* conditional);
set_else_construct_name
void set_else_construct_name(std::string else_construct_name);
set_else_numeric_label
void set_else_numeric_label(SgLabelRefExp* else_numeric_label);
set_end_numeric_label
virtual void set_end_numeric_label(SgLabelRefExp* end_numeric_label) override; [virtual]
set_false_body
void set_false_body(SgStatement* false_body);
set_has_end_statement
void set_has_end_statement(bool has_end_statement);
set_if_constexpr_value
void set_if_constexpr_value(bool if_constexpr_value);
set_if_constexpr_value_known
void set_if_constexpr_value_known(bool if_constexpr_value_known);
set_if_statement_kind
void set_if_statement_kind(SgIfStmt::if_statement_kind_enum if_statement_kind);
set_is_else_if_statement
void set_is_else_if_statement(bool is_else_if_statement);
set_string_label
void set_string_label(std::string string_label);
set_true_body
void set_true_body(SgStatement* true_body);
set_use_then_keyword
void set_use_then_keyword(bool use_then_keyword);
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 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_condition_value
p_conditional
p_else_construct_name
p_else_numeric_label
p_end_numeric_label
p_false_body
p_has_end_statement
p_if_constexpr_value
p_if_constexpr_value_known
p_if_statement_kind
p_is_else_if_statement
p_string_label
p_true_body
p_use_then_keyword

Friends

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

Created with MrDocs