Merge branch 'topic/show_deps' into 'master'

Replace `textDocument/alsShowDependencies` request

See merge request eng/ide/ada_language_server!1397

Author: reznikmm

doc/show_dependencies.md

@@ -8,8 +8,8 @@ a given unit.
 
 ## Capabilities
 
-The `initialize` request returns a boolean `alsShowDepsProvider` as part of
-the `capabilities`, set to true if the server supports this functionality.
+The `initialize` request returns `als-show-dependencies` in the list of
+supported commands if the server supports this functionality.
 
 ## Change description
 
@@ -23,7 +23,7 @@ export namespace ALS_ShowDependenciesKind {
 }
 
 interface ALS_ShowDependenciesParams {
-   textDocument : TextDocumentIdentifier; /* The queried unit */
+   uri          : DocumentUri; /* The queried unit */
    kind         : ALS_ShowDependenciesKind; /* The dependencies query kind */
    showImplicit : boolean; /* True if implicit dependencies should be returned */
 }
@@ -34,15 +34,16 @@ interface ALS_Unit_Description {
 }
 ```
 
-And a new request:
+And a new command `als-show-dependencies`:
 
-  method: `textDocument/alsShowDependencies`
-  params: `ALS_ShowDependenciesParams`
+    method: `workspace/executeCommand`
+    "params": {
+       "command": "als-show-dependencies",
+       "arguments": [
+          <ALS_ShowDependenciesParams>
+       ]
+    }
 
-Returning the references to the method identified at the given position:
+It returns list of `ALS_Unit_Description`:
 
   result: `ALS_Unit_Description[]`
-
-We also introduce a new boolean field `ALS_showDepsProvider` in the
-interface `ServerCapabilities` indicating whether the server supports
-this extension.

gnat/ignore_in_317.txt

@@ -40,17 +40,11 @@ project LSP_Server is
 
    for Source_Dirs use
      ("../source/server",
-      "../source/server/generated",
       "../source/ada",
       "../source/gpr",
       "../source/ada/generated",
       "../source/memory");
 
-   for Excluded_Source_Dirs use
-     ("../source/server/generated");
-
-   for Excluded_Source_List_File use "ignore_in_317.txt";
-
    for Object_Dir use "../.obj/server";
    for Main use ("lsp-ada_driver.adb");
 

gnat/lsp_server.gpr

@@ -41,9 +41,10 @@ package LSP.Ada_Commands is
       return Command is abstract;
 
    procedure Execute
-     (Self    : Command;
-      Handler : not null access LSP.Ada_Handlers.Message_Handler'Class;
-      Error   : in out LSP.Errors.ResponseError_Optional) is abstract;
+     (Self     : Command;
+      Handler  : not null access LSP.Ada_Handlers.Message_Handler'Class;
+      Response : in out LSP.Structures.LSPAny_Or_Null;
+      Error    : in out LSP.Errors.ResponseError_Optional) is abstract;
    --  Execute given command and return Error is something went wrong.
    --  Commands are executed on the server side only.
    --  The Handler is the access to the message handler executing the command.

source/ada/lsp-ada_commands.ads

@@ -55,6 +55,7 @@ with LSP.Ada_Handlers.Refactor.Remove_Parameter;
 with LSP.Ada_Handlers.Refactor.Replace_Type;
 with LSP.Ada_Handlers.Refactor.Sort_Dependencies;
 with LSP.Ada_Handlers.Refactor.Suppress_Seperate;
+with LSP.Ada_Handlers.Show_Dependencies_Commands;
 with LSP.Ada_Handlers.Suspend_Executions;
 with LSP.GNATCOLL_Trace_Streams;
 with LSP.GNATCOLL_Tracers;
@@ -88,6 +89,8 @@ procedure LSP.Ada_Driver is
         (LSP.Ada_Handlers.Suspend_Executions.Suspend_Execution'Tag);
       LSP.Ada_Commands.Register
         (LSP.Ada_Handlers.Project_Reload_Commands.Command'Tag);
+      LSP.Ada_Commands.Register
+        (LSP.Ada_Handlers.Show_Dependencies_Commands.Command'Tag);
       LSP.Ada_Commands.Register
         (LSP.Ada_Handlers.Named_Parameters_Commands.Command'Tag);
       LSP.Ada_Commands.Register

source/ada/lsp-ada_driver.adb

@@ -145,10 +145,12 @@ package body LSP.Ada_Handlers.Named_Parameters_Commands is
    -------------
 
    overriding procedure Execute
-     (Self    : Command;
-      Handler : not null access LSP.Ada_Handlers.Message_Handler'Class;
-      Error   : in out LSP.Errors.ResponseError_Optional)
+     (Self     : Command;
+      Handler  : not null access LSP.Ada_Handlers.Message_Handler'Class;
+      Response : in out LSP.Structures.LSPAny_Or_Null;
+      Error    : in out LSP.Errors.ResponseError_Optional)
    is
+      pragma Unreferenced (Response);
       use LSP.Structures;
 
       procedure Append
@@ -159,9 +161,6 @@ package body LSP.Ada_Handlers.Named_Parameters_Commands is
       Apply  : LSP.Structures.ApplyWorkspaceEditParams;
       Edits  : LSP.Structures.WorkspaceEdit renames Apply.edit;
 
-      Message_Handler : LSP.Ada_Handlers.Message_Handler renames
-        LSP.Ada_Handlers.Message_Handler (Handler.all);
-
       ------------
       -- Append --
       ------------
@@ -201,10 +200,10 @@ package body LSP.Ada_Handlers.Named_Parameters_Commands is
       end Append;
 
       Context  : LSP.Ada_Contexts.Context renames
-        Message_Handler.Contexts.Get (Self.Context).all;
+        Handler.Contexts.Get (Self.Context).all;
 
       Document : constant LSP.Ada_Documents.Document_Access :=
-        Message_Handler.Get_Open_Document (Self.Where.textDocument.uri);
+        Handler.Get_Open_Document (Self.Where.textDocument.uri);
 
       Node : Libadalang.Analysis.Ada_Node :=
         Document.Get_Node_At (Context, Self.Where.position);

source/ada/lsp-ada_handlers-named_parameters_commands.adb

@@ -52,9 +52,10 @@ private
        return Command;
 
    overriding procedure Execute
-     (Self    : Command;
-      Handler : not null access LSP.Ada_Handlers.Message_Handler'Class;
-      Error   : in out LSP.Errors.ResponseError_Optional);
+     (Self     : Command;
+      Handler  : not null access LSP.Ada_Handlers.Message_Handler'Class;
+      Response : in out LSP.Structures.LSPAny_Or_Null;
+      Error    : in out LSP.Errors.ResponseError_Optional);
 
    function Write_Command
      (Self : Command) return LSP.Structures.LSPAny_Vector;

source/ada/lsp-ada_handlers-named_parameters_commands.ads

@@ -74,10 +74,12 @@ package body LSP.Ada_Handlers.Other_File_Commands is
    -------------
 
    overriding procedure Execute
-     (Self    : Command;
-      Handler : not null access LSP.Ada_Handlers.Message_Handler'Class;
-      Error   : in out LSP.Errors.ResponseError_Optional)
+     (Self     : Command;
+      Handler  : not null access LSP.Ada_Handlers.Message_Handler'Class;
+      Response : in out LSP.Structures.LSPAny_Or_Null;
+      Error    : in out LSP.Errors.ResponseError_Optional)
    is
+      pragma Unreferenced (Response);
       File : constant GNATCOLL.VFS.Virtual_File :=
         Handler.To_File (Self.URI);
 

source/ada/lsp-ada_handlers-other_file_commands.adb

@@ -39,9 +39,10 @@ private
        return Command;
 
    overriding procedure Execute
-     (Self    : Command;
-      Handler : not null access LSP.Ada_Handlers.Message_Handler'Class;
-      Error   : in out LSP.Errors.ResponseError_Optional);
+     (Self     : Command;
+      Handler  : not null access LSP.Ada_Handlers.Message_Handler'Class;
+      Response : in out LSP.Structures.LSPAny_Or_Null;
+      Error    : in out LSP.Errors.ResponseError_Optional);
 
    for Command'External_Tag use "als-other-file";
 

source/ada/lsp-ada_handlers-other_file_commands.ads

@@ -37,9 +37,12 @@ package body LSP.Ada_Handlers.Project_Reload_Commands is
    -------------
 
    overriding procedure Execute
-     (Self    : Command;
-      Handler : not null access LSP.Ada_Handlers.Message_Handler'Class;
-      Error   : in out LSP.Errors.ResponseError_Optional) is
+     (Self     : Command;
+      Handler  : not null access LSP.Ada_Handlers.Message_Handler'Class;
+      Response : in out LSP.Structures.LSPAny_Or_Null;
+      Error    : in out LSP.Errors.ResponseError_Optional)
+   is
+      pragma Unreferenced (Response);
    begin
       LSP.Ada_Handlers.Project_Loading.Reload_Project (Handler.all);
    end Execute;