U617-025: Index runtime files at startup

To allow having completion for runtime packages that are not
included yet, which is similar to what the have with the old engine.

An automatic test has also been added.

Author: AnthonyLeonardoGracio

source/ada/lsp-ada_contexts.adb

@@ -841,7 +841,8 @@ package body LSP.Ada_Contexts is
    procedure Index_File
      (Self    : in out Context;
       File    : GNATCOLL.VFS.Virtual_File;
-      Reparse : Boolean := True)
+      Reparse : Boolean := True;
+      PLE     : Boolean := True)
    is
       Unit : constant Libadalang.Analysis.Analysis_Unit :=
         Self.LAL_Context.Get_From_File
@@ -850,34 +851,32 @@ package body LSP.Ada_Contexts is
            Reparse => Reparse);
    begin
       Self.Source_Files.Index_File (File, Unit);
+
+      if PLE then
+         Libadalang.Analysis.Populate_Lexical_Env (Unit);
+      end if;
    end Index_File;
 
    --------------------
    -- Index_Document --
    --------------------
 
    procedure Index_Document
-     (Self     : Context;
+     (Self     : in out Context;
       Document : in out LSP.Ada_Documents.Document)
    is
-      File : constant Ada.Strings.UTF_Encoding.UTF_8_String :=
+      Filename : constant Ada.Strings.UTF_Encoding.UTF_8_String :=
         Self.URI_To_File (Document.URI);
-      Unit : Libadalang.Analysis.Analysis_Unit;
    begin
-      Document.Reset_Symbol_Cache;
       --  Reset cache of symbols to avoid access to stale references
+      Document.Reset_Symbol_Cache;
 
-      --  Preprocess the buffer
-      Unit := Self.LAL_Context.Get_From_File
-        (Filename => File,
-         Charset  => Ada.Strings.Unbounded.To_String (Self.Charset),
-         Reparse  => True);
-
-      --  After creating an analysis unit, populate the lexical env with it:
-      --  we do this to allow Libadalang to do some work in reaction to
-      --  a file being open in the IDE, in order to speed up the response
-      --  to user queries.
-      Libadalang.Analysis.Populate_Lexical_Env (Unit);
+      --  Index the file, calling Populate_Lexical_Env on it to speed up the
+      --  response to user queries.
+      Self.Index_File
+        (File    => Create_From_UTF8 (Filename),
+         Reparse => True,
+         PLE     => True);
    end Index_Document;
 
    -------------

source/ada/lsp-ada_contexts.ads

@@ -190,12 +190,15 @@ package LSP.Ada_Contexts is
    procedure Index_File
      (Self    : in out Context;
       File    : GNATCOLL.VFS.Virtual_File;
-      Reparse : Boolean := True);
+      Reparse : Boolean := True;
+      PLE     : Boolean := True);
    --  Index the given file. This translates to refreshing the Libadalang
    --  Analysis_Unit associated to it.
+   --  If PLE is True, Populate_Lexical_Env is called at the end, which will
+   --  increase the speed of semantic requests.
 
    procedure Index_Document
-     (Self     : Context;
+     (Self     : in out Context;
       Document : in out LSP.Ada_Documents.Document);
    --  Index/reindex the given document in this context
 

source/ada/lsp-ada_handlers-invisibles.adb

@@ -97,7 +97,8 @@ package body LSP.Ada_Handlers.Invisibles is
 
       if Node.Is_Null or else
         (not Node.Parent.Is_Null and then Node.Parent.Kind in
-           Libadalang.Common.Ada_Defining_Name_Range)
+           Libadalang.Common.Ada_Defining_Name_Range
+             | Libadalang.Common.Ada_Dotted_Name_Range)
       then
          return;
       end if;

source/ada/lsp-ada_handlers.adb

@@ -90,8 +90,11 @@ package body LSP.Ada_Handlers is
    Notifications_For_Imprecise : constant GNATCOLL.Traces.Trace_Handle :=
      GNATCOLL.Traces.Create ("ALS.NOTIFICATIONS_FOR_IMPRECISE_NAVIGATION",
                              GNATCOLL.Traces.Off);
-   --  Whether to send notifications to the client for "imprecise"
-   --  navigation operations.
+
+   Runtime_Indexing : constant GNATCOLL.Traces.Trace_Handle :=
+     GNATCOLL.Traces.Create ("ALS.RUNTIME_INDEXING",
+                             GNATCOLL.Traces.On);
+   --  Trace to enable/disable runtime indexing. Useful for the testsuite.
 
    Is_Parent : constant LSP.Messages.AlsReferenceKind_Set :=
      (Is_Server_Side => True,
@@ -3358,12 +3361,29 @@ package body LSP.Ada_Handlers is
    procedure Mark_Source_Files_For_Indexing (Self : access Message_Handler) is
    begin
       Self.Files_To_Index.Clear;
+
+      --  Mark all the project's source files
       for C of Self.Contexts.Each_Context loop
          for F in C.List_Files loop
             Self.Files_To_Index.Include
               (LSP.Ada_File_Sets.File_Sets.Element (F));
          end loop;
       end loop;
+
+      if Runtime_Indexing.Is_Active then
+         --  Mark all the predefined sources too (runtime)
+         for F in Self.Project_Predefined_Sources.Iterate loop
+            declare
+               File : GNATCOLL.VFS.Virtual_File renames
+                 LSP.Ada_File_Sets.File_Sets.Element (F);
+            begin
+               for Context of Self.Contexts_For_File (File) loop
+                  Self.Files_To_Index.Include (File);
+               end loop;
+            end;
+         end loop;
+      end if;
+
       Self.Total_Files_Indexed := 0;
       Self.Total_Files_To_Index := Positive'Max
         (1, Natural (Self.Files_To_Index.Length));

testsuite/.als/traces.cfg

@@ -12,3 +12,6 @@ ALS.ALLOW_INCREMENTAL_TEXT_CHANGES=yes > inout.txt:buffer_size=0
 
 # Activate navigation warnings in test mode
 ALS.NOTIFICATIONS_FOR_IMPRECISE_NAVIGATION=yes
+
+# Disable runtime indexing for most tests
+ALS.RUNTIME_INDEXING=no

testsuite/ada_lsp/completion.invisible.runtime/default.gpr

@@ -0,0 +1,2 @@
+project Default is
+end Default;

testsuite/ada_lsp/completion.invisible.runtime/main.adb

@@ -0,0 +1,5 @@
+
+procedure Main is
+begin
+   Ada.Te
+end Main;