gdb/gdb.h

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