1 /* Source-language-related definitions for GDB.
3 Copyright (C) 1991-2017 Free Software Foundation, Inc.
5 Contributed by the Department of Computer Science at the State University
6 of New York at Buffalo.
8 This file is part of GDB.
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
12 the Free Software Foundation; either version 3 of the License, or
13 (at your option) any later version.
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.
20 You should have received a copy of the GNU General Public License
21 along with this program. If not, see <http://www.gnu.org/licenses/>. */
23 #if !defined (LANGUAGE_H)
27 #include "common/function-view.h"
29 /* Forward decls for prototypes. */
35 struct value_print_options;
36 struct type_print_options;
37 struct lang_varobj_ops;
39 struct compile_instance;
41 #define MAX_FORTRAN_DIMS 7 /* Maximum number of F77 array dims. */
44 range_mode_auto: range_check set automatically to default of language.
45 range_mode_manual: range_check set manually by user. */
47 extern enum range_mode
49 range_mode_auto, range_mode_manual
54 range_check_on: Ranges are checked in GDB expressions, producing errors.
55 range_check_warn: Ranges are checked, producing warnings.
56 range_check_off: Ranges are not checked in GDB expressions. */
58 extern enum range_check
60 range_check_off, range_check_warn, range_check_on
65 case_mode_auto: case_sensitivity set upon selection of scope.
66 case_mode_manual: case_sensitivity set only by user. */
70 case_mode_auto, case_mode_manual
75 array_row_major: Arrays are in row major order.
76 array_column_major: Arrays are in column major order. */
78 extern enum array_ordering
80 array_row_major, array_column_major
85 /* case_sensitivity ==
86 case_sensitive_on: Case sensitivity in name matching is used.
87 case_sensitive_off: Case sensitivity in name matching is not used. */
89 extern enum case_sensitivity
91 case_sensitive_on, case_sensitive_off
97 macro_expansion_no: No macro expansion is available.
98 macro_expansion_c: C-like macro expansion is available. */
102 macro_expansion_no, macro_expansion_c
106 /* Per architecture (OS/ABI) language information. */
108 struct language_arch_info
110 /* Its primitive types. This is a vector ended by a NULL pointer.
111 These types can be specified by name in parsing types in
112 expressions, regardless of whether the program being debugged
113 actually defines such a type. */
114 struct type **primitive_type_vector;
116 /* Symbol wrappers around primitive_type_vector, so that the symbol lookup
117 machinery can return them. */
118 struct symbol **primitive_type_symbols;
120 /* Type of elements of strings. */
121 struct type *string_char_type;
123 /* Symbol name of type to use as boolean type, if defined. */
124 const char *bool_type_symbol;
125 /* Otherwise, this is the default boolean builtin type. */
126 struct type *bool_type_default;
129 /* A pointer to a function expected to return nonzero if
130 SYMBOL_SEARCH_NAME matches the given LOOKUP_NAME.
132 SYMBOL_SEARCH_NAME should be a symbol's "search" name.
133 LOOKUP_NAME should be the name of an entity after it has been
134 transformed for lookup. */
136 typedef int (*symbol_name_cmp_ftype) (const char *symbol_search_name,
137 const char *lookup_name);
139 /* Structure tying together assorted information about a language. */
143 /* Name of the language. */
147 /* Natural or official name of the language. */
149 const char *la_natural_name;
151 /* its symtab language-enum (defs.h). */
153 enum language la_language;
155 /* Default range checking. */
157 enum range_check la_range_check;
159 /* Default case sensitivity. */
160 enum case_sensitivity la_case_sensitivity;
162 /* Multi-dimensional array ordering. */
163 enum array_ordering la_array_ordering;
165 /* Style of macro expansion, if any, supported by this language. */
166 enum macro_expansion la_macro_expansion;
168 /* A NULL-terminated array of file extensions for this language.
169 The extension must include the ".", like ".c". If this
170 language doesn't need to provide any filename extensions, this
173 const char *const *la_filename_extensions;
175 /* Definitions related to expression printing, prefixifying, and
178 const struct exp_descriptor *la_exp_desc;
180 /* Parser function. */
182 int (*la_parser) (struct parser_state *);
184 /* Parser error function. */
186 void (*la_error) (const char *);
188 /* Given an expression *EXPP created by prefixifying the result of
189 la_parser, perform any remaining processing necessary to complete
190 its translation. *EXPP may change; la_post_parser is responsible
191 for releasing its previous contents, if necessary. If
192 VOID_CONTEXT_P, then no value is expected from the expression. */
194 void (*la_post_parser) (struct expression ** expp, int void_context_p);
196 void (*la_printchar) (int ch, struct type *chtype,
197 struct ui_file * stream);
199 void (*la_printstr) (struct ui_file * stream, struct type *elttype,
200 const gdb_byte *string, unsigned int length,
201 const char *encoding, int force_ellipses,
202 const struct value_print_options *);
204 void (*la_emitchar) (int ch, struct type *chtype,
205 struct ui_file * stream, int quoter);
207 /* Print a type using syntax appropriate for this language. */
209 void (*la_print_type) (struct type *, const char *, struct ui_file *, int,
210 int, const struct type_print_options *);
212 /* Print a typedef using syntax appropriate for this language.
213 TYPE is the underlying type. NEW_SYMBOL is the symbol naming
214 the type. STREAM is the output stream on which to print. */
216 void (*la_print_typedef) (struct type *type, struct symbol *new_symbol,
217 struct ui_file *stream);
219 /* Print a value using syntax appropriate for this language.
221 TYPE is the type of the sub-object to be printed.
223 EMBEDDED_OFFSET is the offset into the outermost object of the
224 sub-object represented by TYPE. This is the object which this
225 call should print. Note that the enclosing type is not
228 ADDRESS is the address in the inferior of the enclosing object.
230 STREAM is the stream on which the value is to be printed.
232 RECURSE is the recursion depth. It is zero-based.
234 OPTIONS are the formatting options to be used when
237 void (*la_val_print) (struct type *type,
238 int embedded_offset, CORE_ADDR address,
239 struct ui_file *stream, int recurse,
241 const struct value_print_options *options);
243 /* Print a top-level value using syntax appropriate for this language. */
245 void (*la_value_print) (struct value *, struct ui_file *,
246 const struct value_print_options *);
248 /* Given a symbol VAR, the corresponding block VAR_BLOCK (if any) and a
249 stack frame id FRAME, read the value of the variable and return (pointer
250 to a) struct value containing the value.
252 VAR_BLOCK is needed if there's a possibility for VAR to be outside
253 FRAME. This is what happens if FRAME correspond to a nested function
254 and VAR is defined in the outer function. If callers know that VAR is
255 located in FRAME or is global/static, NULL can be passed as VAR_BLOCK.
257 Throw an error if the variable cannot be found. */
259 struct value *(*la_read_var_value) (struct symbol *var,
260 const struct block *var_block,
261 struct frame_info *frame);
263 /* PC is possibly an unknown languages trampoline.
264 If that PC falls in a trampoline belonging to this language,
265 return the address of the first pc in the real function, or 0
266 if it isn't a language tramp for this language. */
267 CORE_ADDR (*skip_trampoline) (struct frame_info *, CORE_ADDR);
269 /* Now come some hooks for lookup_symbol. */
271 /* If this is non-NULL, specifies the name that of the implicit
272 local variable that refers to the current object instance. */
274 const char *la_name_of_this;
276 /* This is a function that lookup_symbol will call when it gets to
277 the part of symbol lookup where C looks up static and global
280 struct block_symbol (*la_lookup_symbol_nonlocal)
281 (const struct language_defn *,
283 const struct block *,
286 /* Find the definition of the type with the given name. */
287 struct type *(*la_lookup_transparent_type) (const char *);
289 /* Return demangled language symbol, or NULL. */
290 char *(*la_demangle) (const char *mangled, int options);
292 /* Demangle a symbol according to this language's rules. Unlike
293 la_demangle, this does not take any options.
295 *DEMANGLED will be set by this function.
297 If this function returns 0, then *DEMANGLED must always be set
300 If this function returns 1, the implementation may set this to
301 a xmalloc'd string holding the demangled form. However, it is
302 not required to. The string, if any, is owned by the caller.
304 The resulting string should be of the form that will be
305 installed into a symbol. */
306 int (*la_sniff_from_mangled_name) (const char *mangled, char **demangled);
308 /* Return class name of a mangled method name or NULL. */
309 char *(*la_class_name_from_physname) (const char *physname);
311 /* Table for printing expressions. */
313 const struct op_print *la_op_print_tab;
315 /* Zero if the language has first-class arrays. True if there are no
316 array values, and array objects decay to pointers, as in C. */
320 /* Index to use for extracting the first element of a string. */
321 char string_lower_bound;
323 /* The list of characters forming word boundaries. */
324 const char *(*la_word_break_characters) (void);
326 /* Add to the completion tracker all symbols which are possible
327 completions for TEXT. WORD is the entire command on which the
328 completion is being made. If CODE is TYPE_CODE_UNDEF, then all
329 symbols should be examined; otherwise, only STRUCT_DOMAIN
330 symbols whose type has a code of CODE should be matched. */
331 void (*la_collect_symbol_completion_matches)
332 (completion_tracker &tracker,
333 complete_symbol_mode mode,
336 enum type_code code);
338 /* The per-architecture (OS/ABI) language information. */
339 void (*la_language_arch_info) (struct gdbarch *,
340 struct language_arch_info *);
342 /* Print the index of an element of an array. */
343 void (*la_print_array_index) (struct value *index_value,
344 struct ui_file *stream,
345 const struct value_print_options *options);
347 /* Return non-zero if TYPE should be passed (and returned) by
348 reference at the language level. */
349 int (*la_pass_by_reference) (struct type *type);
351 /* Obtain a string from the inferior, storing it in a newly allocated
352 buffer in BUFFER, which should be freed by the caller. If the
353 in- and out-parameter *LENGTH is specified at -1, the string is
354 read until a null character of the appropriate width is found -
355 otherwise the string is read to the length of characters specified.
356 On completion, *LENGTH will hold the size of the string in characters.
357 If a *LENGTH of -1 was specified it will count only actual
358 characters, excluding any eventual terminating null character.
359 Otherwise *LENGTH will include all characters - including any nulls.
360 CHARSET will hold the encoding used in the string. */
361 void (*la_get_string) (struct value *value, gdb_byte **buffer, int *length,
362 struct type **chartype, const char **charset);
364 /* Return an expression that can be used for a location
365 watchpoint. TYPE is a pointer type that points to the memory
366 to watch, and ADDR is the address of the watched memory. */
367 gdb::unique_xmalloc_ptr<char> (*la_watch_location_expression)
368 (struct type *type, CORE_ADDR addr);
370 /* Return a pointer to the function that should be used to match
371 a symbol name against LOOKUP_NAME. This is mostly for languages
372 such as Ada where the matching algorithm depends on LOOKUP_NAME.
374 This field may be NULL, in which case strcmp_iw will be used
375 to perform the matching. */
376 symbol_name_cmp_ftype (*la_get_symbol_name_cmp) (const char *lookup_name);
378 /* Find all symbols in the current program space matching NAME in
379 DOMAIN, according to this language's rules.
381 The search is done in BLOCK only.
382 The caller is responsible for iterating up through superblocks
385 For each one, call CALLBACK with the symbol. If CALLBACK
386 returns false, the iteration ends at that point.
388 This field may not be NULL. If the language does not need any
389 special processing here, 'iterate_over_symbols' should be
390 used as the definition. */
391 void (*la_iterate_over_symbols)
392 (const struct block *block, const char *name, domain_enum domain,
393 gdb::function_view<symbol_found_callback_ftype> callback);
395 /* Various operations on varobj. */
396 const struct lang_varobj_ops *la_varobj_ops;
398 /* If this language allows compilation from the gdb command line,
399 this method should be non-NULL. When called it should return
400 an instance of struct gcc_context appropriate to the language.
401 When defined this method must never return NULL; instead it
402 should throw an exception on failure. The returned compiler
403 instance is owned by its caller and must be deallocated by
404 calling its 'destroy' method. */
406 struct compile_instance *(*la_get_compile_instance) (void);
408 /* This method must be defined if 'la_get_gcc_context' is defined.
409 If 'la_get_gcc_context' is not defined, then this method is
412 This takes the user-supplied text and returns a new bit of code
415 INST is the compiler instance being used.
416 INPUT is the user's input text.
417 GDBARCH is the architecture to use.
418 EXPR_BLOCK is the block in which the expression is being
420 EXPR_PC is the PC at which the expression is being parsed. */
422 std::string (*la_compute_program) (struct compile_instance *inst,
424 struct gdbarch *gdbarch,
425 const struct block *expr_block,
428 /* Add fields above this point, so the magic number is always last. */
429 /* Magic number for compat checking. */
435 #define LANG_MAGIC 910823L
437 /* Pointer to the language_defn for our current language. This pointer
438 always points to *some* valid struct; it can be used without checking
441 The current language affects expression parsing and evaluation
442 (FIXME: it might be cleaner to make the evaluation-related stuff
443 separate exp_opcodes for each different set of semantics. We
444 should at least think this through more clearly with respect to
445 what happens if the language is changed between parsing and
446 evaluation) and printing of things like types and arrays. It does
447 *not* affect symbol-reading-- each source file in a symbol-file has
448 its own language and we should keep track of that regardless of the
449 language when symbols are read. If we want some manual setting for
450 the language of symbol files (e.g. detecting when ".c" files are
451 C++), it should be a separate setting from the current_language. */
453 extern const struct language_defn *current_language;
455 /* Pointer to the language_defn expected by the user, e.g. the language
456 of main(), or the language we last mentioned in a message, or C. */
458 extern const struct language_defn *expected_language;
461 language_mode_auto: current_language automatically set upon selection
462 of scope (e.g. stack frame)
463 language_mode_manual: current_language set only by user. */
465 extern enum language_mode
467 language_mode_auto, language_mode_manual
471 struct type *language_bool_type (const struct language_defn *l,
472 struct gdbarch *gdbarch);
474 struct type *language_string_char_type (const struct language_defn *l,
475 struct gdbarch *gdbarch);
477 /* Look up type NAME in language L, and return its definition for architecture
478 GDBARCH. Returns NULL if not found. */
480 struct type *language_lookup_primitive_type (const struct language_defn *l,
481 struct gdbarch *gdbarch,
484 /* Wrapper around language_lookup_primitive_type to return the
485 corresponding symbol. */
488 language_lookup_primitive_type_as_symbol (const struct language_defn *l,
489 struct gdbarch *gdbarch,
493 /* These macros define the behaviour of the expression
496 /* Should we range check values against the domain of their type? */
497 #define RANGE_CHECK (range_check != range_check_off)
499 /* "cast" really means conversion. */
500 /* FIXME -- should be a setting in language_defn. */
501 #define CAST_IS_CONVERSION(LANG) ((LANG)->la_language == language_c || \
502 (LANG)->la_language == language_cplus || \
503 (LANG)->la_language == language_objc)
505 extern void language_info (int);
507 extern enum language set_language (enum language);
510 /* This page contains functions that return things that are
511 specific to languages. Each of these functions is based on
512 the current setting of working_lang, which the user sets
513 with the "set language" command. */
515 #define LA_PRINT_TYPE(type,varstring,stream,show,level,flags) \
516 (current_language->la_print_type(type,varstring,stream,show,level,flags))
518 #define LA_PRINT_TYPEDEF(type,new_symbol,stream) \
519 (current_language->la_print_typedef(type,new_symbol,stream))
521 #define LA_VALUE_PRINT(val,stream,options) \
522 (current_language->la_value_print(val,stream,options))
524 #define LA_PRINT_CHAR(ch, type, stream) \
525 (current_language->la_printchar(ch, type, stream))
526 #define LA_PRINT_STRING(stream, elttype, string, length, encoding, force_ellipses, options) \
527 (current_language->la_printstr(stream, elttype, string, length, \
528 encoding, force_ellipses,options))
529 #define LA_EMIT_CHAR(ch, type, stream, quoter) \
530 (current_language->la_emitchar(ch, type, stream, quoter))
531 #define LA_GET_STRING(value, buffer, length, chartype, encoding) \
532 (current_language->la_get_string(value, buffer, length, chartype, encoding))
534 #define LA_PRINT_ARRAY_INDEX(index_value, stream, options) \
535 (current_language->la_print_array_index(index_value, stream, options))
537 #define LA_ITERATE_OVER_SYMBOLS(BLOCK, NAME, DOMAIN, CALLBACK) \
538 (current_language->la_iterate_over_symbols (BLOCK, NAME, DOMAIN, CALLBACK))
540 /* Test a character to decide whether it can be printed in literal form
541 or needs to be printed in another representation. For example,
542 in C the literal form of the character with octal value 141 is 'a'
543 and the "other representation" is '\141'. The "other representation"
544 is program language dependent. */
546 #define PRINT_LITERAL_FORM(c) \
548 && ((c) < 0x7F || (c) >= 0xA0) \
549 && (!sevenbit_strings || (c) < 0x80))
551 /* Type predicates */
553 extern int pointer_type (struct type *);
557 extern void range_error (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
559 /* Data: Does this value represent "truth" to the current language? */
561 extern int value_true (struct value *);
563 /* Misc: The string representing a particular enum language. */
565 extern enum language language_enum (char *str);
567 extern const struct language_defn *language_def (enum language);
569 extern const char *language_str (enum language);
571 /* Check for a language-specific trampoline. */
573 extern CORE_ADDR skip_language_trampoline (struct frame_info *, CORE_ADDR pc);
575 /* Return demangled language symbol, or NULL. */
576 extern char *language_demangle (const struct language_defn *current_language,
577 const char *mangled, int options);
579 /* A wrapper for la_sniff_from_mangled_name. The arguments and result
580 are as for the method. */
582 extern int language_sniff_from_mangled_name (const struct language_defn *lang,
586 /* Return class name from physname, or NULL. */
587 extern char *language_class_name_from_physname (const struct language_defn *,
588 const char *physname);
590 /* Splitting strings into words. */
591 extern const char *default_word_break_characters (void);
593 /* Print the index of an array element using the C99 syntax. */
594 extern void default_print_array_index (struct value *index_value,
595 struct ui_file *stream,
596 const struct value_print_options *options);
598 /* Return non-zero if TYPE should be passed (and returned) by
599 reference at the language level. */
600 int language_pass_by_reference (struct type *type);
602 /* Return zero; by default, types are passed by value at the language
603 level. The target ABI may pass or return some structs by reference
604 independent of this. */
605 int default_pass_by_reference (struct type *type);
607 /* The default implementation of la_print_typedef. */
608 void default_print_typedef (struct type *type, struct symbol *new_symbol,
609 struct ui_file *stream);
611 void default_get_string (struct value *value, gdb_byte **buffer, int *length,
612 struct type **char_type, const char **charset);
614 void c_get_string (struct value *value, gdb_byte **buffer, int *length,
615 struct type **char_type, const char **charset);
617 /* The languages supported by GDB. */
619 extern const struct language_defn auto_language_defn;
620 extern const struct language_defn unknown_language_defn;
621 extern const struct language_defn minimal_language_defn;
623 extern const struct language_defn ada_language_defn;
624 extern const struct language_defn asm_language_defn;
625 extern const struct language_defn c_language_defn;
626 extern const struct language_defn cplus_language_defn;
627 extern const struct language_defn d_language_defn;
628 extern const struct language_defn f_language_defn;
629 extern const struct language_defn go_language_defn;
630 extern const struct language_defn m2_language_defn;
631 extern const struct language_defn objc_language_defn;
632 extern const struct language_defn opencl_language_defn;
633 extern const struct language_defn pascal_language_defn;
634 extern const struct language_defn rust_language_defn;
636 #endif /* defined (LANGUAGE_H) */