org.beetl.core.parser.BeetlAntlrErrorStrategy.java Source code

Java tutorial

Introduction

Here is the source code for org.beetl.core.parser.BeetlAntlrErrorStrategy.java

Source

/*
 [The "BSD license"]
 Copyright (c) 2011-2014 Joel Li (?)
 All rights reserved.
    
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions
 are met:
 1. Redistributions of source code must retain the above copyright
 notice, this list of conditions and the following disclaimer.
 2. Redistributions in binary form must reproduce the above copyright
 notice, this list of conditions and the following disclaimer in the
 documentation and/or other materials provided with the distribution.
 3. The name of the author may not be used to endorse or promote products
 derived from this software without specific prior written permission.
    
 THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package org.beetl.core.parser;

import org.antlr.v4.runtime.DefaultErrorStrategy;
import org.antlr.v4.runtime.FailedPredicateException;
import org.antlr.v4.runtime.InputMismatchException;
import org.antlr.v4.runtime.NoViableAltException;
import org.antlr.v4.runtime.Parser;
import org.antlr.v4.runtime.RecognitionException;
import org.antlr.v4.runtime.Token;
import org.antlr.v4.runtime.TokenStream;
import org.antlr.v4.runtime.misc.IntervalSet;
import org.antlr.v4.runtime.misc.NotNull;
import org.beetl.core.exception.BeetlException;
import org.beetl.core.exception.BeetlParserException;
import org.beetl.core.statement.GrammarToken;

/**
 * antlr ???
 * @author joelli
 *
 */
public class BeetlAntlrErrorStrategy extends DefaultErrorStrategy {
    @Override
    public void recover(Parser recognizer, RecognitionException e) {

        //?report
        super.recover(recognizer, e);
    }

    @Override
    public void reportError(Parser recognizer, RecognitionException e) {
        // if we've already reported an error and have not matched a token
        // yet successfully, don't report any errors.
        if (inErrorRecoveryMode(recognizer)) {
            //         System.err.print("[SPURIOUS] ");
            return; // don't report spurious errors
        }
        beginErrorCondition(recognizer);
        if (e instanceof NoViableAltException) {
            reportNoViableAlternative(recognizer, (NoViableAltException) e);
        } else if (e instanceof InputMismatchException) {
            reportInputMismatch(recognizer, (InputMismatchException) e);
        } else if (e instanceof FailedPredicateException) {
            reportFailedPredicate(recognizer, (FailedPredicateException) e);
        } else {
            //         System.err.println("unknown recognition error type: " + e.getClass().getName());
            BeetlException exception = new BeetlException(BeetlException.PARSER_UNKNOW_ERROR,
                    e.getClass().getName(), e);
            exception.token = this.getGrammarToken(e.getOffendingToken());
            throw exception;
        }
    }

    protected void reportNoViableAlternative(@NotNull Parser recognizer, @NotNull NoViableAltException e) {
        TokenStream tokens = recognizer.getInputStream();
        String input;
        if (tokens instanceof TokenStream) {
            if (e.getStartToken().getType() == Token.EOF)
                input = "<>";
            else
                input = tokens.getText(e.getStartToken(), e.getOffendingToken());
        } else {
            input = "<>";
        }
        //      String msg = "no viable alternative at input " + escapeWSAndQuote(input);
        BeetlException exception = new BeetlParserException(BeetlException.PARSER_VIABLE_ERROR,
                escapeWSAndQuote(input), e);
        exception.token = this.getGrammarToken(e.getOffendingToken());
        throw exception;
    }

    protected void reportInputMismatch(@NotNull Parser recognizer, @NotNull InputMismatchException e) {
        String msg = " " + getTokenErrorDisplay(e.getOffendingToken()) + "  "
                + e.getExpectedTokens().toString(recognizer.getTokenNames());
        BeetlException exception = new BeetlParserException(BeetlException.PARSER_MISS_ERROR, msg, e);
        exception.token = this.getGrammarToken(e.getOffendingToken());
        throw exception;

    }

    protected void reportFailedPredicate(@NotNull Parser recognizer, @NotNull FailedPredicateException e) {
        String ruleName = recognizer.getRuleNames()[recognizer.getContext().getRuleIndex()];
        BeetlException exception = new BeetlParserException(BeetlException.PARSER_PREDICATE_ERROR, ruleName, e);
        exception.token = this.getGrammarToken(e.getOffendingToken());
        throw exception;
    }

    /** Make sure we don't attempt to recover from problems in subrules. */
    @Override
    public void sync(Parser recognizer) {
    }

    /** Make sure we don't attempt to recover inline; if the parser
    * successfully recovers, it won't throw an exception.
    */
    @Override
    public Token recoverInline(Parser recognizer) throws RecognitionException {
        // SINGLE TOKEN DELETION
        Token matchedSymbol = singleTokenDeletion(recognizer);
        if (matchedSymbol != null) {
            // we have deleted the extra token.
            // now, move past ttype token as if all were ok
            recognizer.consume();
            return matchedSymbol;
        }

        // SINGLE TOKEN INSERTION
        if (singleTokenInsertion(recognizer)) {
            return getMissingSymbol(recognizer);
        }

        // even that didn't work; must throw the exception

        BeetlException exception = new BeetlParserException(BeetlException.PARSER_MISS_ERROR);
        exception.token = this.getGrammarToken(recognizer.getCurrentToken());
        throw exception;
        //      
        //      throw new InputMismatchException(recognizer);
    }

    protected void reportMissingToken(@NotNull Parser recognizer) {
        if (inErrorRecoveryMode(recognizer)) {
            return;
        }

        beginErrorCondition(recognizer);

        Token t = recognizer.getCurrentToken();
        IntervalSet expecting = getExpectedTokens(recognizer);
        String msg = " " + expecting.toString(recognizer.getTokenNames()) + "  "
                + getTokenErrorDisplay(t);

        BeetlException exception = new BeetlParserException(BeetlException.PARSER_MISS_ERROR, msg);
        exception.token = this.getGrammarToken(t);
        throw exception;
    }

    protected void reportUnwantedToken(@NotNull Parser recognizer) {
        if (inErrorRecoveryMode(recognizer)) {
            return;
        }

        beginErrorCondition(recognizer);

        Token t = recognizer.getCurrentToken();
        String tokenName = getTokenErrorDisplay(t);
        IntervalSet expecting = getExpectedTokens(recognizer);
        String msg = " " + tokenName + "  " + expecting.toString(recognizer.getTokenNames());
        BeetlException exception = new BeetlParserException(BeetlException.PARSER_MISS_ERROR, msg);
        exception.token = this.getGrammarToken(t);
        throw exception;
    }

    protected GrammarToken getGrammarToken(Token token) {
        return GrammarToken.createToken(token.getText(), token.getLine());
    }

}