1<?php
2
3/**
4 * Hoa
5 *
6 *
7 * @license
8 *
9 * New BSD License
10 *
11 * Copyright © 2007-2017, Hoa community. All rights reserved.
12 *
13 * Redistribution and use in source and binary forms, with or without
14 * modification, are permitted provided that the following conditions are met:
15 *     * Redistributions of source code must retain the above copyright
16 *       notice, this list of conditions and the following disclaimer.
17 *     * Redistributions in binary form must reproduce the above copyright
18 *       notice, this list of conditions and the following disclaimer in the
19 *       documentation and/or other materials provided with the distribution.
20 *     * Neither the name of the Hoa nor the names of its contributors may be
21 *       used to endorse or promote products derived from this software without
22 *       specific prior written permission.
23 *
24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS AND CONTRIBUTORS BE
28 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
29 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
30 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
31 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
32 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
33 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
34 * POSSIBILITY OF SUCH DAMAGE.
35 */
36
37namespace Hoa\Compiler\Llk\Rule;
38
39/**
40 * Class \Hoa\Compiler\Llk\Rule\Invocation.
41 *
42 * Parent of entry and ekzit rules.
43 *
44 * @copyright  Copyright © 2007-2017 Hoa community
45 * @license    New BSD License
46 */
47abstract class Invocation
48{
49    /**
50     * Rule.
51     *
52     * @var string
53     */
54    protected $_rule         = null;
55
56    /**
57     * Data.
58     *
59     * @var mixed
60     */
61    protected $_data         = null;
62
63    /**
64     * Piece of todo sequence.
65     *
66     * @var array
67     */
68    protected $_todo         = null;
69
70    /**
71     * Depth in the trace.
72     *
73     * @var int
74     */
75    protected $_depth        = -1;
76
77    /**
78     * Whether the rule is transitional or not (i.e. not declared in the grammar
79     * but created by the analyzer).
80     *
81     * @var bool
82     */
83    protected $_transitional = false;
84
85
86
87    /**
88     * Constructor.
89     *
90     * @param   string  $rule     Rule name.
91     * @param   mixed   $data     Data.
92     * @param   array   $todo     Todo.
93     * @param   int     $depth    Depth.
94     */
95    public function __construct(
96        $rule,
97        $data,
98        array $todo = null,
99        $depth      = -1
100    ) {
101        $this->_rule         = $rule;
102        $this->_data         = $data;
103        $this->_todo         = $todo;
104        $this->_depth        = $depth;
105        $this->_transitional = is_int($rule);
106
107        return;
108    }
109
110    /**
111     * Get rule name.
112     *
113     * @return  string
114     */
115    public function getRule()
116    {
117        return $this->_rule;
118    }
119
120    /**
121     * Get data.
122     *
123     * @return  mixed
124     */
125    public function getData()
126    {
127        return $this->_data;
128    }
129
130    /**
131     * Get todo sequence.
132     *
133     * @return  array
134     */
135    public function getTodo()
136    {
137        return $this->_todo;
138    }
139
140    /**
141     * Set depth in trace.
142     *
143     * @param   int  $depth    Depth.
144     * @return  int
145     */
146    public function setDepth($depth)
147    {
148        $old          = $this->_depth;
149        $this->_depth = $depth;
150
151        return $old;
152    }
153
154    /**
155     * Get depth in trace.
156     *
157     * @return  int
158     */
159    public function getDepth()
160    {
161        return $this->_depth;
162    }
163
164    /**
165     * Check whether the rule is transitional or not.
166     *
167     * @return  bool
168     */
169    public function isTransitional()
170    {
171        return $this->_transitional;
172    }
173}
174