1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
|
/*
* This file is part of Petascope.
*
* Petascope is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation, either version 3 of
* the License, or (at your option) any later version.
*
* Petascope is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with Petascope. If not, see <http://www.gnu.org/licenses/>.
*
* For more information please see <http://www.Petascope.org>
* or contact Peter Baumann via <baumann@rasdaman.com>.
*
* Copyright 2009 Jacobs University Bremen, Peter Baumann.
*/
package java_cup;
/** This abstract class serves as the base class for grammar symbols (i.e.,
* both terminals and non-terminals). Each symbol has a name string, and
* a string giving the type of object that the symbol will be represented by
* on the runtime parse stack. In addition, each symbol maintains a use count
* in order to detect symbols that are declared but never used, and an index
* number that indicates where it appears in parse tables (index numbers are
* unique within terminals or non terminals, but not across both).
*
* @see java_cup.terminal
* @see java_cup.non_terminal
*/
public abstract class symbol {
/*-----------------------------------------------------------*/
/*--- Constructor(s) ----------------------------------------*/
/*-----------------------------------------------------------*/
/** Full constructor.
* @param nm the name of the symbol.
* @param tp a string with the type name.
*/
public symbol(String nm, String tp)
{
/* sanity check */
if (nm == null) nm = "";
/* apply default if no type given */
if (tp == null) tp = "Object";
_name = nm;
_stack_type = tp;
}
/*. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .*/
/** Constructor with default type.
* @param nm the name of the symbol.
*/
public symbol(String nm)
{
this(nm, null);
}
/*-----------------------------------------------------------*/
/*--- (Access to) Instance Variables ------------------------*/
/*-----------------------------------------------------------*/
/** String for the human readable name of the symbol. */
protected String _name;
/** String for the human readable name of the symbol. */
public String name() {return _name;}
/*. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .*/
/** String for the type of object used for the symbol on the parse stack. */
protected String _stack_type;
/** String for the type of object used for the symbol on the parse stack. */
public String stack_type() {return _stack_type;}
/*. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .*/
/** Count of how many times the symbol appears in productions. */
protected int _use_count = 0;
/** Count of how many times the symbol appears in productions. */
public int use_count() {return _use_count;}
/** Increment the use count. */
public void note_use() {_use_count++;}
/*. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .*/
/** Index of this symbol (terminal or non terminal) in the parse tables.
* Note: indexes are unique among terminals and unique among non terminals,
* however, a terminal may have the same index as a non-terminal, etc.
*/
protected int _index;
/** Index of this symbol (terminal or non terminal) in the parse tables.
* Note: indexes are unique among terminals and unique among non terminals,
* however, a terminal may have the same index as a non-terminal, etc.
*/
public int index() {return _index;}
/*. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .*/
/** Indicate if this is a non-terminal. Here in the base class we
* don't know, so this is abstract.
*/
public abstract boolean is_non_term();
/*. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .*/
/** Convert to a string. */
public String toString()
{
return name();
}
/*-----------------------------------------------------------*/
}
|
