1 /* Source-language-related definitions for GDB.
3 Copyright (C) 1991, 1992, 1993, 1994, 1995, 1998, 1999, 2000, 2003, 2004,
4 2007 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 /* enum exp_opcode; ANSI's `wisdom' didn't include forward enum decls. */
36 /* This used to be included to configure GDB for one or more specific
37 languages. Now it is left out to configure for all of them. FIXME. */
38 /* #include "lang_def.h" */
44 #define MAX_FORTRAN_DIMS 7 /* Maximum number of F77 array dims */
47 range_mode_auto: range_check set automatically to default of language.
48 range_mode_manual: range_check set manually by user. */
50 extern enum range_mode
52 range_mode_auto
, range_mode_manual
57 range_check_on: Ranges are checked in GDB expressions, producing errors.
58 range_check_warn: Ranges are checked, producing warnings.
59 range_check_off: Ranges are not checked in GDB expressions. */
61 extern enum range_check
63 range_check_off
, range_check_warn
, range_check_on
68 type_mode_auto: type_check set automatically to default of language
69 type_mode_manual: type_check set manually by user. */
73 type_mode_auto
, type_mode_manual
78 type_check_on: Types are checked in GDB expressions, producing errors.
79 type_check_warn: Types are checked, producing warnings.
80 type_check_off: Types are not checked in GDB expressions. */
82 extern enum type_check
84 type_check_off
, type_check_warn
, type_check_on
89 case_mode_auto: case_sensitivity set upon selection of scope
90 case_mode_manual: case_sensitivity set only by user. */
94 case_mode_auto
, case_mode_manual
99 array_row_major: Arrays are in row major order
100 array_column_major: Arrays are in column major order.*/
102 extern enum array_ordering
104 array_row_major
, array_column_major
109 /* case_sensitivity ==
110 case_sensitive_on: Case sensitivity in name matching is used
111 case_sensitive_off: Case sensitivity in name matching is not used */
113 extern enum case_sensitivity
115 case_sensitive_on
, case_sensitive_off
119 /* Per architecture (OS/ABI) language information. */
121 struct language_arch_info
123 /* Its primitive types. This is a vector ended by a NULL pointer.
124 These types can be specified by name in parsing types in
125 expressions, regardless of whether the program being debugged
126 actually defines such a type. */
127 struct type
**primitive_type_vector
;
128 /* Type of elements of strings. */
129 struct type
*string_char_type
;
132 struct type
*language_string_char_type (const struct language_defn
*l
,
133 struct gdbarch
*gdbarch
);
135 struct type
*language_lookup_primitive_type_by_name (const struct language_defn
*l
,
136 struct gdbarch
*gdbarch
,
139 /* Structure tying together assorted information about a language. */
143 /* Name of the language */
147 /* its symtab language-enum (defs.h) */
149 enum language la_language
;
151 /* Default range checking */
153 enum range_check la_range_check
;
155 /* Default type checking */
157 enum type_check la_type_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 /* Definitions related to expression printing, prefixifying, and
168 const struct exp_descriptor
*la_exp_desc
;
170 /* Parser function. */
172 int (*la_parser
) (void);
174 /* Parser error function */
176 void (*la_error
) (char *);
178 /* Given an expression *EXPP created by prefixifying the result of
179 la_parser, perform any remaining processing necessary to complete
180 its translation. *EXPP may change; la_post_parser is responsible
181 for releasing its previous contents, if necessary. If
182 VOID_CONTEXT_P, then no value is expected from the expression. */
184 void (*la_post_parser
) (struct expression
** expp
, int void_context_p
);
186 void (*la_printchar
) (int ch
, struct ui_file
* stream
);
188 void (*la_printstr
) (struct ui_file
* stream
, const gdb_byte
*string
,
189 unsigned int length
, int width
,
192 void (*la_emitchar
) (int ch
, struct ui_file
* stream
, int quoter
);
194 struct type
*(*la_fund_type
) (struct objfile
*, int);
196 /* Print a type using syntax appropriate for this language. */
198 void (*la_print_type
) (struct type
*, char *, struct ui_file
*, int,
201 /* Print a value using syntax appropriate for this language. */
203 int (*la_val_print
) (struct type
*, const gdb_byte
*, int, CORE_ADDR
,
204 struct ui_file
*, int, int, int,
205 enum val_prettyprint
);
207 /* Print a top-level value using syntax appropriate for this language. */
209 int (*la_value_print
) (struct value
*, struct ui_file
*,
210 int, enum val_prettyprint
);
212 /* PC is possibly an unknown languages trampoline.
213 If that PC falls in a trampoline belonging to this language,
214 return the address of the first pc in the real function, or 0
215 if it isn't a language tramp for this language. */
216 CORE_ADDR (*skip_trampoline
) (struct frame_info
*, CORE_ADDR
);
218 /* Now come some hooks for lookup_symbol. */
220 /* If this is non-NULL, lookup_symbol will do the 'field_of_this'
221 check, using this function to find the value of this. */
223 /* FIXME: carlton/2003-05-19: Audit all the language_defn structs
224 to make sure we're setting this appropriately: I'm sure it
225 could be NULL in more languages. */
227 struct value
*(*la_value_of_this
) (int complain
);
229 /* This is a function that lookup_symbol will call when it gets to
230 the part of symbol lookup where C looks up static and global
233 struct symbol
*(*la_lookup_symbol_nonlocal
) (const char *,
235 const struct block
*,
239 /* Find the definition of the type with the given name. */
240 struct type
*(*la_lookup_transparent_type
) (const char *);
242 /* Return demangled language symbol, or NULL. */
243 char *(*la_demangle
) (const char *mangled
, int options
);
245 /* Return class name of a mangled method name or NULL. */
246 char *(*la_class_name_from_physname
) (const char *physname
);
248 /* Table for printing expressions */
250 const struct op_print
*la_op_print_tab
;
252 /* Zero if the language has first-class arrays. True if there are no
253 array values, and array objects decay to pointers, as in C. */
257 /* Index to use for extracting the first element of a string. */
258 char string_lower_bound
;
260 /* The list of characters forming word boundaries. */
261 char *(*la_word_break_characters
) (void);
263 /* The per-architecture (OS/ABI) language information. */
264 void (*la_language_arch_info
) (struct gdbarch
*,
265 struct language_arch_info
*);
267 /* Print the index of an element of an array. */
268 void (*la_print_array_index
) (struct value
*index_value
,
269 struct ui_file
*stream
,
271 enum val_prettyprint pretty
);
273 /* Return non-zero if TYPE should be passed (and returned) by
274 reference at the language level. */
275 int (*la_pass_by_reference
) (struct type
*type
);
277 /* Add fields above this point, so the magic number is always last. */
278 /* Magic number for compat checking */
284 #define LANG_MAGIC 910823L
286 /* Pointer to the language_defn for our current language. This pointer
287 always points to *some* valid struct; it can be used without checking
290 The current language affects expression parsing and evaluation
291 (FIXME: it might be cleaner to make the evaluation-related stuff
292 separate exp_opcodes for each different set of semantics. We
293 should at least think this through more clearly with respect to
294 what happens if the language is changed between parsing and
295 evaluation) and printing of things like types and arrays. It does
296 *not* affect symbol-reading-- each source file in a symbol-file has
297 its own language and we should keep track of that regardless of the
298 language when symbols are read. If we want some manual setting for
299 the language of symbol files (e.g. detecting when ".c" files are
300 C++), it should be a separate setting from the current_language. */
302 extern const struct language_defn
*current_language
;
304 /* Pointer to the language_defn expected by the user, e.g. the language
305 of main(), or the language we last mentioned in a message, or C. */
307 extern const struct language_defn
*expected_language
;
310 language_mode_auto: current_language automatically set upon selection
311 of scope (e.g. stack frame)
312 language_mode_manual: current_language set only by user. */
314 extern enum language_mode
316 language_mode_auto
, language_mode_manual
320 /* These macros define the behaviour of the expression
323 /* Should we strictly type check expressions? */
324 #define STRICT_TYPE (type_check != type_check_off)
326 /* Should we range check values against the domain of their type? */
327 #define RANGE_CHECK (range_check != range_check_off)
329 /* "cast" really means conversion */
330 /* FIXME -- should be a setting in language_defn */
331 #define CAST_IS_CONVERSION (current_language->la_language == language_c || \
332 current_language->la_language == language_cplus || \
333 current_language->la_language == language_objc)
335 extern void language_info (int);
337 extern enum language
set_language (enum language
);
340 /* This page contains functions that return things that are
341 specific to languages. Each of these functions is based on
342 the current setting of working_lang, which the user sets
343 with the "set language" command. */
345 #define create_fundamental_type(objfile,typeid) \
346 (current_language->la_fund_type(objfile, typeid))
348 #define LA_PRINT_TYPE(type,varstring,stream,show,level) \
349 (current_language->la_print_type(type,varstring,stream,show,level))
351 #define LA_VAL_PRINT(type,valaddr,offset,addr,stream,fmt,deref,recurse,pretty) \
352 (current_language->la_val_print(type,valaddr,offset,addr,stream,fmt,deref, \
354 #define LA_VALUE_PRINT(val,stream,fmt,pretty) \
355 (current_language->la_value_print(val,stream,fmt,pretty))
357 #define LA_PRINT_CHAR(ch, stream) \
358 (current_language->la_printchar(ch, stream))
359 #define LA_PRINT_STRING(stream, string, length, width, force_ellipses) \
360 (current_language->la_printstr(stream, string, length, width, force_ellipses))
361 #define LA_EMIT_CHAR(ch, stream, quoter) \
362 (current_language->la_emitchar(ch, stream, quoter))
364 #define LA_PRINT_ARRAY_INDEX(index_value, stream, format, pretty) \
365 (current_language->la_print_array_index(index_value, stream, format, pretty))
367 /* Test a character to decide whether it can be printed in literal form
368 or needs to be printed in another representation. For example,
369 in C the literal form of the character with octal value 141 is 'a'
370 and the "other representation" is '\141'. The "other representation"
371 is program language dependent. */
373 #define PRINT_LITERAL_FORM(c) \
375 && ((c) < 0x7F || (c) >= 0xA0) \
376 && (!sevenbit_strings || (c) < 0x80))
379 /* FIXME: cagney/2000-03-04: This function does not appear to be used.
380 It can be deleted once 5.0 has been released. */
381 /* Return a string that contains the hex digits of the number. No preceeding
384 extern char *longest_raw_hex_string (LONGEST
);
387 /* Type predicates */
389 extern int simple_type (struct type
*);
391 extern int ordered_type (struct type
*);
393 extern int same_type (struct type
*, struct type
*);
395 extern int integral_type (struct type
*);
397 extern int numeric_type (struct type
*);
399 extern int character_type (struct type
*);
401 extern int boolean_type (struct type
*);
403 extern int float_type (struct type
*);
405 extern int pointer_type (struct type
*);
407 extern int structured_type (struct type
*);
409 /* Checks Binary and Unary operations for semantic type correctness */
410 /* FIXME: Does not appear to be used */
411 #define unop_type_check(v,o) binop_type_check((v),NULL,(o))
413 extern void binop_type_check (struct value
*, struct value
*, int);
417 extern void op_error (const char *lhs
, enum exp_opcode
,
420 extern void type_error (const char *, ...) ATTR_FORMAT (printf
, 1, 2);
422 extern void range_error (const char *, ...) ATTR_FORMAT (printf
, 1, 2);
424 /* Data: Does this value represent "truth" to the current language? */
426 extern int value_true (struct value
*);
428 extern struct type
*lang_bool_type (void);
430 /* The type used for Boolean values in the current language. */
431 #define LA_BOOL_TYPE lang_bool_type ()
433 /* Misc: The string representing a particular enum language. */
435 extern enum language
language_enum (char *str
);
437 extern const struct language_defn
*language_def (enum language
);
439 extern char *language_str (enum language
);
441 /* Add a language to the set known by GDB (at initialization time). */
443 extern void add_language (const struct language_defn
*);
445 extern enum language
get_frame_language (void); /* In stack.c */
447 /* Check for a language-specific trampoline. */
449 extern CORE_ADDR
skip_language_trampoline (struct frame_info
*, CORE_ADDR pc
);
451 /* Return demangled language symbol, or NULL. */
452 extern char *language_demangle (const struct language_defn
*current_language
,
453 const char *mangled
, int options
);
455 /* Return class name from physname, or NULL. */
456 extern char *language_class_name_from_physname (const struct language_defn
*,
457 const char *physname
);
459 /* Splitting strings into words. */
460 extern char *default_word_break_characters (void);
462 /* Print the index of an array element using the C99 syntax. */
463 extern void default_print_array_index (struct value
*index_value
,
464 struct ui_file
*stream
,
466 enum val_prettyprint pretty
);
468 /* Return non-zero if TYPE should be passed (and returned) by
469 reference at the language level. */
470 int language_pass_by_reference (struct type
*type
);
472 /* Return zero; by default, types are passed by value at the language
473 level. The target ABI may pass or return some structs by reference
474 independent of this. */
475 int default_pass_by_reference (struct type
*type
);
477 #endif /* defined (LANGUAGE_H) */