Call Update_Sources only when GPR files are saved

Update_Sources is too slow to be called each time the
user edits the file: call it only when opening the file for
the first time and when saving it.

Add a test that checks that source files diagnostics get properly
updated when saving edited GPR files.

For eng/ide/ada_language_server#1576

Author: AnthonyLeonardoGracio

source/gpr/lsp-gpr_did_change_document.adb

@@ -102,11 +102,14 @@ package body LSP.GPR_Did_Change_Document is
            (Message.Params.textDocument.version, Changes);
       end if;
 
-      --  Load gpr tree & prepare diagnostics
+      --  Load gpr tree & prepare diagnostics.
+      --  Do not update the tree's sources because it's too slow: we only want
+      --  to publish syntactic and semantic diagnostics here.
 
       Self.Document.Load
-        (Client        => Self.Parent.Context.Get_Client.all,
-         Configuration => Self.Parent.Context.Get_Configuration);
+        (Client         => Self.Parent.Context.Get_Client.all,
+         Configuration  => Self.Parent.Context.Get_Configuration,
+         Update_Sources => False);
 
       --  Build GPR file for LSP needs.
 

source/gpr/lsp-gpr_documents.adb

@@ -176,9 +176,10 @@ package body LSP.GPR_Documents is
    ----------
 
    procedure Load
-     (Self          : in out Document;
-      Client        : LSP.Ada_Client_Capabilities.Client_Capability;
-      Configuration : LSP.Ada_Configurations.Configuration) is
+     (Self           : in out Document;
+      Client         : LSP.Ada_Client_Capabilities.Client_Capability;
+      Configuration  : LSP.Ada_Configurations.Configuration;
+      Update_Sources : Boolean := False) is
 
       procedure Update_Diagnostics;
       --  Update Self.Messages, Self.Errors_Changed, Self.Has_Diagnostics
@@ -216,15 +217,14 @@ package body LSP.GPR_Documents is
          Opts.Add_Switch (GPR2.Options.P, String (Self.File.Value));
          Opts.Add_Context (Configuration.Context);
 
-         Success := Self.Tree.Load
-           (Opts,
-            Reporter         => Reporter,
-            With_Runtime     => True,
-            Absent_Dir_Error => GPR2.No_Error,
-            File_Reader      => Self.File_Provider.Get_File_Reader,
-            Environment      => LSP.GPR_Files.Environment);
+         Success :=
+           Self.Tree.Load
+             (Opts, Reporter   => Reporter, With_Runtime => True,
+              Absent_Dir_Error => GPR2.No_Error,
+              File_Reader      => Self.File_Provider.Get_File_Reader,
+              Environment      => LSP.GPR_Files.Environment);
 
-         if Success then
+         if Update_Sources and then Success then
             Self.Tree.Update_Sources;
          end if;
 

source/gpr/lsp-gpr_documents.ads

@@ -74,10 +74,14 @@ package LSP.GPR_Documents is
    --  project status diagnostic source.
 
    procedure Load
-     (Self          : in out Document;
-      Client        : LSP.Ada_Client_Capabilities.Client_Capability;
-      Configuration : LSP.Ada_Configurations.Configuration);
+     (Self           : in out Document;
+      Client         : LSP.Ada_Client_Capabilities.Client_Capability;
+      Configuration  : LSP.Ada_Configurations.Configuration;
+      Update_Sources : Boolean := False);
    --  Load associated GPR tree.
+   --  If Update_Sources is True, the tree's sources will be updated after
+   --  loading it successfully, allowing to retrieve GPR2 warnings/errors
+   --  related to source files and directories later on.
 
    procedure Cleanup (Self : in out Document);
    --  Free all the data associated to this document.

source/gpr/lsp-gpr_handlers.adb

@@ -200,7 +200,7 @@ package body LSP.GPR_Handlers is
      (Self  : in out Message_Handler;
       Value : LSP.Structures.DidOpenTextDocumentParams)
    is
-      URI    : constant LSP.Structures.DocumentUri := Value.textDocument.uri;
+      URI : constant LSP.Structures.DocumentUri := Value.textDocument.uri;
       File   : constant GNATCOLL.VFS.Virtual_File  := Self.To_File (URI);
       Object : constant Internal_Document_Access   :=
         new LSP.GPR_Documents.Document (Self.Tracer);
