analyses/org.eclipse.tracecompass.incubator.filters.core/src/org/eclipse/tracecompass/incubator/internal/filters/core/server/FilterValidation.java

/*******************************************************************************
 * Copyright (c) 2019 École Polytechnique de Montréal
 *
 * All rights reserved. This program and the accompanying materials are
 * made available under the terms of the Eclipse Public License 2.0 which
 * accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *******************************************************************************/

package org.eclipse.tracecompass.incubator.internal.filters.core.server;

import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.util.ArrayList;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import java.util.Stack;

import org.antlr.runtime.ANTLRInputStream;
import org.antlr.runtime.CommonTokenStream;
import org.antlr.runtime.EarlyExitException;
import org.antlr.runtime.MismatchedNotSetException;
import org.antlr.runtime.MismatchedRangeException;
import org.antlr.runtime.MismatchedSetException;
import org.antlr.runtime.MismatchedTokenException;
import org.antlr.runtime.NoViableAltException;
import org.antlr.runtime.RecognitionException;
import org.antlr.runtime.tree.CommonErrorNode;
import org.antlr.runtime.tree.CommonTree;
import org.eclipse.lsp4j.Diagnostic;
import org.eclipse.lsp4j.Position;
import org.eclipse.lsp4j.Range;
import org.eclipse.tracecompass.tmf.filter.parser.FilterParserLexer;
import org.eclipse.tracecompass.tmf.filter.parser.FilterParserParser;
import org.eclipse.tracecompass.tmf.filter.parser.FilterParserParser.parse_return;

/**
 * Validates the user input with antlr and detects where the errors are in the
 * string
 *
 * @author Maxime Thibault
 * @author David-Alexandre Beaupre
 * @author Remi Croteau
 *
 */
public class FilterValidation {

    /**
     * Get the range of the error for the smallest expression possible
     *
     * @param tree
     *            is the representation of full expression entered by the user
     * @param startIndex
     *            is whether we want the start or the end of the simple
     *            expression
     * @return
     */
    static private int getErrorStartEndIndex(CommonTree tree, boolean startIndex) {
        Stack<CommonTree> treeStack = new Stack<>();
        treeStack.push(tree);
        CommonTree currentTree = null;
        // Depth first search of the tree of the full expression to find the
        // smallest expression with the error
        while (!treeStack.isEmpty()) {
            currentTree = treeStack.pop();
            int childCount = currentTree.getChildCount();
            // push all children of the current tree node
            for (int i = childCount - 1; i >= 0; i--) {
                treeStack.push((CommonTree) currentTree.getChild(i));
            }
            // we are only interested in error nodes to find their position
            if (currentTree instanceof CommonErrorNode) {
                if (startIndex) {
                    int start = ((CommonErrorNode) currentTree).start.getCharPositionInLine();
                    return start;
                }
                int stop = ((CommonErrorNode) currentTree).stop.getCharPositionInLine();
                return stop;
            }
        }
        return -1;
    }

