Fix language of compilation unit with unknown file extension
[deliverable/binutils-gdb.git] / gdb / defs.h
1 /* *INDENT-OFF* */ /* ATTRIBUTE_PRINTF confuses indent, avoid running it
2 for now. */
3 /* Basic, host-specific, and target-specific definitions for GDB.
4 Copyright (C) 1986-2015 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 3 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, see <http://www.gnu.org/licenses/>. */
20
21 #ifndef DEFS_H
22 #define DEFS_H
23
24 #ifdef GDBSERVER
25 # error gdbserver should not include gdb/defs.h
26 #endif
27
28 #include "common-defs.h"
29
30 #include <sys/types.h>
31 #include <limits.h>
32
33 /* The libdecnumber library, on which GDB depends, includes a header file
34 called gstdint.h instead of relying directly on stdint.h. GDB, on the
35 other hand, includes stdint.h directly, relying on the fact that gnulib
36 generates a copy if the system doesn't provide one or if it is missing
37 some features. Unfortunately, gstdint.h and stdint.h cannot be included
38 at the same time, which may happen when we include a file from
39 libdecnumber.
40
41 The following macro definition effectively prevents the inclusion of
42 gstdint.h, as all the definitions it provides are guarded against
43 the GCC_GENERATED_STDINT_H macro. We already have gnulib/stdint.h
44 included, so it's ok to blank out gstdint.h. */
45 #define GCC_GENERATED_STDINT_H 1
46
47 #include <unistd.h>
48
49 #include <fcntl.h>
50
51 #include "gdb_wchar.h"
52
53 #include "ui-file.h"
54
55 #include "host-defs.h"
56
57 /* Scope types enumerator. List the types of scopes the compiler will
58 accept. */
59
60 enum compile_i_scope_types
61 {
62 COMPILE_I_INVALID_SCOPE,
63
64 /* A simple scope. Wrap an expression into a simple scope that
65 takes no arguments, returns no value, and uses the generic
66 function name "_gdb_expr". */
67
68 COMPILE_I_SIMPLE_SCOPE,
69
70 /* Do not wrap the expression,
71 it has to provide function "_gdb_expr" on its own. */
72 COMPILE_I_RAW_SCOPE,
73
74 /* A printable expression scope. Wrap an expression into a scope
75 suitable for the "compile print" command. It uses the generic
76 function name "_gdb_expr". COMPILE_I_PRINT_ADDRESS_SCOPE variant
77 is the usual one, taking address of the object.
78 COMPILE_I_PRINT_VALUE_SCOPE is needed for arrays where the array
79 name already specifies its address. See get_out_value_type. */
80 COMPILE_I_PRINT_ADDRESS_SCOPE,
81 COMPILE_I_PRINT_VALUE_SCOPE,
82 };
83
84 /* Just in case they're not defined in stdio.h. */
85
86 #ifndef SEEK_SET
87 #define SEEK_SET 0
88 #endif
89 #ifndef SEEK_CUR
90 #define SEEK_CUR 1
91 #endif
92
93 /* The O_BINARY flag is defined in fcntl.h on some non-Posix platforms.
94 It is used as an access modifier in calls to open(), where it acts
95 similarly to the "b" character in fopen()'s MODE argument. On Posix
96 platforms it should be a no-op, so it is defined as 0 here. This
97 ensures that the symbol may be used freely elsewhere in gdb. */
98
99 #ifndef O_BINARY
100 #define O_BINARY 0
101 #endif
102
103 #include "hashtab.h"
104
105 #ifndef min
106 #define min(a, b) ((a) < (b) ? (a) : (b))
107 #endif
108 #ifndef max
109 #define max(a, b) ((a) > (b) ? (a) : (b))
110 #endif
111
112 /* * Enable dbx commands if set. */
113 extern int dbx_commands;
114
115 /* * System root path, used to find libraries etc. */
116 extern char *gdb_sysroot;
117
118 /* * GDB datadir, used to store data files. */
119 extern char *gdb_datadir;
120
121 /* * If non-NULL, the possibly relocated path to python's "lib" directory
122 specified with --with-python. */
123 extern char *python_libdir;
124
125 /* * Search path for separate debug files. */
126 extern char *debug_file_directory;
127
128 /* GDB has two methods for handling SIGINT. When immediate_quit is
129 nonzero, a SIGINT results in an immediate longjmp out of the signal
130 handler. Otherwise, SIGINT simply sets a flag; code that might
131 take a long time, and which ought to be interruptible, checks this
132 flag using the QUIT macro.
133
134 These functions use the extension_language_ops API to allow extension
135 language(s) and GDB SIGINT handling to coexist seamlessly. */
136
137 /* * Clear the quit flag. */
138 extern void clear_quit_flag (void);
139 /* * Evaluate to non-zero if the quit flag is set, zero otherwise. This
140 will clear the quit flag as a side effect. */
141 extern int check_quit_flag (void);
142 /* * Set the quit flag. */
143 extern void set_quit_flag (void);
144
145 /* Flag that function quit should call quit_force. */
146 extern volatile int sync_quit_force_run;
147
148 extern int immediate_quit;
149
150 extern void quit (void);
151
152 /* FIXME: cagney/2000-03-13: It has been suggested that the peformance
153 benefits of having a ``QUIT'' macro rather than a function are
154 marginal. If the overhead of a QUIT function call is proving
155 significant then its calling frequency should probably be reduced
156 [kingdon]. A profile analyzing the current situtation is
157 needed. */
158
159 #define QUIT { \
160 if (check_quit_flag () || sync_quit_force_run) quit (); \
161 if (deprecated_interactive_hook) deprecated_interactive_hook (); \
162 }
163
164 /* * Languages represented in the symbol table and elsewhere.
165 This should probably be in language.h, but since enum's can't
166 be forward declared to satisfy opaque references before their
167 actual definition, needs to be here. */
168
169 enum language
170 {
171 language_unknown, /* Language not known */
172 language_auto, /* Placeholder for automatic setting */
173 language_c, /* C */
174 language_cplus, /* C++ */
175 language_d, /* D */
176 language_go, /* Go */
177 language_objc, /* Objective-C */
178 language_java, /* Java */
179 language_fortran, /* Fortran */
180 language_m2, /* Modula-2 */
181 language_asm, /* Assembly language */
182 language_pascal, /* Pascal */
183 language_ada, /* Ada */
184 language_opencl, /* OpenCL */
185 language_minimal, /* All other languages, minimal support only */
186 nr_languages
187 };
188
189 /* The number of bits needed to represent all languages, with enough
190 padding to allow for reasonable growth. */
191 #define LANGUAGE_BITS 5
192 gdb_static_assert (nr_languages <= (1 << LANGUAGE_BITS));
193
194 enum precision_type
195 {
196 single_precision,
197 double_precision,
198 unspecified_precision
199 };
200
201 /* * A generic, not quite boolean, enumeration. This is used for
202 set/show commands in which the options are on/off/automatic. */
203 enum auto_boolean
204 {
205 AUTO_BOOLEAN_TRUE,
206 AUTO_BOOLEAN_FALSE,
207 AUTO_BOOLEAN_AUTO
208 };
209
210 /* * Potential ways that a function can return a value of a given
211 type. */
212
213 enum return_value_convention
214 {
215 /* * Where the return value has been squeezed into one or more
216 registers. */
217 RETURN_VALUE_REGISTER_CONVENTION,
218 /* * Commonly known as the "struct return convention". The caller
219 passes an additional hidden first parameter to the caller. That
220 parameter contains the address at which the value being returned
221 should be stored. While typically, and historically, used for
222 large structs, this is convention is applied to values of many
223 different types. */
224 RETURN_VALUE_STRUCT_CONVENTION,
225 /* * Like the "struct return convention" above, but where the ABI
226 guarantees that the called function stores the address at which
227 the value being returned is stored in a well-defined location,
228 such as a register or memory slot in the stack frame. Don't use
229 this if the ABI doesn't explicitly guarantees this. */
230 RETURN_VALUE_ABI_RETURNS_ADDRESS,
231 /* * Like the "struct return convention" above, but where the ABI
232 guarantees that the address at which the value being returned is
233 stored will be available in a well-defined location, such as a
234 register or memory slot in the stack frame. Don't use this if
235 the ABI doesn't explicitly guarantees this. */
236 RETURN_VALUE_ABI_PRESERVES_ADDRESS,
237 };
238
239 /* Needed for various prototypes */
240
241 struct symtab;
242 struct breakpoint;
243 struct frame_info;
244 struct gdbarch;
245 struct value;
246
247 /* From main.c. */
248
249 /* This really belong in utils.c (path-utils.c?), but it references some
250 globals that are currently only available to main.c. */
251 extern char *relocate_gdb_directory (const char *initial, int flag);
252
253 \f
254 /* Annotation stuff. */
255
256 extern int annotation_level; /* in stack.c */
257 \f
258
259 /* From regex.c or libc. BSD 4.4 declares this with the argument type as
260 "const char *" in unistd.h, so we can't declare the argument
261 as "char *". */
262
263 EXTERN_C char *re_comp (const char *);
264
265 /* From symfile.c */
266
267 extern void symbol_file_command (char *, int);
268
269 /* * Remote targets may wish to use this as their load function. */
270 extern void generic_load (const char *name, int from_tty);
271
272 /* * Report on STREAM the performance of memory transfer operation,
273 such as 'load'.
274 @param DATA_COUNT is the number of bytes transferred.
275 @param WRITE_COUNT is the number of separate write operations, or 0,
276 if that information is not available.
277 @param START_TIME is the time at which an operation was started.
278 @param END_TIME is the time at which an operation ended. */
279 struct timeval;
280 extern void print_transfer_performance (struct ui_file *stream,
281 unsigned long data_count,
282 unsigned long write_count,
283 const struct timeval *start_time,
284 const struct timeval *end_time);
285
286 /* From top.c */
287
288 typedef void initialize_file_ftype (void);
289
290 extern char *gdb_readline (const char *);
291
292 extern char *gdb_readline_wrapper (const char *);
293
294 extern char *command_line_input (const char *, int, char *);
295
296 extern void print_prompt (void);
297
298 extern int input_from_terminal_p (void);
299
300 extern int info_verbose;
301
302 /* From printcmd.c */
303
304 extern void set_next_address (struct gdbarch *, CORE_ADDR);
305
306 extern int print_address_symbolic (struct gdbarch *, CORE_ADDR,
307 struct ui_file *, int, char *);
308
309 extern int build_address_symbolic (struct gdbarch *,
310 CORE_ADDR addr,
311 int do_demangle,
312 char **name,
313 int *offset,
314 char **filename,
315 int *line,
316 int *unmapped);
317
318 extern void print_address (struct gdbarch *, CORE_ADDR, struct ui_file *);
319 extern const char *pc_prefix (CORE_ADDR);
320
321 /* From source.c */
322
323 /* See openp function definition for their description. */
324 #define OPF_TRY_CWD_FIRST 0x01
325 #define OPF_SEARCH_IN_PATH 0x02
326 #define OPF_RETURN_REALPATH 0x04
327
328 extern int openp (const char *, int, const char *, int, char **);
329
330 extern int source_full_path_of (const char *, char **);
331
332 extern void mod_path (char *, char **);
333
334 extern void add_path (char *, char **, int);
335
336 extern void directory_switch (char *, int);
337
338 extern char *source_path;
339
340 extern void init_source_path (void);
341
342 /* From exec.c */
343
344 /* * Process memory area starting at ADDR with length SIZE. Area is
345 readable iff READ is non-zero, writable if WRITE is non-zero,
346 executable if EXEC is non-zero. Area is possibly changed against
347 its original file based copy if MODIFIED is non-zero. DATA is
348 passed without changes from a caller. */
349
350 typedef int (*find_memory_region_ftype) (CORE_ADDR addr, unsigned long size,
351 int read, int write, int exec,
352 int modified, void *data);
353
354 /* * Possible lvalue types. Like enum language, this should be in
355 value.h, but needs to be here for the same reason. */
356
357 enum lval_type
358 {
359 /* * Not an lval. */
360 not_lval,
361 /* * In memory. */
362 lval_memory,
363 /* * In a register. Registers are relative to a frame. */
364 lval_register,
365 /* * In a gdb internal variable. */
366 lval_internalvar,
367 /* * Value encapsulates a callable defined in an extension language. */
368 lval_xcallable,
369 /* * Part of a gdb internal variable (structure field). */
370 lval_internalvar_component,
371 /* * Value's bits are fetched and stored using functions provided
372 by its creator. */
373 lval_computed
374 };
375
376 /* * Control types for commands. */
377
378 enum misc_command_type
379 {
380 ok_command,
381 end_command,
382 else_command,
383 nop_command
384 };
385
386 enum command_control_type
387 {
388 simple_control,
389 break_control,
390 continue_control,
391 while_control,
392 if_control,
393 commands_control,
394 python_control,
395 compile_control,
396 guile_control,
397 while_stepping_control,
398 invalid_control
399 };
400
401 /* * Structure for saved commands lines (for breakpoints, defined
402 commands, etc). */
403
404 struct command_line
405 {
406 struct command_line *next;
407 char *line;
408 enum command_control_type control_type;
409 union
410 {
411 struct
412 {
413 enum compile_i_scope_types scope;
414 void *scope_data;
415 }
416 compile;
417 }
418 control_u;
419 /* * The number of elements in body_list. */
420 int body_count;
421 /* * For composite commands, the nested lists of commands. For
422 example, for "if" command this will contain the then branch and
423 the else branch, if that is available. */
424 struct command_line **body_list;
425 };
426
427 extern struct command_line *read_command_lines (char *, int, int,
428 void (*)(char *, void *),
429 void *);
430 extern struct command_line *read_command_lines_1 (char * (*) (void), int,
431 void (*)(char *, void *),
432 void *);
433
434 extern void free_command_lines (struct command_line **);
435
436 /* * Parameters of the "info proc" command. */
437
438 enum info_proc_what
439 {
440 /* * Display the default cmdline, cwd and exe outputs. */
441 IP_MINIMAL,
442
443 /* * Display `info proc mappings'. */
444 IP_MAPPINGS,
445
446 /* * Display `info proc status'. */
447 IP_STATUS,
448
449 /* * Display `info proc stat'. */
450 IP_STAT,
451
452 /* * Display `info proc cmdline'. */
453 IP_CMDLINE,
454
455 /* * Display `info proc exe'. */
456 IP_EXE,
457
458 /* * Display `info proc cwd'. */
459 IP_CWD,
460
461 /* * Display all of the above. */
462 IP_ALL
463 };
464
465 /* * String containing the current directory (what getwd would return). */
466
467 extern char *current_directory;
468
469 /* * Default radixes for input and output. Only some values supported. */
470 extern unsigned input_radix;
471 extern unsigned output_radix;
472
473 /* * Possibilities for prettyformat parameters to routines which print
474 things. Like enum language, this should be in value.h, but needs
475 to be here for the same reason. FIXME: If we can eliminate this
476 as an arg to LA_VAL_PRINT, then we can probably move it back to
477 value.h. */
478
479 enum val_prettyformat
480 {
481 Val_no_prettyformat = 0,
482 Val_prettyformat,
483 /* * Use the default setting which the user has specified. */
484 Val_prettyformat_default
485 };
486
487 /* * Optional native machine support. Non-native (and possibly pure
488 multi-arch) targets do not need a "nm.h" file. This will be a
489 symlink to one of the nm-*.h files, built by the `configure'
490 script. */
491
492 #ifdef GDB_NM_FILE
493 #include "nm.h"
494 #endif
495
496 /* Assume that fopen accepts the letter "b" in the mode string.
497 It is demanded by ISO C9X, and should be supported on all
498 platforms that claim to have a standard-conforming C library. On
499 true POSIX systems it will be ignored and have no effect. There
500 may still be systems without a standard-conforming C library where
501 an ISO C9X compiler (GCC) is available. Known examples are SunOS
502 4.x and 4.3BSD. This assumption means these systems are no longer
503 supported. */
504 #ifndef FOPEN_RB
505 # include "fopen-bin.h"
506 #endif
507
508 /* Defaults for system-wide constants (if not defined by xm.h, we fake it).
509 FIXME: Assumes 2's complement arithmetic. */
510
511 #if !defined (UINT_MAX)
512 #define UINT_MAX ((unsigned int)(~0)) /* 0xFFFFFFFF for 32-bits */
513 #endif
514
515 #if !defined (INT_MAX)
516 #define INT_MAX ((int)(UINT_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
517 #endif
518
519 #if !defined (INT_MIN)
520 #define INT_MIN ((int)((int) ~0 ^ INT_MAX)) /* 0x80000000 for 32-bits */
521 #endif
522
523 #if !defined (ULONG_MAX)
524 #define ULONG_MAX ((unsigned long)(~0L)) /* 0xFFFFFFFF for 32-bits */
525 #endif
526
527 #if !defined (LONG_MAX)
528 #define LONG_MAX ((long)(ULONG_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
529 #endif
530
531 #if !defined (ULONGEST_MAX)
532 #define ULONGEST_MAX (~(ULONGEST)0) /* 0xFFFFFFFFFFFFFFFF for 64-bits */
533 #endif
534
535 #if !defined (LONGEST_MAX) /* 0x7FFFFFFFFFFFFFFF for 64-bits */
536 #define LONGEST_MAX ((LONGEST)(ULONGEST_MAX >> 1))
537 #endif
538
539 /* * Convert a LONGEST to an int. This is used in contexts (e.g. number of
540 arguments to a function, number in a value history, register number, etc.)
541 where the value must not be larger than can fit in an int. */
542
543 extern int longest_to_int (LONGEST);
544
545 /* * List of known OS ABIs. If you change this, make sure to update the
546 table in osabi.c. */
547 enum gdb_osabi
548 {
549 GDB_OSABI_UNINITIALIZED = -1, /* For struct gdbarch_info. */
550
551 GDB_OSABI_UNKNOWN = 0, /* keep this zero */
552
553 GDB_OSABI_SVR4,
554 GDB_OSABI_HURD,
555 GDB_OSABI_SOLARIS,
556 GDB_OSABI_LINUX,
557 GDB_OSABI_FREEBSD_AOUT,
558 GDB_OSABI_FREEBSD_ELF,
559 GDB_OSABI_NETBSD_AOUT,
560 GDB_OSABI_NETBSD_ELF,
561 GDB_OSABI_OPENBSD_ELF,
562 GDB_OSABI_WINCE,
563 GDB_OSABI_GO32,
564 GDB_OSABI_IRIX,
565 GDB_OSABI_HPUX_ELF,
566 GDB_OSABI_HPUX_SOM,
567 GDB_OSABI_QNXNTO,
568 GDB_OSABI_CYGWIN,
569 GDB_OSABI_AIX,
570 GDB_OSABI_DICOS,
571 GDB_OSABI_DARWIN,
572 GDB_OSABI_SYMBIAN,
573 GDB_OSABI_OPENVMS,
574 GDB_OSABI_LYNXOS178,
575 GDB_OSABI_NEWLIB,
576 GDB_OSABI_SDE,
577
578 GDB_OSABI_INVALID /* keep this last */
579 };
580
581 /* Global functions from other, non-gdb GNU thingies.
582 Libiberty thingies are no longer declared here. We include libiberty.h
583 above, instead. */
584
585 /* From other system libraries */
586
587 #ifndef atof
588 extern double atof (const char *); /* X3.159-1989 4.10.1.1 */
589 #endif
590
591 /* Dynamic target-system-dependent parameters for GDB. */
592 #include "gdbarch.h"
593
594 /* * Maximum size of a register. Something small, but large enough for
595 all known ISAs. If it turns out to be too small, make it bigger. */
596
597 enum { MAX_REGISTER_SIZE = 64 };
598
599 /* In findvar.c. */
600
601 extern LONGEST extract_signed_integer (const gdb_byte *, int,
602 enum bfd_endian);
603
604 extern ULONGEST extract_unsigned_integer (const gdb_byte *, int,
605 enum bfd_endian);
606
607 extern int extract_long_unsigned_integer (const gdb_byte *, int,
608 enum bfd_endian, LONGEST *);
609
610 extern CORE_ADDR extract_typed_address (const gdb_byte *buf,
611 struct type *type);
612
613 extern void store_signed_integer (gdb_byte *, int,
614 enum bfd_endian, LONGEST);
615
616 extern void store_unsigned_integer (gdb_byte *, int,
617 enum bfd_endian, ULONGEST);
618
619 extern void store_typed_address (gdb_byte *buf, struct type *type,
620 CORE_ADDR addr);
621
622 \f
623 /* From valops.c */
624
625 extern int watchdog;
626
627 /* Hooks for alternate command interfaces. */
628
629 /* * The name of the interpreter if specified on the command line. */
630 extern char *interpreter_p;
631
632 struct target_waitstatus;
633 struct cmd_list_element;
634
635 extern void (*deprecated_pre_add_symbol_hook) (const char *);
636 extern void (*deprecated_post_add_symbol_hook) (void);
637 extern void (*selected_frame_level_changed_hook) (int);
638 extern int (*deprecated_ui_loop_hook) (int signo);
639 extern void (*deprecated_show_load_progress) (const char *section,
640 unsigned long section_sent,
641 unsigned long section_size,
642 unsigned long total_sent,
643 unsigned long total_size);
644 extern void (*deprecated_print_frame_info_listing_hook) (struct symtab * s,
645 int line,
646 int stopline,
647 int noerror);
648 extern int (*deprecated_query_hook) (const char *, va_list)
649 ATTRIBUTE_FPTR_PRINTF(1,0);
650 extern void (*deprecated_warning_hook) (const char *, va_list)
651 ATTRIBUTE_FPTR_PRINTF(1,0);
652 extern void (*deprecated_interactive_hook) (void);
653 extern void (*deprecated_readline_begin_hook) (char *, ...)
654 ATTRIBUTE_FPTR_PRINTF_1;
655 extern char *(*deprecated_readline_hook) (const char *);
656 extern void (*deprecated_readline_end_hook) (void);
657 extern void (*deprecated_context_hook) (int);
658 extern ptid_t (*deprecated_target_wait_hook) (ptid_t ptid,
659 struct target_waitstatus *status,
660 int options);
661
662 extern void (*deprecated_attach_hook) (void);
663 extern void (*deprecated_detach_hook) (void);
664 extern void (*deprecated_call_command_hook) (struct cmd_list_element * c,
665 char *cmd, int from_tty);
666
667 extern int (*deprecated_ui_load_progress_hook) (const char *section,
668 unsigned long num);
669
670 /* If this definition isn't overridden by the header files, assume
671 that isatty and fileno exist on this system. */
672 #ifndef ISATTY
673 #define ISATTY(FP) (isatty (fileno (FP)))
674 #endif
675
676 /* * A width that can achieve a better legibility for GDB MI mode. */
677 #define GDB_MI_MSG_WIDTH 80
678
679 /* From progspace.c */
680
681 extern void initialize_progspace (void);
682 extern void initialize_inferiors (void);
683
684 /* * Special block numbers */
685
686 enum block_enum
687 {
688 GLOBAL_BLOCK = 0,
689 STATIC_BLOCK = 1,
690 FIRST_LOCAL_BLOCK = 2
691 };
692
693 #include "utils.h"
694
695 #endif /* #ifndef DEFS_H */
This page took 0.044226 seconds and 4 git commands to generate.