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