Commit | Line | Data |
---|---|---|
c906108c | 1 | /* Source-language-related definitions for GDB. |
1bac305b AC |
2 | |
3 | Copyright 1991, 1992, 1993, 1994, 1995, 1998, 1999, 2000, 2003 Free | |
4 | Software Foundation, Inc. | |
5 | ||
c906108c SS |
6 | Contributed by the Department of Computer Science at the State University |
7 | of New York at Buffalo. | |
8 | ||
c5aa993b | 9 | This file is part of GDB. |
c906108c | 10 | |
c5aa993b JM |
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. | |
c906108c | 15 | |
c5aa993b JM |
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. | |
c906108c | 20 | |
c5aa993b JM |
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. */ | |
c906108c SS |
25 | |
26 | #if !defined (LANGUAGE_H) | |
27 | #define LANGUAGE_H 1 | |
28 | ||
104c1213 | 29 | /* Forward decls for prototypes */ |
c906108c SS |
30 | struct value; |
31 | struct objfile; | |
32 | struct expression; | |
da3331ec AC |
33 | struct ui_file; |
34 | ||
c5aa993b | 35 | /* enum exp_opcode; ANSI's `wisdom' didn't include forward enum decls. */ |
c906108c SS |
36 | |
37 | /* This used to be included to configure GDB for one or more specific | |
7e73cedf | 38 | languages. Now it is left out to configure for all of them. FIXME. */ |
c906108c SS |
39 | /* #include "lang_def.h" */ |
40 | #define _LANG_c | |
41 | #define _LANG_m2 | |
750ba382 PM |
42 | #define _LANG_fortran |
43 | #define _LANG_pascal | |
c906108c | 44 | |
c5aa993b | 45 | #define MAX_FORTRAN_DIMS 7 /* Maximum number of F77 array dims */ |
c906108c SS |
46 | |
47 | /* range_mode == | |
48 | range_mode_auto: range_check set automatically to default of language. | |
49 | range_mode_manual: range_check set manually by user. */ | |
50 | ||
c5aa993b JM |
51 | extern enum range_mode |
52 | { | |
53 | range_mode_auto, range_mode_manual | |
54 | } | |
55 | range_mode; | |
c906108c SS |
56 | |
57 | /* range_check == | |
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. */ | |
61 | ||
62 | extern enum range_check | |
c5aa993b JM |
63 | { |
64 | range_check_off, range_check_warn, range_check_on | |
65 | } | |
66 | range_check; | |
c906108c SS |
67 | |
68 | /* type_mode == | |
69 | type_mode_auto: type_check set automatically to default of language | |
70 | type_mode_manual: type_check set manually by user. */ | |
71 | ||
c5aa993b JM |
72 | extern enum type_mode |
73 | { | |
74 | type_mode_auto, type_mode_manual | |
75 | } | |
76 | type_mode; | |
c906108c SS |
77 | |
78 | /* type_check == | |
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. */ | |
82 | ||
83 | extern enum type_check | |
c5aa993b JM |
84 | { |
85 | type_check_off, type_check_warn, type_check_on | |
86 | } | |
87 | type_check; | |
63872f9d JG |
88 | |
89 | /* case_mode == | |
90 | case_mode_auto: case_sensitivity set upon selection of scope | |
91 | case_mode_manual: case_sensitivity set only by user. */ | |
92 | ||
93 | extern enum case_mode | |
94 | { | |
95 | case_mode_auto, case_mode_manual | |
96 | } | |
97 | case_mode; | |
98 | ||
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 */ | |
102 | ||
103 | extern enum case_sensitivity | |
104 | { | |
105 | case_sensitive_on, case_sensitive_off | |
106 | } | |
107 | case_sensitivity; | |
c906108c SS |
108 | \f |
109 | /* Information for doing language dependent formatting of printed values. */ | |
110 | ||
111 | struct language_format_info | |
c5aa993b JM |
112 | { |
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 | |
115 | the language. */ | |
c906108c | 116 | |
c5aa993b | 117 | char *la_format; |
c906108c | 118 | |
c5aa993b JM |
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). */ | |
c906108c | 123 | |
c5aa993b | 124 | char *la_format_prefix; |
c906108c | 125 | |
c5aa993b JM |
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. */ | |
c906108c | 129 | |
c5aa993b | 130 | char *la_format_specifier; |
c906108c | 131 | |
c5aa993b JM |
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). */ | |
c906108c | 136 | |
c5aa993b JM |
137 | char *la_format_suffix; /* Suffix for custom format string */ |
138 | }; | |
c906108c SS |
139 | |
140 | /* Structure tying together assorted information about a language. */ | |
141 | ||
142 | struct language_defn | |
c5aa993b JM |
143 | { |
144 | /* Name of the language */ | |
c906108c | 145 | |
c5aa993b | 146 | char *la_name; |
c906108c | 147 | |
c5aa993b | 148 | /* its symtab language-enum (defs.h) */ |
c906108c | 149 | |
c5aa993b | 150 | enum language la_language; |
c906108c | 151 | |
c5aa993b JM |
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 | |
155 | such a type. */ | |
c906108c | 156 | |
c5aa993b | 157 | struct type **const *la_builtin_type_vector; |
c906108c | 158 | |
c5aa993b | 159 | /* Default range checking */ |
c906108c | 160 | |
c5aa993b | 161 | enum range_check la_range_check; |
c906108c | 162 | |
c5aa993b | 163 | /* Default type checking */ |
c906108c | 164 | |
c5aa993b | 165 | enum type_check la_type_check; |
c906108c | 166 | |
63872f9d JG |
167 | /* Default case sensitivity */ |
168 | enum case_sensitivity la_case_sensitivity; | |
169 | ||
5f9769d1 PH |
170 | /* Definitions related to expression printing, prefixifying, and |
171 | dumping */ | |
172 | ||
173 | const struct exp_descriptor *la_exp_desc; | |
174 | ||
c5aa993b | 175 | /* Parser function. */ |
c906108c | 176 | |
507f3c78 | 177 | int (*la_parser) (void); |
c906108c | 178 | |
c5aa993b | 179 | /* Parser error function */ |
c906108c | 180 | |
507f3c78 | 181 | void (*la_error) (char *); |
c906108c | 182 | |
d9fcf2fb | 183 | void (*la_printchar) (int ch, struct ui_file * stream); |
c906108c | 184 | |
d9fcf2fb JM |
185 | void (*la_printstr) (struct ui_file * stream, char *string, |
186 | unsigned int length, int width, | |
187 | int force_ellipses); | |
c906108c | 188 | |
d9fcf2fb | 189 | void (*la_emitchar) (int ch, struct ui_file * stream, int quoter); |
c906108c | 190 | |
507f3c78 | 191 | struct type *(*la_fund_type) (struct objfile *, int); |
c906108c | 192 | |
c5aa993b | 193 | /* Print a type using syntax appropriate for this language. */ |
c906108c | 194 | |
d9fcf2fb JM |
195 | void (*la_print_type) (struct type *, char *, struct ui_file *, int, |
196 | int); | |
c906108c | 197 | |
c5aa993b | 198 | /* Print a value using syntax appropriate for this language. */ |
c906108c | 199 | |
d9fcf2fb JM |
200 | int (*la_val_print) (struct type *, char *, int, CORE_ADDR, |
201 | struct ui_file *, int, int, int, | |
202 | enum val_prettyprint); | |
c906108c | 203 | |
c5aa993b | 204 | /* Print a top-level value using syntax appropriate for this language. */ |
c906108c | 205 | |
d9fcf2fb JM |
206 | int (*la_value_print) (struct value *, struct ui_file *, |
207 | int, enum val_prettyprint); | |
c906108c | 208 | |
f636b87d AF |
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); | |
214 | ||
5f9a71c3 DC |
215 | /* Now come some hooks for lookup_symbol. */ |
216 | ||
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. */ | |
219 | ||
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. */ | |
223 | ||
224 | struct value *(*la_value_of_this) (int complain); | |
225 | ||
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 | |
228 | variables. */ | |
229 | ||
230 | struct symbol *(*la_lookup_symbol_nonlocal) (const char *, | |
231 | const char *, | |
232 | const struct block *, | |
233 | const domain_enum, | |
234 | struct symtab **); | |
235 | ||
9a3d7dfd AF |
236 | /* Return demangled language symbol, or NULL. */ |
237 | char *(*la_demangle) (const char *mangled, int options); | |
238 | ||
c5aa993b | 239 | /* Base 2 (binary) formats. */ |
c906108c | 240 | |
c5aa993b | 241 | struct language_format_info la_binary_format; |
c906108c | 242 | |
c5aa993b | 243 | /* Base 8 (octal) formats. */ |
c906108c | 244 | |
c5aa993b | 245 | struct language_format_info la_octal_format; |
c906108c | 246 | |
c5aa993b | 247 | /* Base 10 (decimal) formats */ |
c906108c | 248 | |
c5aa993b | 249 | struct language_format_info la_decimal_format; |
c906108c | 250 | |
c5aa993b | 251 | /* Base 16 (hexadecimal) formats */ |
c906108c | 252 | |
c5aa993b | 253 | struct language_format_info la_hex_format; |
c906108c | 254 | |
c5aa993b | 255 | /* Table for printing expressions */ |
c906108c | 256 | |
c5aa993b | 257 | const struct op_print *la_op_print_tab; |
c906108c | 258 | |
c5aa993b JM |
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. */ | |
c906108c | 261 | |
c5aa993b | 262 | char c_style_arrays; |
c906108c | 263 | |
c5aa993b JM |
264 | /* Index to use for extracting the first element of a string. */ |
265 | char string_lower_bound; | |
c906108c | 266 | |
c5aa993b JM |
267 | /* Type of elements of strings. */ |
268 | struct type **string_char_type; | |
c906108c | 269 | |
6084f43a JB |
270 | /* The list of characters forming word boundaries. */ |
271 | char *(*la_word_break_characters) (void); | |
272 | ||
c5aa993b JM |
273 | /* Add fields above this point, so the magic number is always last. */ |
274 | /* Magic number for compat checking */ | |
275 | ||
276 | long la_magic; | |
277 | ||
278 | }; | |
c906108c SS |
279 | |
280 | #define LANG_MAGIC 910823L | |
281 | ||
282 | /* Pointer to the language_defn for our current language. This pointer | |
283 | always points to *some* valid struct; it can be used without checking | |
284 | it for validity. | |
285 | ||
286 | The current language affects expression parsing and evaluation | |
287 | (FIXME: it might be cleaner to make the evaluation-related stuff | |
288 | separate exp_opcodes for each different set of semantics. We | |
289 | should at least think this through more clearly with respect to | |
290 | what happens if the language is changed between parsing and | |
291 | evaluation) and printing of things like types and arrays. It does | |
292 | *not* affect symbol-reading-- each source file in a symbol-file has | |
293 | its own language and we should keep track of that regardless of the | |
294 | language when symbols are read. If we want some manual setting for | |
295 | the language of symbol files (e.g. detecting when ".c" files are | |
7e73cedf | 296 | C++), it should be a separate setting from the current_language. */ |
c906108c SS |
297 | |
298 | extern const struct language_defn *current_language; | |
299 | ||
300 | /* Pointer to the language_defn expected by the user, e.g. the language | |
301 | of main(), or the language we last mentioned in a message, or C. */ | |
302 | ||
303 | extern const struct language_defn *expected_language; | |
304 | ||
305 | /* language_mode == | |
306 | language_mode_auto: current_language automatically set upon selection | |
c5aa993b | 307 | of scope (e.g. stack frame) |
c906108c SS |
308 | language_mode_manual: current_language set only by user. */ |
309 | ||
310 | extern enum language_mode | |
c5aa993b JM |
311 | { |
312 | language_mode_auto, language_mode_manual | |
313 | } | |
314 | language_mode; | |
c906108c SS |
315 | \f |
316 | /* These macros define the behaviour of the expression | |
317 | evaluator. */ | |
318 | ||
319 | /* Should we strictly type check expressions? */ | |
320 | #define STRICT_TYPE (type_check != type_check_off) | |
321 | ||
322 | /* Should we range check values against the domain of their type? */ | |
323 | #define RANGE_CHECK (range_check != range_check_off) | |
324 | ||
325 | /* "cast" really means conversion */ | |
326 | /* FIXME -- should be a setting in language_defn */ | |
327 | #define CAST_IS_CONVERSION (current_language->la_language == language_c || \ | |
806e6073 AF |
328 | current_language->la_language == language_cplus || \ |
329 | current_language->la_language == language_objc) | |
c906108c | 330 | |
a14ed312 | 331 | extern void language_info (int); |
c906108c | 332 | |
a14ed312 | 333 | extern enum language set_language (enum language); |
c906108c | 334 | \f |
c5aa993b | 335 | |
c906108c SS |
336 | /* This page contains functions that return things that are |
337 | specific to languages. Each of these functions is based on | |
338 | the current setting of working_lang, which the user sets | |
339 | with the "set language" command. */ | |
340 | ||
341 | #define create_fundamental_type(objfile,typeid) \ | |
342 | (current_language->la_fund_type(objfile, typeid)) | |
343 | ||
344 | #define LA_PRINT_TYPE(type,varstring,stream,show,level) \ | |
345 | (current_language->la_print_type(type,varstring,stream,show,level)) | |
346 | ||
347 | #define LA_VAL_PRINT(type,valaddr,offset,addr,stream,fmt,deref,recurse,pretty) \ | |
348 | (current_language->la_val_print(type,valaddr,offset,addr,stream,fmt,deref, \ | |
349 | recurse,pretty)) | |
350 | #define LA_VALUE_PRINT(val,stream,fmt,pretty) \ | |
351 | (current_language->la_value_print(val,stream,fmt,pretty)) | |
352 | ||
353 | /* Return a format string for printf that will print a number in one of | |
354 | the local (language-specific) formats. Result is static and is | |
355 | overwritten by the next call. Takes printf options like "08" or "l" | |
356 | (to produce e.g. %08x or %lx). */ | |
357 | ||
358 | #define local_binary_format() \ | |
359 | (current_language->la_binary_format.la_format) | |
360 | #define local_binary_format_prefix() \ | |
361 | (current_language->la_binary_format.la_format_prefix) | |
362 | #define local_binary_format_specifier() \ | |
363 | (current_language->la_binary_format.la_format_specifier) | |
364 | #define local_binary_format_suffix() \ | |
365 | (current_language->la_binary_format.la_format_suffix) | |
366 | ||
367 | #define local_octal_format() \ | |
368 | (current_language->la_octal_format.la_format) | |
369 | #define local_octal_format_prefix() \ | |
370 | (current_language->la_octal_format.la_format_prefix) | |
371 | #define local_octal_format_specifier() \ | |
372 | (current_language->la_octal_format.la_format_specifier) | |
373 | #define local_octal_format_suffix() \ | |
374 | (current_language->la_octal_format.la_format_suffix) | |
375 | ||
376 | #define local_decimal_format() \ | |
377 | (current_language->la_decimal_format.la_format) | |
378 | #define local_decimal_format_prefix() \ | |
379 | (current_language->la_decimal_format.la_format_prefix) | |
380 | #define local_decimal_format_specifier() \ | |
381 | (current_language->la_decimal_format.la_format_specifier) | |
382 | #define local_decimal_format_suffix() \ | |
383 | (current_language->la_decimal_format.la_format_suffix) | |
384 | ||
385 | #define local_hex_format() \ | |
386 | (current_language->la_hex_format.la_format) | |
387 | #define local_hex_format_prefix() \ | |
388 | (current_language->la_hex_format.la_format_prefix) | |
389 | #define local_hex_format_specifier() \ | |
390 | (current_language->la_hex_format.la_format_specifier) | |
391 | #define local_hex_format_suffix() \ | |
392 | (current_language->la_hex_format.la_format_suffix) | |
393 | ||
394 | #define LA_PRINT_CHAR(ch, stream) \ | |
395 | (current_language->la_printchar(ch, stream)) | |
396 | #define LA_PRINT_STRING(stream, string, length, width, force_ellipses) \ | |
397 | (current_language->la_printstr(stream, string, length, width, force_ellipses)) | |
398 | #define LA_EMIT_CHAR(ch, stream, quoter) \ | |
399 | (current_language->la_emitchar(ch, stream, quoter)) | |
400 | ||
401 | /* Test a character to decide whether it can be printed in literal form | |
402 | or needs to be printed in another representation. For example, | |
403 | in C the literal form of the character with octal value 141 is 'a' | |
404 | and the "other representation" is '\141'. The "other representation" | |
405 | is program language dependent. */ | |
406 | ||
407 | #define PRINT_LITERAL_FORM(c) \ | |
408 | ((c) >= 0x20 \ | |
409 | && ((c) < 0x7F || (c) >= 0xA0) \ | |
410 | && (!sevenbit_strings || (c) < 0x80)) | |
411 | ||
412 | /* Return a format string for printf that will print a number in one of | |
413 | the local (language-specific) formats. Result is static and is | |
414 | overwritten by the next call. Takes printf options like "08" or "l" | |
415 | (to produce e.g. %08x or %lx). */ | |
416 | ||
a14ed312 | 417 | extern char *local_decimal_format_custom (char *); /* language.c */ |
c906108c | 418 | |
a14ed312 | 419 | extern char *local_octal_format_custom (char *); /* language.c */ |
c906108c | 420 | |
a14ed312 | 421 | extern char *local_hex_format_custom (char *); /* language.c */ |
c906108c | 422 | |
7acb79c8 AC |
423 | #if 0 |
424 | /* FIXME: cagney/2000-03-04: This function does not appear to be used. | |
425 | It can be deleted once 5.0 has been released. */ | |
c4093a6a JM |
426 | /* Return a string that contains the hex digits of the number. No preceeding |
427 | "0x" */ | |
428 | ||
a14ed312 | 429 | extern char *longest_raw_hex_string (LONGEST); |
7acb79c8 | 430 | #endif |
c4093a6a | 431 | |
c906108c SS |
432 | /* Return a string that contains a number formatted in one of the local |
433 | (language-specific) formats. Result is static and is overwritten by | |
c4093a6a | 434 | the next call. Takes printf options like "08l" or "l". */ |
c906108c | 435 | |
14a5e767 | 436 | extern char *local_hex_string (LONGEST); /* language.c */ |
c906108c | 437 | |
14a5e767 | 438 | extern char *local_hex_string_custom (LONGEST, char *); /* language.c */ |
c4093a6a | 439 | |
c906108c SS |
440 | /* Type predicates */ |
441 | ||
a14ed312 | 442 | extern int simple_type (struct type *); |
c906108c | 443 | |
a14ed312 | 444 | extern int ordered_type (struct type *); |
c906108c | 445 | |
a14ed312 | 446 | extern int same_type (struct type *, struct type *); |
c906108c | 447 | |
a14ed312 | 448 | extern int integral_type (struct type *); |
c906108c | 449 | |
a14ed312 | 450 | extern int numeric_type (struct type *); |
c906108c | 451 | |
a14ed312 | 452 | extern int character_type (struct type *); |
c906108c | 453 | |
a14ed312 | 454 | extern int boolean_type (struct type *); |
c906108c | 455 | |
a14ed312 | 456 | extern int float_type (struct type *); |
c906108c | 457 | |
a14ed312 | 458 | extern int pointer_type (struct type *); |
c906108c | 459 | |
a14ed312 | 460 | extern int structured_type (struct type *); |
c906108c SS |
461 | |
462 | /* Checks Binary and Unary operations for semantic type correctness */ | |
463 | /* FIXME: Does not appear to be used */ | |
464 | #define unop_type_check(v,o) binop_type_check((v),NULL,(o)) | |
465 | ||
a14ed312 | 466 | extern void binop_type_check (struct value *, struct value *, int); |
c906108c SS |
467 | |
468 | /* Error messages */ | |
469 | ||
98b3ab73 AC |
470 | extern void op_error (const char *lhs, enum exp_opcode, |
471 | const char *rhs); | |
c906108c | 472 | |
ddfe3c15 | 473 | extern void type_error (const char *, ...) ATTR_FORMAT (printf, 1, 2); |
c906108c | 474 | |
ddfe3c15 | 475 | extern void range_error (const char *, ...) ATTR_FORMAT (printf, 1, 2); |
c906108c SS |
476 | |
477 | /* Data: Does this value represent "truth" to the current language? */ | |
478 | ||
a14ed312 | 479 | extern int value_true (struct value *); |
c906108c | 480 | |
a14ed312 | 481 | extern struct type *lang_bool_type (void); |
c906108c SS |
482 | |
483 | /* The type used for Boolean values in the current language. */ | |
484 | #define LA_BOOL_TYPE lang_bool_type () | |
485 | ||
486 | /* Misc: The string representing a particular enum language. */ | |
487 | ||
a14ed312 | 488 | extern enum language language_enum (char *str); |
c906108c | 489 | |
a14ed312 | 490 | extern const struct language_defn *language_def (enum language); |
7a292a7a | 491 | |
a14ed312 | 492 | extern char *language_str (enum language); |
c906108c SS |
493 | |
494 | /* Add a language to the set known by GDB (at initialization time). */ | |
495 | ||
a14ed312 | 496 | extern void add_language (const struct language_defn *); |
c906108c | 497 | |
a14ed312 | 498 | extern enum language get_frame_language (void); /* In stack.c */ |
c906108c | 499 | |
f636b87d AF |
500 | /* Check for a language-specific trampoline. */ |
501 | ||
502 | extern CORE_ADDR skip_language_trampoline (CORE_ADDR pc); | |
503 | ||
9a3d7dfd AF |
504 | /* Return demangled language symbol, or NULL. */ |
505 | extern char *language_demangle (const struct language_defn *current_language, | |
506 | const char *mangled, int options); | |
507 | ||
9f0a5303 JB |
508 | /* Splitting strings into words. */ |
509 | extern char *default_word_break_characters (void); | |
510 | ||
c5aa993b | 511 | #endif /* defined (LANGUAGE_H) */ |