gdb/python/py-event.h

   1 /* Python interface to inferior events.
   2
   3    Copyright (C) 2009-2019 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 GDB_PY_EVENT_H
  21 #define GDB_PY_EVENT_H
  22
  23 #include "py-events.h"
  24 #include "command.h"
  25 #include "python-internal.h"
  26 #include "inferior.h"
  27 #include "py-ref.h"
  28
  29 /* Declare all event types.  */
  30 #define GDB_PY_DEFINE_EVENT_TYPE(name, py_name, doc, base) \
  31   extern PyTypeObject name##_event_object_type              \
  32         CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF ("event_object");
  33 #include "py-event-types.def"
  34 #undef GDB_PY_DEFINE_EVENT_TYPE
  35
  36 typedef struct
  37 {
  38   PyObject_HEAD
  39
  40   PyObject *dict;
  41 } event_object;
  42
  43 extern int emit_continue_event (ptid_t ptid);
  44 extern int emit_exited_event (const LONGEST *exit_code, struct inferior *inf);
  45
  46 /* For inferior function call events, discriminate whether event is
  47    before or after the call. */
  48
  49 typedef enum
  50 {
  51   /* Before the call */
  52   INFERIOR_CALL_PRE,
  53   /* after the call */
  54   INFERIOR_CALL_POST,
  55 } inferior_call_kind;
  56
  57 extern int emit_inferior_call_event (inferior_call_kind kind,
  58                                      ptid_t thread, CORE_ADDR addr);
  59 extern int emit_register_changed_event (struct frame_info *frame,
  60                                         int regnum);
  61 extern int emit_memory_changed_event (CORE_ADDR addr, ssize_t len);
  62 extern int evpy_emit_event (PyObject *event,
  63                             eventregistry_object *registry);
  64
  65 extern gdbpy_ref<> create_event_object (PyTypeObject *py_type);
  66
  67 /* thread events can either be thread specific or process wide.  If gdb is
  68    running in non-stop mode then the event is thread specific, otherwise
  69    it is process wide.
  70    This function returns the currently stopped thread in non-stop mode and
  71    Py_None otherwise.  */
  72 extern gdbpy_ref<> py_get_event_thread (ptid_t ptid);
  73
  74 extern gdbpy_ref<> create_thread_event_object (PyTypeObject *py_type,
  75                                                PyObject *thread);
  76
  77 extern int emit_new_objfile_event (struct objfile *objfile);
  78 extern int emit_clear_objfiles_event (void);
  79
  80 extern void evpy_dealloc (PyObject *self);
  81 extern int evpy_add_attribute (PyObject *event,
  82                                const char *name, PyObject *attr)
  83   CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION;
  84 int gdbpy_initialize_event_generic (PyTypeObject *type, const char *name)
  85   CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION;
  86
  87 #endif /* GDB_PY_EVENT_H */