gdb/python/py-events.h

   1 /* Python interface to inferior events.
   2
   3    Copyright (C) 2009-2024 Free Software Foundation, Inc.
   4
   5    This file is part of GDB.
   6
   7    This program is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 3 of the License, or
  10    (at your option) any later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  19
  20 #ifndef PYTHON_PY_EVENTS_H
  21 #define PYTHON_PY_EVENTS_H
  22
  23 #include "command.h"
  24 #include "python-internal.h"
  25 #include "inferior.h"
  26
  27 /* Stores a list of objects to be notified when the event for which this
  28    registry tracks occurs.  */
  29
  30 struct eventregistry_object
  31 {
  32   PyObject_HEAD
  33
  34   PyObject *callbacks;
  35 };
  36
  37 /* Struct holding references to event registries both in python and c.
  38    This is meant to be a singleton.  */
  39
  40 struct events_object
  41 {
  42 #define GDB_PY_DEFINE_EVENT(name)               \
  43   eventregistry_object *name;
  44 #include "py-all-events.def"
  45 #undef GDB_PY_DEFINE_EVENT
  46
  47   PyObject *module;
  48
  49 };
  50
  51 /* Python events singleton.  */
  52 extern events_object gdb_py_events;
  53
  54 extern eventregistry_object *create_eventregistry_object (void);
  55 extern bool evregpy_no_listeners_p (eventregistry_object *registry);
  56
  57 #endif /* PYTHON_PY_EVENTS_H */