1 /*******************************************************************************
2 * Copyright (c) 2010 Association for Decentralized Information Management in
4 * All rights reserved. This program and the accompanying materials
5 * are made available under the terms of the Eclipse Public License v1.0
6 * which accompanies this distribution, and is available at
7 * http://www.eclipse.org/legal/epl-v10.html
10 * VTT Technical Research Centre of Finland - initial API and implementation
11 *******************************************************************************/
12 package org.simantics.databoard.parser;
15 * This exception is thrown when parse errors are encountered.
16 * You can explicitly create objects of this exception type by
17 * calling the method generateParseException in the generated
20 * You can modify this class to customize your error reporting
21 * mechanisms so long as you retain the public fields.
23 public class ParseException extends Exception {
26 * The version identifier for this Serializable class.
27 * Increment only if the <i>serialized</i> form of the
30 private static final long serialVersionUID = 1L;
33 * This constructor is used by the method "generateParseException"
34 * in the generated parser. Calling this constructor generates
35 * a new object of this type with the fields "currentToken",
36 * "expectedTokenSequences", and "tokenImage" set.
38 public ParseException(Token currentTokenVal,
39 int[][] expectedTokenSequencesVal,
40 String[] tokenImageVal
43 super(initialise(currentTokenVal, expectedTokenSequencesVal, tokenImageVal));
44 currentToken = currentTokenVal;
45 expectedTokenSequences = expectedTokenSequencesVal;
46 tokenImage = tokenImageVal;
50 * The following constructors are for use by you for whatever
51 * purpose you can think of. Constructing the exception in this
52 * manner makes the exception behave in the normal way - i.e., as
53 * documented in the class "Throwable". The fields "errorToken",
54 * "expectedTokenSequences", and "tokenImage" do not contain
55 * relevant information. The JavaCC generated code does not use
59 public ParseException() {
63 /** Constructor with message. */
64 public ParseException(String message) {
70 * This is the last token that has been consumed successfully. If
71 * this object has been created due to a parse error, the token
72 * followng this token will (therefore) be the first error token.
74 public Token currentToken;
77 * Each entry in this array is an array of integers. Each array
78 * of integers represents a sequence of tokens (by their ordinal
79 * values) that is expected at this point of the parse.
81 public int[][] expectedTokenSequences;
84 * This is a reference to the "tokenImage" array of the generated
85 * parser within which the parse error occurred. This array is
86 * defined in the generated ...Constants interface.
88 public String[] tokenImage;
91 * It uses "currentToken" and "expectedTokenSequences" to generate a parse
92 * error message and returns it. If this object has been created
93 * due to a parse error, and you do not catch it (it gets thrown
94 * from the parser) the correct error message
97 private static String initialise(Token currentToken,
98 int[][] expectedTokenSequences,
99 String[] tokenImage) {
100 String eol = System.getProperty("line.separator", "\n");
101 StringBuffer expected = new StringBuffer();
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 String retval = "Encountered \"";
116 Token tok = currentToken.next;
117 for (int i = 0; i < maxSize; i++) {
118 if (i != 0) retval += " ";
120 retval += tokenImage[0];
123 retval += " " + tokenImage[tok.kind];
125 retval += add_escapes(tok.image);
129 retval += "\" at line " + currentToken.next.beginLine + ", column " + currentToken.next.beginColumn;
131 if (expectedTokenSequences.length == 1) {
132 retval += "Was expecting:" + eol + " ";
134 retval += "Was expecting one of:" + eol + " ";
136 retval += expected.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
150 static String add_escapes(String str) {
151 StringBuffer retval = new StringBuffer();
153 for (int i = 0; i < str.length(); i++) {
154 switch (str.charAt(i))
159 retval.append("\\b");
162 retval.append("\\t");
165 retval.append("\\n");
168 retval.append("\\f");
171 retval.append("\\r");
174 retval.append("\\\"");
177 retval.append("\\\'");
180 retval.append("\\\\");
183 if ((ch = str.charAt(i)) < 0x20 || ch > 0x7e) {
184 String s = "0000" + Integer.toString(ch, 16);
185 retval.append("\\u" + s.substring(s.length() - 4, s.length()));
192 return retval.toString();
196 /* JavaCC - OriginalChecksum=b5c72bfd4ff9fc75f81dd38a03e24e8a (do not edit this line) */