gdb/continuations.h

   1 /* Continuations for GDB, the GNU debugger.
   2
   3    Copyright (C) 1999-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 CONTINUATIONS_H
  21 #define CONTINUATIONS_H
  22
  23 struct inferior;
  24
  25 /* To continue the execution commands when running gdb asynchronously.
  26    A continuation structure contains a pointer to a function to be called
  27    to finish the command, once the target has stopped.  Such mechanism is
  28    used by the finish and until commands, and in the remote protocol
  29    when opening an extended-remote connection.  */
  30
  31 /* Prototype of the continuation callback functions.  ARG is the
  32    continuation argument registered in the corresponding
  33    add_*_continuation call.  ERR is true when the command should be
  34    cancelled instead of finished normally.  In that case, the
  35    continuation should clean up whatever state had been set up for the
  36    command in question (e.g., remove momentary breakpoints).  This
  37    happens e.g., when an error was thrown while handling a target
  38    event, or when the inferior thread the command was being executed
  39    on exits.  */
  40 typedef void (continuation_ftype) (void *arg, int err);
  41
  42 /* Prototype of the function responsible for releasing the argument
  43    passed to the continuation callback functions, either when the
  44    continuation is called, or discarded.  */
  45 typedef void (continuation_free_arg_ftype) (void *);
  46
  47 /* Inferior specific (any thread) continuations.  */
  48
  49 extern void add_inferior_continuation (continuation_ftype *,
  50                                        void *,
  51                                        continuation_free_arg_ftype *);
  52 extern void do_all_inferior_continuations (int err);
  53 extern void discard_all_inferior_continuations (struct inferior *inf);
  54
  55 #endif