OpenVDB
12.0.0
|
The base abstract node which determines the interface and required methods for all derived concrete nodes which comprise a valid AST. More...
#include <openvdb_ax/ast/AST.h>
Inherited by Statement, and Tree.
Public Types | |
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 > |
using | UniquePtr = std::unique_ptr< Node > |
Public Member Functions | |
Node ()=default | |
virtual | ~Node ()=default |
virtual Node * | copy () const =0 |
The deep copy method for a Node. More... | |
Name/Type | |
virtual NodeType | nodetype () const =0 |
Virtual method for accessing node type information. More... | |
virtual const char * | nodename () const =0 |
Virtual method for accessing node name information. More... | |
virtual const char * | subname () const =0 |
Virtual method for accessing node name information. More... | |
virtual const Node * | basetype () const |
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... | |
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 | |
virtual size_t | children () const =0 |
Virtual method for accessing child information. Returns the number of children a given AST node owns. More... | |
virtual const Node * | child (const size_t index) const =0 |
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... | |
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... | |
The base abstract node which determines the interface and required methods for all derived concrete nodes which comprise a valid AST.
A reference list of all abstract and concrete AST nodes in hierarchical order (non-linear) Abstract nodes:
Concrete nodes:
enum 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.
|
default |
|
virtualdefault |
|
inlinevirtual |
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 in Value< std::string >, Value< T >, DeclareLocal, Local, ExternalVariable, Attribute, ArrayPack, ArrayUnpack, Keyword, FunctionCall, Cast, UnaryOperator, Crement, AssignExpression, TernaryOperator, BinaryOperator, ConditionalStatement, Loop, CommaOperator, Tree, Block, StatementList, ValueBase, Variable, Expression, and Statement.
|
pure virtual |
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.
index | The child index to query |
Implemented in DeclareLocal, ArrayPack, ArrayUnpack, Keyword, FunctionCall, Cast, UnaryOperator, Crement, AssignExpression, TernaryOperator, BinaryOperator, ConditionalStatement, Loop, CommaOperator, Tree, Block, StatementList, ValueBase, and Variable.
|
inline |
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)
|
pure virtual |
Virtual method for accessing child information. Returns the number of children a given AST node owns.
Implemented in DeclareLocal, ArrayPack, ArrayUnpack, Keyword, FunctionCall, Cast, UnaryOperator, Crement, AssignExpression, TernaryOperator, BinaryOperator, ConditionalStatement, Loop, CommaOperator, Tree, Block, StatementList, ValueBase, and Variable.
|
pure virtual |
The deep copy method for a Node.
Implemented in Value< std::string >, Value< T >, DeclareLocal, Local, ExternalVariable, Attribute, ArrayPack, ArrayUnpack, Keyword, FunctionCall, Cast, UnaryOperator, Crement, AssignExpression, TernaryOperator, BinaryOperator, ConditionalStatement, Loop, CommaOperator, Tree, Block, StatementList, ValueBase, Variable, Expression, and Statement.
|
inline |
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. |
|
pure virtual |
Virtual method for accessing node name information.
Implemented in Value< std::string >, Value< T >, DeclareLocal, Local, ExternalVariable, Attribute, ArrayPack, ArrayUnpack, Keyword, FunctionCall, Cast, UnaryOperator, Crement, AssignExpression, TernaryOperator, BinaryOperator, ConditionalStatement, Loop, CommaOperator, Tree, Block, and StatementList.
|
pure virtual |
Virtual method for accessing node type information.
Implemented in Value< std::string >, Value< T >, DeclareLocal, Local, ExternalVariable, Attribute, ArrayPack, ArrayUnpack, Keyword, FunctionCall, Cast, UnaryOperator, Crement, AssignExpression, TernaryOperator, BinaryOperator, ConditionalStatement, Loop, CommaOperator, Tree, Block, and StatementList.
|
inline |
Access a const pointer to this nodes parent.
|
inline |
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. |
|
inlinevirtual |
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.
|
inline |
Set this node's parent. This is used during construction of an AST and should not be used.
parent | The parent to set |
|
pure virtual |
Virtual method for accessing node name information.
Implemented in Value< std::string >, Value< T >, DeclareLocal, Local, ExternalVariable, Attribute, ArrayPack, ArrayUnpack, Keyword, FunctionCall, Cast, UnaryOperator, Crement, AssignExpression, TernaryOperator, BinaryOperator, ConditionalStatement, Loop, CommaOperator, Tree, Block, and StatementList.