gdb/gdb-events.h

   1 /* User Interface Events.
   2
   3    Copyright 1999, 2001, 2002 Free Software Foundation, Inc.
   4
   5    Contributed by Cygnus Solutions.
   6
   7    This file is part of GDB.
   8
   9    This program is free software; you can redistribute it and/or modify
  10    it under the terms of the GNU General Public License as published by
  11    the Free Software Foundation; either version 2 of the License, or
  12    (at your option) any later version.
  13
  14    This program is distributed in the hope that it will be useful,
  15    but WITHOUT ANY WARRANTY; without even the implied warranty of
  16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17    GNU General Public License for more details.
  18
  19    You should have received a copy of the GNU General Public License
  20    along with this program; if not, write to the Free Software
  21    Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
  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 #ifndef WITH_GDB_EVENTS
  42 #define WITH_GDB_EVENTS 1
  43 #endif
  44
  45
  46 /* COMPAT: pointer variables for old, unconverted events.
  47    A call to set_gdb_events() will automatically update these. */
  48
  49
  50
  51 /* Type definition of all hook functions.
  52    Recommended pratice is to first declare each hook function using
  53    the below ftype and then define it. */
  54
  55 typedef void (gdb_events_breakpoint_create_ftype) (int b);
  56 typedef void (gdb_events_breakpoint_delete_ftype) (int b);
  57 typedef void (gdb_events_breakpoint_modify_ftype) (int b);
  58 typedef void (gdb_events_tracepoint_create_ftype) (int number);
  59 typedef void (gdb_events_tracepoint_delete_ftype) (int number);
  60 typedef void (gdb_events_tracepoint_modify_ftype) (int number);
  61 typedef void (gdb_events_architecture_changed_ftype) (void);
  62 typedef void (gdb_events_target_changed_ftype) (void);
  63
  64
  65 /* gdb-events: object. */
  66
  67 struct gdb_events
  68   {
  69     gdb_events_breakpoint_create_ftype *breakpoint_create;
  70     gdb_events_breakpoint_delete_ftype *breakpoint_delete;
  71     gdb_events_breakpoint_modify_ftype *breakpoint_modify;
  72     gdb_events_tracepoint_create_ftype *tracepoint_create;
  73     gdb_events_tracepoint_delete_ftype *tracepoint_delete;
  74     gdb_events_tracepoint_modify_ftype *tracepoint_modify;
  75     gdb_events_architecture_changed_ftype *architecture_changed;
  76     gdb_events_target_changed_ftype *target_changed;
  77   };
  78
  79
  80 /* Interface into events functions.
  81    Where a *_p() predicate is present, it must be called before
  82    calling the hook proper. */
  83 extern void breakpoint_create_event (int b);
  84 extern void breakpoint_delete_event (int b);
  85 extern void breakpoint_modify_event (int b);
  86 extern void tracepoint_create_event (int number);
  87 extern void tracepoint_delete_event (int number);
  88 extern void tracepoint_modify_event (int number);
  89 extern void architecture_changed_event (void);
  90 extern void target_changed_event (void);
  91
  92
  93 /* When GDB_EVENTS are not being used, completly disable them. */
  94
  95 #if !WITH_GDB_EVENTS
  96 #define breakpoint_create_event(b) 0
  97 #define breakpoint_delete_event(b) 0
  98 #define breakpoint_modify_event(b) 0
  99 #define tracepoint_create_event(number) 0
 100 #define tracepoint_delete_event(number) 0
 101 #define tracepoint_modify_event(number) 0
 102 #define architecture_changed_event() 0
 103 #define target_changed_event() 0
 104 #endif
 105
 106 /* Install custom gdb-events hooks. */
 107 extern struct gdb_events *set_gdb_event_hooks (struct gdb_events *vector);
 108
 109 /* Deliver any pending events. */
 110 extern void gdb_events_deliver (struct gdb_events *vector);
 111
 112 /* Clear event handlers */
 113 extern void clear_gdb_event_hooks (void);
 114
 115 #if !WITH_GDB_EVENTS
 116 #define set_gdb_events(x) 0
 117 #define set_gdb_event_hooks(x) 0
 118 #define gdb_events_deliver(x) 0
 119 #endif
 120
 121 #endif