gdb/defs.h

   1 /* *INDENT-OFF* */ /* ATTR_FORMAT confuses indent, avoid running it for now */
   2 /* Basic, host-specific, and target-specific definitions for GDB.
   3    Copyright (C) 1986, 1989, 1991-1996, 1998-2000
   4    Free Software Foundation, Inc.
   5
   6    This file is part of GDB.
   7
   8    This program is free software; you can redistribute it and/or modify
   9    it under the terms of the GNU General Public License as published by
  10    the Free Software Foundation; either version 2 of the License, or
  11    (at your option) any later version.
  12
  13    This program is distributed in the hope that it will be useful,
  14    but WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16    GNU General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with this program; if not, write to the Free Software
  20    Foundation, Inc., 59 Temple Place - Suite 330,
  21    Boston, MA 02111-1307, USA.  */
  22
  23 #ifndef DEFS_H
  24 #define DEFS_H
  25
  26 #include "config.h"             /* Generated by configure */
  27 #include <stdio.h>
  28 #include <errno.h>              /* System call error return status */
  29 #include <limits.h>
  30
  31 #ifdef HAVE_STDDEF_H
  32 #include <stddef.h>
  33 #else
  34 #include <sys/types.h>          /* for size_t */
  35 #endif
  36
  37 #ifdef HAVE_UNISTD_H
  38 #include <unistd.h>
  39 #endif
  40
  41 /* Just in case they're not defined in stdio.h. */
  42
  43 #ifndef SEEK_SET
  44 #define SEEK_SET 0
  45 #endif
  46 #ifndef SEEK_CUR
  47 #define SEEK_CUR 1
  48 #endif
  49
  50 /* First include ansidecl.h so we can use the various macro definitions
  51    here and in all subsequent file inclusions.  */
  52
  53 #include "ansidecl.h"
  54
  55 #include <stdarg.h>             /* for va_list */
  56
  57 #include "libiberty.h"
  58
  59 /* libiberty.h can't declare this one, but evidently we can.  */
  60 extern char *strsignal (int);
  61
  62 #include "progress.h"
  63
  64 #ifdef USE_MMALLOC
  65 #include "mmalloc.h"
  66 #endif
  67
  68 /* For BFD64 and bfd_vma.  */
  69 #include "bfd.h"
  70
  71 /* An address in the program being debugged.  Host byte order.  Rather
  72    than duplicate all the logic in BFD which figures out what type
  73    this is (long, long long, etc.) and whether it needs to be 64
  74    bits (the host/target interactions are subtle), we just use
  75    bfd_vma.  */
  76
  77 typedef bfd_vma CORE_ADDR;
  78
  79 /* This is to make sure that LONGEST is at least as big as CORE_ADDR.  */
  80
  81 #ifndef LONGEST
  82
  83 #ifdef BFD64
  84
  85 #define LONGEST BFD_HOST_64_BIT
  86 #define ULONGEST BFD_HOST_U_64_BIT
  87
  88 #else /* No BFD64 */
  89
  90 #ifdef CC_HAS_LONG_LONG
  91 #define LONGEST long long
  92 #define ULONGEST unsigned long long
  93 #else
  94 #ifdef BFD_HOST_64_BIT
  95 /* BFD_HOST_64_BIT is defined for some hosts that don't have long long
  96    (e.g. i386-windows) so try it.  */
  97 #define LONGEST BFD_HOST_64_BIT
  98 #define ULONGEST BFD_HOST_U_64_BIT
  99 #else
 100 #define LONGEST long
 101 #define ULONGEST unsigned long
 102 #endif
 103 #endif
 104
 105 #endif /* No BFD64 */
 106
 107 #endif /* ! LONGEST */
 108
 109 extern int core_addr_lessthan (CORE_ADDR lhs, CORE_ADDR rhs);
 110 extern int core_addr_greaterthan (CORE_ADDR lhs, CORE_ADDR rhs);
 111
 112
 113 #ifndef min
 114 #define min(a, b) ((a) < (b) ? (a) : (b))
 115 #endif
 116 #ifndef max
 117 #define max(a, b) ((a) > (b) ? (a) : (b))
 118 #endif
 119
 120 /* Macros to do string compares.
 121
 122    NOTE: cagney/2000-03-14:
 123
 124    While old code can continue to refer to these macros, new code is
 125    probably better off using strcmp() directly vis: ``strcmp() == 0''
 126    and ``strcmp() != 0''.
 127
 128    This is because modern compilers can directly inline strcmp()
 129    making the original justification for these macros - avoid function
 130    call overhead by pre-testing the first characters
 131    (``*X==*Y?...:0'') - redundant.
 132
 133    ``Even if [...] testing the first character does have a modest
 134    performance improvement, I'd rather that whenever a performance
 135    issue is found that we spend the effort on algorithmic
 136    optimizations than micro-optimizing.'' J.T. */
 137
 138 #define STRCMP(a,b) (*(a) == *(b) ? strcmp ((a), (b)) : (int)*(a) - (int)*(b))
 139 #define STREQ(a,b) (*(a) == *(b) ? !strcmp ((a), (b)) : 0)
 140 #define STREQN(a,b,c) (*(a) == *(b) ? !strncmp ((a), (b), (c)) : 0)
 141
 142 /* The character GNU C++ uses to build identifiers that must be unique from
 143    the program's identifiers (such as $this and $$vptr).  */
 144 #define CPLUS_MARKER '$'        /* May be overridden to '.' for SysV */
 145
 146 /* Check if a character is one of the commonly used C++ marker characters.  */
 147 extern int is_cplus_marker (int);
 148
 149 /* use tui interface if non-zero */
 150 extern int tui_version;
 151
 152 #if defined(TUI)
 153 /* all invocations of TUIDO should have two sets of parens */
 154 #define TUIDO(x)        tuiDo x
 155 #else
 156 #define TUIDO(x)
 157 #endif
 158
 159 /* enable xdb commands if set */
 160 extern int xdb_commands;
 161
 162 /* enable dbx commands if set */
 163 extern int dbx_commands;
 164
 165 extern int quit_flag;
 166 extern int immediate_quit;
 167 extern int sevenbit_strings;
 168
 169 extern void quit (void);
 170
 171 /* FIXME: cagney/2000-03-13: It has been suggested that the peformance
 172    benefits of having a ``QUIT'' macro rather than a function are
 173    marginal.  If the overhead of a QUIT function call is proving
 174    significant then its calling frequency should probably be reduced
 175    [kingdon].  A profile analyzing the current situtation is
 176    needed. */
 177
 178 #ifdef QUIT
 179 /* do twice to force compiler warning */
 180 #define QUIT_FIXME "FIXME"
 181 #define QUIT_FIXME "ignoring redefinition of QUIT"
 182 #else
 183 #define QUIT { \
 184   if (quit_flag) quit (); \
 185   if (interactive_hook) interactive_hook (); \
 186   PROGRESS (1); \
 187 }
 188 #endif
 189
 190 /* Languages represented in the symbol table and elsewhere.
 191    This should probably be in language.h, but since enum's can't
 192    be forward declared to satisfy opaque references before their
 193    actual definition, needs to be here. */
 194
 195 enum language
 196   {
 197     language_unknown,           /* Language not known */
 198     language_auto,              /* Placeholder for automatic setting */
 199     language_c,                 /* C */
 200     language_cplus,             /* C++ */
 201     language_java,              /* Java */
 202     language_chill,             /* Chill */
 203     language_fortran,           /* Fortran */
 204     language_m2,                /* Modula-2 */
 205     language_asm,               /* Assembly language */
 206     language_scm                /* Scheme / Guile */
 207   };
 208
 209 enum precision_type
 210   {
 211     single_precision,
 212     double_precision,
 213     unspecified_precision
 214   };
 215
 216 /* the cleanup list records things that have to be undone
 217    if an error happens (descriptors to be closed, memory to be freed, etc.)
 218    Each link in the chain records a function to call and an
 219    argument to give it.
 220
 221    Use make_cleanup to add an element to the cleanup chain.
 222    Use do_cleanups to do all cleanup actions back to a given
 223    point in the chain.  Use discard_cleanups to remove cleanups
 224    from the chain back to a given point, not doing them.  */
 225
 226 struct cleanup
 227   {
 228     struct cleanup *next;
 229     void (*function) (PTR);
 230     PTR arg;
 231   };
 232
 233
 234 /* The ability to declare that a function never returns is useful, but
 235    not really required to compile GDB successfully, so the NORETURN and
 236    ATTR_NORETURN macros normally expand into nothing.  */
 237
 238 /* If compiling with older versions of GCC, a function may be declared
 239    "volatile" to indicate that it does not return.  */
 240
 241 #ifndef NORETURN
 242 #if defined(__GNUC__) \
 243      && (__GNUC__ == 1 || (__GNUC__ == 2 && __GNUC_MINOR__ < 7))
 244 #define NORETURN volatile
 245 #else
 246 #define NORETURN                /* nothing */
 247 #endif
 248 #endif
 249
 250 /* GCC 2.5 and later versions define a function attribute "noreturn",
 251    which is the preferred way to declare that a function never returns.
 252    However GCC 2.7 appears to be the first version in which this fully
 253    works everywhere we use it. */
 254
 255 #ifndef ATTR_NORETURN
 256 #if defined(__GNUC__) && __GNUC__ >= 2 && __GNUC_MINOR__ >= 7
 257 #define ATTR_NORETURN __attribute__ ((noreturn))
 258 #else
 259 #define ATTR_NORETURN           /* nothing */
 260 #endif
 261 #endif
 262
 263 #ifndef ATTR_FORMAT
 264 #if defined(__GNUC__) && __GNUC__ >= 2 && __GNUC_MINOR__ >= 4
 265 #define ATTR_FORMAT(type, x, y) __attribute__ ((format(type, x, y)))
 266 #else
 267 #define ATTR_FORMAT(type, x, y) /* nothing */
 268 #endif
 269 #endif
 270
 271 /* Needed for various prototypes */
 272
 273 struct symtab;
 274 struct breakpoint;
 275
 276 /* From blockframe.c */
 277
 278 extern int inside_entry_func (CORE_ADDR);
 279
 280 extern int inside_entry_file (CORE_ADDR addr);
 281
 282 extern int inside_main_func (CORE_ADDR pc);
 283
 284 /* From ch-lang.c, for the moment. (FIXME) */
 285
 286 extern char *chill_demangle (const char *);
 287
 288 /* From utils.c */
 289
 290 extern void initialize_utils (void);
 291
 292 extern void notice_quit (void);
 293
 294 extern int strcmp_iw (const char *, const char *);
 295
 296 extern int subset_compare (char *, char *);
 297
 298 extern char *safe_strerror (int);
 299
 300 extern char *safe_strsignal (int);
 301
 302 extern void init_malloc (void *);
 303
 304 extern void request_quit (int);
 305
 306 extern void do_cleanups (struct cleanup *);
 307 extern void do_final_cleanups (struct cleanup *);
 308 extern void do_my_cleanups (struct cleanup **, struct cleanup *);
 309 extern void do_run_cleanups (struct cleanup *);
 310 extern void do_exec_cleanups (struct cleanup *);
 311 extern void do_exec_error_cleanups (struct cleanup *);
 312
 313 extern void discard_cleanups (struct cleanup *);
 314 extern void discard_final_cleanups (struct cleanup *);
 315 extern void discard_exec_error_cleanups (struct cleanup *);
 316 extern void discard_my_cleanups (struct cleanup **, struct cleanup *);
 317
 318 /* DEPRECATED: cagney/2000-03-04: Do not use this typedef to cast
 319    function pointers so that they match the argument to the various
 320    cleanup functions.  Post GDB 5.0, this typedef will be
 321    deleted. [Editors note: cagney was the person that added most of
 322    those type casts] */
 323 typedef void (*make_cleanup_func) (void *);
 324
 325 /* NOTE: cagney/2000-03-04: This typedef is strictly for the
 326    make_cleanup function declarations below. Do not use this typedef
 327    as a cast when passing functions into the make_cleanup() code.
 328    Instead either use a bounce function or add a wrapper function.
 329    Calling a f(char*) function with f(void*) is non-portable. */
 330 typedef void (make_cleanup_ftype) (void *);
 331
 332 extern struct cleanup *make_cleanup (make_cleanup_ftype *, void *);
 333
 334 extern struct cleanup *make_cleanup_freeargv (char **);
 335
 336 struct ui_file;
 337 extern struct cleanup *make_cleanup_ui_file_delete (struct ui_file *);
 338
 339 extern struct cleanup *make_final_cleanup (make_cleanup_ftype *, void *);
 340
 341 extern struct cleanup *make_my_cleanup (struct cleanup **,
 342                                         make_cleanup_ftype *, void *);
 343
 344 extern struct cleanup *make_run_cleanup (make_cleanup_ftype *, void *);
 345
 346 extern struct cleanup *make_exec_cleanup (make_cleanup_ftype *, void *);
 347 extern struct cleanup *make_exec_error_cleanup (make_cleanup_ftype *, void *);
 348
 349 extern struct cleanup *save_cleanups (void);
 350 extern struct cleanup *save_final_cleanups (void);
 351 extern struct cleanup *save_my_cleanups (struct cleanup **);
 352
 353 extern void restore_cleanups (struct cleanup *);
 354 extern void restore_final_cleanups (struct cleanup *);
 355 extern void restore_my_cleanups (struct cleanup **, struct cleanup *);
 356
 357 extern void free_current_contents (char **);
 358
 359 extern void null_cleanup (void *);
 360
 361 extern int myread (int, char *, int);
 362
 363 extern int query (char *, ...) ATTR_FORMAT (printf, 1, 2);
 364
 365 #if !defined (USE_MMALLOC)
 366 /* NOTE: cagney/2000-03-04: The mmalloc functions need to use PTR
 367    rather than void* so that they are consistent with
 368    ../mmalloc/mmalloc.h. */
 369 extern PTR mcalloc (PTR, size_t, size_t);
 370 extern PTR mmalloc (PTR, size_t);
 371 extern PTR mrealloc (PTR, PTR, size_t);
 372 extern void mfree (PTR, PTR);
 373 #endif
 374
 375 extern void init_page_info (void);
 376
 377 /* From demangle.c */
 378
 379 extern void set_demangling_style (char *);
 380
 381 /* From tm.h */
 382
 383 struct type;
 384 typedef int (use_struct_convention_fn) (int gcc_p, struct type * value_type);
 385 extern use_struct_convention_fn generic_use_struct_convention;
 386
 387 typedef unsigned char *(breakpoint_from_pc_fn) (CORE_ADDR * pcptr, int *lenptr);
 388 \f
 389 /* Annotation stuff.  */
 390
 391 extern int annotation_level;    /* in stack.c */
 392 \f
 393 extern void begin_line (void);
 394
 395 extern void wrap_here (char *);
 396
 397 extern void reinitialize_more_filter (void);
 398
 399 /* Normal results */
 400 extern struct ui_file *gdb_stdout;
 401 /* Serious error notifications */
 402 extern struct ui_file *gdb_stderr;
 403 /* Log/debug/trace messages that should bypass normal stdout/stderr
 404    filtering.  For momement, always call this stream using
 405    *_unfiltered. In the very near future that restriction shall be
 406    removed - either call shall be unfiltered. (cagney 1999-06-13). */
 407 extern struct ui_file *gdb_stdlog;
 408 /* Target output that should bypass normal stdout/stderr filtering.
 409    For momement, always call this stream using *_unfiltered. In the
 410    very near future that restriction shall be removed - either call
 411    shall be unfiltered. (cagney 1999-07-02). */
 412 extern struct ui_file *gdb_stdtarg;
 413
 414 #if defined(TUI)
 415 #include "tui.h"
 416 #include "tuiCommand.h"
 417 #include "tuiData.h"
 418 #include "tuiIO.h"
 419 #include "tuiLayout.h"
 420 #include "tuiWin.h"
 421 #endif
 422
 423 #include "ui-file.h"
 424
 425 /* More generic printf like operations */
 426
 427 extern void fputs_filtered (const char *, struct ui_file *);
 428
 429 extern void fputs_unfiltered (const char *, struct ui_file *);
 430
 431 extern int fputc_filtered (int c, struct ui_file *);
 432
 433 extern int fputc_unfiltered (int c, struct ui_file *);
 434
 435 extern int putchar_unfiltered (int c);
 436
 437 extern void puts_filtered (const char *);
 438
 439 extern void puts_unfiltered (const char *);
 440
 441 extern void puts_debug (char *prefix, char *string, char *suffix);
 442
 443 extern void vprintf_filtered (const char *, va_list) ATTR_FORMAT (printf, 1, 0);
 444
 445 extern void vfprintf_filtered (struct ui_file *, const char *, va_list) ATTR_FORMAT (printf, 2, 0);
 446
 447 extern void fprintf_filtered (struct ui_file *, const char *, ...) ATTR_FORMAT (printf, 2, 3);
 448
 449 extern void fprintfi_filtered (int, struct ui_file *, const char *, ...) ATTR_FORMAT (printf, 3, 4);
 450
 451 extern void printf_filtered (const char *, ...) ATTR_FORMAT (printf, 1, 2);
 452
 453 extern void printfi_filtered (int, const char *, ...) ATTR_FORMAT (printf, 2, 3);
 454
 455 extern void vprintf_unfiltered (const char *, va_list) ATTR_FORMAT (printf, 1, 0);
 456
 457 extern void vfprintf_unfiltered (struct ui_file *, const char *, va_list) ATTR_FORMAT (printf, 2, 0);
 458
 459 extern void fprintf_unfiltered (struct ui_file *, const char *, ...) ATTR_FORMAT (printf, 2, 3);
 460
 461 extern void printf_unfiltered (const char *, ...) ATTR_FORMAT (printf, 1, 2);
 462
 463 extern void print_spaces (int, struct ui_file *);
 464
 465 extern void print_spaces_filtered (int, struct ui_file *);
 466
 467 extern char *n_spaces (int);
 468
 469 extern void fputstr_filtered (const char *str, int quotr, struct ui_file * stream);
 470
 471 extern void fputstr_unfiltered (const char *str, int quotr, struct ui_file * stream);
 472
 473 extern void fputstrn_unfiltered (const char *str, int n, int quotr, struct ui_file * stream);
 474
 475 /* Display the host ADDR on STREAM formatted as ``0x%x''. */
 476 extern void gdb_print_host_address (void *addr, struct ui_file *stream);
 477
 478 /* Convert a CORE_ADDR into a HEX string.  paddr() is like %08lx.
 479    paddr_nz() is like %lx.  paddr_u() is like %lu. paddr_width() is
 480    for ``%*''. */
 481 extern int strlen_paddr (void);
 482 extern char *paddr (CORE_ADDR addr);
 483 extern char *paddr_nz (CORE_ADDR addr);
 484 extern char *paddr_u (CORE_ADDR addr);
 485 extern char *paddr_d (LONGEST addr);
 486
 487 typedef bfd_vma t_reg;
 488 extern char *preg (t_reg reg);
 489 extern char *preg_nz (t_reg reg);
 490
 491 extern void fprintf_symbol_filtered (struct ui_file *, char *,
 492                                      enum language, int);
 493
 494 extern NORETURN void perror_with_name (char *) ATTR_NORETURN;
 495
 496 extern void print_sys_errmsg (char *, int);
 497
 498 /* From regex.c or libc.  BSD 4.4 declares this with the argument type as
 499    "const char *" in unistd.h, so we can't declare the argument
 500    as "char *".  */
 501
 502 extern char *re_comp (const char *);
 503
 504 /* From symfile.c */
 505
 506 extern void symbol_file_command (char *, int);
 507
 508 /* Remote targets may wish to use this as their load function.  */
 509 extern void generic_load (char *name, int from_tty);
 510
 511 /* Summarise a download */
 512 extern void print_transfer_performance (struct ui_file *stream,
 513                                         unsigned long data_count,
 514                                         unsigned long write_count,
 515                                         unsigned long time_count);
 516
 517 /* From top.c */
 518
 519 typedef void initialize_file_ftype (void);
 520
 521 extern char *skip_quoted (char *);
 522
 523 extern char *gdb_readline (char *);
 524
 525 extern char *command_line_input (char *, int, char *);
 526
 527 extern void print_prompt (void);
 528
 529 extern int input_from_terminal_p (void);
 530
 531 extern int info_verbose;
 532
 533 /* From printcmd.c */
 534
 535 extern void set_next_address (CORE_ADDR);
 536
 537 extern void print_address_symbolic (CORE_ADDR, struct ui_file *, int,
 538                                     char *);
 539
 540 extern int build_address_symbolic (CORE_ADDR addr,
 541                                    int do_demangle,
 542                                    char **name,
 543                                    int *offset,
 544                                    char **filename,
 545                                    int *line,
 546                                    int *unmapped);
 547
 548 extern void print_address_numeric (CORE_ADDR, int, struct ui_file *);
 549
 550 extern void print_address (CORE_ADDR, struct ui_file *);
 551
 552 /* From source.c */
 553
 554 extern int openp (char *, int, char *, int, int, char **);
 555
 556 extern int source_full_path_of (char *, char **);
 557
 558 extern void mod_path (char *, char **);
 559
 560 extern void directory_command (char *, int);
 561
 562 extern void init_source_path (void);
 563
 564 extern char *symtab_to_filename (struct symtab *);
 565
 566 /* From exec.c */
 567
 568 extern void exec_set_section_offsets (bfd_signed_vma text_off,
 569                                       bfd_signed_vma data_off,
 570                                       bfd_signed_vma bss_off);
 571
 572 /* From findvar.c */
 573
 574 extern int read_relative_register_raw_bytes (int, char *);
 575
 576 /* Possible lvalue types.  Like enum language, this should be in
 577    value.h, but needs to be here for the same reason. */
 578
 579 enum lval_type
 580   {
 581     /* Not an lval. */
 582     not_lval,
 583     /* In memory.  Could be a saved register.  */
 584     lval_memory,
 585     /* In a register.  */
 586     lval_register,
 587     /* In a gdb internal variable.  */
 588     lval_internalvar,
 589     /* Part of a gdb internal variable (structure field).  */
 590     lval_internalvar_component,
 591     /* In a register series in a frame not the current one, which may have been
 592        partially saved or saved in different places (otherwise would be
 593        lval_register or lval_memory).  */
 594     lval_reg_frame_relative
 595   };
 596
 597 struct frame_info;
 598
 599 void default_get_saved_register (char *raw_buffer, int *optimized,
 600                                  CORE_ADDR * addrp,
 601                                  struct frame_info *frame, int regnum,
 602                                  enum lval_type *lval);
 603
 604 /* From readline (but not in any readline .h files).  */
 605
 606 extern char *tilde_expand (char *);
 607
 608 /* Control types for commands */
 609
 610 enum misc_command_type
 611   {
 612     ok_command,
 613     end_command,
 614     else_command,
 615     nop_command
 616   };
 617
 618 enum command_control_type
 619   {
 620     simple_control,
 621     break_control,
 622     continue_control,
 623     while_control,
 624     if_control,
 625     invalid_control
 626   };
 627
 628 /* Structure for saved commands lines
 629    (for breakpoints, defined commands, etc).  */
 630
 631 struct command_line
 632   {
 633     struct command_line *next;
 634     char *line;
 635     enum command_control_type control_type;
 636     int body_count;
 637     struct command_line **body_list;
 638   };
 639
 640 extern struct command_line *read_command_lines (char *, int);
 641
 642 extern void free_command_lines (struct command_line **);
 643
 644 /* To continue the execution commands when running gdb asynchronously.
 645    A continuation structure contains a pointer to a function to be called
 646    to finish the command, once the target has stopped. Such mechanism is
 647    used bt the finish and until commands, and in the remote protocol
 648    when opening an extended-remote connection. */
 649
 650 struct continuation_arg
 651   {
 652     struct continuation_arg *next;
 653     void *data;
 654   };
 655
 656 struct continuation
 657   {
 658     void (*continuation_hook) (struct continuation_arg *);
 659     struct continuation_arg *arg_list;
 660     struct continuation *next;
 661   };
 662 struct continuation continuation;
 663
 664 /* In infrun.c. */
 665 extern struct continuation *cmd_continuation;
 666 /* Used only by the step_1 function. */
 667 extern struct continuation *intermediate_continuation;
 668
 669 /* From utils.c */
 670 extern void add_continuation (void (*)(struct continuation_arg *),
 671                               struct continuation_arg *);
 672 extern void do_all_continuations (void);
 673 extern void discard_all_continuations (void);
 674
 675 extern void add_intermediate_continuation (void (*)(struct continuation_arg *),
 676                               struct continuation_arg *);
 677 extern void do_all_intermediate_continuations (void);
 678 extern void discard_all_intermediate_continuations (void);
 679
 680 /* String containing the current directory (what getwd would return).  */
 681
 682 extern char *current_directory;
 683
 684 /* Default radixes for input and output.  Only some values supported.  */
 685 extern unsigned input_radix;
 686 extern unsigned output_radix;
 687
 688 /* Possibilities for prettyprint parameters to routines which print
 689    things.  Like enum language, this should be in value.h, but needs
 690    to be here for the same reason.  FIXME:  If we can eliminate this
 691    as an arg to LA_VAL_PRINT, then we can probably move it back to
 692    value.h. */
 693
 694 enum val_prettyprint
 695   {
 696     Val_no_prettyprint = 0,
 697     Val_prettyprint,
 698     /* Use the default setting which the user has specified.  */
 699     Val_pretty_default
 700   };
 701 \f
 702
 703 /* Host machine definition.  This will be a symlink to one of the
 704    xm-*.h files, built by the `configure' script.  */
 705
 706 #include "xm.h"
 707
 708 /* Native machine support.  This will be a symlink to one of the
 709    nm-*.h files, built by the `configure' script.  */
 710
 711 #include "nm.h"
 712
 713 /* Target machine definition.  This will be a symlink to one of the
 714    tm-*.h files, built by the `configure' script.  */
 715
 716 #include "tm.h"
 717
 718 /* If the xm.h file did not define the mode string used to open the
 719    files, assume that binary files are opened the same way as text
 720    files */
 721 #ifndef FOPEN_RB
 722 #include "fopen-same.h"
 723 #endif
 724
 725 /* Microsoft C can't deal with const pointers */
 726
 727 #ifdef _MSC_VER
 728 #define CONST_PTR
 729 #else
 730 #define CONST_PTR const
 731 #endif
 732
 733 /*
 734  * Allow things in gdb to be declared "volatile".  If compiling ANSI, it
 735  * just works.  If compiling with gcc but non-ansi, redefine to __volatile__.
 736  * If non-ansi, non-gcc, then eliminate "volatile" entirely, making those
 737  * objects be read-write rather than read-only.
 738  */
 739
 740 #ifndef volatile
 741 #ifndef __STDC__
 742 #ifdef __GNUC__
 743 #define volatile __volatile__
 744 #else
 745 #define volatile                /* nothing */
 746 #endif /* GNUC */
 747 #endif /* STDC */
 748 #endif /* volatile */
 749
 750 /* Defaults for system-wide constants (if not defined by xm.h, we fake it).
 751    FIXME: Assumes 2's complement arithmetic */
 752
 753 #if !defined (UINT_MAX)
 754 #define UINT_MAX ((unsigned int)(~0))   /* 0xFFFFFFFF for 32-bits */
 755 #endif
 756
 757 #if !defined (INT_MAX)
 758 #define INT_MAX ((int)(UINT_MAX >> 1))  /* 0x7FFFFFFF for 32-bits */
 759 #endif
 760
 761 #if !defined (INT_MIN)
 762 #define INT_MIN ((int)((int) ~0 ^ INT_MAX))     /* 0x80000000 for 32-bits */
 763 #endif
 764
 765 #if !defined (ULONG_MAX)
 766 #define ULONG_MAX ((unsigned long)(~0L))        /* 0xFFFFFFFF for 32-bits */
 767 #endif
 768
 769 #if !defined (LONG_MAX)
 770 #define LONG_MAX ((long)(ULONG_MAX >> 1))       /* 0x7FFFFFFF for 32-bits */
 771 #endif
 772
 773 #if !defined (ULONGEST_MAX)
 774 #define ULONGEST_MAX (~(ULONGEST)0)        /* 0xFFFFFFFFFFFFFFFF for 32-bits */
 775 #endif
 776
 777 #if !defined (LONGEST_MAX)                 /* 0x7FFFFFFFFFFFFFFF for 32-bits */
 778 #define LONGEST_MAX ((LONGEST)(ULONGEST_MAX >> 1))
 779 #endif
 780
 781 /* Convert a LONGEST to an int.  This is used in contexts (e.g. number of
 782    arguments to a function, number in a value history, register number, etc.)
 783    where the value must not be larger than can fit in an int.  */
 784
 785 extern int longest_to_int (LONGEST);
 786
 787 /* Assorted functions we can declare, now that const and volatile are
 788    defined.  */
 789
 790 extern char *savestring (const char *, int);
 791
 792 extern char *msavestring (void *, const char *, int);
 793
 794 extern char *strsave (const char *);
 795
 796 extern char *mstrsave (void *, const char *);
 797
 798 /* FIXME; was long, but this causes compile errors in msvc if already
 799    defined */
 800 #ifdef _MSC_VER
 801 extern PTR xmmalloc (PTR, size_t);
 802 extern PTR xmrealloc (PTR, PTR, size_t);
 803 #else
 804 extern PTR xmmalloc (PTR, long);
 805 extern PTR xmrealloc (PTR, PTR, long);
 806 #endif
 807
 808 extern int parse_escape (char **);
 809
 810 /* Message to be printed before the error message, when an error occurs.  */
 811
 812 extern char *error_pre_print;
 813
 814 /* Message to be printed before the error message, when an error occurs.  */
 815
 816 extern char *quit_pre_print;
 817
 818 /* Message to be printed before the warning message, when a warning occurs.  */
 819
 820 extern char *warning_pre_print;
 821
 822 extern NORETURN void verror (const char *fmt, va_list ap) ATTR_NORETURN;
 823
 824 extern NORETURN void error (const char *fmt, ...) ATTR_NORETURN;
 825
 826 /* DEPRECATED: Use error(), verror() or error_stream(). */
 827 extern NORETURN void error_begin (void);
 828
 829 extern NORETURN void error_stream (struct ui_file *) ATTR_NORETURN;
 830
 831 /* Returns a freshly allocate buffer containing the last error
 832    message.  */
 833 extern char *error_last_message (void);
 834
 835 extern NORETURN void internal_verror (const char *, va_list ap) ATTR_NORETURN;
 836
 837 extern NORETURN void internal_error (char *, ...) ATTR_NORETURN;
 838
 839 extern NORETURN void nomem (long) ATTR_NORETURN;
 840
 841 /* Reasons for calling return_to_top_level.  Note: enum value 0 is
 842    reserved for internal use as the return value from an initial
 843    setjmp().  */
 844
 845 enum return_reason
 846   {
 847     /* User interrupt.  */
 848     RETURN_QUIT = 1,
 849     /* Any other error.  */
 850     RETURN_ERROR
 851   };
 852
 853 #define ALL_CLEANUPS    ((struct cleanup *)0)
 854
 855 #define RETURN_MASK(reason)     (1 << (int)(reason))
 856 #define RETURN_MASK_QUIT        RETURN_MASK (RETURN_QUIT)
 857 #define RETURN_MASK_ERROR       RETURN_MASK (RETURN_ERROR)
 858 #define RETURN_MASK_ALL         (RETURN_MASK_QUIT | RETURN_MASK_ERROR)
 859 typedef int return_mask;
 860
 861 extern NORETURN void return_to_top_level (enum return_reason) ATTR_NORETURN;
 862
 863 /* If CATCH_ERRORS_FTYPE throws an error, catch_errors() returns zero
 864    otherwize the result from CATCH_ERRORS_FTYPE is returned. It is
 865    probably useful for CATCH_ERRORS_FTYPE to always return a non-zero
 866    value. It's unfortunate that, catch_errors() does not return an
 867    indication of the exact exception that it caught - quit_flag might
 868    help. */
 869
 870 typedef int (catch_errors_ftype) (PTR);
 871 extern int catch_errors (catch_errors_ftype *, PTR, char *, return_mask);
 872
 873 /* Template to catch_errors() that wraps calls to command
 874    functions. */
 875
 876 typedef void (catch_command_errors_ftype) (char *, int);
 877 extern int catch_command_errors (catch_command_errors_ftype *func, char *command, int from_tty, return_mask);
 878
 879 extern void warning_begin (void);
 880
 881 extern void warning (const char *, ...) ATTR_FORMAT (printf, 1, 2);
 882
 883 /* Global functions from other, non-gdb GNU thingies.
 884    Libiberty thingies are no longer declared here.  We include libiberty.h
 885    above, instead.  */
 886
 887 #ifndef GETENV_PROVIDED
 888 extern char *getenv (const char *);
 889 #endif
 890
 891 /* From other system libraries */
 892
 893 #ifdef HAVE_STDDEF_H
 894 #include <stddef.h>
 895 #endif
 896
 897 #ifdef HAVE_STDLIB_H
 898 #if defined(_MSC_VER) && !defined(__cplusplus)
 899 /* msvc defines these in stdlib.h for c code */
 900 #undef min
 901 #undef max
 902 #endif
 903 #include <stdlib.h>
 904 #endif
 905 #ifndef min
 906 #define min(a, b) ((a) < (b) ? (a) : (b))
 907 #endif
 908 #ifndef max
 909 #define max(a, b) ((a) > (b) ? (a) : (b))
 910 #endif
 911
 912
 913 /* We take the address of fclose later, but some stdio's forget
 914    to declare this.  We can't always declare it since there's
 915    no way to declare the parameters without upsetting some compiler
 916    somewhere. */
 917
 918 #ifndef FCLOSE_PROVIDED
 919 extern int fclose (FILE *);
 920 #endif
 921
 922 #ifndef atof
 923 extern double atof (const char *);      /* X3.159-1989  4.10.1.1 */
 924 #endif
 925
 926 #ifndef MALLOC_INCOMPATIBLE
 927
 928 #ifdef NEED_DECLARATION_MALLOC
 929 extern PTR malloc ();
 930 #endif
 931
 932 #ifdef NEED_DECLARATION_REALLOC
 933 extern PTR realloc ();
 934 #endif
 935
 936 #ifdef NEED_DECLARATION_FREE
 937 extern void free ();
 938 #endif
 939
 940 #endif /* MALLOC_INCOMPATIBLE */
 941
 942 /* Various possibilities for alloca.  */
 943 #ifndef alloca
 944 #ifdef __GNUC__
 945 #define alloca __builtin_alloca
 946 #else /* Not GNU C */
 947 #ifdef HAVE_ALLOCA_H
 948 #include <alloca.h>
 949 #else
 950 #ifdef _AIX
 951 #pragma alloca
 952 #else
 953
 954 /* We need to be careful not to declare this in a way which conflicts with
 955    bison.  Bison never declares it as char *, but under various circumstances
 956    (like __hpux) we need to use void *.  */
 957 #if defined (__STDC__) || defined (__hpux)
 958 extern void *alloca ();
 959 #else /* Don't use void *.  */
 960 extern char *alloca ();
 961 #endif /* Don't use void *.  */
 962 #endif /* Not _AIX */
 963 #endif /* Not HAVE_ALLOCA_H */
 964 #endif /* Not GNU C */
 965 #endif /* alloca not defined */
 966
 967 /* HOST_BYTE_ORDER must be defined to one of these.  */
 968
 969 #ifdef HAVE_ENDIAN_H
 970 #include <endian.h>
 971 #endif
 972
 973 #if !defined (BIG_ENDIAN)
 974 #define BIG_ENDIAN 4321
 975 #endif
 976
 977 #if !defined (LITTLE_ENDIAN)
 978 #define LITTLE_ENDIAN 1234
 979 #endif
 980
 981 /* Dynamic target-system-dependent parameters for GDB. */
 982 #include "gdbarch.h"
 983
 984 /* Static target-system-dependent parameters for GDB. */
 985
 986 /* Number of bits in a char or unsigned char for the target machine.
 987    Just like CHAR_BIT in <limits.h> but describes the target machine.  */
 988 #if !defined (TARGET_CHAR_BIT)
 989 #define TARGET_CHAR_BIT 8
 990 #endif
 991
 992 /* Number of bits in a short or unsigned short for the target machine. */
 993 #if !defined (TARGET_SHORT_BIT)
 994 #define TARGET_SHORT_BIT (2 * TARGET_CHAR_BIT)
 995 #endif
 996
 997 /* Number of bits in an int or unsigned int for the target machine. */
 998 #if !defined (TARGET_INT_BIT)
 999 #define TARGET_INT_BIT (4 * TARGET_CHAR_BIT)
