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 |
|---|---|
SgIfStmtSgIfStmt( SgStatement* conditional, SgStatement* true_body, SgStatement* false_body); [constructor] | Constructors |
~SgIfStmtvirtual ~SgIfStmt(); [destructor] [virtual] | Destructor |
acceptvirtual void accept(ROSE_VisitorPattern& visitor) override; [virtual] | support for the classic visitor pattern done in GoF |
appendDestructorOwnedNodesvirtual void appendDestructorOwnedNodes(std::vector<SgNode*>& nodes) const override; [virtual] | |
cfgFindChildIndexvirtual unsigned int cfgFindChildIndex(SgNode* n) override; [virtual] | |
cfgInEdgesvirtual std::vector<VirtualCFG::CFGEdge> cfgInEdges(unsigned int index) override; [virtual] | |
cfgIndexForEndvirtual unsigned int cfgIndexForEnd() const override; [virtual] | |
cfgIsIndexInterestingvirtual bool cfgIsIndexInteresting(unsigned int) const override; [virtual] | |
cfgOutEdgesvirtual std::vector<VirtualCFG::CFGEdge> cfgOutEdges(unsigned int index) override; [virtual] | |
class_namevirtual std::string class_name() const override; [virtual] | returns a string representing the class name |
copyvirtual SgNode* copy(SgCopyHelp& help) const override; [virtual] | |
fixupCopy_referencesvirtual void fixupCopy_references( SgNode* copy, SgCopyHelp& help) const override; [virtual] | |
fixupCopy_scopesvirtual void fixupCopy_scopes( SgNode* copy, SgCopyHelp& help) const override; [virtual] | |
fixupCopy_symbolsvirtual void fixupCopy_symbols( SgNode* copy, SgCopyHelp& help) const override; [virtual] | |
get_childIndexvirtual size_t get_childIndex(SgNode* child) const override; [virtual] | index-based access to traversal successors by child node |
get_condition_valueSgExpression* get_condition_value() const; | |
get_conditionalSgStatement* get_conditional() const; | |
get_else_construct_namestd::string get_else_construct_name() const; | |
get_else_numeric_labelSgLabelRefExp* get_else_numeric_label() const; | |
get_end_numeric_labelvirtual SgLabelRefExp* get_end_numeric_label() const override; [virtual] | |
get_false_bodySgStatement* get_false_body() const; | |
get_has_end_statementbool get_has_end_statement() const; | |
get_if_constexpr_valuebool get_if_constexpr_value() const; | |
get_if_constexpr_value_knownbool get_if_constexpr_value_known() const; | |
get_if_statement_kindSgIfStmt::if_statement_kind_enum get_if_statement_kind() const; | |
get_is_else_if_statementbool get_is_else_if_statement() const; | |
get_is_if_consteval_statementbool get_is_if_consteval_statement() const; | |
get_is_if_constexpr_statementbool get_is_if_constexpr_statement() const; | |
get_mangled_namevirtual SgName get_mangled_name() const override; [virtual] | |
get_numberOfTraversalSuccessorsvirtual size_t get_numberOfTraversalSuccessors() const override; [virtual] | return number of children in the traversal successor list |
get_string_labelstd::string get_string_label() const; | |
get_traversalSuccessorByIndexvirtual SgNode* get_traversalSuccessorByIndex(size_t idx) const override; [virtual] | index-based access to traversal successors by index number |
get_traversalSuccessorContainervirtual 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_traversalSuccessorIsListElementvirtual std::vector<bool> get_traversalSuccessorIsListElement() const override; [virtual] | |
get_traversalSuccessorNamesContainervirtual 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_bodySgStatement* get_true_body() const; | |
get_use_then_keywordbool get_use_then_keyword() const; | |
operator deletevoid operator delete( void* pointer, size_t size); | deallocated memory for IR node (returns memory to memory pool for reuse) |
operator newvoid* operator new(size_t size); | returns pointer to newly allocated IR node |
post_construction_initializationvirtual void post_construction_initialization() override; [virtual] | |
processDataMemberReferenceToPointersvirtual void processDataMemberReferenceToPointers(ReferenceToPointerHandler*) override; [virtual] | Pass references to stored node pointers to a handler. |
returnDataMemberPointersvirtual std::vector<std::pair<SgNode*, std::string>> returnDataMemberPointers() const override; [virtual] | Return the node pointers stored in this node's data members. |
roseRTIvirtual RTIReturnType roseRTI() override; [virtual] | return C++ Runtime-Time-Information |
runtime_branch_is_knownbool runtime_branch_is_known() const; | |
runtime_branch_is_truebool runtime_branch_is_true() const; | |
sage_class_namevirtual char const* sage_class_name() const override; [virtual] | returns a C style string (char*) representing the class name |
set_condition_valuevoid set_condition_value(SgExpression* condition_value); | |
set_conditionalvoid set_conditional(SgStatement* conditional); | |
set_else_construct_namevoid set_else_construct_name(std::string else_construct_name); | |
set_else_numeric_labelvoid set_else_numeric_label(SgLabelRefExp* else_numeric_label); | |
set_end_numeric_labelvirtual void set_end_numeric_label(SgLabelRefExp* end_numeric_label) override; [virtual] | |
set_false_bodyvoid set_false_body(SgStatement* false_body); | |
set_has_end_statementvoid set_has_end_statement(bool has_end_statement); | |
set_if_constexpr_valuevoid set_if_constexpr_value(bool if_constexpr_value); | |
set_if_constexpr_value_knownvoid set_if_constexpr_value_known(bool if_constexpr_value_known); | |
set_if_statement_kindvoid set_if_statement_kind(SgIfStmt::if_statement_kind_enum if_statement_kind); | |
set_is_else_if_statementvoid set_is_else_if_statement(bool is_else_if_statement); | |
set_string_labelvoid set_string_label(std::string string_label); | |
set_true_bodyvoid set_true_body(SgStatement* true_body); | |
set_use_then_keywordvoid set_use_then_keyword(bool use_then_keyword); | |
variantTvirtual VariantT variantT() const override; [virtual] | returns new style SageIII enum values |
Static Member Functions¶
| Name | Description |
|---|---|
memoryUsagestatic size_t memoryUsage(); | Returns the size in bytes of the total memory allocated for all IR nodes of this type |
numberOfNodesstatic size_t numberOfNodes(); | Returns the total number of IR nodes of this type |
traverseMemoryPoolNodesstatic void traverseMemoryPoolNodes(ROSE_VisitTraversal& visit); | FOR INTERNAL USE Support for visitor pattern over all IR nodes by type of IR node. |
traverseMemoryPoolVisitorPatternstatic void traverseMemoryPoolVisitorPattern(ROSE_VisitorPattern& visitor); | FOR INTERNAL USE Support for visitor pattern. |
visitRepresentativeNodestatic 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_childvirtual bool insert_child( SgStatement*, SgStatement*, bool inFront = true, bool extractListFromBasicBlock = false) override; [virtual] |
replace_childvirtual bool replace_child( SgStatement*, SgStatement*, bool extractListFromBasicBlock = false) override; [virtual] |
Protected Data Members¶
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