Commit | Line | Data |
---|---|---|
c906108c | 1 | /* Source-language-related definitions for GDB. |
1bac305b | 2 | |
6aba47ca | 3 | Copyright (C) 1991, 1992, 1993, 1994, 1995, 1998, 1999, 2000, 2003, 2004, |
0fb0cc75 | 4 | 2007, 2008, 2009 Free Software Foundation, Inc. |
1bac305b | 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 | |
a9762ec7 | 13 | the Free Software Foundation; either version 3 of the License, or |
c5aa993b | 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 | 21 | You should have received a copy of the GNU General Public License |
a9762ec7 | 22 | along with this program. If not, see <http://www.gnu.org/licenses/>. */ |
c906108c SS |
23 | |
24 | #if !defined (LANGUAGE_H) | |
25 | #define LANGUAGE_H 1 | |
26 | ||
104c1213 | 27 | /* Forward decls for prototypes */ |
c906108c SS |
28 | struct value; |
29 | struct objfile; | |
52f729a7 | 30 | struct frame_info; |
c906108c | 31 | struct expression; |
da3331ec | 32 | struct ui_file; |
79a45b7d | 33 | struct value_print_options; |
62dfaa9c | 34 | |
c5aa993b | 35 | #define MAX_FORTRAN_DIMS 7 /* Maximum number of F77 array dims */ |
c906108c SS |
36 | |
37 | /* range_mode == | |
38 | range_mode_auto: range_check set automatically to default of language. | |
39 | range_mode_manual: range_check set manually by user. */ | |
40 | ||
c5aa993b JM |
41 | extern enum range_mode |
42 | { | |
43 | range_mode_auto, range_mode_manual | |
44 | } | |
45 | range_mode; | |
c906108c SS |
46 | |
47 | /* range_check == | |
48 | range_check_on: Ranges are checked in GDB expressions, producing errors. | |
49 | range_check_warn: Ranges are checked, producing warnings. | |
50 | range_check_off: Ranges are not checked in GDB expressions. */ | |
51 | ||
52 | extern enum range_check | |
c5aa993b JM |
53 | { |
54 | range_check_off, range_check_warn, range_check_on | |
55 | } | |
56 | range_check; | |
c906108c SS |
57 | |
58 | /* type_mode == | |
59 | type_mode_auto: type_check set automatically to default of language | |
60 | type_mode_manual: type_check set manually by user. */ | |
61 | ||
c5aa993b JM |
62 | extern enum type_mode |
63 | { | |
64 | type_mode_auto, type_mode_manual | |
65 | } | |
66 | type_mode; | |
c906108c SS |
67 | |
68 | /* type_check == | |
69 | type_check_on: Types are checked in GDB expressions, producing errors. | |
70 | type_check_warn: Types are checked, producing warnings. | |
71 | type_check_off: Types are not checked in GDB expressions. */ | |
72 | ||
73 | extern enum type_check | |
c5aa993b JM |
74 | { |
75 | type_check_off, type_check_warn, type_check_on | |
76 | } | |
77 | type_check; | |
63872f9d JG |
78 | |
79 | /* case_mode == | |
80 | case_mode_auto: case_sensitivity set upon selection of scope | |
81 | case_mode_manual: case_sensitivity set only by user. */ | |
82 | ||
83 | extern enum case_mode | |
84 | { | |
85 | case_mode_auto, case_mode_manual | |
86 | } | |
87 | case_mode; | |
88 | ||
7ca2d3a3 DL |
89 | /* array_ordering == |
90 | array_row_major: Arrays are in row major order | |
91 | array_column_major: Arrays are in column major order.*/ | |
92 | ||
93 | extern enum array_ordering | |
94 | { | |
95 | array_row_major, array_column_major | |
96 | } | |
97 | array_ordering; | |
98 | ||
99 | ||
63872f9d JG |
100 | /* case_sensitivity == |
101 | case_sensitive_on: Case sensitivity in name matching is used | |
102 | case_sensitive_off: Case sensitivity in name matching is not used */ | |
103 | ||
104 | extern enum case_sensitivity | |
105 | { | |
106 | case_sensitive_on, case_sensitive_off | |
107 | } | |
108 | case_sensitivity; | |
9a044a89 TT |
109 | |
110 | ||
111 | /* macro_expansion == | |
112 | macro_expansion_no: No macro expansion is available | |
113 | macro_expansion_c: C-like macro expansion is available */ | |
114 | ||
115 | enum macro_expansion | |
116 | { | |
117 | macro_expansion_no, macro_expansion_c | |
118 | }; | |
119 | ||
c906108c | 120 | \f |
f290d38e AC |
121 | /* Per architecture (OS/ABI) language information. */ |
122 | ||
123 | struct language_arch_info | |
124 | { | |
5a44ea29 | 125 | /* Its primitive types. This is a vector ended by a NULL pointer. |
f290d38e AC |
126 | These types can be specified by name in parsing types in |
127 | expressions, regardless of whether the program being debugged | |
128 | actually defines such a type. */ | |
5a44ea29 | 129 | struct type **primitive_type_vector; |
f290d38e AC |
130 | /* Type of elements of strings. */ |
131 | struct type *string_char_type; | |
fbb06eb1 UW |
132 | |
133 | /* Symbol name of type to use as boolean type, if defined. */ | |
134 | const char *bool_type_symbol; | |
135 | /* Otherwise, this is the default boolean builtin type. */ | |
136 | struct type *bool_type_default; | |
f290d38e AC |
137 | }; |
138 | ||
c906108c SS |
139 | /* Structure tying together assorted information about a language. */ |
140 | ||
141 | struct language_defn | |
c5aa993b JM |
142 | { |
143 | /* Name of the language */ | |
c906108c | 144 | |
c5aa993b | 145 | char *la_name; |
c906108c | 146 | |
c5aa993b | 147 | /* its symtab language-enum (defs.h) */ |
c906108c | 148 | |
c5aa993b | 149 | enum language la_language; |
c906108c | 150 | |
c5aa993b | 151 | /* Default range checking */ |
c906108c | 152 | |
c5aa993b | 153 | enum range_check la_range_check; |
c906108c | 154 | |
c5aa993b | 155 | /* Default type checking */ |
c906108c | 156 | |
c5aa993b | 157 | enum type_check la_type_check; |
c906108c | 158 | |
63872f9d JG |
159 | /* Default case sensitivity */ |
160 | enum case_sensitivity la_case_sensitivity; | |
161 | ||
7ca2d3a3 DL |
162 | /* Multi-dimensional array ordering */ |
163 | enum array_ordering la_array_ordering; | |
164 | ||
9a044a89 TT |
165 | /* Style of macro expansion, if any, supported by this language. */ |
166 | enum macro_expansion la_macro_expansion; | |
167 | ||
5f9769d1 PH |
168 | /* Definitions related to expression printing, prefixifying, and |
169 | dumping */ | |
170 | ||
171 | const struct exp_descriptor *la_exp_desc; | |
172 | ||
c5aa993b | 173 | /* Parser function. */ |
c906108c | 174 | |
507f3c78 | 175 | int (*la_parser) (void); |
c906108c | 176 | |
c5aa993b | 177 | /* Parser error function */ |
c906108c | 178 | |
507f3c78 | 179 | void (*la_error) (char *); |
c906108c | 180 | |
e85c3284 PH |
181 | /* Given an expression *EXPP created by prefixifying the result of |
182 | la_parser, perform any remaining processing necessary to complete | |
183 | its translation. *EXPP may change; la_post_parser is responsible | |
184 | for releasing its previous contents, if necessary. If | |
185 | VOID_CONTEXT_P, then no value is expected from the expression. */ | |
186 | ||
187 | void (*la_post_parser) (struct expression ** expp, int void_context_p); | |
188 | ||
d9fcf2fb | 189 | void (*la_printchar) (int ch, struct ui_file * stream); |
c906108c | 190 | |
fc1a4b47 | 191 | void (*la_printstr) (struct ui_file * stream, const gdb_byte *string, |
d9fcf2fb | 192 | unsigned int length, int width, |
79a45b7d TT |
193 | int force_ellipses, |
194 | const struct value_print_options *); | |
c906108c | 195 | |
d9fcf2fb | 196 | void (*la_emitchar) (int ch, struct ui_file * stream, int quoter); |
c906108c | 197 | |
c5aa993b | 198 | /* Print a type using syntax appropriate for this language. */ |
c906108c | 199 | |
d9fcf2fb JM |
200 | void (*la_print_type) (struct type *, char *, struct ui_file *, int, |
201 | int); | |
c906108c | 202 | |
5c6ce71d TT |
203 | /* Print a typedef using syntax appropriate for this language. |
204 | TYPE is the underlying type. NEW_SYMBOL is the symbol naming | |
205 | the type. STREAM is the output stream on which to print. */ | |
206 | ||
207 | void (*la_print_typedef) (struct type *type, struct symbol *new_symbol, | |
208 | struct ui_file *stream); | |
209 | ||
c5aa993b | 210 | /* Print a value using syntax appropriate for this language. */ |
c906108c | 211 | |
fc1a4b47 | 212 | int (*la_val_print) (struct type *, const gdb_byte *, int, CORE_ADDR, |
79a45b7d TT |
213 | struct ui_file *, int, |
214 | const struct value_print_options *); | |
c906108c | 215 | |
c5aa993b | 216 | /* Print a top-level value using syntax appropriate for this language. */ |
c906108c | 217 | |
d9fcf2fb | 218 | int (*la_value_print) (struct value *, struct ui_file *, |
79a45b7d | 219 | const struct value_print_options *); |
c906108c | 220 | |
f636b87d AF |
221 | /* PC is possibly an unknown languages trampoline. |
222 | If that PC falls in a trampoline belonging to this language, | |
223 | return the address of the first pc in the real function, or 0 | |
224 | if it isn't a language tramp for this language. */ | |
52f729a7 | 225 | CORE_ADDR (*skip_trampoline) (struct frame_info *, CORE_ADDR); |
f636b87d | 226 | |
5f9a71c3 DC |
227 | /* Now come some hooks for lookup_symbol. */ |
228 | ||
2b2d9e11 VP |
229 | /* If this is non-NULL, specifies the name that of the implicit |
230 | local variable that refers to the current object instance. */ | |
5f9a71c3 | 231 | |
2b2d9e11 | 232 | char *la_name_of_this; |
5f9a71c3 DC |
233 | |
234 | /* This is a function that lookup_symbol will call when it gets to | |
235 | the part of symbol lookup where C looks up static and global | |
236 | variables. */ | |
237 | ||
238 | struct symbol *(*la_lookup_symbol_nonlocal) (const char *, | |
239 | const char *, | |
240 | const struct block *, | |
21b556f4 | 241 | const domain_enum); |
5f9a71c3 | 242 | |
b368761e DC |
243 | /* Find the definition of the type with the given name. */ |
244 | struct type *(*la_lookup_transparent_type) (const char *); | |
245 | ||
9a3d7dfd AF |
246 | /* Return demangled language symbol, or NULL. */ |
247 | char *(*la_demangle) (const char *mangled, int options); | |
248 | ||
31c27f77 JJ |
249 | /* Return class name of a mangled method name or NULL. */ |
250 | char *(*la_class_name_from_physname) (const char *physname); | |
251 | ||
c5aa993b | 252 | /* Table for printing expressions */ |
c906108c | 253 | |
c5aa993b | 254 | const struct op_print *la_op_print_tab; |
c906108c | 255 | |
c5aa993b JM |
256 | /* Zero if the language has first-class arrays. True if there are no |
257 | array values, and array objects decay to pointers, as in C. */ | |
c906108c | 258 | |
c5aa993b | 259 | char c_style_arrays; |
c906108c | 260 | |
c5aa993b JM |
261 | /* Index to use for extracting the first element of a string. */ |
262 | char string_lower_bound; | |
c906108c | 263 | |
6084f43a JB |
264 | /* The list of characters forming word boundaries. */ |
265 | char *(*la_word_break_characters) (void); | |
266 | ||
41d27058 JB |
267 | /* Should return a NULL terminated array of all symbols which |
268 | are possible completions for TEXT. WORD is the entire command | |
269 | on which the completion is being made. */ | |
270 | char **(*la_make_symbol_completion_list) (char *text, char *word); | |
271 | ||
f290d38e AC |
272 | /* The per-architecture (OS/ABI) language information. */ |
273 | void (*la_language_arch_info) (struct gdbarch *, | |
274 | struct language_arch_info *); | |
275 | ||
e79af960 JB |
276 | /* Print the index of an element of an array. */ |
277 | void (*la_print_array_index) (struct value *index_value, | |
278 | struct ui_file *stream, | |
79a45b7d | 279 | const struct value_print_options *options); |
e79af960 | 280 | |
41f1b697 DJ |
281 | /* Return non-zero if TYPE should be passed (and returned) by |
282 | reference at the language level. */ | |
283 | int (*la_pass_by_reference) (struct type *type); | |
284 | ||
c5aa993b JM |
285 | /* Add fields above this point, so the magic number is always last. */ |
286 | /* Magic number for compat checking */ | |
287 | ||
288 | long la_magic; | |
289 | ||
290 | }; | |
c906108c SS |
291 | |
292 | #define LANG_MAGIC 910823L | |
293 | ||
294 | /* Pointer to the language_defn for our current language. This pointer | |
295 | always points to *some* valid struct; it can be used without checking | |
296 | it for validity. | |
297 | ||
298 | The current language affects expression parsing and evaluation | |
299 | (FIXME: it might be cleaner to make the evaluation-related stuff | |
300 | separate exp_opcodes for each different set of semantics. We | |
301 | should at least think this through more clearly with respect to | |
302 | what happens if the language is changed between parsing and | |
303 | evaluation) and printing of things like types and arrays. It does | |
304 | *not* affect symbol-reading-- each source file in a symbol-file has | |
305 | its own language and we should keep track of that regardless of the | |
306 | language when symbols are read. If we want some manual setting for | |
307 | the language of symbol files (e.g. detecting when ".c" files are | |
7e73cedf | 308 | C++), it should be a separate setting from the current_language. */ |
c906108c SS |
309 | |
310 | extern const struct language_defn *current_language; | |
311 | ||
312 | /* Pointer to the language_defn expected by the user, e.g. the language | |
313 | of main(), or the language we last mentioned in a message, or C. */ | |
314 | ||
315 | extern const struct language_defn *expected_language; | |
316 | ||
317 | /* language_mode == | |
318 | language_mode_auto: current_language automatically set upon selection | |
c5aa993b | 319 | of scope (e.g. stack frame) |
c906108c SS |
320 | language_mode_manual: current_language set only by user. */ |
321 | ||
322 | extern enum language_mode | |
c5aa993b JM |
323 | { |
324 | language_mode_auto, language_mode_manual | |
325 | } | |
326 | language_mode; | |
b62f3443 | 327 | |
fbb06eb1 UW |
328 | struct type *language_bool_type (const struct language_defn *l, |
329 | struct gdbarch *gdbarch); | |
330 | ||
b62f3443 JB |
331 | struct type *language_string_char_type (const struct language_defn *l, |
332 | struct gdbarch *gdbarch); | |
333 | ||
334 | struct type *language_lookup_primitive_type_by_name (const struct language_defn *l, | |
335 | struct gdbarch *gdbarch, | |
336 | const char *name); | |
337 | ||
c906108c SS |
338 | \f |
339 | /* These macros define the behaviour of the expression | |
340 | evaluator. */ | |
341 | ||
342 | /* Should we strictly type check expressions? */ | |
343 | #define STRICT_TYPE (type_check != type_check_off) | |
344 | ||
345 | /* Should we range check values against the domain of their type? */ | |
346 | #define RANGE_CHECK (range_check != range_check_off) | |
347 | ||
348 | /* "cast" really means conversion */ | |
349 | /* FIXME -- should be a setting in language_defn */ | |
350 | #define CAST_IS_CONVERSION (current_language->la_language == language_c || \ | |
806e6073 AF |
351 | current_language->la_language == language_cplus || \ |
352 | current_language->la_language == language_objc) | |
c906108c | 353 | |
a14ed312 | 354 | extern void language_info (int); |
c906108c | 355 | |
a14ed312 | 356 | extern enum language set_language (enum language); |
c906108c | 357 | \f |
c5aa993b | 358 | |
c906108c SS |
359 | /* This page contains functions that return things that are |
360 | specific to languages. Each of these functions is based on | |
361 | the current setting of working_lang, which the user sets | |
362 | with the "set language" command. */ | |
363 | ||
c906108c SS |
364 | #define LA_PRINT_TYPE(type,varstring,stream,show,level) \ |
365 | (current_language->la_print_type(type,varstring,stream,show,level)) | |
366 | ||
5c6ce71d TT |
367 | #define LA_PRINT_TYPEDEF(type,new_symbol,stream) \ |
368 | (current_language->la_print_typedef(type,new_symbol,stream)) | |
369 | ||
79a45b7d TT |
370 | #define LA_VAL_PRINT(type,valaddr,offset,addr,stream,recurse,options) \ |
371 | (current_language->la_val_print(type,valaddr,offset,addr,stream, \ | |
372 | recurse,options)) | |
373 | #define LA_VALUE_PRINT(val,stream,options) \ | |
374 | (current_language->la_value_print(val,stream,options)) | |
c906108c | 375 | |
c906108c SS |
376 | #define LA_PRINT_CHAR(ch, stream) \ |
377 | (current_language->la_printchar(ch, stream)) | |
79a45b7d TT |
378 | #define LA_PRINT_STRING(stream, string, length, width, force_ellipses,options) \ |
379 | (current_language->la_printstr(stream, string, length, width, \ | |
380 | force_ellipses,options)) | |
c906108c SS |
381 | #define LA_EMIT_CHAR(ch, stream, quoter) \ |
382 | (current_language->la_emitchar(ch, stream, quoter)) | |
383 | ||
79a45b7d TT |
384 | #define LA_PRINT_ARRAY_INDEX(index_value, stream, optins) \ |
385 | (current_language->la_print_array_index(index_value, stream, options)) | |
e79af960 | 386 | |
c906108c SS |
387 | /* Test a character to decide whether it can be printed in literal form |
388 | or needs to be printed in another representation. For example, | |
389 | in C the literal form of the character with octal value 141 is 'a' | |
390 | and the "other representation" is '\141'. The "other representation" | |
391 | is program language dependent. */ | |
392 | ||
393 | #define PRINT_LITERAL_FORM(c) \ | |
394 | ((c) >= 0x20 \ | |
395 | && ((c) < 0x7F || (c) >= 0xA0) \ | |
396 | && (!sevenbit_strings || (c) < 0x80)) | |
397 | ||
7acb79c8 AC |
398 | #if 0 |
399 | /* FIXME: cagney/2000-03-04: This function does not appear to be used. | |
400 | It can be deleted once 5.0 has been released. */ | |
c4093a6a JM |
401 | /* Return a string that contains the hex digits of the number. No preceeding |
402 | "0x" */ | |
403 | ||
a14ed312 | 404 | extern char *longest_raw_hex_string (LONGEST); |
7acb79c8 | 405 | #endif |
c4093a6a | 406 | |
c906108c SS |
407 | /* Type predicates */ |
408 | ||
a14ed312 | 409 | extern int simple_type (struct type *); |
c906108c | 410 | |
a14ed312 | 411 | extern int ordered_type (struct type *); |
c906108c | 412 | |
a14ed312 | 413 | extern int same_type (struct type *, struct type *); |
c906108c | 414 | |
a14ed312 | 415 | extern int integral_type (struct type *); |
c906108c | 416 | |
a14ed312 | 417 | extern int numeric_type (struct type *); |
c906108c | 418 | |
a14ed312 | 419 | extern int character_type (struct type *); |
c906108c | 420 | |
a14ed312 | 421 | extern int boolean_type (struct type *); |
c906108c | 422 | |
a14ed312 | 423 | extern int float_type (struct type *); |
c906108c | 424 | |
a14ed312 | 425 | extern int pointer_type (struct type *); |
c906108c | 426 | |
a14ed312 | 427 | extern int structured_type (struct type *); |
c906108c SS |
428 | |
429 | /* Checks Binary and Unary operations for semantic type correctness */ | |
430 | /* FIXME: Does not appear to be used */ | |
431 | #define unop_type_check(v,o) binop_type_check((v),NULL,(o)) | |
432 | ||
a14ed312 | 433 | extern void binop_type_check (struct value *, struct value *, int); |
c906108c SS |
434 | |
435 | /* Error messages */ | |
436 | ||
ddfe3c15 | 437 | extern void type_error (const char *, ...) ATTR_FORMAT (printf, 1, 2); |
c906108c | 438 | |
ddfe3c15 | 439 | extern void range_error (const char *, ...) ATTR_FORMAT (printf, 1, 2); |
c906108c SS |
440 | |
441 | /* Data: Does this value represent "truth" to the current language? */ | |
442 | ||
a14ed312 | 443 | extern int value_true (struct value *); |
c906108c | 444 | |
c906108c SS |
445 | /* Misc: The string representing a particular enum language. */ |
446 | ||
a14ed312 | 447 | extern enum language language_enum (char *str); |
c906108c | 448 | |
a14ed312 | 449 | extern const struct language_defn *language_def (enum language); |
7a292a7a | 450 | |
a14ed312 | 451 | extern char *language_str (enum language); |
c906108c SS |
452 | |
453 | /* Add a language to the set known by GDB (at initialization time). */ | |
454 | ||
a14ed312 | 455 | extern void add_language (const struct language_defn *); |
c906108c | 456 | |
a14ed312 | 457 | extern enum language get_frame_language (void); /* In stack.c */ |
c906108c | 458 | |
f636b87d AF |
459 | /* Check for a language-specific trampoline. */ |
460 | ||
52f729a7 | 461 | extern CORE_ADDR skip_language_trampoline (struct frame_info *, CORE_ADDR pc); |
f636b87d | 462 | |
9a3d7dfd AF |
463 | /* Return demangled language symbol, or NULL. */ |
464 | extern char *language_demangle (const struct language_defn *current_language, | |
465 | const char *mangled, int options); | |
466 | ||
31c27f77 JJ |
467 | /* Return class name from physname, or NULL. */ |
468 | extern char *language_class_name_from_physname (const struct language_defn *, | |
469 | const char *physname); | |
470 | ||
9f0a5303 JB |
471 | /* Splitting strings into words. */ |
472 | extern char *default_word_break_characters (void); | |
473 | ||
e79af960 JB |
474 | /* Print the index of an array element using the C99 syntax. */ |
475 | extern void default_print_array_index (struct value *index_value, | |
476 | struct ui_file *stream, | |
79a45b7d | 477 | const struct value_print_options *options); |
e79af960 | 478 | |
41f1b697 DJ |
479 | /* Return non-zero if TYPE should be passed (and returned) by |
480 | reference at the language level. */ | |
481 | int language_pass_by_reference (struct type *type); | |
482 | ||
483 | /* Return zero; by default, types are passed by value at the language | |
484 | level. The target ABI may pass or return some structs by reference | |
485 | independent of this. */ | |
486 | int default_pass_by_reference (struct type *type); | |
487 | ||
5c6ce71d TT |
488 | /* The default implementation of la_print_typedef. */ |
489 | void default_print_typedef (struct type *type, struct symbol *new_symbol, | |
490 | struct ui_file *stream); | |
491 | ||
c5aa993b | 492 | #endif /* defined (LANGUAGE_H) */ |