gdb/gdb.h

   1 /* Library interface into GDB.
   2    Copyright (C) 1999, 2001
   3    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 2 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, write to the Free Software
  19    Foundation, Inc., 51 Franklin Street, Fifth Floor,
  20    Boston, MA 02110-1301, USA.  */
  21
  22 #ifndef GDB_H
  23 #define GDB_H
  24
  25 struct ui_out;
  26
  27 /* Return-code (RC) from a gdb library call.  (The abreviation RC is
  28    taken from the sim/common directory.) */
  29
  30 enum gdb_rc {
  31   /* The operation failed.  The failure message can be fetched by
  32      calling ``char *error_last_message(void)''.  The value is
  33      determined by the catch_errors() interface.  The MSG parameter is
  34      set to a freshly allocated copy of the error message.  */
  35   /* NOTE: Since ``defs.h:catch_errors()'' does not return an error /
  36      internal / quit indication it is not possible to return that
  37      here. */
  38   GDB_RC_FAIL = 0,
  39   /* No error occured but nothing happened. Due to the catch_errors()
  40      interface, this must be non-zero. */
  41   GDB_RC_NONE = 1,
  42   /* The operation was successful. Due to the catch_errors()
  43      interface, this must be non-zero. */
  44   GDB_RC_OK = 2
  45 };
  46
  47
  48 /* Print the specified breakpoint on GDB_STDOUT. (Eventually this
  49    function will ``print'' the object on ``output''). */
  50 enum gdb_rc gdb_breakpoint_query (struct ui_out *uiout, int bnum,
  51                                   char **error_message);
  52
  53 /* Create a breakpoint at ADDRESS (a GDB source and line). */
  54 enum gdb_rc gdb_breakpoint (char *address, char *condition,
  55                             int hardwareflag, int tempflag,
  56                             int thread, int ignore_count,
  57                             char **error_message);
  58
  59 /* Switch thread and print notification. */
  60 enum gdb_rc gdb_thread_select (struct ui_out *uiout, char *tidstr,
  61                                char **error_message);
  62
  63 /* Print a list of known thread ids. */
  64 enum gdb_rc gdb_list_thread_ids (struct ui_out *uiout,
  65                                  char **error_message);
  66
  67 #endif