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