gdb/gdb-events.h

   1 /* User Interface Events.
   2
   3    Copyright (C) 1999, 2001, 2002, 2004, 2007, 2008
   4    Free Software Foundation, Inc.
   5
   6    Contributed by Cygnus Solutions.
   7
   8    This file is part of GDB.
   9
  10    This program is free software; you can redistribute it and/or modify
  11    it under the terms of the GNU General Public License as published by
  12    the Free Software Foundation; either version 3 of the License, or
  13    (at your option) any later version.
  14
  15    This program is distributed in the hope that it will be useful,
  16    but WITHOUT ANY WARRANTY; without even the implied warranty of
  17    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18    GNU General Public License for more details.
  19
  20    You should have received a copy of the GNU General Public License
  21    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  22
  23 /* Work in progress */
  24
  25 /* This file was created with the aid of ``gdb-events.sh''.
  26
  27    The bourn shell script ``gdb-events.sh'' creates the files
  28    ``new-gdb-events.c'' and ``new-gdb-events.h and then compares
  29    them against the existing ``gdb-events.[hc]''.  Any differences
  30    found being reported.
  31
  32    If editing this file, please also run gdb-events.sh and merge any
  33    changes into that script. Conversely, when making sweeping changes
  34    to this file, modifying gdb-events.sh and using its output may
  35    prove easier. */
  36
  37
  38 #ifndef GDB_EVENTS_H
  39 #define GDB_EVENTS_H
  40
  41
  42 /* COMPAT: pointer variables for old, unconverted events.
  43    A call to set_gdb_events() will automatically update these. */
  44
  45
  46
  47 /* Type definition of all hook functions.  Recommended pratice is to
  48    first declare each hook function using the below ftype and then
  49    define it.  */
  50
  51 typedef void (gdb_events_breakpoint_create_ftype) (int b);
  52 typedef void (gdb_events_breakpoint_delete_ftype) (int b);
  53 typedef void (gdb_events_breakpoint_modify_ftype) (int b);
  54 typedef void (gdb_events_tracepoint_create_ftype) (int number);
  55 typedef void (gdb_events_tracepoint_delete_ftype) (int number);
  56 typedef void (gdb_events_tracepoint_modify_ftype) (int number);
  57 typedef void (gdb_events_architecture_changed_ftype) (void);
  58
  59
  60 /* gdb-events: object. */
  61
  62 struct gdb_events
  63   {
  64     gdb_events_breakpoint_create_ftype *breakpoint_create;
  65     gdb_events_breakpoint_delete_ftype *breakpoint_delete;
  66     gdb_events_breakpoint_modify_ftype *breakpoint_modify;
  67     gdb_events_tracepoint_create_ftype *tracepoint_create;
  68     gdb_events_tracepoint_delete_ftype *tracepoint_delete;
  69     gdb_events_tracepoint_modify_ftype *tracepoint_modify;
  70     gdb_events_architecture_changed_ftype *architecture_changed;
  71   };
  72
  73
  74 /* Interface into events functions.
  75    Where a *_p() predicate is present, it must be called before
  76    calling the hook proper.  */
  77 extern void breakpoint_create_event (int b);
  78 extern void breakpoint_delete_event (int b);
  79 extern void breakpoint_modify_event (int b);
  80 extern void tracepoint_create_event (int number);
  81 extern void tracepoint_delete_event (int number);
  82 extern void tracepoint_modify_event (int number);
  83 extern void architecture_changed_event (void);
  84
  85 /* Install custom gdb-events hooks.  */
  86 extern struct gdb_events *deprecated_set_gdb_event_hooks (struct gdb_events *vector);
  87
  88 /* Deliver any pending events.  */
  89 extern void gdb_events_deliver (struct gdb_events *vector);
  90
  91 /* Clear event handlers.  */
  92 extern void clear_gdb_event_hooks (void);
  93
  94 #endif