node Class Reference

#include <node.hpp>

List of all members.

Public Member Functions
	node ()
	node (double number)
	node (std::string const &identifier)
	node (char op, node operand)
	node (node left, char op, node right)
	node (identifier_list const &parameters, node definition)
	node (std::string const &name, node_list const &arguments)
	node (node const &n)
	~node ()
node &	operator= (node const &n)
void	print (std::ostream &stream, int indent=0) const
double	evaluate () const
std::string	to_string () const
identifier_list const &	get_parameters () const
Static Private Member Functions
static node_impl *	make_binary_operator (node, char, node)
	Factory function to make the binary operator nodes.
Private Attributes
node_impl *	pimpl_

---

Detailed Description

Wrapper class for all parse-tree nodes. The actual parse tree nodes derive from node_impl. This class uses the pimpl idiom to make it easier to work with node objects.

Definition at line 25 of file node.hpp.

---

Constructor & Destructor Documentation

node::node

(

)

Construct a node of type void.

Definition at line 20 of file node.cpp.

: pimpl_(new node_void())
{}

node::node

(

double

number

)

Construct a numeric node.

Parameters:

number

The number

Definition at line 30 of file node.cpp.

: pimpl_(new node_number(number))
{}

node::node

(

std::string const &

identifier

)

Construct an identifier node.

Parameters:

identifier

The identifier

Definition at line 34 of file node.cpp.

  : pimpl_(new node_identifier(identifier))
  {}

node::node	(	char	op,
		node	operand
	)

Construct a unary operator node.

Parameters:

	op	The operator character, e.g., '-'
	operand	The operand node

Definition at line 38 of file node.cpp.

: pimpl_(new node_negate(operand))
{}

node::node	(	node	left,
		char	op,
		node	right
	)

Construct a binary operator node.

Parameters:

	left	The left-hand parse-tree
	op	The operator character, e.g., '*'
	right	The right-hand operand

Definition at line 42 of file node.cpp.

: pimpl_(make_binary_operator(left, op, right))
{}

node::node	(	identifier_list const &	parameters,
		node	definition
	)

Construct a function definition node.

Parameters:

	parameters	The list of all the parameter names
	definition	The function definition

Definition at line 46 of file node.cpp.

: pimpl_(new node_function(parameters, definition))
{}

node::node	(	std::string const &	name,
		node_list const &	arguments
	)

Construct a function call node.

Parameters:

	name	The function name
	arguments	The function arguments

Definition at line 50 of file node.cpp.

: pimpl_(new node_function_call(name, arguments))
{}

node::node

(

node const &

n

)

Copy constructor. Increments the reference count.

Parameters:

n

The node to copy

Definition at line 24 of file node.cpp.

References node_impl::add_ref(), and pimpl_.

: pimpl_(n.pimpl_)
{
  pimpl_->add_ref();
}

node::~node

(

)

Destructor. Decrements the reference count.

Definition at line 54 of file node.cpp.

References node_impl::del_ref(), and pimpl_.

{
  pimpl_->del_ref();
}

---

Member Function Documentation

node & node::operator=

(

node const &

n

)

Copy assignment operator decrements the reference count.

Parameters:

n

the source of the assignment

Definition at line 59 of file node.cpp.

References node_impl::add_ref(), node_impl::del_ref(), and pimpl_.

{
  n.pimpl_->add_ref();
  pimpl_->del_ref();
  pimpl_ = n.pimpl_;

  return *this;
}

void node::print	(	std::ostream &	stream,
		int	indent = 0
	)			const

Print a tree. For debugging, print a visual representation of the parse tree. Each level increments the indent to make the tree structure evident.

Parameters:

	stream	The output stream
	indent	The indentation.

Definition at line 68 of file node.cpp.

References pimpl_, and node_impl::print().

Referenced by node_divide::print_node(), node_multiply::print_node(), node_subtract::print_node(), node_add::print_node(), node_negate::print_node(), and node_function::print_node().

{
  pimpl_->print(stream, indent);
}

double node::evaluate

(

)

const

Evaluate a parse tree. Evaluate and tree and return the result.

Definition at line 74 of file node.cpp.

References node_impl::evaluate(), and pimpl_.

Referenced by BOOST_AUTO_TEST_CASE(), node_binary::evaluate_left(), node_function_call::evaluate_node(), node_function::evaluate_node(), node_identifier::evaluate_node(), node_unary::evaluate_operand(), node_binary::evaluate_right(), and parser::get_statement().

{
  return pimpl_->evaluate();
}

std::string node::to_string

(

)

const

Return a string representation. For an identifier node, return the identifier. For all other nodes, return a string representation of the evaluated value.

Definition at line 80 of file node.cpp.

References pimpl_, and node_impl::to_string().

Referenced by BOOST_AUTO_TEST_CASE().

{
  return pimpl_->to_string();
}

identifier_list const & node::get_parameters

(

)

const

Return a list of parameter names. Most node return a reference to a global, static, const, empty list. Only function nodes return a list of parameters.

Definition at line 86 of file node.cpp.

References node_impl::get_parameters(), and pimpl_.

Referenced by node_function_call::evaluate_node(), and get_variable().

{
  return pimpl_->get_parameters();
}

node_impl * node::make_binary_operator	(	node	left,
		char	op,
		node	right
	)			[static, private]

Factory function to make the binary operator nodes.

Definition at line 6 of file node.cpp.

{
  if (op == '+')
    return new node_add(left, right);
  else if (op == '-')
    return new node_subtract(left, right);
  else if (op == '*')
    return new node_multiply(left, right);
  else if (op == '/')
    return new node_divide(left, right);
  else
    throw std::logic_error("fatal error in make_binary_opreator: unknown operator: " + op);
}

---

Member Data Documentation

node_impl* node::pimpl_ [private]

Definition at line 99 of file node.hpp.

Referenced by evaluate(), get_parameters(), node(), operator=(), print(), to_string(), and ~node().

---

The documentation for this class was generated from the following files:

• node.hpp
• node.cpp

---