mossadal/math-parser

<?php
/*
 * Visitable interface
 *
 * Part of the visitor design pattern implementation. Every Node
 * implements the Visitable interface, containing the single function
 * accept()
 *
 * @author      Frank Wikström <frank@mossadal.se>
 * @copyright   2015 Frank Wikström
 * @license     http://www.opensource.org/licenses/lgpl-license.php LGPL
 *
 */

namespace MathParser\Interpreting\Visitors;

use MathParser\Parsing\Nodes\ExpressionNode;
use MathParser\Parsing\Nodes\NumberNode;
use MathParser\Parsing\Nodes\VariableNode;
use MathParser\Parsing\Nodes\FunctionNode;
use MathParser\Parsing\Nodes\ConstantNode;
use MathParser\Parsing\Nodes\IntegerNode;
use MathParser\Parsing\Nodes\RationalNode;

/**
 * Visitor interface
 *
 * Implemented by every interpreter. The interface specifies
 * functions for visiting and handling each Node subclass.
 *
 */
interface Visitor
{
    /**
     * Interface function for visiting ExpressionNodes
     *
     * @param ExpressionNode $node Node to visit.
     **/
    function visitExpressionNode(ExpressionNode $node);

    /**
     * Interface function for visiting NumberNodes
     *
     * @param NumberNode $node Node to visit.
     **/
    function visitNumberNode(NumberNode $node);

    /**
     * Interface function for visiting IntegerNodes
     *
     * @param IntegerNode $node Node to visit.
     **/
    function visitIntegerNode(IntegerNode $node);

    /**
     * Interface function for visiting RationalNodes
     *
     * @param RationalNode $node Node to visit.
     **/
    function visitRationalNode(RationalNode $node);

    /**
     * Interface function for visiting VariableNodes
     *
     * @param VariableNode $node Node to visit.
     **/
    function visitVariableNode(VariableNode $node);

    /**
     * Interface function for visiting FunctionNode
     *
     * @param FunctionNode $node Node to visit.
     **/
    function visitFunctionNode(FunctionNode $node);

    /**
     * Interface function for visiting ConstantNode
     *
     * @param ConstantNode $node Node to visit.
     **/
    function visitConstantNode(ConstantNode $node);
}