1 /*
   2  * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 /* Generated By:JavaCC: Do not edit this line. ParseException.java Version 3.0 */
  26 package com.sun.xml.internal.rngom.parse.compact;
  27 
  28 /**
  29  * This exception is thrown when parse errors are encountered.
  30  * You can explicitly create objects of this exception type by
  31  * calling the method generateParseException in the generated
  32  * parser.
  33  *
  34  * You can modify this class to customize your error reporting
  35  * mechanisms so long as you retain the public fields.
  36  */
  37 public class ParseException extends Exception {
  38 
  39   /**
  40    * This constructor is used by the method "generateParseException"
  41    * in the generated parser.  Calling this constructor generates
  42    * a new object of this type with the fields "currentToken",
  43    * "expectedTokenSequences", and "tokenImage" set.  The boolean
  44    * flag "specialConstructor" is also set to true to indicate that
  45    * this constructor was used to create this object.
  46    * This constructor calls its super class with the empty string
  47    * to force the "toString" method of parent class "Throwable" to
  48    * print the error message in the form:
  49    *     ParseException: <result of getMessage>
  50    */
  51   public ParseException(Token currentTokenVal,
  52                         int[][] expectedTokenSequencesVal,
  53                         String[] tokenImageVal
  54                        )
  55   {
  56     super("");
  57     specialConstructor = true;
  58     currentToken = currentTokenVal;
  59     expectedTokenSequences = expectedTokenSequencesVal;
  60     tokenImage = tokenImageVal;
  61   }
  62 
  63   /**
  64    * The following constructors are for use by you for whatever
  65    * purpose you can think of.  Constructing the exception in this
  66    * manner makes the exception behave in the normal way - i.e., as
  67    * documented in the class "Throwable".  The fields "errorToken",
  68    * "expectedTokenSequences", and "tokenImage" do not contain
  69    * relevant information.  The JavaCC generated code does not use
  70    * these constructors.
  71    */
  72 
  73   public ParseException() {
  74     super();
  75     specialConstructor = false;
  76   }
  77 
  78   public ParseException(String message) {
  79     super(message);
  80     specialConstructor = false;
  81   }
  82 
  83   /**
  84    * This variable determines which constructor was used to create
  85    * this object and thereby affects the semantics of the
  86    * "getMessage" method (see below).
  87    */
  88   protected boolean specialConstructor;
  89 
  90   /**
  91    * This is the last token that has been consumed successfully.  If
  92    * this object has been created due to a parse error, the token
  93    * followng this token will (therefore) be the first error token.
  94    */
  95   public Token currentToken;
  96 
  97   /**
  98    * Each entry in this array is an array of integers.  Each array
  99    * of integers represents a sequence of tokens (by their ordinal
 100    * values) that is expected at this point of the parse.
 101    */
 102   public int[][] expectedTokenSequences;
 103 
 104   /**
 105    * This is a reference to the "tokenImage" array of the generated
 106    * parser within which the parse error occurred.  This array is
 107    * defined in the generated ...Constants interface.
 108    */
 109   public String[] tokenImage;
 110 
 111   /**
 112    * This method has the standard behavior when this object has been
 113    * created using the standard constructors.  Otherwise, it uses
 114    * "currentToken" and "expectedTokenSequences" to generate a parse
 115    * error message and returns it.  If this object has been created
 116    * due to a parse error, and you do not catch it (it gets thrown
 117    * from the parser), then this method is called during the printing
 118    * of the final stack trace, and hence the correct error message
 119    * gets displayed.
 120    */
 121   public String getMessage() {
 122     if (!specialConstructor) {
 123       return super.getMessage();
 124     }
 125     String expected = "";
 126     int maxSize = 0;
 127     for (int i = 0; i < expectedTokenSequences.length; i++) {
 128       if (maxSize < expectedTokenSequences[i].length) {
 129         maxSize = expectedTokenSequences[i].length;
 130       }
 131       for (int j = 0; j < expectedTokenSequences[i].length; j++) {
 132         expected += tokenImage[expectedTokenSequences[i][j]] + " ";
 133       }
 134       if (expectedTokenSequences[i][expectedTokenSequences[i].length - 1] != 0) {
 135         expected += "...";
 136       }
 137       expected += eol + "    ";
 138     }
 139     String retval = "Encountered \"";
 140     Token tok = currentToken.next;
 141     for (int i = 0; i < maxSize; i++) {
 142       if (i != 0) retval += " ";
 143       if (tok.kind == 0) {
 144         retval += tokenImage[0];
 145         break;
 146       }
 147       retval += add_escapes(tok.image);
 148       tok = tok.next;
 149     }
 150     retval += "\" at line " + currentToken.next.beginLine + ", column " + currentToken.next.beginColumn;
 151     retval += "." + eol;
 152     if (expectedTokenSequences.length == 1) {
 153       retval += "Was expecting:" + eol + "    ";
 154     } else {
 155       retval += "Was expecting one of:" + eol + "    ";
 156     }
 157     retval += expected;
 158     return retval;
 159   }
 160 
 161   /**
 162    * The end of line string for this machine.
 163    */
 164   protected String eol = System.getProperty("line.separator", "\n");
 165 
 166   /**
 167    * Used to convert raw characters to their escaped version
 168    * when these raw version cannot be used as part of an ASCII
 169    * string literal.
 170    */
 171   protected String add_escapes(String str) {
 172       StringBuffer retval = new StringBuffer();
 173       char ch;
 174       for (int i = 0; i < str.length(); i++) {
 175         switch (str.charAt(i))
 176         {
 177            case 0 :
 178               continue;
 179            case '\b':
 180               retval.append("\\b");
 181               continue;
 182            case '\t':
 183               retval.append("\\t");
 184               continue;
 185            case '\n':
 186               retval.append("\\n");
 187               continue;
 188            case '\f':
 189               retval.append("\\f");
 190               continue;
 191            case '\r':
 192               retval.append("\\r");
 193               continue;
 194            case '\"':
 195               retval.append("\\\"");
 196               continue;
 197            case '\'':
 198               retval.append("\\\'");
 199               continue;
 200            case '\\':
 201               retval.append("\\\\");
 202               continue;
 203            default:
 204               if ((ch = str.charAt(i)) < 0x20 || ch > 0x7e) {
 205                  String s = "0000" + Integer.toString(ch, 16);
 206                  retval.append("\\u" + s.substring(s.length() - 4, s.length()));
 207               } else {
 208                  retval.append(ch);
 209               }
 210               continue;
 211         }
 212       }
 213       return retval.toString();
 214    }
 215 
 216 }