Add rangeFormatting, reuse formatting.

Author: toinehartman

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

@@ -60,7 +60,7 @@ public interface ILanguageContributions {
     public InterruptibleFuture<ISet> implementation(IList focus);
     public InterruptibleFuture<IList> codeAction(IList focus);
     public InterruptibleFuture<IList> selectionRange(IList focus);
-    public InterruptibleFuture<IList> formatting(ITree input, ISet formattingOptions);
+    public InterruptibleFuture<IList> formatting(ITree input, ISourceLocation loc, ISet formattingOptions);
 
     public CompletableFuture<IList> parseCodeActions(String command);
 

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

@@ -60,6 +60,7 @@
 import org.eclipse.lsp4j.DidOpenTextDocumentParams;
 import org.eclipse.lsp4j.DidSaveTextDocumentParams;
 import org.eclipse.lsp4j.DocumentFormattingParams;
+import org.eclipse.lsp4j.DocumentRangeFormattingParams;
 import org.eclipse.lsp4j.DocumentSymbol;
 import org.eclipse.lsp4j.DocumentSymbolParams;
 import org.eclipse.lsp4j.ExecuteCommandOptions;
@@ -75,6 +76,7 @@
 import org.eclipse.lsp4j.Location;
 import org.eclipse.lsp4j.LocationLink;
 import org.eclipse.lsp4j.Position;
+import org.eclipse.lsp4j.Range;
 import org.eclipse.lsp4j.ReferenceParams;
 import org.eclipse.lsp4j.SelectionRange;
 import org.eclipse.lsp4j.SelectionRangeParams;
@@ -100,6 +102,7 @@
 import org.rascalmpl.uri.URIResolverRegistry;
 import org.rascalmpl.values.IRascalValueFactory;
 import org.rascalmpl.values.parsetrees.ITree;
+import org.rascalmpl.values.parsetrees.TreeAdapter;
 import org.rascalmpl.vscode.lsp.BaseWorkspaceService;
 import org.rascalmpl.vscode.lsp.IBaseLanguageClient;
 import org.rascalmpl.vscode.lsp.IBaseTextDocumentService;
@@ -531,17 +534,32 @@ public CompletableFuture<List<Either<Command, CodeAction>>> codeAction(CodeActio
 
     @Override
     public CompletableFuture<List<? extends TextEdit>> formatting(DocumentFormattingParams params) {
-        logger.debug("formatting: {}", params);
+        logger.debug("Formatting: {}", params);
+        return format(params.getTextDocument(), null, params.getOptions());
+    }
 
-        final ILanguageContributions contribs = contributions(params.getTextDocument());
+    @Override
+    public CompletableFuture<List<? extends TextEdit>> rangeFormatting(DocumentRangeFormattingParams params) {
+        logger.debug("Formatting range: {}", params);
+        return format(params.getTextDocument(), params.getRange(), params.getOptions());
+    }
+
+    private CompletableFuture<List<? extends TextEdit>> format(TextDocumentIdentifier uri, @Nullable Range range, FormattingOptions options) {
+        final ILanguageContributions contribs = contributions(uri);
 
         // convert the `FormattingOptions` map to a `set[FormattingOption]`
-        ISet optSet = getFormattingOptions(params.getOptions());
+        ISet optSet = getFormattingOptions(options);
         // call the `formatting` implementation of the relevant language contribution
-        return getFile(params.getTextDocument())
+        return getFile(uri)
             .getCurrentTreeAsync()
             .thenApply(Versioned::get)
-            .thenCompose(tree -> contribs.formatting(tree, optSet).get())
+            .thenCompose(tree -> {
+                // range to Rascal loc
+                ISourceLocation loc = range == null
+                    ? TreeAdapter.getLocation(tree)
+                    : null; // TODO map Range to ISourceLocation
+                return contribs.formatting(tree, loc, optSet).get();
+            })
             // convert the document changes
             .thenApply(l -> DocumentChanges.translateTextEdits(this, l, Map.of()));
     }

rascal-lsp/src/main/rascal/library/demo/lang/pico/LanguageServer.rsc

@@ -41,6 +41,7 @@ import util::ParseErrorRecovery;
 import util::Reflective;
 import lang::pico::\syntax::Main;
 import IO;
+import Location;
 import String;
 
 import lang::box::\syntax::Box;
@@ -70,14 +71,13 @@ set[LanguageService] picoLanguageServer(bool allowRecovery) = {
     formatting(picoFormattingService)
 };
 
-list[TextEdit] picoFormattingService(Tree input, FormattingOptions opts) {
-    // pico tree to box formatting representation
+list[TextEdit] picoFormattingService(Tree input, loc range, FormattingOptions opts) {
     str original = "<input>";
-    print("[original]");
-    rprintln(original);
 
+    // pico tree to box formatting representation
     box = toBox(input);
     box = visit (box) { case i:I(_) => i[is=opts.tabSize] };
+
     // box to string
     formatted = format(box);
 
@@ -109,7 +109,8 @@ list[TextEdit] picoFormattingService(Tree input, FormattingOptions opts) {
     // computelayout differences as edits, and restore comments
     edits = layoutDiff(input, parse(#start[Program], formatted));
 
-    return edits;
+    // TODO Instead of computing all edits and filtering, we can be more efficient by only formatting certain trees.
+    return [e | e <- edits, isContainedIn(e.range, range)];
 }
 
 Box toBox((Program) `begin <Declarations decls> <{Statement ";"}* body> end`, FormatOptions opts = formatOptions())

rascal-lsp/src/main/rascal/library/util/LanguageServer.rsc

@@ -270,7 +270,7 @@ data LanguageService
     | implementation(set[loc] (Focus _focus) implementationService)
     | codeAction    (list[CodeAction] (Focus _focus) codeActionService)
     | selectionRange(list[loc](Focus _focus) selectionRangeService)
-    | formatting    (list[TextEdit](Tree _input, FormattingOptions _opts) formattingService)
+    | formatting    (list[TextEdit](Tree _input, loc range, FormattingOptions _opts) formattingService)
     ;
 
 data FormattingOptions(