-
Notifications
You must be signed in to change notification settings - Fork 1
/
ProtoLexer.java
238 lines (188 loc) · 8.63 KB
/
ProtoLexer.java
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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
/* M2J -- Modula-2 to Java Translator & Compiler
*
* Copyright (c) 2016 The Modula-2 Software Foundation
*
* Author & Maintainer: Benjamin Kowarsch <[email protected]>
*
* @synopsis
*
* M2J is a multi-dialect Modula-2 to Java translator and via-Java compiler.
* It supports the dialects described in the 3rd and 4th editions of Niklaus
* Wirth's book "Programming in Modula-2" (PIM) published by Springer Verlag,
* and an extended mode with select features from the revised language by
* B.Kowarsch and R.Sutcliffe "Modula-2 Revision 2010" (M2R10).
*
* In translator mode, M2J translates Modula-2 source to Java source files.
* In compiler mode, M2J compiles Modula-2 source via Java source files
* to Java .class files using the host system's resident Java compiler.
*
* @repository
*
* https://github.com/m2sf/m2j
*
* @file
*
* ProtoLexer.java
*
* Public lexer interface.
*
* @license
*
* M2J is free software: you can redistribute and/or modify it under the
* terms of the GNU Lesser General Public License (LGPL) either version 2.1
* or at your choice version 3 as published by the Free Software Foundation.
* However, you may not alter the copyright, author and license information.
*
* M2J 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. Read the license for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with m2j. If not, see <https://www.gnu.org/copyleft/lesser.html>.
*
* NB: Components in the domain part of email addresses are in reverse order.
*/
package org.m2sf.m2j;
interface ProtoLexer {
/* ---------------------------------------------------------------------------
* Lexical limits
* ------------------------------------------------------------------------ */
public static int MAX_IDENT_LENGTH = 32;
public static int COMMENT_NESTING_LIMIT = 100;
/* ---------------------------------------------------------------------------
* Lexer status codes
* ------------------------------------------------------------------------ */
public enum Status {
SUCCESS,
FILE_NOT_FOUND,
FILE_ACCESS_DENIED,
NOT_INITIALIZED,
TODO
} /* Status */
/* ---------------------------------------------------------------------------
* constructor newLexer(filename)
* ---------------------------------------------------------------------------
* Creates a new lexer instance, opens an input file, associates the file with
* the newly created lexer and returns a Result pair with the lexer reference
* and a status value.
*
* pre-conditions:
* o filename must refer to an existing and accessible input file
*
* post-conditions:
* o lexer is created
* o status is set to SUCCESS
*
* error-conditions:
* o if the file represented by filename cannot be found
* lexer is set to null, status is set to FILE_NOT_FOUND
* o if the file represented by filename cannot be accessed
* lexer is set to null, status is set to FILE_ACCESS_DENIED
* ----------------------------------------------------------------------- */
public Result<ProtoLexer, Status> newLexer (String filename);
/* --------------------------------------------------------------------------
* method readSym()
* --------------------------------------------------------------------------
* Reads the lookahead symbol from the source file associated with lexer and
* consumes it, thus advancing the current reading position, then returns
* the symbol's token.
*
* pre-conditions:
* o lexer instance must have been created with constructor newLexer()
* so that it is associated with an input source file
*
* post-conditions:
* o character code of lookahead character or EOF is returned
* o current reading position and line and column counters are updated
* o file status is set to SUCCESS
*
* error-conditions:
* o if no source file is associated with lexer, no operation is carried out
* and status is set to NOT_INITIALIZED
* ----------------------------------------------------------------------- */
public ProtoTerminals.Token readSym();
/* --------------------------------------------------------------------------
* method nextSym()
* --------------------------------------------------------------------------
* Reads the lookahead symbol from the source file associated with lexer but
* does not consume it, thus not advancing the current reading position,
* then returns the symbol's token.
*
* pre-conditions:
* o lexer instance must have been created with constructor newLexer()
* so that it is associated with an input source file
*
* post-conditions:
* o token of lookahead symbol is returned
* o current reading position and line and column counters are NOT updated
* o file status is set to SUCCESS
*
* error-conditions:
* o if no source file is associated with lexer, no operation is carried out
* and status is set to NOT_INITIALIZED
* ----------------------------------------------------------------------- */
public ProtoTerminals.Token nextSym ();
/* --------------------------------------------------------------------------
* method consumeSym()
* --------------------------------------------------------------------------
* Consumes the lookahead symbol and returns the token of the new lookahead
* symbol.
* ----------------------------------------------------------------------- */
public ProtoTerminals.Token consumeSym ();
/* --------------------------------------------------------------------------
* method filename()
* --------------------------------------------------------------------------
* Returns the filename associated with the lexer instance.
* ----------------------------------------------------------------------- */
public String filename ();
/* --------------------------------------------------------------------------
* method status()
* --------------------------------------------------------------------------
* Returns the status of the last operation on lexer.
* ----------------------------------------------------------------------- */
public Status status ();
/* --------------------------------------------------------------------------
* method lookaheadLexeme()
* --------------------------------------------------------------------------
* Returns the lexeme of the lookahead symbol.
* ----------------------------------------------------------------------- */
public String lookaheadLexeme ();
/* --------------------------------------------------------------------------
* method currentLexeme()
* --------------------------------------------------------------------------
* Returns the lexeme of the most recently consumed symbol.
* ----------------------------------------------------------------------- */
public String currentLexeme ();
/* --------------------------------------------------------------------------
* method lookaheadLine()
* --------------------------------------------------------------------------
* Returns the line counter of the lookahead symbol.
* ----------------------------------------------------------------------- */
public int lookaheadLine ();
/* --------------------------------------------------------------------------
* method currentLine()
* --------------------------------------------------------------------------
* Returns the line counter of the most recently consumed symbol.
* ----------------------------------------------------------------------- */
public int currentLine ();
/* --------------------------------------------------------------------------
* method lookaheadColumn()
* --------------------------------------------------------------------------
* Returns the column counter of the lookahead symbol.
* ----------------------------------------------------------------------- */
public int lookaheadColumn ();
/* --------------------------------------------------------------------------
* method currentColumn()
* --------------------------------------------------------------------------
* Returns the column counter of the most recently consumed symbol.
* ----------------------------------------------------------------------- */
public int currentColumn ();
/* --------------------------------------------------------------------------
* method printLineAndMarkColumn(line, column)
* --------------------------------------------------------------------------
* Prints the given source line of the current symbol to the console and
* marks the given coloumn with a caret '^'.
* ----------------------------------------------------------------------- */
public void printLineAndMarkColumn (int line, int column);
} /* ProtoLexer */
/* END OF FILE */