1000 #endif
1001
1002 /* Number of bits in a long or unsigned long for the target machine. */
1003 #if !defined (TARGET_LONG_BIT)
1004 #define TARGET_LONG_BIT (4 * TARGET_CHAR_BIT)
1005 #endif
1006
1007 /* Number of bits in a long long or unsigned long long for the target machine. */
1008 #if !defined (TARGET_LONG_LONG_BIT)
1009 #define TARGET_LONG_LONG_BIT (2 * TARGET_LONG_BIT)
1010 #endif
1011
1012 /* Number of bits in a float for the target machine. */
1013 #if !defined (TARGET_FLOAT_BIT)
1014 #define TARGET_FLOAT_BIT (4 * TARGET_CHAR_BIT)
1015 #endif
1016
1017 /* Number of bits in a double for the target machine. */
1018 #if !defined (TARGET_DOUBLE_BIT)
1019 #define TARGET_DOUBLE_BIT (8 * TARGET_CHAR_BIT)
1020 #endif
1021
1022 /* Number of bits in a long double for the target machine.  */
1023 #if !defined (TARGET_LONG_DOUBLE_BIT)
1024 #define TARGET_LONG_DOUBLE_BIT (2 * TARGET_DOUBLE_BIT)
1025 #endif
1026
1027 /* Number of bits in a pointer for the target machine */
1028 #if !defined (TARGET_PTR_BIT)
1029 #define TARGET_PTR_BIT TARGET_INT_BIT
1030 #endif
1031
1032 /* Number of bits in a BFD_VMA for the target object file format. */
1033 #if !defined (TARGET_BFD_VMA_BIT)
1034 #define TARGET_BFD_VMA_BIT TARGET_PTR_BIT
1035 #endif
1036
1037 /* If we picked up a copy of CHAR_BIT from a configuration file
1038    (which may get it by including <limits.h>) then use it to set
1039    the number of bits in a host char.  If not, use the same size
1040    as the target. */
1041
1042 #if defined (CHAR_BIT)
1043 #define HOST_CHAR_BIT CHAR_BIT
1044 #else
1045 #define HOST_CHAR_BIT TARGET_CHAR_BIT
1046 #endif
1047
1048 /* The bit byte-order has to do just with numbering of bits in
1049    debugging symbols and such.  Conceptually, it's quite separate
1050    from byte/word byte order.  */
1051
1052 #if !defined (BITS_BIG_ENDIAN)
1053 #define BITS_BIG_ENDIAN (TARGET_BYTE_ORDER == BIG_ENDIAN)
1054 #endif
1055
1056 /* In findvar.c.  */
1057
1058 extern LONGEST extract_signed_integer (void *, int);
1059
1060 extern ULONGEST extract_unsigned_integer (void *, int);
1061
1062 extern int extract_long_unsigned_integer (void *, int, LONGEST *);
1063
1064 extern CORE_ADDR extract_address (void *, int);
1065
1066 extern void store_signed_integer (void *, int, LONGEST);
1067
1068 extern void store_unsigned_integer (void *, int, ULONGEST);
1069
1070 extern void store_address (void *, int, LONGEST);
1071
1072 /* Setup definitions for host and target floating point formats.  We need to
1073    consider the format for `float', `double', and `long double' for both target
1074    and host.  We need to do this so that we know what kind of conversions need
1075    to be done when converting target numbers to and from the hosts DOUBLEST
1076    data type.  */
1077
1078 /* This is used to indicate that we don't know the format of the floating point
1079    number.  Typically, this is useful for native ports, where the actual format
1080    is irrelevant, since no conversions will be taking place.  */
1081
1082 extern const struct floatformat floatformat_unknown;
1083
1084 #if HOST_BYTE_ORDER == BIG_ENDIAN
1085 #ifndef HOST_FLOAT_FORMAT
1086 #define HOST_FLOAT_FORMAT &floatformat_ieee_single_big
1087 #endif
1088 #ifndef HOST_DOUBLE_FORMAT
1089 #define HOST_DOUBLE_FORMAT &floatformat_ieee_double_big
1090 #endif
1091 #else /* LITTLE_ENDIAN */
1092 #ifndef HOST_FLOAT_FORMAT
1093 #define HOST_FLOAT_FORMAT &floatformat_ieee_single_little
1094 #endif
1095 #ifndef HOST_DOUBLE_FORMAT
1096 #define HOST_DOUBLE_FORMAT &floatformat_ieee_double_little
1097 #endif
1098 #endif
1099
1100 #ifndef HOST_LONG_DOUBLE_FORMAT
1101 #define HOST_LONG_DOUBLE_FORMAT &floatformat_unknown
1102 #endif
1103
1104 #ifndef TARGET_FLOAT_FORMAT
1105 #define TARGET_FLOAT_FORMAT (TARGET_BYTE_ORDER == BIG_ENDIAN \
1106                              ? &floatformat_ieee_single_big \
1107                              : &floatformat_ieee_single_little)
1108 #endif
1109 #ifndef TARGET_DOUBLE_FORMAT
1110 #define TARGET_DOUBLE_FORMAT (TARGET_BYTE_ORDER == BIG_ENDIAN \
1111                               ? &floatformat_ieee_double_big \
1112                               : &floatformat_ieee_double_little)
1113 #endif
1114
1115 #ifndef TARGET_LONG_DOUBLE_FORMAT
1116 #define TARGET_LONG_DOUBLE_FORMAT &floatformat_unknown
1117 #endif
1118
1119 /* Use `long double' if the host compiler supports it.  (Note that this is not
1120    necessarily any longer than `double'.  On SunOS/gcc, it's the same as
1121    double.)  This is necessary because GDB internally converts all floating
1122    point values to the widest type supported by the host.
1123
1124    There are problems however, when the target `long double' is longer than the
1125    host's `long double'.  In general, we'll probably reduce the precision of
1126    any such values and print a warning.  */
1127
1128 #ifdef HAVE_LONG_DOUBLE
1129 typedef long double DOUBLEST;
1130 #else
1131 typedef double DOUBLEST;
1132 #endif
1133
1134 extern void floatformat_to_doublest (const struct floatformat *,
1135                                      char *, DOUBLEST *);
1136 extern void floatformat_from_doublest (const struct floatformat *,
1137                                        DOUBLEST *, char *);
1138 extern DOUBLEST extract_floating (void *, int);
1139
1140 extern void store_floating (void *, int, DOUBLEST);
1141 \f
1142 /* On some machines there are bits in addresses which are not really
1143    part of the address, but are used by the kernel, the hardware, etc.
1144    for special purposes.  ADDR_BITS_REMOVE takes out any such bits
1145    so we get a "real" address such as one would find in a symbol
1146    table.  This is used only for addresses of instructions, and even then
1147    I'm not sure it's used in all contexts.  It exists to deal with there
1148    being a few stray bits in the PC which would mislead us, not as some sort
1149    of generic thing to handle alignment or segmentation (it's possible it
1150    should be in TARGET_READ_PC instead). */
1151 #if !defined (ADDR_BITS_REMOVE)
1152 #define ADDR_BITS_REMOVE(addr) (addr)
1153 #endif /* No ADDR_BITS_REMOVE.  */
1154
1155 /* From valops.c */
1156
1157 extern CORE_ADDR push_bytes (CORE_ADDR, char *, int);
1158
1159 extern CORE_ADDR push_word (CORE_ADDR, ULONGEST);
1160
1161 extern int watchdog;
1162
1163 /* Hooks for alternate command interfaces.  */
1164
1165 #ifdef UI_OUT
1166 /* The name of the interpreter if specified on the command line. */
1167 extern char *interpreter_p;
1168 #endif
1169
1170 /* If a given interpreter matches INTERPRETER_P then it should update
1171    command_loop_hook and init_ui_hook with the per-interpreter
1172    implementation. */
1173 /* FIXME: command_loop_hook and init_ui_hook should be moved here. */
1174
1175 struct target_waitstatus;
1176 struct cmd_list_element;
1177
1178 /* Should the asynchronous variant of the interpreter (using the
1179    event-loop) be enabled? */
1180 extern int event_loop_p;
1181
1182 extern void (*init_ui_hook) (char *argv0);
1183 extern void (*command_loop_hook) (void);
1184 extern void (*show_load_progress) (const char *section,
1185                                    unsigned long section_sent,
1186                                    unsigned long section_size,
1187                                    unsigned long total_sent,
1188                                    unsigned long total_size);
1189 extern void (*print_frame_info_listing_hook) (struct symtab * s,
1190                                               int line, int stopline,
1191                                               int noerror);
1192 extern struct frame_info *parse_frame_specification (char *frame_exp);
1193 extern int (*query_hook) (const char *, va_list);
1194 extern void (*warning_hook) (const char *, va_list);
1195 extern void (*flush_hook) (struct ui_file * stream);
1196 extern void (*create_breakpoint_hook) (struct breakpoint * b);
1197 extern void (*delete_breakpoint_hook) (struct breakpoint * bpt);
1198 extern void (*modify_breakpoint_hook) (struct breakpoint * bpt);
1199 extern void (*interactive_hook) (void);
1200 extern void (*registers_changed_hook) (void);
1201 extern void (*readline_begin_hook) (char *,...);
1202 extern char *(*readline_hook) (char *);
1203 extern void (*readline_end_hook) (void);
1204 extern void (*register_changed_hook) (int regno);
1205 extern void (*memory_changed_hook) (CORE_ADDR addr, int len);
1206 extern void (*context_hook) (int);
1207 extern int (*target_wait_hook) (int pid, struct target_waitstatus * status);
1208
1209 extern void (*attach_hook) (void);
1210 extern void (*detach_hook) (void);
1211 extern void (*call_command_hook) (struct cmd_list_element * c,
1212                                   char *cmd, int from_tty);
1213
1214 extern void (*set_hook) (struct cmd_list_element * c);
1215
1216 extern NORETURN void (*error_hook) (void) ATTR_NORETURN;
1217
1218 extern void (*error_begin_hook) (void);
1219
1220 extern int (*ui_load_progress_hook) (const char *section, unsigned long num);
1221
1222
1223 /* Inhibit window interface if non-zero. */
1224
1225 extern int use_windows;
1226
1227 /* Symbolic definitions of filename-related things.  */
1228 /* FIXME, this doesn't work very well if host and executable
1229    filesystems conventions are different.  */
1230
1231 #ifndef DIRNAME_SEPARATOR
1232 #define DIRNAME_SEPARATOR ':'
1233 #endif
1234
1235 #ifndef SLASH_P
1236 #if defined(__GO32__)||defined(_WIN32)
1237 #define SLASH_P(X) ((X)=='\\')
1238 #else
1239 #define SLASH_P(X) ((X)=='/')
1240 #endif
1241 #endif
1242
1243 #ifndef SLASH_CHAR
1244 #if defined(__GO32__)||defined(_WIN32)
1245 #define SLASH_CHAR '\\'
1246 #else
1247 #define SLASH_CHAR '/'
1248 #endif
1249 #endif
1250
1251 #ifndef SLASH_STRING
1252 #if defined(__GO32__)||defined(_WIN32)
1253 #define SLASH_STRING "\\"
1254 #else
1255 #define SLASH_STRING "/"
1256 #endif
1257 #endif
1258
1259 #ifndef ROOTED_P
1260 #define ROOTED_P(X) (SLASH_P((X)[0]))
1261 #endif
1262
1263 /* On some systems, PIDGET is defined to extract the inferior pid from
1264    an internal pid that has the thread id and pid in seperate bit
1265    fields.  If not defined, then just use the entire internal pid as
1266    the actual pid. */
1267
1268 #ifndef PIDGET
1269 #define PIDGET(PID) (PID)
1270 #define TIDGET(PID) 0
1271 #define MERGEPID(PID, TID) (PID)
1272 #endif
1273
1274 /* If under Cygwin, provide backwards compatibility with older
1275    Cygwin compilers that don't define the current cpp define. */
1276 #ifdef __CYGWIN32__
1277 #ifndef __CYGWIN__
1278 #define __CYGWIN__
1279 #endif
1280 #endif
1281
1282 /* Define well known filenos if the system does not define them.  */
1283 #ifndef STDIN_FILENO
1284 #define STDIN_FILENO   0
1285 #endif
1286 #ifndef STDOUT_FILENO
1287 #define STDOUT_FILENO  1
1288 #endif
1289 #ifndef STDERR_FILENO
1290 #define STDERR_FILENO  2
1291 #endif
1292
1293 /* If this definition isn't overridden by the header files, assume
1294    that isatty and fileno exist on this system.  */
1295 #ifndef ISATTY
1296 #define ISATTY(FP)      (isatty (fileno (FP)))
1297 #endif
1298
1299 \f
1300 /* FIXME: cagney/1999-12-13: The following will be moved to gdb.h /
1301    libgdb.h or gdblib.h. */
1302
1303 /* Return-code (RC) from a gdb library call.  (The abreviation RC is
1304    taken from the sim/common directory.) */
1305
1306 enum gdb_rc {
1307   /* The operation failed.  The failure message can be fetched by
1308      calling ``char *error_last_message(void)''. The value is
1309      determined by the catch_errors() interface. */
1310   /* NOTE: Since ``defs.h:catch_errors()'' does not return an error /
1311      internal / quit indication it is not possible to return that
1312      here. */
1313   GDB_RC_FAIL = 0,
1314   /* No error occured but nothing happened. Due to the catch_errors()
1315      interface, this must be non-zero. */
1316   GDB_RC_NONE = 1,
1317   /* The operation was successful. Due to the catch_errors()
1318      interface, this must be non-zero. */
1319   GDB_RC_OK = 2
1320 };
1321
1322
1323 /* Print the specified breakpoint on GDB_STDOUT. (Eventually this
1324    function will ``print'' the object on ``output''). */
1325 enum gdb_rc gdb_breakpoint_query (/* struct {ui,gdb}_out *output, */ int bnum);
1326
1327 /* Create a breakpoint at ADDRESS (a GDB source and line). */
1328 enum gdb_rc gdb_breakpoint (char *address, char *condition,
1329                             int hardwareflag, int tempflag,
1330                             int thread, int ignore_count);
1331 enum gdb_rc gdb_thread_select (/* output object */ char *tidstr);
1332
1333 #ifdef UI_OUT
1334 /* Print a list of known thread ids. */
1335 enum gdb_rc gdb_list_thread_ids (/* output object */);
1336
1337 /* Switch thread and print notification. */
1338 #endif
1339 #endif /* #ifndef DEFS_H */