Files
binutils-gdb/gdb/python/py-event-types.def
Andrew Burgess 0e3b7c25ee gdb/python: introduce gdb.TargetConnection object type
This commit adds a new object type gdb.TargetConnection.  This new
type represents a connection within GDB (a connection as displayed by
'info connections').

There's three ways to find a gdb.TargetConnection, there's a new
'gdb.connections()' function, which returns a list of all currently
active connections.

Or you can read the new 'connection' property on the gdb.Inferior
object type, this contains the connection for that inferior (or None
if the inferior has no connection, for example, it is exited).

Finally, there's a new gdb.events.connection_removed event registry,
this emits a new gdb.ConnectionEvent whenever a connection is removed
from GDB (this can happen when all inferiors using a connection exit,
though this is not always the case, depending on the connection type).
The gdb.ConnectionEvent has a 'connection' property, which is the
gdb.TargetConnection being removed from GDB.

The gdb.TargetConnection has an 'is_valid()' method.  A connection
object becomes invalid when the underlying connection is removed from
GDB (as discussed above, this might be when all inferiors using a
connection exit, or it might be when the user explicitly replaces a
connection in GDB by issuing another 'target' command).

The gdb.TargetConnection has the following read-only properties:

  'num': The number for this connection,

  'type': e.g. 'native', 'remote', 'sim', etc

  'description': The longer description as seen in the 'info
                 connections' command output.

  'details': A string or None.  Extra details for the connection, for
             example, a remote connection's details might be
             'hostname:port'.
2021-11-30 12:10:33 +00:00

118 lines
3.3 KiB
C++

/* Python event definitions -*- c++ -*-
Copyright (C) 2017-2021 Free Software Foundation, Inc.
This file is part of GDB.
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/>. */
/* To use this file, define GDB_PY_DEFINE_EVENT_TYPE to expand how you
like, then include the file.
Each invocation is of the form:
GDB_PY_DEFINE_EVENT_TYPE(name, py_name, doc, base)
NAME is the name of the event.
PY_NAME a string representing what the event should be called in
python.
DOC Python documentation for the new event type
BASE the base event for this event usually just event_object_type.
*/
GDB_PY_DEFINE_EVENT_TYPE (breakpoint,
"BreakpointEvent",
"GDB breakpoint stop event object",
stop_event_object_type);
GDB_PY_DEFINE_EVENT_TYPE (continue,
"ContinueEvent",
"GDB continue event object",
thread_event_object_type);
GDB_PY_DEFINE_EVENT_TYPE (exited,
"ExitedEvent",
"GDB exited event object",
event_object_type);
GDB_PY_DEFINE_EVENT_TYPE (new_thread,
"NewThreadEvent",
"GDB new thread event object",
thread_event_object_type);
GDB_PY_DEFINE_EVENT_TYPE (new_inferior,
"NewInferiorEvent",
"GDB new inferior event object",
event_object_type);
GDB_PY_DEFINE_EVENT_TYPE (inferior_deleted,
"InferiorDeletedEvent",
"GDB inferior deleted event object",
event_object_type);
GDB_PY_DEFINE_EVENT_TYPE (inferior_call_pre,
"InferiorCallPreEvent",
"GDB inferior function pre-call event object",
event_object_type);
GDB_PY_DEFINE_EVENT_TYPE (inferior_call_post,
"InferiorCallPostEvent",
"GDB inferior function post-call event object",
event_object_type);
GDB_PY_DEFINE_EVENT_TYPE (register_changed,
"RegisterChangedEvent",
"GDB register change event object",
event_object_type);
GDB_PY_DEFINE_EVENT_TYPE (memory_changed,
"MemoryChangedEvent",
"GDB memory change event object",
event_object_type);
GDB_PY_DEFINE_EVENT_TYPE (new_objfile,
"NewObjFileEvent",
"GDB new object file event object",
event_object_type);
GDB_PY_DEFINE_EVENT_TYPE (clear_objfiles,
"ClearObjFilesEvent",
"GDB clear object files event object",
event_object_type);
GDB_PY_DEFINE_EVENT_TYPE (signal,
"SignalEvent",
"GDB signal event object",
stop_event_object_type);
GDB_PY_DEFINE_EVENT_TYPE (stop,
"StopEvent",
"GDB stop event object",
thread_event_object_type);
GDB_PY_DEFINE_EVENT_TYPE (thread,
"ThreadEvent",
"GDB thread event object",
event_object_type);
GDB_PY_DEFINE_EVENT_TYPE (gdb_exiting,
"GdbExitingEvent",
"GDB is about to exit",
event_object_type);
GDB_PY_DEFINE_EVENT_TYPE (connection,
"ConnectionEvent",
"GDB connection added or removed object",
event_object_type);