Implement DAP 'terminated' event
authorTom Tromey <tromey@adacore.com>
Tue, 25 Jul 2023 15:16:35 +0000 (09:16 -0600)
committerTom Tromey <tromey@adacore.com>
Tue, 1 Aug 2023 18:56:52 +0000 (12:56 -0600)
This implements the DAP 'terminated' event.  Vladimir Makaev noticed
that VSCode will not report the debug session as over unless this is
sent.

It's not completely clear when exactly this event ought to be sent.
Here I've done it when the inferior exits.

Bug: https://sourceware.org/bugzilla/show_bug.cgi?id=30681

gdb/python/lib/gdb/dap/events.py
gdb/python/lib/gdb/dap/server.py
gdb/testsuite/gdb.dap/terminate.exp [new file with mode: 0644]

index 10c8a34890ed8d86e5a3041850d40b575a0edc25..aca25120ca0609e496d99a22a76c8c572ad2aba4 100644 (file)
@@ -32,6 +32,7 @@ def _on_exit(event):
             "exitCode": code,
         },
     )
+    send_event("terminated")
 
 
 @in_gdb_thread
index b1c75ab967f4366f4e5a54ff50d80a83a35fe8cf..db7893a387b95c39db6f7fa90c2dd2ed8008ff0b 100644 (file)
@@ -151,7 +151,7 @@ class Server:
         self.done = True
 
 
-def send_event(event, body):
+def send_event(event, body=None):
     """Send an event to the DAP client.
     EVENT is the name of the event, a string.
     BODY is the body of the event, an arbitrary object."""
diff --git a/gdb/testsuite/gdb.dap/terminate.exp b/gdb/testsuite/gdb.dap/terminate.exp
new file mode 100644 (file)
index 0000000..bc222ab
--- /dev/null
@@ -0,0 +1,39 @@
+# Copyright 2023 Free Software Foundation, Inc.
+
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+# Test that the 'terminated' event is delivered.
+
+require allow_dap_tests
+
+load_lib dap-support.exp
+
+# The test doesn't matter much, since we aren't going to set any
+# breakpoints -- it just has to exit.
+standard_testfile scopes.c
+
+if {[build_executable ${testfile}.exp $testfile $srcfile] == -1} {
+    return
+}
+
+if {[dap_launch $testfile] == ""} {
+    return
+}
+
+dap_check_request_and_response "start inferior" configurationDone
+dap_wait_for_event_and_check "inferior started" thread "body reason" started
+
+dap_wait_for_event_and_check "terminated event" terminated
+
+dap_shutdown