1 /* Source-language-related definitions for GDB.
3 Copyright (C) 1991-2014 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)
28 /* Forward decls for prototypes. */
34 struct value_print_options
;
35 struct type_print_options
;
36 struct lang_varobj_ops
;
38 struct compile_instance
;
40 #define MAX_FORTRAN_DIMS 7 /* Maximum number of F77 array dims. */
43 range_mode_auto: range_check set automatically to default of language.
44 range_mode_manual: range_check set manually by user. */
46 extern enum range_mode
48 range_mode_auto
, range_mode_manual
53 range_check_on: Ranges are checked in GDB expressions, producing errors.
54 range_check_warn: Ranges are checked, producing warnings.
55 range_check_off: Ranges are not checked in GDB expressions. */
57 extern enum range_check
59 range_check_off
, range_check_warn
, range_check_on
64 case_mode_auto: case_sensitivity set upon selection of scope.
65 case_mode_manual: case_sensitivity set only by user. */
69 case_mode_auto
, case_mode_manual
74 array_row_major: Arrays are in row major order.
75 array_column_major: Arrays are in column major order. */
77 extern enum array_ordering
79 array_row_major
, array_column_major
84 /* case_sensitivity ==
85 case_sensitive_on: Case sensitivity in name matching is used.
86 case_sensitive_off: Case sensitivity in name matching is not used. */
88 extern enum case_sensitivity
90 case_sensitive_on
, case_sensitive_off
96 macro_expansion_no: No macro expansion is available.
97 macro_expansion_c: C-like macro expansion is available. */
101 macro_expansion_no
, macro_expansion_c
105 /* Per architecture (OS/ABI) language information. */
107 struct language_arch_info
109 /* Its primitive types. This is a vector ended by a NULL pointer.
110 These types can be specified by name in parsing types in
111 expressions, regardless of whether the program being debugged
112 actually defines such a type. */
113 struct type
**primitive_type_vector
;
114 /* Type of elements of strings. */
115 struct type
*string_char_type
;
117 /* Symbol name of type to use as boolean type, if defined. */
118 const char *bool_type_symbol
;
119 /* Otherwise, this is the default boolean builtin type. */
120 struct type
*bool_type_default
;
123 /* A pointer to a function expected to return nonzero if
124 SYMBOL_SEARCH_NAME matches the given LOOKUP_NAME.
126 SYMBOL_SEARCH_NAME should be a symbol's "search" name.
127 LOOKUP_NAME should be the name of an entity after it has been
128 transformed for lookup. */
130 typedef int (*symbol_name_cmp_ftype
) (const char *symbol_search_name
,
131 const char *lookup_name
);
133 /* Structure tying together assorted information about a language. */
137 /* Name of the language. */
141 /* Natural or official name of the language. */
143 const char *la_natural_name
;
145 /* its symtab language-enum (defs.h). */
147 enum language la_language
;
149 /* Default range checking. */
151 enum range_check la_range_check
;
153 /* Default case sensitivity. */
154 enum case_sensitivity la_case_sensitivity
;
156 /* Multi-dimensional array ordering. */
157 enum array_ordering la_array_ordering
;
159 /* Style of macro expansion, if any, supported by this language. */
160 enum macro_expansion la_macro_expansion
;
162 /* Definitions related to expression printing, prefixifying, and
165 const struct exp_descriptor
*la_exp_desc
;
167 /* Parser function. */
169 int (*la_parser
) (struct parser_state
*);
171 /* Parser error function. */
173 void (*la_error
) (char *);
175 /* Given an expression *EXPP created by prefixifying the result of
176 la_parser, perform any remaining processing necessary to complete
177 its translation. *EXPP may change; la_post_parser is responsible
178 for releasing its previous contents, if necessary. If
179 VOID_CONTEXT_P, then no value is expected from the expression. */
181 void (*la_post_parser
) (struct expression
** expp
, int void_context_p
);
183 void (*la_printchar
) (int ch
, struct type
*chtype
,
184 struct ui_file
* stream
);
186 void (*la_printstr
) (struct ui_file
* stream
, struct type
*elttype
,
187 const gdb_byte
*string
, unsigned int length
,
188 const char *encoding
, int force_ellipses
,
189 const struct value_print_options
*);
191 void (*la_emitchar
) (int ch
, struct type
*chtype
,
192 struct ui_file
* stream
, int quoter
);
194 /* Print a type using syntax appropriate for this language. */
196 void (*la_print_type
) (struct type
*, const char *, struct ui_file
*, int,
197 int, const struct type_print_options
*);
199 /* Print a typedef using syntax appropriate for this language.
200 TYPE is the underlying type. NEW_SYMBOL is the symbol naming
201 the type. STREAM is the output stream on which to print. */
203 void (*la_print_typedef
) (struct type
*type
, struct symbol
*new_symbol
,
204 struct ui_file
*stream
);
206 /* Print a value using syntax appropriate for this language.
208 TYPE is the type of the sub-object to be printed.
210 CONTENTS holds the bits of the value. This holds the entire
213 EMBEDDED_OFFSET is the offset into the outermost object of the
214 sub-object represented by TYPE. This is the object which this
215 call should print. Note that the enclosing type is not
218 ADDRESS is the address in the inferior of the enclosing object.
220 STREAM is the stream on which the value is to be printed.
222 RECURSE is the recursion depth. It is zero-based.
224 OPTIONS are the formatting options to be used when
227 void (*la_val_print
) (struct type
*type
,
228 const gdb_byte
*contents
,
229 int embedded_offset
, CORE_ADDR address
,
230 struct ui_file
*stream
, int recurse
,
231 const struct value
*val
,
232 const struct value_print_options
*options
);
234 /* Print a top-level value using syntax appropriate for this language. */
236 void (*la_value_print
) (struct value
*, struct ui_file
*,
237 const struct value_print_options
*);
239 /* Given a symbol VAR, and a stack frame id FRAME, read the value
240 of the variable an return (pointer to a) struct value containing
243 Throw an error if the variable cannot be found. */
245 struct value
*(*la_read_var_value
) (struct symbol
*var
,
246 struct frame_info
*frame
);
248 /* PC is possibly an unknown languages trampoline.
249 If that PC falls in a trampoline belonging to this language,
250 return the address of the first pc in the real function, or 0
251 if it isn't a language tramp for this language. */
252 CORE_ADDR (*skip_trampoline
) (struct frame_info
*, CORE_ADDR
);
254 /* Now come some hooks for lookup_symbol. */
256 /* If this is non-NULL, specifies the name that of the implicit
257 local variable that refers to the current object instance. */
259 char *la_name_of_this
;
261 /* This is a function that lookup_symbol will call when it gets to
262 the part of symbol lookup where C looks up static and global
265 struct symbol
*(*la_lookup_symbol_nonlocal
) (const struct language_defn
*,
267 const struct block
*,
270 /* Find the definition of the type with the given name. */
271 struct type
*(*la_lookup_transparent_type
) (const char *);
273 /* Return demangled language symbol, or NULL. */
274 char *(*la_demangle
) (const char *mangled
, int options
);
276 /* Return class name of a mangled method name or NULL. */
277 char *(*la_class_name_from_physname
) (const char *physname
);
279 /* Table for printing expressions. */
281 const struct op_print
*la_op_print_tab
;
283 /* Zero if the language has first-class arrays. True if there are no
284 array values, and array objects decay to pointers, as in C. */
288 /* Index to use for extracting the first element of a string. */
289 char string_lower_bound
;
291 /* The list of characters forming word boundaries. */
292 char *(*la_word_break_characters
) (void);
294 /* Should return a vector of all symbols which are possible
295 completions for TEXT. WORD is the entire command on which the
296 completion is being made. If CODE is TYPE_CODE_UNDEF, then all
297 symbols should be examined; otherwise, only STRUCT_DOMAIN
298 symbols whose type has a code of CODE should be matched. */
299 VEC (char_ptr
) *(*la_make_symbol_completion_list
) (const char *text
,
301 enum type_code code
);
303 /* The per-architecture (OS/ABI) language information. */
304 void (*la_language_arch_info
) (struct gdbarch
*,
305 struct language_arch_info
*);
307 /* Print the index of an element of an array. */
308 void (*la_print_array_index
) (struct value
*index_value
,
309 struct ui_file
*stream
,
310 const struct value_print_options
*options
);
312 /* Return non-zero if TYPE should be passed (and returned) by
313 reference at the language level. */
314 int (*la_pass_by_reference
) (struct type
*type
);
316 /* Obtain a string from the inferior, storing it in a newly allocated
317 buffer in BUFFER, which should be freed by the caller. If the
318 in- and out-parameter *LENGTH is specified at -1, the string is
319 read until a null character of the appropriate width is found -
320 otherwise the string is read to the length of characters specified.
321 On completion, *LENGTH will hold the size of the string in characters.
322 If a *LENGTH of -1 was specified it will count only actual
323 characters, excluding any eventual terminating null character.
324 Otherwise *LENGTH will include all characters - including any nulls.
325 CHARSET will hold the encoding used in the string. */
326 void (*la_get_string
) (struct value
*value
, gdb_byte
**buffer
, int *length
,
327 struct type
**chartype
, const char **charset
);
329 /* Return a pointer to the function that should be used to match
330 a symbol name against LOOKUP_NAME. This is mostly for languages
331 such as Ada where the matching algorithm depends on LOOKUP_NAME.
333 This field may be NULL, in which case strcmp_iw will be used
334 to perform the matching. */
335 symbol_name_cmp_ftype (*la_get_symbol_name_cmp
) (const char *lookup_name
);
337 /* Find all symbols in the current program space matching NAME in
338 DOMAIN, according to this language's rules.
340 The search is done in BLOCK only.
341 The caller is responsible for iterating up through superblocks
344 For each one, call CALLBACK with the symbol and the DATA
345 argument. If CALLBACK returns zero, the iteration ends at that
348 This field may not be NULL. If the language does not need any
349 special processing here, 'iterate_over_symbols' should be
350 used as the definition. */
351 void (*la_iterate_over_symbols
) (const struct block
*block
,
354 symbol_found_callback_ftype
*callback
,
357 /* Various operations on varobj. */
358 const struct lang_varobj_ops
*la_varobj_ops
;
360 /* If this language allows compilation from the gdb command line,
361 this method should be non-NULL. When called it should return
362 an instance of struct gcc_context appropriate to the language.
363 When defined this method must never return NULL; instead it
364 should throw an exception on failure. The returned compiler
365 instance is owned by its caller and must be deallocated by
366 calling its 'destroy' method. */
368 struct compile_instance
*(*la_get_compile_instance
) (void);
370 /* This method must be defined if 'la_get_gcc_context' is defined.
371 If 'la_get_gcc_context' is not defined, then this method is
374 This takes the user-supplied text and returns a newly malloc'd
375 bit of code to compile. The caller owns the result.
377 INST is the compiler instance being used.
378 INPUT is the user's input text.
379 GDBARCH is the architecture to use.
380 EXPR_BLOCK is the block in which the expression is being
382 EXPR_PC is the PC at which the expression is being parsed. */
384 char *(*la_compute_program
) (struct compile_instance
*inst
,
386 struct gdbarch
*gdbarch
,
387 const struct block
*expr_block
,
390 /* Add fields above this point, so the magic number is always last. */
391 /* Magic number for compat checking. */
397 #define LANG_MAGIC 910823L
399 /* Pointer to the language_defn for our current language. This pointer
400 always points to *some* valid struct; it can be used without checking
403 The current language affects expression parsing and evaluation
404 (FIXME: it might be cleaner to make the evaluation-related stuff
405 separate exp_opcodes for each different set of semantics. We
406 should at least think this through more clearly with respect to
407 what happens if the language is changed between parsing and
408 evaluation) and printing of things like types and arrays. It does
409 *not* affect symbol-reading-- each source file in a symbol-file has
410 its own language and we should keep track of that regardless of the
411 language when symbols are read. If we want some manual setting for
412 the language of symbol files (e.g. detecting when ".c" files are
413 C++), it should be a separate setting from the current_language. */
415 extern const struct language_defn
*current_language
;
417 /* Pointer to the language_defn expected by the user, e.g. the language
418 of main(), or the language we last mentioned in a message, or C. */
420 extern const struct language_defn
*expected_language
;
423 language_mode_auto: current_language automatically set upon selection
424 of scope (e.g. stack frame)
425 language_mode_manual: current_language set only by user. */
427 extern enum language_mode
429 language_mode_auto
, language_mode_manual
433 struct type
*language_bool_type (const struct language_defn
*l
,
434 struct gdbarch
*gdbarch
);
436 struct type
*language_string_char_type (const struct language_defn
*l
,
437 struct gdbarch
*gdbarch
);
439 struct type
*language_lookup_primitive_type (const struct language_defn
*l
,
440 struct gdbarch
*gdbarch
,
444 /* These macros define the behaviour of the expression
447 /* Should we range check values against the domain of their type? */
448 #define RANGE_CHECK (range_check != range_check_off)
450 /* "cast" really means conversion. */
451 /* FIXME -- should be a setting in language_defn. */
452 #define CAST_IS_CONVERSION(LANG) ((LANG)->la_language == language_c || \
453 (LANG)->la_language == language_cplus || \
454 (LANG)->la_language == language_objc)
456 extern void language_info (int);
458 extern enum language
set_language (enum language
);
461 /* This page contains functions that return things that are
462 specific to languages. Each of these functions is based on
463 the current setting of working_lang, which the user sets
464 with the "set language" command. */
466 #define LA_PRINT_TYPE(type,varstring,stream,show,level,flags) \
467 (current_language->la_print_type(type,varstring,stream,show,level,flags))
469 #define LA_PRINT_TYPEDEF(type,new_symbol,stream) \
470 (current_language->la_print_typedef(type,new_symbol,stream))
472 #define LA_VAL_PRINT(type,valaddr,offset,addr,stream,val,recurse,options) \
473 (current_language->la_val_print(type,valaddr,offset,addr,stream, \
474 val,recurse,options))
475 #define LA_VALUE_PRINT(val,stream,options) \
476 (current_language->la_value_print(val,stream,options))
478 #define LA_PRINT_CHAR(ch, type, stream) \
479 (current_language->la_printchar(ch, type, stream))
480 #define LA_PRINT_STRING(stream, elttype, string, length, encoding, force_ellipses, options) \
481 (current_language->la_printstr(stream, elttype, string, length, \
482 encoding, force_ellipses,options))
483 #define LA_EMIT_CHAR(ch, type, stream, quoter) \
484 (current_language->la_emitchar(ch, type, stream, quoter))
485 #define LA_GET_STRING(value, buffer, length, chartype, encoding) \
486 (current_language->la_get_string(value, buffer, length, chartype, encoding))
488 #define LA_PRINT_ARRAY_INDEX(index_value, stream, options) \
489 (current_language->la_print_array_index(index_value, stream, options))
491 #define LA_ITERATE_OVER_SYMBOLS(BLOCK, NAME, DOMAIN, CALLBACK, DATA) \
492 (current_language->la_iterate_over_symbols (BLOCK, NAME, DOMAIN, CALLBACK, \
495 /* Test a character to decide whether it can be printed in literal form
496 or needs to be printed in another representation. For example,
497 in C the literal form of the character with octal value 141 is 'a'
498 and the "other representation" is '\141'. The "other representation"
499 is program language dependent. */
501 #define PRINT_LITERAL_FORM(c) \
503 && ((c) < 0x7F || (c) >= 0xA0) \
504 && (!sevenbit_strings || (c) < 0x80))
506 /* Type predicates */
508 extern int pointer_type (struct type
*);
512 extern void range_error (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
514 /* Data: Does this value represent "truth" to the current language? */
516 extern int value_true (struct value
*);
518 /* Misc: The string representing a particular enum language. */
520 extern enum language
language_enum (char *str
);
522 extern const struct language_defn
*language_def (enum language
);
524 extern const char *language_str (enum language
);
526 /* Add a language to the set known by GDB (at initialization time). */
528 extern void add_language (const struct language_defn
*);
530 extern enum language
get_frame_language (void); /* In stack.c */
532 /* Check for a language-specific trampoline. */
534 extern CORE_ADDR
skip_language_trampoline (struct frame_info
*, CORE_ADDR pc
);
536 /* Return demangled language symbol, or NULL. */
537 extern char *language_demangle (const struct language_defn
*current_language
,
538 const char *mangled
, int options
);
540 /* Return class name from physname, or NULL. */
541 extern char *language_class_name_from_physname (const struct language_defn
*,
542 const char *physname
);
544 /* Splitting strings into words. */
545 extern char *default_word_break_characters (void);
547 /* Print the index of an array element using the C99 syntax. */
548 extern void default_print_array_index (struct value
*index_value
,
549 struct ui_file
*stream
,
550 const struct value_print_options
*options
);
552 /* Return non-zero if TYPE should be passed (and returned) by
553 reference at the language level. */
554 int language_pass_by_reference (struct type
*type
);
556 /* Return zero; by default, types are passed by value at the language
557 level. The target ABI may pass or return some structs by reference
558 independent of this. */
559 int default_pass_by_reference (struct type
*type
);
561 /* The default implementation of la_print_typedef. */
562 void default_print_typedef (struct type
*type
, struct symbol
*new_symbol
,
563 struct ui_file
*stream
);
565 void default_get_string (struct value
*value
, gdb_byte
**buffer
, int *length
,
566 struct type
**char_type
, const char **charset
);
568 void c_get_string (struct value
*value
, gdb_byte
**buffer
, int *length
,
569 struct type
**char_type
, const char **charset
);
571 #endif /* defined (LANGUAGE_H) */