V614-021: Use completion weight in sortText

In order to place items with an higher weight at the
top of the completion window.

Author: Anthony Leonardo Gracio

source/ada/lsp-ada_completions-names.adb

@@ -128,7 +128,8 @@ package body LSP.Ada_Completions.Names is
                (Is_Dot_Call  => False,
                 Is_Visible   => True,
                 Use_Snippets => Use_Snippets,
-                Pos          => 1));
+                Pos          => 1,
+                Weight       => 0));
             return;
          end if;
       end if;
@@ -174,7 +175,8 @@ package body LSP.Ada_Completions.Names is
                         (Is_Dot_Call (Item),
                          Is_Visible (Item),
                          Use_Snippets,
-                         Completion_Count));
+                         Completion_Count,
+                         Weight (Item)));
                   end if;
                end loop;
             end if;

source/ada/lsp-ada_completions.adb

@@ -99,6 +99,7 @@ package body LSP.Ada_Completions is
                         Is_Dot_Call              => Info.Is_Dot_Call,
                         Is_Visible               => Info.Is_Visible,
                         Pos                      => Info.Pos,
+                        Weight                   => Info.Weight,
                         Completions_Count        => Length));
                end if;
             end;

source/ada/lsp-ada_completions.ads

@@ -43,6 +43,10 @@ package LSP.Ada_Completions is
    --  for completion, since LAL can return several times the same declaration
    --  and specially subprograms from generic instantiations.
 
+   subtype Completion_Item_Weight_Type is Integer range 0 .. 100;
+   --  Type representing the weight returned by LAL for each completion item.
+   --  Used to sort them accordingly on the client-side.
+
    type Name_Information is record
       Is_Dot_Call  : Boolean;
       --  True if we are dealing with a dotted call.
@@ -57,6 +61,9 @@ package LSP.Ada_Completions is
       Pos          : Integer := -1;
       --  The position of the item in the fully computed completion list. Used
       --  for sorting properly the items on client-side.
+
+      Weight : Completion_Item_Weight_Type := 0;
+      --  The completion item's weight. Used for sorting on the client-side.
    end record;
 
    package Completion_Maps is new Ada.Containers.Hashed_Maps

source/ada/lsp-ada_documents.adb

@@ -1838,6 +1838,7 @@ package body LSP.Ada_Documents is
       Is_Dot_Call              : Boolean;
       Is_Visible               : Boolean;
       Pos                      : Integer;
+      Weight                   : Completion_Item_Weight_Type;
       Completions_Count        : Natural)
       return LSP.Messages.CompletionItem
    is
@@ -1860,14 +1861,22 @@ package body LSP.Ada_Documents is
 
       function Get_Sort_Text
         (Base_Label : VSS.Strings.Virtual_String)
-         return VSS.Strings.Virtual_String is
+         return VSS.Strings.Virtual_String
+      is
+         use VSS.Strings;
       begin
          return Sort_Text : VSS.Strings.Virtual_String do
-            if Pos /= -1 then
-               Sort_Text :=
-                 VSS.Strings.Conversions.To_Virtual_String
-                   (GNATCOLL.Utils.Image (Pos, Min_Width => Min_Width));
-            end if;
+
+            Sort_Text :=
+              VSS.Strings.Conversions.To_Virtual_String
+                (GNATCOLL.Utils.Image
+                   (Value     => Completion_Item_Weight_Type'Last - Weight,
+                    Min_Width =>
+                      Completion_Item_Weight_Type'Last'Img'Length - 1)) & "&";
+
+            Sort_Text := Sort_Text &
+              VSS.Strings.Conversions.To_Virtual_String
+              (GNATCOLL.Utils.Image (Pos, Min_Width => Min_Width));
 
             Sort_Text.Append (Base_Label);
 
@@ -2146,7 +2155,8 @@ package body LSP.Ada_Documents is
                (Is_Dot_Call  => False,
                 Is_Visible   => False,
                 Use_Snippets => False,
-                Pos          => <>));
+                Pos          => <>,
+                Weight       => <>));
          end if;
       end Insert;
 

source/ada/lsp-ada_documents.ads

@@ -33,7 +33,7 @@ with GNATCOLL.Traces;
 with Pp.Command_Lines;
 
 limited with LSP.Ada_Contexts;
-with LSP.Ada_Completions;
+with LSP.Ada_Completions; use LSP.Ada_Completions;
 with LSP.Ada_Highlighters;
 with LSP.Diagnostic_Sources;
 with LSP.Messages;
@@ -252,6 +252,7 @@ package LSP.Ada_Documents is
       Is_Dot_Call              : Boolean;
       Is_Visible               : Boolean;
       Pos                      : Integer;
+      Weight                   : Completion_Item_Weight_Type;
       Completions_Count        : Natural)
       return LSP.Messages.CompletionItem;
    --  Compute a completion item.
@@ -264,6 +265,8 @@ package LSP.Ada_Documents is
    --  named notation is used for subprogram completion snippets.
    --  Is_Dot_Call is used to know if we should omit the first parameter
    --  when computing subprogram snippets.
+   --  Weight is used for sorting: items with an higher weight will be placed
+   --  at the top.
    --  Completions_Count is the total number of completion items.
 
    procedure Set_Completion_Item_Documentation

source/ada/lsp-ada_handlers-invisibles.adb

@@ -68,7 +68,8 @@ package body LSP.Ada_Handlers.Invisibles is
                (Is_Dot_Call  => False,
                 Is_Visible   => False,
                 Use_Snippets => False,
-                Pos          => Pos));
+                Pos          => Pos,
+                Weight       => <>));
 
             Pos := Pos + 1;
 

source/ada/lsp-ada_handlers.adb

@@ -5121,7 +5121,8 @@ package body LSP.Ada_Handlers is
                (Is_Dot_Call  => False,
                 Is_Visible   => False,
                 Use_Snippets => False,
-                Pos          => <>));
+                Pos          => <>,
+                Weight       => <>));
          end if;
 
          Stop := Canceled.Has_Been_Canceled;

testsuite/ada_lsp/U915-024.completion.invisible_snippets/test.json

@@ -204,7 +204,7 @@
                      {
                         "label": "Do_Something (invisible)",
                         "kind": 3,
-                        "sortText": "~0Do_Something",
+                        "sortText": "~100&0Do_Something",
                         "filterText": "Do_Something",
                         "insertText": "Do_Something",
                         "additionalTextEdits": [],

testsuite/ada_lsp/U921-010.completion.no_generic_duplicates/test.json

@@ -244,7 +244,7 @@
                      {
                         "label": "Primitive",
                         "kind": 3,
-                        "sortText": "2Primitive",
+                        "sortText": "100&2Primitive",
                         "insertText": "Primitive (${1:Obj : Parent})$0",
                         "insertTextFormat": 2,
                         "additionalTextEdits": [],

testsuite/ada_lsp/completion.duplicates/test.json

@@ -199,7 +199,7 @@
                      {
                         "label": "Do_Something",
                         "kind": 3,
-                        "sortText": "2Do_Something",
+                        "sortText": "100&2Do_Something",
                         "additionalTextEdits": [],
                         "data": {
                            "uri": "$URI{main.adb}",