plugins/org.eclipse.datatools.sqltools.sql/src/org/eclipse/datatools/sqltools/sql/parser/TokenMgrError.java

/*******************************************************************************
 * Copyright (c) 2004, 2005 Sybase, Inc. and others.
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     Sybase, Inc. - initial API and implementation
 *******************************************************************************/
package org.eclipse.datatools.sqltools.sql.parser;


public class TokenMgrError extends Error
{

    /**
	 * 
	 */
	private static final long serialVersionUID = -3740423667639691370L;

    /*
     * Ordinals for various reasons why an Error of this type can be thrown.
     */
	/**
     * Lexical error occured.
     */
    public static final int LEXICAL_ERROR         = 0;

    /**
     * An attempt wass 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.
     */
    public int              errorCode;

    private Token           _token;

    /**
     * Replaces unprintable characters by their espaced (or unicode escaped) equivalents in the given string
     */
    public static final String addEscapes(String str)
    {
        StringBuffer retval = new StringBuffer();
        char ch;
        for (int i = 0; i < str.length(); i++)
        {
            switch (str.charAt(i))
            {
                case 0:
                    continue;
                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.
     * Parameters : EOFSeen : indicates if EOF caused the lexicl error curLexState : lexical state in which this error
     * occured errorLine : line number when the error occured errorColumn : column number when the error occured
     * errorAfter : prefix that was seen before this error occured curchar : the offending character Note: You can
     * customize the lexical error message by modifying this method.
     */
    public static String LexicalError(boolean EOFSeen, int lexState, int errorLine, int errorColumn, String errorAfter,
        char curChar)
    {
        Object[] args = new Object[]
        {
            String.valueOf(errorLine),
                String.valueOf(errorColumn),
                (EOFSeen ? Messages.getString("TokenMgrError.eof") : Messages.getString("TokenMgrError.currentchar", addEscapes(String.valueOf(curChar)), String.valueOf((int) curChar))),
                addEscapes(errorAfter)
        }
        ;
        return (Messages.getString("TokenMgrError.lexical.error", args));
    }

    /**
     * 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 :
     * 
     * "Internal Error : Please file a bug report .... "
     * 
     * from this method for such cases in the release version of your parser.
     */
    public String getMessage()
    {
        return super.getMessage();
    }

    /*
     * Constructors of various flavors follow.
     */

    public TokenMgrError()
    {
    }

    public TokenMgrError(String message, int reason)
    {
        super(message);
        errorCode = reason;
    }

    public TokenMgrError(boolean EOFSeen, int lexState, int errorLine, int errorColumn, String errorAfter,
        char curChar, int reason)
    {
        this(LexicalError(EOFSeen, lexState, errorLine, errorColumn, errorAfter, curChar), reason);
        _token = new Token();
        _token.beginLine = errorLine;
        _token.beginColumn = errorColumn;
        _token.endLine = errorLine;
        _token.endColumn = errorColumn + 1;
    }

    public Token getToken()
    {
        return _token;
    }
}