ParseException.java
001 /* Generated By:JavaCC: Do not edit this line. ParseException.java Version 4.1 */
002 /* JavaCCOptions:KEEP_LINE_COL=null */
003 package net.sourceforge.pmd.lang.java.ast;
004 
005 /**
006  * This exception is thrown when parse errors are encountered.
007  * You can explicitly create objects of this exception type by
008  * calling the method generateParseException in the generated
009  * parser.
010  *
011  * You can modify this class to customize your error reporting
012  * mechanisms so long as you retain the public fields.
013  */
014 public class ParseException extends net.sourceforge.pmd.lang.ast.ParseException {
015 
016   /**
017    * This constructor is used by the method "generateParseException"
018    * in the generated parser.  Calling this constructor generates
019    * a new object of this type with the fields "currentToken",
020    * "expectedTokenSequences", and "tokenImage" set.  The boolean
021    * flag "specialConstructor" is also set to true to indicate that
022    * this constructor was used to create this object.
023    * This constructor calls its super class with the empty string
024    * to force the "toString" method of parent class "Throwable" to
025    * print the error message in the form:
026    *     ParseException: <result of getMessage>
027    */
028   public ParseException(Token currentTokenVal,
029                         int[][] expectedTokenSequencesVal,
030                         String[] tokenImageVal
031                        )
032   {
033     super("");
034     specialConstructor = true;
035     currentToken = currentTokenVal;
036     expectedTokenSequences = expectedTokenSequencesVal;
037     tokenImage = tokenImageVal;
038   }
039 
040   /**
041    * The following constructors are for use by you for whatever
042    * purpose you can think of.  Constructing the exception in this
043    * manner makes the exception behave in the normal way - i.e., as
044    * documented in the class "Throwable".  The fields "errorToken",
045    * "expectedTokenSequences", and "tokenImage" do not contain
046    * relevant information.  The JavaCC generated code does not use
047    * these constructors.
048    */
049 
050   public ParseException() {
051     super();
052     specialConstructor = false;
053   }
054 
055   /** Constructor with message. */
056   public ParseException(String message) {
057     super(message);
058     specialConstructor = false;
059   }
060 
061   /**
062    * This variable determines which constructor was used to create
063    * this object and thereby affects the semantics of the
064    * "getMessage" method (see below).
065    */
066   protected boolean specialConstructor;
067 
068   /**
069    * This is the last token that has been consumed successfully.  If
070    * this object has been created due to a parse error, the token
071    * followng this token will (therefore) be the first error token.
072    */
073   public Token currentToken;
074 
075   /**
076    * Each entry in this array is an array of integers.  Each array
077    * of integers represents a sequence of tokens (by their ordinal
078    * values) that is expected at this point of the parse.
079    */
080   public int[][] expectedTokenSequences;
081 
082   /**
083    * This is a reference to the "tokenImage" array of the generated
084    * parser within which the parse error occurred.  This array is
085    * defined in the generated ...Constants interface.
086    */
087   public String[] tokenImage;
088 
089   /**
090    * This method has the standard behavior when this object has been
091    * created using the standard constructors.  Otherwise, it uses
092    * "currentToken" and "expectedTokenSequences" to generate a parse
093    * error message and returns it.  If this object has been created
094    * due to a parse error, and you do not catch it (it gets thrown
095    * from the parser), then this method is called during the printing
096    * of the final stack trace, and hence the correct error message
097    * gets displayed.
098    */
099   public String getMessage() {
100     if (!specialConstructor) {
101       return super.getMessage();
102     }
103     StringBuffer expected = new StringBuffer();
104     int maxSize = 0;
105     for (int i = 0; i < expectedTokenSequences.length; i++) {
106       if (maxSize < expectedTokenSequences[i].length) {
107         maxSize = expectedTokenSequences[i].length;
108       }
109       for (int j = 0; j < expectedTokenSequences[i].length; j++) {
110         expected.append(tokenImage[expectedTokenSequences[i][j]]).append(' ');
111       }
112       if (expectedTokenSequences[i][expectedTokenSequences[i].length - 1!= 0) {
113         expected.append("...");
114       }
115       expected.append(eol).append("    ");
116     }
117     String retval = "Encountered \"";
118     Token tok = currentToken.next;
119     for (int i = 0; i < maxSize; i++) {
120       if (i != 0retval += " ";
121       if (tok.kind == 0) {
122         retval += tokenImage[0];
123         break;
124       }
125       retval += " " + tokenImage[tok.kind];
126       retval += " \"";
127       retval += add_escapes(tok.image);
128       retval += " \"";
129       tok = tok.next;
130     }
131     retval += "\" at line " + currentToken.next.beginLine + ", column " + currentToken.next.beginColumn;
132     retval += "." + eol;
133     if (expectedTokenSequences.length == 1) {
134       retval += "Was expecting:" + eol + "    ";
135     else {
136       retval += "Was expecting one of:" + eol + "    ";
137     }
138     retval += expected.toString();
139     return retval;
140   }
141 
142   /**
143    * The end of line string for this machine.
144    */
145   protected String eol = System.getProperty("line.separator""\n");
146 
147   /**
148    * Used to convert raw characters to their escaped version
149    * when these raw version cannot be used as part of an ASCII
150    * string literal.
151    */
152   protected String add_escapes(String str) {
153       StringBuffer retval = new StringBuffer();
154       char ch;
155       for (int i = 0; i < str.length(); i++) {
156         switch (str.charAt(i))
157         {
158            case :
159               continue;
160            case '\b':
161               retval.append("\\b");
162               continue;
163            case '\t':
164               retval.append("\\t");
165               continue;
166            case '\n':
167               retval.append("\\n");
168               continue;
169            case '\f':
170               retval.append("\\f");
171               continue;
172            case '\r':
173               retval.append("\\r");
174               continue;
175            case '\"':
176               retval.append("\\\"");
177               continue;
178            case '\'':
179               retval.append("\\\'");
180               continue;
181            case '\\':
182               retval.append("\\\\");
183               continue;
184            default:
185               if ((ch = str.charAt(i)) 0x20 || ch > 0x7e) {
186                  String s = "0000" + Integer.toString(ch, 16);
187                  retval.append("\\u" + s.substring(s.length() 4, s.length()));
188               else {
189                  retval.append(ch);
190               }
191               continue;
192         }
193       }
194       return retval.toString();
195    }
196 
197 }
198 /* JavaCC - OriginalChecksum=a63a6feef75bb2f43f87818b3b26b2af (do not edit this line) */