Add a DAP_Event_Processed hook

This allows to wait for DAP events in the tests.

For eng/ide/gnatstudio#281

Author: AnthonyLeonardoGracio

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

dap/src/dap-clients.adb

@@ -1390,6 +1390,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

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):
         """

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='''

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):