Release 0.5
[wine/multimedia.git] / debugger / defs.h
blobe789dd3be12370a3a9466e563da8aadd5f24ff75
1 /* Basic, host-specific, and target-specific definitions for GDB.
2 Copyright (C) 1986, 1989, 1991 Free Software Foundation, Inc.
4 This file is part of GDB.
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program; if not, write to the Free Software
18 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */
20 #if !defined (DEFS_H)
21 #define DEFS_H 1
23 #include <stdio.h>
25 /* First include ansidecl.h so we can use the various macro definitions
26 here and in all subsequent file inclusions. */
28 #include "ansidecl.h"
30 /* An address in the program being debugged. Host byte order. */
31 typedef unsigned int CORE_ADDR;
33 #define min(a, b) ((a) < (b) ? (a) : (b))
34 #define max(a, b) ((a) > (b) ? (a) : (b))
36 /* The character C++ uses to build identifiers that must be unique from
37 the program's identifiers (such as $this and $$vptr). */
38 #define CPLUS_MARKER '$' /* May be overridden to '.' for SysV */
40 #include <errno.h> /* System call error return status */
42 extern int quit_flag;
43 extern int immediate_quit;
45 extern void
46 quit PARAMS ((void));
48 #define QUIT { if (quit_flag) quit (); }
50 /* Command classes are top-level categories into which commands are broken
51 down for "help" purposes.
52 Notes on classes: class_alias is for alias commands which are not
53 abbreviations of the original command. class-pseudo is for commands
54 which are not really commands nor help topics ("stop"). */
56 enum command_class
58 /* Special args to help_list */
59 all_classes = -2, all_commands = -1,
60 /* Classes of commands */
61 no_class = -1, class_run = 0, class_vars, class_stack,
62 class_files, class_support, class_info, class_breakpoint,
63 class_alias, class_obscure, class_user, class_maintenance,
64 class_pseudo
67 /* the cleanup list records things that have to be undone
68 if an error happens (descriptors to be closed, memory to be freed, etc.)
69 Each link in the chain records a function to call and an
70 argument to give it.
72 Use make_cleanup to add an element to the cleanup chain.
73 Use do_cleanups to do all cleanup actions back to a given
74 point in the chain. Use discard_cleanups to remove cleanups
75 from the chain back to a given point, not doing them. */
77 struct cleanup
79 struct cleanup *next;
80 void (*function) PARAMS ((PTR));
81 PTR arg;
84 /* From blockframe.c */
86 extern int
87 inside_entry_func PARAMS ((CORE_ADDR));
89 extern int
90 inside_entry_file PARAMS ((CORE_ADDR addr));
92 extern int
93 inside_main_func PARAMS ((CORE_ADDR pc));
95 /* From cplus-dem.c */
97 extern char *
98 cplus_demangle PARAMS ((const char *, int));
100 extern char *
101 cplus_mangle_opname PARAMS ((char *, int));
103 /* From libmmalloc.a (memory mapped malloc library) */
105 extern PTR
106 mmalloc_attach PARAMS ((int, PTR));
108 extern PTR
109 mmalloc_detach PARAMS ((PTR));
111 extern PTR
112 mmalloc PARAMS ((PTR, long));
114 extern PTR
115 mrealloc PARAMS ((PTR, PTR, long));
117 extern void
118 mfree PARAMS ((PTR, PTR));
120 extern int
121 mmalloc_setkey PARAMS ((PTR, int, PTR));
123 extern PTR
124 mmalloc_getkey PARAMS ((PTR, int));
126 /* From utils.c */
128 extern char *
129 demangle_and_match PARAMS ((const char *, const char *, int));
131 extern int
132 strcmp_iw PARAMS ((const char *, const char *));
134 extern char *
135 safe_strerror PARAMS ((int));
137 extern char *
138 safe_strsignal PARAMS ((int));
140 extern void
141 init_malloc PARAMS ((PTR));
143 extern void
144 request_quit PARAMS ((int));
146 extern void
147 do_cleanups PARAMS ((struct cleanup *));
149 extern void
150 discard_cleanups PARAMS ((struct cleanup *));
152 /* The bare make_cleanup function is one of those rare beasts that
153 takes almost any type of function as the first arg and anything that
154 will fit in a "void *" as the second arg.
156 Should be, once all calls and called-functions are cleaned up:
157 extern struct cleanup *
158 make_cleanup PARAMS ((void (*function) (PTR), PTR));
160 Until then, lint and/or various type-checking compiler options will
161 complain about make_cleanup calls. It'd be wrong to just cast things,
162 since the type actually passed when the function is called would be
163 wrong. */
165 extern struct cleanup *
166 make_cleanup ();
168 extern struct cleanup *
169 save_cleanups PARAMS ((void));
171 extern void
172 restore_cleanups PARAMS ((struct cleanup *));
174 extern void
175 free_current_contents PARAMS ((char **));
177 extern void
178 null_cleanup PARAMS ((char **));
180 extern int
181 myread PARAMS ((int, char *, int));
183 extern int
184 query ();
186 extern void
187 wrap_here PARAMS ((char *));
189 extern void
190 reinitialize_more_filter PARAMS ((void));
192 extern int
193 print_insn PARAMS ((CORE_ADDR, CORE_ADDR, FILE *, int));
195 extern void
196 fputs_filtered PARAMS ((const char *, FILE *));
198 extern void
199 puts_filtered PARAMS ((char *));
201 extern void
202 vfprintf_filtered ();
204 extern void
205 fprintf_filtered ();
207 extern void
208 fprintfi_filtered ();
210 extern void
211 printf_filtered ();
213 extern void
214 printfi_filtered ();
216 extern void
217 print_spaces PARAMS ((int, FILE *));
219 extern void
220 print_spaces_filtered PARAMS ((int, FILE *));
222 extern char *
223 n_spaces PARAMS ((int));
225 extern void
226 printchar PARAMS ((int, FILE *, int));
228 extern char *
229 strdup_demangled PARAMS ((const char *));
231 extern void
232 fprint_symbol PARAMS ((FILE *, char *));
234 extern void
235 fputs_demangled PARAMS ((char *, FILE *, int));
237 extern void
238 perror_with_name PARAMS ((char *));
240 extern void
241 print_sys_errmsg PARAMS ((char *, int));
243 /* From regex.c */
245 extern char *
246 re_comp PARAMS ((char *));
248 /* From symfile.c */
250 extern void
251 symbol_file_command PARAMS ((char *, int));
253 /* From main.c */
255 extern char *
256 skip_quoted PARAMS ((char *));
258 extern char *
259 gdb_readline PARAMS ((char *));
261 extern char *
262 command_line_input PARAMS ((char *, int));
264 extern void
265 print_prompt PARAMS ((void));
267 extern int
268 batch_mode PARAMS ((void));
270 extern int
271 input_from_terminal_p PARAMS ((void));
273 extern int
274 catch_errors PARAMS ((int (*) (char *), char *, char *));
276 /* From printcmd.c */
278 extern void
279 set_next_address PARAMS ((CORE_ADDR));
281 extern void
282 print_address_symbolic PARAMS ((CORE_ADDR, FILE *, int, char *));
284 extern void
285 print_address PARAMS ((CORE_ADDR, FILE *));
287 /* From source.c */
289 extern int
290 openp PARAMS ((char *, int, char *, int, int, char **));
292 extern void
293 mod_path PARAMS ((char *, char **));
295 extern void
296 directory_command PARAMS ((char *, int));
298 extern void
299 init_source_path PARAMS ((void));
301 /* From findvar.c */
303 extern int
304 read_relative_register_raw_bytes PARAMS ((int, char *));
306 /* From readline (but not in any readline .h files). */
308 extern char *
309 tilde_expand PARAMS ((char *));
311 /* Structure for saved commands lines
312 (for breakpoints, defined commands, etc). */
314 struct command_line
316 struct command_line *next;
317 char *line;
320 extern struct command_line *
321 read_command_lines PARAMS ((void));
323 extern void
324 free_command_lines PARAMS ((struct command_line **));
326 /* String containing the current directory (what getwd would return). */
328 extern char *current_directory;
330 /* Default radixes for input and output. Only some values supported. */
331 extern unsigned input_radix;
332 extern unsigned output_radix;
334 /* Baud rate specified for communication with serial target systems. */
335 extern char *baud_rate;
337 /* Languages represented in the symbol table and elsewhere. */
339 enum language
341 language_unknown, /* Language not known */
342 language_auto, /* Placeholder for automatic setting */
343 language_c, /* C */
344 language_cplus, /* C++ */
345 language_m2 /* Modula-2 */
348 /* Return a format string for printf that will print a number in the local
349 (language-specific) hexadecimal format. Result is static and is
350 overwritten by the next call. local_hex_format_custom takes printf
351 options like "08" or "l" (to produce e.g. %08x or %lx). */
353 #define local_hex_format() (current_language->la_hex_format)
355 extern char *
356 local_hex_format_custom PARAMS ((char *)); /* language.c */
358 /* Return a string that contains a number formatted in the local
359 (language-specific) hexadecimal format. Result is static and is
360 overwritten by the next call. local_hex_string_custom takes printf
361 options like "08" or "l". */
363 extern char *
364 local_hex_string PARAMS ((int)); /* language.c */
366 extern char *
367 local_hex_string_custom PARAMS ((int, char *)); /* language.c */
370 /* Host machine definition. This will be a symlink to one of the
371 xm-*.h files, built by the `configure' script. */
373 #include "xm.h"
375 /* If the xm.h file did not define the mode string used to open the
376 files, assume that binary files are opened the same way as text
377 files */
378 #ifndef FOPEN_RB
379 #include "fopen-same.h"
380 #endif
383 * Allow things in gdb to be declared "const". If compiling ANSI, it
384 * just works. If compiling with gcc but non-ansi, redefine to __const__.
385 * If non-ansi, non-gcc, then eliminate "const" entirely, making those
386 * objects be read-write rather than read-only.
389 #ifndef const
390 #ifndef __STDC__
391 # ifdef __GNUC__
392 # define const __const__
393 # else
394 # define const /*nothing*/
395 # endif /* GNUC */
396 #endif /* STDC */
397 #endif /* const */
399 #ifndef volatile
400 #ifndef __STDC__
401 # ifdef __GNUC__
402 # define volatile __volatile__
403 # else
404 # define volatile /*nothing*/
405 # endif /* GNUC */
406 #endif /* STDC */
407 #endif /* volatile */
409 /* Some compilers (many AT&T SVR4 compilers for instance), do not accept
410 declarations of functions that never return (exit for instance) as
411 "volatile void". For such compilers "NORETURN" can be defined away
412 to keep them happy */
414 #ifndef NORETURN
415 # ifdef __lucid
416 # define NORETURN /*nothing*/
417 # else
418 # define NORETURN volatile
419 # endif
420 #endif
422 /* Defaults for system-wide constants (if not defined by xm.h, we fake it). */
424 #if !defined (UINT_MAX)
425 #define UINT_MAX 0xffffffff
426 #endif
428 #if !defined (LONG_MAX)
429 #define LONG_MAX 0x7fffffff
430 #endif
432 #if !defined (INT_MAX)
433 #define INT_MAX 0x7fffffff
434 #endif
436 #if !defined (INT_MIN)
437 /* Two's complement, 32 bit. */
438 #define INT_MIN -0x80000000
439 #endif
441 /* Number of bits in a char or unsigned char for the target machine.
442 Just like CHAR_BIT in <limits.h> but describes the target machine. */
443 #if !defined (TARGET_CHAR_BIT)
444 #define TARGET_CHAR_BIT 8
445 #endif
447 /* Number of bits in a short or unsigned short for the target machine. */
448 #if !defined (TARGET_SHORT_BIT)
449 #define TARGET_SHORT_BIT (sizeof (short) * TARGET_CHAR_BIT)
450 #endif
452 /* Number of bits in an int or unsigned int for the target machine. */
453 #if !defined (TARGET_INT_BIT)
454 #define TARGET_INT_BIT (sizeof (int) * TARGET_CHAR_BIT)
455 #endif
457 /* Number of bits in a long or unsigned long for the target machine. */
458 #if !defined (TARGET_LONG_BIT)
459 #define TARGET_LONG_BIT (sizeof (long) * TARGET_CHAR_BIT)
460 #endif
462 /* Number of bits in a long long or unsigned long long for the target machine. */
463 #if !defined (TARGET_LONG_LONG_BIT)
464 #define TARGET_LONG_LONG_BIT (2 * TARGET_LONG_BIT)
465 #endif
467 /* Number of bits in a float for the target machine. */
468 #if !defined (TARGET_FLOAT_BIT)
469 #define TARGET_FLOAT_BIT (sizeof (float) * TARGET_CHAR_BIT)
470 #endif
472 /* Number of bits in a double for the target machine. */
473 #if !defined (TARGET_DOUBLE_BIT)
474 #define TARGET_DOUBLE_BIT (sizeof (double) * TARGET_CHAR_BIT)
475 #endif
477 /* Number of bits in a long double for the target machine. */
478 #if !defined (TARGET_LONG_DOUBLE_BIT)
479 #define TARGET_LONG_DOUBLE_BIT (2 * TARGET_DOUBLE_BIT)
480 #endif
482 /* Number of bits in a "complex" for the target machine. */
483 #if !defined (TARGET_COMPLEX_BIT)
484 #define TARGET_COMPLEX_BIT (2 * TARGET_FLOAT_BIT)
485 #endif
487 /* Number of bits in a "double complex" for the target machine. */
488 #if !defined (TARGET_DOUBLE_COMPLEX_BIT)
489 #define TARGET_DOUBLE_COMPLEX_BIT (2 * TARGET_DOUBLE_BIT)
490 #endif
492 /* Number of bits in a pointer for the target machine */
493 #if !defined (TARGET_PTR_BIT)
494 #define TARGET_PTR_BIT TARGET_INT_BIT
495 #endif
497 /* Convert a LONGEST to an int. This is used in contexts (e.g. number
498 of arguments to a function, number in a value history, register
499 number, etc.) where the value must not be larger than can fit
500 in an int. */
501 #if !defined (longest_to_int)
502 #if defined (LONG_LONG)
503 #define longest_to_int(x) (((x) > INT_MAX || (x) < INT_MIN) \
504 ? (error ("Value out of range."),0) : (int) (x))
505 #else /* No LONG_LONG. */
506 /* Assume sizeof (int) == sizeof (long). */
507 #define longest_to_int(x) ((int) (x))
508 #endif /* No LONG_LONG. */
509 #endif /* No longest_to_int. */
511 /* This should not be a typedef, because "unsigned LONGEST" needs
512 to work. LONG_LONG is defined if the host has "long long". */
514 #ifndef LONGEST
515 # ifdef LONG_LONG
516 # define LONGEST long long
517 # else
518 # define LONGEST long
519 # endif
520 #endif
522 /* Assorted functions we can declare, now that const and volatile are
523 defined. */
525 extern char *
526 savestring PARAMS ((const char *, int));
528 extern char *
529 msavestring PARAMS ((void *, const char *, int));
531 extern char *
532 strsave PARAMS ((const char *));
534 extern char *
535 mstrsave PARAMS ((void *, const char *));
537 extern char *
538 concat PARAMS ((char *, ...));
540 extern PTR
541 xmalloc PARAMS ((long));
543 extern PTR
544 xrealloc PARAMS ((PTR, long));
546 extern PTR
547 xmmalloc PARAMS ((PTR, long));
549 extern PTR
550 xmrealloc PARAMS ((PTR, PTR, long));
552 extern PTR
553 mmalloc PARAMS ((PTR, long));
555 extern PTR
556 mrealloc PARAMS ((PTR, PTR, long));
558 extern void
559 mfree PARAMS ((PTR, PTR));
561 extern int
562 mmcheck PARAMS ((PTR, void (*) (void)));
564 extern int
565 mmtrace PARAMS ((void));
567 extern int
568 parse_escape PARAMS ((char **));
570 extern const char * const reg_names[];
572 extern NORETURN void /* Does not return to the caller. */
573 error ();
575 extern NORETURN void /* Does not return to the caller. */
576 fatal ();
578 extern NORETURN void /* Not specified as volatile in ... */
579 exit PARAMS ((int)); /* 4.10.4.3 */
581 extern NORETURN void /* Does not return to the caller. */
582 nomem PARAMS ((long));
584 extern NORETURN void /* Does not return to the caller. */
585 return_to_top_level PARAMS ((void));
587 extern void
588 warning_setup PARAMS ((void));
590 extern void
591 warning ();
593 /* Global functions from other, non-gdb GNU thingies (libiberty for
594 instance) */
596 extern char *
597 basename PARAMS ((char *));
599 extern char *
600 getenv PARAMS ((const char *));
602 extern char **
603 buildargv PARAMS ((char *));
605 extern void
606 freeargv PARAMS ((char **));
608 extern char *
609 strerrno PARAMS ((int));
611 extern char *
612 strsigno PARAMS ((int));
614 extern int
615 errno_max PARAMS ((void));
617 extern int
618 signo_max PARAMS ((void));
620 extern int
621 strtoerrno PARAMS ((char *));
623 extern int
624 strtosigno PARAMS ((char *));
626 extern char *
627 strsignal PARAMS ((int));
629 /* From other system libraries */
631 #ifndef PSIGNAL_IN_SIGNAL_H
632 extern void
633 psignal PARAMS ((unsigned, char *));
634 #endif
636 /* For now, we can't include <stdlib.h> because it conflicts with
637 "../include/getopt.h". (FIXME)
639 However, if a function is defined in the ANSI C standard and a prototype
640 for that function is defined and visible in any header file in an ANSI
641 conforming environment, then that prototype must match the definition in
642 the ANSI standard. So we can just duplicate them here without conflict,
643 since they must be the same in all conforming ANSI environments. If
644 these cause problems, then the environment is not ANSI conformant. */
646 #ifdef __STDC__
647 #include <stddef.h>
648 #endif
650 extern int
651 fclose PARAMS ((FILE *stream)); /* 4.9.5.1 */
653 extern void
654 perror PARAMS ((const char *)); /* 4.9.10.4 */
656 extern double
657 atof PARAMS ((const char *nptr)); /* 4.10.1.1 */
659 extern int
660 atoi PARAMS ((const char *)); /* 4.10.1.2 */
662 #ifndef MALLOC_INCOMPATIBLE
664 extern PTR
665 malloc PARAMS ((size_t size)); /* 4.10.3.3 */
667 extern PTR
668 realloc PARAMS ((void *ptr, size_t size)); /* 4.10.3.4 */
670 extern void
671 free PARAMS ((void *)); /* 4.10.3.2 */
673 #endif /* MALLOC_INCOMPATIBLE */
675 extern void
676 qsort PARAMS ((void *base, size_t nmemb, /* 4.10.5.2 */
677 size_t size,
678 int (*comp)(const void *, const void *)));
680 #ifndef MEM_FNS_DECLARED /* Some non-ANSI use void *, not char *. */
681 extern PTR
682 memcpy PARAMS ((void *, const void *, size_t)); /* 4.11.2.1 */
683 #endif
685 extern int
686 memcmp PARAMS ((const void *, const void *, size_t)); /* 4.11.4.1 */
688 extern char *
689 strchr PARAMS ((const char *, int)); /* 4.11.5.2 */
691 extern char *
692 strrchr PARAMS ((const char *, int)); /* 4.11.5.5 */
694 extern char *
695 strstr PARAMS ((const char *, const char *)); /* 4.11.5.7 */
697 extern char *
698 strtok PARAMS ((char *, const char *)); /* 4.11.5.8 */
700 #ifndef MEM_FNS_DECLARED /* Some non-ANSI use void *, not char *. */
701 extern PTR
702 memset PARAMS ((void *, int, size_t)); /* 4.11.6.1 */
703 #endif
705 extern char *
706 strerror PARAMS ((int)); /* 4.11.6.2 */
708 /* Various possibilities for alloca. */
709 #ifndef alloca
710 # ifdef __GNUC__
711 # define alloca __builtin_alloca
712 # else
713 # ifdef sparc
714 # include <alloca.h> /* NOTE: Doesn't declare alloca() */
715 # endif
716 # ifdef __STDC__
717 extern void *alloca (size_t);
718 # else /* __STDC__ */
719 extern char *alloca ();
720 # endif
721 # endif
722 #endif
724 /* TARGET_BYTE_ORDER and HOST_BYTE_ORDER must be defined to one of these. */
726 #if !defined (BIG_ENDIAN)
727 #define BIG_ENDIAN 4321
728 #endif
730 #if !defined (LITTLE_ENDIAN)
731 #define LITTLE_ENDIAN 1234
732 #endif
734 /* Target-system-dependent parameters for GDB.
736 The standard thing is to include defs.h. However, files that are
737 specific to a particular target can define TM_FILE_OVERRIDE before
738 including defs.h, then can include any particular tm-file they desire. */
740 /* Target machine definition. This will be a symlink to one of the
741 tm-*.h files, built by the `configure' script. */
743 #ifndef TM_FILE_OVERRIDE
744 #include "tm.h"
745 #endif
747 /* The bit byte-order has to do just with numbering of bits in
748 debugging symbols and such. Conceptually, it's quite separate
749 from byte/word byte order. */
751 #if !defined (BITS_BIG_ENDIAN)
752 #if TARGET_BYTE_ORDER == BIG_ENDIAN
753 #define BITS_BIG_ENDIAN 1
754 #endif /* Big endian. */
756 #if TARGET_BYTE_ORDER == LITTLE_ENDIAN
757 #define BITS_BIG_ENDIAN 0
758 #endif /* Little endian. */
759 #endif /* BITS_BIG_ENDIAN not defined. */
761 /* Swap LEN bytes at BUFFER between target and host byte-order. */
762 #if TARGET_BYTE_ORDER == HOST_BYTE_ORDER
763 #define SWAP_TARGET_AND_HOST(buffer,len)
764 #else /* Target and host byte order differ. */
765 #define SWAP_TARGET_AND_HOST(buffer,len) \
767 char tmp; \
768 char *p = (char *)(buffer); \
769 char *q = ((char *)(buffer)) + len - 1; \
770 for (; p < q; p++, q--) \
772 tmp = *q; \
773 *q = *p; \
774 *p = tmp; \
777 #endif /* Target and host byte order differ. */
779 /* On some machines there are bits in addresses which are not really
780 part of the address, but are used by the kernel, the hardware, etc.
781 for special purposes. ADDR_BITS_REMOVE takes out any such bits
782 so we get a "real" address such as one would find in a symbol
783 table. ADDR_BITS_SET sets those bits the way the system wants
784 them. */
785 #if !defined (ADDR_BITS_REMOVE)
786 #define ADDR_BITS_REMOVE(addr) (addr)
787 #define ADDR_BITS_SET(addr) (addr)
788 #endif /* No ADDR_BITS_REMOVE. */
790 /* From valops.c */
792 extern CORE_ADDR
793 push_bytes PARAMS ((CORE_ADDR, char *, int));
795 /* In some modules, we don't have a definition of REGISTER_TYPE yet, so we
796 must avoid prototyping this function for now. FIXME. Should be:
797 extern CORE_ADDR
798 push_word PARAMS ((CORE_ADDR, REGISTER_TYPE));
800 extern CORE_ADDR
801 push_word ();
803 /* Some parts of gdb might be considered optional, in the sense that they
804 are not essential for being able to build a working, usable debugger
805 for a specific environment. For example, the maintenance commands
806 are there for the benefit of gdb maintainers. As another example,
807 some environments really don't need gdb's that are able to read N
808 different object file formats. In order to make it possible (but
809 not necessarily recommended) to build "stripped down" versions of
810 gdb, the following defines control selective compilation of those
811 parts of gdb which can be safely left out when necessary. Note that
812 the default is to include everything. */
814 #ifndef MAINTENANCE_CMDS
815 #define MAINTENANCE_CMDS 1
816 #endif
818 #endif /* !defined (DEFS_H) */