@@ -212,19 +212,18 @@ package body LSP.GPR_Handlers is
 
       --  We have received a document: add it to the documents container
       Object.Initialize
-        (URI,
-         GPR2.Path_Name.Create (Self.To_File (URI)),
-         Value.textDocument.text,
-         Self'Unchecked_Access);
+        (URI, GPR2.Path_Name.Create (Self.To_File (URI)),
+         Value.textDocument.text, Self'Unchecked_Access);
 
       Self.Open_Documents.Include (File, Object);
 
       --  Load gpr tree & prepare diagnostics
 
       begin
          Object.Load
-           (Client        => Self.Client,
-            Configuration => Self.Get_Configuration);
+           (Client         => Self.Client,
+            Configuration  => Self.Get_Configuration,
+            Update_Sources => True);
       exception
          when E : others =>
             Self.Tracer.Trace_Exception (E, "On_DidOpen_Notification");
@@ -243,6 +242,36 @@ package body LSP.GPR_Handlers is
       Self.Tracer.Trace ("Finished Text_Document_Did_Open");
    end On_DidOpen_Notification;
 
+   -----------------------------
+   -- On_DidSave_Notification --
+   -----------------------------
+
+   overriding procedure On_DidSave_Notification
+     (Self  : in out Message_Handler;
+      Value : LSP.Structures.DidSaveTextDocumentParams)
+   is
+      URI : LSP.Structures.DocumentUri renames Value.textDocument.uri;
+
+      Document : constant LSP.GPR_Documents.Document_Access :=
+        Self.Get_Open_Document (URI);
+   begin
+      --  Reload the project tree on saving, and update its sources
+      --  to get GPR2 diagnostics related to source files/directories.
+      Document.Load
+        (Client         => Self.Get_Client.all,
+         Configuration  => Self.Get_Configuration,
+         Update_Sources => True);
+
+      --  Build GPR file for LSP needs.
+
+      LSP.GPR_Files.Parse_Modified_Document
+        (File_Provider => Self'Unrestricted_Access,
+         Path          => Self.To_File (URI));
+
+      --  Emit diagnostics
+      Self.Publish_Diagnostics (Document);
+   end On_DidSave_Notification;
+
    -------------------------------
    -- On_DocumentSymbol_Request --
    -------------------------------
@@ -393,6 +422,8 @@ package body LSP.GPR_Handlers is
                       (openClose => (Is_Set => True, Value => True),
                        change    =>
                          (Is_Set => True, Value => LSP.Enumerations.Full),
+                       save =>
+                         (Is_Set => True, Value => (True, True)),
                        others    => <>)));
 
       Response.capabilities.documentSymbolProvider :=
@@ -658,7 +689,10 @@ package body LSP.GPR_Handlers is
       for Document of Self.Open_Documents loop
          begin
             --  reload gpr tree
-            Document.Load (Self.Client, Self.Configuration);
+            Document.Load
+              (Client         => Self.Client,
+               Configuration  => Self.Configuration,
+               Update_Sources => True);
 
          exception
             when E : others =>

source/gpr/lsp-gpr_handlers.ads

@@ -153,6 +153,10 @@ private
      (Self  : in out Message_Handler;
       Value : LSP.Structures.DidOpenTextDocumentParams);
 
+   overriding procedure On_DidSave_Notification
+     (Self  : in out Message_Handler;
+      Value : LSP.Structures.DidSaveTextDocumentParams);
+
    overriding procedure On_Hover_Request
      (Self  : in out Message_Handler;
       Id    : LSP.Structures.Integer_Or_Virtual_String;

testsuite/.als/gpr_ls_traces.cfg

@@ -1,4 +1,4 @@
 >gpr_ls_log.$T.log:buffer_size=0:buffer_size=0
 ALS.MAIN=yes
-ALS.IN=no
-ALS.OUT=no
+ALS.IN=yes
+ALS.OUT=yes

testsuite/gpr_lsp/source_files_diagnostics/default.gpr

@@ -0,0 +1,4 @@
+project Default is
+   for Main use ("main.adb");
+   for Source_Dirs use ("src");
+end Default;

testsuite/gpr_lsp/source_files_diagnostics/main.adb

@@ -0,0 +1,4 @@
+procedure Main is
+begin
+   null;
+end Main;