Merge branch 'topic/dap_remove_delete' into 'master'

AnthonyLeonardoGracio · AnthonyLeonardoGracio · commit 0a20dfdb8a66 · 2024-04-23T16:39:04.000Z
Do not intercept 'delete' commands in DAP

See merge request eng/ide/gnatstudio!478
diff --git a/dap/src/dap-clients-breakpoint_managers.adb b/dap/src/dap-clients-breakpoint_managers.adb
@@ -45,7 +45,7 @@ package body DAP.Clients.Breakpoint_Managers is
      ("DAP.CLIENTS.BREAKPOINT_MANAGER");
 
    type On_DAP_Request_Processed
-   is new GPS.Kernel.Hooks.Dap_Message_Hooks_Function with record
+   is new GPS.Kernel.Hooks.Dap_Method_Hooks_Function with record
       Manager : Breakpoint_Manager_Access;
    end record;
    overriding procedure Execute
diff --git a/dap/src/dap-clients.adb b/dap/src/dap-clients.adb
@@ -41,7 +41,6 @@ with VSS.Regular_Expressions;
 with VSS.Stream_Element_Vectors.Conversions;
 with VSS.Strings;                use VSS.Strings;
 with VSS.Strings.Conversions;
-with VSS.Strings.Cursors.Iterators.Characters;
 with VSS.Text_Streams.Memory_UTF8_Input;
 with VSS.Text_Streams.Memory_UTF8_Output;
 
@@ -136,18 +135,6 @@ package body DAP.Clients is
         & "(?:\s+(.+)?)?$");
    --  to catch breakpoint command
 
-   Is_Delete_Pattern : constant VSS.Regular_Expressions.
-     Regular_Expression := VSS.Regular_Expressions.To_Regular_Expression
-       ("^\s*(delete|del|d)(?:\s+(.+)?)?$");
-   --  to catch delete breakpoint(s) command
-
-   Bp_Delete_Details_Idx : constant := 2;
-
-   Ids_Pattern : constant VSS.Regular_Expressions.
-     Regular_Expression := VSS.Regular_Expressions.To_Regular_Expression
-       ("((\d+)\s*-\s*(\d+)|\d+)");
-   --  to get all (breakpoints) ids or range
-
    Is_Ignore_Pattern : constant VSS.Regular_Expressions.
      Regular_Expression := VSS.Regular_Expressions.To_Regular_Expression
        ("^\s*(?:ignore)\s+(\d+)\s+(\d+)");
@@ -1390,6 +1377,10 @@ package body DAP.Clients is
          if Self.Status /= Terminating then
             Self.Process_Event (Reader, Event);
          end if;
+
+         GPS.Kernel.Hooks.Dap_Event_Processed_Hook.Run
+            (Kernel => Self.Kernel,
+             Event  => VSS.Strings.Conversions.To_UTF_8_String (Event));
       end if;
 
    exception
@@ -1655,10 +1646,8 @@ package body DAP.Clients is
       VSS_Cmd       : Virtual_String;
       Details       : Virtual_String;
       Level         : Integer;
-      Ids           : Breakpoint_Identifier_Lists.List;
 
       procedure Add_BP_For_Offset;
-      procedure Check_Delete_Command;
       procedure Check_Ignore_Command;
       function Value
         (S : VSS.Strings.Virtual_String) return Integer;
@@ -1690,72 +1679,6 @@ package body DAP.Clients is
             Condition => Details_Match.Captured (Bp_Condition_Idx));
       end Add_BP_For_Offset;
 
