Move File_Span_Sets to a dedicated file

Refs #1141

Author: reznikmm

source/ada/lsp-ada_handlers-call_hierarchy.adb

@@ -23,6 +23,7 @@ with Laltools.Common;
 with Laltools.Call_Hierarchy;
 
 with LSP.GNATCOLL_Tracers.Handle;
+with LSP.Ada_Handlers.Locations;
 with LSP.Utils;
 
 package body LSP.Ada_Handlers.Call_Hierarchy is
@@ -69,7 +70,7 @@ package body LSP.Ada_Handlers.Call_Hierarchy is
    procedure Find_Incoming_Calls
      (Self        : in out Message_Handler;
       Response    : in out LSP.Structures.CallHierarchyIncomingCall_Vector;
-      Filter      : in out LSP.Ada_Handlers.Locations.File_Span_Sets.Set;
+      Filter      : in out LSP.Locations.File_Span_Sets.Set;
       Context     : LSP.Ada_Contexts.Context;
       Definition  : Libadalang.Analysis.Defining_Name)
    is
@@ -206,7 +207,7 @@ package body LSP.Ada_Handlers.Call_Hierarchy is
    procedure Find_Outgoing_Calls
      (Self        : in out Message_Handler;
       Response    : in out LSP.Structures.CallHierarchyOutgoingCall_Vector;
-      Filter      : in out LSP.Ada_Handlers.Locations.File_Span_Sets.Set;
+      Filter      : in out LSP.Locations.File_Span_Sets.Set;
       Definition  : Libadalang.Analysis.Defining_Name)
    is
       use Laltools.Common.References_By_Subprogram;

source/ada/lsp-ada_handlers-call_hierarchy.ads

@@ -18,14 +18,14 @@
 with Libadalang.Analysis;
 
 with LSP.Ada_Contexts;
-with LSP.Ada_Handlers.Locations;
+with LSP.Locations;
 
 package LSP.Ada_Handlers.Call_Hierarchy is
 
    procedure Find_Incoming_Calls
      (Self        : in out Message_Handler;
       Response    : in out LSP.Structures.CallHierarchyIncomingCall_Vector;
-      Filter      : in out LSP.Ada_Handlers.Locations.File_Span_Sets.Set;
+      Filter      : in out LSP.Locations.File_Span_Sets.Set;
       Context     : LSP.Ada_Contexts.Context;
       Definition  : Libadalang.Analysis.Defining_Name)
           with Pre => Definition.P_Basic_Decl.P_Is_Subprogram;
@@ -36,7 +36,7 @@ package LSP.Ada_Handlers.Call_Hierarchy is
    procedure Find_Outgoing_Calls
      (Self        : in out Message_Handler;
       Response    : in out LSP.Structures.CallHierarchyOutgoingCall_Vector;
-      Filter      : in out LSP.Ada_Handlers.Locations.File_Span_Sets.Set;
+      Filter      : in out LSP.Locations.File_Span_Sets.Set;
       Definition  : Libadalang.Analysis.Defining_Name)
           with Pre => Definition.P_Basic_Decl.P_Is_Subprogram;
    --  Return the list of all the calls made in the subprogram pointed at by

source/ada/lsp-ada_handlers-locations.adb

@@ -38,7 +38,7 @@ package body LSP.Ada_Handlers.Locations is
    procedure Append_Location
      (Self   : in out Message_Handler;
       Result : in out LSP.Structures.Location_Vector;
-      Filter : in out LSP.Ada_Handlers.Locations.File_Span_Sets.Set;
+      Filter : in out LSP.Locations.File_Span_Sets.Set;
       Node   : Libadalang.Analysis.Ada_Node'Class;
       Kinds  : LSP.Structures.AlsReferenceKind_Set := LSP.Constants.Empty) is
    begin
@@ -132,17 +132,6 @@ package body LSP.Ada_Handlers.Locations is
       end;
    end Get_Node_At;
 
-   ----------
-   -- Hash --
-   ----------
-
-   function Hash
-     (Value : LSP.Structures.Location) return Ada.Containers.Hash_Type is
-      use type Ada.Containers.Hash_Type;
-   begin
-      return Value.uri.Get_Hash + LSP.Utils.Hash (Value.a_range);
-   end Hash;
-
    ----------
    -- Sort --
    ----------

source/ada/lsp-ada_handlers-locations.ads

@@ -26,18 +26,10 @@ with Libadalang.Common;
 
 with LSP.Ada_Contexts;
 with LSP.Constants;
+with LSP.Locations;
 
 package LSP.Ada_Handlers.Locations is
 
