OpenVDB  12.0.0
Public Types | Public Member Functions | List of all members
StatementList Struct Reference

Concrete AST nodes. More...

#include <openvdb_ax/ast/AST.h>

Inherits Statement.

Public Types

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

 StatementList ()
 Construct a new StatementList with an empty list. More...
 
 StatementList (Statement *statement)
 Construct a new StatementList with a single statement, transferring ownership of the statement to the statement list and updating parent data on the statement. If the statement is a nullptr, it is ignored. More...
 
 StatementList (const std::vector< Statement * > &statements)
 Construct a new StatementList from a vector of statements, transferring ownership of all valid statements to the statement list and updating parent data on the statement. Only valid (non null) statements are added to the statement list. More...
 
 StatementList (const StatementList &other)
 Deep copy constructor for a StatementList, performing a deep copy on every held statement, ensuring parent information is updated. More...
 
 ~StatementList () override=default
 
StatementListcopy () const override
 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 Statementbasetype () 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 Statementchild (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...
 
size_t size () const
 Alias for StatementList::children. More...
 
void addStatement (Statement *stmnt)
 Adds a statement to this statement list, transferring ownership to the statement list and updating parent data on the statement. If the statement 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 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

Concrete AST nodes.

A StatementList is derived from a Statement and comprises of combinations of multiple statements. This could represent either a list of statements of different types but in practice will likely represent a ',' separated list of the same type i.e. 'int i = 1, j = 1;'.

Note
Statements held by the list are guaranteed to be valid (non null). nullptrs added to the list are implicitly dropped.

Member Typedef Documentation

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

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

StatementList ( )
inline

Construct a new StatementList with an empty list.

StatementList ( Statement statement)
inline

Construct a new StatementList with a single statement, transferring ownership of the statement to the statement list and updating parent data on the statement. If the statement is a nullptr, it is ignored.

Parameters
statementThe statement to construct from
StatementList ( const std::vector< Statement * > &  statements)
inline

Construct a new StatementList from a vector of statements, transferring ownership of all valid statements to the statement list and updating parent data on the statement. Only valid (non null) statements are added to the statement list.

Parameters
statementsThe vector of statements to construct from
StatementList ( const StatementList other)
inline

Deep copy constructor for a StatementList, performing a deep copy on every held statement, ensuring parent information is updated.

Parameters
otherA const reference to another statement list to deep copy
~StatementList ( )
overridedefault

Member Function Documentation

void addStatement ( Statement stmnt)
inline

Adds a statement to this statement list, transferring ownership to the statement list and updating parent data on the statement. If the statement is a nullptr, it is ignored.

const Statement* 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.

Reimplemented from Statement.

const Statement* child ( const size_t  i) const
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.

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
size_t children ( ) const
inlinefinaloverridevirtual

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

Implements Node.

StatementList* copy ( ) const
inlineoverridevirtual

The deep copy method for a Node.

Implements Statement.

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.
const char* nodename ( ) const
inlineoverridevirtual

Virtual method for accessing node name information.

Implements Node.

NodeType nodetype ( ) const
inlineoverridevirtual

Virtual method for accessing node type information.

Implements Node.

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  i,
Node node 
)
inlinefinaloverridevirtual

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

Reimplemented from Node.

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
size_t size ( ) const
inline
const char* subname ( ) const
inlineoverridevirtual

Virtual method for accessing node name information.

Implements Node.