gdb/gdb-events.h

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