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
99 /* case_sensitivity ==
100 case_sensitive_on: Case sensitivity in name matching is used
101 case_sensitive_off: Case sensitivity in name matching is not used */
103 extern enum case_sensitivity
105 case_sensitive_on
, case_sensitive_off
109 /* Information for doing language dependent formatting of printed values. */
111 struct language_format_info
113 /* The format that can be passed directly to standard C printf functions
114 to generate a completely formatted value in the format appropriate for
119 /* The prefix to be used when directly printing a value, or constructing
120 a standard C printf format. This generally is everything up to the
121 conversion specification (the part introduced by the '%' character
122 and terminated by the conversion specifier character). */
124 char *la_format_prefix
;
126 /* The conversion specifier. This is generally everything after the
127 field width and precision, typically only a single character such
128 as 'o' for octal format or 'x' for hexadecimal format. */
130 char *la_format_specifier
;
132 /* The suffix to be used when directly printing a value, or constructing
133 a standard C printf format. This generally is everything after the
134 conversion specification (the part introduced by the '%' character
135 and terminated by the conversion specifier character). */
137 char *la_format_suffix
; /* Suffix for custom format string */
140 /* Per architecture (OS/ABI) language information. */
142 struct language_arch_info
144 /* Its primitive types. This is a vector ended by a NULL pointer.
145 These types can be specified by name in parsing types in
146 expressions, regardless of whether the program being debugged
147 actually defines such a type. */
148 struct type
**primitive_type_vector
;
149 /* Type of elements of strings. */
150 struct type
*string_char_type
;
153 struct type
*language_string_char_type (const struct language_defn
*l
,
154 struct gdbarch
*gdbarch
);
156 struct type
*language_lookup_primitive_type_by_name (const struct language_defn
*l
,
157 struct gdbarch
*gdbarch
,
160 /* Structure tying together assorted information about a language. */
164 /* Name of the language */
168 /* its symtab language-enum (defs.h) */
170 enum language la_language
;
172 /* Its builtin types. This is a vector ended by a NULL pointer. These
173 types can be specified by name in parsing types in expressions,
174 regardless of whether the program being debugged actually defines
177 struct type
**const *la_builtin_type_vector
;
179 /* Default range checking */
181 enum range_check la_range_check
;
183 /* Default type checking */
185 enum type_check la_type_check
;
187 /* Default case sensitivity */
188 enum case_sensitivity la_case_sensitivity
;
190 /* Definitions related to expression printing, prefixifying, and
193 const struct exp_descriptor
*la_exp_desc
;
195 /* Parser function. */
197 int (*la_parser
) (void);
199 /* Parser error function */
201 void (*la_error
) (char *);
203 /* Given an expression *EXPP created by prefixifying the result of
204 la_parser, perform any remaining processing necessary to complete
205 its translation. *EXPP may change; la_post_parser is responsible
206 for releasing its previous contents, if necessary. If
207 VOID_CONTEXT_P, then no value is expected from the expression. */
209 void (*la_post_parser
) (struct expression
** expp
, int void_context_p
);
211 void (*la_printchar
) (int ch
, struct ui_file
* stream
);
213 void (*la_printstr
) (struct ui_file
* stream
, char *string
,
214 unsigned int length
, int width
,
217 void (*la_emitchar
) (int ch
, struct ui_file
* stream
, int quoter
);
219 struct type
*(*la_fund_type
) (struct objfile
*, int);
221 /* Print a type using syntax appropriate for this language. */
223 void (*la_print_type
) (struct type
*, char *, struct ui_file
*, int,
226 /* Print a value using syntax appropriate for this language. */
228 int (*la_val_print
) (struct type
*, char *, int, CORE_ADDR
,
229 struct ui_file
*, int, int, int,
230 enum val_prettyprint
);
232 /* Print a top-level value using syntax appropriate for this language. */
234 int (*la_value_print
) (struct value
*, struct ui_file
*,
235 int, enum val_prettyprint
);
237 /* PC is possibly an unknown languages trampoline.
238 If that PC falls in a trampoline belonging to this language,
239 return the address of the first pc in the real function, or 0
240 if it isn't a language tramp for this language. */
241 CORE_ADDR (*skip_trampoline
) (CORE_ADDR pc
);
243 /* Now come some hooks for lookup_symbol. */
245 /* If this is non-NULL, lookup_symbol will do the 'field_of_this'
246 check, using this function to find the value of this. */
248 /* FIXME: carlton/2003-05-19: Audit all the language_defn structs
249 to make sure we're setting this appropriately: I'm sure it
250 could be NULL in more languages. */
252 struct value
*(*la_value_of_this
) (int complain
);
254 /* This is a function that lookup_symbol will call when it gets to
255 the part of symbol lookup where C looks up static and global
258 struct symbol
*(*la_lookup_symbol_nonlocal
) (const char *,
260 const struct block
*,
264 /* Find the definition of the type with the given name. */
265 struct type
*(*la_lookup_transparent_type
) (const char *);
267 /* Return demangled language symbol, or NULL. */
268 char *(*la_demangle
) (const char *mangled
, int options
);
270 /* Return class name of a mangled method name or NULL. */
271 char *(*la_class_name_from_physname
) (const char *physname
);
273 /* Base 2 (binary) formats. */
275 struct language_format_info la_binary_format
;
277 /* Base 8 (octal) formats. */
279 struct language_format_info la_octal_format
;
281 /* Base 10 (decimal) formats */
283 struct language_format_info la_decimal_format
;
285 /* Base 16 (hexadecimal) formats */
287 struct language_format_info la_hex_format
;
289 /* Table for printing expressions */
291 const struct op_print
*la_op_print_tab
;
293 /* Zero if the language has first-class arrays. True if there are no
294 array values, and array objects decay to pointers, as in C. */
298 /* Index to use for extracting the first element of a string. */
299 char string_lower_bound
;
301 /* Type of elements of strings. */
302 struct type
**string_char_type
;
304 /* The list of characters forming word boundaries. */
305 char *(*la_word_break_characters
) (void);
307 /* The per-architecture (OS/ABI) language information. */
308 void (*la_language_arch_info
) (struct gdbarch
*,
309 struct language_arch_info
*);
311 /* Add fields above this point, so the magic number is always last. */
312 /* Magic number for compat checking */
318 #define LANG_MAGIC 910823L
320 /* Pointer to the language_defn for our current language. This pointer
321 always points to *some* valid struct; it can be used without checking
324 The current language affects expression parsing and evaluation
325 (FIXME: it might be cleaner to make the evaluation-related stuff
326 separate exp_opcodes for each different set of semantics. We
327 should at least think this through more clearly with respect to
328 what happens if the language is changed between parsing and
329 evaluation) and printing of things like types and arrays. It does
330 *not* affect symbol-reading-- each source file in a symbol-file has
331 its own language and we should keep track of that regardless of the
332 language when symbols are read. If we want some manual setting for
333 the language of symbol files (e.g. detecting when ".c" files are
334 C++), it should be a separate setting from the current_language. */
336 extern const struct language_defn
*current_language
;
338 /* Pointer to the language_defn expected by the user, e.g. the language
339 of main(), or the language we last mentioned in a message, or C. */
341 extern const struct language_defn
*expected_language
;
344 language_mode_auto: current_language automatically set upon selection
345 of scope (e.g. stack frame)
346 language_mode_manual: current_language set only by user. */
348 extern enum language_mode
350 language_mode_auto
, language_mode_manual
354 /* These macros define the behaviour of the expression
357 /* Should we strictly type check expressions? */
358 #define STRICT_TYPE (type_check != type_check_off)
360 /* Should we range check values against the domain of their type? */
361 #define RANGE_CHECK (range_check != range_check_off)
363 /* "cast" really means conversion */
364 /* FIXME -- should be a setting in language_defn */
365 #define CAST_IS_CONVERSION (current_language->la_language == language_c || \
366 current_language->la_language == language_cplus || \
367 current_language->la_language == language_objc)
369 extern void language_info (int);
371 extern enum language
set_language (enum language
);
374 /* This page contains functions that return things that are
375 specific to languages. Each of these functions is based on
376 the current setting of working_lang, which the user sets
377 with the "set language" command. */
379 #define create_fundamental_type(objfile,typeid) \
380 (current_language->la_fund_type(objfile, typeid))
382 #define LA_PRINT_TYPE(type,varstring,stream,show,level) \
383 (current_language->la_print_type(type,varstring,stream,show,level))
385 #define LA_VAL_PRINT(type,valaddr,offset,addr,stream,fmt,deref,recurse,pretty) \
386 (current_language->la_val_print(type,valaddr,offset,addr,stream,fmt,deref, \
388 #define LA_VALUE_PRINT(val,stream,fmt,pretty) \
389 (current_language->la_value_print(val,stream,fmt,pretty))
391 /* Return a format string for printf that will print a number in one of
392 the local (language-specific) formats. Result is static and is
393 overwritten by the next call. Takes printf options like "08" or "l"
394 (to produce e.g. %08x or %lx). */
396 #define local_binary_format() \
397 (current_language->la_binary_format.la_format)
398 #define local_binary_format_prefix() \
399 (current_language->la_binary_format.la_format_prefix)
400 #define local_binary_format_specifier() \
401 (current_language->la_binary_format.la_format_specifier)
402 #define local_binary_format_suffix() \
403 (current_language->la_binary_format.la_format_suffix)
405 #define local_octal_format() \
406 (current_language->la_octal_format.la_format)
407 #define local_octal_format_prefix() \
408 (current_language->la_octal_format.la_format_prefix)
409 #define local_octal_format_specifier() \
410 (current_language->la_octal_format.la_format_specifier)
411 #define local_octal_format_suffix() \
412 (current_language->la_octal_format.la_format_suffix)
414 #define local_decimal_format() \
415 (current_language->la_decimal_format.la_format)
416 #define local_decimal_format_prefix() \
417 (current_language->la_decimal_format.la_format_prefix)
418 #define local_decimal_format_specifier() \
419 (current_language->la_decimal_format.la_format_specifier)
420 #define local_decimal_format_suffix() \
421 (current_language->la_decimal_format.la_format_suffix)
423 #define local_hex_format() \
424 (current_language->la_hex_format.la_format)
425 #define local_hex_format_prefix() \
426 (current_language->la_hex_format.la_format_prefix)
427 #define local_hex_format_specifier() \
428 (current_language->la_hex_format.la_format_specifier)
429 #define local_hex_format_suffix() \
430 (current_language->la_hex_format.la_format_suffix)
432 #define LA_PRINT_CHAR(ch, stream) \
433 (current_language->la_printchar(ch, stream))
434 #define LA_PRINT_STRING(stream, string, length, width, force_ellipses) \
435 (current_language->la_printstr(stream, string, length, width, force_ellipses))
436 #define LA_EMIT_CHAR(ch, stream, quoter) \
437 (current_language->la_emitchar(ch, stream, quoter))
439 /* Test a character to decide whether it can be printed in literal form
440 or needs to be printed in another representation. For example,
441 in C the literal form of the character with octal value 141 is 'a'
442 and the "other representation" is '\141'. The "other representation"
443 is program language dependent. */
445 #define PRINT_LITERAL_FORM(c) \
447 && ((c) < 0x7F || (c) >= 0xA0) \
448 && (!sevenbit_strings || (c) < 0x80))
450 /* Return a format string for printf that will print a number in one of
451 the local (language-specific) formats. Result is static and is
452 overwritten by the next call. Takes printf options like "08" or "l"
453 (to produce e.g. %08x or %lx). */
455 extern char *local_decimal_format_custom (char *); /* language.c */
457 extern char *local_octal_format_custom (char *); /* language.c */
459 extern char *local_hex_format_custom (char *); /* language.c */
462 /* FIXME: cagney/2000-03-04: This function does not appear to be used.
463 It can be deleted once 5.0 has been released. */
464 /* Return a string that contains the hex digits of the number. No preceeding
467 extern char *longest_raw_hex_string (LONGEST
);
470 /* Return a string that contains a number formatted in one of the local
471 (language-specific) formats. Result is static and is overwritten by
472 the next call. Takes printf options like "08l" or "l". */
474 extern char *local_hex_string (LONGEST
); /* language.c */
476 extern char *local_hex_string_custom (LONGEST
, char *); /* language.c */
478 /* Type predicates */
480 extern int simple_type (struct type
*);
482 extern int ordered_type (struct type
*);
484 extern int same_type (struct type
*, struct type
*);
486 extern int integral_type (struct type
*);
488 extern int numeric_type (struct type
*);
490 extern int character_type (struct type
*);
492 extern int boolean_type (struct type
*);
494 extern int float_type (struct type
*);
496 extern int pointer_type (struct type
*);
498 extern int structured_type (struct type
*);
500 /* Checks Binary and Unary operations for semantic type correctness */
501 /* FIXME: Does not appear to be used */
502 #define unop_type_check(v,o) binop_type_check((v),NULL,(o))
504 extern void binop_type_check (struct value
*, struct value
*, int);
508 extern void op_error (const char *lhs
, enum exp_opcode
,
511 extern void type_error (const char *, ...) ATTR_FORMAT (printf
, 1, 2);
513 extern void range_error (const char *, ...) ATTR_FORMAT (printf
, 1, 2);
515 /* Data: Does this value represent "truth" to the current language? */
517 extern int value_true (struct value
*);
519 extern struct type
*lang_bool_type (void);
521 /* The type used for Boolean values in the current language. */
522 #define LA_BOOL_TYPE lang_bool_type ()
524 /* Misc: The string representing a particular enum language. */
526 extern enum language
language_enum (char *str
);
528 extern const struct language_defn
*language_def (enum language
);
530 extern char *language_str (enum language
);
532 /* Add a language to the set known by GDB (at initialization time). */
534 extern void add_language (const struct language_defn
*);
536 extern enum language
get_frame_language (void); /* In stack.c */
538 /* Check for a language-specific trampoline. */
540 extern CORE_ADDR
skip_language_trampoline (CORE_ADDR pc
);
542 /* Return demangled language symbol, or NULL. */
543 extern char *language_demangle (const struct language_defn
*current_language
,
544 const char *mangled
, int options
);
546 /* Return class name from physname, or NULL. */
547 extern char *language_class_name_from_physname (const struct language_defn
*,
548 const char *physname
);
550 /* Splitting strings into words. */
551 extern char *default_word_break_characters (void);
553 #endif /* defined (LANGUAGE_H) */