1 /* Source-language-related definitions for GDB.
3 Copyright (C) 1991, 1992, 1993, 1994, 1995, 1998, 1999, 2000, 2003, 2004,
4 2007, 2008 Free Software Foundation, Inc.
6 Contributed by the Department of Computer Science at the State University
7 of New York at Buffalo.
9 This file is part of GDB.
11 This program is free software; you can redistribute it and/or modify
12 it under the terms of the GNU General Public License as published by
13 the Free Software Foundation; either version 3 of the License, or
14 (at your option) any later version.
16 This program is distributed in the hope that it will be useful,
17 but WITHOUT ANY WARRANTY; without even the implied warranty of
18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 GNU General Public License for more details.
21 You should have received a copy of the GNU General Public License
22 along with this program. If not, see <http://www.gnu.org/licenses/>. */
24 #if !defined (LANGUAGE_H)
27 /* Forward decls for prototypes */
34 /* This used to be included to configure GDB for one or more specific
35 languages. Now it is left out to configure for all of them. FIXME. */
36 /* #include "lang_def.h" */
42 #define MAX_FORTRAN_DIMS 7 /* Maximum number of F77 array dims */
45 range_mode_auto: range_check set automatically to default of language.
46 range_mode_manual: range_check set manually by user. */
48 extern enum range_mode
50 range_mode_auto, range_mode_manual
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. */
59 extern enum range_check
61 range_check_off, range_check_warn, range_check_on
66 type_mode_auto: type_check set automatically to default of language
67 type_mode_manual: type_check set manually by user. */
71 type_mode_auto, type_mode_manual
76 type_check_on: Types are checked in GDB expressions, producing errors.
77 type_check_warn: Types are checked, producing warnings.
78 type_check_off: Types are not checked in GDB expressions. */
80 extern enum type_check
82 type_check_off, type_check_warn, type_check_on
87 case_mode_auto: case_sensitivity set upon selection of scope
88 case_mode_manual: case_sensitivity set only by user. */
92 case_mode_auto, case_mode_manual
97 array_row_major: Arrays are in row major order
98 array_column_major: Arrays are in column major order.*/
100 extern enum array_ordering
102 array_row_major, array_column_major
107 /* case_sensitivity ==
108 case_sensitive_on: Case sensitivity in name matching is used
109 case_sensitive_off: Case sensitivity in name matching is not used */
111 extern enum case_sensitivity
113 case_sensitive_on, case_sensitive_off
117 /* Per architecture (OS/ABI) language information. */
119 struct language_arch_info
121 /* Its primitive types. This is a vector ended by a NULL pointer.
122 These types can be specified by name in parsing types in
123 expressions, regardless of whether the program being debugged
124 actually defines such a type. */
125 struct type **primitive_type_vector;
126 /* Type of elements of strings. */
127 struct type *string_char_type;
129 /* Symbol name of type to use as boolean type, if defined. */
130 const char *bool_type_symbol;
131 /* Otherwise, this is the default boolean builtin type. */
132 struct type *bool_type_default;
135 /* Structure tying together assorted information about a language. */
139 /* Name of the language */
143 /* its symtab language-enum (defs.h) */
145 enum language la_language;
147 /* Default range checking */
149 enum range_check la_range_check;
151 /* Default type checking */
153 enum type_check la_type_check;
155 /* Default case sensitivity */
156 enum case_sensitivity la_case_sensitivity;
158 /* Multi-dimensional array ordering */
159 enum array_ordering la_array_ordering;
161 /* Definitions related to expression printing, prefixifying, and
164 const struct exp_descriptor *la_exp_desc;
166 /* Parser function. */
168 int (*la_parser) (void);
170 /* Parser error function */
172 void (*la_error) (char *);
174 /* Given an expression *EXPP created by prefixifying the result of
175 la_parser, perform any remaining processing necessary to complete
176 its translation. *EXPP may change; la_post_parser is responsible
177 for releasing its previous contents, if necessary. If
178 VOID_CONTEXT_P, then no value is expected from the expression. */
180 void (*la_post_parser) (struct expression ** expp, int void_context_p);
182 void (*la_printchar) (int ch, struct ui_file * stream);
184 void (*la_printstr) (struct ui_file * stream, const gdb_byte *string,
185 unsigned int length, int width,
188 void (*la_emitchar) (int ch, struct ui_file * stream, int quoter);
190 /* Print a type using syntax appropriate for this language. */
192 void (*la_print_type) (struct type *, char *, struct ui_file *, int,
195 /* Print a value using syntax appropriate for this language. */
197 int (*la_val_print) (struct type *, const gdb_byte *, int, CORE_ADDR,
198 struct ui_file *, int, int, int,
199 enum val_prettyprint);
201 /* Print a top-level value using syntax appropriate for this language. */
203 int (*la_value_print) (struct value *, struct ui_file *,
204 int, enum val_prettyprint);
206 /* PC is possibly an unknown languages trampoline.
207 If that PC falls in a trampoline belonging to this language,
208 return the address of the first pc in the real function, or 0
209 if it isn't a language tramp for this language. */
210 CORE_ADDR (*skip_trampoline) (struct frame_info *, CORE_ADDR);
212 /* Now come some hooks for lookup_symbol. */
214 /* If this is non-NULL, specifies the name that of the implicit
215 local variable that refers to the current object instance. */
217 char *la_name_of_this;
219 /* This is a function that lookup_symbol will call when it gets to
220 the part of symbol lookup where C looks up static and global
223 struct symbol *(*la_lookup_symbol_nonlocal) (const char *,
225 const struct block *,
228 /* Find the definition of the type with the given name. */
229 struct type *(*la_lookup_transparent_type) (const char *);
231 /* Return demangled language symbol, or NULL. */
232 char *(*la_demangle) (const char *mangled, int options);
234 /* Return class name of a mangled method name or NULL. */
235 char *(*la_class_name_from_physname) (const char *physname);
237 /* Table for printing expressions */
239 const struct op_print *la_op_print_tab;
241 /* Zero if the language has first-class arrays. True if there are no
242 array values, and array objects decay to pointers, as in C. */
246 /* Index to use for extracting the first element of a string. */
247 char string_lower_bound;
249 /* The list of characters forming word boundaries. */
250 char *(*la_word_break_characters) (void);
252 /* Should return a NULL terminated array of all symbols which
253 are possible completions for TEXT. WORD is the entire command
254 on which the completion is being made. */
255 char **(*la_make_symbol_completion_list) (char *text, char *word);
257 /* The per-architecture (OS/ABI) language information. */
258 void (*la_language_arch_info) (struct gdbarch *,
259 struct language_arch_info *);
261 /* Print the index of an element of an array. */
262 void (*la_print_array_index) (struct value *index_value,
263 struct ui_file *stream,
265 enum val_prettyprint pretty);
267 /* Return non-zero if TYPE should be passed (and returned) by
268 reference at the language level. */
269 int (*la_pass_by_reference) (struct type *type);
271 /* Add fields above this point, so the magic number is always last. */
272 /* Magic number for compat checking */
278 #define LANG_MAGIC 910823L
280 /* Pointer to the language_defn for our current language. This pointer
281 always points to *some* valid struct; it can be used without checking
284 The current language affects expression parsing and evaluation
285 (FIXME: it might be cleaner to make the evaluation-related stuff
286 separate exp_opcodes for each different set of semantics. We
287 should at least think this through more clearly with respect to
288 what happens if the language is changed between parsing and
289 evaluation) and printing of things like types and arrays. It does
290 *not* affect symbol-reading-- each source file in a symbol-file has
291 its own language and we should keep track of that regardless of the
292 language when symbols are read. If we want some manual setting for
293 the language of symbol files (e.g. detecting when ".c" files are
294 C++), it should be a separate setting from the current_language. */
296 extern const struct language_defn *current_language;
298 /* Pointer to the language_defn expected by the user, e.g. the language
299 of main(), or the language we last mentioned in a message, or C. */
301 extern const struct language_defn *expected_language;
304 language_mode_auto: current_language automatically set upon selection
305 of scope (e.g. stack frame)
306 language_mode_manual: current_language set only by user. */
308 extern enum language_mode
310 language_mode_auto, language_mode_manual
314 struct type *language_bool_type (const struct language_defn *l,
315 struct gdbarch *gdbarch);
317 struct type *language_string_char_type (const struct language_defn *l,
318 struct gdbarch *gdbarch);
320 struct type *language_lookup_primitive_type_by_name (const struct language_defn *l,
321 struct gdbarch *gdbarch,
325 /* These macros define the behaviour of the expression
328 /* Should we strictly type check expressions? */
329 #define STRICT_TYPE (type_check != type_check_off)
331 /* Should we range check values against the domain of their type? */
332 #define RANGE_CHECK (range_check != range_check_off)
334 /* "cast" really means conversion */
335 /* FIXME -- should be a setting in language_defn */
336 #define CAST_IS_CONVERSION (current_language->la_language == language_c || \
337 current_language->la_language == language_cplus || \
338 current_language->la_language == language_objc)
340 extern void language_info (int);
342 extern enum language set_language (enum language);
345 /* This page contains functions that return things that are
346 specific to languages. Each of these functions is based on
347 the current setting of working_lang, which the user sets
348 with the "set language" command. */
350 #define LA_PRINT_TYPE(type,varstring,stream,show,level) \
351 (current_language->la_print_type(type,varstring,stream,show,level))
353 #define LA_VAL_PRINT(type,valaddr,offset,addr,stream,fmt,deref,recurse,pretty) \
354 (current_language->la_val_print(type,valaddr,offset,addr,stream,fmt,deref, \
356 #define LA_VALUE_PRINT(val,stream,fmt,pretty) \
357 (current_language->la_value_print(val,stream,fmt,pretty))
359 #define LA_PRINT_CHAR(ch, stream) \
360 (current_language->la_printchar(ch, stream))
361 #define LA_PRINT_STRING(stream, string, length, width, force_ellipses) \
362 (current_language->la_printstr(stream, string, length, width, force_ellipses))
363 #define LA_EMIT_CHAR(ch, stream, quoter) \
364 (current_language->la_emitchar(ch, stream, quoter))
366 #define LA_PRINT_ARRAY_INDEX(index_value, stream, format, pretty) \
367 (current_language->la_print_array_index(index_value, stream, format, pretty))
369 /* Test a character to decide whether it can be printed in literal form
370 or needs to be printed in another representation. For example,
371 in C the literal form of the character with octal value 141 is 'a'
372 and the "other representation" is '\141'. The "other representation"
373 is program language dependent. */
375 #define PRINT_LITERAL_FORM(c) \
377 && ((c) < 0x7F || (c) >= 0xA0) \
378 && (!sevenbit_strings || (c) < 0x80))
381 /* FIXME: cagney/2000-03-04: This function does not appear to be used.
382 It can be deleted once 5.0 has been released. */
383 /* Return a string that contains the hex digits of the number. No preceeding
386 extern char *longest_raw_hex_string (LONGEST);
389 /* Type predicates */
391 extern int simple_type (struct type *);
393 extern int ordered_type (struct type *);
395 extern int same_type (struct type *, struct type *);
397 extern int integral_type (struct type *);
399 extern int numeric_type (struct type *);
401 extern int character_type (struct type *);
403 extern int boolean_type (struct type *);
405 extern int float_type (struct type *);
407 extern int pointer_type (struct type *);
409 extern int structured_type (struct type *);
411 /* Checks Binary and Unary operations for semantic type correctness */
412 /* FIXME: Does not appear to be used */
413 #define unop_type_check(v,o) binop_type_check((v),NULL,(o))
415 extern void binop_type_check (struct value *, struct value *, int);
419 extern void type_error (const char *, ...) ATTR_FORMAT (printf, 1, 2);
421 extern void range_error (const char *, ...) ATTR_FORMAT (printf, 1, 2);
423 /* Data: Does this value represent "truth" to the current language? */
425 extern int value_true (struct value *);
427 /* Misc: The string representing a particular enum language. */
429 extern enum language language_enum (char *str);
431 extern const struct language_defn *language_def (enum language);
433 extern char *language_str (enum language);
435 /* Add a language to the set known by GDB (at initialization time). */
437 extern void add_language (const struct language_defn *);
439 extern enum language get_frame_language (void); /* In stack.c */
441 /* Check for a language-specific trampoline. */
443 extern CORE_ADDR skip_language_trampoline (struct frame_info *, CORE_ADDR pc);
445 /* Return demangled language symbol, or NULL. */
446 extern char *language_demangle (const struct language_defn *current_language,
447 const char *mangled, int options);
449 /* Return class name from physname, or NULL. */
450 extern char *language_class_name_from_physname (const struct language_defn *,
451 const char *physname);
453 /* Splitting strings into words. */
454 extern char *default_word_break_characters (void);
456 /* Print the index of an array element using the C99 syntax. */
457 extern void default_print_array_index (struct value *index_value,
458 struct ui_file *stream,
460 enum val_prettyprint pretty);
462 /* Return non-zero if TYPE should be passed (and returned) by
463 reference at the language level. */
464 int language_pass_by_reference (struct type *type);
466 /* Return zero; by default, types are passed by value at the language
467 level. The target ABI may pass or return some structs by reference
468 independent of this. */
469 int default_pass_by_reference (struct type *type);
471 #endif /* defined (LANGUAGE_H) */