Merge branch 'topic/source_info_diags' into 'master'

Clear source info diagnostics when option changes

See merge request eng/ide/ada_language_server!1991

Author: AnthonyLeonardoGracio

source/ada/lsp-ada_documents-lal_diagnostics.adb

@@ -29,7 +29,7 @@ package body LSP.Ada_Documents.LAL_Diagnostics is
    -- Get_Diagnostic --
    --------------------
 
-   overriding procedure Get_Diagnostic
+   overriding procedure Get_Diagnostics
      (Self    : in out Diagnostic_Source;
       Context : LSP.Ada_Contexts.Context;
       Errors  : out LSP.Structures.Diagnostic_Vector)
@@ -49,7 +49,7 @@ package body LSP.Ada_Documents.LAL_Diagnostics is
 
          Errors.Append (Item);
       end loop;
-   end Get_Diagnostic;
+   end Get_Diagnostics;
 
    ------------------------
    -- Has_New_Diagnostic --

source/ada/lsp-ada_documents-lal_diagnostics.ads

@@ -26,7 +26,7 @@ package LSP.Ada_Documents.LAL_Diagnostics is
       Document : not null LSP.Ada_Documents.Document_Access)
    is limited new LSP.Diagnostic_Sources.Diagnostic_Source with private;
 
-   overriding procedure Get_Diagnostic
+   overriding procedure Get_Diagnostics
      (Self    : in out Diagnostic_Source;
       Context : LSP.Ada_Contexts.Context;
       Errors  : out LSP.Structures.Diagnostic_Vector);

source/ada/lsp-ada_documents-source_info_diagnostics.adb

@@ -32,6 +32,8 @@ package body LSP.Ada_Documents.Source_Info_Diagnostics is
 
       Current_Project_Stamp : constant LSP.Ada_Handlers.Project_Stamp :=
         Self.Handler.Get_Project_Stamp;
+      Is_Enabled : constant Boolean :=
+        Self.Handler.Source_Info_Diagnostics_Enabled;
    begin
       --  The project has been reloaded: compute source information diagnostics
       --  again since the set of source files might have been changed.
@@ -40,15 +42,23 @@ package body LSP.Ada_Documents.Source_Info_Diagnostics is
          return True;
       end if;
 
+      --  The 'sourceInfoDiagnostics' option has just changed: always return
+      --  True in this case (e.g: to clear any existing diagnostic when the
+      --  option gets disabled)
+      if Self.Enabled /= Is_Enabled then
+         Self.Enabled := Is_Enabled;
+         return True;
+      end if;
+
       return False;
    end Has_New_Diagnostic;
 
-   --------------------
+   ---------------------
    -- Get_Diagnostics --
-   --------------------
+   ---------------------
 
    overriding
-   procedure Get_Diagnostic
+   procedure Get_Diagnostics
      (Self    : in out Diagnostic_Source;
       Context : LSP.Ada_Contexts.Context;
       Errors  : out LSP.Structures.Diagnostic_Vector)
@@ -57,7 +67,7 @@ package body LSP.Ada_Documents.Source_Info_Diagnostics is
       --  If the unit associated to the document belongs to the fallback context
       --  it means that the document's file does not belong the loaded project:
       --  emit a hint diagnostic in that case.
-      if Context.Is_Fallback_Context then
+      if Self.Is_Enabled and then Context.Is_Fallback_Context then
          declare
             Diag_Msg : constant String :=
               (if Self.Handler.Get_Project_Status.Is_Project_Loaded
@@ -78,7 +88,7 @@ package body LSP.Ada_Documents.Source_Info_Diagnostics is
                   others   => <>));
          end;
       end if;
-   end Get_Diagnostic;
+   end Get_Diagnostics;
 
    ----------------
    -- Is_Enabled --

source/ada/lsp-ada_documents-source_info_diagnostics.ads

@@ -28,7 +28,7 @@ package LSP.Ada_Documents.Source_Info_Diagnostics is
       Document : not null LSP.Ada_Documents.Document_Access)
    is limited new LSP.Diagnostic_Sources.Diagnostic_Source with private;
 
-   overriding procedure Get_Diagnostic
+   overriding procedure Get_Diagnostics
      (Self    : in out Diagnostic_Source;
       Context : LSP.Ada_Contexts.Context;
       Errors  : out LSP.Structures.Diagnostic_Vector);
@@ -51,6 +51,10 @@ private
       --  Used to detect when the project has been reloaded.
       --  We want to update source information diagnostics only after
       --  project reloade.
+
+      Enabled : Boolean := True;
+      --  Used to keep track of the 'sourceInfoDiagnostics' option, which
+      --  enables/disables source information diagnostics.
    end record;
 
 end LSP.Ada_Documents.Source_Info_Diagnostics;

source/ada/lsp-ada_documents.adb

@@ -966,7 +966,7 @@ package body LSP.Ada_Documents is
 
       if Changed or else Force then
          for Source of Self.Diagnostic_Sources loop
-            Source.Get_Diagnostic (Context, Errors);
+            Source.Get_Diagnostics (Context, Errors);
          end loop;
       end if;
    end Get_Errors;

source/ada/lsp-diagnostic_sources.ads

@@ -33,7 +33,7 @@ package LSP.Diagnostic_Sources is
         LSP.Diagnostic_Sources.Diagnostic_Source_Access,
         LSP.Diagnostic_Sources."=");
 
-   procedure Get_Diagnostic
+   procedure Get_Diagnostics
      (Self    : in out Diagnostic_Source;
       Context : LSP.Ada_Contexts.Context;
       Errors  : out LSP.Structures.Diagnostic_Vector) is abstract;

testsuite/ada_lsp/diagnostics.source_information/test.json

@@ -112,6 +112,31 @@
          ]
       }
    },
+   {
+      "send": {
+         "request": {
+            "jsonrpc": "2.0",
+            "method": "workspace/didChangeConfiguration",
+            "params": {
+               "settings": {
+                  "ada": {
+                     "projectFile": "$URI{default.gpr}",
+                     "sourceInfoDiagnostics": false
+                  }
+               }
+            }
+         },
+         "wait": [
+            {
+               "method": "textDocument/publishDiagnostics",
+               "params": {
+                  "uri": "$URI{main.adb}",
+                  "diagnostics": []
+               }
+            }
+         ]
+      }
+   },
    {
       "stop": {
          "exit_code": 0