Merge remote-tracking branch 'origin/main' into feature/132-lsp-call-hierarchy

Author: toinehartman

.github/workflows/lint.yaml

@@ -69,6 +69,7 @@ jobs:
           eslint_dir: ./rascal-vscode-extension
           eslint_args: "src"
           eslint_extensions: ts
+          continue_on_error: false
 
   checkstyle:
     name: checkstyle 

build.sh

@@ -1,23 +1,34 @@
 #!/usr/bin/env bash
 
-set -euxo pipefail
+set -euo pipefail
 
 extra_flags=''
+lint=0
 
 clean="clean"
-while getopts 'fd' flag; do
+while getopts 'lfd' flag; do
   case "${flag}" in
     f) extra_flags='-Drascal.compile.skip -Drascal.tutor.skip -DskipTests' ;;
+    l) lint=1 ;;
     d) clean='' ;;
     *) printf "incorrect param, valid params:
     Use -f to skip rascal-compile and tests
-    Use -d to skip cleaning the target folder"
+    Use -d to skip cleaning the target folder
+    Use -l to skip linting
+
+"
         exit 1 ;;
   esac
 done
 
 rm -f rascal-lsp/target/*.jar
 
+if (( $lint == 1 )); then
+   (cd rascal-lsp && mvn -B checkstyle:checkstyle  checkstyle:check )
+fi
 (cd rascal-lsp && mvn $clean package -Drascal.monitor.batch $extra_flags )
+if (( $lint == 1 )); then
+   (cd rascal-vscode-extension && npm run lint )
+fi
 (cd rascal-vscode-extension && npm run lsp4j:package )
 

rascal-lsp/pom.xml

@@ -63,7 +63,7 @@
     <dependency>
       <groupId>org.rascalmpl</groupId>
       <artifactId>rascal</artifactId>
-      <version>0.41.0-RC62</version>
+      <version>0.41.0-RC67</version>
     </dependency>
     <!-- Rascal tests require JUnit 4 -->
     <dependency>
@@ -158,6 +158,15 @@
         <groupId>org.rascalmpl</groupId>
         <artifactId>rascal-maven-plugin</artifactId>
         <version>0.30.0-RC25</version>
+        <configuration>
+            <errorsAsWarnings>false</errorsAsWarnings>
+            <bin>${project.build.outputDirectory}</bin>
+            <srcs>
+                <src>${project.basedir}/src/main/rascal/library</src>
+            </srcs>
+            <sources>|http://github.com/usethesource/rascal-language-servers/blob/main/rascal-lsp|</sources>
+            <issues>|http://github.com/usethesource/rascal-language-servers/issues|</issues>
+        </configuration>
         <executions>
           <execution>
             <?m2e ignore?>
@@ -166,13 +175,6 @@
             <goals>
               <goal>compile</goal>
             </goals>
-            <configuration>
-                <errorsAsWarnings>false</errorsAsWarnings>
-                <bin>${project.build.outputDirectory}</bin>
-                <srcs>
-                    <src>${project.basedir}/src/main/rascal/library</src>
-                </srcs>
-            </configuration>
           </execution>
           <execution>
             <id>default-package</id>
@@ -187,18 +189,6 @@
             <goals>
               <goal>tutor</goal>
             </goals>
-            <configuration>
-              <bin>${project.build.outputDirectory}</bin>
-              <sources>|http://github.com/usethesource/rascal-language-servers/blob/main/rascal-lsp|</sources>
-              <issues>|http://github.com/usethesource/rascal-language-servers/issues|</issues>
-              <srcs>
-                <src>${project.basedir}/src/main/rascal</src>
-              </srcs>
-              <ignores>
-                  <ignore>${project.basedir}/src/main/rascal/lang/rascal</ignore>
-                  <ignore>${project.basedir}/src/main/rascal/framework</ignore>
-              </ignores>
-            </configuration>
           </execution>
         </executions>
       </plugin>

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

@@ -29,6 +29,7 @@
 import org.eclipse.lsp4j.jsonrpc.services.JsonNotification;
 import org.eclipse.lsp4j.services.LanguageClient;
 import org.rascalmpl.vscode.lsp.terminal.ITerminalIDEServer.BrowseParameter;
+import org.rascalmpl.vscode.lsp.terminal.ITerminalIDEServer.EditorParameter;
 import org.rascalmpl.vscode.lsp.terminal.ITerminalIDEServer.LanguageParameter;
 
 public interface IBaseLanguageClient extends LanguageClient {
@@ -41,6 +42,9 @@ public interface IBaseLanguageClient extends LanguageClient {
     @JsonNotification("rascal/receiveUnregisterLanguage")
     void receiveUnregisterLanguage(LanguageParameter lang);
 
+    @JsonNotification("rascal/editDocument")
+    void editDocument(EditorParameter params);
+
     /**
      * Notification sent to the vscode client to start a debugging session on the given debug adapter port
      */

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

