Commit | Line | Data |
---|---|---|
c906108c | 1 | /* Source-language-related definitions for GDB. |
1bac305b | 2 | |
e2882c85 | 3 | Copyright (C) 1991-2018 Free Software Foundation, Inc. |
1bac305b | 4 | |
c906108c SS |
5 | Contributed by the Department of Computer Science at the State University |
6 | of New York at Buffalo. | |
7 | ||
c5aa993b | 8 | This file is part of GDB. |
c906108c | 9 | |
c5aa993b JM |
10 | This program is free software; you can redistribute it and/or modify |
11 | it under the terms of the GNU General Public License as published by | |
a9762ec7 | 12 | the Free Software Foundation; either version 3 of the License, or |
c5aa993b | 13 | (at your option) any later version. |
c906108c | 14 | |
c5aa993b JM |
15 | This program is distributed in the hope that it will be useful, |
16 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
17 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
18 | GNU General Public License for more details. | |
c906108c | 19 | |
c5aa993b | 20 | You should have received a copy of the GNU General Public License |
a9762ec7 | 21 | along with this program. If not, see <http://www.gnu.org/licenses/>. */ |
c906108c SS |
22 | |
23 | #if !defined (LANGUAGE_H) | |
24 | #define LANGUAGE_H 1 | |
25 | ||
671afef6 | 26 | #include "symtab.h" |
14bc53a8 | 27 | #include "common/function-view.h" |
e9d9f57e | 28 | #include "expression.h" |
671afef6 | 29 | |
1777feb0 | 30 | /* Forward decls for prototypes. */ |
c906108c SS |
31 | struct value; |
32 | struct objfile; | |
52f729a7 | 33 | struct frame_info; |
da3331ec | 34 | struct ui_file; |
79a45b7d | 35 | struct value_print_options; |
79d43c61 | 36 | struct type_print_options; |
a53b64ea | 37 | struct lang_varobj_ops; |
410a0ff2 | 38 | struct parser_state; |
bb2ec1b3 | 39 | struct compile_instance; |
a207cff2 | 40 | struct completion_match_for_lcd; |
62dfaa9c | 41 | |
1777feb0 | 42 | #define MAX_FORTRAN_DIMS 7 /* Maximum number of F77 array dims. */ |
c906108c SS |
43 | |
44 | /* range_mode == | |
45 | range_mode_auto: range_check set automatically to default of language. | |
46 | range_mode_manual: range_check set manually by user. */ | |
47 | ||
c5aa993b JM |
48 | extern enum range_mode |
49 | { | |
50 | range_mode_auto, range_mode_manual | |
51 | } | |
52 | range_mode; | |
c906108c SS |
53 | |
54 | /* range_check == | |
55 | range_check_on: Ranges are checked in GDB expressions, producing errors. | |
56 | range_check_warn: Ranges are checked, producing warnings. | |
57 | range_check_off: Ranges are not checked in GDB expressions. */ | |
58 | ||
59 | extern enum range_check | |
c5aa993b JM |
60 | { |
61 | range_check_off, range_check_warn, range_check_on | |
62 | } | |
63 | range_check; | |
c906108c | 64 | |
63872f9d | 65 | /* case_mode == |
1777feb0 | 66 | case_mode_auto: case_sensitivity set upon selection of scope. |
63872f9d JG |
67 | case_mode_manual: case_sensitivity set only by user. */ |
68 | ||
69 | extern enum case_mode | |
70 | { | |
71 | case_mode_auto, case_mode_manual | |
72 | } | |
73 | case_mode; | |
74 | ||
7ca2d3a3 | 75 | /* array_ordering == |
1777feb0 MS |
76 | array_row_major: Arrays are in row major order. |
77 | array_column_major: Arrays are in column major order. */ | |
7ca2d3a3 DL |
78 | |
79 | extern enum array_ordering | |
80 | { | |
81 | array_row_major, array_column_major | |
82 | } | |
83 | array_ordering; | |
84 | ||
85 | ||
63872f9d | 86 | /* case_sensitivity == |
1777feb0 MS |
87 | case_sensitive_on: Case sensitivity in name matching is used. |
88 | case_sensitive_off: Case sensitivity in name matching is not used. */ | |
63872f9d JG |
89 | |
90 | extern enum case_sensitivity | |
91 | { | |
92 | case_sensitive_on, case_sensitive_off | |
93 | } | |
94 | case_sensitivity; | |
9a044a89 TT |
95 | |
96 | ||
97 | /* macro_expansion == | |
1777feb0 MS |
98 | macro_expansion_no: No macro expansion is available. |
99 | macro_expansion_c: C-like macro expansion is available. */ | |
9a044a89 TT |
100 | |
101 | enum macro_expansion | |
102 | { | |
103 | macro_expansion_no, macro_expansion_c | |
104 | }; | |
105 | ||
c906108c | 106 | \f |
f290d38e AC |
107 | /* Per architecture (OS/ABI) language information. */ |
108 | ||
109 | struct language_arch_info | |
110 | { | |
5a44ea29 | 111 | /* Its primitive types. This is a vector ended by a NULL pointer. |
f290d38e AC |
112 | These types can be specified by name in parsing types in |
113 | expressions, regardless of whether the program being debugged | |
114 | actually defines such a type. */ | |
5a44ea29 | 115 | struct type **primitive_type_vector; |
1994afbf DE |
116 | |
117 | /* Symbol wrappers around primitive_type_vector, so that the symbol lookup | |
118 | machinery can return them. */ | |
119 | struct symbol **primitive_type_symbols; | |
120 | ||
1777feb0 | 121 | /* Type of elements of strings. */ |
f290d38e | 122 | struct type *string_char_type; |
fbb06eb1 UW |
123 | |
124 | /* Symbol name of type to use as boolean type, if defined. */ | |
125 | const char *bool_type_symbol; | |
126 | /* Otherwise, this is the default boolean builtin type. */ | |
127 | struct type *bool_type_default; | |
f290d38e AC |
128 | }; |
129 | ||
c906108c SS |
130 | /* Structure tying together assorted information about a language. */ |
131 | ||
132 | struct language_defn | |
c5aa993b | 133 | { |
1777feb0 | 134 | /* Name of the language. */ |
c906108c | 135 | |
27cd387b | 136 | const char *la_name; |
c906108c | 137 | |
6abde28f YQ |
138 | /* Natural or official name of the language. */ |
139 | ||
140 | const char *la_natural_name; | |
141 | ||
1777feb0 | 142 | /* its symtab language-enum (defs.h). */ |
c906108c | 143 | |
c5aa993b | 144 | enum language la_language; |
c906108c | 145 | |
1777feb0 | 146 | /* Default range checking. */ |
c906108c | 147 | |
c5aa993b | 148 | enum range_check la_range_check; |
c906108c | 149 | |
1777feb0 | 150 | /* Default case sensitivity. */ |
63872f9d JG |
151 | enum case_sensitivity la_case_sensitivity; |
152 | ||
1777feb0 | 153 | /* Multi-dimensional array ordering. */ |
7ca2d3a3 DL |
154 | enum array_ordering la_array_ordering; |
155 | ||
9a044a89 TT |
156 | /* Style of macro expansion, if any, supported by this language. */ |
157 | enum macro_expansion la_macro_expansion; | |
158 | ||
56618e20 TT |
159 | /* A NULL-terminated array of file extensions for this language. |
160 | The extension must include the ".", like ".c". If this | |
161 | language doesn't need to provide any filename extensions, this | |
162 | may be NULL. */ | |
163 | ||
164 | const char *const *la_filename_extensions; | |
165 | ||
5f9769d1 | 166 | /* Definitions related to expression printing, prefixifying, and |
1777feb0 | 167 | dumping. */ |
5f9769d1 PH |
168 | |
169 | const struct exp_descriptor *la_exp_desc; | |
170 | ||
1777feb0 | 171 | /* Parser function. */ |
c906108c | 172 | |
410a0ff2 | 173 | int (*la_parser) (struct parser_state *); |
c906108c | 174 | |
1777feb0 | 175 | /* Parser error function. */ |
c906108c | 176 | |
a121b7c1 | 177 | void (*la_error) (const char *); |
c906108c | 178 | |
e85c3284 PH |
179 | /* Given an expression *EXPP created by prefixifying the result of |
180 | la_parser, perform any remaining processing necessary to complete | |
181 | its translation. *EXPP may change; la_post_parser is responsible | |
182 | for releasing its previous contents, if necessary. If | |
183 | VOID_CONTEXT_P, then no value is expected from the expression. */ | |
184 | ||
e9d9f57e | 185 | void (*la_post_parser) (expression_up *expp, int void_context_p); |
e85c3284 | 186 | |
3e43a32a MS |
187 | void (*la_printchar) (int ch, struct type *chtype, |
188 | struct ui_file * stream); | |
c906108c | 189 | |
6c7a06a3 TT |
190 | void (*la_printstr) (struct ui_file * stream, struct type *elttype, |
191 | const gdb_byte *string, unsigned int length, | |
be759fcf | 192 | const char *encoding, int force_ellipses, |
79a45b7d | 193 | const struct value_print_options *); |
c906108c | 194 | |
6c7a06a3 TT |
195 | void (*la_emitchar) (int ch, struct type *chtype, |
196 | struct ui_file * stream, int quoter); | |
c906108c | 197 | |
1777feb0 | 198 | /* Print a type using syntax appropriate for this language. */ |
c906108c | 199 | |
25b524e8 | 200 | void (*la_print_type) (struct type *, const char *, struct ui_file *, int, |
79d43c61 | 201 | int, const struct type_print_options *); |
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 | ||
edf3d5f3 TT |
210 | /* Print a value using syntax appropriate for this language. |
211 | ||
212 | TYPE is the type of the sub-object to be printed. | |
c906108c | 213 | |
edf3d5f3 TT |
214 | EMBEDDED_OFFSET is the offset into the outermost object of the |
215 | sub-object represented by TYPE. This is the object which this | |
216 | call should print. Note that the enclosing type is not | |
217 | available. | |
218 | ||
219 | ADDRESS is the address in the inferior of the enclosing object. | |
220 | ||
221 | STREAM is the stream on which the value is to be printed. | |
222 | ||
223 | RECURSE is the recursion depth. It is zero-based. | |
224 | ||
225 | OPTIONS are the formatting options to be used when | |
226 | printing. */ | |
227 | ||
d3eab38a | 228 | void (*la_val_print) (struct type *type, |
d3eab38a TT |
229 | int embedded_offset, CORE_ADDR address, |
230 | struct ui_file *stream, int recurse, | |
e8b24d9f | 231 | struct value *val, |
d3eab38a | 232 | const struct value_print_options *options); |
c906108c | 233 | |
1777feb0 | 234 | /* Print a top-level value using syntax appropriate for this language. */ |
c906108c | 235 | |
8e069a98 TT |
236 | void (*la_value_print) (struct value *, struct ui_file *, |
237 | const struct value_print_options *); | |
c906108c | 238 | |
63e43d3a PMR |
239 | /* Given a symbol VAR, the corresponding block VAR_BLOCK (if any) and a |
240 | stack frame id FRAME, read the value of the variable and return (pointer | |
241 | to a) struct value containing the value. | |
242 | ||
243 | VAR_BLOCK is needed if there's a possibility for VAR to be outside | |
244 | FRAME. This is what happens if FRAME correspond to a nested function | |
245 | and VAR is defined in the outer function. If callers know that VAR is | |
246 | located in FRAME or is global/static, NULL can be passed as VAR_BLOCK. | |
a5ee536b JB |
247 | |
248 | Throw an error if the variable cannot be found. */ | |
249 | ||
250 | struct value *(*la_read_var_value) (struct symbol *var, | |
63e43d3a | 251 | const struct block *var_block, |
a5ee536b JB |
252 | struct frame_info *frame); |
253 | ||
f636b87d AF |
254 | /* PC is possibly an unknown languages trampoline. |
255 | If that PC falls in a trampoline belonging to this language, | |
256 | return the address of the first pc in the real function, or 0 | |
257 | if it isn't a language tramp for this language. */ | |
52f729a7 | 258 | CORE_ADDR (*skip_trampoline) (struct frame_info *, CORE_ADDR); |
f636b87d | 259 | |
5f9a71c3 DC |
260 | /* Now come some hooks for lookup_symbol. */ |
261 | ||
2b2d9e11 VP |
262 | /* If this is non-NULL, specifies the name that of the implicit |
263 | local variable that refers to the current object instance. */ | |
5f9a71c3 | 264 | |
a121b7c1 | 265 | const char *la_name_of_this; |
5f9a71c3 DC |
266 | |
267 | /* This is a function that lookup_symbol will call when it gets to | |
268 | the part of symbol lookup where C looks up static and global | |
269 | variables. */ | |
270 | ||
d12307c1 PMR |
271 | struct block_symbol (*la_lookup_symbol_nonlocal) |
272 | (const struct language_defn *, | |
273 | const char *, | |
274 | const struct block *, | |
275 | const domain_enum); | |
5f9a71c3 | 276 | |
b368761e DC |
277 | /* Find the definition of the type with the given name. */ |
278 | struct type *(*la_lookup_transparent_type) (const char *); | |
279 | ||
9a3d7dfd AF |
280 | /* Return demangled language symbol, or NULL. */ |
281 | char *(*la_demangle) (const char *mangled, int options); | |
282 | ||
8b302db8 TT |
283 | /* Demangle a symbol according to this language's rules. Unlike |
284 | la_demangle, this does not take any options. | |
285 | ||
286 | *DEMANGLED will be set by this function. | |
287 | ||
288 | If this function returns 0, then *DEMANGLED must always be set | |
289 | to NULL. | |
290 | ||
291 | If this function returns 1, the implementation may set this to | |
292 | a xmalloc'd string holding the demangled form. However, it is | |
293 | not required to. The string, if any, is owned by the caller. | |
294 | ||
295 | The resulting string should be of the form that will be | |
296 | installed into a symbol. */ | |
297 | int (*la_sniff_from_mangled_name) (const char *mangled, char **demangled); | |
298 | ||
31c27f77 JJ |
299 | /* Return class name of a mangled method name or NULL. */ |
300 | char *(*la_class_name_from_physname) (const char *physname); | |
301 | ||
1777feb0 | 302 | /* Table for printing expressions. */ |
c906108c | 303 | |
c5aa993b | 304 | const struct op_print *la_op_print_tab; |
c906108c | 305 | |
c5aa993b | 306 | /* Zero if the language has first-class arrays. True if there are no |
1777feb0 | 307 | array values, and array objects decay to pointers, as in C. */ |
c906108c | 308 | |
c5aa993b | 309 | char c_style_arrays; |
c906108c | 310 | |
1777feb0 | 311 | /* Index to use for extracting the first element of a string. */ |
c5aa993b | 312 | char string_lower_bound; |
c906108c | 313 | |
6084f43a | 314 | /* The list of characters forming word boundaries. */ |
67cb5b2d | 315 | const char *(*la_word_break_characters) (void); |
6084f43a | 316 | |
eb3ff9a5 | 317 | /* Add to the completion tracker all symbols which are possible |
49c4e619 | 318 | completions for TEXT. WORD is the entire command on which the |
2f68a895 TT |
319 | completion is being made. If CODE is TYPE_CODE_UNDEF, then all |
320 | symbols should be examined; otherwise, only STRUCT_DOMAIN | |
321 | symbols whose type has a code of CODE should be matched. */ | |
eb3ff9a5 PA |
322 | void (*la_collect_symbol_completion_matches) |
323 | (completion_tracker &tracker, | |
c6756f62 | 324 | complete_symbol_mode mode, |
b5ec771e | 325 | symbol_name_match_type match_type, |
eb3ff9a5 PA |
326 | const char *text, |
327 | const char *word, | |
328 | enum type_code code); | |
41d27058 | 329 | |
f290d38e AC |
330 | /* The per-architecture (OS/ABI) language information. */ |
331 | void (*la_language_arch_info) (struct gdbarch *, | |
332 | struct language_arch_info *); | |
333 | ||
e79af960 JB |
334 | /* Print the index of an element of an array. */ |
335 | void (*la_print_array_index) (struct value *index_value, | |
336 | struct ui_file *stream, | |
79a45b7d | 337 | const struct value_print_options *options); |
e79af960 | 338 | |
41f1b697 DJ |
339 | /* Return non-zero if TYPE should be passed (and returned) by |
340 | reference at the language level. */ | |
341 | int (*la_pass_by_reference) (struct type *type); | |
342 | ||
ae6a3a4c | 343 | /* Obtain a string from the inferior, storing it in a newly allocated |
fbb8f299 PM |
344 | buffer in BUFFER, which should be freed by the caller. If the |
345 | in- and out-parameter *LENGTH is specified at -1, the string is | |
346 | read until a null character of the appropriate width is found - | |
347 | otherwise the string is read to the length of characters specified. | |
348 | On completion, *LENGTH will hold the size of the string in characters. | |
349 | If a *LENGTH of -1 was specified it will count only actual | |
350 | characters, excluding any eventual terminating null character. | |
351 | Otherwise *LENGTH will include all characters - including any nulls. | |
352 | CHARSET will hold the encoding used in the string. */ | |
ae6a3a4c | 353 | void (*la_get_string) (struct value *value, gdb_byte **buffer, int *length, |
96c07c5b | 354 | struct type **chartype, const char **charset); |
ae6a3a4c | 355 | |
43cc5389 TT |
356 | /* Return an expression that can be used for a location |
357 | watchpoint. TYPE is a pointer type that points to the memory | |
358 | to watch, and ADDR is the address of the watched memory. */ | |
359 | gdb::unique_xmalloc_ptr<char> (*la_watch_location_expression) | |
360 | (struct type *type, CORE_ADDR addr); | |
361 | ||
b5ec771e PA |
362 | /* Return a pointer to the function that should be used to match a |
363 | symbol name against LOOKUP_NAME, according to this language's | |
364 | rules. The matching algorithm depends on LOOKUP_NAME. For | |
365 | example, on Ada, the matching algorithm depends on the symbol | |
366 | name (wild/full/verbatim matching), and on whether we're doing | |
367 | a normal lookup or a completion match lookup. | |
f8eba3c6 | 368 | |
b5ec771e PA |
369 | This field may be NULL, in which case |
370 | default_symbol_name_matcher is used to perform the | |
371 | matching. */ | |
372 | symbol_name_matcher_ftype *(*la_get_symbol_name_matcher) | |
373 | (const lookup_name_info &); | |
f8eba3c6 TT |
374 | |
375 | /* Find all symbols in the current program space matching NAME in | |
376 | DOMAIN, according to this language's rules. | |
377 | ||
4eeaa230 DE |
378 | The search is done in BLOCK only. |
379 | The caller is responsible for iterating up through superblocks | |
380 | if desired. | |
f8eba3c6 | 381 | |
14bc53a8 PA |
382 | For each one, call CALLBACK with the symbol. If CALLBACK |
383 | returns false, the iteration ends at that point. | |
f8eba3c6 | 384 | |
72e1143f TT |
385 | This field may not be NULL. If the language does not need any |
386 | special processing here, 'iterate_over_symbols' should be | |
387 | used as the definition. */ | |
14bc53a8 | 388 | void (*la_iterate_over_symbols) |
b5ec771e PA |
389 | (const struct block *block, const lookup_name_info &name, |
390 | domain_enum domain, | |
14bc53a8 | 391 | gdb::function_view<symbol_found_callback_ftype> callback); |
f8eba3c6 | 392 | |
5ffa0793 PA |
393 | /* Hash the given symbol search name. Use |
394 | default_search_name_hash if no special treatment is | |
395 | required. */ | |
396 | unsigned int (*la_search_name_hash) (const char *name); | |
397 | ||
a53b64ea YQ |
398 | /* Various operations on varobj. */ |
399 | const struct lang_varobj_ops *la_varobj_ops; | |
400 | ||
bb2ec1b3 TT |
401 | /* If this language allows compilation from the gdb command line, |
402 | this method should be non-NULL. When called it should return | |
403 | an instance of struct gcc_context appropriate to the language. | |
404 | When defined this method must never return NULL; instead it | |
405 | should throw an exception on failure. The returned compiler | |
406 | instance is owned by its caller and must be deallocated by | |
407 | calling its 'destroy' method. */ | |
408 | ||
409 | struct compile_instance *(*la_get_compile_instance) (void); | |
410 | ||
411 | /* This method must be defined if 'la_get_gcc_context' is defined. | |
412 | If 'la_get_gcc_context' is not defined, then this method is | |
413 | ignored. | |
414 | ||
aaee65ae PA |
415 | This takes the user-supplied text and returns a new bit of code |
416 | to compile. | |
bb2ec1b3 TT |
417 | |
418 | INST is the compiler instance being used. | |
419 | INPUT is the user's input text. | |
420 | GDBARCH is the architecture to use. | |
421 | EXPR_BLOCK is the block in which the expression is being | |
422 | parsed. | |
423 | EXPR_PC is the PC at which the expression is being parsed. */ | |
424 | ||
aaee65ae PA |
425 | std::string (*la_compute_program) (struct compile_instance *inst, |
426 | const char *input, | |
427 | struct gdbarch *gdbarch, | |
428 | const struct block *expr_block, | |
429 | CORE_ADDR expr_pc); | |
bb2ec1b3 | 430 | |
1777feb0 MS |
431 | /* Add fields above this point, so the magic number is always last. */ |
432 | /* Magic number for compat checking. */ | |
c5aa993b JM |
433 | |
434 | long la_magic; | |
435 | ||
436 | }; | |
c906108c SS |
437 | |
438 | #define LANG_MAGIC 910823L | |
439 | ||
440 | /* Pointer to the language_defn for our current language. This pointer | |
441 | always points to *some* valid struct; it can be used without checking | |
442 | it for validity. | |
443 | ||
444 | The current language affects expression parsing and evaluation | |
445 | (FIXME: it might be cleaner to make the evaluation-related stuff | |
446 | separate exp_opcodes for each different set of semantics. We | |
447 | should at least think this through more clearly with respect to | |
448 | what happens if the language is changed between parsing and | |
449 | evaluation) and printing of things like types and arrays. It does | |
450 | *not* affect symbol-reading-- each source file in a symbol-file has | |
451 | its own language and we should keep track of that regardless of the | |
452 | language when symbols are read. If we want some manual setting for | |
453 | the language of symbol files (e.g. detecting when ".c" files are | |
7e73cedf | 454 | C++), it should be a separate setting from the current_language. */ |
c906108c SS |
455 | |
456 | extern const struct language_defn *current_language; | |
457 | ||
458 | /* Pointer to the language_defn expected by the user, e.g. the language | |
459 | of main(), or the language we last mentioned in a message, or C. */ | |
460 | ||
461 | extern const struct language_defn *expected_language; | |
462 | ||
463 | /* language_mode == | |
464 | language_mode_auto: current_language automatically set upon selection | |
c5aa993b | 465 | of scope (e.g. stack frame) |
c906108c SS |
466 | language_mode_manual: current_language set only by user. */ |
467 | ||
468 | extern enum language_mode | |
c5aa993b JM |
469 | { |
470 | language_mode_auto, language_mode_manual | |
471 | } | |
472 | language_mode; | |
b62f3443 | 473 | |
fbb06eb1 UW |
474 | struct type *language_bool_type (const struct language_defn *l, |
475 | struct gdbarch *gdbarch); | |
476 | ||
b62f3443 JB |
477 | struct type *language_string_char_type (const struct language_defn *l, |
478 | struct gdbarch *gdbarch); | |
479 | ||
1994afbf DE |
480 | /* Look up type NAME in language L, and return its definition for architecture |
481 | GDBARCH. Returns NULL if not found. */ | |
482 | ||
46b0da17 DE |
483 | struct type *language_lookup_primitive_type (const struct language_defn *l, |
484 | struct gdbarch *gdbarch, | |
485 | const char *name); | |
b62f3443 | 486 | |
1994afbf DE |
487 | /* Wrapper around language_lookup_primitive_type to return the |
488 | corresponding symbol. */ | |
489 | ||
490 | struct symbol * | |
491 | language_lookup_primitive_type_as_symbol (const struct language_defn *l, | |
492 | struct gdbarch *gdbarch, | |
493 | const char *name); | |
494 | ||
c906108c SS |
495 | \f |
496 | /* These macros define the behaviour of the expression | |
497 | evaluator. */ | |
498 | ||
1777feb0 | 499 | /* Should we range check values against the domain of their type? */ |
c906108c SS |
500 | #define RANGE_CHECK (range_check != range_check_off) |
501 | ||
1777feb0 MS |
502 | /* "cast" really means conversion. */ |
503 | /* FIXME -- should be a setting in language_defn. */ | |
cc73bb8c TT |
504 | #define CAST_IS_CONVERSION(LANG) ((LANG)->la_language == language_c || \ |
505 | (LANG)->la_language == language_cplus || \ | |
506 | (LANG)->la_language == language_objc) | |
c906108c | 507 | |
a14ed312 | 508 | extern void language_info (int); |
c906108c | 509 | |
a14ed312 | 510 | extern enum language set_language (enum language); |
c906108c | 511 | \f |
c5aa993b | 512 | |
c906108c SS |
513 | /* This page contains functions that return things that are |
514 | specific to languages. Each of these functions is based on | |
515 | the current setting of working_lang, which the user sets | |
1777feb0 | 516 | with the "set language" command. */ |
c906108c | 517 | |
79d43c61 TT |
518 | #define LA_PRINT_TYPE(type,varstring,stream,show,level,flags) \ |
519 | (current_language->la_print_type(type,varstring,stream,show,level,flags)) | |
c906108c | 520 | |
5c6ce71d TT |
521 | #define LA_PRINT_TYPEDEF(type,new_symbol,stream) \ |
522 | (current_language->la_print_typedef(type,new_symbol,stream)) | |
523 | ||
79a45b7d TT |
524 | #define LA_VALUE_PRINT(val,stream,options) \ |
525 | (current_language->la_value_print(val,stream,options)) | |
c906108c | 526 | |
6c7a06a3 TT |
527 | #define LA_PRINT_CHAR(ch, type, stream) \ |
528 | (current_language->la_printchar(ch, type, stream)) | |
3e43a32a | 529 | #define LA_PRINT_STRING(stream, elttype, string, length, encoding, force_ellipses, options) \ |
6c7a06a3 | 530 | (current_language->la_printstr(stream, elttype, string, length, \ |
be759fcf | 531 | encoding, force_ellipses,options)) |
6c7a06a3 TT |
532 | #define LA_EMIT_CHAR(ch, type, stream, quoter) \ |
533 | (current_language->la_emitchar(ch, type, stream, quoter)) | |
96c07c5b TT |
534 | #define LA_GET_STRING(value, buffer, length, chartype, encoding) \ |
535 | (current_language->la_get_string(value, buffer, length, chartype, encoding)) | |
c906108c | 536 | |
577ce03a | 537 | #define LA_PRINT_ARRAY_INDEX(index_value, stream, options) \ |
79a45b7d | 538 | (current_language->la_print_array_index(index_value, stream, options)) |
e79af960 | 539 | |
14bc53a8 PA |
540 | #define LA_ITERATE_OVER_SYMBOLS(BLOCK, NAME, DOMAIN, CALLBACK) \ |
541 | (current_language->la_iterate_over_symbols (BLOCK, NAME, DOMAIN, CALLBACK)) | |
f8eba3c6 | 542 | |
c906108c SS |
543 | /* Test a character to decide whether it can be printed in literal form |
544 | or needs to be printed in another representation. For example, | |
545 | in C the literal form of the character with octal value 141 is 'a' | |
546 | and the "other representation" is '\141'. The "other representation" | |
1777feb0 | 547 | is program language dependent. */ |
c906108c SS |
548 | |
549 | #define PRINT_LITERAL_FORM(c) \ | |
550 | ((c) >= 0x20 \ | |
551 | && ((c) < 0x7F || (c) >= 0xA0) \ | |
552 | && (!sevenbit_strings || (c) < 0x80)) | |
553 | ||
c906108c SS |
554 | /* Type predicates */ |
555 | ||
a14ed312 | 556 | extern int pointer_type (struct type *); |
c906108c | 557 | |
c906108c SS |
558 | /* Error messages */ |
559 | ||
a0b31db1 | 560 | extern void range_error (const char *, ...) ATTRIBUTE_PRINTF (1, 2); |
c906108c SS |
561 | |
562 | /* Data: Does this value represent "truth" to the current language? */ | |
563 | ||
a14ed312 | 564 | extern int value_true (struct value *); |
c906108c | 565 | |
c906108c SS |
566 | /* Misc: The string representing a particular enum language. */ |
567 | ||
2039bd9f | 568 | extern enum language language_enum (const char *str); |
c906108c | 569 | |
a14ed312 | 570 | extern const struct language_defn *language_def (enum language); |
7a292a7a | 571 | |
27cd387b | 572 | extern const char *language_str (enum language); |
c906108c | 573 | |
1777feb0 | 574 | /* Check for a language-specific trampoline. */ |
f636b87d | 575 | |
52f729a7 | 576 | extern CORE_ADDR skip_language_trampoline (struct frame_info *, CORE_ADDR pc); |
f636b87d | 577 | |
9a3d7dfd AF |
578 | /* Return demangled language symbol, or NULL. */ |
579 | extern char *language_demangle (const struct language_defn *current_language, | |
580 | const char *mangled, int options); | |
581 | ||
8b302db8 TT |
582 | /* A wrapper for la_sniff_from_mangled_name. The arguments and result |
583 | are as for the method. */ | |
584 | ||
585 | extern int language_sniff_from_mangled_name (const struct language_defn *lang, | |
586 | const char *mangled, | |
587 | char **demangled); | |
588 | ||
31c27f77 JJ |
589 | /* Return class name from physname, or NULL. */ |
590 | extern char *language_class_name_from_physname (const struct language_defn *, | |
591 | const char *physname); | |
592 | ||
9f0a5303 | 593 | /* Splitting strings into words. */ |
67cb5b2d | 594 | extern const char *default_word_break_characters (void); |
9f0a5303 | 595 | |
e79af960 JB |
596 | /* Print the index of an array element using the C99 syntax. */ |
597 | extern void default_print_array_index (struct value *index_value, | |
598 | struct ui_file *stream, | |
79a45b7d | 599 | const struct value_print_options *options); |
e79af960 | 600 | |
41f1b697 DJ |
601 | /* Return non-zero if TYPE should be passed (and returned) by |
602 | reference at the language level. */ | |
603 | int language_pass_by_reference (struct type *type); | |
604 | ||
605 | /* Return zero; by default, types are passed by value at the language | |
606 | level. The target ABI may pass or return some structs by reference | |
607 | independent of this. */ | |
608 | int default_pass_by_reference (struct type *type); | |
609 | ||
5c6ce71d TT |
610 | /* The default implementation of la_print_typedef. */ |
611 | void default_print_typedef (struct type *type, struct symbol *new_symbol, | |
612 | struct ui_file *stream); | |
613 | ||
ae6a3a4c | 614 | void default_get_string (struct value *value, gdb_byte **buffer, int *length, |
96c07c5b | 615 | struct type **char_type, const char **charset); |
ae6a3a4c | 616 | |
5ffa0793 PA |
617 | /* Default name hashing function. */ |
618 | ||
619 | /* Produce an unsigned hash value from SEARCH_NAME that is consistent | |
620 | with strcmp_iw, strcmp, and, at least on Ada symbols, wild_match. | |
621 | That is, two identifiers equivalent according to any of those three | |
622 | comparison operators hash to the same value. */ | |
623 | extern unsigned int default_search_name_hash (const char *search_name); | |
624 | ||
ae6a3a4c | 625 | void c_get_string (struct value *value, gdb_byte **buffer, int *length, |
96c07c5b | 626 | struct type **char_type, const char **charset); |
ae6a3a4c | 627 | |
b5ec771e PA |
628 | /* The default implementation of la_symbol_name_matcher. Matches with |
629 | strncmp_iw. */ | |
630 | extern bool default_symbol_name_matcher | |
631 | (const char *symbol_search_name, | |
632 | const lookup_name_info &lookup_name, | |
a207cff2 | 633 | completion_match_result *comp_match_res); |
b5ec771e PA |
634 | |
635 | /* Get LANG's symbol_name_matcher method for LOOKUP_NAME. Returns | |
c63d3e8d PA |
636 | default_symbol_name_matcher if not set. LANG is used as a hint; |
637 | the function may ignore it depending on the current language and | |
638 | LOOKUP_NAME. Specifically, if the current language is Ada, this | |
639 | may return an Ada matcher regardless of LANG. */ | |
618daa93 | 640 | symbol_name_matcher_ftype *get_symbol_name_matcher |
b5ec771e PA |
641 | (const language_defn *lang, const lookup_name_info &lookup_name); |
642 | ||
47e77640 PA |
643 | /* The languages supported by GDB. */ |
644 | ||
645 | extern const struct language_defn auto_language_defn; | |
646 | extern const struct language_defn unknown_language_defn; | |
647 | extern const struct language_defn minimal_language_defn; | |
648 | ||
649 | extern const struct language_defn ada_language_defn; | |
650 | extern const struct language_defn asm_language_defn; | |
651 | extern const struct language_defn c_language_defn; | |
652 | extern const struct language_defn cplus_language_defn; | |
653 | extern const struct language_defn d_language_defn; | |
654 | extern const struct language_defn f_language_defn; | |
655 | extern const struct language_defn go_language_defn; | |
656 | extern const struct language_defn m2_language_defn; | |
657 | extern const struct language_defn objc_language_defn; | |
658 | extern const struct language_defn opencl_language_defn; | |
659 | extern const struct language_defn pascal_language_defn; | |
660 | extern const struct language_defn rust_language_defn; | |
661 | ||
e3ad2841 TT |
662 | /* Save the current language and restore it upon destruction. */ |
663 | ||
664 | class scoped_restore_current_language | |
665 | { | |
666 | public: | |
667 | ||
668 | explicit scoped_restore_current_language () | |
669 | : m_lang (current_language->la_language) | |
670 | { | |
671 | } | |
672 | ||
673 | ~scoped_restore_current_language () | |
674 | { | |
675 | set_language (m_lang); | |
676 | } | |
677 | ||
678 | scoped_restore_current_language (const scoped_restore_current_language &) | |
679 | = delete; | |
680 | scoped_restore_current_language &operator= | |
681 | (const scoped_restore_current_language &) = delete; | |
682 | ||
683 | private: | |
684 | ||
685 | enum language m_lang; | |
686 | }; | |
687 | ||
c5aa993b | 688 | #endif /* defined (LANGUAGE_H) */ |