OpenVDB
12.0.0
|
FunctionCalls represent a single call to a function and any provided arguments. The argument list can be empty. The function name is expected to exist in the AX function registry. More...
#include <openvdb_ax/ast/AST.h>
Inherits Expression.
Public Types | |
using | UniquePtr = std::unique_ptr< FunctionCall > |
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 | |
FunctionCall (const std::string &function, Expression *argument=nullptr) | |
Construct a new FunctionCall with a given function identifier and an optional argument, transferring ownership of any provided argument to the FunctionCall and updating parent data on the arguments. More... | |
FunctionCall (const std::string &function, const std::vector< Expression * > &arguments) | |
Construct a new FunctionCall with a given function identifier and optional argument list, transferring ownership of any provided arguments to the FunctionCall and updating parent data on the arguments. More... | |
FunctionCall (const FunctionCall &other) | |
Deep copy constructor for a FunctionCall, performing a deep copy on all held function arguments, ensuring parent information is updated. More... | |
~FunctionCall () override=default | |
FunctionCall * | 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... | |
const std::string & | name () const |
Access the function name/identifier. More... | |
size_t | numArgs () const |
Query the total number of arguments stored on this function. More... | |
size_t | size () const |
Alias for FunctionCall::children. More... | |
bool | empty () const |
Query whether this Expression list holds any valid expressions. More... | |
void | append (Expression *expr) |
Appends an argument to this function call, transferring ownership to the FunctionCall and updating parent data on the expression. If the expression 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... | |
FunctionCalls represent a single call to a function and any provided arguments. The argument list can be empty. The function name is expected to exist in the AX function registry.
using UniquePtr = std::unique_ptr<FunctionCall> |
|
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 FunctionCall with a given function identifier and an optional argument, transferring ownership of any provided argument to the FunctionCall and updating parent data on the arguments.
function | The name/identifier of the function |
argument | Function argument |
|
inline |
Construct a new FunctionCall with a given function identifier and optional argument list, transferring ownership of any provided arguments to the FunctionCall and updating parent data on the arguments.
function | The name/identifier of the function |
arguments | Function arguments |
|
inline |
Deep copy constructor for a FunctionCall, performing a deep copy on all held function arguments, ensuring parent information is updated.
other | A const reference to another FunctionCall to deep copy |
|
overridedefault |
|
inline |
Appends an argument to this function call, transferring ownership to the FunctionCall and updating parent data on the expression. If the expression is a nullptr, it is ignored.
|
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 this Expression list holds any valid expressions.
|
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 the function name/identifier.
|
inlineoverridevirtual |
Virtual method for accessing node name information.
Implements Node.
|
inlineoverridevirtual |
Virtual method for accessing node type information.
Implements Node.
|
inline |
Query the total number of arguments stored on this function.
|
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 FunctionCall::children.
|
inlineoverridevirtual |
Virtual method for accessing node name information.
Implements Node.