Merge pull request #710 from usethesource/error-causes

Map optional `causes` field of Message to `RelatedDiagnosticInformation` of Diagnostics

Author: DavyLandman

rascal-lsp/src/main/java/org/rascalmpl/vscode/lsp/BaseWorkspaceService.java

@@ -57,7 +57,6 @@
 import org.eclipse.lsp4j.services.LanguageClient;
 import org.eclipse.lsp4j.services.LanguageClientAware;
 import org.eclipse.lsp4j.services.WorkspaceService;
-import org.rascalmpl.vscode.lsp.util.locations.Locations;
 
 public class BaseWorkspaceService implements WorkspaceService, LanguageClientAware {
     private static final Logger logger = LogManager.getLogger(BaseWorkspaceService.class);

rascal-lsp/src/main/java/org/rascalmpl/vscode/lsp/IBaseTextDocumentService.java

@@ -37,6 +37,7 @@
 import org.eclipse.lsp4j.services.LanguageClient;
 import org.eclipse.lsp4j.services.TextDocumentService;
 import org.rascalmpl.vscode.lsp.terminal.ITerminalIDEServer.LanguageParameter;
+import org.rascalmpl.vscode.lsp.util.locations.ColumnMaps;
 import org.rascalmpl.vscode.lsp.util.locations.LineColumnOffsetMap;
 
 import io.usethesource.vallang.ISourceLocation;
@@ -54,11 +55,13 @@ public interface IBaseTextDocumentService extends TextDocumentService {
     void unregisterLanguage(LanguageParameter lang);
     CompletableFuture<IValue> executeCommand(String languageName, String command);
     LineColumnOffsetMap getColumnMap(ISourceLocation file);
+    ColumnMaps getColumnMaps();
     TextDocumentState getDocumentState(ISourceLocation file);
 
     boolean isManagingFile(ISourceLocation file);
 
     void didRenameFiles(RenameFilesParams params, List<WorkspaceFolder> workspaceFolders);
     void didDeleteFiles(DeleteFilesParams params);
     void cancelProgress(String progressId);
+
 }

rascal-lsp/src/main/java/org/rascalmpl/vscode/lsp/LSPIDEServices.java

@@ -148,7 +148,7 @@ public void registerLocations(IString scheme, IString auth, IMap map) {
 
     @Override
     public void registerDiagnostics(IList messages) {
-        Map<ISourceLocation, List<Diagnostic>> translated = Diagnostics.translateMessages(messages, docService);
+        Map<ISourceLocation, List<Diagnostic>> translated = Diagnostics.translateMessages(messages, docService.getColumnMaps());
 
         for (Entry<ISourceLocation, List<Diagnostic>> entry : translated.entrySet()) {
             String uri = entry.getKey().getURI().toString();

rascal-lsp/src/main/java/org/rascalmpl/vscode/lsp/parametric/ParametricTextDocumentService.java

@@ -199,6 +199,11 @@ public ParametricTextDocumentService(ExecutorService exec, @Nullable LanguagePar
         FallbackResolver.getInstance().registerTextDocumentService(this);
     }
 
+    @Override
+    public ColumnMaps getColumnMaps() {
+        return columns;
+    }
+
     @Override
     public LineColumnOffsetMap getColumnMap(ISourceLocation file) {
         return columns.get(file);

rascal-lsp/src/main/java/org/rascalmpl/vscode/lsp/parametric/ParserOnlyContribution.java

@@ -38,7 +38,6 @@
 import org.eclipse.lsp4j.jsonrpc.messages.Either;
 import org.rascalmpl.interpreter.NullRascalMonitor;
 import org.rascalmpl.shell.ShellEvaluatorFactory;
-import org.rascalmpl.uri.URIUtil;
 import org.rascalmpl.values.IRascalValueFactory;
 import org.rascalmpl.values.RascalFunctionValueFactory;
 import org.rascalmpl.values.RascalValueFactory;
@@ -49,7 +48,6 @@
 
 import io.usethesource.vallang.IConstructor;
 import io.usethesource.vallang.IList;
-import io.usethesource.vallang.IMap;
 import io.usethesource.vallang.ISet;
 import io.usethesource.vallang.ISourceLocation;
 import io.usethesource.vallang.ITuple;

rascal-lsp/src/main/java/org/rascalmpl/vscode/lsp/rascal/RascalTextDocumentService.java

@@ -159,6 +159,11 @@ public RascalTextDocumentService(ExecutorService exec) {
         FallbackResolver.getInstance().registerTextDocumentService(this);
     }
 
+    @Override
+    public ColumnMaps getColumnMaps() {
+        return columns;
+    }
+
     @Override
     public LineColumnOffsetMap getColumnMap(ISourceLocation file) {
         return columns.get(file);

rascal-lsp/src/main/java/org/rascalmpl/vscode/lsp/terminal/TerminalIDEServer.java

@@ -151,7 +151,7 @@ public void registerLocations(RegisterLocationsParameters param) {
 
     @Override
     public void registerDiagnostics(RegisterDiagnosticsParameters param) {
-        Map<ISourceLocation, List<Diagnostic>> translated = Diagnostics.translateMessages(param.getMessages(), docService);
+        Map<ISourceLocation, List<Diagnostic>> translated = Diagnostics.translateMessages(param.getMessages(), docService.getColumnMaps());
 
         for (Entry<ISourceLocation, List<Diagnostic>> entry : translated.entrySet()) {
             String uri = entry.getKey().getURI().toString();

rascal-lsp/src/main/java/org/rascalmpl/vscode/lsp/util/Diagnostics.java

@@ -37,16 +37,15 @@
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
 import org.eclipse.lsp4j.Diagnostic;
+import org.eclipse.lsp4j.DiagnosticRelatedInformation;
 import org.eclipse.lsp4j.DiagnosticSeverity;
 import org.eclipse.lsp4j.Position;
 import org.eclipse.lsp4j.Range;
 import org.rascalmpl.parser.gtd.exception.ParseError;
 import org.rascalmpl.values.ValueFactoryFactory;
 import org.rascalmpl.values.parsetrees.ITree;
 import org.rascalmpl.values.parsetrees.TreeAdapter;
-import org.rascalmpl.vscode.lsp.IBaseTextDocumentService;
 import org.rascalmpl.vscode.lsp.util.locations.ColumnMaps;
-import org.rascalmpl.vscode.lsp.util.locations.LineColumnOffsetMap;
 import org.rascalmpl.vscode.lsp.util.locations.Locations;
 import io.usethesource.vallang.ICollection;
 import io.usethesource.vallang.IConstructor;
@@ -176,19 +175,27 @@ private static void storeFixCommands(IConstructor d, Diagnostic result) {
     }
 
     public static Diagnostic translateDiagnostic(IConstructor d, ColumnMaps cm) {
-        return translateDiagnostic(d, Locations.toRange(getMessageLocation(d), cm));
+        return translateDiagnostic(d, Locations.toRange(getMessageLocation(d), cm), cm);
     }
 
-    public static Diagnostic translateDiagnostic(IConstructor d, LineColumnOffsetMap cm) {
-        return translateDiagnostic(d, Locations.toRange(getMessageLocation(d), cm));
-    }
-
-    public static Diagnostic translateDiagnostic(IConstructor d, Range range) {
+    public static Diagnostic translateDiagnostic(IConstructor d, Range range, ColumnMaps otherFiles) {
         Diagnostic result = new Diagnostic();
         result.setSeverity(severityMap.get(d.getName()));
-        result.setMessage(((IString) d.get("msg")).getValue());
+        result.setMessage(getMessageString(d));
         result.setRange(range);
 
+
+        if (d.asWithKeywordParameters().hasParameter("causes")) {
+            result.setRelatedInformation(
+                ((IList) d.asWithKeywordParameters().getParameter("causes")).stream()
+                .map(IConstructor.class::cast)
+                .map(c -> new DiagnosticRelatedInformation(
+                    Locations.toLSPLocation(getMessageLocation(d), otherFiles.get(getMessageLocation(d))),
+                    getMessageString(c)))
+                .collect(Collectors.toList())
+            );
+        }
+
         storeFixCommands(d, result);
         return result;
     }
@@ -227,13 +234,13 @@ public static List<Diagnostic> translateDiagnostics(ISourceLocation file, IColle
      * @param docService  needed to convert column positions
      * @return an ordered map of Diagnostics
      */
-    public static Map<ISourceLocation, List<Diagnostic>> translateMessages(IList messages, IBaseTextDocumentService docService) {
+    public static Map<ISourceLocation, List<Diagnostic>> translateMessages(IList messages, ColumnMaps cm) {
         Map<ISourceLocation, List<Diagnostic>> results = new HashMap<>();
 
         for (IValue elem : messages) {
             IConstructor message = (IConstructor) elem;
             ISourceLocation file = getMessageLocation(message).top();
-            Diagnostic d = translateDiagnostic(message, docService.getColumnMap(file));
+            Diagnostic d = translateDiagnostic(message, cm);
 
             List<Diagnostic> lst = results.computeIfAbsent(file, l -> new LinkedList<>());
             lst.add(d);
@@ -246,6 +253,10 @@ private static ISourceLocation getMessageLocation(IConstructor message) {
         return Locations.toClientLocation(((ISourceLocation) message.get("at")));
     }
 
+    private static String getMessageString(IConstructor msg) {
+        return ((IString) msg.get("msg")).getValue();
+    }
+
     private static boolean hasValidLocation(IConstructor d, ISourceLocation file) {
         ISourceLocation loc = getMessageLocation(d);