Merge pull request #651 from usethesource/feature/rename-refactoring/language-server-api

Design LSP rename API

Author: toinehartman

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

@@ -52,7 +52,8 @@ set[LanguageService] picoLanguageServer() = {
     execution(picoExecutionService),
     inlayHint(picoInlayHintService),
     definition(picoDefinitionService),
-    codeAction(picoCodeActionService)
+    codeAction(picoCodeActionService),
+    rename(picoRenamingService, prepareRenameService = picoRenamePreparingService)
 };
 
 @synopsis{This set of contributions runs slower but provides more detail.}
@@ -177,6 +178,15 @@ value picoExecutionService(removeDecl(start[Program] program, IdType toBeRemoved
     return ("result": true);
 }
 
+loc picoRenamePreparingService(Focus _:[Id id, *_]) = id.src;
+
+tuple[list[DocumentEdit], set[Message]] picoRenamingService(Focus focus, str newName) = <[changed(focus[0].src.top, [
+    replace(id.src, newName)
+    | cursor := focus[0]
+    , /Id id := focus[-1]
+    , id := cursor
+])], {}>;
+
 @synopsis{The main function registers the Pico language with the IDE}
 @description{
 Register the Pico language and the contributions that supply the IDE with features.

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

@@ -44,6 +44,7 @@ import analysis::diff::edits::TextEdits;
 import IO;
 import ParseTree;
 import Message;
+import Exception;
 
 @synopsis{Definition of a language server by its meta-data.}
 @description{
@@ -207,6 +208,9 @@ hover documentation, definition with uses, references to declarations, implement
 * The ((inlayHint)) service discovers plances to add "inlays" (little views embedded in the editor on the same line). Unlike ((lenses)) inlays do not offer command execution.
 * The ((execution)) service executes the commands registered by ((lenses)) and ((inlayHinter))s.
 * The ((actions)) service discovers places in the editor to add "code actions" (little hints in the margin next to where the action is relevant) and connects ((CodeAction))s to execute when the users selects the action from a menu.
+* The ((util::LanguageServer::rename)) service renames an identifier by collecting the edits required to rename all occurrences of that identifier. It might fail and report why in diagnostics.
+   * The optional `prepareRename` service argument discovers places in the editor where a ((util::LanguageServer::rename)) is possible. If renameing the location is not supported, it should throw an exception.
+* The ((didRenameFiles)) service collects ((DocumentEdit))s corresponding to renamed files (e.g. to rename a class when the class file was renamed). The IDE applies the edits after moving the files. It might fail and report why in diagnostics.
 
 Many services receive a ((Focus)) parameter. The focus lists the syntactical constructs under the current cursor, from the current
 leaf all the way up to the root of the tree. This list helps to create functionality that is syntax-directed, and always relevant to the
@@ -268,8 +272,14 @@ data LanguageService
     | references    (set[loc] (Focus _focus) referencesService)
     | implementation(set[loc] (Focus _focus) implementationService)
     | codeAction    (list[CodeAction] (Focus _focus) codeActionService)
+    | rename        (tuple[list[DocumentEdit], set[Message]] (Focus _focus, str newName) renameService
+        , loc (Focus _focus) prepareRenameService = defaultPrepareRenameService)
+    | didRenameFiles(tuple[list[DocumentEdit], set[Message]] (list[DocumentEdit] fileRenames) didRenameFilesService)
     ;
 
+loc defaultPrepareRenameService(Focus _:[Tree tr, *_]) = tr.src when tr.src?;
+default loc defaultPrepareRenameService(Focus focus) { throw IllegalArgument(focus, "Element under cursor does not have source location"); }
+
 @deprecated{Backward compatible with ((parsing)).}
 @synopsis{Construct a `parsing` ((LanguageService))}
 LanguageService parser(Parser parser) = parsing(parser);