import gdb-1999-10-04 snapshot
[external/binutils.git] / 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 PARAMS ((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 /* BFD_HOST_64_BIT is defined for some hosts that don't have long long
95    (e.g. i386-windows) so try it.  */
96 #    ifdef BFD_HOST_64_BIT
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 PARAMS ((CORE_ADDR lhs, CORE_ADDR rhs));
110 extern int core_addr_greaterthan PARAMS ((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 PARAMS ((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 PARAMS ((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) PARAMS ((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 PARAMS ((CORE_ADDR));
257
258 extern int inside_entry_file PARAMS ((CORE_ADDR addr));
259
260 extern int inside_main_func PARAMS ((CORE_ADDR pc));
261
262 /* From ch-lang.c, for the moment. (FIXME) */
263
264 extern char *chill_demangle PARAMS ((const char *));
265
266 /* From utils.c */
267
268 extern void initialize_utils PARAMS ((void));
269
270 extern void notice_quit PARAMS ((void));
271
272 extern int strcmp_iw PARAMS ((const char *, const char *));
273
274 extern int subset_compare PARAMS ((char *, char *));
275
276 extern char *safe_strerror PARAMS ((int));
277
278 extern char *safe_strsignal PARAMS ((int));
279
280 extern void init_malloc PARAMS ((void *));
281
282 extern void request_quit PARAMS ((int));
283
284 extern void do_cleanups PARAMS ((struct cleanup *));
285 extern void do_final_cleanups PARAMS ((struct cleanup *));
286 extern void do_my_cleanups PARAMS ((struct cleanup **, struct cleanup *));
287 extern void do_run_cleanups PARAMS ((struct cleanup *));
288 extern void do_exec_cleanups PARAMS ((struct cleanup *));
289 extern void do_exec_error_cleanups PARAMS ((struct cleanup *));
290
291 extern void discard_cleanups PARAMS ((struct cleanup *));
292 extern void discard_final_cleanups PARAMS ((struct cleanup *));
293 extern void discard_exec_error_cleanups PARAMS ((struct cleanup *));
294 extern void discard_my_cleanups PARAMS ((struct cleanup **, struct cleanup *));
295
296 typedef void (*make_cleanup_func) PARAMS ((void *));
297
298 extern struct cleanup *make_cleanup PARAMS ((make_cleanup_func, void *));
299
300 extern struct cleanup *make_cleanup_freeargv PARAMS ((char **));
301
302 extern struct cleanup *make_final_cleanup PARAMS ((make_cleanup_func, void *));
303
304 extern struct cleanup *make_my_cleanup PARAMS ((struct cleanup **, 
305                                                 make_cleanup_func, void *));
306
307 extern struct cleanup *make_run_cleanup PARAMS ((make_cleanup_func, void *));
308
309 extern struct cleanup *make_exec_cleanup PARAMS ((make_cleanup_func, void *));
310 extern struct cleanup *make_exec_error_cleanup PARAMS ((make_cleanup_func, void *));
311
312 extern struct cleanup *save_cleanups PARAMS ((void));
313 extern struct cleanup *save_final_cleanups PARAMS ((void));
314 extern struct cleanup *save_my_cleanups PARAMS ((struct cleanup **));
315
316 extern void restore_cleanups PARAMS ((struct cleanup *));
317 extern void restore_final_cleanups PARAMS ((struct cleanup *));
318 extern void restore_my_cleanups PARAMS ((struct cleanup **, struct cleanup *));
319
320 extern void free_current_contents PARAMS ((char **));
321
322 extern void null_cleanup PARAMS ((PTR));
323
324 extern int myread PARAMS ((int, char *, int));
325
326 extern int query PARAMS((char *, ...))
327      ATTR_FORMAT(printf, 1, 2);
328
329 #if !defined (USE_MMALLOC)
330 extern PTR mmalloc PARAMS ((PTR, size_t));
331 extern PTR mrealloc PARAMS ((PTR, PTR, size_t));
332 extern void mfree PARAMS ((PTR, PTR));
333 #endif
334
335 extern void init_page_info PARAMS ((void));
336
337 /* From demangle.c */
338
339 extern void set_demangling_style PARAMS ((char *));
340
341 /* From tm.h */
342
343 struct type;
344 typedef int (use_struct_convention_fn) PARAMS ((int gcc_p, struct type *value_type));
345 extern use_struct_convention_fn generic_use_struct_convention;
346
347 typedef unsigned char *(breakpoint_from_pc_fn) PARAMS ((CORE_ADDR *pcptr, int *lenptr));
348
349
350 \f
351 /* Annotation stuff.  */
352
353 extern int annotation_level; /* in stack.c */
354 \f
355 extern void begin_line PARAMS ((void));
356
357 extern void wrap_here PARAMS ((char *));
358
359 extern void reinitialize_more_filter PARAMS ((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 new gdb_file with the specified methods. */
389
390 typedef void (gdb_file_flush_ftype) PARAMS ((struct gdb_file *stream));
391 extern void set_gdb_file_flush PARAMS ((struct gdb_file *stream, gdb_file_flush_ftype *flush));
392
393 typedef void (gdb_file_fputs_ftype) PARAMS ((const char *, struct gdb_file *stream));
394 extern void set_gdb_file_fputs PARAMS ((struct gdb_file *stream, gdb_file_fputs_ftype *fputs));
395
396 typedef int (gdb_file_isatty_ftype) PARAMS ((struct gdb_file *stream));
397 extern void set_gdb_file_isatty PARAMS ((struct gdb_file *stream, gdb_file_isatty_ftype *isatty));
398
399 typedef void (gdb_file_rewind_ftype) PARAMS ((struct gdb_file *stream));
400 extern void set_gdb_file_rewind PARAMS ((struct gdb_file *stream, gdb_file_rewind_ftype *rewind));
401
402 typedef void (gdb_file_put_ftype) PARAMS ((struct gdb_file *stream, struct gdb_file *dest));
403 extern void set_gdb_file_put PARAMS ((struct gdb_file *stream, gdb_file_put_ftype *put));
404
405 typedef void (gdb_file_delete_ftype) PARAMS ((struct gdb_file *stream));
406 extern void set_gdb_file_data PARAMS ((struct gdb_file *stream, void *data, gdb_file_delete_ftype *delete));
407
408 extern struct gdb_file *gdb_file_new PARAMS ((void));
409
410 extern void gdb_file_delete PARAMS ((struct gdb_file *stream));
411
412 extern void gdb_file_rewind PARAMS ((struct gdb_file *stream));
413
414 /* NOTE: copies left to right */
415 extern void gdb_file_put PARAMS ((struct gdb_file *src, struct gdb_file *dest));
416
417 extern void *gdb_file_data PARAMS ((struct gdb_file *file));
418
419 /* Open the specified FILE as a gdb_file. */
420 extern struct gdb_file *stdio_fileopen PARAMS ((FILE *)); 
421 /* #if defined (TUI) */
422 extern struct gdb_file *tui_fileopen PARAMS ((FILE *)); 
423 extern struct gdb_file *tui_sfileopen PARAMS ((int)); 
424 /* #endif */
425
426 /* deprecated - use gdb_file_delete */
427 extern void gdb_fclose PARAMS ((GDB_FILE **));
428
429 extern void gdb_flush PARAMS ((GDB_FILE *));
430
431 extern GDB_FILE *gdb_fopen PARAMS ((char * name, char * mode));
432
433 extern void fputs_filtered PARAMS ((const char *, GDB_FILE *));
434
435 extern void fputs_unfiltered PARAMS ((const char *, GDB_FILE *));
436
437 extern int fputc_filtered PARAMS ((int c, GDB_FILE *));
438
439 extern int fputc_unfiltered PARAMS ((int c, GDB_FILE *));
440
441 extern int putchar_unfiltered PARAMS ((int c));
442
443 extern void puts_filtered PARAMS ((const char *));
444
445 extern void puts_unfiltered PARAMS ((const char *));
446
447 extern void puts_debug PARAMS ((char *prefix, char *string, char *suffix));
448
449 extern void vprintf_filtered PARAMS ((const char *, va_list))
450      ATTR_FORMAT(printf, 1, 0);
451
452 extern void vfprintf_filtered PARAMS ((GDB_FILE *, const char *, va_list))
453      ATTR_FORMAT(printf, 2, 0);
454
455 extern void fprintf_filtered PARAMS ((GDB_FILE *, const char *, ...))
456      ATTR_FORMAT(printf, 2, 3);
457
458 extern void fprintfi_filtered PARAMS ((int, GDB_FILE *, const char *, ...))
459      ATTR_FORMAT(printf, 3, 4);
460
461 extern void printf_filtered PARAMS ((const char *, ...))
462      ATTR_FORMAT(printf, 1, 2);
463
464 extern void printfi_filtered PARAMS ((int, const char *, ...))
465      ATTR_FORMAT(printf, 2, 3);
466
467 extern void vprintf_unfiltered PARAMS ((const char *, va_list))
468      ATTR_FORMAT(printf, 1, 0);
469
470 extern void vfprintf_unfiltered PARAMS ((GDB_FILE *, const char *, va_list))
471      ATTR_FORMAT(printf, 2, 0);
472
473 extern void fprintf_unfiltered PARAMS ((GDB_FILE *, const char *, ...))
474      ATTR_FORMAT(printf, 2, 3);
475
476 extern void printf_unfiltered PARAMS ((const char *, ...))
477      ATTR_FORMAT(printf, 1, 2);
478
479 extern int gdb_file_isatty PARAMS ((GDB_FILE *));
480
481 /* #if defined (TUI) */
482 extern GDB_FILE *gdb_file_init_astring PARAMS ((int));
483 /* #endif */
484
485 extern void gdb_file_deallocate PARAMS ((GDB_FILE **));
486
487 /* #if defined (TUI) */
488 extern char *gdb_file_get_strbuf PARAMS ((GDB_FILE *));
489 /* #endif */
490
491 /* #if defined (TUI) */
492 extern void gdb_file_adjust_strbuf PARAMS ((int, GDB_FILE *));
493 /* #endif */
494
495 extern void print_spaces PARAMS ((int, GDB_FILE *));
496
497 extern void print_spaces_filtered PARAMS ((int, GDB_FILE *));
498
499 extern char *n_spaces PARAMS ((int));
500
501 extern void fputstr_filtered PARAMS ((const char *str, int quotr, GDB_FILE *stream));
502
503 extern void fputstr_unfiltered PARAMS ((const char *str, int quotr, GDB_FILE *stream));
504
505 extern void fputstrn_unfiltered PARAMS ((const char *str, int n, int quotr, GDB_FILE *stream));
506
507 /* Display the host ADDR on STREAM formatted as ``0x%x''. */
508 extern void gdb_print_host_address (void *addr, struct gdb_file *stream);
509
510 /* Convert a CORE_ADDR into a HEX string.  paddr() is like %08lx.
511    paddr_nz() is like %lx.  paddr_u() is like %lu. paddr_width() is
512    for ``%*''. */
513 extern int strlen_paddr (void);
514 extern char* paddr (CORE_ADDR addr);
515 extern char* paddr_nz (CORE_ADDR addr);
516 extern char* paddr_u (CORE_ADDR addr);
517 extern char* paddr_d (LONGEST addr);
518
519 typedef bfd_vma t_reg;
520 extern char* preg (t_reg reg);
521 extern char* preg_nz (t_reg reg);
522
523 extern void fprintf_symbol_filtered PARAMS ((GDB_FILE *, char *,
524                                              enum language, int));
525
526 extern NORETURN void perror_with_name PARAMS ((char *)) ATTR_NORETURN;
527
528 extern void print_sys_errmsg PARAMS ((char *, int));
529
530 /* From regex.c or libc.  BSD 4.4 declares this with the argument type as
531    "const char *" in unistd.h, so we can't declare the argument
532    as "char *".  */
533
534 extern char *re_comp PARAMS ((const char *));
535
536 /* From symfile.c */
537
538 extern void symbol_file_command PARAMS ((char *, int));
539
540 /* From top.c */
541
542 typedef void initialize_file_ftype (void);
543
544 extern char *skip_quoted PARAMS ((char *));
545
546 extern char *gdb_readline PARAMS ((char *));
547
548 extern char *command_line_input PARAMS ((char *, int, char *));
549
550 extern void print_prompt PARAMS ((void));
551
552 extern int input_from_terminal_p PARAMS ((void));
553
554 extern int info_verbose;
555
556 /* From printcmd.c */
557
558 extern void set_next_address PARAMS ((CORE_ADDR));
559
560 extern void print_address_symbolic PARAMS ((CORE_ADDR, GDB_FILE *, int,
561                                             char *));
562
563 extern void print_address_numeric PARAMS ((CORE_ADDR, int, GDB_FILE *));
564
565 extern void print_address PARAMS ((CORE_ADDR, GDB_FILE *));
566
567 /* From source.c */
568
569 extern int openp PARAMS ((char *, int, char *, int, int, char **));
570
571 extern int source_full_path_of PARAMS ((char *, char **));
572
573 extern void mod_path PARAMS ((char *, char **));
574
575 extern void directory_command PARAMS ((char *, int));
576
577 extern void init_source_path PARAMS ((void));
578
579 extern char *symtab_to_filename PARAMS ((struct symtab *));
580
581 /* From exec.c */
582
583 extern void exec_set_section_offsets (bfd_signed_vma text_off,
584                                       bfd_signed_vma data_off,
585                                       bfd_signed_vma bss_off);
586
587 /* From findvar.c */
588
589 extern int read_relative_register_raw_bytes PARAMS ((int, char *));
590
591 /* Possible lvalue types.  Like enum language, this should be in
592    value.h, but needs to be here for the same reason. */
593
594 enum lval_type
595   {
596     /* Not an lval. */
597     not_lval,
598     /* In memory.  Could be a saved register.  */
599     lval_memory,
600     /* In a register.  */
601     lval_register,
602     /* In a gdb internal variable.  */
603     lval_internalvar,
604     /* Part of a gdb internal variable (structure field).  */
605     lval_internalvar_component,
606     /* In a register series in a frame not the current one, which may have been
607        partially saved or saved in different places (otherwise would be
608        lval_register or lval_memory).  */
609     lval_reg_frame_relative
610   };
611
612 struct frame_info;
613
614 void default_get_saved_register PARAMS ((char *raw_buffer, int *optimized,
615                                          CORE_ADDR *addrp,
616                                          struct frame_info *frame, int regnum,
617                                          enum lval_type *lval));
618
619 /* From readline (but not in any readline .h files).  */
620
621 extern char *tilde_expand PARAMS ((char *));
622
623 /* Control types for commands */
624
625 enum misc_command_type
626 {
627   ok_command,
628   end_command,
629   else_command,
630   nop_command
631 };
632
633 enum command_control_type
634 {
635   simple_control,
636   break_control,
637   continue_control,
638   while_control,
639   if_control,
640   invalid_control
641 };
642
643 /* Structure for saved commands lines
644    (for breakpoints, defined commands, etc).  */
645
646 struct command_line
647 {
648   struct command_line *next;
649   char *line;
650   enum command_control_type control_type;
651   int body_count;
652   struct command_line **body_list;
653 };
654
655 extern struct command_line *read_command_lines PARAMS ((char *, int));
656
657 extern void free_command_lines PARAMS ((struct command_line **));
658
659 /* To continue the execution commands when running gdb asynchronously. 
660    A continuation structure contains a pointer to a function to be called 
661    to finish the command, once the target has stopped. Such mechanism is
662    used bt the finish and until commands, and in the remote protocol
663    when opening an extended-remote connection. */
664
665 struct continuation_arg
666 {
667   struct continuation_arg *next;
668   PTR data;
669 };
670
671 struct continuation
672 {
673   void (*continuation_hook) PARAMS ((struct continuation_arg *));
674   struct continuation_arg *arg_list;
675   struct continuation *next;
676 }
677 continuation;
678
679 /* In infrun.c. */
680 extern struct continuation *cmd_continuation;
681
682 /* From utils.c */
683 extern void add_continuation PARAMS ((void (*) PARAMS ((struct continuation_arg *)), 
684                                struct continuation_arg *));
685 extern void do_all_continuations PARAMS ((void));
686 extern void discard_all_continuations PARAMS ((void));
687
688 /* String containing the current directory (what getwd would return).  */
689
690 extern char *current_directory;
691
692 /* Default radixes for input and output.  Only some values supported.  */
693 extern unsigned input_radix;
694 extern unsigned output_radix;
695
696 /* Possibilities for prettyprint parameters to routines which print
697    things.  Like enum language, this should be in value.h, but needs
698    to be here for the same reason.  FIXME:  If we can eliminate this
699    as an arg to LA_VAL_PRINT, then we can probably move it back to
700    value.h. */
701
702 enum val_prettyprint
703 {
704   Val_no_prettyprint = 0,
705   Val_prettyprint,
706   /* Use the default setting which the user has specified.  */
707   Val_pretty_default
708 };
709
710 \f
711 /* Host machine definition.  This will be a symlink to one of the
712    xm-*.h files, built by the `configure' script.  */
713
714 #include "xm.h"
715
716 /* Native machine support.  This will be a symlink to one of the
717    nm-*.h files, built by the `configure' script.  */
718
719 #include "nm.h"
720
721 /* Target machine definition.  This will be a symlink to one of the
722    tm-*.h files, built by the `configure' script.  */
723
724 #include "tm.h"
725
726 /* If the xm.h file did not define the mode string used to open the
727    files, assume that binary files are opened the same way as text
728    files */
729 #ifndef FOPEN_RB
730 #include "fopen-same.h"
731 #endif
732
733 /* Microsoft C can't deal with const pointers */
734
735 #ifdef _MSC_VER
736 #define CONST_PTR
737 #else
738 #define CONST_PTR const
739 #endif
740
741 /*
742  * Allow things in gdb to be declared "volatile".  If compiling ANSI, it
743  * just works.  If compiling with gcc but non-ansi, redefine to __volatile__.
744  * If non-ansi, non-gcc, then eliminate "volatile" entirely, making those
745  * objects be read-write rather than read-only.
746  */
747
748 #ifndef volatile
749 #ifndef __STDC__
750 # ifdef __GNUC__
751 #  define volatile __volatile__
752 # else
753 #  define volatile /*nothing*/
754 # endif /* GNUC */
755 #endif /* STDC */
756 #endif /* volatile */
757
758 /* Defaults for system-wide constants (if not defined by xm.h, we fake it).
759    FIXME: Assumes 2's complement arithmetic */
760
761 #if !defined (UINT_MAX)
762 #define UINT_MAX ((unsigned int)(~0))           /* 0xFFFFFFFF for 32-bits */
763 #endif
764
765 #if !defined (INT_MAX)
766 #define INT_MAX ((int)(UINT_MAX >> 1))          /* 0x7FFFFFFF for 32-bits */
767 #endif
768
769 #if !defined (INT_MIN)
770 #define INT_MIN ((int)((int) ~0 ^ INT_MAX))     /* 0x80000000 for 32-bits */
771 #endif
772
773 #if !defined (ULONG_MAX)
774 #define ULONG_MAX ((unsigned long)(~0L))        /* 0xFFFFFFFF for 32-bits */
775 #endif
776
777 #if !defined (LONG_MAX)
778 #define LONG_MAX ((long)(ULONG_MAX >> 1))       /* 0x7FFFFFFF for 32-bits */
779 #endif
780
781 /* Convert a LONGEST to an int.  This is used in contexts (e.g. number of
782    arguments to a function, number in a value history, register number, etc.)
783    where the value must not be larger than can fit in an int.  */
784
785 extern int longest_to_int PARAMS ((LONGEST));
786
787 /* Assorted functions we can declare, now that const and volatile are 
788    defined.  */
789
790 extern char *savestring PARAMS ((const char *, int));
791
792 extern char *msavestring PARAMS ((void *, const char *, int));
793
794 extern char *strsave PARAMS ((const char *));
795
796 extern char *mstrsave PARAMS ((void *, const char *));
797
798 #ifdef _MSC_VER /* FIXME; was long, but this causes compile errors in msvc if already defined */
799 extern PTR xmmalloc PARAMS ((PTR, size_t));
800
801 extern PTR xmrealloc PARAMS ((PTR, PTR, size_t));
802 #else
803 extern PTR xmmalloc PARAMS ((PTR, long));
804
805 extern PTR xmrealloc PARAMS ((PTR, PTR, long));
806 #endif
807
808 extern int parse_escape PARAMS ((char **));
809
810 /* Message to be printed before the error message, when an error occurs.  */
811
812 extern char *error_pre_print;
813
814 /* Message to be printed before the error message, when an error occurs.  */
815
816 extern char *quit_pre_print;
817
818 /* Message to be printed before the warning message, when a warning occurs.  */
819
820 extern char *warning_pre_print;
821
822 extern NORETURN void error PARAMS((const char *, ...)) ATTR_NORETURN;
823
824 extern void error_begin PARAMS ((void));
825
826 extern NORETURN void internal_error (char *, ...) ATTR_NORETURN;
827
828 extern NORETURN void error_stream PARAMS ((GDB_FILE *)) ATTR_NORETURN;
829
830 extern char *error_last_message PARAMS ((void));
831
832 extern NORETURN void nomem PARAMS ((long)) ATTR_NORETURN;
833
834 /* Reasons for calling return_to_top_level.  */
835 enum return_reason {
836   /* User interrupt.  */
837   RETURN_QUIT,
838
839   /* Any other error.  */
840   RETURN_ERROR
841 };
842
843 #define ALL_CLEANUPS    ((struct cleanup *)0)
844
845 #define RETURN_MASK_QUIT (1 << (int)RETURN_QUIT)
846 #define RETURN_MASK_ERROR (1 << (int)RETURN_ERROR)
847 #define RETURN_MASK_ALL (RETURN_MASK_QUIT | RETURN_MASK_ERROR)
848 typedef int return_mask;
849
850 extern NORETURN void
851 return_to_top_level PARAMS ((enum return_reason)) ATTR_NORETURN;
852
853 typedef int (catch_errors_ftype) PARAMS ((PTR));
854 extern int catch_errors PARAMS ((catch_errors_ftype *, PTR, char *, return_mask));
855
856 extern void warning_begin PARAMS ((void));
857
858 extern void warning PARAMS ((const char *, ...))
859      ATTR_FORMAT(printf, 1, 2);
860
861 /* Global functions from other, non-gdb GNU thingies.
862    Libiberty thingies are no longer declared here.  We include libiberty.h
863    above, instead.  */
864
865 #ifndef GETENV_PROVIDED
866 extern char *getenv PARAMS ((const char *));
867 #endif
868
869 /* From other system libraries */
870
871 #ifdef HAVE_STDDEF_H
872 #include <stddef.h>
873 #endif
874
875 #ifdef HAVE_STDLIB_H
876 #if defined(_MSC_VER) && !defined(__cplusplus)
877 /* msvc defines these in stdlib.h for c code */
878 #undef min
879 #undef max
880 #endif
881 #include <stdlib.h>
882 #endif
883 #ifndef min
884 #define min(a, b) ((a) < (b) ? (a) : (b))
885 #endif
886 #ifndef max
887 #define max(a, b) ((a) > (b) ? (a) : (b))
888 #endif
889
890
891 /* We take the address of fclose later, but some stdio's forget
892    to declare this.  We can't always declare it since there's
893    no way to declare the parameters without upsetting some compiler
894    somewhere. */
895
896 #ifndef FCLOSE_PROVIDED
897 extern int fclose PARAMS ((FILE *));
898 #endif
899
900 #ifndef atof
901 extern double atof PARAMS ((const char *));     /* X3.159-1989  4.10.1.1 */
902 #endif
903
904 #ifndef MALLOC_INCOMPATIBLE
905
906 #ifdef NEED_DECLARATION_MALLOC
907 extern PTR malloc ();
908 #endif
909
910 #ifdef NEED_DECLARATION_REALLOC
911 extern PTR realloc ();
912 #endif
913
914 #ifdef NEED_DECLARATION_FREE
915 extern void free ();
916 #endif
917
918 #endif /* MALLOC_INCOMPATIBLE */
919
920 /* Various possibilities for alloca.  */
921 #ifndef alloca
922 # ifdef __GNUC__
923 #  define alloca __builtin_alloca
924 # else /* Not GNU C */
925 #  ifdef HAVE_ALLOCA_H
926 #   include <alloca.h>
927 #  else
928 #   ifdef _AIX
929  #pragma alloca
930 #   else
931
932 /* We need to be careful not to declare this in a way which conflicts with
933    bison.  Bison never declares it as char *, but under various circumstances
934    (like __hpux) we need to use void *.  */
935 #    if defined (__STDC__) || defined (__hpux)
936    extern void *alloca ();
937 #    else /* Don't use void *.  */
938    extern char *alloca ();
939 #    endif /* Don't use void *.  */
940 #   endif /* Not _AIX */
941 #  endif /* Not HAVE_ALLOCA_H */
942 # endif /* Not GNU C */
943 #endif /* alloca not defined */
944
945 /* HOST_BYTE_ORDER must be defined to one of these.  */
946
947 #ifdef HAVE_ENDIAN_H
948 #include <endian.h>
949 #endif
950
951 #if !defined (BIG_ENDIAN)
952 #define BIG_ENDIAN 4321
953 #endif
954
955 #if !defined (LITTLE_ENDIAN)
956 #define LITTLE_ENDIAN 1234
957 #endif
958
959 /* Dynamic target-system-dependent parameters for GDB. */
960 #include "gdbarch.h"
961
962 /* Static target-system-dependent parameters for GDB. */
963
964 /* Number of bits in a char or unsigned char for the target machine.
965    Just like CHAR_BIT in <limits.h> but describes the target machine.  */
966 #if !defined (TARGET_CHAR_BIT)
967 #define TARGET_CHAR_BIT 8
968 #endif
969
970 /* Number of bits in a short or unsigned short for the target machine. */
971 #if !defined (TARGET_SHORT_BIT)
972 #define TARGET_SHORT_BIT (2 * TARGET_CHAR_BIT)
973 #endif
974
975 /* Number of bits in an int or unsigned int for the target machine. */
976 #if !defined (TARGET_INT_BIT)
977 #define TARGET_INT_BIT (4 * TARGET_CHAR_BIT)
978 #endif
979
980 /* Number of bits in a long or unsigned long for the target machine. */
981 #if !defined (TARGET_LONG_BIT)
982 #define TARGET_LONG_BIT (4 * TARGET_CHAR_BIT)
983 #endif
984
985 /* Number of bits in a long long or unsigned long long for the target machine. */
986 #if !defined (TARGET_LONG_LONG_BIT)
987 #define TARGET_LONG_LONG_BIT (2 * TARGET_LONG_BIT)
988 #endif
989
990 /* Number of bits in a float for the target machine. */
991 #if !defined (TARGET_FLOAT_BIT)
992 #define TARGET_FLOAT_BIT (4 * TARGET_CHAR_BIT)
993 #endif
994
995 /* Number of bits in a double for the target machine. */
996 #if !defined (TARGET_DOUBLE_BIT)
997 #define TARGET_DOUBLE_BIT (8 * TARGET_CHAR_BIT)
998 #endif
999
1000 /* Number of bits in a long double for the target machine.  */
1001 #if !defined (TARGET_LONG_DOUBLE_BIT)
1002 #define TARGET_LONG_DOUBLE_BIT (2 * TARGET_DOUBLE_BIT)
1003 #endif
1004
1005 /* Number of bits in a pointer for the target machine */
1006 #if !defined (TARGET_PTR_BIT)
1007 #define TARGET_PTR_BIT TARGET_INT_BIT
1008 #endif
1009
1010 /* If we picked up a copy of CHAR_BIT from a configuration file
1011    (which may get it by including <limits.h>) then use it to set
1012    the number of bits in a host char.  If not, use the same size
1013    as the target. */
1014
1015 #if defined (CHAR_BIT)
1016 #define HOST_CHAR_BIT CHAR_BIT
1017 #else
1018 #define HOST_CHAR_BIT TARGET_CHAR_BIT
1019 #endif
1020
1021 /* The bit byte-order has to do just with numbering of bits in
1022    debugging symbols and such.  Conceptually, it's quite separate
1023    from byte/word byte order.  */
1024
1025 #if !defined (BITS_BIG_ENDIAN)
1026 #define BITS_BIG_ENDIAN (TARGET_BYTE_ORDER == BIG_ENDIAN)
1027 #endif
1028
1029 /* In findvar.c.  */
1030
1031 extern LONGEST extract_signed_integer PARAMS ((void *, int));
1032
1033 extern ULONGEST extract_unsigned_integer PARAMS ((void *, int));
1034
1035 extern int extract_long_unsigned_integer PARAMS ((void *, int, LONGEST *));
1036
1037 extern CORE_ADDR extract_address PARAMS ((void *, int));
1038
1039 extern void store_signed_integer PARAMS ((PTR, int, LONGEST));
1040
1041 extern void store_unsigned_integer PARAMS ((PTR, int, ULONGEST));
1042
1043 extern void store_address PARAMS ((PTR, int, LONGEST));
1044
1045 /* Setup definitions for host and target floating point formats.  We need to
1046    consider the format for `float', `double', and `long double' for both target
1047    and host.  We need to do this so that we know what kind of conversions need
1048    to be done when converting target numbers to and from the hosts DOUBLEST
1049    data type.  */
1050
1051 /* This is used to indicate that we don't know the format of the floating point
1052    number.  Typically, this is useful for native ports, where the actual format
1053    is irrelevant, since no conversions will be taking place.  */
1054
1055 extern const struct floatformat floatformat_unknown;
1056
1057 #if HOST_BYTE_ORDER == BIG_ENDIAN
1058 #  ifndef HOST_FLOAT_FORMAT
1059 #    define HOST_FLOAT_FORMAT &floatformat_ieee_single_big
1060 #  endif
1061 #  ifndef HOST_DOUBLE_FORMAT
1062 #    define HOST_DOUBLE_FORMAT &floatformat_ieee_double_big
1063 #  endif
1064 #else                           /* LITTLE_ENDIAN */
1065 #  ifndef HOST_FLOAT_FORMAT
1066 #    define HOST_FLOAT_FORMAT &floatformat_ieee_single_little
1067 #  endif
1068 #  ifndef HOST_DOUBLE_FORMAT
1069 #    define HOST_DOUBLE_FORMAT &floatformat_ieee_double_little
1070 #  endif
1071 #endif
1072
1073 #ifndef HOST_LONG_DOUBLE_FORMAT
1074 #define HOST_LONG_DOUBLE_FORMAT &floatformat_unknown
1075 #endif
1076
1077 #ifndef TARGET_FLOAT_FORMAT
1078 #define TARGET_FLOAT_FORMAT (TARGET_BYTE_ORDER == BIG_ENDIAN \
1079                              ? &floatformat_ieee_single_big \
1080                              : &floatformat_ieee_single_little)
1081 #endif
1082 #ifndef TARGET_DOUBLE_FORMAT
1083 #define TARGET_DOUBLE_FORMAT (TARGET_BYTE_ORDER == BIG_ENDIAN \
1084                               ? &floatformat_ieee_double_big \
1085                               : &floatformat_ieee_double_little)
1086 #endif
1087
1088 #ifndef TARGET_LONG_DOUBLE_FORMAT
1089 #  define TARGET_LONG_DOUBLE_FORMAT &floatformat_unknown
1090 #endif
1091
1092 /* Use `long double' if the host compiler supports it.  (Note that this is not
1093    necessarily any longer than `double'.  On SunOS/gcc, it's the same as
1094    double.)  This is necessary because GDB internally converts all floating
1095    point values to the widest type supported by the host.
1096
1097    There are problems however, when the target `long double' is longer than the
1098    host's `long double'.  In general, we'll probably reduce the precision of
1099    any such values and print a warning.  */
1100
1101 #ifdef HAVE_LONG_DOUBLE
1102 typedef long double DOUBLEST;
1103 #else
1104 typedef double DOUBLEST;
1105 #endif
1106
1107 extern void floatformat_to_doublest PARAMS ((const struct floatformat *,
1108                                              char *, DOUBLEST *));
1109 extern void floatformat_from_doublest PARAMS ((const struct floatformat *,
1110                                                DOUBLEST *, char *));
1111 extern DOUBLEST extract_floating PARAMS ((void *, int));
1112
1113 extern void store_floating PARAMS ((void *, int, DOUBLEST));
1114 \f
1115 /* On some machines there are bits in addresses which are not really
1116    part of the address, but are used by the kernel, the hardware, etc.
1117    for special purposes.  ADDR_BITS_REMOVE takes out any such bits
1118    so we get a "real" address such as one would find in a symbol
1119    table.  This is used only for addresses of instructions, and even then
1120    I'm not sure it's used in all contexts.  It exists to deal with there
1121    being a few stray bits in the PC which would mislead us, not as some sort
1122    of generic thing to handle alignment or segmentation (it's possible it
1123    should be in TARGET_READ_PC instead). */
1124 #if !defined (ADDR_BITS_REMOVE)
1125 #define ADDR_BITS_REMOVE(addr) (addr)
1126 #endif /* No ADDR_BITS_REMOVE.  */
1127
1128 /* From valops.c */
1129
1130 extern CORE_ADDR push_bytes PARAMS ((CORE_ADDR, char *, int));
1131
1132 extern CORE_ADDR push_word PARAMS ((CORE_ADDR, ULONGEST));
1133
1134 extern int watchdog;
1135
1136 /* Hooks for alternate command interfaces.  */
1137 struct target_waitstatus;
1138 struct cmd_list_element;
1139
1140 /* Should the asynchronous variant of the interpreter (using the
1141    event-loop) be enabled? */
1142 extern int event_loop_p;
1143                                                                    
1144 extern void (*init_ui_hook) PARAMS ((char *argv0));
1145 extern void (*command_loop_hook) PARAMS ((void));
1146 extern void (*fputs_unfiltered_hook) PARAMS ((const char *linebuffer,
1147                                               GDB_FILE *stream));
1148 extern void (*print_frame_info_listing_hook) PARAMS ((struct symtab *s,
1149                                                       int line, int stopline,
1150                                                       int noerror));
1151 extern struct frame_info *parse_frame_specification PARAMS ((char *frame_exp));
1152 extern int  (*query_hook) PARAMS ((const char *, va_list));
1153 extern void (*warning_hook) PARAMS ((const char *, va_list));
1154 extern void (*flush_hook) PARAMS ((GDB_FILE *stream));
1155 extern void (*create_breakpoint_hook) PARAMS ((struct breakpoint *b));
1156 extern void (*delete_breakpoint_hook) PARAMS ((struct breakpoint *bpt));
1157 extern void (*modify_breakpoint_hook) PARAMS ((struct breakpoint *bpt));
1158 extern void (*interactive_hook) PARAMS ((void));
1159 extern void (*registers_changed_hook) PARAMS ((void));
1160 extern void (*readline_begin_hook) PARAMS ((char *, ...));
1161 extern char * (*readline_hook) PARAMS ((char *));
1162 extern void (*readline_end_hook) PARAMS ((void));
1163 extern void (*register_changed_hook) PARAMS ((int regno));
1164 extern void (*memory_changed_hook) PARAMS ((CORE_ADDR addr, int len));
1165 extern void (*context_hook) PARAMS ((int));
1166 extern int (*target_wait_hook) PARAMS ((int pid,
1167                                         struct target_waitstatus *status));
1168
1169 extern void (*attach_hook) PARAMS ((void));
1170 extern void (*detach_hook) PARAMS ((void));
1171 extern void (*call_command_hook) PARAMS ((struct cmd_list_element *c,
1172                                           char *cmd, int from_tty));
1173
1174 extern void (*set_hook) PARAMS ((struct cmd_list_element *c));
1175
1176 extern NORETURN void (*error_hook) PARAMS ((void)) ATTR_NORETURN;
1177
1178 extern void (*error_begin_hook) PARAMS ((void));
1179
1180
1181 /* Inhibit window interface if non-zero. */
1182
1183 extern int use_windows;
1184
1185 /* Symbolic definitions of filename-related things.  */
1186 /* FIXME, this doesn't work very well if host and executable
1187    filesystems conventions are different.  */
1188
1189 #ifndef DIRNAME_SEPARATOR
1190 #define DIRNAME_SEPARATOR ':'
1191 #endif
1192
1193 #ifndef SLASH_P
1194 #if defined(__GO32__)||defined(_WIN32)
1195 #define SLASH_P(X) ((X)=='\\')
1196 #else
1197 #define SLASH_P(X) ((X)=='/')
1198 #endif
1199 #endif
1200
1201 #ifndef SLASH_CHAR
1202 #if defined(__GO32__)||defined(_WIN32)
1203 #define SLASH_CHAR '\\'
1204 #else
1205 #define SLASH_CHAR '/'
1206 #endif
1207 #endif
1208
1209 #ifndef SLASH_STRING
1210 #if defined(__GO32__)||defined(_WIN32)
1211 #define SLASH_STRING "\\"
1212 #else
1213 #define SLASH_STRING "/"
1214 #endif
1215 #endif
1216
1217 #ifndef ROOTED_P
1218 #define ROOTED_P(X) (SLASH_P((X)[0]))
1219 #endif
1220
1221 /* On some systems, PIDGET is defined to extract the inferior pid from
1222    an internal pid that has the thread id and pid in seperate bit
1223    fields.  If not defined, then just use the entire internal pid as
1224    the actual pid. */
1225
1226 #ifndef PIDGET
1227 #define PIDGET(pid) (pid)
1228 #endif
1229
1230 /* If under Cygwin, provide backwards compatibility with older
1231    Cygwin compilers that don't define the current cpp define. */
1232 #ifdef __CYGWIN32__
1233 #ifndef __CYGWIN__
1234 #define __CYGWIN__
1235 #endif
1236 #endif
1237
1238 /* Define well known filenos if the system does not define them.  */
1239 #ifndef STDIN_FILENO
1240 #define STDIN_FILENO   0
1241 #endif
1242 #ifndef STDOUT_FILENO
1243 #define STDOUT_FILENO  1
1244 #endif
1245 #ifndef STDERR_FILENO
1246 #define STDERR_FILENO  2
1247 #endif
1248
1249 /* If this definition isn't overridden by the header files, assume
1250    that isatty and fileno exist on this system.  */
1251 #ifndef ISATTY
1252 #define ISATTY(FP)      (isatty (fileno (FP)))
1253 #endif
1254
1255 #endif /* #ifndef DEFS_H */