-
Notifications
You must be signed in to change notification settings - Fork 1
/
ProtoDiagnostics.java
246 lines (186 loc) · 9.27 KB
/
ProtoDiagnostics.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
239
240
241
242
243
244
245
246
/* 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
*
* ProtoDiagnostics.java
*
* Public interface for emitting compiler warnings and error messages.
*
* @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;
import java.util.EnumSet;
interface ProtoDiagnostics {
/* ---------------------------------------------------------------------------
* type Code
* ---------------------------------------------------------------------------
* Enumerated diagnostic codes representing compilation warnings and errors.
* ------------------------------------------------------------------------ */
public enum Code {
/* Null Error */
UNKNOWN,
/* Option Errors */
ERROR_INVALID_OPTION,
ERROR_INVALID_ARGUMENT,
ERROR_MISSING_FILENAME,
ERROR_INVALID_FILENAME,
ERROR_INPUT_FILE_NOT_FOUND,
/* Lexical Warnings and Errors */
WARN_DISABLED_CODE_SECTION,
ERROR_INVALID_INPUT_CHAR,
ERROR_EOF_IN_BLOCK_COMMENT,
ERROR_NEW_LINE_IN_STRING_LITERAL,
ERROR_EOF_IN_STRING_LITERAL,
ERROR_INVALID_ESCAPE_SEQUENCE,
ERROR_EOF_IN_PRAGMA,
ERROR_MISSING_STRING_DELIMITER,
ERROR_MISSING_SUFFIX,
ERROR_MISSING_EXPONENT,
/* Syntax Warnings and Errors */
ERROR_UNEXPECTED_TOKEN,
WARN_SEMICOLON_AFTER_FIELD_LIST_SEQ,
WARN_EMPTY_FIELD_LIST_SEQ,
WARN_SEMICOLON_AFTER_FORMAL_PARAM_LIST,
WARN_SEMICOLON_AFTER_STMT_SEQ,
WARN_EMPTY_STMT_SEQ,
ERROR_Y, /* Y */
/* Semantic Errors */
ERROR_Z; /* Z */
} /* Code */
/* ---------------------------------------------------------------------------
* method isOptionError(code)
* ---------------------------------------------------------------------------
* Returns true if code represents an option error code, otherwise false.
* ------------------------------------------------------------------------ */
public boolean isOptionError (Code code);
/* ---------------------------------------------------------------------------
* method isLexicalError(code)
* ---------------------------------------------------------------------------
* Returns true if code represents a lexical error code, otherwise false.
* ------------------------------------------------------------------------ */
public boolean isLexicalError (Code code);
/* ---------------------------------------------------------------------------
* method isSyntaxError(error)
* ---------------------------------------------------------------------------
* Returns true if code represents a syntax error code, otherwise false.
* ------------------------------------------------------------------------ */
public boolean isSyntaxError (Code code);
/* ---------------------------------------------------------------------------
* method isSemanticError(code)
* ---------------------------------------------------------------------------
* Returns true if code represents a semantic error code, otherwise false.
* ------------------------------------------------------------------------ */
public boolean isSemanticError (Code code);
/* ---------------------------------------------------------------------------
* method diagMsgText(code)
* ---------------------------------------------------------------------------
* Returns a pointer to an immutable human readable message string for the
* given diagnostic code or null if the code is not a valid diagnostic code.
* ------------------------------------------------------------------------ */
public String diagMsgText (Code code);
/* ---------------------------------------------------------------------------
* method emitError(code)
* ---------------------------------------------------------------------------
* Emits an error message for code to the console.
* ------------------------------------------------------------------------ */
public void emitError (Code code);
/* ---------------------------------------------------------------------------
* method emitErrorWithOffendingStr(code, offendingStr)
* ---------------------------------------------------------------------------
* Emits an error message for code and offendingStr to the console.
* ------------------------------------------------------------------------ */
public void emitErrorWithOffendingStr (Code code, String offendingStr);
/* ---------------------------------------------------------------------------
* method emitErrorWithPos(code, line, column)
* ---------------------------------------------------------------------------
* Emits an error message for code, line and column to the console.
* ------------------------------------------------------------------------ */
public void emitErrorWithPos (Code code, int line, int column);
/* ---------------------------------------------------------------------------
* method emitErrorWithChr(error, line, column, offendingChr)
* ---------------------------------------------------------------------------
* Emits an error message for code, line, column and offendingChr to the
* console.
* ------------------------------------------------------------------------ */
public void emitErrorWithChr
(Code code, int line, int column, char offendingChr);
/* ---------------------------------------------------------------------------
* method m2c_emit_error_w_lex(error, line, column, offendingLexeme)
* ---------------------------------------------------------------------------
* Emits an error message for code, line, column and offendingLexeme to the
* console.
* ------------------------------------------------------------------------ */
public void emitErrorWithLex
(Code code, int line, int column, String offendingLexeme);
/* ---------------------------------------------------------------------------
* method emitSyntaxErrorWithToken(line, col, unexpToken, offLex, expToken)
* ---------------------------------------------------------------------------
* Emits a syntax error message of the following format to the console:
* line: n, column: m, unexpected offending-symbol offending-lexeme found
* expected token
* ------------------------------------------------------------------------ */
public void emitSyntaxErrorWithToken
(int line, int column,
ProtoTerminals.Token unexpectedToken,
String offendingLexeme,
ProtoTerminals.Token expectedToken);
/* ---------------------------------------------------------------------------
* method emitSyntaxErrorWithSet(line, col, unexpToken, offLex, expTokenSet)
* ---------------------------------------------------------------------------
* Emits a syntax error message of the following format to the console:
* line: n, column: m, unexpected offending-symbol offending-lexeme found
* expected set-symbol-1, set-symbol-2, set-symbol-3, ... or set-symbol-N
* ------------------------------------------------------------------------ */
public void emitSyntaxErrorWithSet
(int line, int column,
ProtoTerminals.Token unexpectedToken,
String offendingLexeme,
EnumSet<ProtoTerminals.Token> expectedTokenSet);
/* ---------------------------------------------------------------------------
* method emitWarningWithPos(code, line, column)
* ---------------------------------------------------------------------------
* Emits a warning message for code, line and column to the console.
* ------------------------------------------------------------------------ */
public void emitWarningWithPos (Code code, int line, int column);
/* ---------------------------------------------------------------------------
* method emitWarningWithRange(error, firstLine, lastLine)
* ---------------------------------------------------------------------------
* Emits a warning message for range from firstLine to lastLine.
* ------------------------------------------------------------------------ */
public void emitWarningWithRange (Code code, int firstLine, int lastLine);
} /* ProtoDiagnostics */
/* END OF FILE */