TokenMgrError.java

/* Generated By:JavaCC: Do not edit this line. TokenMgrError.java Version 8.1.0 */
/*
 * Copyright (c) 2022, 2026 Eclipse Foundation
 * Copyright (C) 2004-2011
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package com.sun.tools.rngom.parse.compact;

/** 
 * The class generated by JavaCC/java (by JavaCodeGenerator.java with java/TokenMgrError.template)
 *  that is used when TokenManager exceptions (if LEGACY_EXCEPTION_HANDLING option is false)
 *  or errors (if LEGACY_EXCEPTION_HANDLING option is true) are encountered.<br>
 */
public class TokenMgrError extends Error {

  /**
   * The version identifier for this Serializable class.<br>
   * Increment only if the <i>serialized</i> form of the class changes.
   */
  private static final long serialVersionUID = 1L;

  /*
   * Ordinals for various reasons why an Error of this type can be thrown.
   */

  /**
   * Lexical error occurred.
   */
  public static final int LEXICAL_ERROR = 0;

  /**
   * An attempt was made to create a second instance of a static token manager.
   */
  public static final int STATIC_LEXER_ERROR = 1;

  /**
   * Tried to change to an invalid lexical state.
   */
  public static final int INVALID_LEXICAL_STATE = 2;

  /**
   * Detected (and bailed out of) an infinite loop in the token manager.
   */
  public static final int LOOP_DETECTED = 3;

  /**
   * Indicates the reason why the exception is thrown. It will have one of the above 4 values.
   */
  int errorCode;

  /**
   * Replaces unprintable characters by their escaped (or unicode escaped)
   * equivalents in the given string.
   */
  protected static final String addEscapes(String str) {
    StringBuilder retval = new StringBuilder();
    char ch;
    for (int i = 0; i < str.length(); i++) {
      switch (str.charAt(i)) {
        case '\b':
          retval.append("\\b");
          continue;
        case '\t':
          retval.append("\\t");
          continue;
        case '\n':
          retval.append("\\n");
          continue;
        case '\f':
          retval.append("\\f");
          continue;
        case '\r':
          retval.append("\\r");
          continue;
        case '\"':
          retval.append("\\\"");
          continue;
        case '\'':
          retval.append("\\\'");
          continue;
        case '\\':
          retval.append("\\\\");
          continue;
        default:
          if ((ch = str.charAt(i)) < 0x20 || ch > 0x7e) {
            String s = "0000" + Integer.toString(ch, 16);
            retval.append("\\u" + s.substring(s.length() - 4, s.length()));
          } else {
            retval.append(ch);
          }
          continue;
      }
    }
    return retval.toString();
  }

  /**
   * Returns a detailed message for the Error when it is thrown by the token manager
   *  to indicate a lexical error.<br>
   * Note: You can customize the lexical error message by modifying this method.
   *
   * @param eofSeen - true if EOF caused the lexical error
   * @param lexState - lexical state in which this error occurred
   * @param errorLine - line number when the error occurred
   * @param errorColumn - column number when the error occurred
   * @param errorAfter - prefix that was seen before this error occurred
   * @param curChar - the offending character
   */
  protected static String LexicalErr(boolean eofSeen, int lexState, int errorLine,
      int errorColumn, String errorAfter, int curChar) {
    char cc = (char) curChar;
    return ("Lexical error at line " + errorLine + ", column " + errorColumn + ".  Encountered: " +
            (eofSeen ? "<EOF>"
                     : ("\"" + addEscapes(String.valueOf(cc)) + "\"") + " (" + curChar + ")") +
            " after: \"" + addEscapes(errorAfter) + "\"");
  }

  /**
   * You can also modify the body of this method to customize your error messages.
   * For example, cases like LOOP_DETECTED and INVALID_LEXICAL_STATE are not
   * of end-users concern, so you can return something like :
   *
   * <p>"Internal Error : Please file a bug report .... "
   *
   * <p>from this method for such cases in the release version of your parser.
   */
  @Override
  public String getMessage() {
    return super.getMessage();
  }

  /** No arg constructor. */
  public TokenMgrError() {
  }

  /** Constructor with message and reason. */
  public TokenMgrError(String message, int reason) {
    super(message);
    errorCode = reason;
  }

  /** Full Constructor. */
  public TokenMgrError(boolean eofSeen,
      int lexState, int errorLine, int errorColumn, String errorAfter, int curChar, int reason) {
    this(LexicalErr(eofSeen, lexState, errorLine, errorColumn, errorAfter, curChar), reason);
  }
  
}
/* JavaCC - OriginalChecksum=ad27a66ec2d436739177dab1c3641cc4 (do not edit this line) */