Commit | Line | Data |
---|---|---|
c906108c | 1 | /* Source-language-related definitions for GDB. |
1bac305b | 2 | |
b811d2c2 | 3 | Copyright (C) 1991-2020 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" |
268a13a5 | 27 | #include "gdbsupport/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; |
9cdfd9a2 | 39 | class compile_instance; |
a207cff2 | 40 | struct completion_match_for_lcd; |
699bd4cf | 41 | class innermost_block_tracker; |
62dfaa9c | 42 | |
1777feb0 | 43 | #define MAX_FORTRAN_DIMS 7 /* Maximum number of F77 array dims. */ |
c906108c SS |
44 | |
45 | /* range_mode == | |
46 | range_mode_auto: range_check set automatically to default of language. | |
47 | range_mode_manual: range_check set manually by user. */ | |
48 | ||
c5aa993b JM |
49 | extern enum range_mode |
50 | { | |
51 | range_mode_auto, range_mode_manual | |
52 | } | |
53 | range_mode; | |
c906108c SS |
54 | |
55 | /* range_check == | |
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. */ | |
59 | ||
60 | extern enum range_check | |
c5aa993b JM |
61 | { |
62 | range_check_off, range_check_warn, range_check_on | |
63 | } | |
64 | range_check; | |
c906108c | 65 | |
63872f9d | 66 | /* case_mode == |
1777feb0 | 67 | case_mode_auto: case_sensitivity set upon selection of scope. |
63872f9d JG |
68 | case_mode_manual: case_sensitivity set only by user. */ |
69 | ||
70 | extern enum case_mode | |
71 | { | |
72 | case_mode_auto, case_mode_manual | |
73 | } | |
74 | case_mode; | |
75 | ||
7ca2d3a3 | 76 | /* array_ordering == |
1777feb0 MS |
77 | array_row_major: Arrays are in row major order. |
78 | array_column_major: Arrays are in column major order. */ | |
7ca2d3a3 DL |
79 | |
80 | extern enum array_ordering | |
81 | { | |
82 | array_row_major, array_column_major | |
83 | } | |
84 | array_ordering; | |
85 | ||
86 | ||
63872f9d | 87 | /* case_sensitivity == |
1777feb0 MS |
88 | case_sensitive_on: Case sensitivity in name matching is used. |
89 | case_sensitive_off: Case sensitivity in name matching is not used. */ | |
63872f9d JG |
90 | |
91 | extern enum case_sensitivity | |
92 | { | |
93 | case_sensitive_on, case_sensitive_off | |
94 | } | |
95 | case_sensitivity; | |
9a044a89 TT |
96 | |
97 | ||
98 | /* macro_expansion == | |
1777feb0 MS |
99 | macro_expansion_no: No macro expansion is available. |
100 | macro_expansion_c: C-like macro expansion is available. */ | |
9a044a89 TT |
101 | |
102 | enum macro_expansion | |
103 | { | |
104 | macro_expansion_no, macro_expansion_c | |
105 | }; | |
106 | ||
c906108c | 107 | \f |
f290d38e AC |
108 | /* Per architecture (OS/ABI) language information. */ |
109 | ||
110 | struct language_arch_info | |
111 | { | |
5a44ea29 | 112 | /* Its primitive types. This is a vector ended by a NULL pointer. |
f290d38e AC |
113 | These types can be specified by name in parsing types in |
114 | expressions, regardless of whether the program being debugged | |
115 | actually defines such a type. */ | |
5a44ea29 | 116 | struct type **primitive_type_vector; |
1994afbf DE |
117 | |
118 | /* Symbol wrappers around primitive_type_vector, so that the symbol lookup | |
119 | machinery can return them. */ | |
120 | struct symbol **primitive_type_symbols; | |
121 | ||
1777feb0 | 122 | /* Type of elements of strings. */ |
f290d38e | 123 | struct type *string_char_type; |
fbb06eb1 UW |
124 | |
125 | /* Symbol name of type to use as boolean type, if defined. */ | |
126 | const char *bool_type_symbol; | |
127 | /* Otherwise, this is the default boolean builtin type. */ | |
128 | struct type *bool_type_default; | |
f290d38e AC |
129 | }; |
130 | ||
9d084466 TBA |
131 | /* In a language (particularly C++) a function argument of an aggregate |
132 | type (i.e. class/struct/union) may be implicitly passed by reference | |
133 | even though it is declared a call-by-value argument in the source. | |
134 | The struct below puts together necessary information for GDB to be | |
135 | able to detect and carry out pass-by-reference semantics for a | |
136 | particular type. This type is referred as T in the inlined comments | |
137 | below. | |
138 | ||
139 | The default values of the fields are chosen to give correct semantics | |
140 | for primitive types and for simple aggregate types, such as | |
141 | ||
142 | class T { | |
143 | int x; | |
144 | }; */ | |
145 | ||
146 | struct language_pass_by_ref_info | |
147 | { | |
148 | /* True if an argument of type T can be passed to a function by value | |
149 | (i.e. not through an implicit reference). False, otherwise. */ | |
150 | bool trivially_copyable = true; | |
151 | ||
152 | /* True if a copy of a value of type T can be initialized by | |
153 | memcpy'ing the value bit-by-bit. False, otherwise. | |
154 | E.g. If T has a user-defined copy ctor, this should be false. */ | |
155 | bool trivially_copy_constructible = true; | |
156 | ||
157 | /* True if a value of type T can be destructed simply by reclaiming | |
158 | the memory area occupied by the value. False, otherwise. | |
159 | E.g. If T has a user-defined destructor, this should be false. */ | |
160 | bool trivially_destructible = true; | |
161 | ||
162 | /* True if it is allowed to create a copy of a value of type T. | |
163 | False, otherwise. | |
164 | E.g. If T has a deleted copy ctor, this should be false. */ | |
165 | bool copy_constructible = true; | |
166 | ||
167 | /* True if a value of type T can be destructed. False, otherwise. | |
168 | E.g. If T has a deleted destructor, this should be false. */ | |
169 | bool destructible = true; | |
170 | }; | |
171 | ||
53fc67f8 AB |
172 | /* Splitting strings into words. */ |
173 | extern const char *default_word_break_characters (void); | |
174 | ||
0874fd07 | 175 | /* Structure tying together assorted information about a language. |
c906108c | 176 | |
0874fd07 AB |
177 | As we move over from the old structure based languages to a class |
178 | hierarchy of languages this structure will continue to contain a | |
179 | mixture of both data and function pointers. | |
180 | ||
181 | Once the class hierarchy of languages in place the first task is to | |
182 | remove the function pointers from this structure and convert them into | |
183 | member functions on the different language classes. | |
184 | ||
185 | The current plan it to keep the constant data that describes a language | |
186 | in this structure, and have each language pass in an instance of this | |
187 | structure at construction time. */ | |
188 | ||
189 | struct language_data | |
c5aa993b | 190 | { |
1777feb0 | 191 | /* Default range checking. */ |
c906108c | 192 | |
c5aa993b | 193 | enum range_check la_range_check; |
c906108c | 194 | |
1777feb0 | 195 | /* Default case sensitivity. */ |
63872f9d JG |
196 | enum case_sensitivity la_case_sensitivity; |
197 | ||
1777feb0 | 198 | /* Multi-dimensional array ordering. */ |
7ca2d3a3 DL |
199 | enum array_ordering la_array_ordering; |
200 | ||
9a044a89 TT |
201 | /* Style of macro expansion, if any, supported by this language. */ |
202 | enum macro_expansion la_macro_expansion; | |
203 | ||
5f9769d1 | 204 | /* Definitions related to expression printing, prefixifying, and |
1777feb0 | 205 | dumping. */ |
5f9769d1 PH |
206 | |
207 | const struct exp_descriptor *la_exp_desc; | |
208 | ||
1777feb0 | 209 | /* Table for printing expressions. */ |
c906108c | 210 | |
c5aa993b | 211 | const struct op_print *la_op_print_tab; |
c906108c | 212 | |
a53b64ea YQ |
213 | /* Various operations on varobj. */ |
214 | const struct lang_varobj_ops *la_varobj_ops; | |
c5aa993b | 215 | }; |
c906108c | 216 | |
0874fd07 AB |
217 | /* Base class from which all other language classes derive. */ |
218 | ||
219 | struct language_defn : language_data | |
220 | { | |
221 | language_defn (enum language lang, const language_data &init_data) | |
85967615 AB |
222 | : language_data (init_data), |
223 | la_language (lang) | |
0874fd07 AB |
224 | { |
225 | /* We should only ever create one instance of each language. */ | |
226 | gdb_assert (languages[lang] == nullptr); | |
227 | languages[lang] = this; | |
228 | } | |
229 | ||
85967615 AB |
230 | /* Which language this is. */ |
231 | ||
232 | const enum language la_language; | |
233 | ||
6f7664a9 AB |
234 | /* Name of the language. */ |
235 | ||
236 | virtual const char *name () const = 0; | |
237 | ||
238 | /* Natural or official name of the language. */ | |
239 | ||
240 | virtual const char *natural_name () const = 0; | |
241 | ||
e171d6f1 AB |
242 | /* Return a vector of file extensions for this language. The extension |
243 | must include the ".", like ".c". If this language doesn't need to | |
244 | provide any filename extensions, this may be an empty vector (which is | |
245 | the default). */ | |
246 | ||
247 | virtual const std::vector<const char *> &filename_extensions () const | |
248 | { | |
249 | static const std::vector<const char *> no_extensions; | |
250 | return no_extensions; | |
251 | } | |
252 | ||
5bd40f2a AB |
253 | /* Print the index of an element of an array. This default |
254 | implementation prints using C99 syntax. */ | |
255 | ||
256 | virtual void print_array_index (struct type *index_type, | |
257 | LONGEST index_value, | |
258 | struct ui_file *stream, | |
259 | const value_print_options *options) const; | |
260 | ||
15e5fd35 AB |
261 | /* Given a symbol VAR, the corresponding block VAR_BLOCK (if any) and a |
262 | stack frame id FRAME, read the value of the variable and return (pointer | |
263 | to a) struct value containing the value. | |
264 | ||
265 | VAR_BLOCK is needed if there's a possibility for VAR to be outside | |
266 | FRAME. This is what happens if FRAME correspond to a nested function | |
267 | and VAR is defined in the outer function. If callers know that VAR is | |
268 | located in FRAME or is global/static, NULL can be passed as VAR_BLOCK. | |
269 | ||
270 | Throw an error if the variable cannot be found. */ | |
271 | ||
272 | virtual struct value *read_var_value (struct symbol *var, | |
273 | const struct block *var_block, | |
274 | struct frame_info *frame) const; | |
275 | ||
48448202 AB |
276 | /* Return information about whether TYPE should be passed |
277 | (and returned) by reference at the language level. The default | |
278 | implementation returns a LANGUAGE_PASS_BY_REF_INFO initialised in its | |
279 | default state. */ | |
280 | ||
281 | virtual struct language_pass_by_ref_info pass_by_reference_info | |
282 | (struct type *type) const | |
283 | { | |
284 | return {}; | |
285 | } | |
286 | ||
1fb314aa AB |
287 | /* The per-architecture (OS/ABI) language information. */ |
288 | ||
289 | virtual void language_arch_info (struct gdbarch *, | |
290 | struct language_arch_info *) const = 0; | |
291 | ||
54f4ca46 AB |
292 | /* Find the definition of the type with the given name. */ |
293 | ||
294 | virtual struct type *lookup_transparent_type (const char *name) const | |
295 | { | |
296 | return basic_lookup_transparent_type (name); | |
297 | } | |
298 | ||
4009ee92 AB |
299 | /* Find all symbols in the current program space matching NAME in |
300 | DOMAIN, according to this language's rules. | |
301 | ||
302 | The search is done in BLOCK only. | |
303 | The caller is responsible for iterating up through superblocks | |
304 | if desired. | |
305 | ||
306 | For each one, call CALLBACK with the symbol. If CALLBACK | |
307 | returns false, the iteration ends at that point. | |
308 | ||
309 | This field may not be NULL. If the language does not need any | |
310 | special processing here, 'iterate_over_symbols' should be | |
311 | used as the definition. */ | |
312 | virtual bool iterate_over_symbols | |
313 | (const struct block *block, const lookup_name_info &name, | |
314 | domain_enum domain, | |
315 | gdb::function_view<symbol_found_callback_ftype> callback) const | |
316 | { | |
317 | return ::iterate_over_symbols (block, name, domain, callback); | |
318 | } | |
319 | ||
c9debfb9 AB |
320 | /* Return a pointer to the function that should be used to match a |
321 | symbol name against LOOKUP_NAME, according to this language's | |
322 | rules. The matching algorithm depends on LOOKUP_NAME. For | |
323 | example, on Ada, the matching algorithm depends on the symbol | |
324 | name (wild/full/verbatim matching), and on whether we're doing | |
325 | a normal lookup or a completion match lookup. | |
326 | ||
327 | As Ada wants to capture symbol matching for all languages in some | |
328 | cases, then this method is a non-overridable interface. Languages | |
329 | should override GET_SYMBOL_NAME_MATCHER_INNER if they need to. */ | |
330 | ||
331 | symbol_name_matcher_ftype *get_symbol_name_matcher | |
332 | (const lookup_name_info &lookup_name) const; | |
333 | ||
8e25bafe AB |
334 | /* If this language allows compilation from the gdb command line, then |
335 | this method will return an instance of struct gcc_context appropriate | |
336 | to the language. If compilation for this language is generally | |
337 | supported, but something goes wrong then an exception is thrown. The | |
338 | returned compiler instance is owned by its caller and must be | |
339 | deallocated by the caller. If compilation is not supported for this | |
340 | language then this method returns NULL. */ | |
341 | ||
342 | virtual compile_instance *get_compile_instance () const | |
343 | { | |
344 | return nullptr; | |
345 | } | |
346 | ||
9a49ad8c AB |
347 | /* This method must be overridden if 'get_compile_instance' is |
348 | overridden. | |
349 | ||
350 | This takes the user-supplied text and returns a new bit of code | |
351 | to compile. | |
352 | ||
353 | INST is the compiler instance being used. | |
354 | INPUT is the user's input text. | |
355 | GDBARCH is the architecture to use. | |
356 | EXPR_BLOCK is the block in which the expression is being | |
357 | parsed. | |
358 | EXPR_PC is the PC at which the expression is being parsed. */ | |
359 | ||
360 | virtual std::string compute_program (compile_instance *inst, | |
361 | const char *input, | |
362 | struct gdbarch *gdbarch, | |
363 | const struct block *expr_block, | |
364 | CORE_ADDR expr_pc) const | |
365 | { | |
366 | gdb_assert_not_reached ("language_defn::compute_program"); | |
367 | } | |
368 | ||
fb8006fd AB |
369 | /* Hash the given symbol search name. */ |
370 | virtual unsigned int search_name_hash (const char *name) const; | |
371 | ||
6f827019 AB |
372 | /* Demangle a symbol according to this language's rules. Unlike |
373 | la_demangle, this does not take any options. | |
374 | ||
375 | *DEMANGLED will be set by this function. | |
376 | ||
377 | If this function returns false, then *DEMANGLED must always be set | |
378 | to NULL. | |
379 | ||
380 | If this function returns true, the implementation may set this to | |
381 | a xmalloc'd string holding the demangled form. However, it is | |
382 | not required to. The string, if any, is owned by the caller. | |
383 | ||
384 | The resulting string should be of the form that will be | |
385 | installed into a symbol. */ | |
386 | virtual bool sniff_from_mangled_name (const char *mangled, | |
387 | char **demangled) const | |
388 | { | |
389 | *demangled = nullptr; | |
390 | return false; | |
391 | } | |
392 | ||
0a50df5d AB |
393 | /* Return demangled language symbol version of MANGLED, or NULL. */ |
394 | virtual char *demangle (const char *mangled, int options) const | |
395 | { | |
396 | return nullptr; | |
397 | } | |
398 | ||
fbfb0a46 AB |
399 | /* Print a type using syntax appropriate for this language. */ |
400 | ||
401 | virtual void print_type (struct type *, const char *, struct ui_file *, int, | |
402 | int, const struct type_print_options *) const = 0; | |
403 | ||
f6eee2d0 AB |
404 | /* PC is possibly an unknown languages trampoline. |
405 | If that PC falls in a trampoline belonging to this language, return | |
406 | the address of the first pc in the real function, or 0 if it isn't a | |
407 | language tramp for this language. */ | |
408 | virtual CORE_ADDR skip_trampoline (struct frame_info *fi, CORE_ADDR pc) const | |
409 | { | |
410 | return (CORE_ADDR) 0; | |
411 | } | |
412 | ||
eff93b4d AB |
413 | /* Return class name of a mangled method name or NULL. */ |
414 | virtual char *class_name_from_physname (const char *physname) const | |
415 | { | |
416 | return nullptr; | |
417 | } | |
418 | ||
53fc67f8 AB |
419 | /* The list of characters forming word boundaries. */ |
420 | virtual const char *word_break_characters (void) const | |
421 | { | |
422 | return default_word_break_characters (); | |
423 | } | |
424 | ||
7e56227d AB |
425 | /* Add to the completion tracker all symbols which are possible |
426 | completions for TEXT. WORD is the entire command on which the | |
427 | completion is being made. If CODE is TYPE_CODE_UNDEF, then all | |
428 | symbols should be examined; otherwise, only STRUCT_DOMAIN symbols | |
429 | whose type has a code of CODE should be matched. */ | |
430 | ||
431 | virtual void collect_symbol_completion_matches | |
432 | (completion_tracker &tracker, | |
433 | complete_symbol_mode mode, | |
434 | symbol_name_match_type name_match_type, | |
435 | const char *text, | |
436 | const char *word, | |
437 | enum type_code code) const | |
438 | { | |
439 | return default_collect_symbol_completion_matches_break_on | |
440 | (tracker, mode, name_match_type, text, word, "", code); | |
441 | } | |
442 | ||
a78a19b1 AB |
443 | /* This is a function that lookup_symbol will call when it gets to |
444 | the part of symbol lookup where C looks up static and global | |
445 | variables. This default implements the basic C lookup rules. */ | |
446 | ||
447 | virtual struct block_symbol lookup_symbol_nonlocal | |
448 | (const char *name, | |
449 | const struct block *block, | |
450 | const domain_enum domain) const; | |
451 | ||
f16a9f57 AB |
452 | /* Return an expression that can be used for a location |
453 | watchpoint. TYPE is a pointer type that points to the memory | |
454 | to watch, and ADDR is the address of the watched memory. */ | |
455 | virtual gdb::unique_xmalloc_ptr<char> watch_location_expression | |
456 | (struct type *type, CORE_ADDR addr) const; | |
457 | ||
0874fd07 AB |
458 | /* List of all known languages. */ |
459 | static const struct language_defn *languages[nr_languages]; | |
c9debfb9 | 460 | |
a1d1fa3e AB |
461 | /* Print a top-level value using syntax appropriate for this language. */ |
462 | virtual void value_print (struct value *val, struct ui_file *stream, | |
463 | const struct value_print_options *options) const; | |
464 | ||
ebe2334e AB |
465 | /* Print a value using syntax appropriate for this language. RECURSE is |
466 | the recursion depth. It is zero-based. */ | |
467 | virtual void value_print_inner | |
468 | (struct value *val, struct ui_file *stream, int recurse, | |
469 | const struct value_print_options *options) const; | |
470 | ||
87afa652 AB |
471 | /* Parser function. */ |
472 | ||
473 | virtual int parser (struct parser_state *ps) const; | |
474 | ||
1bf9c363 AB |
475 | /* Given an expression *EXPP created by prefixifying the result of |
476 | la_parser, perform any remaining processing necessary to complete its | |
477 | translation. *EXPP may change; la_post_parser is responsible for | |
478 | releasing its previous contents, if necessary. If VOID_CONTEXT_P, | |
479 | then no value is expected from the expression. If COMPLETING is | |
480 | non-zero, then the expression has been parsed for completion, not | |
481 | evaluation. */ | |
482 | ||
483 | virtual void post_parser (expression_up *expp, int void_context_p, | |
484 | int completing, | |
485 | innermost_block_tracker *tracker) const | |
486 | { | |
487 | /* By default the post-parser does nothing. */ | |
488 | } | |
489 | ||
ec8cec5b AB |
490 | /* Print the character CH (of type CHTYPE) on STREAM as part of the |
491 | contents of a literal string whose delimiter is QUOTER. */ | |
492 | ||
493 | virtual void emitchar (int ch, struct type *chtype, | |
494 | struct ui_file *stream, int quoter) const; | |
495 | ||
52b50f2c AB |
496 | virtual void printchar (int ch, struct type *chtype, |
497 | struct ui_file * stream) const; | |
498 | ||
d711ee67 AB |
499 | /* Print the character string STRING, printing at most LENGTH characters. |
500 | Printing stops early if the number hits print_max; repeat counts | |
501 | are printed as appropriate. Print ellipses at the end if we | |
502 | had to stop before printing LENGTH characters, or if FORCE_ELLIPSES. */ | |
503 | ||
504 | virtual void printstr (struct ui_file *stream, struct type *elttype, | |
505 | const gdb_byte *string, unsigned int length, | |
506 | const char *encoding, int force_ellipses, | |
507 | const struct value_print_options *options) const; | |
508 | ||
4ffc13fb AB |
509 | |
510 | /* Print a typedef using syntax appropriate for this language. | |
511 | TYPE is the underlying type. NEW_SYMBOL is the symbol naming | |
512 | the type. STREAM is the output stream on which to print. */ | |
513 | ||
514 | virtual void print_typedef (struct type *type, struct symbol *new_symbol, | |
515 | struct ui_file *stream) const; | |
516 | ||
39e7ecca AB |
517 | /* Return true if TYPE is a string type. */ |
518 | virtual bool is_string_type_p (struct type *type) const; | |
519 | ||
22e3f3ed AB |
520 | /* Return a string that is used by the 'set print max-depth' setting. |
521 | When GDB replaces a struct or union (during value printing) that is | |
522 | "too deep" this string is displayed instead. The default value here | |
523 | suits most languages. If overriding then the string here should | |
524 | ideally be similar in style to the default; an opener, three '.', and | |
525 | a closer. */ | |
526 | ||
527 | virtual const char *struct_too_deep_ellipsis () const | |
528 | { return "{...}"; } | |
529 | ||
5bae7c4e AB |
530 | /* If this returns non-NULL then the string returned specifies the name |
531 | of the implicit local variable that refers to the current object | |
532 | instance. Return NULL (the default) for languages that have no name | |
533 | for the current object instance. */ | |
534 | ||
535 | virtual const char *name_of_this () const | |
536 | { return nullptr; } | |
537 | ||
67bd3fd5 AB |
538 | /* Return false if the language has first-class arrays. Return true if |
539 | there are no array values, and array objects decay to pointers, as in | |
540 | C. The default is true as currently most supported languages behave | |
541 | in this manor. */ | |
542 | ||
543 | virtual bool c_style_arrays_p () const | |
544 | { return true; } | |
545 | ||
22c12a6c AB |
546 | /* Return the index to use for extracting the first element of a string, |
547 | or as the lower bound when creating a new string. The default of | |
548 | choosing 0 or 1 based on C_STYLE_ARRAYS_P works for all currently | |
549 | supported languages except Modula-2. */ | |
550 | ||
551 | virtual char string_lower_bound () const | |
552 | { return c_style_arrays_p () ? 0 : 1; } | |
553 | ||
d3355e4d AB |
554 | /* Returns true if the symbols names should be stored in GDB's data |
555 | structures for minimal/partial/full symbols using their linkage (aka | |
556 | mangled) form; false if the symbol names should be demangled first. | |
557 | ||
558 | Most languages implement symbol lookup by comparing the demangled | |
559 | names, in which case it is advantageous to store that information | |
560 | already demangled, and so would return false, which is the default. | |
561 | ||
562 | On the other hand, some languages have opted for doing symbol lookups | |
563 | by comparing mangled names instead, for reasons usually specific to | |
564 | the language. Those languages should override this function and | |
565 | return true. | |
566 | ||
567 | And finally, other languages such as C or Asm do not have the concept | |
568 | of mangled vs demangled name, so those languages should also override | |
569 | this function and return true, to prevent any accidental demangling | |
570 | through an unrelated language's demangler. */ | |
571 | ||
572 | virtual bool store_sym_names_in_linkage_form_p () const | |
573 | { return false; } | |
574 | ||
c9debfb9 AB |
575 | protected: |
576 | ||
577 | /* This is the overridable part of the GET_SYMBOL_NAME_MATCHER method. | |
578 | See that method for a description of the arguments. */ | |
579 | ||
580 | virtual symbol_name_matcher_ftype *get_symbol_name_matcher_inner | |
581 | (const lookup_name_info &lookup_name) const; | |
0874fd07 AB |
582 | }; |
583 | ||
c906108c SS |
584 | /* Pointer to the language_defn for our current language. This pointer |
585 | always points to *some* valid struct; it can be used without checking | |
586 | it for validity. | |
587 | ||
588 | The current language affects expression parsing and evaluation | |
589 | (FIXME: it might be cleaner to make the evaluation-related stuff | |
590 | separate exp_opcodes for each different set of semantics. We | |
591 | should at least think this through more clearly with respect to | |
592 | what happens if the language is changed between parsing and | |
593 | evaluation) and printing of things like types and arrays. It does | |
594 | *not* affect symbol-reading-- each source file in a symbol-file has | |
595 | its own language and we should keep track of that regardless of the | |
596 | language when symbols are read. If we want some manual setting for | |
597 | the language of symbol files (e.g. detecting when ".c" files are | |
7e73cedf | 598 | C++), it should be a separate setting from the current_language. */ |
c906108c SS |
599 | |
600 | extern const struct language_defn *current_language; | |
601 | ||
602 | /* Pointer to the language_defn expected by the user, e.g. the language | |
603 | of main(), or the language we last mentioned in a message, or C. */ | |
604 | ||
605 | extern const struct language_defn *expected_language; | |
606 | ||
34916edc CB |
607 | /* Warning issued when current_language and the language of the current |
608 | frame do not match. */ | |
609 | ||
610 | extern const char lang_frame_mismatch_warn[]; | |
611 | ||
c906108c SS |
612 | /* language_mode == |
613 | language_mode_auto: current_language automatically set upon selection | |
c5aa993b | 614 | of scope (e.g. stack frame) |
c906108c SS |
615 | language_mode_manual: current_language set only by user. */ |
616 | ||
617 | extern enum language_mode | |
c5aa993b JM |
618 | { |
619 | language_mode_auto, language_mode_manual | |
620 | } | |
621 | language_mode; | |
b62f3443 | 622 | |
fbb06eb1 UW |
623 | struct type *language_bool_type (const struct language_defn *l, |
624 | struct gdbarch *gdbarch); | |
625 | ||
b62f3443 JB |
626 | struct type *language_string_char_type (const struct language_defn *l, |
627 | struct gdbarch *gdbarch); | |
628 | ||
1994afbf DE |
629 | /* Look up type NAME in language L, and return its definition for architecture |
630 | GDBARCH. Returns NULL if not found. */ | |
631 | ||
46b0da17 DE |
632 | struct type *language_lookup_primitive_type (const struct language_defn *l, |
633 | struct gdbarch *gdbarch, | |
634 | const char *name); | |
b62f3443 | 635 | |
1994afbf DE |
636 | /* Wrapper around language_lookup_primitive_type to return the |
637 | corresponding symbol. */ | |
638 | ||
639 | struct symbol * | |
640 | language_lookup_primitive_type_as_symbol (const struct language_defn *l, | |
641 | struct gdbarch *gdbarch, | |
642 | const char *name); | |
643 | ||
c906108c SS |
644 | \f |
645 | /* These macros define the behaviour of the expression | |
646 | evaluator. */ | |
647 | ||
1777feb0 | 648 | /* Should we range check values against the domain of their type? */ |
c906108c SS |
649 | #define RANGE_CHECK (range_check != range_check_off) |
650 | ||
1777feb0 MS |
651 | /* "cast" really means conversion. */ |
652 | /* FIXME -- should be a setting in language_defn. */ | |
cc73bb8c TT |
653 | #define CAST_IS_CONVERSION(LANG) ((LANG)->la_language == language_c || \ |
654 | (LANG)->la_language == language_cplus || \ | |
655 | (LANG)->la_language == language_objc) | |
c906108c | 656 | |
a14ed312 | 657 | extern void language_info (int); |
c906108c | 658 | |
a14ed312 | 659 | extern enum language set_language (enum language); |
c906108c | 660 | \f |
c5aa993b | 661 | |
c906108c SS |
662 | /* This page contains functions that return things that are |
663 | specific to languages. Each of these functions is based on | |
664 | the current setting of working_lang, which the user sets | |
1777feb0 | 665 | with the "set language" command. */ |
c906108c | 666 | |
79d43c61 | 667 | #define LA_PRINT_TYPE(type,varstring,stream,show,level,flags) \ |
fbfb0a46 | 668 | (current_language->print_type(type,varstring,stream,show,level,flags)) |
c906108c | 669 | |
5c6ce71d | 670 | #define LA_PRINT_TYPEDEF(type,new_symbol,stream) \ |
4ffc13fb | 671 | (current_language->print_typedef (type,new_symbol,stream)) |
5c6ce71d | 672 | |
79a45b7d | 673 | #define LA_VALUE_PRINT(val,stream,options) \ |
a1d1fa3e | 674 | (current_language->value_print (val,stream,options)) |
c906108c | 675 | |
6c7a06a3 | 676 | #define LA_PRINT_CHAR(ch, type, stream) \ |
52b50f2c | 677 | (current_language->printchar (ch, type, stream)) |
3e43a32a | 678 | #define LA_PRINT_STRING(stream, elttype, string, length, encoding, force_ellipses, options) \ |
d711ee67 AB |
679 | (current_language->printstr (stream, elttype, string, length, \ |
680 | encoding, force_ellipses,options)) | |
6c7a06a3 | 681 | #define LA_EMIT_CHAR(ch, type, stream, quoter) \ |
ec8cec5b | 682 | (current_language->emitchar (ch, type, stream, quoter)) |
c906108c | 683 | |
53a47a3e | 684 | #define LA_PRINT_ARRAY_INDEX(index_type, index_value, stream, options) \ |
5bd40f2a AB |
685 | (current_language->print_array_index(index_type, index_value, stream, \ |
686 | options)) | |
e79af960 | 687 | |
14bc53a8 | 688 | #define LA_ITERATE_OVER_SYMBOLS(BLOCK, NAME, DOMAIN, CALLBACK) \ |
4009ee92 | 689 | (current_language->iterate_over_symbols (BLOCK, NAME, DOMAIN, CALLBACK)) |
f8eba3c6 | 690 | |
c906108c SS |
691 | /* Test a character to decide whether it can be printed in literal form |
692 | or needs to be printed in another representation. For example, | |
693 | in C the literal form of the character with octal value 141 is 'a' | |
694 | and the "other representation" is '\141'. The "other representation" | |
1777feb0 | 695 | is program language dependent. */ |
c906108c SS |
696 | |
697 | #define PRINT_LITERAL_FORM(c) \ | |
698 | ((c) >= 0x20 \ | |
699 | && ((c) < 0x7F || (c) >= 0xA0) \ | |
700 | && (!sevenbit_strings || (c) < 0x80)) | |
701 | ||
c906108c SS |
702 | /* Type predicates */ |
703 | ||
a14ed312 | 704 | extern int pointer_type (struct type *); |
c906108c | 705 | |
c906108c SS |
706 | /* Error messages */ |
707 | ||
a0b31db1 | 708 | extern void range_error (const char *, ...) ATTRIBUTE_PRINTF (1, 2); |
c906108c SS |
709 | |
710 | /* Data: Does this value represent "truth" to the current language? */ | |
711 | ||
a14ed312 | 712 | extern int value_true (struct value *); |
c906108c | 713 | |
c906108c SS |
714 | /* Misc: The string representing a particular enum language. */ |
715 | ||
2039bd9f | 716 | extern enum language language_enum (const char *str); |
c906108c | 717 | |
a14ed312 | 718 | extern const struct language_defn *language_def (enum language); |
7a292a7a | 719 | |
27cd387b | 720 | extern const char *language_str (enum language); |
c906108c | 721 | |
1777feb0 | 722 | /* Check for a language-specific trampoline. */ |
f636b87d | 723 | |
52f729a7 | 724 | extern CORE_ADDR skip_language_trampoline (struct frame_info *, CORE_ADDR pc); |
f636b87d | 725 | |
9a3d7dfd AF |
726 | /* Return demangled language symbol, or NULL. */ |
727 | extern char *language_demangle (const struct language_defn *current_language, | |
728 | const char *mangled, int options); | |
729 | ||
9d084466 TBA |
730 | /* Return information about whether TYPE should be passed |
731 | (and returned) by reference at the language level. */ | |
732 | struct language_pass_by_ref_info language_pass_by_reference (struct type *type); | |
5c6ce71d | 733 | |
b4be9fad TT |
734 | void c_get_string (struct value *value, |
735 | gdb::unique_xmalloc_ptr<gdb_byte> *buffer, | |
736 | int *length, struct type **char_type, | |
737 | const char **charset); | |
ae6a3a4c | 738 | |
b5ec771e | 739 | /* Get LANG's symbol_name_matcher method for LOOKUP_NAME. Returns |
c63d3e8d PA |
740 | default_symbol_name_matcher if not set. LANG is used as a hint; |
741 | the function may ignore it depending on the current language and | |
742 | LOOKUP_NAME. Specifically, if the current language is Ada, this | |
743 | may return an Ada matcher regardless of LANG. */ | |
618daa93 | 744 | symbol_name_matcher_ftype *get_symbol_name_matcher |
b5ec771e PA |
745 | (const language_defn *lang, const lookup_name_info &lookup_name); |
746 | ||
e3ad2841 TT |
747 | /* Save the current language and restore it upon destruction. */ |
748 | ||
749 | class scoped_restore_current_language | |
750 | { | |
751 | public: | |
752 | ||
753 | explicit scoped_restore_current_language () | |
754 | : m_lang (current_language->la_language) | |
755 | { | |
756 | } | |
757 | ||
758 | ~scoped_restore_current_language () | |
759 | { | |
760 | set_language (m_lang); | |
761 | } | |
762 | ||
763 | scoped_restore_current_language (const scoped_restore_current_language &) | |
764 | = delete; | |
765 | scoped_restore_current_language &operator= | |
766 | (const scoped_restore_current_language &) = delete; | |
767 | ||
768 | private: | |
769 | ||
770 | enum language m_lang; | |
771 | }; | |
772 | ||
9e6a1ab6 PW |
773 | /* If language_mode is language_mode_auto, |
774 | then switch current language to the language of SYM | |
775 | and restore current language upon destruction. | |
776 | ||
777 | Else do nothing. */ | |
778 | ||
779 | class scoped_switch_to_sym_language_if_auto | |
780 | { | |
781 | public: | |
782 | ||
783 | explicit scoped_switch_to_sym_language_if_auto (const struct symbol *sym) | |
784 | { | |
785 | if (language_mode == language_mode_auto) | |
786 | { | |
787 | m_lang = current_language->la_language; | |
788 | m_switched = true; | |
c1b5c1eb | 789 | set_language (sym->language ()); |
9e6a1ab6 PW |
790 | } |
791 | else | |
ae73e2e2 TT |
792 | { |
793 | m_switched = false; | |
794 | /* Assign to m_lang to silence a GCC warning. See | |
795 | https://gcc.gnu.org/bugzilla/show_bug.cgi?id=80635. */ | |
796 | m_lang = language_unknown; | |
797 | } | |
9e6a1ab6 PW |
798 | } |
799 | ||
800 | ~scoped_switch_to_sym_language_if_auto () | |
801 | { | |
802 | if (m_switched) | |
803 | set_language (m_lang); | |
804 | } | |
805 | ||
806 | DISABLE_COPY_AND_ASSIGN (scoped_switch_to_sym_language_if_auto); | |
807 | ||
808 | private: | |
809 | bool m_switched; | |
810 | enum language m_lang; | |
811 | }; | |
812 | ||
c5aa993b | 813 | #endif /* defined (LANGUAGE_H) */ |