OpenVDB
12.0.0
|
AssignExpressions represents a similar object construction to a BinaryOperator. AssignExpressions can be chained together and are thus derived as Expressions rather than Statements. More...
#include <openvdb_ax/ast/AST.h>
Inherits Expression.
Public Types | |
using | UniquePtr = std::unique_ptr< AssignExpression > |
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 | |
AssignExpression (Expression *lhs, Expression *rhs, const tokens::OperatorToken op=tokens::EQUALS) | |
Construct a new AssignExpression with valid LHS and RHS expressions, transferring ownership of the expressions to the AssignExpression and updating parent data on the expressions. More... | |
AssignExpression (const AssignExpression &other) | |
Deep copy constructor for an AssignExpression, performing a deep copy on both held expressions, ensuring parent information is updated. More... | |
~AssignExpression () override=default | |
AssignExpression * | 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 Expression * | 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 Expression * | 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... | |
bool | isCompound () const |
Query whether or not this is a compound AssignExpression. Compound AssignExpressions are assignments which read and write to the LHS value. i.e. +=, -=, *= etc. More... | |
tokens::OperatorToken | operation () const |
Query the actual operational type of this AssignExpression. For simple (non-compound) AssignExpressions, tokens::EQUALS is returned. More... | |
const Expression * | lhs () const |
Access a const pointer to the AssignExpression LHS as an abstract expression. More... | |
const Expression * | rhs () const |
Access a const pointer to the AssignExpression RHS as an. 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... | |
AssignExpressions represents a similar object construction to a BinaryOperator. AssignExpressions can be chained together and are thus derived as Expressions rather than Statements.
using UniquePtr = std::unique_ptr<AssignExpression> |
|
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.
|
inline |
Construct a new AssignExpression with valid LHS and RHS expressions, transferring ownership of the expressions to the AssignExpression and updating parent data on the expressions.
lhs | The left hand side of the assign expression |
rhs | The right hand side of the assign expression |
op | The compound assignment token, if any |
|
inline |
Deep copy constructor for an AssignExpression, performing a deep copy on both held expressions, ensuring parent information is updated.
other | A const reference to another AssignExpression to deep copy |
|
overridedefault |
|
inlineoverridevirtual |
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 Expression.
|
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 |
The deep copy method for a Node.
Implements Expression.
|
inline |
Query whether or not this is a compound AssignExpression. Compound AssignExpressions are assignments which read and write to the LHS value. i.e. +=, -=, *= etc.
|
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. |
|
inline |
Access a const pointer to the AssignExpression LHS as an abstract expression.
|
inlineoverridevirtual |
Virtual method for accessing node name information.
Implements Node.
|
inlineoverridevirtual |
Virtual method for accessing node type information.
Implements Node.
|
inline |
Query the actual operational type of this AssignExpression. For simple (non-compound) AssignExpressions, tokens::EQUALS is returned.
|
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.
|
inline |
Access a const pointer to the AssignExpression RHS as an.
abstract expression
|
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.