OpenVDB  9.0.1
Public Types | Public Member Functions | List of all members
Statement Struct Referenceabstract

Abstract (pure-virtual) AST nodes. More...

#include <openvdb_ax/ast/AST.h>

Inherits Node.

Inherited by Block, ConditionalStatement, DeclareLocal, Expression, Keyword, Loop, and StatementList.

Public Types

using UniquePtr = std::unique_ptr< Statement >
 
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

 ~Statement () override=default
 
virtual Statementcopy () const override=0
 The deep copy method for a Node. More...
 
const Nodebasetype () 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...
 
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...
 
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 Nodechild (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 Nodeparent () 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...
 

Detailed Description

Abstract (pure-virtual) AST nodes.

Statements are anything that can make up a line, i.e. everything in between semicolons. Likewise to their base ast::Node class, currently every concrete AST node is either directly or indirectly a derived statement type. They hold no class data.

Member Typedef Documentation

using Ptr = std::shared_ptr<Node>
inherited
using UniquePtr = std::unique_ptr<Statement>

Member Enumeration Documentation

enum NodeType
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.

Note
This is sometimes referred to as "manual RTTI". We use this technique combine with single dispatch due to opting for CRTP on the main visitor and no templated virtual method support in C++. i.e. no way to double dispatch: visit<template T>(Visitor<T>*)
Abstract (pure-virtual) nodes are not listed here. Node::isType should be used to determine if a node is of a given abstract type.
Enumerator
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 

Constructor & Destructor Documentation

~Statement ( )
overridedefault

Member Function Documentation

const Node* basetype ( ) const
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.

Returns
Returns the current node as its base class type.

Reimplemented from Node.

Reimplemented in Value< std::string >, Value< T >, DeclareLocal, Local, ExternalVariable, Attribute, ArrayPack, ArrayUnpack, Keyword, FunctionCall, Cast, UnaryOperator, Crement, AssignExpression, TernaryOperator, BinaryOperator, ConditionalStatement, Loop, CommaOperator, Block, StatementList, ValueBase, Variable, and Expression.

virtual const Node* child ( const size_t  index) const
pure virtualinherited

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.

Note
This may still return a nullptr even if the given index is valid if the child node has not been created.
Parameters
indexThe child index to query
Returns
A Pointer to the child node, or a nullptr if none exists.

Implemented in DeclareLocal, ArrayPack, ArrayUnpack, Keyword, FunctionCall, Cast, UnaryOperator, Crement, AssignExpression, TernaryOperator, BinaryOperator, ConditionalStatement, Loop, CommaOperator, Tree, Block, StatementList, ValueBase, and Variable.

int64_t childidx ( ) const
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)

Returns
The child index of this node
virtual size_t children ( ) const
pure virtualinherited

Virtual method for accessing child information. Returns the number of children a given AST node owns.

Returns
The number of children this node owns.

Implemented in DeclareLocal, ArrayPack, ArrayUnpack, Keyword, FunctionCall, Cast, UnaryOperator, Crement, AssignExpression, TernaryOperator, BinaryOperator, ConditionalStatement, Loop, CommaOperator, Tree, Block, StatementList, ValueBase, and Variable.

virtual Statement* copy ( ) const
overridepure virtual
bool isType ( ) const
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()

Template Parameters
NodeTThe node type to query against.
Returns
True if this node is of the given type, false otherwise.
virtual const char* nodename ( ) const
pure virtualinherited
virtual NodeType nodetype ( ) const
pure virtualinherited

Virtual method for accessing node type information.

Note
This method should be used when querying a concrete nodes type.
Returns
Returns the enumerated node type from the NodeType list

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.

const Node* parent ( ) const
inlineinherited

Access a const pointer to this nodes parent.

Note
Can be a nullptr if this is the top most node in an AST (usually a Tree)
Returns
A const pointer to this node's parent node
bool replace ( Node node)
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.

Note
A replacement will fail if this node is the top most node within an AST hierarchy or if the provided node type is not a compatible type for the required abstract storage. For example, if this node is an Attribute being held on a BinaryOperator, only concrete nodes derived from an Expression can be used as a replacement.
This method will dynamic_cast the provided node to check to see if it's a compatible type.
Parameters
nodeThe node to insert on a successful replacement.
Returns
True if the replacement was successful, resulting in destruction of this class and ownership transferal of the provided node. False otherwise, where this and the provided node are unchanged.
bool replacechild ( const size_t  index,
Node node 
)
inlinevirtualinherited

Virtual method that attempted to replace a child at a given index with a provided node type.

Note
See Node::replace for a more detailed description
Parameters
indexThe child index where a replacement should be attempted
nodeThe node to insert on a successful replacement.
Returns
True if the replacement was successful, false otherwise

Reimplemented in DeclareLocal, ArrayPack, ArrayUnpack, FunctionCall, Cast, UnaryOperator, Crement, AssignExpression, TernaryOperator, BinaryOperator, ConditionalStatement, Loop, CommaOperator, Block, and StatementList.

void setParent ( Node parent)
inlineinherited

Set this node's parent. This is used during construction of an AST and should not be used.

Parameters
parentThe parent to set
virtual const char* subname ( ) const
pure virtualinherited