bundles/org.simantics.databoard/src/org/simantics/databoard/parser/ParseException.java

   1 /*******************************************************************************
   2  *  Copyright (c) 2010 Association for Decentralized Information Management in
   3  *  Industry THTH ry.
   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
   8  *
   9  *  Contributors:
  10  *      VTT Technical Research Centre of Finland - initial API and implementation
  11  *******************************************************************************/
  12 package org.simantics.databoard.parser;
  13
  14 /**
  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
  18  * parser.
  19  *
  20  * You can modify this class to customize your error reporting
  21  * mechanisms so long as you retain the public fields.
  22  */
  23 public class ParseException extends Exception {
  24
  25   /**
  26    * The version identifier for this Serializable class.
  27    * Increment only if the <i>serialized</i> form of the
  28    * class changes.
  29    */
  30   private static final long serialVersionUID = 1L;
  31
  32   /**
  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.
  37    */
  38   public ParseException(Token currentTokenVal,
  39                         int[][] expectedTokenSequencesVal,
  40                         String[] tokenImageVal
  41                        )
  42   {
  43     super(initialise(currentTokenVal, expectedTokenSequencesVal, tokenImageVal));
  44     currentToken = currentTokenVal;
  45     expectedTokenSequences = expectedTokenSequencesVal;
  46     tokenImage = tokenImageVal;
  47   }
  48
  49   /**
  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
  56    * these constructors.
  57    */
  58
  59   public ParseException() {
  60     super();
  61   }
  62
  63   /** Constructor with message. */
  64   public ParseException(String message) {
  65     super(message);
  66   }
  67
  68
  69   /**
  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.
  73    */
  74   public Token currentToken;
  75
  76   /**
  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.
  80    */
  81   public int[][] expectedTokenSequences;
  82
  83   /**
  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.
  87    */
  88   public String[] tokenImage;
  89
  90   /**
  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
  95    * gets displayed.
  96    */
  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();
 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 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=b5c72bfd4ff9fc75f81dd38a03e24e8a (do not edit this line) */