restructuring
[lwes-java.git] / src / main / java / org / lwes / db / ParseException.java
blob116125dc067e65bc2056cc21efdfac170b02da61
1 /* Generated By:JavaCC: Do not edit this line. ParseException.java Version 3.0 */
2 package org.lwes.db;
4 /**
5 * This exception is thrown when parse errors are encountered.
6 * You can explicitly create objects of this exception type by
7 * calling the method generateParseException in the generated
8 * parser.
10 * You can modify this class to customize your error reporting
11 * mechanisms so long as you retain the public fields.
13 public class ParseException extends Exception {
15 /**
16 * This constructor is used by the method "generateParseException"
17 * in the generated parser. Calling this constructor generates
18 * a new object of this type with the fields "currentToken",
19 * "expectedTokenSequences", and "tokenImage" set. The boolean
20 * flag "specialConstructor" is also set to true to indicate that
21 * this constructor was used to create this object.
22 * This constructor calls its super class with the empty string
23 * to force the "toString" method of parent class "Throwable" to
24 * print the error message in the form:
25 * ParseException: <result of getMessage>
27 public ParseException(Token currentTokenVal,
28 int[][] expectedTokenSequencesVal,
29 String[] tokenImageVal
32 super("");
33 specialConstructor = true;
34 currentToken = currentTokenVal;
35 expectedTokenSequences = expectedTokenSequencesVal;
36 tokenImage = tokenImageVal;
39 /**
40 * The following constructors are for use by you for whatever
41 * purpose you can think of. Constructing the exception in this
42 * manner makes the exception behave in the normal way - i.e., as
43 * documented in the class "Throwable". The fields "errorToken",
44 * "expectedTokenSequences", and "tokenImage" do not contain
45 * relevant information. The JavaCC generated code does not use
46 * these constructors.
49 public ParseException() {
50 super();
51 specialConstructor = false;
54 public ParseException(String message) {
55 super(message);
56 specialConstructor = false;
59 /**
60 * This variable determines which constructor was used to create
61 * this object and thereby affects the semantics of the
62 * "getMessage" method (see below).
64 protected boolean specialConstructor;
66 /**
67 * This is the last token that has been consumed successfully. If
68 * this object has been created due to a parse error, the token
69 * followng this token will (therefore) be the first error token.
71 public Token currentToken;
73 /**
74 * Each entry in this array is an array of integers. Each array
75 * of integers represents a sequence of tokens (by their ordinal
76 * values) that is expected at this point of the parse.
78 public int[][] expectedTokenSequences;
80 /**
81 * This is a reference to the "tokenImage" array of the generated
82 * parser within which the parse error occurred. This array is
83 * defined in the generated ...Constants interface.
85 public String[] tokenImage;
87 /**
88 * This method has the standard behavior when this object has been
89 * created using the standard constructors. Otherwise, it uses
90 * "currentToken" and "expectedTokenSequences" to generate a parse
91 * error message and returns it. If this object has been created
92 * due to a parse error, and you do not catch it (it gets thrown
93 * from the parser), then this method is called during the printing
94 * of the final stack trace, and hence the correct error message
95 * gets displayed.
97 public String getMessage() {
98 if (!specialConstructor) {
99 return super.getMessage();
101 StringBuffer expected = new StringBuffer();
102 int maxSize = 0;
103 for (int i = 0; i < expectedTokenSequences.length; i++) {
104 if (maxSize < expectedTokenSequences[i].length) {
105 maxSize = expectedTokenSequences[i].length;
107 for (int j = 0; j < expectedTokenSequences[i].length; j++) {
108 expected.append(tokenImage[expectedTokenSequences[i][j]]).append(" ");
110 if (expectedTokenSequences[i][expectedTokenSequences[i].length - 1] != 0) {
111 expected.append("...");
113 expected.append(eol).append(" ");
115 StringBuffer retval = new StringBuffer("Encountered \"");
116 Token tok = currentToken.next;
117 for (int i = 0; i < maxSize; i++) {
118 if (i != 0) retval.append(" ");
119 if (tok.kind == 0) {
120 retval.append(tokenImage[0]);
121 break;
123 retval.append(add_escapes(tok.image));
124 tok = tok.next;
126 retval.append("\" at line ")
127 .append(currentToken.next.beginLine)
128 .append(", column ")
129 .append(currentToken.next.beginColumn)
130 .append(".").append(eol);
131 if (expectedTokenSequences.length == 1) {
132 retval.append("Was expecting:").append(eol).append(" ");
133 } else {
134 retval.append("Was expecting one of:").append(eol).append(" ");
136 retval.append(expected.toString());
137 return retval.toString();
141 * The end of line string for this machine.
143 protected String eol = System.getProperty("line.separator", "\n");
146 * Used to convert raw characters to their escaped version
147 * when these raw version cannot be used as part of an ASCII
148 * string literal.
150 protected String add_escapes(String str) {
151 StringBuffer retval = new StringBuffer();
152 char ch;
153 for (int i = 0; i < str.length(); i++) {
154 switch (str.charAt(i))
156 case 0 :
157 continue;
158 case '\b':
159 retval.append("\\b");
160 continue;
161 case '\t':
162 retval.append("\\t");
163 continue;
164 case '\n':
165 retval.append("\\n");
166 continue;
167 case '\f':
168 retval.append("\\f");
169 continue;
170 case '\r':
171 retval.append("\\r");
172 continue;
173 case '\"':
174 retval.append("\\\"");
175 continue;
176 case '\'':
177 retval.append("\\\'");
178 continue;
179 case '\\':
180 retval.append("\\\\");
181 continue;
182 default:
183 if ((ch = str.charAt(i)) < 0x20 || ch > 0x7e) {
184 String s = "0000" + Integer.toString(ch, 16);
185 retval.append("\\u").append(s.substring(s.length() - 4, s.length()));
186 } else {
187 retval.append(ch);
189 continue;
192 return retval.toString();