OpenVDB
12.0.0
|
ExternalVariable represent any access to external (custom) data, typically associated with the '$' symbol syntax. Note that the AST does not store any additional information on the given external other than its name and type, which together form a unique external identifier known as the ExternalVariable 'token'. This token is used by the compiler to map user provided values to these external values. More...
#include <openvdb_ax/ast/AST.h>
Inherits Variable.
Public Types | |
using | UniquePtr = std::unique_ptr< ExternalVariable > |
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 | |
ExternalVariable (const std::string &name, const tokens::CoreType type) | |
Construct a new ExternalVariable with a given name and type. More... | |
ExternalVariable (const std::string &name, const std::string &token) | |
Construct a new ExternalVariable with a given name and type/token string, delegating construction to the above ExternalVariable constructor. More... | |
ExternalVariable (const ExternalVariable &other) | |
Deep copy constructor for a ExternalVariable. More... | |
~ExternalVariable () override=default | |
ExternalVariable * | 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 Variable * | 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... | |
tokens::CoreType | type () const |
Access the type that was used to access this external variable. More... | |
std::string | typestr () const |
Get the access type as a front end AX type/token string. More... | |
const std::string | tokenname () const |
Construct and return the full external token identifier. See ExternalVariable::tokenFromNameType. More... | |
size_t | children () const override |
Virtual method for accessing child information. Returns the number of children a given AST node owns. More... | |
const Node * | child (const size_t) const override |
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... | |
const std::string & | name () const |
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... | |
Static Public Member Functions | |
static char | symbolseparator () |
Static method returning the symbol associated with an ExternalVariable access as defined by AX Grammar. More... | |
static std::string | tokenFromNameType (const std::string &name, const tokens::CoreType type) |
Static method returning the full unique external token identifier by consolidating its name and type such that token = tokenstr + '$' + name, where tokenstr is the AX type token as a string, converted from the provided CoreType. More... | |
static bool | nametypeFromToken (const std::string &token, std::string *name, std::string *type) |
Static method which splits a valid external token into its name and type counterparts. If the token cannot be split, neither name or type are updated and false is returned. More... | |
ExternalVariable represent any access to external (custom) data, typically associated with the '$' symbol syntax. Note that the AST does not store any additional information on the given external other than its name and type, which together form a unique external identifier known as the ExternalVariable 'token'. This token is used by the compiler to map user provided values to these external values.
using UniquePtr = std::unique_ptr<ExternalVariable> |
|
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 ExternalVariable with a given name and type.
name | The name of the attribute |
type | The type of the attribute |
|
inline |
Construct a new ExternalVariable with a given name and type/token string, delegating construction to the above ExternalVariable constructor.
name | The name of the attribute |
token | The type/token string of the attribute |
|
inline |
Deep copy constructor for a ExternalVariable.
other | A const reference to another ExternalVariable to deep copy |
|
overridedefault |
|
inlineoverridevirtual |
|
inlineoverridevirtualinherited |
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 |
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)
|
inlineoverridevirtualinherited |
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. |
|
inlineinherited |
|
inlinestatic |
Static method which splits a valid external token into its name and type counterparts. If the token cannot be split, neither name or type are updated and false is returned.
token | The token to split. |
name | Set to the second part of the external token, representing the name. If a nullptr, it is ignored |
type | Set to the first part of the external token, representing the type. If a nullptr, it is ignored. Note that this can be empty if the external token has an inferred type or a single character. |
|
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.
|
inlinestatic |
Static method returning the symbol associated with an ExternalVariable access as defined by AX Grammar.
|
inlinestatic |
Static method returning the full unique external token identifier by consolidating its name and type such that token = tokenstr + '$' + name, where tokenstr is the AX type token as a string, converted from the provided CoreType.
name | The name of the external |
type | The CoreType of the external |
|
inline |
Construct and return the full external token identifier. See ExternalVariable::tokenFromNameType.
|
inline |
Access the type that was used to access this external variable.
|
inline |
Get the access type as a front end AX type/token string.