1 /* Source-language-related definitions for GDB.
2 Copyright 1991, 1992 Free Software Foundation, Inc.
3 Contributed by the Department of Computer Science at the State University
4 of New York at Buffalo.
6 This file is part of GDB.
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 2 of the License, or
11 (at your option) any later version.
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.
18 You should have received a copy of the GNU General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, Inc., 59 Temple Place - Suite 330,
21 Boston, MA 02111-1307, USA. */
23 #if !defined (LANGUAGE_H)
26 /* Forward decls for prototypes */
30 /* enum exp_opcode; ANSI's `wisdom' didn't include forward enum decls. */
32 /* This used to be included to configure GDB for one or more specific
33 languages. Now it is shortcutted to configure for all of them. FIXME. */
34 /* #include "lang_def.h" */
40 #define MAX_FORTRAN_DIMS 7 /* Maximum number of F77 array dims */
43 range_mode_auto: range_check set automatically to default of language.
44 range_mode_manual: range_check set manually by user. */
46 extern enum range_mode
48 range_mode_auto
, range_mode_manual
53 range_check_on: Ranges are checked in GDB expressions, producing errors.
54 range_check_warn: Ranges are checked, producing warnings.
55 range_check_off: Ranges are not checked in GDB expressions. */
57 extern enum range_check
59 range_check_off
, range_check_warn
, range_check_on
64 type_mode_auto: type_check set automatically to default of language
65 type_mode_manual: type_check set manually by user. */
69 type_mode_auto
, type_mode_manual
74 type_check_on: Types are checked in GDB expressions, producing errors.
75 type_check_warn: Types are checked, producing warnings.
76 type_check_off: Types are not checked in GDB expressions. */
78 extern enum type_check
80 type_check_off
, type_check_warn
, type_check_on
84 /* Information for doing language dependent formatting of printed values. */
86 struct language_format_info
88 /* The format that can be passed directly to standard C printf functions
89 to generate a completely formatted value in the format appropriate for
94 /* The prefix to be used when directly printing a value, or constructing
95 a standard C printf format. This generally is everything up to the
96 conversion specification (the part introduced by the '%' character
97 and terminated by the conversion specifier character). */
99 char *la_format_prefix
;
101 /* The conversion specifier. This is generally everything after the
102 field width and precision, typically only a single character such
103 as 'o' for octal format or 'x' for hexadecimal format. */
105 char *la_format_specifier
;
107 /* The suffix to be used when directly printing a value, or constructing
108 a standard C printf format. This generally is everything after the
109 conversion specification (the part introduced by the '%' character
110 and terminated by the conversion specifier character). */
112 char *la_format_suffix
; /* Suffix for custom format string */
115 /* Structure tying together assorted information about a language. */
119 /* Name of the language */
123 /* its symtab language-enum (defs.h) */
125 enum language la_language
;
127 /* Its builtin types. This is a vector ended by a NULL pointer. These
128 types can be specified by name in parsing types in expressions,
129 regardless of whether the program being debugged actually defines
132 struct type
**const *la_builtin_type_vector
;
134 /* Default range checking */
136 enum range_check la_range_check
;
138 /* Default type checking */
140 enum type_check la_type_check
;
142 /* Parser function. */
144 int (*la_parser
) PARAMS ((void));
146 /* Parser error function */
148 void (*la_error
) PARAMS ((char *));
150 /* Evaluate an expression. */
151 struct value
*(*evaluate_exp
) PARAMS ((struct type
*, struct expression
*,
152 int *, enum noside
));
154 void (*la_printchar
) PARAMS ((int ch
, GDB_FILE
* stream
));
156 void (*la_printstr
) PARAMS ((GDB_FILE
* stream
, char *string
,
157 unsigned int length
, int width
,
158 int force_ellipses
));
160 void (*la_emitchar
) PARAMS ((int ch
, GDB_FILE
* stream
, int quoter
));
162 struct type
*(*la_fund_type
) PARAMS ((struct objfile
*, int));
164 /* Print a type using syntax appropriate for this language. */
166 void (*la_print_type
) PARAMS ((struct type
*, char *, GDB_FILE
*, int, int));
168 /* Print a value using syntax appropriate for this language. */
170 int (*la_val_print
) PARAMS ((struct type
*, char *, int, CORE_ADDR
, GDB_FILE
*,
171 int, int, int, enum val_prettyprint
));
173 /* Print a top-level value using syntax appropriate for this language. */
175 int (*la_value_print
) PARAMS ((struct value
*, GDB_FILE
*,
176 int, enum val_prettyprint
));
178 /* Base 2 (binary) formats. */
180 struct language_format_info la_binary_format
;
182 /* Base 8 (octal) formats. */
184 struct language_format_info la_octal_format
;
186 /* Base 10 (decimal) formats */
188 struct language_format_info la_decimal_format
;
190 /* Base 16 (hexadecimal) formats */
192 struct language_format_info la_hex_format
;
194 /* Table for printing expressions */
196 const struct op_print
*la_op_print_tab
;
198 /* Zero if the language has first-class arrays. True if there are no
199 array values, and array objects decay to pointers, as in C. */
203 /* Index to use for extracting the first element of a string. */
204 char string_lower_bound
;
206 /* Type of elements of strings. */
207 struct type
**string_char_type
;
209 /* Add fields above this point, so the magic number is always last. */
210 /* Magic number for compat checking */
216 #define LANG_MAGIC 910823L
218 /* Pointer to the language_defn for our current language. This pointer
219 always points to *some* valid struct; it can be used without checking
222 The current language affects expression parsing and evaluation
223 (FIXME: it might be cleaner to make the evaluation-related stuff
224 separate exp_opcodes for each different set of semantics. We
225 should at least think this through more clearly with respect to
226 what happens if the language is changed between parsing and
227 evaluation) and printing of things like types and arrays. It does
228 *not* affect symbol-reading-- each source file in a symbol-file has
229 its own language and we should keep track of that regardless of the
230 language when symbols are read. If we want some manual setting for
231 the language of symbol files (e.g. detecting when ".c" files are
232 C++), it should be a seprate setting from the current_language. */
234 extern const struct language_defn
*current_language
;
236 /* Pointer to the language_defn expected by the user, e.g. the language
237 of main(), or the language we last mentioned in a message, or C. */
239 extern const struct language_defn
*expected_language
;
242 language_mode_auto: current_language automatically set upon selection
243 of scope (e.g. stack frame)
244 language_mode_manual: current_language set only by user. */
246 extern enum language_mode
248 language_mode_auto
, language_mode_manual
252 /* These macros define the behaviour of the expression
255 /* Should we strictly type check expressions? */
256 #define STRICT_TYPE (type_check != type_check_off)
258 /* Should we range check values against the domain of their type? */
259 #define RANGE_CHECK (range_check != range_check_off)
261 /* "cast" really means conversion */
262 /* FIXME -- should be a setting in language_defn */
263 #define CAST_IS_CONVERSION (current_language->la_language == language_c || \
264 current_language->la_language == language_cplus)
267 language_info
PARAMS ((int));
270 set_language
PARAMS ((enum language
));
273 /* This page contains functions that return things that are
274 specific to languages. Each of these functions is based on
275 the current setting of working_lang, which the user sets
276 with the "set language" command. */
278 #define create_fundamental_type(objfile,typeid) \
279 (current_language->la_fund_type(objfile, typeid))
281 #define LA_PRINT_TYPE(type,varstring,stream,show,level) \
282 (current_language->la_print_type(type,varstring,stream,show,level))
284 #define LA_VAL_PRINT(type,valaddr,offset,addr,stream,fmt,deref,recurse,pretty) \
285 (current_language->la_val_print(type,valaddr,offset,addr,stream,fmt,deref, \
287 #define LA_VALUE_PRINT(val,stream,fmt,pretty) \
288 (current_language->la_value_print(val,stream,fmt,pretty))
290 /* Return a format string for printf that will print a number in one of
291 the local (language-specific) formats. Result is static and is
292 overwritten by the next call. Takes printf options like "08" or "l"
293 (to produce e.g. %08x or %lx). */
295 #define local_binary_format() \
296 (current_language->la_binary_format.la_format)
297 #define local_binary_format_prefix() \
298 (current_language->la_binary_format.la_format_prefix)
299 #define local_binary_format_specifier() \
300 (current_language->la_binary_format.la_format_specifier)
301 #define local_binary_format_suffix() \
302 (current_language->la_binary_format.la_format_suffix)
304 #define local_octal_format() \
305 (current_language->la_octal_format.la_format)
306 #define local_octal_format_prefix() \
307 (current_language->la_octal_format.la_format_prefix)
308 #define local_octal_format_specifier() \
309 (current_language->la_octal_format.la_format_specifier)
310 #define local_octal_format_suffix() \
311 (current_language->la_octal_format.la_format_suffix)
313 #define local_decimal_format() \
314 (current_language->la_decimal_format.la_format)
315 #define local_decimal_format_prefix() \
316 (current_language->la_decimal_format.la_format_prefix)
317 #define local_decimal_format_specifier() \
318 (current_language->la_decimal_format.la_format_specifier)
319 #define local_decimal_format_suffix() \
320 (current_language->la_decimal_format.la_format_suffix)
322 #define local_hex_format() \
323 (current_language->la_hex_format.la_format)
324 #define local_hex_format_prefix() \
325 (current_language->la_hex_format.la_format_prefix)
326 #define local_hex_format_specifier() \
327 (current_language->la_hex_format.la_format_specifier)
328 #define local_hex_format_suffix() \
329 (current_language->la_hex_format.la_format_suffix)
331 #define LA_PRINT_CHAR(ch, stream) \
332 (current_language->la_printchar(ch, stream))
333 #define LA_PRINT_STRING(stream, string, length, width, force_ellipses) \
334 (current_language->la_printstr(stream, string, length, width, force_ellipses))
335 #define LA_EMIT_CHAR(ch, stream, quoter) \
336 (current_language->la_emitchar(ch, stream, quoter))
338 /* Test a character to decide whether it can be printed in literal form
339 or needs to be printed in another representation. For example,
340 in C the literal form of the character with octal value 141 is 'a'
341 and the "other representation" is '\141'. The "other representation"
342 is program language dependent. */
344 #define PRINT_LITERAL_FORM(c) \
346 && ((c) < 0x7F || (c) >= 0xA0) \
347 && (!sevenbit_strings || (c) < 0x80))
349 /* Return a format string for printf that will print a number in one of
350 the local (language-specific) formats. Result is static and is
351 overwritten by the next call. Takes printf options like "08" or "l"
352 (to produce e.g. %08x or %lx). */
355 local_decimal_format_custom
PARAMS ((char *)); /* language.c */
358 local_octal_format_custom
PARAMS ((char *)); /* language.c */
361 local_hex_format_custom
PARAMS ((char *)); /* language.c */
363 /* Return a string that contains a number formatted in one of the local
364 (language-specific) formats. Result is static and is overwritten by
365 the next call. Takes printf options like "08" or "l". */
368 local_hex_string
PARAMS ((unsigned long)); /* language.c */
371 local_hex_string_custom
PARAMS ((unsigned long, char *)); /* language.c */
373 /* Type predicates */
376 simple_type
PARAMS ((struct type
*));
379 ordered_type
PARAMS ((struct type
*));
382 same_type
PARAMS ((struct type
*, struct type
*));
385 integral_type
PARAMS ((struct type
*));
388 numeric_type
PARAMS ((struct type
*));
391 character_type
PARAMS ((struct type
*));
394 boolean_type
PARAMS ((struct type
*));
397 float_type
PARAMS ((struct type
*));
400 pointer_type
PARAMS ((struct type
*));
403 structured_type
PARAMS ((struct type
*));
405 /* Checks Binary and Unary operations for semantic type correctness */
406 /* FIXME: Does not appear to be used */
407 #define unop_type_check(v,o) binop_type_check((v),NULL,(o))
410 binop_type_check
PARAMS ((struct value
*, struct value
*, int));
415 op_error
PARAMS ((char *fmt
, enum exp_opcode
, int));
417 #define type_op_error(f,o) \
418 op_error((f),(o),type_check==type_check_on ? 1 : 0)
419 #define range_op_error(f,o) \
420 op_error((f),(o),range_check==range_check_on ? 1 : 0)
424 PARAMS ((char *,...))
425 ATTR_FORMAT (printf
, 1, 2);
428 range_error
PARAMS ((char *,...))
429 ATTR_FORMAT (printf
, 1, 2);
431 /* Data: Does this value represent "truth" to the current language? */
434 value_true
PARAMS ((struct value
*));
436 extern struct type
*lang_bool_type
PARAMS ((void));
438 /* The type used for Boolean values in the current language. */
439 #define LA_BOOL_TYPE lang_bool_type ()
441 /* Misc: The string representing a particular enum language. */
443 extern enum language language_enum
PARAMS ((char *str
));
445 extern const struct language_defn
*language_def
PARAMS ((enum language
));
447 extern char *language_str
PARAMS ((enum language
));
449 /* Add a language to the set known by GDB (at initialization time). */
452 add_language
PARAMS ((const struct language_defn
*));
455 get_frame_language
PARAMS ((void)); /* In stack.c */
457 #endif /* defined (LANGUAGE_H) */