Loops represent for, while and do-while loop constructs. These all consist of a condition - evaluated to determine if loop iteration should continue, and a body which is the logic to be repeated. For loops also have initial statements which are evaluated prior to loop execution (at loop scope) and commonly used to set up iterators, and iteration expressions which are evaluated between iterations after the body and before the condition. Both conditions and initial statements can be declarations or expressions, so are Statements, and iteration expressions can consist of multiple expressions. The loop body is a Block defining its own scope (encapsulated by initial statement scope for for-loops).
More...
|
| Loop (const tokens::LoopToken loopType, Statement *condition, Block *body, Statement *init=nullptr, Expression *iter=nullptr) |
| Construct a new Loop with the type defined by a tokens::LoopToken, a condition Statement, a Block representing the body and for for-loops an optional initial Statement and iteration Expression. Ownership of all arguments is transferred to the Loop. All arguments have their parent data updated. More...
|
|
| Loop (const Loop &other) |
| Deep copy constructor for an Loop, performing a deep copy on the condition, body and initial Statement/iteration Expression if they exist, ensuring parent information is updated. More...
|
|
| ~Loop () override=default |
|
Loop * | copy () const override final |
| The deep copy method for a Node. More...
|
|
NodeType | nodetype () const override |
| Virtual method for accessing node type information. More...
|
|
const char * | nodename () const override |
| Virtual method for accessing node name information. More...
|
|
const char * | subname () const override |
| Virtual method for accessing node name information. More...
|
|
const Statement * | basetype () const override |
| Virtual method for accessing a node's base class. Note that if this is called explicitly on an instance of ast::Node (the top most base class) a nullptr is returned. This is primarily used by the Visitor to support hierarchical visits. More...
|
|
size_t | children () const override final |
| Virtual method for accessing child information. Returns the number of children a given AST node owns. More...
|
|
const Statement * | child (const size_t i) const override final |
| Virtual method for accessing child information. Returns a const pointer to a child node at the given index. If the index is out of range, a nullptr is returned. More...
|
|
bool | replacechild (const size_t i, Node *node) override final |
| Virtual method that attempted to replace a child at a given index with a provided node type. More...
|
|
tokens::LoopToken | loopType () const |
| Query the type of loop held on this node. More...
|
|
bool | hasInit () const |
| Query if this Loop has a valid initial statement. More...
|
|
bool | hasIter () const |
| Query if this Loop has a valid iteration expression list. More...
|
|
const Statement * | condition () const |
| Access a const pointer to the Loop condition as an abstract statement. More...
|
|
const Block * | body () const |
| Access a const pointer to the Loop body as a Block. More...
|
|
const Statement * | initial () const |
| Access a const pointer to the Loop initial statement as an abstract statement. More...
|
|
const Expression * | iteration () const |
| Access a const pointer to the Loop iteration Expression. More...
|
|
|
template<typename NodeT > |
bool | isType () const |
| Query whether or not this node is of a specific (derived) type. This method should be used to check if a node is of a particular abstract type. When checking concrete types, it's generally more efficient to check the return value of Node::nodetype() More...
|
|
|
int64_t | childidx () const |
| Returns the child index of this node in relation to its parent, or -1 if no valid index is found (usually representing the top most node (i.e. Tree) More...
|
|
|
bool | replace (Node *node) |
| In place replacement. Attempts to replace this node at its specific location within its Abstract Syntax Tree. On a successful replacement, this node is destroyed, the provided node is inserted in its place and ownership is transferred to the parent node. No further calls to this node can be made on successful replacements. More...
|
|
|
const Node * | parent () const |
| Access a const pointer to this nodes parent. More...
|
|
void | setParent (Node *parent) |
| Set this node's parent. This is used during construction of an AST and should not be used. More...
|
|
Loops represent for, while and do-while loop constructs. These all consist of a condition - evaluated to determine if loop iteration should continue, and a body which is the logic to be repeated. For loops also have initial statements which are evaluated prior to loop execution (at loop scope) and commonly used to set up iterators, and iteration expressions which are evaluated between iterations after the body and before the condition. Both conditions and initial statements can be declarations or expressions, so are Statements, and iteration expressions can consist of multiple expressions. The loop body is a Block defining its own scope (encapsulated by initial statement scope for for-loops).
- Note
- Only for-loops should have initial statements and/or iteration expressions. Also for-loops allow empty conditions to be given by the user, this is replaced with a 'true' expression in the parser.