Skip to content

SgForStatement

This class represents the concept of a for loop.

Synopsis

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

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

Description

Data members

SgForStatement::p_for_init_stmt

This pointer a SgForInitStatement (a list of pointers to statements (SgStatement objects) ).

  • Note: I think this is a poor name for this variable.

SgForStatement::p_test

The condition statement, which can be an expression statement or declaration.

SgForStatement::p_increment

The increment expression.

SgForStatement::p_loop_body

This pointer a SgStatement, and holds the statements in the body of the loop.

  • Note: I think this is a poor name for this variable (should be "body" to match other IR nodes).
  • Todo: Change "loop_body" to "body" to be consistant with other scopes that contain a SgStatement. Member functions

SgForStatement::copy(const SgCopyHelp & help)

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

  • Return: Returns pointer to copy of SgForStatement.

SgForStatement::get_for_init_stmt() const

Access function for p_for_init_stmt.

  • Return: Returns a pointer to a SgForInitStatement.

SgForStatement::set_for_init_stmt(SgForInitStatement* for_init_stmt)

Access function for p_for_init_stmt.

  • Param for_init_stmt: SgForInitStatement pointer
  • Return: Returns void.

SgForStatement::get_test_expr() const

Returns the expression held by an expression-statement test.

  • Return: Returns a pointer to a SgExpression.

SgForStatement::get_loop_body() const

Access function for p_loop_body.

  • Return: Returns a pointer to a SgStatement.

SgForStatement::set_loop_body(SgStatement* loop_body)

Access function for p_loop_body.

  • Param loop_body: SgStatement pointer
  • 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

Member Functions

Name Description
SgForStatement
SgForStatement( SgStatement* test, SgExpression* increment, SgStatement* loop_body); [constructor]
Constructors
~SgForStatement
virtual ~SgForStatement(); [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]
append_init_stmt
virtual void append_init_stmt(SgStatement* element); [virtual]
cfgFindChildIndex
virtual unsigned int cfgFindChildIndex(SgNode* n) override; [virtual]
cfgFindNextChildIndex
virtual unsigned int cfgFindNextChildIndex(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_construction_physical_output_owner
SgScopeStatement* get_construction_physical_output_owner() const;
get_for_init_stmt
SgForInitStatement* get_for_init_stmt() const;
get_increment
SgExpression* get_increment() const;
get_init_stmt
SgStatementPtrList& get_init_stmt();
get_loop_body
SgStatement* get_loop_body() 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_test
SgStatement* get_test() const;
get_test_expr
SgExpression* get_test_expr() 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]
prepend_init_stmt
virtual void prepend_init_stmt(SgStatement* element); [virtual]
processDataMemberReferenceToPointers
virtual void processDataMemberReferenceToPointers(ReferenceToPointerHandler*) override; [virtual]
Pass references to stored node pointers to a handler.
replace_expression
virtual int replace_expression( SgExpression* original_expression, SgExpression* new_expression) override; [virtual]
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_condition_value
void set_condition_value(SgExpression* condition_value);
set_construction_physical_output_owner
void set_construction_physical_output_owner(SgScopeStatement* construction_physical_output_owner);
set_for_init_stmt
void set_for_init_stmt(SgForInitStatement* for_init_stmt);
set_increment
void set_increment(SgExpression* increment);
set_loop_body
void set_loop_body(SgStatement* loop_body);
set_string_label
void set_string_label(std::string string_label);
set_test
void set_test(SgStatement* test);
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_construction_physical_output_owner
p_for_init_stmt
p_increment
p_loop_body
p_string_label
p_test

Friends

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

Created with MrDocs