* c-exp.y (yylex): Recognize single-quoted strings that specify
[binutils-gdb.git] / gdb / defs.h
1 /* Basic, host-specific, and target-specific definitions for GDB.
2 Copyright (C) 1986, 1989, 1991 Free Software Foundation, Inc.
3
4 This file is part of GDB.
5
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.
10
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.
15
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. */
19
20 #if !defined (DEFS_H)
21 #define DEFS_H 1
22
23 #include <stdio.h>
24
25 /* First include ansidecl.h so we can use the various macro definitions
26 in all subsequent file inclusions. FIXME: This inclusion can now
27 be removed from all files that include defs.h */
28
29 #include "ansidecl.h"
30
31 /* We could use the EXFUN macro in ansidecl.h to handle prototypes, but
32 the name is misleading the the result is ugly. So just define a simple
33 macro to handle the parameter lists. */
34
35 #ifdef __STDC__
36 #define PARAMS(paramlist) paramlist
37 #else
38 #define PARAMS(paramlist) ()
39 #endif
40
41 /* An address in the program being debugged. Host byte order. */
42 typedef unsigned int CORE_ADDR;
43
44 #define min(a, b) ((a) < (b) ? (a) : (b))
45 #define max(a, b) ((a) > (b) ? (a) : (b))
46
47 /* The character C++ uses to build identifiers that must be unique from
48 the program's identifiers (such as $this and $$vptr). */
49 #define CPLUS_MARKER '$' /* May be overridden to '.' for SysV */
50
51 #include <errno.h> /* System call error return status */
52
53 extern int quit_flag;
54 extern int immediate_quit;
55
56 extern void
57 quit PARAMS ((void));
58
59 #define QUIT { if (quit_flag) quit (); }
60
61 /* Notes on classes: class_alias is for alias commands which are not
62 abbreviations of the original command. */
63
64 enum command_class
65 {
66 /* Special args to help_list */
67 all_classes = -2, all_commands = -1,
68 /* Classes of commands */
69 no_class = -1, class_run = 0, class_vars, class_stack,
70 class_files, class_support, class_info, class_breakpoint,
71 class_alias, class_obscure, class_user
72 };
73
74 /* the cleanup list records things that have to be undone
75 if an error happens (descriptors to be closed, memory to be freed, etc.)
76 Each link in the chain records a function to call and an
77 argument to give it.
78
79 Use make_cleanup to add an element to the cleanup chain.
80 Use do_cleanups to do all cleanup actions back to a given
81 point in the chain. Use discard_cleanups to remove cleanups
82 from the chain back to a given point, not doing them. */
83
84 struct cleanup
85 {
86 struct cleanup *next;
87 void (*function) PARAMS ((PTR));
88 PTR arg;
89 };
90
91 /* From blockframe.c */
92
93 extern int
94 inside_entry_func PARAMS ((CORE_ADDR));
95
96 extern int
97 inside_entry_file PARAMS ((CORE_ADDR addr));
98
99 extern int
100 inside_main_func PARAMS ((CORE_ADDR pc));
101
102 /* From cplus-dem.c */
103
104 extern char *
105 cplus_demangle PARAMS ((const char *, int));
106
107 extern char *
108 cplus_mangle_opname PARAMS ((char *, int));
109
110 /* From libmmalloc.a (memory mapped malloc library) */
111
112 extern PTR
113 mmalloc_attach PARAMS ((int, PTR));
114
115 extern PTR
116 mmalloc_detach PARAMS ((PTR));
117
118 extern PTR
119 mmalloc PARAMS ((PTR, long));
120
121 extern PTR
122 mrealloc PARAMS ((PTR, PTR, long));
123
124 extern void
125 mfree PARAMS ((PTR, PTR));
126
127 extern int
128 mmalloc_setkey PARAMS ((PTR, int, PTR));
129
130 extern PTR
131 mmalloc_getkey PARAMS ((PTR, int));
132
133 /* From utils.c */
134
135 extern char *
136 demangle_and_match PARAMS ((const char *, const char *, int));
137
138 extern int
139 strcmp_iw PARAMS ((const char *, const char *));
140
141 extern char *
142 safe_strerror PARAMS ((int));
143
144 extern char *
145 safe_strsignal PARAMS ((int));
146
147 extern void
148 init_malloc PARAMS ((PTR));
149
150 extern void
151 request_quit PARAMS ((int));
152
153 extern void
154 do_cleanups PARAMS ((struct cleanup *));
155
156 extern void
157 discard_cleanups PARAMS ((struct cleanup *));
158
159 /* The bare make_cleanup function is one of those rare beasts that
160 takes almost any type of function as the first arg and anything that
161 will fit in a "void *" as the second arg.
162
163 Should be, once all calls and called-functions are cleaned up:
164 extern struct cleanup *
165 make_cleanup PARAMS ((void (*function) (PTR), PTR));
166
167 Until then, lint and/or various type-checking compiler options will
168 complain about make_cleanup calls. It'd be wrong to just cast things,
169 since the type actually passed when the function is called would be
170 wrong. */
171
172 extern struct cleanup *
173 make_cleanup ();
174
175 extern struct cleanup *
176 save_cleanups PARAMS ((void));
177
178 extern void
179 restore_cleanups PARAMS ((struct cleanup *));
180
181 extern void
182 free_current_contents PARAMS ((char **));
183
184 extern void
185 null_cleanup PARAMS ((char **));
186
187 extern int
188 myread PARAMS ((int, char *, int));
189
190 extern int
191 query ();
192
193 extern void
194 wrap_here PARAMS ((char *));
195
196 extern void
197 reinitialize_more_filter PARAMS ((void));
198
199 extern int
200 print_insn PARAMS ((CORE_ADDR, FILE *));
201
202 extern void
203 fputs_filtered PARAMS ((const char *, FILE *));
204
205 extern void
206 puts_filtered PARAMS ((char *));
207
208 extern void
209 fprintf_filtered ();
210
211 extern void
212 printf_filtered ();
213
214 extern void
215 print_spaces PARAMS ((int, FILE *));
216
217 extern void
218 print_spaces_filtered PARAMS ((int, FILE *));
219
220 extern char *
221 n_spaces PARAMS ((int));
222
223 extern void
224 printchar PARAMS ((int, FILE *, int));
225
226 extern void
227 fprint_symbol PARAMS ((FILE *, char *));
228
229 extern void
230 fputs_demangled PARAMS ((char *, FILE *, int));
231
232 extern void
233 perror_with_name PARAMS ((char *));
234
235 extern void
236 print_sys_errmsg PARAMS ((char *, int));
237
238 /* From regex.c */
239
240 extern char *
241 re_comp PARAMS ((char *));
242
243 /* From symfile.c */
244
245 extern void
246 symbol_file_command PARAMS ((char *, int));
247
248 /* From main.c */
249
250 extern char *
251 skip_quoted PARAMS ((char *));
252
253 extern char *
254 gdb_readline PARAMS ((char *));
255
256 extern char *
257 command_line_input PARAMS ((char *, int));
258
259 extern void
260 print_prompt PARAMS ((void));
261
262 extern int
263 batch_mode PARAMS ((void));
264
265 extern int
266 input_from_terminal_p PARAMS ((void));
267
268 extern int
269 catch_errors PARAMS ((int (*) (char *), char *, char *));
270
271 /* From printcmd.c */
272
273 extern void
274 set_next_address PARAMS ((CORE_ADDR));
275
276 extern void
277 print_address_symbolic PARAMS ((CORE_ADDR, FILE *, int, char *));
278
279 extern void
280 print_address PARAMS ((CORE_ADDR, FILE *));
281
282 /* From source.c */
283
284 extern int
285 openp PARAMS ((char *, int, char *, int, int, char **));
286
287 extern void
288 mod_path PARAMS ((char *, char **));
289
290 extern void
291 directory_command PARAMS ((char *, int));
292
293 extern void
294 init_source_path PARAMS ((void));
295
296 /* From findvar.c */
297
298 extern int
299 read_relative_register_raw_bytes PARAMS ((int, char *));
300
301 /* From readline (but not in any readline .h files). */
302
303 extern char *
304 tilde_expand PARAMS ((char *));
305
306 /* Structure for saved commands lines
307 (for breakpoints, defined commands, etc). */
308
309 struct command_line
310 {
311 struct command_line *next;
312 char *line;
313 };
314
315 extern struct command_line *
316 read_command_lines PARAMS ((void));
317
318 extern void
319 free_command_lines PARAMS ((struct command_line **));
320
321 /* String containing the current directory (what getwd would return). */
322
323 extern char *current_directory;
324
325 /* Default radixes for input and output. Only some values supported. */
326 extern unsigned input_radix;
327 extern unsigned output_radix;
328
329 /* Baud rate specified for communication with serial target systems. */
330 extern char *baud_rate;
331
332 /* Languages represented in the symbol table and elsewhere. */
333
334 enum language
335 {
336 language_unknown, /* Language not known */
337 language_auto, /* Placeholder for automatic setting */
338 language_c, /* C */
339 language_cplus, /* C++ */
340 language_m2 /* Modula-2 */
341 };
342
343 /* Return a format string for printf that will print a number in the local
344 (language-specific) hexadecimal format. Result is static and is
345 overwritten by the next call. local_hex_format_custom takes printf
346 options like "08" or "l" (to produce e.g. %08x or %lx). */
347
348 #define local_hex_format() (current_language->la_hex_format)
349
350 extern char *
351 local_hex_format_custom PARAMS ((char *)); /* language.c */
352
353 /* Return a string that contains a number formatted in the local
354 (language-specific) hexadecimal format. Result is static and is
355 overwritten by the next call. local_hex_string_custom takes printf
356 options like "08" or "l". */
357
358 extern char *
359 local_hex_string PARAMS ((int)); /* language.c */
360
361 extern char *
362 local_hex_string_custom PARAMS ((int, char *)); /* language.c */
363
364 \f
365 /* Host machine definition. This will be a symlink to one of the
366 xm-*.h files, built by the `configure' script. */
367
368 #include "xm.h"
369
370 /* If the xm.h file did not define the mode string used to open the
371 files, assume that binary files are opened the same way as text
372 files */
373 #ifndef FOPEN_RB
374 #include "fopen-same.h"
375 #endif
376
377 /*
378 * Allow things in gdb to be declared "const". If compiling ANSI, it
379 * just works. If compiling with gcc but non-ansi, redefine to __const__.
380 * If non-ansi, non-gcc, then eliminate "const" entirely, making those
381 * objects be read-write rather than read-only.
382 */
383
384 #ifndef const
385 #ifndef __STDC__
386 # ifdef __GNUC__
387 # define const __const__
388 # else
389 # define const /*nothing*/
390 # endif /* GNUC */
391 #endif /* STDC */
392 #endif /* const */
393
394 #ifndef volatile
395 #ifndef __STDC__
396 # ifdef __GNUC__
397 # define volatile __volatile__
398 # else
399 # define volatile /*nothing*/
400 # endif /* GNUC */
401 #endif /* STDC */
402 #endif /* volatile */
403
404 /* Some compilers (many AT&T SVR4 compilers for instance), do not accept
405 declarations of functions that never return (exit for instance) as
406 "volatile void". For such compilers "NORETURN" can be defined away
407 to keep them happy */
408
409 #ifndef NORETURN
410 # define NORETURN volatile
411 #endif
412
413 /* Defaults for system-wide constants (if not defined by xm.h, we fake it). */
414
415 #if !defined (UINT_MAX)
416 #define UINT_MAX 0xffffffff
417 #endif
418
419 #if !defined (LONG_MAX)
420 #define LONG_MAX 0x7fffffff
421 #endif
422
423 #if !defined (INT_MAX)
424 #define INT_MAX 0x7fffffff
425 #endif
426
427 #if !defined (INT_MIN)
428 /* Two's complement, 32 bit. */
429 #define INT_MIN -0x80000000
430 #endif
431
432 /* Number of bits in a char or unsigned char for the target machine.
433 Just like CHAR_BIT in <limits.h> but describes the target machine. */
434 #if !defined (TARGET_CHAR_BIT)
435 #define TARGET_CHAR_BIT 8
436 #endif
437
438 /* Number of bits in a short or unsigned short for the target machine. */
439 #if !defined (TARGET_SHORT_BIT)
440 #define TARGET_SHORT_BIT (sizeof (short) * TARGET_CHAR_BIT)
441 #endif
442
443 /* Number of bits in an int or unsigned int for the target machine. */
444 #if !defined (TARGET_INT_BIT)
445 #define TARGET_INT_BIT (sizeof (int) * TARGET_CHAR_BIT)
446 #endif
447
448 /* Number of bits in a long or unsigned long for the target machine. */
449 #if !defined (TARGET_LONG_BIT)
450 #define TARGET_LONG_BIT (sizeof (long) * TARGET_CHAR_BIT)
451 #endif
452
453 /* Number of bits in a long long or unsigned long long for the target machine. */
454 #if !defined (TARGET_LONG_LONG_BIT)
455 #define TARGET_LONG_LONG_BIT (2 * TARGET_LONG_BIT)
456 #endif
457
458 /* Number of bits in a float for the target machine. */
459 #if !defined (TARGET_FLOAT_BIT)
460 #define TARGET_FLOAT_BIT (sizeof (float) * TARGET_CHAR_BIT)
461 #endif
462
463 /* Number of bits in a double for the target machine. */
464 #if !defined (TARGET_DOUBLE_BIT)
465 #define TARGET_DOUBLE_BIT (sizeof (double) * TARGET_CHAR_BIT)
466 #endif
467
468 /* Number of bits in a long double for the target machine. */
469 #if !defined (TARGET_LONG_DOUBLE_BIT)
470 #define TARGET_LONG_DOUBLE_BIT (2 * TARGET_DOUBLE_BIT)
471 #endif
472
473 /* Number of bits in a "complex" for the target machine. */
474 #if !defined (TARGET_COMPLEX_BIT)
475 #define TARGET_COMPLEX_BIT (2 * TARGET_FLOAT_BIT)
476 #endif
477
478 /* Number of bits in a "double complex" for the target machine. */
479 #if !defined (TARGET_DOUBLE_COMPLEX_BIT)
480 #define TARGET_DOUBLE_COMPLEX_BIT (2 * TARGET_DOUBLE_BIT)
481 #endif
482
483 /* Number of bits in a pointer for the target machine */
484 #if !defined (TARGET_PTR_BIT)
485 #define TARGET_PTR_BIT TARGET_INT_BIT
486 #endif
487
488 /* Convert a LONGEST to an int. This is used in contexts (e.g. number
489 of arguments to a function, number in a value history, register
490 number, etc.) where the value must not be larger than can fit
491 in an int. */
492 #if !defined (longest_to_int)
493 #if defined (LONG_LONG)
494 #define longest_to_int(x) (((x) > INT_MAX || (x) < INT_MIN) \
495 ? error ("Value out of range.") : (int) (x))
496 #else /* No LONG_LONG. */
497 /* Assume sizeof (int) == sizeof (long). */
498 #define longest_to_int(x) ((int) (x))
499 #endif /* No LONG_LONG. */
500 #endif /* No longest_to_int. */
501
502 /* This should not be a typedef, because "unsigned LONGEST" needs
503 to work. LONG_LONG is defined if the host has "long long". */
504
505 #ifndef LONGEST
506 # ifdef LONG_LONG
507 # define LONGEST long long
508 # else
509 # define LONGEST long
510 # endif
511 #endif
512
513 /* Assorted functions we can declare, now that const and volatile are
514 defined. */
515
516 extern char *
517 savestring PARAMS ((const char *, int));
518
519 extern char *
520 msavestring PARAMS ((void *, const char *, int));
521
522 extern char *
523 strsave PARAMS ((const char *));
524
525 extern char *
526 mstrsave PARAMS ((void *, const char *));
527
528 extern char *
529 concat PARAMS ((char *, ...));
530
531 extern PTR
532 xmalloc PARAMS ((long));
533
534 extern PTR
535 xrealloc PARAMS ((PTR, long));
536
537 extern PTR
538 xmmalloc PARAMS ((PTR, long));
539
540 extern PTR
541 xmrealloc PARAMS ((PTR, PTR, long));
542
543 extern PTR
544 mmalloc PARAMS ((PTR, long));
545
546 extern PTR
547 mrealloc PARAMS ((PTR, PTR, long));
548
549 extern void
550 mfree PARAMS ((PTR, PTR));
551
552 extern int
553 mmcheck PARAMS ((PTR, void (*) (void)));
554
555 extern int
556 mmtrace PARAMS ((void));
557
558 extern int
559 parse_escape PARAMS ((char **));
560
561 extern char *reg_names[];
562
563 extern NORETURN void /* Does not return to the caller. */
564 error ();
565
566 extern NORETURN void /* Does not return to the caller. */
567 fatal ();
568
569 extern NORETURN void /* Not specified as volatile in ... */
570 exit PARAMS ((int)); /* 4.10.4.3 */
571
572 extern NORETURN void /* Does not return to the caller. */
573 nomem PARAMS ((long));
574
575 extern NORETURN void /* Does not return to the caller. */
576 return_to_top_level PARAMS ((void));
577
578 extern void
579 warning_setup PARAMS ((void));
580
581 extern void
582 warning ();
583
584 /* Global functions from other, non-gdb GNU thingies (libiberty for
585 instance) */
586
587 extern char *
588 basename PARAMS ((char *));
589
590 extern char *
591 getenv PARAMS ((CONST char *));
592
593 extern char **
594 buildargv PARAMS ((char *));
595
596 extern void
597 freeargv PARAMS ((char **));
598
599 extern char *
600 strerrno PARAMS ((int));
601
602 extern char *
603 strsigno PARAMS ((int));
604
605 extern int
606 errno_max PARAMS ((void));
607
608 extern int
609 signo_max PARAMS ((void));
610
611 extern int
612 strtoerrno PARAMS ((char *));
613
614 extern int
615 strtosigno PARAMS ((char *));
616
617 extern char *
618 strsignal PARAMS ((int));
619
620 /* From other system libraries */
621
622 #ifndef PSIGNAL_IN_SIGNAL_H
623 extern void
624 psignal PARAMS ((unsigned, char *));
625 #endif
626
627 /* For now, we can't include <stdlib.h> because it conflicts with
628 "../include/getopt.h". (FIXME)
629
630 However, if a function is defined in the ANSI C standard and a prototype
631 for that function is defined and visible in any header file in an ANSI
632 conforming environment, then that prototype must match the definition in
633 the ANSI standard. So we can just duplicate them here without conflict,
634 since they must be the same in all conforming ANSI environments. If
635 these cause problems, then the environment is not ANSI conformant. */
636
637 #ifdef __STDC__
638 #include <stddef.h>
639 #endif
640
641 extern int
642 fclose PARAMS ((FILE *stream)); /* 4.9.5.1 */
643
644 extern void
645 perror PARAMS ((const char *)); /* 4.9.10.4 */
646
647 extern double
648 atof PARAMS ((const char *nptr)); /* 4.10.1.1 */
649
650 #ifndef MALLOC_INCOMPATIBLE
651
652 extern PTR
653 malloc PARAMS ((size_t size)); /* 4.10.3.3 */
654
655 extern PTR
656 realloc PARAMS ((void *ptr, size_t size)); /* 4.10.3.4 */
657
658 extern void
659 free PARAMS ((void *)); /* 4.10.3.2 */
660
661 #endif /* MALLOC_INCOMPATIBLE */
662
663 extern void
664 qsort PARAMS ((void *base, size_t nmemb, /* 4.10.5.2 */
665 size_t size,
666 int (*comp)(const void *, const void *)));
667
668 extern char *
669 strchr PARAMS ((const char *, int)); /* 4.11.5.2 */
670
671 extern char *
672 strrchr PARAMS ((const char *, int)); /* 4.11.5.5 */
673
674 extern char *
675 strstr PARAMS ((const char *, const char *)); /* 4.11.5.7 */
676
677 extern char *
678 strtok PARAMS ((char *, const char *)); /* 4.11.5.8 */
679
680 extern char *
681 strerror PARAMS ((int)); /* 4.11.6.2 */
682
683 /* Various possibilities for alloca. */
684 #ifndef alloca
685 # ifdef __GNUC__
686 # define alloca __builtin_alloca
687 # else
688 # ifdef sparc
689 # include <alloca.h>
690 # endif
691 extern char *alloca ();
692 # endif
693 #endif
694
695 /* TARGET_BYTE_ORDER and HOST_BYTE_ORDER should be defined to one of these. */
696
697 #if !defined (BIG_ENDIAN)
698 #define BIG_ENDIAN 4321
699 #endif
700
701 #if !defined (LITTLE_ENDIAN)
702 #define LITTLE_ENDIAN 1234
703 #endif
704
705 /* Target-system-dependent parameters for GDB.
706
707 The standard thing is to include defs.h. However, files that are
708 specific to a particular target can define TM_FILE_OVERRIDE before
709 including defs.h, then can include any particular tm-file they desire. */
710
711 /* Target machine definition. This will be a symlink to one of the
712 tm-*.h files, built by the `configure' script. */
713
714 #ifndef TM_FILE_OVERRIDE
715 #include "tm.h"
716 #endif
717
718 /* The bit byte-order has to do just with numbering of bits in
719 debugging symbols and such. Conceptually, it's quite separate
720 from byte/word byte order. */
721
722 #if !defined (BITS_BIG_ENDIAN)
723 #if TARGET_BYTE_ORDER == BIG_ENDIAN
724 #define BITS_BIG_ENDIAN 1
725 #endif /* Big endian. */
726
727 #if TARGET_BYTE_ORDER == LITTLE_ENDIAN
728 #define BITS_BIG_ENDIAN 0
729 #endif /* Little endian. */
730 #endif /* BITS_BIG_ENDIAN not defined. */
731
732 /* Swap LEN bytes at BUFFER between target and host byte-order. */
733 #if TARGET_BYTE_ORDER == HOST_BYTE_ORDER
734 #define SWAP_TARGET_AND_HOST(buffer,len)
735 #else /* Target and host byte order differ. */
736 #define SWAP_TARGET_AND_HOST(buffer,len) \
737 { \
738 char tmp; \
739 char *p = (char *)(buffer); \
740 char *q = ((char *)(buffer)) + len - 1; \
741 for (; p < q; p++, q--) \
742 { \
743 tmp = *q; \
744 *q = *p; \
745 *p = tmp; \
746 } \
747 }
748 #endif /* Target and host byte order differ. */
749
750 /* On some machines there are bits in addresses which are not really
751 part of the address, but are used by the kernel, the hardware, etc.
752 for special purposes. ADDR_BITS_REMOVE takes out any such bits
753 so we get a "real" address such as one would find in a symbol
754 table. ADDR_BITS_SET sets those bits the way the system wants
755 them. */
756 #if !defined (ADDR_BITS_REMOVE)
757 #define ADDR_BITS_REMOVE(addr) (addr)
758 #define ADDR_BITS_SET(addr) (addr)
759 #endif /* No ADDR_BITS_REMOVE. */
760
761 /* From valops.c */
762
763 extern CORE_ADDR
764 push_bytes PARAMS ((CORE_ADDR, char *, int));
765
766 /* In some modules, we don't have a definition of REGISTER_TYPE yet, so we
767 must avoid prototyping this function for now. FIXME. Should be:
768 extern CORE_ADDR
769 push_word PARAMS ((CORE_ADDR, REGISTER_TYPE));
770 */
771 extern CORE_ADDR
772 push_word ();
773
774 #endif /* !defined (DEFS_H) */