Replace trace by a setting to control project diagnostics emission

For eng/ide/ada_language_server#1423

For eng/ide/ada_language_server#1427

Author: Boulanger

doc/settings.md

@@ -59,6 +59,7 @@ Ada Language Server understands these settings:
 * [relocateBuildTree](#relocatebuildtree)
 * [rootDir](#rootdir)
 * [enableDiagnostics](#enablediagnostics)
+* [projectDiagnostics](#projectdiagnostics)
 * [enableIndexing](#enableindexing)
 * [renameInComments](#renameincomments)
 * [namedNotationThreshold](#namednotationthreshold)
@@ -143,6 +144,16 @@ The value is a boolean.
     'enableDiagnostics': false
 ```
 
+## projectDiagnostics
+
+This setting needs `enableDiagnostics` enabled and can be disabled to remove
+project related diagnotics.
+The value is a boolean.
+
+```javascript
+    'enableDiagnostics': false
+```
+
 ## enableIndexing
 
 By default, the server indexes the source files after loading a project,

integration/vscode/ada/package.json

@@ -297,6 +297,12 @@
                         },
                         "order": 1
                     },
+                    "ada.projectDiagnostics": {
+                        "scope": "window",
+                        "type": "boolean",
+                        "default": true,
+                        "description": "Controls whether or not the Ada Language Server should emit project diagnostics into the VS Code Problems view.\n\nNote: this setting is ignored if `ada.enableDiagnostics` is disabled and a workspace reload is necessary to refresh the diagnostics after modifying this setting."
+                    },
                     "ada.defaultCharset": {
                         "scope": "window",
                         "type": "string",

source/ada/lsp-ada_configurations.adb

@@ -244,6 +244,11 @@ package body LSP.Ada_Configurations is
          then
             Set (Self.Project_File, JSON (Index).String_Value);
 
+         elsif Name = "projectDiagnostics"
+           and then JSON (Index).Kind = Boolean_Value
+         then
+            Self.Project_Diagnostics_Enabled := JSON (Index).Boolean_Value;
+
          elsif Name = "scenarioVariables"
            and then JSON (Index).Kind = Start_Object
          then

source/ada/lsp-ada_configurations.ads

@@ -69,6 +69,10 @@ package LSP.Ada_Configurations is
    function Diagnostics_Enabled (Self : Configuration'Class) return Boolean;
    --  Whether to publish diagnostics
 
+   function Project_Diagnostics_Enabled
+     (Self : Configuration'Class) return Boolean;
+   --  Whether to publish project related diagnostics
+
    function Indexing_Enabled (Self : Configuration'Class) return Boolean;
    --  Whether to index sources in the background. This should be True
    --  for normal use, and can be disabled for debug or testing purposes.
@@ -128,21 +132,22 @@ private
    use type VSS.Strings.Virtual_String;
 
    type Configuration is tagged record
-      Project_File             : VSS.Strings.Virtual_String;
-      Charset                  : VSS.Strings.Virtual_String;
-      Relocate_Build_Tree      : VSS.Strings.Virtual_String;
-      Relocate_Root            : VSS.Strings.Virtual_String;
-      Named_Notation_Threshold : Natural := 3;
-      Log_Threshold            : Natural := 10;
-      Diagnostics_Enabled      : Boolean := True;
-      Indexing_Enabled         : Boolean := True;
-      Rename_In_Comments       : Boolean := False;
-      Folding_Comments         : Boolean := True;
-      Use_Completion_Snippets  : Boolean := True;
-      Use_Gnatformat           : Boolean := False;
-      Indent_Only              : Boolean := True;
-      Follow_Symlinks          : Boolean := True;
-      Insert_With_Clauses      : Boolean := True;
+      Project_File                : VSS.Strings.Virtual_String;
+      Charset                     : VSS.Strings.Virtual_String;
+      Relocate_Build_Tree         : VSS.Strings.Virtual_String;
+      Relocate_Root               : VSS.Strings.Virtual_String;
+      Named_Notation_Threshold    : Natural := 3;
+      Log_Threshold               : Natural := 10;
+      Diagnostics_Enabled         : Boolean := True;
+      Project_Diagnostics_Enabled : Boolean := True;
+      Indexing_Enabled            : Boolean := True;
+      Rename_In_Comments          : Boolean := False;
+      Folding_Comments            : Boolean := True;
+      Use_Completion_Snippets     : Boolean := True;
+      Use_Gnatformat              : Boolean := False;
+      Indent_Only                 : Boolean := True;
+      Follow_Symlinks             : Boolean := True;
+      Insert_With_Clauses         : Boolean := True;
 
       Documentation_Style      : GNATdoc.Comments.Options.Documentation_Style
         := GNATdoc.Comments.Options.GNAT;
@@ -176,6 +181,10 @@ private
    function Diagnostics_Enabled (Self : Configuration'Class) return Boolean is
       (Self.Diagnostics_Enabled);
 
+   function Project_Diagnostics_Enabled
+     (Self : Configuration'Class)
+      return Boolean is (Self.Project_Diagnostics_Enabled);
+
    function Indexing_Enabled (Self : Configuration'Class) return Boolean is
       (Self.Indexing_Enabled);
 

source/ada/lsp-ada_handlers-project_diagnostics.adb

@@ -15,12 +15,8 @@
 -- of the license.                                                          --
 ------------------------------------------------------------------------------
 
-with GNATCOLL.Traces; use GNATCOLL.Traces;
-
 package body LSP.Ada_Handlers.Project_Diagnostics is
 
-   Me : constant Trace_Handle := Create ("ALS.PROJECT.DIAGNOSTICS", On);
-
    --------------------
    -- Get_Diagnostic --
    --------------------
@@ -30,7 +26,7 @@ package body LSP.Ada_Handlers.Project_Diagnostics is
       Context : LSP.Ada_Contexts.Context;
       Errors  : out LSP.Structures.Diagnostic_Vector) is
    begin
-      if Me.Active then
+      if Self.Handler.Configuration.Project_Diagnostics_Enabled then
          Self.Last_Status := Self.Handler.Project_Status;
 
          Self.Handler.Tracer.Trace ("Diag: " & Self.Last_Status'Image);
@@ -54,7 +50,7 @@ package body LSP.Ada_Handlers.Project_Diagnostics is
    is
       pragma Unreferenced (Context);
    begin
-      if Me.Active then
+      if Self.Handler.Configuration.Project_Diagnostics_Enabled then
          return LSP.Ada_Project_Loading.Has_New_Diagnostics
            (Self.Last_Status,
             Self.Handler.Project_Status);