Add support for setTrace notification

In order to not raise an exception when VS Code sends it.

We don't handle it for now since VS Code already outputs a lot
of useful information (resquests being sent, results...) when
the trace setting is set to 'messages' or 'verbose'.

This could be used in the future if we want to have more debug
traces in the ALS.

closes eng/ide/ada_language_server#1116

Author: AnthonyLeonardoGracio

scripts/generate.py

@@ -350,6 +350,7 @@
      'DeleteFilesParams'),
 
     ('$/cancelRequest', 'Cancel', 'CancelParams'),
+    ('$/setTrace', 'SetTrace', 'SetTraceParams'),
 
     # TODO: rename these to TextDocumentDidOpen/DidChange/DidSave/DidClose?
     ('textDocument/didOpen', 'DidOpenTextDocument',

scripts/io_gen.py

@@ -518,7 +518,7 @@
     "refactorrewrite": "refactor.rewrite",
     "source": "source",
     "sourceorganizeimports": "source.organizeImports",
-    "messages_trace": "message",  # for TraceValue
+    "messages_trace": "messages",  # for TraceValue
     "diff": "delta", # for SemanticTokens
     "an_abstract": "abstract", # for SemanticTokenTypes
     "an_interface": "interface",

source/ada/lsp-ada_handlers.ads

@@ -635,6 +635,14 @@ private
    --  This is intentionally null procedure, because cancel is implemented by
    --  LSP server itself.
 
+   overriding procedure On_SetTrace_Notification
+     (Self  : access Message_Handler;
+      Value : LSP.Messages.SetTraceParams) is null;
+   --  This is intentionally set to null since VS Code already handle traces
+   --  by itself correctly, outputting the LSP requests being sent
+   --  and the returned results with more or less verbosity depending on the
+   --  settings.
+
    overriding function Get_Open_Document
      (Self  : access Message_Handler;
       URI   : LSP.Messages.DocumentUri;

source/ada/lsp-fuzz_decorators.adb

@@ -109,6 +109,17 @@ package body LSP.Fuzz_Decorators is
       Self.Handler.On_Cancel_Notification (Value);
    end On_Cancel_Notification;
 
+   ------------------------------
+   -- On_SetTrace_Notification --
+   ------------------------------
+
+   overriding procedure On_SetTrace_Notification
+     (Self  : access Fuzz_Notification_Decorator;
+      Value : LSP.Messages.SetTraceParams) is
+   begin
+      Self.Handler.On_SetTrace_Notification (Value);
+   end On_SetTrace_Notification;
+
    ------------------------------------
    -- On_DidCreateFiles_Notification --
    ------------------------------------

source/ada/lsp-fuzz_decorators.ads

@@ -68,6 +68,10 @@ package LSP.Fuzz_Decorators is
      (Self  : access Fuzz_Notification_Decorator;
       Value : LSP.Messages.CancelParams);
 
+   overriding procedure On_SetTrace_Notification
+     (Self  : access Fuzz_Notification_Decorator;
+      Value : LSP.Messages.SetTraceParams);
+
    overriding procedure On_DidCreateFiles_Notification
      (Self  : access Fuzz_Notification_Decorator;
       Value : LSP.Messages.CreateFilesParams);

source/client/lsp-clients.adb

@@ -1161,6 +1161,20 @@ package body LSP.Clients is
       Self.Send_Notification ("$/cancelRequest", Message);
    end On_Cancel_Notification;
 
+   ------------------------------
+   -- On_SetTrace_Notification --
+   ------------------------------
+
+   overriding procedure On_SetTrace_Notification
+     (Self  : access Client;
+      Value : LSP.Messages.SetTraceParams)
+   is
+      Message : SetTrace_Notification :=
+        (params => Value, others => <>);
+   begin
+      Self.Send_Notification ("$/setTrace", Message);
+   end On_SetTrace_Notification;
+
    ------------------------------------
    -- On_DidCreateFiles_Notification --
    ------------------------------------

source/client/lsp-clients.ads

@@ -78,6 +78,10 @@ package LSP.Clients is
      (Self  : access Client;
       Value : LSP.Messages.CancelParams);
 
+   overriding procedure On_SetTrace_Notification
+     (Self  : access Client;
+      Value : LSP.Messages.SetTraceParams);
+
    overriding procedure On_DidCreateFiles_Notification
      (Self  : access Client;
       Value : LSP.Messages.CreateFilesParams);

source/gpr/lsp-gpr_handlers.ads

@@ -281,6 +281,10 @@ private
    --  This is intentionally null procedure, because cancel is implemented by
    --  LSP server itself.
 
+   overriding procedure On_SetTrace_Notification
+     (Self  : access Message_Handler;
+      Value : LSP.Messages.SetTraceParams) is null;
+
    overriding function On_ALS_Check_Syntax_Request
      (Self    : access Message_Handler;
       Request : LSP.Messages.Server_Requests.ALS_Check_Syntax_Request)

source/protocol/generated/lsp-message_io.adb

@@ -4440,7 +4440,7 @@ package body LSP.Message_IO is
       JS.R.Read_Next;
       if Text = "off" then
          V := off;
-      elsif Text = "message" then
+      elsif Text = "messages" then
          V := messages_trace;
       elsif Text = "verbose" then
          V := verbose;
@@ -4468,7 +4468,7 @@ package body LSP.Message_IO is
             when off =>
                return "off";
             when messages_trace =>
-               return "message";
+               return "messages";
             when verbose =>
                return "verbose";
          end case;

source/protocol/generated/lsp-messages-server_notifications.adb

@@ -97,6 +97,13 @@ package body LSP.Messages.Server_Notifications is
       Handler.On_Cancel_Notification (Self.params);
    end Visit;
 
+   overriding procedure Visit
+     (Self    : SetTrace_Notification;
+      Handler : access Server_Notification_Receiver'Class) is
+   begin
+      Handler.On_SetTrace_Notification (Self.params);
+   end Visit;
+
    overriding procedure Visit
      (Self    : DidOpenTextDocument_Notification;
       Handler : access Server_Notification_Receiver'Class) is
@@ -163,6 +170,10 @@ begin
      ("$/cancelRequest",
       Cancel_Notification'Tag);
 
+   Map.Insert
+     ("$/setTrace",
+      SetTrace_Notification'Tag);
+
    Map.Insert
      ("textDocument/didOpen",
       DidOpenTextDocument_Notification'Tag);