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

Detailed Description

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.

Member Typedef Documentation

using Ptr = std::shared_ptr<Node>

inherited

using UniquePtr = std::unique_ptr<FunctionCall>

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

FunctionCall	(	const std::string &	function,
		Expression *	argument = `nullptr`
	)

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.

Parameters

function	The name/identifier of the function
argument	Function argument

FunctionCall	(	const std::string &	function,
		const std::vector< Expression * > &	arguments
	)

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.

Parameters

function	The name/identifier of the function
arguments	Function arguments

FunctionCall ( const FunctionCall & other )

inline

Deep copy constructor for a FunctionCall, performing a deep copy on all held function arguments, ensuring parent information is updated.

Parameters

other A const reference to another FunctionCall to deep copy

~FunctionCall ( )

overridedefault

Member Function Documentation

void append ( Expression * expr )

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.

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

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

FunctionCall* copy ( ) const

inlinefinaloverridevirtual

The deep copy method for a Node.

Implements Expression.

bool empty ( ) const

inline

Query whether this Expression list holds any valid expressions.

Returns: True if this node if empty, false otherwise

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

NodeT The node type to query against.

Returns: True if this node is of the given type, false otherwise.

const std::string& name ( ) const

inline

Access the function name/identifier.

Returns: A const reference to the function name

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.

size_t numArgs ( ) const

inline

Query the total number of arguments stored on this function.

Returns: The number of arguments. Can be 0

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

node	The 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

parent The parent to set

size_t size ( ) const

inline

Alias for FunctionCall::children.

const char* subname ( ) const

inlineoverridevirtual

Virtual method for accessing node name information.

Implements Node.

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation