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 */
33 /* enum exp_opcode; ANSI's `wisdom' didn't include forward enum decls. */
35 /* This used to be included to configure GDB for one or more specific
36 languages. Now it is left out to configure for all of them. FIXME. */
37 /* #include "lang_def.h" */
43 #define MAX_FORTRAN_DIMS 7 /* Maximum number of F77 array dims */
46 range_mode_auto: range_check set automatically to default of language.
47 range_mode_manual: range_check set manually by user. */
49 extern enum range_mode
51 range_mode_auto
, range_mode_manual
56 range_check_on: Ranges are checked in GDB expressions, producing errors.
57 range_check_warn: Ranges are checked, producing warnings.
58 range_check_off: Ranges are not checked in GDB expressions. */
60 extern enum range_check
62 range_check_off
, range_check_warn
, range_check_on
67 type_mode_auto: type_check set automatically to default of language
68 type_mode_manual: type_check set manually by user. */
72 type_mode_auto
, type_mode_manual
77 type_check_on: Types are checked in GDB expressions, producing errors.
78 type_check_warn: Types are checked, producing warnings.
79 type_check_off: Types are not checked in GDB expressions. */
81 extern enum type_check
83 type_check_off
, type_check_warn
, type_check_on
88 case_mode_auto: case_sensitivity set upon selection of scope
89 case_mode_manual: case_sensitivity set only by user. */
93 case_mode_auto
, case_mode_manual
97 /* case_sensitivity ==
98 case_sensitive_on: Case sensitivity in name matching is used
99 case_sensitive_off: Case sensitivity in name matching is not used */
101 extern enum case_sensitivity
103 case_sensitive_on
, case_sensitive_off
107 /* Information for doing language dependent formatting of printed values. */
109 struct language_format_info
111 /* The format that can be passed directly to standard C printf functions
112 to generate a completely formatted value in the format appropriate for
117 /* The prefix to be used when directly printing a value, or constructing
118 a standard C printf format. This generally is everything up to the
119 conversion specification (the part introduced by the '%' character
120 and terminated by the conversion specifier character). */
122 char *la_format_prefix
;
124 /* The conversion specifier. This is generally everything after the
125 field width and precision, typically only a single character such
126 as 'o' for octal format or 'x' for hexadecimal format. */
128 char *la_format_specifier
;
130 /* The suffix to be used when directly printing a value, or constructing
131 a standard C printf format. This generally is everything after the
132 conversion specification (the part introduced by the '%' character
133 and terminated by the conversion specifier character). */
135 char *la_format_suffix
; /* Suffix for custom format string */
138 /* Structure tying together assorted information about a language. */
142 /* Name of the language */
146 /* its symtab language-enum (defs.h) */
148 enum language la_language
;
150 /* Its builtin types. This is a vector ended by a NULL pointer. These
151 types can be specified by name in parsing types in expressions,
152 regardless of whether the program being debugged actually defines
155 struct type
**const *la_builtin_type_vector
;
157 /* Default range checking */
159 enum range_check la_range_check
;
161 /* Default type checking */
163 enum type_check la_type_check
;
165 /* Default case sensitivity */
166 enum case_sensitivity la_case_sensitivity
;
168 /* Parser function. */
170 int (*la_parser
) (void);
172 /* Parser error function */
174 void (*la_error
) (char *);
176 /* Evaluate an expression. */
177 struct value
*(*evaluate_exp
) (struct type
*, struct expression
*,
180 void (*la_printchar
) (int ch
, struct ui_file
* stream
);
182 void (*la_printstr
) (struct ui_file
* stream
, char *string
,
183 unsigned int length
, int width
,
186 void (*la_emitchar
) (int ch
, struct ui_file
* stream
, int quoter
);
188 struct type
*(*la_fund_type
) (struct objfile
*, int);
190 /* Print a type using syntax appropriate for this language. */
192 void (*la_print_type
) (struct type
*, char *, struct ui_file
*, int,
195 /* Print a value using syntax appropriate for this language. */
197 int (*la_val_print
) (struct type
*, char *, int, CORE_ADDR
,
198 struct ui_file
*, int, int, int,
199 enum val_prettyprint
);
201 /* Print a top-level value using syntax appropriate for this language. */
203 int (*la_value_print
) (struct value
*, struct ui_file
*,
204 int, enum val_prettyprint
);
206 /* PC is possibly an unknown languages trampoline.
207 If that PC falls in a trampoline belonging to this language,
208 return the address of the first pc in the real function, or 0
209 if it isn't a language tramp for this language. */
210 CORE_ADDR (*skip_trampoline
) (CORE_ADDR pc
);
212 /* Return demangled language symbol, or NULL. */
213 char *(*la_demangle
) (const char *mangled
, int options
);
215 /* Base 2 (binary) formats. */
217 struct language_format_info la_binary_format
;
219 /* Base 8 (octal) formats. */
221 struct language_format_info la_octal_format
;
223 /* Base 10 (decimal) formats */
225 struct language_format_info la_decimal_format
;
227 /* Base 16 (hexadecimal) formats */
229 struct language_format_info la_hex_format
;
231 /* Table for printing expressions */
233 const struct op_print
*la_op_print_tab
;
235 /* Zero if the language has first-class arrays. True if there are no
236 array values, and array objects decay to pointers, as in C. */
240 /* Index to use for extracting the first element of a string. */
241 char string_lower_bound
;
243 /* Type of elements of strings. */
244 struct type
**string_char_type
;
246 /* Add fields above this point, so the magic number is always last. */
247 /* Magic number for compat checking */
253 #define LANG_MAGIC 910823L
255 /* Pointer to the language_defn for our current language. This pointer
256 always points to *some* valid struct; it can be used without checking
259 The current language affects expression parsing and evaluation
260 (FIXME: it might be cleaner to make the evaluation-related stuff
261 separate exp_opcodes for each different set of semantics. We
262 should at least think this through more clearly with respect to
263 what happens if the language is changed between parsing and
264 evaluation) and printing of things like types and arrays. It does
265 *not* affect symbol-reading-- each source file in a symbol-file has
266 its own language and we should keep track of that regardless of the
267 language when symbols are read. If we want some manual setting for
268 the language of symbol files (e.g. detecting when ".c" files are
269 C++), it should be a separate setting from the current_language. */
271 extern const struct language_defn
*current_language
;
273 /* Pointer to the language_defn expected by the user, e.g. the language
274 of main(), or the language we last mentioned in a message, or C. */
276 extern const struct language_defn
*expected_language
;
279 language_mode_auto: current_language automatically set upon selection
280 of scope (e.g. stack frame)
281 language_mode_manual: current_language set only by user. */
283 extern enum language_mode
285 language_mode_auto
, language_mode_manual
289 /* These macros define the behaviour of the expression
292 /* Should we strictly type check expressions? */
293 #define STRICT_TYPE (type_check != type_check_off)
295 /* Should we range check values against the domain of their type? */
296 #define RANGE_CHECK (range_check != range_check_off)
298 /* "cast" really means conversion */
299 /* FIXME -- should be a setting in language_defn */
300 #define CAST_IS_CONVERSION (current_language->la_language == language_c || \
301 current_language->la_language == language_cplus || \
302 current_language->la_language == language_objc)
304 extern void language_info (int);
306 extern enum language
set_language (enum language
);
309 /* This page contains functions that return things that are
310 specific to languages. Each of these functions is based on
311 the current setting of working_lang, which the user sets
312 with the "set language" command. */
314 #define create_fundamental_type(objfile,typeid) \
315 (current_language->la_fund_type(objfile, typeid))
317 #define LA_PRINT_TYPE(type,varstring,stream,show,level) \
318 (current_language->la_print_type(type,varstring,stream,show,level))
320 #define LA_VAL_PRINT(type,valaddr,offset,addr,stream,fmt,deref,recurse,pretty) \
321 (current_language->la_val_print(type,valaddr,offset,addr,stream,fmt,deref, \
323 #define LA_VALUE_PRINT(val,stream,fmt,pretty) \
324 (current_language->la_value_print(val,stream,fmt,pretty))
326 /* Return a format string for printf that will print a number in one of
327 the local (language-specific) formats. Result is static and is
328 overwritten by the next call. Takes printf options like "08" or "l"
329 (to produce e.g. %08x or %lx). */
331 #define local_binary_format() \
332 (current_language->la_binary_format.la_format)
333 #define local_binary_format_prefix() \
334 (current_language->la_binary_format.la_format_prefix)
335 #define local_binary_format_specifier() \
336 (current_language->la_binary_format.la_format_specifier)
337 #define local_binary_format_suffix() \
338 (current_language->la_binary_format.la_format_suffix)
340 #define local_octal_format() \
341 (current_language->la_octal_format.la_format)
342 #define local_octal_format_prefix() \
343 (current_language->la_octal_format.la_format_prefix)
344 #define local_octal_format_specifier() \
345 (current_language->la_octal_format.la_format_specifier)
346 #define local_octal_format_suffix() \
347 (current_language->la_octal_format.la_format_suffix)
349 #define local_decimal_format() \
350 (current_language->la_decimal_format.la_format)
351 #define local_decimal_format_prefix() \
352 (current_language->la_decimal_format.la_format_prefix)
353 #define local_decimal_format_specifier() \
354 (current_language->la_decimal_format.la_format_specifier)
355 #define local_decimal_format_suffix() \
356 (current_language->la_decimal_format.la_format_suffix)
358 #define local_hex_format() \
359 (current_language->la_hex_format.la_format)
360 #define local_hex_format_prefix() \
361 (current_language->la_hex_format.la_format_prefix)
362 #define local_hex_format_specifier() \
363 (current_language->la_hex_format.la_format_specifier)
364 #define local_hex_format_suffix() \
365 (current_language->la_hex_format.la_format_suffix)
367 #define LA_PRINT_CHAR(ch, stream) \
368 (current_language->la_printchar(ch, stream))
369 #define LA_PRINT_STRING(stream, string, length, width, force_ellipses) \
370 (current_language->la_printstr(stream, string, length, width, force_ellipses))
371 #define LA_EMIT_CHAR(ch, stream, quoter) \
372 (current_language->la_emitchar(ch, stream, quoter))
374 /* Test a character to decide whether it can be printed in literal form
375 or needs to be printed in another representation. For example,
376 in C the literal form of the character with octal value 141 is 'a'
377 and the "other representation" is '\141'. The "other representation"
378 is program language dependent. */
380 #define PRINT_LITERAL_FORM(c) \
382 && ((c) < 0x7F || (c) >= 0xA0) \
383 && (!sevenbit_strings || (c) < 0x80))
385 /* Return a format string for printf that will print a number in one of
386 the local (language-specific) formats. Result is static and is
387 overwritten by the next call. Takes printf options like "08" or "l"
388 (to produce e.g. %08x or %lx). */
390 extern char *local_decimal_format_custom (char *); /* language.c */
392 extern char *local_octal_format_custom (char *); /* language.c */
394 extern char *local_hex_format_custom (char *); /* language.c */
397 /* FIXME: cagney/2000-03-04: This function does not appear to be used.
398 It can be deleted once 5.0 has been released. */
399 /* Return a string that contains the hex digits of the number. No preceeding
402 extern char *longest_raw_hex_string (LONGEST
);
405 /* Return a string that contains a number formatted in one of the local
406 (language-specific) formats. Result is static and is overwritten by
407 the next call. Takes printf options like "08l" or "l". */
409 extern char *local_hex_string (LONGEST
); /* language.c */
411 extern char *local_hex_string_custom (LONGEST
, char *); /* language.c */
413 /* Type predicates */
415 extern int simple_type (struct type
*);
417 extern int ordered_type (struct type
*);
419 extern int same_type (struct type
*, struct type
*);
421 extern int integral_type (struct type
*);
423 extern int numeric_type (struct type
*);
425 extern int character_type (struct type
*);
427 extern int boolean_type (struct type
*);
429 extern int float_type (struct type
*);
431 extern int pointer_type (struct type
*);
433 extern int structured_type (struct type
*);
435 /* Checks Binary and Unary operations for semantic type correctness */
436 /* FIXME: Does not appear to be used */
437 #define unop_type_check(v,o) binop_type_check((v),NULL,(o))
439 extern void binop_type_check (struct value
*, struct value
*, int);
443 extern void op_error (char *fmt
, enum exp_opcode
, int);
445 #define type_op_error(f,o) \
446 op_error((f),(o),type_check==type_check_on ? 1 : 0)
447 #define range_op_error(f,o) \
448 op_error((f),(o),range_check==range_check_on ? 1 : 0)
450 extern void type_error (const char *, ...) ATTR_FORMAT (printf
, 1, 2);
452 extern void range_error (const char *, ...) ATTR_FORMAT (printf
, 1, 2);
454 /* Data: Does this value represent "truth" to the current language? */
456 extern int value_true (struct value
*);
458 extern struct type
*lang_bool_type (void);
460 /* The type used for Boolean values in the current language. */
461 #define LA_BOOL_TYPE lang_bool_type ()
463 /* Misc: The string representing a particular enum language. */
465 extern enum language
language_enum (char *str
);
467 extern const struct language_defn
*language_def (enum language
);
469 extern char *language_str (enum language
);
471 /* Add a language to the set known by GDB (at initialization time). */
473 extern void add_language (const struct language_defn
*);
475 extern enum language
get_frame_language (void); /* In stack.c */
477 /* Check for a language-specific trampoline. */
479 extern CORE_ADDR
skip_language_trampoline (CORE_ADDR pc
);
481 /* Return demangled language symbol, or NULL. */
482 extern char *language_demangle (const struct language_defn
*current_language
,
483 const char *mangled
, int options
);
485 #endif /* defined (LANGUAGE_H) */