OpenVDB
12.0.0
|
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 <openvdb_ax/ast/AST.h>
Inherits Statement.
Public Types | |
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 > |
Public Member Functions | |
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... | |
Name/Type | |
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... | |
Child Queries | |
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... | |
Replacement | |
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... | |
Parent | |
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... | |
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.
|
inherited |
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.
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.
statement | The statement to construct from |
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.
statements | The vector of statements to construct from |
Deep copy constructor for a Block, performing a deep copy on every held statement, ensuring parent information is updated.
other | A const reference to another block to deep copy |
|
overridedefault |
|
inline |
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.
|
inlineoverridevirtual |
|
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.
|
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)
|
inlinefinaloverridevirtual |
Virtual method for accessing child information. Returns the number of children a given AST node owns.
Implements Node.
|
inlinefinaloverridevirtual |
|
inlineinherited |
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()
NodeT | The node type to query against. |
|
inlineoverridevirtual |
Virtual method for accessing node name information.
Implements Node.
|
inlineoverridevirtual |
Virtual method for accessing node type information.
Implements Node.
|
inlineinherited |
Access a const pointer to this nodes parent.
|
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.
node | The node to insert on a successful replacement. |
|
inlinefinaloverridevirtual |
Virtual method that attempted to replace a child at a given index with a provided node type.
Reimplemented from Node.
|
inlineinherited |
Set this node's parent. This is used during construction of an AST and should not be used.
parent | The parent to set |
|
inline |
Alias for Block::children.
|
inlineoverridevirtual |
Virtual method for accessing node name information.
Implements Node.