gdb/gdb.h

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