lucene-java-3.5.0/lucene/contrib/queryparser/src/java/org/apache/lucene/queryParser/standard/parser/ParseException.java

   1 /* Generated By:JavaCC: Do not edit this line. ParseException.java Version 4.1 */
   2 /* JavaCCOptions:KEEP_LINE_COL=null */
   3 package org.apache.lucene.queryParser.standard.parser;
   4
   5  import org.apache.lucene.messages.Message;
   6  import org.apache.lucene.messages.MessageImpl;
   7  import org.apache.lucene.queryParser.core.*;
   8  import org.apache.lucene.queryParser.core.messages.*;
   9
  10 /**
  11  * This exception is thrown when parse errors are encountered.
  12  * You can explicitly create objects of this exception type by
  13  * calling the method generateParseException in the generated
  14  * parser.
  15  *
  16  * You can modify this class to customize your error reporting
  17  * mechanisms so long as you retain the public fields.
  18  */
  19 public class ParseException extends QueryNodeParseException {
  20
  21   /**
  22    * This constructor is used by the method "generateParseException"
  23    * in the generated parser.  Calling this constructor generates
  24    * a new object of this type with the fields "currentToken",
  25    * "expectedTokenSequences", and "tokenImage" set.  The boolean
  26    * flag "specialConstructor" is also set to true to indicate that
  27    * this constructor was used to create this object.
  28    * This constructor calls its super class with the empty string
  29    * to force the "toString" method of parent class "Throwable" to
  30    * print the error message in the form:
  31    *     ParseException: <result of getMessage>
  32    */
  33   public ParseException(Token currentTokenVal,
  34      int[][] expectedTokenSequencesVal, String[] tokenImageVal) {
  35      super(new MessageImpl(QueryParserMessages.INVALID_SYNTAX, initialise(
  36      currentTokenVal, expectedTokenSequencesVal, tokenImageVal)));
  37      this.currentToken = currentTokenVal;
  38      this.expectedTokenSequences = expectedTokenSequencesVal;
  39      this.tokenImage = tokenImageVal;
  40    }
  41
  42   /**
  43    * The following constructors are for use by you for whatever
  44    * purpose you can think of.  Constructing the exception in this
  45    * manner makes the exception behave in the normal way - i.e., as
  46    * documented in the class "Throwable".  The fields "errorToken",
  47    * "expectedTokenSequences", and "tokenImage" do not contain
  48    * relevant information.  The JavaCC generated code does not use
  49    * these constructors.
  50    */
  51
  52   public ParseException() {
  53      super(new MessageImpl(QueryParserMessages.INVALID_SYNTAX, "Error"));
  54    }
  55
  56   /** Constructor with message. */
  57   public ParseException(Message message) {
  58      super(message);
  59                          }
  60
  61   /**
  62    * This variable determines which constructor was used to create
  63    * this object and thereby affects the semantics of the
  64    * "getMessage" method (see below).
  65    */
  66   protected boolean specialConstructor;
  67
  68   /**
  69    * This is the last token that has been consumed successfully.  If
  70    * this object has been created due to a parse error, the token
  71    * followng this token will (therefore) be the first error token.
  72    */
  73   public Token currentToken;
  74
  75   /**
  76    * Each entry in this array is an array of integers.  Each array
  77    * of integers represents a sequence of tokens (by their ordinal
  78    * values) that is expected at this point of the parse.
  79    */
  80   public int[][] expectedTokenSequences;
  81
  82   /**
  83    * This is a reference to the "tokenImage" array of the generated
  84    * parser within which the parse error occurred.  This array is
  85    * defined in the generated ...Constants interface.
  86    */
  87   public String[] tokenImage;
  88
  89   /**
  90    * This method has the standard behavior when this object has been
  91    * created using the standard constructors.  Otherwise, it uses
  92    * "currentToken" and "expectedTokenSequences" to generate a parse
  93    * error message and returns it.  If this object has been created
  94    * due to a parse error, and you do not catch it (it gets thrown
  95    * from the parser), then this method is called during the printing
  96    * of the final stack trace, and hence the correct error message
  97    * gets displayed.
  98    */
  99   private static String initialise(Token currentToken, int[][] expectedTokenSequences, String[] tokenImage) {
 100      String eol = System.getProperty("line.separator", "n");
 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;
 106       }
 107       for (int j = 0; j < expectedTokenSequences[i].length; j++) {
 108         expected.append(tokenImage[expectedTokenSequences[i][j]]).append(' ');
 109       }
 110       if (expectedTokenSequences[i][expectedTokenSequences[i].length - 1] != 0) {
 111         expected.append("...");
 112       }
 113       expected.append(eol).append("    ");
 114     }
 115     String retval = "Encountered \"";
 116     Token tok = currentToken.next;
 117     for (int i = 0; i < maxSize; i++) {
 118       if (i != 0) retval += " ";
 119       if (tok.kind == 0) {
 120         retval += tokenImage[0];
 121         break;
 122       }
 123       retval += " " + tokenImage[tok.kind];
 124       retval += " \"";
 125       retval += add_escapes(tok.image);
 126       retval += " \"";
 127       tok = tok.next;
 128     }
 129     retval += "\" at line " + currentToken.next.beginLine + ", column " + currentToken.next.beginColumn;
 130     retval += "." + eol;
 131     if (expectedTokenSequences.length == 1) {
 132       retval += "Was expecting:" + eol + "    ";
 133     } else {
 134       retval += "Was expecting one of:" + eol + "    ";
 135     }
 136     retval += expected.toString();
 137     return retval;
 138   }
 139
 140   /**
 141    * The end of line string for this machine.
 142    */
 143   protected String eol = System.getProperty("line.separator", "\n");
 144
 145   /**
 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.
 149    */
 150   static private 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))
 155         {
 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" + s.substring(s.length() - 4, s.length()));
 186               } else {
 187                  retval.append(ch);
 188               }
 189               continue;
 190         }
 191       }
 192       return retval.toString();
 193    }
 194
 195 }
 196 /* JavaCC - OriginalChecksum=38bce846fe6c8482993969f741c0323e (do not edit this line) */