    /**
     * Detects all the errors in the input string (if any) and return those as
     * diagnostics
     *
     * @param str
     *            is the content of the filter box
     * @return diagnostics is a list containing all the errors found by the
     *         parser and lexer
     * @throws IOException
     *             from the InputStream
     * @throws RecognitionException
     *             from the ANTLR parser or lexer
     */
    @SuppressWarnings("restriction")
    public static List<Diagnostic> validate(String str) throws IOException, RecognitionException {
        // Initialize the lexerParser, parse str and return list of CommonToken
        ByteArrayInputStream input = new ByteArrayInputStream(str.getBytes());
        ANTLRInputStream antlrStream = new ANTLRInputStream(input);

        FilterParserLexer lexer = new FilterParserLexer(antlrStream);
        ArrayList<RecognitionException> lexerExceptions = new ArrayList<>();
        lexer.setErrorListener(e -> {
            lexerExceptions.add((RecognitionException) e);
        });
        CommonTokenStream tokenStream = new CommonTokenStream(lexer);

        FilterParserParser parser = new FilterParserParser(tokenStream);
        ArrayList<RecognitionException> parserExceptions = new ArrayList<>();
        parser.setErrorListener(e -> {
            parserExceptions.add((RecognitionException) e);
        });

        parse_return parse = parser.parse();
        CommonTree tree = parse.getTree();

        List<Diagnostic> diagnostics = new ArrayList<>();

        lexerExceptions.forEach(e -> {
            String message = lexer.getErrorMessage(e, lexer.getTokenNames());
            Range range = getRangeFromException(e, str, tree);
            Diagnostic diagnostic = new Diagnostic(range, message);
            diagnostics.add(diagnostic);
        });

        parserExceptions.forEach(e -> {
            String message = parser.getErrorMessage(e, parser.getTokenNames());
            Range range = getRangeFromException(e, str, tree);
            Diagnostic diagnostic = new Diagnostic(range, message);
            diagnostics.add(diagnostic);
        });

        return preprocessDiagnostics(diagnostics);

    }

    /**
     * Handler to find the appropriate range of error in the exception
     *
     * @see org.antlr.runtime.Lexer#getErrorMessage(RecognitionException e,
     *      String[] tokenNames) /
     * @param e
     *            The RecognitionException thrown by antlr
     * @param msg
     *            The input string to validate
     * @return Range of error to be used in diagnostic
     */
    private static Range getRangeFromException(RecognitionException e, String msg, CommonTree tree) {

        int lineStart = 0;
        int lineEnd = 0;
        int offsetStart = 0;
        int offsetEnd = 0;

        if (e instanceof MismatchedTokenException) {
            // @see:
            // https://www.antlr3.org/api/Java/org/antlr/runtime/MismatchedTokenException.html
            offsetStart = getErrorStartEndIndex(tree, false);
            offsetEnd = msg.length();
            // if we do not find stop error index, this means that the error is
            // an
            // unknown operator, so we use the index to find its position
            if (offsetStart == -1) {
                offsetStart = e.index - 1;
                offsetEnd = e.index;
            }
        } else if (e instanceof NoViableAltException) {
            // @see:
            // https://www.antlr3.org/api/Java/org/antlr/runtime/NoViableAltException.html
            offsetStart = getErrorStartEndIndex(tree, true);
            offsetEnd = msg.length();
        } else if (e instanceof EarlyExitException) {
            // @see:
            // https://www.antlr3.org/api/Java/org/antlr/runtime/EarlyExitException.html
            // Just keep the initialized value.
            // We know that this exception triggers with the string "". Still,
            // we don't know if we should take care of this..
        } else if (e instanceof MismatchedNotSetException) {
            // @see:
            // https://www.antlr3.org/api/Java/org/antlr/runtime/MismatchedNotSetException.html
            // No known case of this exception happening..
        } else if (e instanceof MismatchedSetException) {
            // @see:
            // https://www.antlr3.org/api/Java/org/antlr/runtime/MismatchedSetException.html
            // No known case of this exception happening..
        } else if (e instanceof MismatchedRangeException) {
            // @see:
            // https://www.antlr3.org/api/Java/org/antlr/runtime/MismatchedRangeException.html
            // No known case of this exception happening..
        } else {
            // Any other exception..
        }

        Position start = new Position(lineStart, offsetStart);
        Position end = new Position(lineEnd, offsetEnd);
        return new Range(start, end);
    }

    /**
     * Remove duplicated error from list of diagnostics
     *
     * @param diagnostics
     */
    private static List<Diagnostic> preprocessDiagnostics(List<Diagnostic> diagnostics) {
        List<Diagnostic> newDiagnostics = new ArrayList<>();
        Set<Diagnostic> uniqueDiagnostics = new HashSet<>();

        uniqueDiagnostics.addAll(diagnostics);
        newDiagnostics.addAll(uniqueDiagnostics);

        return newDiagnostics;
    }

}