1 /* Source-language-related definitions for GDB.
3 Copyright 1991, 1992, 1993, 1994, 1995, 1998, 1999, 2000, 2003 Free
4 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 /* Structure tying together assorted information about a language. */
144 /* Name of the language */
148 /* its symtab language-enum (defs.h) */
150 enum language la_language;
152 /* Its builtin types. This is a vector ended by a NULL pointer. These
153 types can be specified by name in parsing types in expressions,
154 regardless of whether the program being debugged actually defines
157 struct type **const *la_builtin_type_vector;
159 /* Default range checking */
161 enum range_check la_range_check;
163 /* Default type checking */
165 enum type_check la_type_check;
167 /* Default case sensitivity */
168 enum case_sensitivity la_case_sensitivity;
170 /* Definitions related to expression printing, prefixifying, and
173 const struct exp_descriptor *la_exp_desc;
175 /* Parser function. */
177 int (*la_parser) (void);
179 /* Parser error function */
181 void (*la_error) (char *);
183 void (*la_printchar) (int ch, struct ui_file * stream);
185 void (*la_printstr) (struct ui_file * stream, char *string,
186 unsigned int length, int width,
189 void (*la_emitchar) (int ch, struct ui_file * stream, int quoter);
191 struct type *(*la_fund_type) (struct objfile *, int);
193 /* Print a type using syntax appropriate for this language. */
195 void (*la_print_type) (struct type *, char *, struct ui_file *, int,
198 /* Print a value using syntax appropriate for this language. */
200 int (*la_val_print) (struct type *, char *, int, CORE_ADDR,
201 struct ui_file *, int, int, int,
202 enum val_prettyprint);
204 /* Print a top-level value using syntax appropriate for this language. */
206 int (*la_value_print) (struct value *, struct ui_file *,
207 int, enum val_prettyprint);
209 /* PC is possibly an unknown languages trampoline.
210 If that PC falls in a trampoline belonging to this language,
211 return the address of the first pc in the real function, or 0
212 if it isn't a language tramp for this language. */
213 CORE_ADDR (*skip_trampoline) (CORE_ADDR pc);
215 /* Now come some hooks for lookup_symbol. */
217 /* If this is non-NULL, lookup_symbol will do the 'field_of_this'
218 check, using this function to find the value of this. */
220 /* FIXME: carlton/2003-05-19: Audit all the language_defn structs
221 to make sure we're setting this appropriately: I'm sure it
222 could be NULL in more languages. */
224 struct value *(*la_value_of_this) (int complain);
226 /* This is a function that lookup_symbol will call when it gets to
227 the part of symbol lookup where C looks up static and global
230 struct symbol *(*la_lookup_symbol_nonlocal) (const char *,
232 const struct block *,
236 /* Return demangled language symbol, or NULL. */
237 char *(*la_demangle) (const char *mangled, int options);
239 /* Base 2 (binary) formats. */
241 struct language_format_info la_binary_format;
243 /* Base 8 (octal) formats. */
245 struct language_format_info la_octal_format;
247 /* Base 10 (decimal) formats */
249 struct language_format_info la_decimal_format;
251 /* Base 16 (hexadecimal) formats */
253 struct language_format_info la_hex_format;
255 /* Table for printing expressions */
257 const struct op_print *la_op_print_tab;
259 /* Zero if the language has first-class arrays. True if there are no
260 array values, and array objects decay to pointers, as in C. */
264 /* Index to use for extracting the first element of a string. */
265 char string_lower_bound;
267 /* Type of elements of strings. */
268 struct type **string_char_type;
270 /* Add fields above this point, so the magic number is always last. */
271 /* Magic number for compat checking */
277 #define LANG_MAGIC 910823L
279 /* Pointer to the language_defn for our current language. This pointer
280 always points to *some* valid struct; it can be used without checking
283 The current language affects expression parsing and evaluation
284 (FIXME: it might be cleaner to make the evaluation-related stuff
285 separate exp_opcodes for each different set of semantics. We
286 should at least think this through more clearly with respect to
287 what happens if the language is changed between parsing and
288 evaluation) and printing of things like types and arrays. It does
289 *not* affect symbol-reading-- each source file in a symbol-file has
290 its own language and we should keep track of that regardless of the
291 language when symbols are read. If we want some manual setting for
292 the language of symbol files (e.g. detecting when ".c" files are
293 C++), it should be a separate setting from the current_language. */
295 extern const struct language_defn *current_language;
297 /* Pointer to the language_defn expected by the user, e.g. the language
298 of main(), or the language we last mentioned in a message, or C. */
300 extern const struct language_defn *expected_language;
303 language_mode_auto: current_language automatically set upon selection
304 of scope (e.g. stack frame)
305 language_mode_manual: current_language set only by user. */
307 extern enum language_mode
309 language_mode_auto, language_mode_manual
313 /* These macros define the behaviour of the expression
316 /* Should we strictly type check expressions? */
317 #define STRICT_TYPE (type_check != type_check_off)
319 /* Should we range check values against the domain of their type? */
320 #define RANGE_CHECK (range_check != range_check_off)
322 /* "cast" really means conversion */
323 /* FIXME -- should be a setting in language_defn */
324 #define CAST_IS_CONVERSION (current_language->la_language == language_c || \
325 current_language->la_language == language_cplus || \
326 current_language->la_language == language_objc)
328 extern void language_info (int);
330 extern enum language set_language (enum language);
333 /* This page contains functions that return things that are
334 specific to languages. Each of these functions is based on
335 the current setting of working_lang, which the user sets
336 with the "set language" command. */
338 #define create_fundamental_type(objfile,typeid) \
339 (current_language->la_fund_type(objfile, typeid))
341 #define LA_PRINT_TYPE(type,varstring,stream,show,level) \
342 (current_language->la_print_type(type,varstring,stream,show,level))
344 #define LA_VAL_PRINT(type,valaddr,offset,addr,stream,fmt,deref,recurse,pretty) \
345 (current_language->la_val_print(type,valaddr,offset,addr,stream,fmt,deref, \
347 #define LA_VALUE_PRINT(val,stream,fmt,pretty) \
348 (current_language->la_value_print(val,stream,fmt,pretty))
350 /* Return a format string for printf that will print a number in one of
351 the local (language-specific) formats. Result is static and is
352 overwritten by the next call. Takes printf options like "08" or "l"
353 (to produce e.g. %08x or %lx). */
355 #define local_binary_format() \
356 (current_language->la_binary_format.la_format)
357 #define local_binary_format_prefix() \
358 (current_language->la_binary_format.la_format_prefix)
359 #define local_binary_format_specifier() \
360 (current_language->la_binary_format.la_format_specifier)
361 #define local_binary_format_suffix() \
362 (current_language->la_binary_format.la_format_suffix)
364 #define local_octal_format() \
365 (current_language->la_octal_format.la_format)
366 #define local_octal_format_prefix() \
367 (current_language->la_octal_format.la_format_prefix)
368 #define local_octal_format_specifier() \
369 (current_language->la_octal_format.la_format_specifier)
370 #define local_octal_format_suffix() \
371 (current_language->la_octal_format.la_format_suffix)
373 #define local_decimal_format() \
374 (current_language->la_decimal_format.la_format)
375 #define local_decimal_format_prefix() \
376 (current_language->la_decimal_format.la_format_prefix)
377 #define local_decimal_format_specifier() \
378 (current_language->la_decimal_format.la_format_specifier)
379 #define local_decimal_format_suffix() \
380 (current_language->la_decimal_format.la_format_suffix)
382 #define local_hex_format() \
383 (current_language->la_hex_format.la_format)
384 #define local_hex_format_prefix() \
385 (current_language->la_hex_format.la_format_prefix)
386 #define local_hex_format_specifier() \
387 (current_language->la_hex_format.la_format_specifier)
388 #define local_hex_format_suffix() \
389 (current_language->la_hex_format.la_format_suffix)
391 #define LA_PRINT_CHAR(ch, stream) \
392 (current_language->la_printchar(ch, stream))
393 #define LA_PRINT_STRING(stream, string, length, width, force_ellipses) \
394 (current_language->la_printstr(stream, string, length, width, force_ellipses))
395 #define LA_EMIT_CHAR(ch, stream, quoter) \
396 (current_language->la_emitchar(ch, stream, quoter))
398 /* Test a character to decide whether it can be printed in literal form
399 or needs to be printed in another representation. For example,
400 in C the literal form of the character with octal value 141 is 'a'
401 and the "other representation" is '\141'. The "other representation"
402 is program language dependent. */
404 #define PRINT_LITERAL_FORM(c) \
406 && ((c) < 0x7F || (c) >= 0xA0) \
407 && (!sevenbit_strings || (c) < 0x80))
409 /* Return a format string for printf that will print a number in one of
410 the local (language-specific) formats. Result is static and is
411 overwritten by the next call. Takes printf options like "08" or "l"
412 (to produce e.g. %08x or %lx). */
414 extern char *local_decimal_format_custom (char *); /* language.c */
416 extern char *local_octal_format_custom (char *); /* language.c */
418 extern char *local_hex_format_custom (char *); /* language.c */
421 /* FIXME: cagney/2000-03-04: This function does not appear to be used.
422 It can be deleted once 5.0 has been released. */
423 /* Return a string that contains the hex digits of the number. No preceeding
426 extern char *longest_raw_hex_string (LONGEST);
429 /* Return a string that contains a number formatted in one of the local
430 (language-specific) formats. Result is static and is overwritten by
431 the next call. Takes printf options like "08l" or "l". */
433 extern char *local_hex_string (LONGEST); /* language.c */
435 extern char *local_hex_string_custom (LONGEST, char *); /* language.c */
437 /* Type predicates */
439 extern int simple_type (struct type *);
441 extern int ordered_type (struct type *);
443 extern int same_type (struct type *, struct type *);
445 extern int integral_type (struct type *);
447 extern int numeric_type (struct type *);
449 extern int character_type (struct type *);
451 extern int boolean_type (struct type *);
453 extern int float_type (struct type *);
455 extern int pointer_type (struct type *);
457 extern int structured_type (struct type *);
459 /* Checks Binary and Unary operations for semantic type correctness */
460 /* FIXME: Does not appear to be used */
461 #define unop_type_check(v,o) binop_type_check((v),NULL,(o))
463 extern void binop_type_check (struct value *, struct value *, int);
467 extern void op_error (const char *lhs, enum exp_opcode,
470 extern void type_error (const char *, ...) ATTR_FORMAT (printf, 1, 2);
472 extern void range_error (const char *, ...) ATTR_FORMAT (printf, 1, 2);
474 /* Data: Does this value represent "truth" to the current language? */
476 extern int value_true (struct value *);
478 extern struct type *lang_bool_type (void);
480 /* The type used for Boolean values in the current language. */
481 #define LA_BOOL_TYPE lang_bool_type ()
483 /* Misc: The string representing a particular enum language. */
485 extern enum language language_enum (char *str);
487 extern const struct language_defn *language_def (enum language);
489 extern char *language_str (enum language);
491 /* Add a language to the set known by GDB (at initialization time). */
493 extern void add_language (const struct language_defn *);
495 extern enum language get_frame_language (void); /* In stack.c */
497 /* Check for a language-specific trampoline. */
499 extern CORE_ADDR skip_language_trampoline (CORE_ADDR pc);
501 /* Return demangled language symbol, or NULL. */
502 extern char *language_demangle (const struct language_defn *current_language,
503 const char *mangled, int options);
505 #endif /* defined (LANGUAGE_H) */