gdb/gdb.h

   1 /* Library interface into GDB.
   2    Copyright (C) 1999, 2001, 2007 Free Software Foundation, Inc.
   3
   4    This file is part of GDB.
   5
   6    This program is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 2 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program; if not, write to the Free Software
  18    Foundation, Inc., 51 Franklin Street, Fifth Floor,
  19    Boston, MA 02110-1301, USA.  */
  20
  21 #ifndef GDB_H
  22 #define GDB_H
  23
  24 struct ui_out;
  25
  26 /* Return-code (RC) from a gdb library call.  (The abreviation RC is
  27    taken from the sim/common directory.) */
  28
  29 enum gdb_rc {
  30   /* The operation failed.  The failure message can be fetched by
  31      calling ``char *error_last_message(void)''.  The value is
  32      determined by the catch_errors() interface.  The MSG parameter is
  33      set to a freshly allocated copy of the error message.  */
  34   /* NOTE: Since ``defs.h:catch_errors()'' does not return an error /
  35      internal / quit indication it is not possible to return that
  36      here. */
  37   GDB_RC_FAIL = 0,
  38   /* No error occured but nothing happened. Due to the catch_errors()
  39      interface, this must be non-zero. */
  40   GDB_RC_NONE = 1,
  41   /* The operation was successful. Due to the catch_errors()
  42      interface, this must be non-zero. */
  43   GDB_RC_OK = 2
  44 };
  45
  46
  47 /* Print the specified breakpoint on GDB_STDOUT. (Eventually this
  48    function will ``print'' the object on ``output''). */
  49 enum gdb_rc gdb_breakpoint_query (struct ui_out *uiout, int bnum,
  50                                   char **error_message);
  51
  52 /* Create a breakpoint at ADDRESS (a GDB source and line). */
  53 enum gdb_rc gdb_breakpoint (char *address, char *condition,
  54                             int hardwareflag, int tempflag,
  55                             int thread, int ignore_count,
  56                             char **error_message);
  57
  58 /* Switch thread and print notification. */
  59 enum gdb_rc gdb_thread_select (struct ui_out *uiout, char *tidstr,
  60                                char **error_message);
  61
  62 /* Print a list of known thread ids. */
  63 enum gdb_rc gdb_list_thread_ids (struct ui_out *uiout,
  64                                  char **error_message);
  65
  66 #endif