/*
* Copyright (c) 2012 Sam Harwell, Tunnel Vision Laboratories LLC
* All rights reserved.
*
* The source code of this document is proprietary work, and is not licensed for
* distribution. For information about licensing, contact Sam Harwell at:
* sam@tunnelvisionlabs.com
*/
package org.tvl.goworks.editor.go.semantics;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.EnumSet;
import java.util.List;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.Future;
import java.util.logging.Level;
import java.util.logging.Logger;
import javax.swing.text.BadLocationException;
import javax.swing.text.Document;
import org.antlr.netbeans.editor.parsing.SyntaxError;
import org.antlr.netbeans.editor.text.DocumentSnapshot;
import org.antlr.netbeans.editor.text.SnapshotPositionRegion;
import org.antlr.netbeans.editor.text.TrackingPositionRegion;
import org.antlr.netbeans.parsing.spi.ParseContext;
import org.antlr.netbeans.parsing.spi.ParserData;
import org.antlr.netbeans.parsing.spi.ParserDataDefinition;
import org.antlr.netbeans.parsing.spi.ParserDataOptions;
import org.antlr.netbeans.parsing.spi.ParserResultHandler;
import org.antlr.netbeans.parsing.spi.ParserTask;
import org.antlr.netbeans.parsing.spi.ParserTaskDefinition;
import org.antlr.netbeans.parsing.spi.ParserTaskManager;
import org.antlr.netbeans.parsing.spi.ParserTaskProvider;
import org.antlr.netbeans.parsing.spi.ParserTaskScheduler;
import org.antlr.netbeans.parsing.spi.SingletonParserTaskProvider;
import org.netbeans.api.editor.mimelookup.MimeRegistration;
import org.netbeans.spi.editor.hints.ErrorDescription;
import org.netbeans.spi.editor.hints.ErrorDescriptionFactory;
import org.netbeans.spi.editor.hints.HintsController;
import org.openide.filesystems.FileObject;
import org.tvl.goworks.editor.GoEditorKit;
import org.tvl.goworks.editor.go.GoParserDataDefinitions;
import org.tvl.goworks.editor.go.parser.CompiledModel;
/**
*
* @author Sam Harwell
*/
public final class SyntaxErrorsHighlightingParserTask implements ParserTask {
// -J-Dorg.tvl.goworks.editor.go.semantics.SyntaxErrorsHighlightingParserTask.level=FINE
private static final Logger LOGGER = Logger.getLogger(SyntaxErrorsHighlightingParserTask.class.getName());
private SyntaxErrorsHighlightingParserTask() {
}
@Override
public ParserTaskDefinition getDefinition() {
return Definition.INSTANCE;
}
@Override
public void parse(ParserTaskManager taskManager, ParseContext context, DocumentSnapshot snapshot, Collection<? extends ParserDataDefinition<?>> requestedData, ParserResultHandler results)
throws InterruptedException, ExecutionException {
if (snapshot.getVersionedDocument().getDocument() == null) {
// no errors update for background parsed document
return;
}
Future<ParserData<CompiledModel>> futureData = taskManager.getData(snapshot, context.getComponent(), GoParserDataDefinitions.COMPILED_MODEL, EnumSet.of(ParserDataOptions.NO_UPDATE, ParserDataOptions.SYNCHRONOUS));
ParserData<CompiledModel> parserData = futureData != null ? futureData.get() : null;
CompiledModel model = parserData != null ? parserData.getData() : null;
if (model == null) {
return;
}
DocumentSnapshot latestSnapshot = snapshot.getVersionedDocument().getCurrentSnapshot();
try {
List<? extends SyntaxError> syntaxErrors = model.getResult().getSyntaxErrors();
Document document = model.getSnapshot().getVersionedDocument().getDocument();
List<ErrorDescription> errors = new ArrayList<>();
for (SyntaxError syntaxError : syntaxErrors) {
SnapshotPositionRegion location = syntaxError.getLocation();
if (location == null) {
continue;
}
TrackingPositionRegion trackingRegion = snapshot.createTrackingRegion(location.getRegion(), TrackingPositionRegion.Bias.Forward);
SnapshotPositionRegion region = trackingRegion.getRegion(latestSnapshot);
String message = syntaxError.getMessage();
try {
ErrorDescription errorDescription = null;
if (document != null) {
errorDescription = ErrorDescriptionFactory.createErrorDescription(syntaxError.getSeverity(), message, document, document.createPosition(region.getStart().getOffset()), document.createPosition(region.getEnd().getOffset()));
} else {
FileObject file = context.getDocument().getFileObject();
if (file != null) {
errorDescription = ErrorDescriptionFactory.createErrorDescription(syntaxError.getSeverity(), message, file, region.getStart().getOffset(), region.getEnd().getOffset());
}
}
if (errorDescription != null) {
errors.add(errorDescription);
}
} catch (BadLocationException ex) {
LOGGER.log(Level.WARNING, "An exception occurred while updating error hints.", ex);
}
}
if (document != null) {
HintsController.setErrors(document, "go-syntax", errors);
} else {
FileObject fileObject = context.getDocument().getFileObject();
if (fileObject != null) {
HintsController.setErrors(fileObject, "go-syntax", errors);
}
}
} catch (RuntimeException ex) {
LOGGER.log(Level.WARNING, "An exception occurred while updating error hints.", ex);
}
}
private static final class Definition extends ParserTaskDefinition {
private static final Collection<ParserDataDefinition<?>> INPUTS =
Collections.<ParserDataDefinition<?>>singletonList(GoParserDataDefinitions.COMPILED_MODEL);
private static final Collection<ParserDataDefinition<?>> OUTPUTS = Collections.emptyList();
public static final Definition INSTANCE = new Definition();
public Definition() {
super("Go Syntax Errors Highlighting", INPUTS, OUTPUTS, ParserTaskScheduler.INPUT_SENSITIVE_TASK_SCHEDULER);
}
}
@MimeRegistration(mimeType=GoEditorKit.GO_MIME_TYPE, service=ParserTaskProvider.class)
public static final class Provider extends SingletonParserTaskProvider {
@Override
public ParserTaskDefinition getDefinition() {
return Definition.INSTANCE;
}
@Override
public ParserTask createTaskImpl() {
return new SyntaxErrorsHighlightingParserTask();
}
}
}