OpenVDB
12.0.0
|
A Tree is the highest concrete (non-abstract) node in the entire AX AST hierarchy. It represents an entire conversion of a valid AX string. More...
#include <openvdb_ax/ast/AST.h>
Inherits Node.
Public Types | |
using | Ptr = std::shared_ptr< Tree > |
using | ConstPtr = std::shared_ptr< const Tree > |
using | UniquePtr = std::unique_ptr< Tree > |
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... | |
Public Member Functions | |
Tree (Block *block=new Block()) | |
Construct a new Tree from a given Block, transferring ownership of the Block to the tree and updating parent data on the Block. More... | |
Tree (const Tree &other) | |
Deep copy constructor for a Tree, performing a deep copy on the held Block, ensuring parent information is updated. More... | |
~Tree () override=default | |
Tree * | 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 Node * | 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 Block * | 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... | |
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... | |
virtual bool | replacechild (const size_t index, Node *node) |
Virtual method that attempted to replace a child at a given index with a provided node type. 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 Tree is the highest concrete (non-abstract) node in the entire AX AST hierarchy. It represents an entire conversion of a valid AX string.
|
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.
|
overridedefault |
|
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.
|
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. |
|
inlinevirtualinherited |
Virtual method that attempted to replace a child at a given index with a provided node type.
index | The child index where a replacement should be attempted |
node | The node to insert on a successful replacement. |
Reimplemented in DeclareLocal, ArrayPack, ArrayUnpack, FunctionCall, Cast, UnaryOperator, Crement, AssignExpression, TernaryOperator, BinaryOperator, ConditionalStatement, Loop, CommaOperator, Block, and StatementList.
|
inlineinherited |
Set this node's parent. This is used during construction of an AST and should not be used.
parent | The parent to set |
|
inlineoverridevirtual |
Virtual method for accessing node name information.
Implements Node.