A Block node represents a scoped list of statements. It may comprise of 0 or more statements, and specifically indicates that a new scope is activated, typically represented by curly braces. Note that a block does not alway have to be encapsulated by curly braces, but always represents a new scope.
More...
#include <AST.h>
Inherits Statement.
|
using | UniquePtr = std::unique_ptr< Block > |
|
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 > |
|
|
| Block () |
| Construct a new Block with an empty list. More...
|
|
| Block (Statement *statement) |
| Construct a new Block with a single statement, transferring ownership of the statement to the block and updating parent data on the statement. If the statement is a nullptr, it is ignored. More...
|
|
| Block (const std::vector< Statement * > &statements) |
| Construct a new Block from a vector of statements, transferring ownership of all valid statements to the block and updating parent data on the statement. Only valid (non null) statements are added to the block. More...
|
|
| Block (const Block &other) |
| Deep copy constructor for a Block, performing a deep copy on every held statement, ensuring parent information is updated. More...
|
|
| ~Block () override=default |
|
Block * | 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...
|
|
size_t | size () const |
| Alias for Block::children. More...
|
|
void | addStatement (Statement *stmnt) |
| Adds a statement to this block, transferring ownership to the block and updating parent data on the statement. If the statement is a nullptr, it is ignored. More...
|
|
A Block node represents a scoped list of statements. It may comprise of 0 or more statements, and specifically indicates that a new scope is activated, typically represented by curly braces. Note that a block does not alway have to be encapsulated by curly braces, but always represents a new scope.
- Note
- Statements held by the block are guaranteed to be valid (non null). nullptrs added to the block are implicitly dropped.
-
While closely linked, it's important to differentiate between this class and an llvm::BasicBlock.
◆ 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 | |
◆ Block() [1/4]
Construct a new Block with an empty list.
◆ Block() [2/4]
Construct a new Block with a single statement, transferring ownership of the statement to the block and updating parent data on the statement. If the statement is a nullptr, it is ignored.
- Parameters
-
statement | The statement to construct from |
◆ Block() [3/4]
Construct a new Block from a vector of statements, transferring ownership of all valid statements to the block and updating parent data on the statement. Only valid (non null) statements are added to the block.
- Parameters
-
statements | The vector of statements to construct from |
◆ Block() [4/4]
Deep copy constructor for a Block, performing a deep copy on every held statement, ensuring parent information is updated.
- Parameters
-
other | A const reference to another block to deep copy |
◆ ~Block()
◆ addStatement()
Adds a statement to this block, transferring ownership to the block and updating parent data on the statement. If the statement is a nullptr, it is ignored.
◆ 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.
◆ 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.
◆ copy()
|
inlinefinaloverridevirtual |
◆ 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
-
◆ size()
◆ subname()
const char* subname |
( |
| ) |
const |
|
inlineoverridevirtual |
Virtual method for accessing node name information.
Implements Node.
The documentation for this struct was generated from the following file: