Merge remote branch 'origin/master' into edge

(no-precommit-check no-tn-check)

Author: mergerepo

scripts/generate.py

@@ -257,6 +257,8 @@
      'CodeAction_Response'),
     ('textDocument/completion', 'Completion', 'TextDocumentPositionParams',
      'Completion_Response'),
+    ('completionItem/resolve', 'CompletionItemResolve', 'CompletionItem',
+     'CompletionItemResolve_Response'),
     ('textDocument/definition', 'Definition', 'DefinitionParams',
      'Location_Link_Response'),
     ('textDocument/declaration', 'Declaration', 'DeclarationParams',

source/ada/lsp-ada_completions.adb

@@ -43,6 +43,7 @@ package body LSP.Ada_Completions is
      (Context                  : LSP.Ada_Contexts.Context;
       Names                    : Completion_Maps.Map;
       Named_Notation_Threshold : Natural;
+      Compute_Doc_And_Details  : Boolean;
       Result                   : in out LSP.Messages.CompletionItem_Vector)
    is
       function Hash (Value : VSS.Strings.Virtual_String)
@@ -91,6 +92,7 @@ package body LSP.Ada_Completions is
                         BD                       => Name.P_Basic_Decl,
                         Label                    => Label,
                         Use_Snippets             => Info.Use_Snippets,
+                        Compute_Doc_And_Details  => Compute_Doc_And_Details,
                         Named_Notation_Threshold => Named_Notation_Threshold,
                         Is_Dot_Call              => Info.Is_Dot_Call,
                         Is_Visible               => Info.Is_Visible,
@@ -102,11 +104,11 @@ package body LSP.Ada_Completions is
       end loop;
    end Write_Completions;
 
-   -------------------
-   -- Write_Symbols --
-   -------------------
+   ---------------------------
+   -- Generic_Write_Symbols --
+   ---------------------------
 
-   procedure Write_Symbols
+   procedure Generic_Write_Symbols
      (Names  : Completion_Maps.Map;
       Result : in out LSP.Messages.Symbol_Vector) is
    begin
@@ -139,6 +141,6 @@ package body LSP.Ada_Completions is
             exit when Has_Been_Canceled;
          end;
       end loop;
-   end Write_Symbols;
+   end Generic_Write_Symbols;
 
 end LSP.Ada_Completions;

source/ada/lsp-ada_completions.ads

@@ -88,11 +88,19 @@ package LSP.Ada_Completions is
      (Context                  : LSP.Ada_Contexts.Context;
       Names                    : Completion_Maps.Map;
       Named_Notation_Threshold : Natural;
+      Compute_Doc_And_Details  : Boolean;
       Result                   : in out LSP.Messages.CompletionItem_Vector);
+   --  Convert all the completion Names into LSP completion items' results.
+   --  Named_Notation_Threshold defines the number of parameters/components at
+   --  which point named notation is used for subprogram/aggregate completion
+   --  snippets.
+   --  If Compute_Doc_And_Details is True, the 'detail' and 'documentation'
+   --  fields for all the resulting completion items will be computed
+   --  immediately, which might take time.
 
    generic
       with function Has_Been_Canceled return Boolean;
-   procedure Write_Symbols
+   procedure Generic_Write_Symbols
      (Names  : Completion_Maps.Map;
       Result : in out LSP.Messages.Symbol_Vector);
 

source/ada/lsp-ada_contexts.ads

@@ -232,7 +232,7 @@ package LSP.Ada_Contexts is
      (Self        : Context;
       Pattern     : LSP.Search.Search_Pattern'Class;
       Only_Public : Boolean;
-      Callback : not null access procedure
+      Callback    : not null access procedure
         (File : GNATCOLL.VFS.Virtual_File;
          Name : Libadalang.Analysis.Defining_Name;
          Stop : in out Boolean));

source/ada/lsp-ada_documents.adb

@@ -30,7 +30,6 @@ with Langkit_Support.Symbols;
 with Langkit_Support.Text;
 with Libadalang.Analysis; use Libadalang.Analysis;
 with Libadalang.Sources;
-with Libadalang.Doc_Utils;
 with Libadalang.Iterators;
 
 with VSS.String_Vectors;
@@ -1764,6 +1763,7 @@ package body LSP.Ada_Documents is
       BD                       : Libadalang.Analysis.Basic_Decl;
       Label                    : VSS.Strings.Virtual_String;
       Use_Snippets             : Boolean;
+      Compute_Doc_And_Details  : Boolean;
       Named_Notation_Threshold : Natural;
       Is_Dot_Call              : Boolean;
       Is_Visible               : Boolean;
@@ -1776,8 +1776,6 @@ package body LSP.Ada_Documents is
 
       Item           : CompletionItem;
       Subp_Spec_Node : Base_Subp_Spec;
-      Doc_Text       : VSS.Strings.Virtual_String;
-      Loc_Text       : VSS.Strings.Virtual_String;
       Min_Width      : constant Natural := Completions_Count'Img'Length - 1;
 
       function Get_Sort_text (Base_Label : LSP_String) return LSP_String;
@@ -1815,9 +1813,6 @@ package body LSP.Ada_Documents is
       Item.label := Label;
       Item.kind := (True, To_Completion_Kind
                             (LSP.Lal_Utils.Get_Decl_Kind (BD)));
-      Item.detail := (True,
-                      LSP.Types.To_LSP_String
-                        (LSP.Lal_Utils.Compute_Completion_Detail (BD)));
 
       declare
          Base_Label : constant LSP_String := LSP.Types.To_LSP_String
@@ -1836,41 +1831,39 @@ package body LSP.Ada_Documents is
          end if;
       end;
 
-      --  Property_Errors can occur when calling
-      --  Get_Documentation on unsupported docstrings, so
-      --  add an exception handler to catch them and recover.
-
-      begin
-         Doc_Text :=
-           VSS.Strings.To_Virtual_String
-             (Libadalang.Doc_Utils.Get_Documentation
-                (BD).Doc.To_String);
-
-         --  Append the declaration's location.
-         --  In addition, append the project's name if we are dealing with an
-         --  aggregate project.
-
-         Loc_Text.Append (LSP.Lal_Utils.Node_Location_Image (BD));
-
-         if not Doc_Text.Is_Empty then
-            Loc_Text.Append
-              (VSS.Strings.To_Virtual_String
-                 ((1 .. 2 => Ada.Characters.Wide_Wide_Latin_1.LF)));
-
-            Loc_Text.Append (Doc_Text);
-         end if;
-
-         Item.documentation :=
-           (Is_Set => True,
-            Value  => String_Or_MarkupContent'
-              (Is_String => True,
-               String    => Loc_Text));
-
-      exception
-         when E : Libadalang.Common.Property_Error =>
-            LSP.Common.Log (Context.Trace, E);
-            Item.documentation := (others => <>);
-      end;
+      --  Compute the 'documentation' and 'detail' fields immediately if
+      --  requested (i.e: when the client does not support lazy computation
+      --  for these fields).
+      if Compute_Doc_And_Details then
+         Item.detail :=
+           (True,
+            LSP.Types.To_LSP_String
+              (LSP.Lal_Utils.Compute_Completion_Detail (BD)));
+
+         --  Property_Errors can occur when calling
+         --  Get_Documentation on unsupported docstrings, so
+         --  add an exception handler to catch them and recover.
+         begin
+            Item.documentation :=
+              (Is_Set => True,
+               Value  => String_Or_MarkupContent'
+                 (Is_String => True,
+                  String    => LSP.Lal_Utils.Compute_Completion_Doc (BD)));
+
+         exception
+            when E : Libadalang.Common.Property_Error =>
+               LSP.Common.Log (Context.Trace, E);
+               Item.documentation := (others => <>);
+         end;
+      else
+         --  Set node's location to the 'data' field of the completion item, so
+         --  that we can retrieve it in the completionItem/resolve handler.
+         Item.data :=
+           (True,
+            (uri    => File_To_URI (BD.Unit.Get_Filename),
+             span   => LSP.Lal_Utils.To_Span (BD.Sloc_Range),
+             others => <>));
+      end if;
 
       --  Return immediately if we should not use snippets (e.g: completion for
       --  invisible symbols).
@@ -2018,6 +2011,7 @@ package body LSP.Ada_Documents is
       Pattern     : LSP.Search.Search_Pattern'Class;
       Limit       : Ada.Containers.Count_Type;
       Only_Public : Boolean;
+      Canceled    : access function return Boolean;
       Result      : in out LSP.Ada_Completions.Completion_Maps.Map)
    is
       use type LSP.Messages.Search_Kind;
@@ -2121,19 +2115,23 @@ package body LSP.Ada_Documents is
                then
                   Insert (Item);
                end if;
+
+               exit when Canceled.all;
             end loop;
 
          elsif Pattern.Match (Symbol_Maps.Key (Cursor)) then
             --  Symbol_Cache is case insensitive so if the key is matched
             --  this means that all elements are also matched the pattern
             for Item of Self.Symbol_Cache (Cursor) loop
                Insert (Item);
+
+               exit when Canceled.all;
             end loop;
 
          else
             --  Symbol_Cache is ordered so we will not find any
             --  matches more
-            exit when Use_Celling;
+            exit when Use_Celling or else Canceled.all;
          end if;
 
          Symbol_Maps.Next (Cursor);

source/ada/lsp-ada_documents.ads

@@ -147,6 +147,7 @@ package LSP.Ada_Documents is
       Pattern     : LSP.Search.Search_Pattern'Class;
       Limit       : Ada.Containers.Count_Type;
       Only_Public : Boolean;
+      Canceled    : access function return Boolean;
       Result  : in out LSP.Ada_Completions.Completion_Maps.Map);
    --  See Contexts.Get_Any_Symbol
 
@@ -234,6 +235,7 @@ package LSP.Ada_Documents is
       BD                       : Libadalang.Analysis.Basic_Decl;
       Label                    : VSS.Strings.Virtual_String;
       Use_Snippets             : Boolean;
+      Compute_Doc_And_Details  : Boolean;
       Named_Notation_Threshold : Natural;
       Is_Dot_Call              : Boolean;
       Is_Visible               : Boolean;

source/ada/lsp-ada_handlers-invisibles.adb

@@ -82,6 +82,8 @@ package body LSP.Ada_Handlers.Invisibles is
            then Libadalang.Common.Previous (Token, True)
            else Token);
 
+      function Dummy_Canceled return Boolean is (False);
+
    begin
       if Libadalang.Common.Kind (Dot_Token) = Ada_Dot then
          --  Don't provide completion after a dot
@@ -140,6 +142,7 @@ package body LSP.Ada_Handlers.Invisibles is
                      Pattern,
                      Limit,
                      True,
+                     Dummy_Canceled'Access,
                      Names);
                end loop;
             end;