-      --------------------------
-      -- Check_Delete_Command --
-      --------------------------
-
-      procedure Check_Delete_Command is
-      begin
-         --  Is the `delete` command
-         Matched := Is_Delete_Pattern.Match (VSS_Cmd);
-
-         if Matched.Has_Match then
-            if Self.Breakpoints = null then
-               null;
-
-            elsif Matched.Has_Capture (Bp_Delete_Details_Idx) then
-               --  Get breakpoint ids or ranges
-               Details := Matched.Captured (Bp_Delete_Details_Idx);
-
-               declare
-                  From : VSS.Strings.Cursors.Iterators.Characters.
-                    Character_Iterator := Details.Before_First_Character;
-               begin
-                  while From.Forward loop
-                     Details_Match := Ids_Pattern.Match (Details, From);
-                     exit when not Details_Match.Has_Match;
-
-                     if Details_Match.Has_Capture (2) then
-                        --  Range match found:
-                        --    1: 1 .. 3 => '2-3'
-                        --    2: 1 .. 1 => '2'
-                        --    3: 3 .. 3 => '3'
-
-                        for Index in
-                          Value (Details_Match.Captured (1)) ..
-                            Value (Details_Match.Captured (2))
-                        loop
-                           Ids.Append (Breakpoint_Identifier (Index));
-                        end loop;
-
-                     else
-                        --  Id match found:
-                        --    1: 1 .. 1 => '4'
-
-                        Ids.Append
-                          (Breakpoint_Identifier
-                             (Value (Details_Match.Captured (1))));
-                     end if;
-
-                     From.Set_At (Details_Match.Last_Marker (1));
-                  end loop;
-
-                  if not Ids.Is_Empty then
-                     Self.Breakpoints.Remove_Breakpoints (Ids);
-                  end if;
-               end;
-
-            else
-               --  `delete` command does not have ids,
-               --  remove all breakpoints.
-               Self.Breakpoints.Remove_All_Breakpoints;
-            end if;
-
-            --  Clear the command to signal that the command is processed
-            VSS_Cmd.Clear;
-         end if;
-      end Check_Delete_Command;
-
       --------------------------
       -- Check_Ignore_Command --
       --------------------------
@@ -1941,10 +1864,6 @@ package body DAP.Clients is
                VSS_Cmd.Clear;
             end if;
 
-            if not VSS_Cmd.Is_Empty then -- Command is not processed yet
-               Check_Delete_Command;
-            end if;
-
             if not VSS_Cmd.Is_Empty then -- Command is not processed yet
                Check_Ignore_Command;
             end if;
diff --git a/docs/users_guide/GPS/generated_hooks.py b/docs/users_guide/GPS/generated_hooks.py
@@ -22,6 +22,16 @@ def DAP_debugger_unloaded(name,id):
 
         """
 
+    # DAP_event_processed = 'DAP_event_processed'
+    def DAP_event_processed(name,event):
+        """
+      Emitted when an event received from the DAP server has been processed.
+
+      :param str name:
+      :param str event:
+
+        """
+
     # DAP_response_processed = 'DAP_response_processed'
     def DAP_response_processed(name,method):
         """
diff --git a/kernel/src/hooks.py b/kernel/src/hooks.py
@@ -545,10 +545,14 @@ def __init__(self, name, type, descr=''):
          Param('contents', 'String'),
          Param('method', 'String')]),
 
-    'DAP_message_hooks': Hook_Type(
+    'DAP_method_hooks': Hook_Type(
         [Param('name', '__hookname__'),
          Param('method', 'String')]),
 
+    'DAP_event_hooks': Hook_Type(
+        [Param('name', '__hookname__'),
+         Param('event', 'String')]),
+
     'DAP_id_hooks': Hook_Type(
         [Param('name', '__hookname__'),
          Param('id', 'Integer')])
@@ -1119,10 +1123,15 @@ def on_file_changed(hook, file):
 Emitted when the filter of a view has changed.'''),
 
     Hook('DAP_response_processed',
-         'DAP_message_hooks',
+         'DAP_method_hooks',
          descr='''
 Emitted when a response from the DAP server has been processed.'''),
 
+    Hook('DAP_event_processed',
+         'DAP_event_hooks',
+         descr='''
+Emitted when an event received from the DAP server has been processed.'''),
+
     Hook('DAP_debugger_unloaded',
          'DAP_id_hooks',
          descr='''
diff --git a/share/support/core/gs_utils/internal/utils.py b/share/support/core/gs_utils/internal/utils.py
@@ -251,6 +251,17 @@ def wait_DAP_server(method=""):
         if m == method:
             break
 
+@workflows.run_as_workflow
+def wait_DAP_event(event=""):
+    """
+    Wait until the given DAP event has been processed by GNAT Studio.
+    """
+    while True:
+        (e) = yield hook("DAP_event_processed")
+
+        if e == event:
+            break
+
 
 @workflows.run_as_workflow
 def wait_until_not_busy(debugger, t=100):