-   function Hash
-     (Value : LSP.Structures.Location) return Ada.Containers.Hash_Type;
-
-   package File_Span_Sets is new Ada.Containers.Hashed_Sets
-     (Element_Type        => LSP.Structures.Location,
-      Hash                => Hash,
-      Equivalent_Elements => LSP.Structures."=",
-      "="                 => LSP.Structures."=");
-
    function To_LSP_Location
      (Self : in out Message_Handler'Class;
       Node : Libadalang.Analysis.Ada_Node'Class;
@@ -66,7 +58,7 @@ package LSP.Ada_Handlers.Locations is
    procedure Append_Location
      (Self   : in out Message_Handler;
       Result : in out LSP.Structures.Location_Vector;
-      Filter : in out LSP.Ada_Handlers.Locations.File_Span_Sets.Set;
+      Filter : in out LSP.Locations.File_Span_Sets.Set;
       Node   : Libadalang.Analysis.Ada_Node'Class;
       Kinds  : LSP.Structures.AlsReferenceKind_Set := LSP.Constants.Empty);
    --  Append given Node location to the Result.

source/ada/lsp-ada_handlers-renaming.adb

@@ -28,7 +28,7 @@ with LAL_Refactor.Safe_Rename;
 
 with LSP.Ada_Contexts;
 with LSP.Ada_Handlers.Locations;
-with LSP.Utils;
+with LSP.Locations;
 
 package body LSP.Ada_Handlers.Renaming is
 
@@ -53,14 +53,14 @@ package body LSP.Ada_Handlers.Renaming is
                      Result := @ + Ada.Containers.Hash_Type'Mod
                        (Item.TextEdit.newText.Hash);
 
-                     Result := @ + LSP.Utils.Hash (Item.TextEdit.a_range);
+                     Result := @ + LSP.Locations.Hash (Item.TextEdit.a_range);
 
                   when False =>
                      Result := @ + Ada.Containers.Hash_Type'Mod
                        (Item.AnnotatedTextEdit.newText.Hash);
 
                      Result := @ +
-                       LSP.Utils.Hash (Item.AnnotatedTextEdit.a_range);
+                       LSP.Locations.Hash (Item.AnnotatedTextEdit.a_range);
                end case;
             end loop;
 

source/ada/lsp-ada_handlers.adb

@@ -94,6 +94,7 @@ with LSP.Errors;
 with LSP.Formatters.Texts;
 with LSP.Generic_Cancel_Check;
 with LSP.GNATCOLL_Tracers.Handle;
+with LSP.Locations;
 with LSP.Predefined_Completion;
 with LSP.Search;
 with LSP.Servers;
@@ -156,7 +157,7 @@ package body LSP.Ada_Handlers is
    procedure Append_Location
      (Self   : in out Message_Handler;
       Result : in out LSP.Structures.Location_Vector;
-      Filter : in out LSP.Ada_Handlers.Locations.File_Span_Sets.Set;
+      Filter : in out LSP.Locations.File_Span_Sets.Set;
       Node   : Libadalang.Analysis.Ada_Node'Class;
       Kinds  : AlsReferenceKind_Array := LSP.Constants.Empty)
         renames LSP.Ada_Handlers.Locations.Append_Location;
@@ -1711,7 +1712,7 @@ package body LSP.Ada_Handlers is
 
       Response   : LSP.Structures.Declaration_Result (LSP.Structures.Variant_1);
       Vector     : LSP.Structures.Location_Vector renames Response.Variant_1;
-      Filter     : LSP.Ada_Handlers.Locations.File_Span_Sets.Set;
+      Filter     : LSP.Locations.File_Span_Sets.Set;
 
       Display_Method_Policy : constant
         LSP.Enumerations.AlsDisplayMethodAncestryOnNavigationPolicy :=
@@ -1865,7 +1866,7 @@ package body LSP.Ada_Handlers is
 
       Response   : LSP.Structures.Definition_Result (LSP.Structures.Variant_1);
       Vector     : LSP.Structures.Location_Vector renames Response.Variant_1;
-      Filter     : LSP.Ada_Handlers.Locations.File_Span_Sets.Set;
+      Filter     : LSP.Locations.File_Span_Sets.Set;
 
       Imprecise  : Boolean := False;
 
@@ -3013,7 +3014,7 @@ package body LSP.Ada_Handlers is
       Response : LSP.Structures.Definition_Result (LSP.Structures.Variant_1);
 
       Vector : LSP.Structures.Location_Vector renames Response.Variant_1;
-      Filter : LSP.Ada_Handlers.Locations.File_Span_Sets.Set;
+      Filter : LSP.Locations.File_Span_Sets.Set;
 
       Display_Method_Policy : constant
         LSP.Enumerations.AlsDisplayMethodAncestryOnNavigationPolicy :=
@@ -3151,7 +3152,7 @@ package body LSP.Ada_Handlers is
         (textDocument => (uri => Item.uri),
          position     => Item.selectionRange.start);
 
-      Filter : LSP.Ada_Handlers.Locations.File_Span_Sets.Set;
+      Filter : LSP.Locations.File_Span_Sets.Set;
 
       ---------------------
       -- Process_Context --
@@ -3500,7 +3501,7 @@ package body LSP.Ada_Handlers is
         (textDocument => (uri => Item.uri),
          position     => Item.selectionRange.start);
 
-      Filter : LSP.Ada_Handlers.Locations.File_Span_Sets.Set;
+      Filter : LSP.Locations.File_Span_Sets.Set;
 
       ---------------------
       -- Process_Context --
@@ -3718,7 +3719,7 @@ package body LSP.Ada_Handlers is
 
       Response   : LSP.Structures.Location_Vector_Or_Null;
       Imprecise  : Boolean := False;
-      Filter     : LSP.Ada_Handlers.Locations.File_Span_Sets.Set;
+      Filter     : LSP.Locations.File_Span_Sets.Set;
 
       Additional_Kinds : AlsReferenceKind_Array :=
         [others => False];
@@ -4419,7 +4420,7 @@ package body LSP.Ada_Handlers is
 
       Response   : LSP.Structures.Definition_Result (LSP.Structures.Variant_1);
       Vector     : LSP.Structures.Location_Vector renames Response.Variant_1;
-      Filter     : LSP.Ada_Handlers.Locations.File_Span_Sets.Set;
+      Filter     : LSP.Locations.File_Span_Sets.Set;
       Imprecise  : Boolean := False;
 
       procedure Resolve_In_Context (C : LSP.Ada_Context_Sets.Context_Access);

source/ada/lsp-locations.ads

@@ -0,0 +1,45 @@
+------------------------------------------------------------------------------
+--                         Language Server Protocol                         --
+--                                                                          --
+--                     Copyright (C) 2018-2023, AdaCore                     --
+--                                                                          --
+-- This is free software;  you can redistribute it  and/or modify it  under --
+-- terms of the  GNU General Public License as published  by the Free Soft- --
+-- ware  Foundation;  either version 3,  or (at your option) any later ver- --
+-- sion.  This software is distributed in the hope  that it will be useful, --
+-- but WITHOUT ANY WARRANTY;  without even the implied warranty of MERCHAN- --
+-- TABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public --
+-- License for  more details.  You should have  received  a copy of the GNU --
+-- General  Public  License  distributed  with  this  software;   see  file --
+-- COPYING3.  If not, go to http://www.gnu.org/licenses for a complete copy --
+-- of the license.                                                          --
+------------------------------------------------------------------------------
+
+with Ada.Containers.Hashed_Sets;
+
+with LSP.Structures;
+
+package LSP.Locations is
+
+   use type Ada.Containers.Hash_Type;
+
+   Prime : constant := 271;
+
+   function Hash
+     (Value : LSP.Structures.A_Range) return Ada.Containers.Hash_Type is
+       (Prime * Ada.Containers.Hash_Type'Mod (Value.start.line)
+        + Ada.Containers.Hash_Type'Mod (Value.start.character)
+        + Prime * Ada.Containers.Hash_Type'Mod (Value.an_end.line)
+        + Ada.Containers.Hash_Type'Mod (Value.an_end.character));
+
+   function Hash
+     (Value : LSP.Structures.Location) return Ada.Containers.Hash_Type is
+       (Value.uri.Get_Hash + Hash (Value.a_range));
+
+   package File_Span_Sets is new Ada.Containers.Hashed_Sets
+     (Element_Type        => LSP.Structures.Location,
+      Hash                => Hash,
+      Equivalent_Elements => LSP.Structures."=",
+      "="                 => LSP.Structures."=");
+
+end LSP.Locations;

source/ada/lsp-utils.adb

@@ -454,25 +454,6 @@ package body LSP.Utils is
       return Std = Unit;
    end Is_Synthetic;
 
-   ----------
-   -- Hash --
-   ----------
-
-   function Hash
-     (Value : LSP.Structures.A_Range) return Ada.Containers.Hash_Type
-   is
-      use type Ada.Containers.Hash_Type;
-      Prime : constant := 271;
-      From  : constant Ada.Containers.Hash_Type :=
-        Prime * Ada.Containers.Hash_Type'Mod (Value.start.line)
-        + Ada.Containers.Hash_Type'Mod (Value.start.character);
-      To    : constant Ada.Containers.Hash_Type :=
-        Prime * Ada.Containers.Hash_Type'Mod (Value.an_end.line)
-        + Ada.Containers.Hash_Type'Mod (Value.an_end.character);
-   begin
-      return From + To;
-   end Hash;
-
    -------------------------
    -- Node_Location_Image --
    -------------------------

source/ada/lsp-utils.ads

@@ -17,8 +17,6 @@
 
 --  This package provides some utility subprograms.
 
-with Ada.Containers;
-
 with VSS.Strings;
 
 with Libadalang.Analysis;
@@ -75,9 +73,6 @@ package LSP.Utils is
    --  to convert LAL's Source_Location_Range to LSP's Range. Consider to
    --  use Document.To_LSP_Range instead, or add necessary wrapper.
 
-   function Hash
-     (Value : LSP.Structures.A_Range) return Ada.Containers.Hash_Type;
-
    function Is_Synthetic
      (Node : Libadalang.Analysis.Ada_Node'Class) return Boolean;
    --  Check if Node is in a synthetic file (like "__standard").