Parametric: formatting

rascal-lsp/pom.xml

@@ -153,6 +153,12 @@
             <version>3.5.3</version>
           </dependency>
         </dependencies>
+        <configuration>
+          <systemPropertyVariables>
+            <forkMode>always</forkMode>
+            <log4j2.configurationFactory>org.rascalmpl.vscode.lsp.log.LogRedirectConfiguration</log4j2.configurationFactory>
+          </systemPropertyVariables>
+        </configuration>
       </plugin>
       <plugin>
         <groupId>org.rascalmpl</groupId>

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

@@ -34,6 +34,7 @@
 import org.rascalmpl.values.IRascalValueFactory;
 import org.rascalmpl.values.parsetrees.ITree;
 import org.rascalmpl.vscode.lsp.util.concurrent.InterruptibleFuture;
+
 import io.usethesource.vallang.IConstructor;
 import io.usethesource.vallang.IList;
 import io.usethesource.vallang.ISet;
@@ -60,6 +61,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(IList input, IConstructor formattingOptions);
 
     public InterruptibleFuture<ISourceLocation> prepareRename(IList focus);
     public InterruptibleFuture<ITuple> rename(IList focus, String name);
@@ -81,6 +83,7 @@ public interface ILanguageContributions {
     public CompletableFuture<Boolean> hasCodeAction();
     public CompletableFuture<Boolean> hasDidRenameFiles();
     public CompletableFuture<Boolean> hasSelectionRange();
+    public CompletableFuture<Boolean> hasFormatting();
 
     public CompletableFuture<Boolean> specialCaseHighlighting();
 

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

@@ -31,6 +31,7 @@
 import java.util.Objects;
 import java.util.concurrent.CompletableFuture;
 import java.util.concurrent.ExecutorService;
+
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
 import org.checkerframework.checker.nullness.qual.Nullable;
@@ -52,6 +53,7 @@
 import org.rascalmpl.vscode.lsp.util.EvaluatorUtil;
 import org.rascalmpl.vscode.lsp.util.EvaluatorUtil.LSPContext;
 import org.rascalmpl.vscode.lsp.util.concurrent.InterruptibleFuture;
+
 import io.usethesource.vallang.IBool;
 import io.usethesource.vallang.IConstructor;
 import io.usethesource.vallang.IList;
@@ -93,6 +95,7 @@ public class InterpretedLanguageContributions implements ILanguageContributions
     private final CompletableFuture<@Nullable IFunction> rename;
     private final CompletableFuture<@Nullable IFunction> didRenameFiles;
     private final CompletableFuture<@Nullable IFunction> selectionRange;
+    private final CompletableFuture<@Nullable IFunction> formatting;
 
     private final CompletableFuture<Boolean> hasAnalysis;
     private final CompletableFuture<Boolean> hasBuild;
@@ -108,6 +111,7 @@ public class InterpretedLanguageContributions implements ILanguageContributions
     private final CompletableFuture<Boolean> hasRename;
     private final CompletableFuture<Boolean> hasDidRenameFiles;
     private final CompletableFuture<Boolean> hasSelectionRange;
+    private final CompletableFuture<Boolean> hasFormatting;
 
     private final CompletableFuture<Boolean> specialCaseHighlighting;
 
@@ -154,6 +158,7 @@ public InterpretedLanguageContributions(LanguageParameter lang, IBaseTextDocumen
             this.rename = getFunctionFor(contributions, LanguageContributions.RENAME);
             this.didRenameFiles = getFunctionFor(contributions, LanguageContributions.DID_RENAME_FILES);
             this.selectionRange = getFunctionFor(contributions, LanguageContributions.SELECTION_RANGE);
+            this.formatting = getFunctionFor(contributions, LanguageContributions.FORMATTING);
 
             // assign boolean properties once instead of wasting futures all the time
             this.hasAnalysis = nonNull(this.analysis);
@@ -170,6 +175,7 @@ public InterpretedLanguageContributions(LanguageParameter lang, IBaseTextDocumen
             this.hasRename = nonNull(this.rename);
             this.hasDidRenameFiles = nonNull(this.didRenameFiles);
             this.hasSelectionRange = nonNull(this.selectionRange);
+            this.hasFormatting = nonNull(this.formatting);
 
             this.specialCaseHighlighting = getContributionParameter(contributions,
                 LanguageContributions.PARSING,
@@ -389,6 +395,12 @@ public InterruptibleFuture<IList> selectionRange(IList focus) {
         return execFunction(LanguageContributions.SELECTION_RANGE, selectionRange, VF.list(), focus);
     }
 
+    @Override
+    public InterruptibleFuture<IList> formatting(IList focus, IConstructor formattingOptions) {
+        debug(LanguageContributions.FORMATTING, focus.size(), formattingOptions);
+        return execFunction(LanguageContributions.FORMATTING, formatting, VF.list(), focus, formattingOptions);
+    }
+
     private void debug(String name, Object param) {
         logger.debug("{}({})", name, param);
     }
@@ -457,6 +469,11 @@ public CompletableFuture<Boolean> hasSelectionRange() {
         return hasSelectionRange;
     }
 
+    @Override
+    public CompletableFuture<Boolean> hasFormatting() {
+        return hasFormatting;
+    }
+
     @Override
     public CompletableFuture<Boolean> hasAnalysis() {
         return hasAnalysis;

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

@@ -70,6 +70,7 @@ private static final <T> CompletableFuture<T> failedInitialization() {
     private volatile CompletableFuture<ILanguageContributions> rename = failedInitialization();
     private volatile CompletableFuture<ILanguageContributions> didRenameFiles = failedInitialization();
     private volatile CompletableFuture<ILanguageContributions> selectionRange = failedInitialization();
+    private volatile CompletableFuture<ILanguageContributions> formatting = failedInitialization();
 
     private volatile CompletableFuture<Boolean> hasAnalysis = failedInitialization();
     private volatile CompletableFuture<Boolean> hasBuild = failedInitialization();
@@ -85,6 +86,7 @@ private static final <T> CompletableFuture<T> failedInitialization() {
     private volatile CompletableFuture<Boolean> hasRename = failedInitialization();
     private volatile CompletableFuture<Boolean> hasDidRenameFiles = failedInitialization();
     private volatile CompletableFuture<Boolean> hasSelectionRange = failedInitialization();
+    private volatile CompletableFuture<Boolean> hasFormatting = failedInitialization();
 
     private volatile CompletableFuture<Boolean> specialCaseHighlighting = failedInitialization();
 
@@ -162,6 +164,7 @@ private synchronized void calculateRouting() {
         prepareRename = findFirstOrDefault(ILanguageContributions::hasRename);
         didRenameFiles = findFirstOrDefault(ILanguageContributions::hasDidRenameFiles);
         selectionRange = findFirstOrDefault(ILanguageContributions::hasSelectionRange);
+        formatting = findFirstOrDefault(ILanguageContributions::hasFormatting);
 
         hasAnalysis = anyTrue(ILanguageContributions::hasAnalysis);
         hasBuild = anyTrue(ILanguageContributions::hasBuild);
@@ -177,6 +180,7 @@ private synchronized void calculateRouting() {
         hasDidRenameFiles = anyTrue(ILanguageContributions::hasDidRenameFiles);
         hasCodeAction = anyTrue(ILanguageContributions::hasCodeAction);
         hasSelectionRange = anyTrue(ILanguageContributions::hasSelectionRange);
+        hasFormatting = anyTrue(ILanguageContributions::hasFormatting);
 
         // Always use the special-case highlighting status of *the first*
         // contribution (possibly using the default value in the Rascal ADT if
@@ -337,6 +341,16 @@ public InterruptibleFuture<IList> selectionRange(IList focus) {
         return flatten(selectionRange, c -> c.selectionRange(focus));
     }
 
+    @Override
+    public InterruptibleFuture<IList> formatting(IList focus, IConstructor formattingOptions) {
+        return flatten(formatting, c -> c.formatting(focus, formattingOptions));
+    }
+
+    @Override
+    public CompletableFuture<Boolean> hasFormatting() {
+        return hasFormatting;
+    }
+
     @Override
     public CompletableFuture<Boolean> hasCodeAction() {
         return hasCodeAction;

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

@@ -62,12 +62,15 @@
 import org.eclipse.lsp4j.DidCloseTextDocumentParams;
 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;
 import org.eclipse.lsp4j.FileRename;
 import org.eclipse.lsp4j.FoldingRange;
 import org.eclipse.lsp4j.FoldingRangeRequestParams;
+import org.eclipse.lsp4j.FormattingOptions;
 import org.eclipse.lsp4j.Hover;
 import org.eclipse.lsp4j.HoverParams;
 import org.eclipse.lsp4j.ImplementationParams;
@@ -100,6 +103,7 @@
 import org.eclipse.lsp4j.TextDocumentIdentifier;
 import org.eclipse.lsp4j.TextDocumentItem;
 import org.eclipse.lsp4j.TextDocumentSyncKind;
+import org.eclipse.lsp4j.TextEdit;
 import org.eclipse.lsp4j.VersionedTextDocumentIdentifier;
 import org.eclipse.lsp4j.WorkspaceEdit;
 import org.eclipse.lsp4j.WorkspaceFolder;
@@ -110,6 +114,7 @@
 import org.eclipse.lsp4j.jsonrpc.messages.ResponseErrorCode;
 import org.eclipse.lsp4j.services.LanguageClient;
 import org.eclipse.lsp4j.services.LanguageClientAware;
+import org.eclipse.lsp4j.util.Ranges;
 import org.rascalmpl.uri.URIResolverRegistry;
 import org.rascalmpl.values.IRascalValueFactory;
 import org.rascalmpl.values.parsetrees.ITree;
@@ -236,6 +241,8 @@ public void initializeServerCapabilities(ServerCapabilities result) {
         result.setCodeLensProvider(new CodeLensOptions(false));
         result.setRenameProvider(new RenameOptions(true));
         result.setExecuteCommandProvider(new ExecuteCommandOptions(Collections.singletonList(getRascalMetaCommandName())));
+        result.setDocumentFormattingProvider(true);
+        result.setDocumentRangeFormattingProvider(true);
         result.setInlayHintProvider(true);
         result.setSelectionRangeProvider(true);
         result.setFoldingRangeProvider(true);
@@ -407,7 +414,7 @@ private CompletableFuture<ISourceLocation> computeRenameRange(final ILanguageCon
     public CompletableFuture<WorkspaceEdit> rename(RenameParams params) {
         logger.trace("rename for: {}, new name: {}", params.getTextDocument().getUri(), params.getNewName());
         final ILanguageContributions contribs = contributions(params.getTextDocument());
-        final Position rascalPos = Locations.toRascalPosition(params.getTextDocument(), params.getPosition(), columns);;
+        final Position rascalPos = Locations.toRascalPosition(params.getTextDocument(), params.getPosition(), columns);
         return getFile(params.getTextDocument())
                 .getCurrentTreeAsync()
                 .thenApply(Versioned::get)
@@ -727,6 +734,67 @@ public CompletableFuture<List<Either<Command, CodeAction>>> codeAction(CodeActio
         return CodeActions.mergeAndConvertCodeActions(this, dedicatedLanguageName, contribs.getName(), quickfixes, codeActions);
     }
 
+    @Override
+    public CompletableFuture<List<? extends TextEdit>> formatting(DocumentFormattingParams params) {
+        logger.debug("Formatting: {}", params);
+
+        TextDocumentIdentifier uri = params.getTextDocument();
+        final ILanguageContributions contribs = contributions(uri);
+
+        // call the `formatting` implementation of the relevant language contribution
+        return getFile(uri)
+            .getCurrentTreeAsync()
+            .thenApply(Versioned::get)
+            .thenCompose(tree -> {
+                final var opts = getFormattingOptions(params.getOptions());
+                return contribs.formatting(VF.list(tree), opts).get();
+            })
+            .thenApply(l -> DocumentChanges.translateTextEdits(this, l, Map.of()));
+    }
+
+    @Override
+    public CompletableFuture<List<? extends TextEdit>> rangeFormatting(DocumentRangeFormattingParams params) {
+        logger.debug("Formatting range: {}", params);
+
+        TextDocumentIdentifier uri = params.getTextDocument();
+        Range range = params.getRange();
+        final ILanguageContributions contribs = contributions(uri);
+
+        // call the `formatting` implementation of the relevant language contribution
+        var fileState = getFile(uri);
+        return fileState
+            .getCurrentTreeAsync()
+            .thenApply(Versioned::get)
+            .thenCompose(tree -> {
+                // just a range
+                var start = Locations.toRascalPosition(uri, range.getStart(), columns);
+                var end = Locations.toRascalPosition(uri, range.getEnd(), columns);
+                // compute the focus list at the end of the range
+                var focus = TreeSearch.computeFocusList(tree, start.getLine(), start.getCharacter(), end.getLine(), end.getCharacter());
+
+                var opts = getFormattingOptions(params.getOptions());
+                return contribs.formatting(focus, opts).get();
+            })
+            // convert the document changes
+            .thenApply(l -> DocumentChanges.translateTextEdits(this, l, Map.of())
+                .stream()
+                .filter(e -> Ranges.containsRange(range, e.getRange()))
+                .collect(Collectors.toList()));
+    }
+
+    private IConstructor getFormattingOptions(FormattingOptions options) {
+        var optionsType = tf.abstractDataType(typeStore, "FormattingOptions");
+        var consType = tf.constructor(typeStore, optionsType, "formattingOptions");
+        var opts = Map.of(
+            "tabSize", VF.integer(options.getTabSize()),
+            "insertSpaces", VF.bool(options.isInsertSpaces()),
+            "trimTrailingWhitespace", VF.bool(options.isTrimTrailingWhitespace()),
+            "insertFinalNewline", VF.bool(options.isInsertFinalNewline()),
+            "trimFinalNewlines", VF.bool(options.isTrimFinalNewlines())
+        );
+        return VF.constructor(consType, new IValue[0], opts);
+    }
+
     private CompletableFuture<IList> computeCodeActions(final ILanguageContributions contribs, final int startLine, final int startColumn, ITree tree) {
         IList focus = TreeSearch.computeFocusList(tree, startLine, startColumn);
 

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

@@ -189,6 +189,16 @@ public InterruptibleFuture<IList> codeAction(IList focus) {
         return InterruptibleFuture.completedFuture(VF.list());
     }
 
+    @Override
+    public InterruptibleFuture<IList> formatting(IList focus, IConstructor formattingOptions) {
+        return InterruptibleFuture.completedFuture(VF.list());
+    }
+
+    @Override
+    public CompletableFuture<Boolean> hasFormatting() {
+        return CompletableFuture.completedFuture(false);
+    }
+
     @Override
     public InterruptibleFuture<ISet> implementation(IList focus) {
         return InterruptibleFuture.completedFuture(VF.set());

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

@@ -48,6 +48,7 @@ private LanguageContributions () {}
         public static final String IMPLEMENTATION = "implementation";
         public static final String CODE_ACTION = "codeAction";
         public static final String SELECTION_RANGE = "selectionRange";
+        public static final String FORMATTING = "formatting";
 
         public static final String RENAME_SERVICE = "renameService";
         public static final String PREPARE_RENAME_SERVICE = "prepareRenameService";

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

@@ -366,7 +366,8 @@ public CompletableFuture<Either3<Range, PrepareRenameResult, PrepareRenameDefaul
                 IList focus = TreeSearch.computeFocusList(tr, rascalCursorPos.getLine(), rascalCursorPos.getCharacter());
                 return findQualifiedNameUnderCursor(focus);
             })
-            .thenApply(cur -> DocumentChanges.locationToRange(this, TreeAdapter.getLocation(cur)))
+            .thenApply(TreeAdapter::getLocation)
+            .thenApply(loc -> Locations.toRange(loc, columns))
             .thenApply(Either3::forFirst);
     }
 

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

@@ -97,11 +97,12 @@ public static WorkspaceEdit translateDocumentChanges(final IBaseTextDocumentServ
         return wsEdit;
     }
 
-    private static List<TextEdit> translateTextEdits(final IBaseTextDocumentService docService, IList edits, Map<String, ChangeAnnotation> changeAnnotations) {
+    public static List<TextEdit> translateTextEdits(final IBaseTextDocumentService docService, IList edits, Map<String, ChangeAnnotation> changeAnnotations) {
         return edits.stream()
             .map(IConstructor.class::cast)
             .map(c -> {
-                var range = locationToRange(docService, (ISourceLocation) c.get("range"));
+                var loc = (ISourceLocation) c.get("range");
+                var range = Locations.toRange(loc, docService.getColumnMap(loc));
                 var replacement = ((IString) c.get("replacement")).getValue();
                 // Check annotation
                 var kw = c.asWithKeywordParameters();
@@ -125,11 +126,6 @@ private static List<TextEdit> translateTextEdits(final IBaseTextDocumentService
             .collect(Collectors.toList());
     }
 
-    public static Range locationToRange(final IBaseTextDocumentService docService, ISourceLocation loc) {
-        LineColumnOffsetMap columnMap = docService.getColumnMap(loc);
-        return Locations.toRange(loc, columnMap);
-    }
-
     private static String getFileURI(IConstructor edit, String label) {
         return ((ISourceLocation) edit.get(label)).getURI().toString();
     }