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