ConditionalStatements represents all combinations of 'if', 'else' and 'else if' syntax and semantics. A single ConditionalStatement only ever represents up to two branches; an 'if' (true) and an optional 'else' (false). ConditionalStatements are nested within the second 'else' branch to support 'else if' logic. As well as both 'if' and 'else' branches, a ConditionalStatement also holds an Expression related to its primary condition.
More...
#include <AST.h>
Inherits Statement.
|
using | UniquePtr = std::unique_ptr< ConditionalStatement > |
|
enum | NodeType {
TreeNode,
StatementListNode,
BlockNode,
ConditionalStatementNode,
CommaOperatorNode,
LoopNode,
KeywordNode,
AssignExpressionNode,
CrementNode,
UnaryOperatorNode,
BinaryOperatorNode,
TernaryOperatorNode,
CastNode,
AttributeNode,
FunctionCallNode,
ExternalVariableNode,
DeclareLocalNode,
ArrayPackNode,
ArrayUnpackNode,
LocalNode,
ValueBoolNode,
ValueInt16Node,
ValueInt32Node,
ValueInt64Node,
ValueFloatNode,
ValueDoubleNode,
ValueStrNode
} |
| An enumerated list of node types for all concrete node types. These can be used for faster evaluation of a given concrete node using the virtual function table via Node::nodetype() rather than performing a dynamic_cast/calling Node::isType. More...
|
|
using | Ptr = std::shared_ptr< Node > |
|
ConditionalStatements represents all combinations of 'if', 'else' and 'else if' syntax and semantics. A single ConditionalStatement only ever represents up to two branches; an 'if' (true) and an optional 'else' (false). ConditionalStatements are nested within the second 'else' branch to support 'else if' logic. As well as both 'if' and 'else' branches, a ConditionalStatement also holds an Expression related to its primary condition.
- Note
- The first 'if' branch is referred to as the 'true' branch. The second 'else' branch is referred to as the 'false' branch.
◆ Ptr
◆ UniquePtr
◆ NodeType
An enumerated list of node types for all concrete node types. These can be used for faster evaluation of a given concrete node using the virtual function table via Node::nodetype() rather than performing a dynamic_cast/calling Node::isType.
- Note
- This is sometimes referred to as "manual RTTI". We use this technique combine with single dispatch due to opting for CRTP on the main visitor and no templated virtual method support in C++. i.e. no way to double dispatch: visit<template T>(Visitor<T>*)
-
Abstract (pure-virtual) nodes are not listed here. Node::isType should be used to determine if a node is of a given abstract type.
Enumerator |
---|
TreeNode | |
StatementListNode | |
BlockNode | |
ConditionalStatementNode | |
CommaOperatorNode | |
LoopNode | |
KeywordNode | |
AssignExpressionNode | |
CrementNode | |
UnaryOperatorNode | |
BinaryOperatorNode | |
TernaryOperatorNode | |
CastNode | |
AttributeNode | |
FunctionCallNode | |
ExternalVariableNode | |
DeclareLocalNode | |
ArrayPackNode | |
ArrayUnpackNode | |
LocalNode | |
ValueBoolNode | |
ValueInt16Node | |
ValueInt32Node | |
ValueInt64Node | |
ValueFloatNode | |
ValueDoubleNode | |
ValueStrNode | |
◆ ConditionalStatement() [1/2]
Construct a new ConditionalStatement with an Expression representing the primary condition, a Block representing the 'true' branch and an optional Block representing the 'false' branch. Ownership of all arguments is transferred to the ConditionalStatement. All arguments have their parent data updated.
- Parameters
-
conditional | The Expression to construct the condition from |
trueBlock | The Block to construct the true branch from |
falseBlock | The (optional) Block to construct the false branch from |
◆ ConditionalStatement() [2/2]
Deep copy constructor for an ConditionalStatement, performing a deep copy on the condition and both held branches (Blocks), ensuring parent information is updated.
- Parameters
-
◆ ~ConditionalStatement()
◆ basetype()
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.
Reimplemented from Statement.
◆ branchCount()
size_t branchCount |
( |
| ) |
const |
|
inline |
Query the number of branches held by this ConditionalStatement. This is only ever 1 or 2.
- Returns
- 2 if a valid 'true' and 'false' branch exist, 1 otherwise
◆ child()
const Statement* child |
( |
const size_t |
i | ) |
const |
|
inlinefinaloverridevirtual |
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.
Implements Node.
◆ childidx()
int64_t childidx |
( |
| ) |
const |
|
inlineinherited |
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)
- Returns
- The child index of this node
◆ children()
size_t children |
( |
| ) |
const |
|
inlinefinaloverridevirtual |
Virtual method for accessing child information. Returns the number of children a given AST node owns.
Implements Node.
◆ condition()
Access a const pointer to the ConditionalStatements condition as an abstract expression.
- Returns
- A const pointer to the condition as an expression
◆ copy()
|
inlinefinaloverridevirtual |
◆ falseBranch()
const Block* falseBranch |
( |
| ) |
const |
|
inline |
Access a const pointer to the ConditionalStatements 'false' branch as a Block.
- Returns
- A const pointer to the 'false' branch
◆ hasFalse()
Query if this ConditionalStatement has a valid 'false' branch.
- Returns
- True if a valid 'false' branch exists, false otherwise
◆ isType()
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()
- Template Parameters
-
NodeT | The node type to query against. |
- Returns
- True if this node is of the given type, false otherwise.
◆ nodename()
const char* nodename |
( |
| ) |
const |
|
inlineoverridevirtual |
Virtual method for accessing node name information.
Implements Node.
◆ nodetype()
Virtual method for accessing node type information.
Implements Node.
◆ parent()
const Node* parent |
( |
| ) |
const |
|
inlineinherited |
Access a const pointer to this nodes parent.
- Note
- Can be a nullptr if this is the top most node in an AST (usually a Tree)
- Returns
- A const pointer to this node's parent node
◆ replace()
bool replace |
( |
Node * |
node | ) |
|
|
inlineinherited |
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.
- Note
- A replacement will fail if this node is the top most node within an AST hierarchy or if the provided node type is not a compatible type for the required abstract storage. For example, if this node is an Attribute being held on a BinaryOperator, only concrete nodes derived from an Expression can be used as a replacement.
-
This method will dynamic_cast the provided node to check to see if it's a compatible type.
- Parameters
-
node | The node to insert on a successful replacement. |
- Returns
- True if the replacement was successful, resulting in destruction of this class and ownership transferal of the provided node. False otherwise, where this and the provided node are unchanged.
◆ replacechild()
bool replacechild |
( |
const size_t |
i, |
|
|
Node * |
node |
|
) |
| |
|
inlinefinaloverridevirtual |
Virtual method that attempted to replace a child at a given index with a provided node type.
Reimplemented from Node.
◆ setParent()
void setParent |
( |
Node * |
parent | ) |
|
|
inlineinherited |
Set this node's parent. This is used during construction of an AST and should not be used.
- Parameters
-
◆ subname()
const char* subname |
( |
| ) |
const |
|
inlineoverridevirtual |
Virtual method for accessing node name information.
Implements Node.
◆ trueBranch()
const Block* trueBranch |
( |
| ) |
const |
|
inline |
Access a const pointer to the ConditionalStatements 'true' branch as a Block.
- Returns
- A const pointer to the 'true' branch
The documentation for this struct was generated from the following file: