Merge branch 'topic/als.1455.settings_diag' into 'master'

Revamp setting for diagnostics

See merge request eng/ide/ada_language_server!1932

Author: AdrienBoulanger

README.md

@@ -146,7 +146,7 @@ Here is an example config file:
       "BINUTILS_SRC_DIR": "/null"
    },
    "ada.defaultCharset": "utf-8",
-   "ada.enableDiagnostics": false,
+   "ada.adaFileDiagnostics": false,
    "ada.renameInComments": false
 }
 ```

doc/settings.md

@@ -106,8 +106,10 @@ Settings understood by the Ada Language Server itself, independently from the LS
 * [defaultCharset](#defaultcharset)
 * [relocateBuildTree](#relocatebuildtree)
 * [rootDir](#rootdir)
-* [enableDiagnostics](#enablediagnostics)
+* [enableDiagnostics](#enableddiagnostics)
+* [adaFileDiagnostics](#adafilediagnostics)
 * [projectDiagnostics](#projectdiagnostics)
+* [alireDiagnostics](#alirediagnostics)
 * [enableIndexing](#enableindexing)
 * [renameInComments](#renameincomments)
 * [namedNotationThreshold](#namednotationthreshold)
@@ -217,27 +219,47 @@ for more details about the corresponding gprbuild switch.
 
 ### enableDiagnostics
 
-You can explicitly deactivate the emission of diagnostics, via the
-`enableDiagnostics` key. By default, diagnostics are enabled.
-The value is a boolean.
+This setting has been deprecated please have a look at `projectDiagnostics`,
+`adaFileDiagnostics` and `alireDiagnostics`.
 
 ```javascript
     'enableDiagnostics': false
 ```
 
+### adaFileDiagnostics
+
+You can explicitly deactivate the emission of diagnostics for Ada Files
+via the `adaFileDiagnostics` key. By default, diagnostics are enabled.
+The value is a boolean.
+
+```javascript
+    'adaFileDiagnostics': false
+```
+
 ### projectDiagnostics
 
-This setting needs `enableDiagnostics` enabled and can be disabled to remove
-project related diagnotics.
+You can explicitly deactivate the emission of diagnostics when loading a
+project via the `projectDiagnostics` key. By default, diagnostics are enabled.
 The value is a boolean.
 
 ```javascript
-    'enableDiagnostics': false
+    'projectDiagnostics': false
+```
+
+### alireDiagnostics
+
+You can explicitly deactivate the emission of diagnostics when loading an
+alire crate via the `alireDiagnostics` key.
+By default, diagnostics are enabled.
+The value is a boolean.
+
+```javascript
+    'alireDiagnostics': false
 ```
 
 ### enableIndexing
 
-By default, the server indexes the source files after loading a project,
+By default, the server indexes the source files after loading a project
 to speed up subsequent requests. This behavior can be controlled
 via the `enableIndexing` flag in this request.
 The value is a boolean.

integration/vscode/ada/package.json

@@ -308,7 +308,13 @@
                         "scope": "window",
                         "type": "boolean",
                         "default": null,
-                        "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."
+                        "description": "Controls whether or not the Ada Language Server should emit project diagnostics into the VS Code Problems view."
+                    },
+                    "ada.alireDiagnostics": {
+                        "scope": "window",
+                        "type": "boolean",
+                        "default": null,
+                        "description": "Controls whether or not the Ada Language Server should emit diagnostics related to alire into the VS Code Problems view."
                     },
                     "ada.defaultCharset": {
                         "scope": "window",
@@ -392,11 +398,11 @@
                         "default": null,
                         "description": "Controls the policy for displaying overriding and overridden subprograms on navigation requests such as 'Go To Definition' or 'Go To Implementations'."
                     },
-                    "ada.enableDiagnostics": {
+                    "ada.adaFileDiagnostics": {
                         "scope": "window",
                         "type": "boolean",
                         "default": null,
-                        "description": "Controls whether or not the Ada Language Server should emit diagnostics into the VS Code Problems view."
+                        "description": "Controls whether or not the Ada Language Server should emit diagnostics related to Ada files into the VS Code Problems view."
                     },
                     "ada.foldComments": {
                         "scope": "window",

integration/vscode/ada/schemas/als-settings-schema.json

@@ -25,7 +25,12 @@
         "projectDiagnostics": {
             "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."
+            "description": "Controls whether or not the Ada Language Server should emit project diagnostics into the VS Code Problems view."
+        },
+        "alireDiagnostics": {
+            "type": "boolean",
+            "default": true,
+            "description": "Controls whether or not the Ada Language Server should emit diagnostics related to alire into the VS Code Problems view."
         },
         "defaultCharset": {
             "type": "string",
@@ -80,10 +85,10 @@
             "default": "usage_and_abstract_only",
             "description": "Controls the policy for displaying overriding and overridden subprograms on navigation requests such as 'Go To Definition' or 'Go To Implementations'."
         },
-        "enableDiagnostics": {
+        "adaFileDiagnostics": {
             "type": "boolean",
             "default": true,
-            "description": "Controls whether or not the Ada Language Server should emit diagnostics into the VS Code Problems view."
+            "description": "Controls whether or not the Ada Language Server should emit diagnostics related to Ada Files into the VS Code Problems view."
         },
         "foldComments": {
             "type": "boolean",

source/ada/lsp-ada_configurations.adb

@@ -302,6 +302,19 @@ package body LSP.Ada_Configurations is
             then
                Self.Project_Diagnostics_Enabled := JSON (Index).Boolean_Value;
 
+            elsif Check_Variable
+              (Name, JSON (Index).Kind, "alireDiagnostics", Boolean_Value)
+            then
+               Self.Alire_Diagnostics_Enabled := JSON (Index).Boolean_Value;
+
+            elsif Check_Variable
+              (Name, JSON (Index).Kind, "enableDiagnostics", Boolean_Value)
+            then
+               Messages.Append
+                 ("enableDiagnostics has been deprecated please have a look at"
+                  & " adaFileDiagnostics, projectDiagnostics"
+                  & "and alireDiagnostics");
+
             elsif Check_Variable
               (Name, JSON (Index).Kind, "scenarioVariables", Start_Object)
             then
@@ -328,9 +341,9 @@ package body LSP.Ada_Configurations is
                Self.Charset := JSON (Index).String_Value;
 
             elsif Check_Variable
-              (Name, JSON (Index).Kind, "enableDiagnostics", Boolean_Value)
+              (Name, JSON (Index).Kind, "adaFileDiagnostics", Boolean_Value)
             then
-               Self.Diagnostics_Enabled := JSON (Index).Boolean_Value;
+               Self.Ada_File_Diagnostics_Enabled := JSON (Index).Boolean_Value;
 
             elsif Check_Variable
               (Name, JSON (Index).Kind, "enableIndexing", Boolean_Value)

source/ada/lsp-ada_configurations.ads

@@ -88,13 +88,18 @@ package LSP.Ada_Configurations is
    --  Maximum number of logs (should be > to the number of servers run
    --  simultaneously)
 
-   function Diagnostics_Enabled (Self : Configuration'Class) return Boolean;
-   --  Whether to publish diagnostics
+   function Ada_File_Diagnostics_Enabled
+     (Self : Configuration'Class) return Boolean;
+   --  Whether to publish file related diagnostics
 
    function Project_Diagnostics_Enabled
      (Self : Configuration'Class) return Boolean;
    --  Whether to publish project related diagnostics
 
+   function Alire_Diagnostics_Enabled
+     (Self : Configuration'Class) return Boolean;
+   --  Whether to publish alire 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.
@@ -154,23 +159,24 @@ private
    use type VSS.Strings.Virtual_String;
 
    type Configuration is tagged record
-      Project_File                : VSS.Strings.Virtual_String;
-      GPR_Configuration_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 := True;
-      Indent_Only                 : Boolean := True;
-      Follow_Symlinks             : Boolean := True;
-      Insert_With_Clauses         : Boolean := True;
+      Project_File                 : VSS.Strings.Virtual_String;
+      GPR_Configuration_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;
+      Ada_File_Diagnostics_Enabled : Boolean := True;
+      Project_Diagnostics_Enabled  : Boolean := True;
+      Alire_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 := True;
+      Indent_Only                  : Boolean := True;
+      Follow_Symlinks              : Boolean := True;
+      Insert_With_Clauses          : Boolean := True;
 
       Documentation_Style      : GNATdoc.Comments.Options.Documentation_Style
         := GNATdoc.Comments.Options.GNAT;
@@ -205,13 +211,19 @@ private
      (Self : Configuration'Class) return VSS.Strings.Virtual_String is
        (Self.Relocate_Root);
 
-   function Diagnostics_Enabled (Self : Configuration'Class) return Boolean is
-      (Self.Diagnostics_Enabled);
+   function Ada_File_Diagnostics_Enabled
+     (Self : Configuration'Class)
+      return Boolean is
+      (Self.Ada_File_Diagnostics_Enabled);
 
    function Project_Diagnostics_Enabled
      (Self : Configuration'Class)
       return Boolean is (Self.Project_Diagnostics_Enabled);
 
+   function Alire_Diagnostics_Enabled
+     (Self : Configuration'Class)
+      return Boolean is (Self.Alire_Diagnostics_Enabled);
+
    function Indexing_Enabled (Self : Configuration'Class) return Boolean is
       (Self.Indexing_Enabled);
 

source/ada/lsp-ada_documents-lal_diagnostics.adb

@@ -57,10 +57,13 @@ package body LSP.Ada_Documents.LAL_Diagnostics is
 
    overriding function Has_New_Diagnostic
      (Self    : in out Diagnostic_Source;
-      Context : LSP.Ada_Contexts.Context) return Boolean
-   is
+      Context : LSP.Ada_Contexts.Context) return Boolean is
    begin
-      return Self.Errors /= Self.Get_Diagnostics (Context);
+      if Self.Is_Enabled then
+         return Self.Errors /= Self.Get_Diagnostics (Context);
+      else
+         return False;
+      end if;
    end Has_New_Diagnostic;
 
    --------------------
@@ -78,7 +81,9 @@ package body LSP.Ada_Documents.LAL_Diagnostics is
       Unit : constant Libadalang.Analysis.Analysis_Unit :=
         Self.Document.Unit (Context);
    begin
-      if Unit.Has_Diagnostics then
+      if Self.Is_Enabled
+        and then Unit.Has_Diagnostics
+      then
          for Error of Unit.Diagnostics loop
 
             --  Filter out diagnostics that simply report "Cannot parse <..>",
@@ -98,4 +103,14 @@ package body LSP.Ada_Documents.LAL_Diagnostics is
       end if;
    end Get_Diagnostics;
 
+   ----------------
+   -- Is_Enabled --
+   ----------------
+
+   overriding function Is_Enabled
+     (Self : Diagnostic_Source) return Boolean is
+   begin
+      return Self.Handler.Ada_File_Diagnostics_Enabled;
+   end Is_Enabled;
+
 end LSP.Ada_Documents.LAL_Diagnostics;

source/ada/lsp-ada_documents-lal_diagnostics.ads

@@ -15,13 +15,15 @@
 -- of the license.                                                          --
 ------------------------------------------------------------------------------
 
+with LSP.Ada_Handlers;
 with LSP.Diagnostic_Sources;
 private with Langkit_Support.Diagnostics;
 
 package LSP.Ada_Documents.LAL_Diagnostics is
 
    type Diagnostic_Source
-     (Document : not null LSP.Ada_Documents.Document_Access)
+     (Handler  : not null access LSP.Ada_Handlers.Message_Handler'Class;
+      Document : not null LSP.Ada_Documents.Document_Access)
    is limited new LSP.Diagnostic_Sources.Diagnostic_Source with private;
 
    overriding procedure Get_Diagnostic
@@ -34,6 +36,9 @@ package LSP.Ada_Documents.LAL_Diagnostics is
      (Self    : in out Diagnostic_Source;
       Context : LSP.Ada_Contexts.Context) return Boolean;
 
+   overriding function Is_Enabled
+     (Self : Diagnostic_Source) return Boolean;
+
 private
 
    subtype Diagnostic_Index is Natural range 0 .. MAX_NB_DIAGNOSTICS;
@@ -43,7 +48,8 @@ private
    end record;
 
    type Diagnostic_Source
-     (Document : not null LSP.Ada_Documents.Document_Access)
+     (Handler  : not null access LSP.Ada_Handlers.Message_Handler'Class;
+      Document : not null LSP.Ada_Documents.Document_Access)
    is limited new LSP.Diagnostic_Sources.Diagnostic_Source with record
       Errors   : Diagnostics;
    end record;

source/ada/lsp-ada_documents.adb

@@ -1132,16 +1132,18 @@ package body LSP.Ada_Documents is
    ----------------
 
    procedure Initialize
-     (Self : in out Document;
-      URI  : LSP.Structures.DocumentUri;
-      Text : VSS.Strings.Virtual_String) is
+     (Self    : in out Document;
+      Handler : LSP.Ada_Handlers.Message_Handler'Class;
+      URI     : LSP.Structures.DocumentUri;
+      Text    : VSS.Strings.Virtual_String) is
    begin
       LSP.Text_Documents.Constructors.Initialize (Self, URI, Text);
 
       Self.Refresh_Symbol_Cache := True;
       Self.Diagnostic_Sources.Append
         (new LSP.Ada_Documents.LAL_Diagnostics.Diagnostic_Source
-               (Self'Unchecked_Access));
+           (Handler  => Handler'Unrestricted_Access,
+            Document => Self'Unchecked_Access));
    end Initialize;
 
    ----------------------

source/ada/lsp-ada_documents.ads

@@ -52,9 +52,10 @@ package LSP.Ada_Documents is
      with Storage_Size => 0;
 
    procedure Initialize
-     (Self : in out Document;
-      URI  : LSP.Structures.DocumentUri;
-      Text : VSS.Strings.Virtual_String);
+     (Self    : in out Document;
+      Handler : LSP.Ada_Handlers.Message_Handler'Class;
+      URI     : LSP.Structures.DocumentUri;
+      Text    : VSS.Strings.Virtual_String);
    --  Create a new document from a TextDocumentItem.
 
    procedure Cleanup (Self : in out Document);