@@ -31,18 +31,18 @@
 import java.io.InputStream;
 import java.io.OutputStream;
 import java.net.URISyntaxException;
+import java.nio.charset.StandardCharsets;
 import java.nio.file.FileAlreadyExistsException;
 import java.nio.file.NotDirectoryException;
 import java.util.Arrays;
 import java.util.Base64;
 import java.util.Set;
-import java.util.Base64.Encoder;
 import java.util.concurrent.CompletableFuture;
 import java.util.concurrent.CompletionException;
 import java.util.concurrent.ExecutorService;
 import java.util.stream.Stream;
 import org.checkerframework.checker.nullness.qual.Nullable;
-
+import org.apache.commons.codec.binary.Base64InputStream;
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
 import org.eclipse.lsp4j.jsonrpc.ResponseErrorException;
@@ -195,28 +195,9 @@ default CompletableFuture<Void> createDirectory(URIParameter uri) {
 
     @JsonRequest("rascal/filesystem/readFile")
     default CompletableFuture<LocationContent> readFile(URIParameter uri) {
-        final int BUFFER_SIZE = 3 * 1024; // has to be divisibly by 3
-
         return CompletableFuture.supplyAsync(() -> {
-            try (InputStream source = reg.getInputStream(uri.getLocation())) {
-                // there is no streaming base64 encoder, but we also do not want to have the
-                // whole file in memory
-                // just to base64 encode it. So we stream it in chunks that will not cause
-                // padding characters in
-                // base 64
-                Encoder encoder = Base64.getEncoder();
-                StringBuilder result = new StringBuilder();
-                byte[] buffer = new byte[BUFFER_SIZE];
-                int read;
-                while ((read = source.read(buffer, 0, BUFFER_SIZE)) == BUFFER_SIZE) {
-                    result.append(encoder.encodeToString(buffer));
-                }
-                if (read > 0) {
-                    // last part needs to be a truncated part of the buffer
-                    buffer = Arrays.copyOf(buffer, read);
-                    result.append(encoder.encodeToString(buffer));
-                }
-                return new LocationContent(result.toString());
+            try (InputStream source = new Base64InputStream(reg.getInputStream(uri.getLocation()), true)) {
+                return new LocationContent(new String(source.readAllBytes(), StandardCharsets.US_ASCII));
             } catch (IOException | URISyntaxException | RuntimeException e) {
                 throw new VSCodeFSError(e);
             }

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

@@ -38,12 +38,13 @@
 import org.eclipse.lsp4j.ApplyWorkspaceEditParams;
 import org.eclipse.lsp4j.Diagnostic;
 import org.eclipse.lsp4j.PublishDiagnosticsParams;
-import org.eclipse.lsp4j.ShowDocumentParams;
+import org.eclipse.lsp4j.Range;
 import org.eclipse.lsp4j.WorkspaceFolder;
 import org.rascalmpl.debug.IRascalMonitor;
 import org.rascalmpl.ideservices.IDEServices;
 import org.rascalmpl.uri.URIUtil;
 import org.rascalmpl.vscode.lsp.terminal.ITerminalIDEServer.BrowseParameter;
+import org.rascalmpl.vscode.lsp.terminal.ITerminalIDEServer.EditorParameter;
 import org.rascalmpl.vscode.lsp.terminal.ITerminalIDEServer.LanguageParameter;
 import org.rascalmpl.vscode.lsp.util.Diagnostics;
 import org.rascalmpl.vscode.lsp.util.DocumentChanges;
@@ -89,16 +90,15 @@ public void browse(URI uri, String title, int viewColumn) {
     }
 
     @Override
-    public void edit(ISourceLocation path) {
+    public void edit(ISourceLocation path, int viewColumn) {
         ISourceLocation physical = Locations.toClientLocation(path);
-        ShowDocumentParams params = new ShowDocumentParams(physical.getURI().toASCIIString());
-        params.setTakeFocus(true);
 
+        Range range = null;
         if (physical.hasOffsetLength()) {
-            params.setSelection(Locations.toRange(physical, docService.getColumnMap(physical)));
+            range = Locations.toRange(physical, docService.getColumnMap(physical));
         }
 
-        languageClient.showDocument(params);
+        languageClient.editDocument(new EditorParameter(path.getURI().toASCIIString(), range, viewColumn));
     }
 
     @Override

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

@@ -28,20 +28,16 @@
 
 import java.util.ArrayList;
 import java.util.List;
-import java.util.concurrent.atomic.AtomicReference;
 import java.util.concurrent.CompletableFuture;
 import java.util.concurrent.CompletionException;
+import java.util.concurrent.atomic.AtomicReference;
 import java.util.function.BiFunction;
 
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
 import org.checkerframework.checker.nullness.qual.MonotonicNonNull;
-import org.eclipse.lsp4j.Diagnostic;
-import org.eclipse.lsp4j.DiagnosticSeverity;
-import org.eclipse.lsp4j.Position;
-import org.eclipse.lsp4j.Range;
+import org.checkerframework.checker.nullness.qual.Nullable;
 import org.rascalmpl.library.util.ParseErrorRecovery;
-import org.rascalmpl.parser.gtd.exception.ParseError;
 import org.rascalmpl.values.IRascalValueFactory;
 import org.rascalmpl.values.parsetrees.ITree;
 import org.rascalmpl.vscode.lsp.util.Diagnostics;
@@ -60,13 +56,14 @@
  * and ParametricTextDocumentService.
  */
 public class TextDocumentState {
+    @SuppressWarnings("unused")
     private static final Logger logger = LogManager.getLogger(TextDocumentState.class);
     private static final ParseErrorRecovery RECOVERY = new ParseErrorRecovery(IRascalValueFactory.getInstance());
 
     private final BiFunction<ISourceLocation, String, CompletableFuture<ITree>> parser;
     private final ISourceLocation location;
 
-    private final AtomicReference<@MonotonicNonNull Versioned<Update>> current;
+    private final AtomicReference<Versioned<Update>> current;
     private final AtomicReference<@MonotonicNonNull Versioned<ITree>> lastWithoutErrors;
     private final AtomicReference<@MonotonicNonNull Versioned<ITree>> last;
 
@@ -98,7 +95,7 @@ public Versioned<String> getCurrentContent() {
         return unpackCurrent().getContent();
     }
 
-    public CompletableFuture<Versioned<ITree>> getCurrentTreeAsync() {
+    private CompletableFuture<Versioned<ITree>> getCurrentTreeAsync() {
         return unpackCurrent().getTreeAsync();
     }
 
@@ -110,14 +107,58 @@ private Update unpackCurrent() {
         return current.get().get();
     }
 
-    public @MonotonicNonNull Versioned<ITree> getLastTree() {
-        return last.get();
-    }
-
     public @MonotonicNonNull Versioned<ITree> getLastTreeWithoutErrors() {
         return lastWithoutErrors.get();
     }
 
+    /**
+     * Wait for the current content to get parsed and get the parse tree from it.
+     * @param allowRecoveredErrors if false parse trees with recovered errors complete the future exceptionally
+     * @return the current parse tree
+     */
+    public CompletableFuture<Versioned<ITree>> getCurrentTreeAsync(boolean allowRecoveredErrors) {
+        if (allowRecoveredErrors) {
+            return getCurrentTreeAsync();
+        }
+        return getCurrentTreeAsync().thenApply(t -> {
+            var withoutErrors = lastWithoutErrors.get();
+            // side-effect of a succesfull parse without any recovered errors is that
+            // `getLastTreeWithoutErrors` is updated to the same tree
+            if (withoutErrors == null || withoutErrors.get() != t.get()) {
+                throw new IllegalStateException("File has parse errors");
+            }
+            return t;
+        });
+    }
+
+    /**
+     * Wait for current tree to parse. Then return the last tree that matches the allowRecoveredErrors conditation.
+     * @param allowRecoveredErrors if false, the result will not contain a tree with recovered errors.
+     * @return the last parse tree, or an exception if non existed.
+     */
+    public CompletableFuture<Versioned<ITree>> getLastTreeAsync(boolean allowRecoveredErrors) {
+        var result = getCurrentTreeAsync()
+            .handle((t, e) -> {
+                if (t == null) {
+                    return last.get();
+                }
+                return t;
+            });
+        if (!allowRecoveredErrors) {
+            // if a parse is done, always overwrite it with the
+            // last tree that did not have any errors, also not recovered errors
+            result = result.thenApply(t -> lastWithoutErrors.get());
+        }
+
+        return result.handle((t, e) -> {
+            if (t == null) {
+                throw new IllegalStateException("No previous parse tree without errors for: " + getLocation());
+            }
+            return t;
+        });
+    }
+
+
     /**
      * An update of a text document, characterized in terms of its
      * {@link #version} (typically provied by the client), its {@link #content}
@@ -128,8 +169,8 @@ private class Update {
         private final int version;
         private final String content;
         private final long timestamp;
-        private final CompletableFuture<Versioned<ITree>> treeAsync;
-        private final CompletableFuture<Versioned<List<Diagnostics.Template>>> diagnosticsAsync;
+        private final CompletableFuture<@Nullable Versioned<ITree>> treeAsync;
+        private final CompletableFuture<@Nullable Versioned<List<Diagnostics.Template>>> diagnosticsAsync;
 
         public Update(int version, String content, long timestamp) {
             this.version = version;
@@ -179,24 +220,15 @@ private void parse() {
                 });
         }
 
-        private List<Diagnostics.Template> toDiagnosticsList(ITree tree, Throwable excp) {
+        private List<Diagnostics.Template> toDiagnosticsList(@Nullable ITree tree, @Nullable Throwable excp) {
             List<Diagnostics.Template> diagnostics = new ArrayList<>();
 
-            if (excp instanceof CompletionException) {
-                excp = excp.getCause();
-            }
+            if (excp != null) {
+                if (excp instanceof CompletionException) {
+                    excp = excp.getCause();
+                }
 
-            if (excp instanceof ParseError) {
-                var parseError = (ParseError) excp;
-                diagnostics.add(Diagnostics.generateParseErrorDiagnostic(parseError));
-            } else if (excp != null) {
-                logger.error("Parsing crashed", excp);
-                var diagnostic = new Diagnostic(
-                    new Range(new Position(0,0), new Position(0,1)),
-                    "Parsing failed: " + excp.getMessage(),
-                    DiagnosticSeverity.Error,
-                    "parser");
-                diagnostics.add(columns -> diagnostic);
+                diagnostics.add(Diagnostics.generateParseErrorDiagnostic(excp));
             }
 
             if (tree != null) {

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

@@ -53,7 +53,7 @@ public interface ILanguageContributions {
     public InterruptibleFuture<IConstructor> build(ISourceLocation loc, ITree input);
     public InterruptibleFuture<IList> documentSymbol(ITree input);
     public InterruptibleFuture<IList> codeLens(ITree input);
-    public InterruptibleFuture<IList> inlayHint(@Nullable ITree input);
+    public InterruptibleFuture<IList> inlayHint(ITree input);
     public InterruptibleFuture<@Nullable IValue> execution(String command);
     public InterruptibleFuture<ISet> hover(IList focus);
     public InterruptibleFuture<ISet> definition(IList focus);

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

@@ -249,8 +249,7 @@ private static boolean isTrue(@Nullable IConstructor constructor, String paramet
     }
 
     private static ISet loadContributions(Evaluator eval, LanguageParameter lang) {
-        return (ISet) eval.eval(eval.getMonitor(), lang.getMainFunction() + "()", URIUtil.rootLocation("lsp"))
-            .getValue();
+        return (ISet) eval.call(eval.getMonitor(), lang.getMainFunction());
     }
 
     @Override