org.netbeans.modules.languages.antlr.AntlrParserResult Maven / Gradle / Ivy

Go to download
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.netbeans.modules.languages.antlr;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.TreeMap;
import org.antlr.v4.runtime.ANTLRErrorListener;
import org.antlr.v4.runtime.BaseErrorListener;
import org.antlr.v4.runtime.Parser;
import org.antlr.v4.runtime.RecognitionException;
import org.antlr.v4.runtime.Recognizer;
import org.antlr.v4.runtime.Token;
import org.antlr.v4.runtime.tree.ParseTreeListener;
import org.netbeans.modules.csl.api.Error;
import org.netbeans.modules.csl.api.OffsetRange;
import org.netbeans.modules.csl.api.Severity;
import org.netbeans.modules.csl.spi.DefaultError;
import org.netbeans.modules.csl.spi.ParserResult;
import org.netbeans.modules.parsing.api.Snapshot;
import org.openide.filesystems.FileObject;

/**
 *
 * @author lkishalmi
 */
public abstract class AntlrParserResult extends ParserResult {

    public enum GrammarType {
        UNKNOWN, LEXER, PARSER, MIXED, TREE;
    }
    
    protected GrammarType grammarType = GrammarType.UNKNOWN;
    
    public final List errors = new ArrayList<>();
    public final Map references = new TreeMap<>();
    public final Map> occurrences = new HashMap<>();

    public final List folds = new ArrayList<>();
    public final List structure = new ArrayList<>();

    volatile boolean finished = false;

    public static final Reference EOF = new Reference(ReferenceType.TOKEN, "EOF", OffsetRange.NONE); //NOI18N
    
    public AntlrParserResult(Snapshot snapshot) {
        super(snapshot);
        
        references.put(EOF.name, EOF);
        
    }

    public AntlrParserResult get() {
        if (! finished) {
            T parser = createParser(getSnapshot());
            parser.addErrorListener(createErrorListener());
            parser.addParseListener(createFoldListener());
            parser.addParseListener(createReferenceListener());
            parser.addParseListener(createImportListener());
            parser.addParseListener(createStructureListener());
            parser.addParseListener(createOccurancesListener());
            evaluateParser(parser);

            finished = true;
        }
        return this;
    }

    @Override
    public List getDiagnostics() {
        return errors;
    }

    @Override
    protected void invalidate() {
        //references.clear();
    }

    @Override
    protected boolean processingFinished() {
        return finished;
    }

    public final GrammarType getGrammarType() {
        return grammarType;
    }

    public enum ReferenceType {
        FRAGMENT, TOKEN, RULE, CHANNEL, MODE
    }
    
    public static class Reference {
        public final ReferenceType type;
        public final String name;
        public final OffsetRange defOffset;

        public Reference(ReferenceType type, String name, OffsetRange defOffset) {
            this.type = type;
            this.name = name;
            this.defOffset = defOffset;
        }
    }

    protected final FileObject getFileObject() {
        return getSnapshot().getSource().getFileObject();
    }
    
    public final List getOccurrences(String refName) {
        ArrayList ret = new ArrayList<>();
        if (references.containsKey(refName)) {
            ret.add(references.get(refName).defOffset);
        }
        if (occurrences.containsKey(refName)) {
            ret.addAll(occurrences.get(refName));
        }
        return ret;
    } 
    
    protected final void markOccurrence(String refName, OffsetRange or) {
        occurrences.computeIfAbsent(refName, s -> new ArrayList<>()).add(or);
    }

    protected abstract T createParser(Snapshot snapshot);
    protected abstract void evaluateParser(T parser);

    protected abstract ParseTreeListener createReferenceListener();
    protected abstract ParseTreeListener createImportListener();
    protected abstract ParseTreeListener createFoldListener();
    protected abstract ParseTreeListener createStructureListener();
    protected abstract ParseTreeListener createOccurancesListener();

    protected ANTLRErrorListener createErrorListener() {
        return new BaseErrorListener() {
            @Override
            public void syntaxError(Recognizer recognizer, Object offendingSymbol, int line, int charPositionInLine, String msg, RecognitionException e) {
                int errorPosition = 0;
                if (offendingSymbol instanceof Token) {
                    Token offendingToken = (Token) offendingSymbol;
                    errorPosition = offendingToken.getStartIndex();
                }
                errors.add(new DefaultError(null, msg, null, getFileObject(), errorPosition, errorPosition, Severity.ERROR));
            }

        };
    }


}