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 #define MAX_FORTRAN_DIMS 7 /* Maximum number of F77 array dims */
37 range_mode_auto: range_check set automatically to default of language.
38 range_mode_manual: range_check set manually by user. */
40 extern enum range_mode
42 range_mode_auto, range_mode_manual
47 range_check_on: Ranges are checked in GDB expressions, producing errors.
48 range_check_warn: Ranges are checked, producing warnings.
49 range_check_off: Ranges are not checked in GDB expressions. */
51 extern enum range_check
53 range_check_off, range_check_warn, range_check_on
58 type_mode_auto: type_check set automatically to default of language
59 type_mode_manual: type_check set manually by user. */
63 type_mode_auto, type_mode_manual
68 type_check_on: Types are checked in GDB expressions, producing errors.
69 type_check_warn: Types are checked, producing warnings.
70 type_check_off: Types are not checked in GDB expressions. */
72 extern enum type_check
74 type_check_off, type_check_warn, type_check_on
79 case_mode_auto: case_sensitivity set upon selection of scope
80 case_mode_manual: case_sensitivity set only by user. */
84 case_mode_auto, case_mode_manual
89 array_row_major: Arrays are in row major order
90 array_column_major: Arrays are in column major order.*/
92 extern enum array_ordering
94 array_row_major, array_column_major
99 /* case_sensitivity ==
100 case_sensitive_on: Case sensitivity in name matching is used
101 case_sensitive_off: Case sensitivity in name matching is not used */
103 extern enum case_sensitivity
105 case_sensitive_on, case_sensitive_off
109 /* Per architecture (OS/ABI) language information. */
111 struct language_arch_info
113 /* Its primitive types. This is a vector ended by a NULL pointer.
114 These types can be specified by name in parsing types in
115 expressions, regardless of whether the program being debugged
116 actually defines such a type. */
117 struct type **primitive_type_vector;
118 /* Type of elements of strings. */
119 struct type *string_char_type;
121 /* Symbol name of type to use as boolean type, if defined. */
122 const char *bool_type_symbol;
123 /* Otherwise, this is the default boolean builtin type. */
124 struct type *bool_type_default;
127 /* Structure tying together assorted information about a language. */
131 /* Name of the language */
135 /* its symtab language-enum (defs.h) */
137 enum language la_language;
139 /* Default range checking */
141 enum range_check la_range_check;
143 /* Default type checking */
145 enum type_check la_type_check;
147 /* Default case sensitivity */
148 enum case_sensitivity la_case_sensitivity;
150 /* Multi-dimensional array ordering */
151 enum array_ordering la_array_ordering;
153 /* Definitions related to expression printing, prefixifying, and
156 const struct exp_descriptor *la_exp_desc;
158 /* Parser function. */
160 int (*la_parser) (void);
162 /* Parser error function */
164 void (*la_error) (char *);
166 /* Given an expression *EXPP created by prefixifying the result of
167 la_parser, perform any remaining processing necessary to complete
168 its translation. *EXPP may change; la_post_parser is responsible
169 for releasing its previous contents, if necessary. If
170 VOID_CONTEXT_P, then no value is expected from the expression. */
172 void (*la_post_parser) (struct expression ** expp, int void_context_p);
174 void (*la_printchar) (int ch, struct ui_file * stream);
176 void (*la_printstr) (struct ui_file * stream, const gdb_byte *string,
177 unsigned int length, int width,
180 void (*la_emitchar) (int ch, struct ui_file * stream, int quoter);
182 /* Print a type using syntax appropriate for this language. */
184 void (*la_print_type) (struct type *, char *, struct ui_file *, int,
187 /* Print a typedef using syntax appropriate for this language.
188 TYPE is the underlying type. NEW_SYMBOL is the symbol naming
189 the type. STREAM is the output stream on which to print. */
191 void (*la_print_typedef) (struct type *type, struct symbol *new_symbol,
192 struct ui_file *stream);
194 /* Print a value using syntax appropriate for this language. */
196 int (*la_val_print) (struct type *, const gdb_byte *, int, CORE_ADDR,
197 struct ui_file *, int, int, int,
198 enum val_prettyprint);
200 /* Print a top-level value using syntax appropriate for this language. */
202 int (*la_value_print) (struct value *, struct ui_file *,
203 int, enum val_prettyprint);
205 /* PC is possibly an unknown languages trampoline.
206 If that PC falls in a trampoline belonging to this language,
207 return the address of the first pc in the real function, or 0
208 if it isn't a language tramp for this language. */
209 CORE_ADDR (*skip_trampoline) (struct frame_info *, CORE_ADDR);
211 /* Now come some hooks for lookup_symbol. */
213 /* If this is non-NULL, specifies the name that of the implicit
214 local variable that refers to the current object instance. */
216 char *la_name_of_this;
218 /* This is a function that lookup_symbol will call when it gets to
219 the part of symbol lookup where C looks up static and global
222 struct symbol *(*la_lookup_symbol_nonlocal) (const char *,
224 const struct block *,
227 /* Find the definition of the type with the given name. */
228 struct type *(*la_lookup_transparent_type) (const char *);
230 /* Return demangled language symbol, or NULL. */
231 char *(*la_demangle) (const char *mangled, int options);
233 /* Return class name of a mangled method name or NULL. */
234 char *(*la_class_name_from_physname) (const char *physname);
236 /* Table for printing expressions */
238 const struct op_print *la_op_print_tab;
240 /* Zero if the language has first-class arrays. True if there are no
241 array values, and array objects decay to pointers, as in C. */
245 /* Index to use for extracting the first element of a string. */
246 char string_lower_bound;
248 /* The list of characters forming word boundaries. */
249 char *(*la_word_break_characters) (void);
251 /* Should return a NULL terminated array of all symbols which
252 are possible completions for TEXT. WORD is the entire command
253 on which the completion is being made. */
254 char **(*la_make_symbol_completion_list) (char *text, char *word);
256 /* The per-architecture (OS/ABI) language information. */
257 void (*la_language_arch_info) (struct gdbarch *,
258 struct language_arch_info *);
260 /* Print the index of an element of an array. */
261 void (*la_print_array_index) (struct value *index_value,
262 struct ui_file *stream,
264 enum val_prettyprint pretty);
266 /* Return non-zero if TYPE should be passed (and returned) by
267 reference at the language level. */
268 int (*la_pass_by_reference) (struct type *type);
270 /* Add fields above this point, so the magic number is always last. */
271 /* Magic number for compat checking */
277 #define LANG_MAGIC 910823L
279 /* Pointer to the language_defn for our current language. This pointer
280 always points to *some* valid struct; it can be used without checking
283 The current language affects expression parsing and evaluation
284 (FIXME: it might be cleaner to make the evaluation-related stuff
285 separate exp_opcodes for each different set of semantics. We
286 should at least think this through more clearly with respect to
287 what happens if the language is changed between parsing and
288 evaluation) and printing of things like types and arrays. It does
289 *not* affect symbol-reading-- each source file in a symbol-file has
290 its own language and we should keep track of that regardless of the
291 language when symbols are read. If we want some manual setting for
292 the language of symbol files (e.g. detecting when ".c" files are
293 C++), it should be a separate setting from the current_language. */
295 extern const struct language_defn *current_language;
297 /* Pointer to the language_defn expected by the user, e.g. the language
298 of main(), or the language we last mentioned in a message, or C. */
300 extern const struct language_defn *expected_language;
303 language_mode_auto: current_language automatically set upon selection
304 of scope (e.g. stack frame)
305 language_mode_manual: current_language set only by user. */
307 extern enum language_mode
309 language_mode_auto, language_mode_manual
313 struct type *language_bool_type (const struct language_defn *l,
314 struct gdbarch *gdbarch);
316 struct type *language_string_char_type (const struct language_defn *l,
317 struct gdbarch *gdbarch);
319 struct type *language_lookup_primitive_type_by_name (const struct language_defn *l,
320 struct gdbarch *gdbarch,
324 /* These macros define the behaviour of the expression
327 /* Should we strictly type check expressions? */
328 #define STRICT_TYPE (type_check != type_check_off)
330 /* Should we range check values against the domain of their type? */
331 #define RANGE_CHECK (range_check != range_check_off)
333 /* "cast" really means conversion */
334 /* FIXME -- should be a setting in language_defn */
335 #define CAST_IS_CONVERSION (current_language->la_language == language_c || \
336 current_language->la_language == language_cplus || \
337 current_language->la_language == language_objc)
339 extern void language_info (int);
341 extern enum language set_language (enum language);
344 /* This page contains functions that return things that are
345 specific to languages. Each of these functions is based on
346 the current setting of working_lang, which the user sets
347 with the "set language" command. */
349 #define LA_PRINT_TYPE(type,varstring,stream,show,level) \
350 (current_language->la_print_type(type,varstring,stream,show,level))
352 #define LA_PRINT_TYPEDEF(type,new_symbol,stream) \
353 (current_language->la_print_typedef(type,new_symbol,stream))
355 #define LA_VAL_PRINT(type,valaddr,offset,addr,stream,fmt,deref,recurse,pretty) \
356 (current_language->la_val_print(type,valaddr,offset,addr,stream,fmt,deref, \
358 #define LA_VALUE_PRINT(val,stream,fmt,pretty) \
359 (current_language->la_value_print(val,stream,fmt,pretty))
361 #define LA_PRINT_CHAR(ch, stream) \
362 (current_language->la_printchar(ch, stream))
363 #define LA_PRINT_STRING(stream, string, length, width, force_ellipses) \
364 (current_language->la_printstr(stream, string, length, width, force_ellipses))
365 #define LA_EMIT_CHAR(ch, stream, quoter) \
366 (current_language->la_emitchar(ch, stream, quoter))
368 #define LA_PRINT_ARRAY_INDEX(index_value, stream, format, pretty) \
369 (current_language->la_print_array_index(index_value, stream, format, pretty))
371 /* Test a character to decide whether it can be printed in literal form
372 or needs to be printed in another representation. For example,
373 in C the literal form of the character with octal value 141 is 'a'
374 and the "other representation" is '\141'. The "other representation"
375 is program language dependent. */
377 #define PRINT_LITERAL_FORM(c) \
379 && ((c) < 0x7F || (c) >= 0xA0) \
380 && (!sevenbit_strings || (c) < 0x80))
383 /* FIXME: cagney/2000-03-04: This function does not appear to be used.
384 It can be deleted once 5.0 has been released. */
385 /* Return a string that contains the hex digits of the number. No preceeding
388 extern char *longest_raw_hex_string (LONGEST);
391 /* Type predicates */
393 extern int simple_type (struct type *);
395 extern int ordered_type (struct type *);
397 extern int same_type (struct type *, struct type *);
399 extern int integral_type (struct type *);
401 extern int numeric_type (struct type *);
403 extern int character_type (struct type *);
405 extern int boolean_type (struct type *);
407 extern int float_type (struct type *);
409 extern int pointer_type (struct type *);
411 extern int structured_type (struct type *);
413 /* Checks Binary and Unary operations for semantic type correctness */
414 /* FIXME: Does not appear to be used */
415 #define unop_type_check(v,o) binop_type_check((v),NULL,(o))
417 extern void binop_type_check (struct value *, struct value *, int);
421 extern void type_error (const char *, ...) ATTR_FORMAT (printf, 1, 2);
423 extern void range_error (const char *, ...) ATTR_FORMAT (printf, 1, 2);
425 /* Data: Does this value represent "truth" to the current language? */
427 extern int value_true (struct value *);
429 /* Misc: The string representing a particular enum language. */
431 extern enum language language_enum (char *str);
433 extern const struct language_defn *language_def (enum language);
435 extern char *language_str (enum language);
437 /* Add a language to the set known by GDB (at initialization time). */
439 extern void add_language (const struct language_defn *);
441 extern enum language get_frame_language (void); /* In stack.c */
443 /* Check for a language-specific trampoline. */
445 extern CORE_ADDR skip_language_trampoline (struct frame_info *, CORE_ADDR pc);
447 /* Return demangled language symbol, or NULL. */
448 extern char *language_demangle (const struct language_defn *current_language,
449 const char *mangled, int options);
451 /* Return class name from physname, or NULL. */
452 extern char *language_class_name_from_physname (const struct language_defn *,
453 const char *physname);
455 /* Splitting strings into words. */
456 extern char *default_word_break_characters (void);
458 /* Print the index of an array element using the C99 syntax. */
459 extern void default_print_array_index (struct value *index_value,
460 struct ui_file *stream,
462 enum val_prettyprint pretty);
464 /* Return non-zero if TYPE should be passed (and returned) by
465 reference at the language level. */
466 int language_pass_by_reference (struct type *type);
468 /* Return zero; by default, types are passed by value at the language
469 level. The target ABI may pass or return some structs by reference
470 independent of this. */
471 int default_pass_by_reference (struct type *type);
473 /* The default implementation of la_print_typedef. */
474 void default_print_typedef (struct type *type, struct symbol *new_symbol,
475 struct ui_file *stream);
477 #endif /* defined (LANGUAGE_H) */