1 /* Source-language-related definitions for GDB.
3 Copyright 1991, 1992, 1993, 1994, 1995, 1998, 1999, 2000, 2003,
4 2004 Free Software Foundation, Inc.
6 Contributed by the Department of Computer Science at the State University
7 of New York at Buffalo.
9 This file is part of GDB.
11 This program is free software; you can redistribute it and/or modify
12 it under the terms of the GNU General Public License as published by
13 the Free Software Foundation; either version 2 of the License, or
14 (at your option) any later version.
16 This program is distributed in the hope that it will be useful,
17 but WITHOUT ANY WARRANTY; without even the implied warranty of
18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 GNU General Public License for more details.
21 You should have received a copy of the GNU General Public License
22 along with this program; if not, write to the Free Software
23 Foundation, Inc., 59 Temple Place - Suite 330,
24 Boston, MA 02111-1307, USA. */
26 #if !defined (LANGUAGE_H)
29 /* Forward decls for prototypes */
35 /* enum exp_opcode; ANSI's `wisdom' didn't include forward enum decls. */
37 /* This used to be included to configure GDB for one or more specific
38 languages. Now it is left out to configure for all of them. FIXME. */
39 /* #include "lang_def.h" */
45 #define MAX_FORTRAN_DIMS 7 /* Maximum number of F77 array dims */
48 range_mode_auto: range_check set automatically to default of language.
49 range_mode_manual: range_check set manually by user. */
51 extern enum range_mode
53 range_mode_auto
, range_mode_manual
58 range_check_on: Ranges are checked in GDB expressions, producing errors.
59 range_check_warn: Ranges are checked, producing warnings.
60 range_check_off: Ranges are not checked in GDB expressions. */
62 extern enum range_check
64 range_check_off
, range_check_warn
, range_check_on
69 type_mode_auto: type_check set automatically to default of language
70 type_mode_manual: type_check set manually by user. */
74 type_mode_auto
, type_mode_manual
79 type_check_on: Types are checked in GDB expressions, producing errors.
80 type_check_warn: Types are checked, producing warnings.
81 type_check_off: Types are not checked in GDB expressions. */
83 extern enum type_check
85 type_check_off
, type_check_warn
, type_check_on
90 case_mode_auto: case_sensitivity set upon selection of scope
91 case_mode_manual: case_sensitivity set only by user. */
95 case_mode_auto
, case_mode_manual
100 array_row_major: Arrays are in row major order
101 array_column_major: Arrays are in column major order.*/
103 extern enum array_ordering
105 array_row_major
, array_column_major
110 /* case_sensitivity ==
111 case_sensitive_on: Case sensitivity in name matching is used
112 case_sensitive_off: Case sensitivity in name matching is not used */
114 extern enum case_sensitivity
116 case_sensitive_on
, case_sensitive_off
120 /* Information for doing language dependent formatting of printed values. */
122 struct language_format_info
124 /* The format that can be passed directly to standard C printf functions
125 to generate a completely formatted value in the format appropriate for
130 /* The prefix to be used when directly printing a value, or constructing
131 a standard C printf format. This generally is everything up to the
132 conversion specification (the part introduced by the '%' character
133 and terminated by the conversion specifier character). */
135 char *la_format_prefix
;
137 /* The conversion specifier. This is generally everything after the
138 field width and precision, typically only a single character such
139 as 'o' for octal format or 'x' for hexadecimal format. */
141 char *la_format_specifier
;
143 /* The suffix to be used when directly printing a value, or constructing
144 a standard C printf format. This generally is everything after the
145 conversion specification (the part introduced by the '%' character
146 and terminated by the conversion specifier character). */
148 char *la_format_suffix
; /* Suffix for custom format string */
151 /* Per architecture (OS/ABI) language information. */
153 struct language_arch_info
155 /* Its primitive types. This is a vector ended by a NULL pointer.
156 These types can be specified by name in parsing types in
157 expressions, regardless of whether the program being debugged
158 actually defines such a type. */
159 struct type
**primitive_type_vector
;
160 /* Type of elements of strings. */
161 struct type
*string_char_type
;
164 struct type
*language_string_char_type (const struct language_defn
*l
,
165 struct gdbarch
*gdbarch
);
167 struct type
*language_lookup_primitive_type_by_name (const struct language_defn
*l
,
168 struct gdbarch
*gdbarch
,
171 /* Structure tying together assorted information about a language. */
175 /* Name of the language */
179 /* its symtab language-enum (defs.h) */
181 enum language la_language
;
183 /* Its builtin types. This is a vector ended by a NULL pointer. These
184 types can be specified by name in parsing types in expressions,
185 regardless of whether the program being debugged actually defines
188 struct type
**const *la_builtin_type_vector
;
190 /* Default range checking */
192 enum range_check la_range_check
;
194 /* Default type checking */
196 enum type_check la_type_check
;
198 /* Default case sensitivity */
199 enum case_sensitivity la_case_sensitivity
;
201 /* Multi-dimensional array ordering */
202 enum array_ordering la_array_ordering
;
204 /* Definitions related to expression printing, prefixifying, and
207 const struct exp_descriptor
*la_exp_desc
;
209 /* Parser function. */
211 int (*la_parser
) (void);
213 /* Parser error function */
215 void (*la_error
) (char *);
217 /* Given an expression *EXPP created by prefixifying the result of
218 la_parser, perform any remaining processing necessary to complete
219 its translation. *EXPP may change; la_post_parser is responsible
220 for releasing its previous contents, if necessary. If
221 VOID_CONTEXT_P, then no value is expected from the expression. */
223 void (*la_post_parser
) (struct expression
** expp
, int void_context_p
);
225 void (*la_printchar
) (int ch
, struct ui_file
* stream
);
227 void (*la_printstr
) (struct ui_file
* stream
, char *string
,
228 unsigned int length
, int width
,
231 void (*la_emitchar
) (int ch
, struct ui_file
* stream
, int quoter
);
233 struct type
*(*la_fund_type
) (struct objfile
*, int);
235 /* Print a type using syntax appropriate for this language. */
237 void (*la_print_type
) (struct type
*, char *, struct ui_file
*, int,
240 /* Print a value using syntax appropriate for this language. */
242 int (*la_val_print
) (struct type
*, char *, int, CORE_ADDR
,
243 struct ui_file
*, int, int, int,
244 enum val_prettyprint
);
246 /* Print a top-level value using syntax appropriate for this language. */
248 int (*la_value_print
) (struct value
*, struct ui_file
*,
249 int, enum val_prettyprint
);
251 /* PC is possibly an unknown languages trampoline.
252 If that PC falls in a trampoline belonging to this language,
253 return the address of the first pc in the real function, or 0
254 if it isn't a language tramp for this language. */
255 CORE_ADDR (*skip_trampoline
) (CORE_ADDR pc
);
257 /* Now come some hooks for lookup_symbol. */
259 /* If this is non-NULL, lookup_symbol will do the 'field_of_this'
260 check, using this function to find the value of this. */
262 /* FIXME: carlton/2003-05-19: Audit all the language_defn structs
263 to make sure we're setting this appropriately: I'm sure it
264 could be NULL in more languages. */
266 struct value
*(*la_value_of_this
) (int complain
);
268 /* This is a function that lookup_symbol will call when it gets to
269 the part of symbol lookup where C looks up static and global
272 struct symbol
*(*la_lookup_symbol_nonlocal
) (const char *,
274 const struct block
*,
278 /* Find the definition of the type with the given name. */
279 struct type
*(*la_lookup_transparent_type
) (const char *);
281 /* Return demangled language symbol, or NULL. */
282 char *(*la_demangle
) (const char *mangled
, int options
);
284 /* Return class name of a mangled method name or NULL. */
285 char *(*la_class_name_from_physname
) (const char *physname
);
287 /* Base 2 (binary) formats. */
289 struct language_format_info la_binary_format
;
291 /* Base 8 (octal) formats. */
293 struct language_format_info la_octal_format
;
295 /* Base 10 (decimal) formats */
297 struct language_format_info la_decimal_format
;
299 /* Base 16 (hexadecimal) formats */
301 struct language_format_info la_hex_format
;
303 /* Table for printing expressions */
305 const struct op_print
*la_op_print_tab
;
307 /* Zero if the language has first-class arrays. True if there are no
308 array values, and array objects decay to pointers, as in C. */
312 /* Index to use for extracting the first element of a string. */
313 char string_lower_bound
;
315 /* Type of elements of strings. */
316 struct type
**string_char_type
;
318 /* The list of characters forming word boundaries. */
319 char *(*la_word_break_characters
) (void);
321 /* The per-architecture (OS/ABI) language information. */
322 void (*la_language_arch_info
) (struct gdbarch
*,
323 struct language_arch_info
*);
325 /* Add fields above this point, so the magic number is always last. */
326 /* Magic number for compat checking */
332 #define LANG_MAGIC 910823L
334 /* Pointer to the language_defn for our current language. This pointer
335 always points to *some* valid struct; it can be used without checking
338 The current language affects expression parsing and evaluation
339 (FIXME: it might be cleaner to make the evaluation-related stuff
340 separate exp_opcodes for each different set of semantics. We
341 should at least think this through more clearly with respect to
342 what happens if the language is changed between parsing and
343 evaluation) and printing of things like types and arrays. It does
344 *not* affect symbol-reading-- each source file in a symbol-file has
345 its own language and we should keep track of that regardless of the
346 language when symbols are read. If we want some manual setting for
347 the language of symbol files (e.g. detecting when ".c" files are
348 C++), it should be a separate setting from the current_language. */
350 extern const struct language_defn
*current_language
;
352 /* Pointer to the language_defn expected by the user, e.g. the language
353 of main(), or the language we last mentioned in a message, or C. */
355 extern const struct language_defn
*expected_language
;
358 language_mode_auto: current_language automatically set upon selection
359 of scope (e.g. stack frame)
360 language_mode_manual: current_language set only by user. */
362 extern enum language_mode
364 language_mode_auto
, language_mode_manual
368 /* These macros define the behaviour of the expression
371 /* Should we strictly type check expressions? */
372 #define STRICT_TYPE (type_check != type_check_off)
374 /* Should we range check values against the domain of their type? */
375 #define RANGE_CHECK (range_check != range_check_off)
377 /* "cast" really means conversion */
378 /* FIXME -- should be a setting in language_defn */
379 #define CAST_IS_CONVERSION (current_language->la_language == language_c || \
380 current_language->la_language == language_cplus || \
381 current_language->la_language == language_objc)
383 extern void language_info (int);
385 extern enum language
set_language (enum language
);
388 /* This page contains functions that return things that are
389 specific to languages. Each of these functions is based on
390 the current setting of working_lang, which the user sets
391 with the "set language" command. */
393 #define create_fundamental_type(objfile,typeid) \
394 (current_language->la_fund_type(objfile, typeid))
396 #define LA_PRINT_TYPE(type,varstring,stream,show,level) \
397 (current_language->la_print_type(type,varstring,stream,show,level))
399 #define LA_VAL_PRINT(type,valaddr,offset,addr,stream,fmt,deref,recurse,pretty) \
400 (current_language->la_val_print(type,valaddr,offset,addr,stream,fmt,deref, \
402 #define LA_VALUE_PRINT(val,stream,fmt,pretty) \
403 (current_language->la_value_print(val,stream,fmt,pretty))
405 /* Return a format string for printf that will print a number in one of
406 the local (language-specific) formats. Result is static and is
407 overwritten by the next call. Takes printf options like "08" or "l"
408 (to produce e.g. %08x or %lx). */
410 #define local_binary_format() \
411 (current_language->la_binary_format.la_format)
412 #define local_binary_format_prefix() \
413 (current_language->la_binary_format.la_format_prefix)
414 #define local_binary_format_specifier() \
415 (current_language->la_binary_format.la_format_specifier)
416 #define local_binary_format_suffix() \
417 (current_language->la_binary_format.la_format_suffix)
419 #define local_octal_format() \
420 (current_language->la_octal_format.la_format)
421 #define local_octal_format_prefix() \
422 (current_language->la_octal_format.la_format_prefix)
423 #define local_octal_format_specifier() \
424 (current_language->la_octal_format.la_format_specifier)
425 #define local_octal_format_suffix() \
426 (current_language->la_octal_format.la_format_suffix)
428 #define local_decimal_format() \
429 (current_language->la_decimal_format.la_format)
430 #define local_decimal_format_prefix() \
431 (current_language->la_decimal_format.la_format_prefix)
432 #define local_decimal_format_specifier() \
433 (current_language->la_decimal_format.la_format_specifier)
434 #define local_decimal_format_suffix() \
435 (current_language->la_decimal_format.la_format_suffix)
437 #define local_hex_format() \
438 (current_language->la_hex_format.la_format)
439 #define local_hex_format_prefix() \
440 (current_language->la_hex_format.la_format_prefix)
441 #define local_hex_format_specifier() \
442 (current_language->la_hex_format.la_format_specifier)
443 #define local_hex_format_suffix() \
444 (current_language->la_hex_format.la_format_suffix)
446 #define LA_PRINT_CHAR(ch, stream) \
447 (current_language->la_printchar(ch, stream))
448 #define LA_PRINT_STRING(stream, string, length, width, force_ellipses) \
449 (current_language->la_printstr(stream, string, length, width, force_ellipses))
450 #define LA_EMIT_CHAR(ch, stream, quoter) \
451 (current_language->la_emitchar(ch, stream, quoter))
453 /* Test a character to decide whether it can be printed in literal form
454 or needs to be printed in another representation. For example,
455 in C the literal form of the character with octal value 141 is 'a'
456 and the "other representation" is '\141'. The "other representation"
457 is program language dependent. */
459 #define PRINT_LITERAL_FORM(c) \
461 && ((c) < 0x7F || (c) >= 0xA0) \
462 && (!sevenbit_strings || (c) < 0x80))
464 /* Return a format string for printf that will print a number in one of
465 the local (language-specific) formats. Result is static and is
466 overwritten by the next call. Takes printf options like "08" or "l"
467 (to produce e.g. %08x or %lx). */
469 extern char *local_decimal_format_custom (char *); /* language.c */
471 extern char *local_octal_format_custom (char *); /* language.c */
473 extern char *local_hex_format_custom (char *); /* language.c */
476 /* FIXME: cagney/2000-03-04: This function does not appear to be used.
477 It can be deleted once 5.0 has been released. */
478 /* Return a string that contains the hex digits of the number. No preceeding
481 extern char *longest_raw_hex_string (LONGEST
);
484 /* Return a string that contains a number formatted in one of the local
485 (language-specific) formats. Result is static and is overwritten by
486 the next call. Takes printf options like "08l" or "l". */
488 extern char *local_hex_string (LONGEST
); /* language.c */
490 extern char *local_hex_string_custom (LONGEST
, char *); /* language.c */
492 /* Type predicates */
494 extern int simple_type (struct type
*);
496 extern int ordered_type (struct type
*);
498 extern int same_type (struct type
*, struct type
*);
500 extern int integral_type (struct type
*);
502 extern int numeric_type (struct type
*);
504 extern int character_type (struct type
*);
506 extern int boolean_type (struct type
*);
508 extern int float_type (struct type
*);
510 extern int pointer_type (struct type
*);
512 extern int structured_type (struct type
*);
514 /* Checks Binary and Unary operations for semantic type correctness */
515 /* FIXME: Does not appear to be used */
516 #define unop_type_check(v,o) binop_type_check((v),NULL,(o))
518 extern void binop_type_check (struct value
*, struct value
*, int);
522 extern void op_error (const char *lhs
, enum exp_opcode
,
525 extern void type_error (const char *, ...) ATTR_FORMAT (printf
, 1, 2);
527 extern void range_error (const char *, ...) ATTR_FORMAT (printf
, 1, 2);
529 /* Data: Does this value represent "truth" to the current language? */
531 extern int value_true (struct value
*);
533 extern struct type
*lang_bool_type (void);
535 /* The type used for Boolean values in the current language. */
536 #define LA_BOOL_TYPE lang_bool_type ()
538 /* Misc: The string representing a particular enum language. */
540 extern enum language
language_enum (char *str
);
542 extern const struct language_defn
*language_def (enum language
);
544 extern char *language_str (enum language
);
546 /* Add a language to the set known by GDB (at initialization time). */
548 extern void add_language (const struct language_defn
*);
550 extern enum language
get_frame_language (void); /* In stack.c */
552 /* Check for a language-specific trampoline. */
554 extern CORE_ADDR
skip_language_trampoline (CORE_ADDR pc
);
556 /* Return demangled language symbol, or NULL. */
557 extern char *language_demangle (const struct language_defn
*current_language
,
558 const char *mangled
, int options
);
560 /* Return class name from physname, or NULL. */
561 extern char *language_class_name_from_physname (const struct language_defn
*,
562 const char *physname
);
564 /* Splitting strings into words. */
565 extern char *default_word_break_characters (void);
567 #endif /* defined (LANGUAGE_H) */