PR breakpoints/13568:
[deliverable/binutils-gdb.git] / gdb / language.h
CommitLineData
c906108c 1/* Source-language-related definitions for GDB.
1bac305b 2
0b302171
JB
3 Copyright (C) 1991-1995, 1998-2000, 2003-2004, 2007-2012 Free
4 Software Foundation, Inc.
1bac305b 5
c906108c
SS
6 Contributed by the Department of Computer Science at the State University
7 of New York at Buffalo.
8
c5aa993b 9 This file is part of GDB.
c906108c 10
c5aa993b
JM
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
a9762ec7 13 the Free Software Foundation; either version 3 of the License, or
c5aa993b 14 (at your option) any later version.
c906108c 15
c5aa993b
JM
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.
c906108c 20
c5aa993b 21 You should have received a copy of the GNU General Public License
a9762ec7 22 along with this program. If not, see <http://www.gnu.org/licenses/>. */
c906108c
SS
23
24#if !defined (LANGUAGE_H)
25#define LANGUAGE_H 1
26
1777feb0 27/* Forward decls for prototypes. */
c906108c
SS
28struct value;
29struct objfile;
52f729a7 30struct frame_info;
c906108c 31struct expression;
da3331ec 32struct ui_file;
79a45b7d 33struct value_print_options;
62dfaa9c 34
1777feb0 35#define MAX_FORTRAN_DIMS 7 /* Maximum number of F77 array dims. */
c906108c
SS
36
37/* range_mode ==
38 range_mode_auto: range_check set automatically to default of language.
39 range_mode_manual: range_check set manually by user. */
40
c5aa993b
JM
41extern enum range_mode
42 {
43 range_mode_auto, range_mode_manual
44 }
45range_mode;
c906108c
SS
46
47/* range_check ==
48 range_check_on: Ranges are checked in GDB expressions, producing errors.
49 range_check_warn: Ranges are checked, producing warnings.
50 range_check_off: Ranges are not checked in GDB expressions. */
51
52extern enum range_check
c5aa993b
JM
53 {
54 range_check_off, range_check_warn, range_check_on
55 }
56range_check;
c906108c
SS
57
58/* type_mode ==
1777feb0
MS
59 type_mode_auto: type_check set automatically to default of language.
60 type_mode_manual: type_check set manually by user. */
c906108c 61
c5aa993b
JM
62extern enum type_mode
63 {
64 type_mode_auto, type_mode_manual
65 }
66type_mode;
c906108c
SS
67
68/* type_check ==
69 type_check_on: Types are checked in GDB expressions, producing errors.
70 type_check_warn: Types are checked, producing warnings.
71 type_check_off: Types are not checked in GDB expressions. */
72
73extern enum type_check
c5aa993b
JM
74 {
75 type_check_off, type_check_warn, type_check_on
76 }
77type_check;
63872f9d
JG
78
79/* case_mode ==
1777feb0 80 case_mode_auto: case_sensitivity set upon selection of scope.
63872f9d
JG
81 case_mode_manual: case_sensitivity set only by user. */
82
83extern enum case_mode
84 {
85 case_mode_auto, case_mode_manual
86 }
87case_mode;
88
7ca2d3a3 89/* array_ordering ==
1777feb0
MS
90 array_row_major: Arrays are in row major order.
91 array_column_major: Arrays are in column major order. */
7ca2d3a3
DL
92
93extern enum array_ordering
94 {
95 array_row_major, array_column_major
96 }
97array_ordering;
98
99
63872f9d 100/* case_sensitivity ==
1777feb0
MS
101 case_sensitive_on: Case sensitivity in name matching is used.
102 case_sensitive_off: Case sensitivity in name matching is not used. */
63872f9d
JG
103
104extern enum case_sensitivity
105 {
106 case_sensitive_on, case_sensitive_off
107 }
108case_sensitivity;
9a044a89
TT
109
110
111/* macro_expansion ==
1777feb0
MS
112 macro_expansion_no: No macro expansion is available.
113 macro_expansion_c: C-like macro expansion is available. */
9a044a89
TT
114
115enum macro_expansion
116 {
117 macro_expansion_no, macro_expansion_c
118 };
119
c906108c 120\f
f290d38e
AC
121/* Per architecture (OS/ABI) language information. */
122
123struct language_arch_info
124{
5a44ea29 125 /* Its primitive types. This is a vector ended by a NULL pointer.
f290d38e
AC
126 These types can be specified by name in parsing types in
127 expressions, regardless of whether the program being debugged
128 actually defines such a type. */
5a44ea29 129 struct type **primitive_type_vector;
1777feb0 130 /* Type of elements of strings. */
f290d38e 131 struct type *string_char_type;
fbb06eb1
UW
132
133 /* Symbol name of type to use as boolean type, if defined. */
134 const char *bool_type_symbol;
135 /* Otherwise, this is the default boolean builtin type. */
136 struct type *bool_type_default;
f290d38e
AC
137};
138
74ccd7f5
JB
139/* A pointer to a function expected to return nonzero if
140 SYMBOL_SEARCH_NAME matches the given LOOKUP_NAME.
141
142 SYMBOL_SEARCH_NAME should be a symbol's "search" name.
143 LOOKUP_NAME should be the name of an entity after it has been
144 transformed for lookup. */
145
146typedef int (*symbol_name_match_p_ftype) (const char *symbol_search_name,
147 const char *lookup_name);
148
c906108c
SS
149/* Structure tying together assorted information about a language. */
150
151struct language_defn
c5aa993b 152 {
1777feb0 153 /* Name of the language. */
c906108c 154
c5aa993b 155 char *la_name;
c906108c 156
1777feb0 157 /* its symtab language-enum (defs.h). */
c906108c 158
c5aa993b 159 enum language la_language;
c906108c 160
1777feb0 161 /* Default range checking. */
c906108c 162
c5aa993b 163 enum range_check la_range_check;
c906108c 164
1777feb0 165 /* Default type checking. */
c906108c 166
c5aa993b 167 enum type_check la_type_check;
c906108c 168
1777feb0 169 /* Default case sensitivity. */
63872f9d
JG
170 enum case_sensitivity la_case_sensitivity;
171
1777feb0 172 /* Multi-dimensional array ordering. */
7ca2d3a3
DL
173 enum array_ordering la_array_ordering;
174
9a044a89
TT
175 /* Style of macro expansion, if any, supported by this language. */
176 enum macro_expansion la_macro_expansion;
177
5f9769d1 178 /* Definitions related to expression printing, prefixifying, and
1777feb0 179 dumping. */
5f9769d1
PH
180
181 const struct exp_descriptor *la_exp_desc;
182
1777feb0 183 /* Parser function. */
c906108c 184
507f3c78 185 int (*la_parser) (void);
c906108c 186
1777feb0 187 /* Parser error function. */
c906108c 188
507f3c78 189 void (*la_error) (char *);
c906108c 190
e85c3284
PH
191 /* Given an expression *EXPP created by prefixifying the result of
192 la_parser, perform any remaining processing necessary to complete
193 its translation. *EXPP may change; la_post_parser is responsible
194 for releasing its previous contents, if necessary. If
195 VOID_CONTEXT_P, then no value is expected from the expression. */
196
197 void (*la_post_parser) (struct expression ** expp, int void_context_p);
198
3e43a32a
MS
199 void (*la_printchar) (int ch, struct type *chtype,
200 struct ui_file * stream);
c906108c 201
6c7a06a3
TT
202 void (*la_printstr) (struct ui_file * stream, struct type *elttype,
203 const gdb_byte *string, unsigned int length,
be759fcf 204 const char *encoding, int force_ellipses,
79a45b7d 205 const struct value_print_options *);
c906108c 206
6c7a06a3
TT
207 void (*la_emitchar) (int ch, struct type *chtype,
208 struct ui_file * stream, int quoter);
c906108c 209
1777feb0 210 /* Print a type using syntax appropriate for this language. */
c906108c 211
25b524e8 212 void (*la_print_type) (struct type *, const char *, struct ui_file *, int,
d9fcf2fb 213 int);
c906108c 214
5c6ce71d
TT
215 /* Print a typedef using syntax appropriate for this language.
216 TYPE is the underlying type. NEW_SYMBOL is the symbol naming
217 the type. STREAM is the output stream on which to print. */
218
219 void (*la_print_typedef) (struct type *type, struct symbol *new_symbol,
220 struct ui_file *stream);
221
edf3d5f3
TT
222 /* Print a value using syntax appropriate for this language.
223
224 TYPE is the type of the sub-object to be printed.
c906108c 225
edf3d5f3
TT
226 CONTENTS holds the bits of the value. This holds the entire
227 enclosing object.
228
229 EMBEDDED_OFFSET is the offset into the outermost object of the
230 sub-object represented by TYPE. This is the object which this
231 call should print. Note that the enclosing type is not
232 available.
233
234 ADDRESS is the address in the inferior of the enclosing object.
235
236 STREAM is the stream on which the value is to be printed.
237
238 RECURSE is the recursion depth. It is zero-based.
239
240 OPTIONS are the formatting options to be used when
241 printing. */
242
243 int (*la_val_print) (struct type *type,
244 const gdb_byte *contents,
245 int embedded_offset, CORE_ADDR address,
246 struct ui_file *stream, int recurse,
0e03807e 247 const struct value *val,
edf3d5f3 248 const struct value_print_options *options);
c906108c 249
1777feb0 250 /* Print a top-level value using syntax appropriate for this language. */
c906108c 251
d9fcf2fb 252 int (*la_value_print) (struct value *, struct ui_file *,
79a45b7d 253 const struct value_print_options *);
c906108c 254
f636b87d
AF
255 /* PC is possibly an unknown languages trampoline.
256 If that PC falls in a trampoline belonging to this language,
257 return the address of the first pc in the real function, or 0
258 if it isn't a language tramp for this language. */
52f729a7 259 CORE_ADDR (*skip_trampoline) (struct frame_info *, CORE_ADDR);
f636b87d 260
5f9a71c3
DC
261 /* Now come some hooks for lookup_symbol. */
262
2b2d9e11
VP
263 /* If this is non-NULL, specifies the name that of the implicit
264 local variable that refers to the current object instance. */
5f9a71c3 265
2b2d9e11 266 char *la_name_of_this;
5f9a71c3
DC
267
268 /* This is a function that lookup_symbol will call when it gets to
269 the part of symbol lookup where C looks up static and global
270 variables. */
271
272 struct symbol *(*la_lookup_symbol_nonlocal) (const char *,
5f9a71c3 273 const struct block *,
21b556f4 274 const domain_enum);
5f9a71c3 275
b368761e
DC
276 /* Find the definition of the type with the given name. */
277 struct type *(*la_lookup_transparent_type) (const char *);
278
9a3d7dfd
AF
279 /* Return demangled language symbol, or NULL. */
280 char *(*la_demangle) (const char *mangled, int options);
281
31c27f77
JJ
282 /* Return class name of a mangled method name or NULL. */
283 char *(*la_class_name_from_physname) (const char *physname);
284
1777feb0 285 /* Table for printing expressions. */
c906108c 286
c5aa993b 287 const struct op_print *la_op_print_tab;
c906108c 288
c5aa993b 289 /* Zero if the language has first-class arrays. True if there are no
1777feb0 290 array values, and array objects decay to pointers, as in C. */
c906108c 291
c5aa993b 292 char c_style_arrays;
c906108c 293
1777feb0 294 /* Index to use for extracting the first element of a string. */
c5aa993b 295 char string_lower_bound;
c906108c 296
6084f43a
JB
297 /* The list of characters forming word boundaries. */
298 char *(*la_word_break_characters) (void);
299
41d27058
JB
300 /* Should return a NULL terminated array of all symbols which
301 are possible completions for TEXT. WORD is the entire command
302 on which the completion is being made. */
303 char **(*la_make_symbol_completion_list) (char *text, char *word);
304
f290d38e
AC
305 /* The per-architecture (OS/ABI) language information. */
306 void (*la_language_arch_info) (struct gdbarch *,
307 struct language_arch_info *);
308
e79af960
JB
309 /* Print the index of an element of an array. */
310 void (*la_print_array_index) (struct value *index_value,
311 struct ui_file *stream,
79a45b7d 312 const struct value_print_options *options);
e79af960 313
41f1b697
DJ
314 /* Return non-zero if TYPE should be passed (and returned) by
315 reference at the language level. */
316 int (*la_pass_by_reference) (struct type *type);
317
ae6a3a4c 318 /* Obtain a string from the inferior, storing it in a newly allocated
fbb8f299
PM
319 buffer in BUFFER, which should be freed by the caller. If the
320 in- and out-parameter *LENGTH is specified at -1, the string is
321 read until a null character of the appropriate width is found -
322 otherwise the string is read to the length of characters specified.
323 On completion, *LENGTH will hold the size of the string in characters.
324 If a *LENGTH of -1 was specified it will count only actual
325 characters, excluding any eventual terminating null character.
326 Otherwise *LENGTH will include all characters - including any nulls.
327 CHARSET will hold the encoding used in the string. */
ae6a3a4c 328 void (*la_get_string) (struct value *value, gdb_byte **buffer, int *length,
96c07c5b 329 struct type **chartype, const char **charset);
ae6a3a4c 330
74ccd7f5
JB
331 /* Return a pointer to the function that should be used to match
332 a symbol name against LOOKUP_NAME. This is mostly for languages
333 such as Ada where the matching algorithm depends on LOOKUP_NAME.
f8eba3c6 334
74ccd7f5
JB
335 This field may be NULL, in which case strcmp_iw will be used
336 to perform the matching. */
337 symbol_name_match_p_ftype (*la_get_symbol_name_match_p)
338 (const char *lookup_name);
f8eba3c6
TT
339
340 /* Find all symbols in the current program space matching NAME in
341 DOMAIN, according to this language's rules.
342
343 The search starts with BLOCK. This function iterates upward
344 through blocks. When the outermost block has been finished,
345 the function returns.
346
347 For each one, call CALLBACK with the symbol and the DATA
348 argument. If CALLBACK returns zero, the iteration ends at that
349 point.
350
351 This field can be NULL, meaning that this language doesn't need
352 any special code aside from ordinary searches of the symbol
353 table. */
354 void (*la_iterate_over_symbols) (const struct block *block,
355 const char *name,
356 domain_enum domain,
357 int (*callback) (struct symbol *, void *),
358 void *data);
359
1777feb0
MS
360 /* Add fields above this point, so the magic number is always last. */
361 /* Magic number for compat checking. */
c5aa993b
JM
362
363 long la_magic;
364
365 };
c906108c
SS
366
367#define LANG_MAGIC 910823L
368
369/* Pointer to the language_defn for our current language. This pointer
370 always points to *some* valid struct; it can be used without checking
371 it for validity.
372
373 The current language affects expression parsing and evaluation
374 (FIXME: it might be cleaner to make the evaluation-related stuff
375 separate exp_opcodes for each different set of semantics. We
376 should at least think this through more clearly with respect to
377 what happens if the language is changed between parsing and
378 evaluation) and printing of things like types and arrays. It does
379 *not* affect symbol-reading-- each source file in a symbol-file has
380 its own language and we should keep track of that regardless of the
381 language when symbols are read. If we want some manual setting for
382 the language of symbol files (e.g. detecting when ".c" files are
7e73cedf 383 C++), it should be a separate setting from the current_language. */
c906108c
SS
384
385extern const struct language_defn *current_language;
386
387/* Pointer to the language_defn expected by the user, e.g. the language
388 of main(), or the language we last mentioned in a message, or C. */
389
390extern const struct language_defn *expected_language;
391
392/* language_mode ==
393 language_mode_auto: current_language automatically set upon selection
c5aa993b 394 of scope (e.g. stack frame)
c906108c
SS
395 language_mode_manual: current_language set only by user. */
396
397extern enum language_mode
c5aa993b
JM
398 {
399 language_mode_auto, language_mode_manual
400 }
401language_mode;
b62f3443 402
fbb06eb1
UW
403struct type *language_bool_type (const struct language_defn *l,
404 struct gdbarch *gdbarch);
405
b62f3443
JB
406struct type *language_string_char_type (const struct language_defn *l,
407 struct gdbarch *gdbarch);
408
409struct type *language_lookup_primitive_type_by_name (const struct language_defn *l,
410 struct gdbarch *gdbarch,
411 const char *name);
412
c906108c
SS
413\f
414/* These macros define the behaviour of the expression
415 evaluator. */
416
1777feb0 417/* Should we strictly type check expressions? */
c906108c
SS
418#define STRICT_TYPE (type_check != type_check_off)
419
1777feb0 420/* Should we range check values against the domain of their type? */
c906108c
SS
421#define RANGE_CHECK (range_check != range_check_off)
422
1777feb0
MS
423/* "cast" really means conversion. */
424/* FIXME -- should be a setting in language_defn. */
cc73bb8c
TT
425#define CAST_IS_CONVERSION(LANG) ((LANG)->la_language == language_c || \
426 (LANG)->la_language == language_cplus || \
427 (LANG)->la_language == language_objc)
c906108c 428
a14ed312 429extern void language_info (int);
c906108c 430
a14ed312 431extern enum language set_language (enum language);
c906108c 432\f
c5aa993b 433
c906108c
SS
434/* This page contains functions that return things that are
435 specific to languages. Each of these functions is based on
436 the current setting of working_lang, which the user sets
1777feb0 437 with the "set language" command. */
c906108c 438
c906108c
SS
439#define LA_PRINT_TYPE(type,varstring,stream,show,level) \
440 (current_language->la_print_type(type,varstring,stream,show,level))
441
5c6ce71d
TT
442#define LA_PRINT_TYPEDEF(type,new_symbol,stream) \
443 (current_language->la_print_typedef(type,new_symbol,stream))
444
0e03807e 445#define LA_VAL_PRINT(type,valaddr,offset,addr,stream,val,recurse,options) \
79a45b7d 446 (current_language->la_val_print(type,valaddr,offset,addr,stream, \
0e03807e 447 val,recurse,options))
79a45b7d
TT
448#define LA_VALUE_PRINT(val,stream,options) \
449 (current_language->la_value_print(val,stream,options))
c906108c 450
6c7a06a3
TT
451#define LA_PRINT_CHAR(ch, type, stream) \
452 (current_language->la_printchar(ch, type, stream))
3e43a32a 453#define LA_PRINT_STRING(stream, elttype, string, length, encoding, force_ellipses, options) \
6c7a06a3 454 (current_language->la_printstr(stream, elttype, string, length, \
be759fcf 455 encoding, force_ellipses,options))
6c7a06a3
TT
456#define LA_EMIT_CHAR(ch, type, stream, quoter) \
457 (current_language->la_emitchar(ch, type, stream, quoter))
96c07c5b
TT
458#define LA_GET_STRING(value, buffer, length, chartype, encoding) \
459 (current_language->la_get_string(value, buffer, length, chartype, encoding))
c906108c 460
577ce03a 461#define LA_PRINT_ARRAY_INDEX(index_value, stream, options) \
79a45b7d 462 (current_language->la_print_array_index(index_value, stream, options))
e79af960 463
f8eba3c6
TT
464#define LA_ITERATE_OVER_SYMBOLS(BLOCK, NAME, DOMAIN, CALLBACK, DATA) \
465 (current_language->la_iterate_over_symbols (BLOCK, NAME, DOMAIN, CALLBACK, \
466 DATA))
467
c906108c
SS
468/* Test a character to decide whether it can be printed in literal form
469 or needs to be printed in another representation. For example,
470 in C the literal form of the character with octal value 141 is 'a'
471 and the "other representation" is '\141'. The "other representation"
1777feb0 472 is program language dependent. */
c906108c
SS
473
474#define PRINT_LITERAL_FORM(c) \
475 ((c) >= 0x20 \
476 && ((c) < 0x7F || (c) >= 0xA0) \
477 && (!sevenbit_strings || (c) < 0x80))
478
c906108c
SS
479/* Type predicates */
480
a14ed312 481extern int pointer_type (struct type *);
c906108c 482
1777feb0
MS
483/* Checks Binary and Unary operations for semantic type correctness. */
484/* FIXME: Does not appear to be used. */
c906108c
SS
485#define unop_type_check(v,o) binop_type_check((v),NULL,(o))
486
a14ed312 487extern void binop_type_check (struct value *, struct value *, int);
c906108c
SS
488
489/* Error messages */
490
a0b31db1 491extern void type_error (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
c906108c 492
a0b31db1 493extern void range_error (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
c906108c
SS
494
495/* Data: Does this value represent "truth" to the current language? */
496
a14ed312 497extern int value_true (struct value *);
c906108c 498
c906108c
SS
499/* Misc: The string representing a particular enum language. */
500
a14ed312 501extern enum language language_enum (char *str);
c906108c 502
a14ed312 503extern const struct language_defn *language_def (enum language);
7a292a7a 504
a14ed312 505extern char *language_str (enum language);
c906108c
SS
506
507/* Add a language to the set known by GDB (at initialization time). */
508
a14ed312 509extern void add_language (const struct language_defn *);
c906108c 510
a14ed312 511extern enum language get_frame_language (void); /* In stack.c */
c906108c 512
1777feb0 513/* Check for a language-specific trampoline. */
f636b87d 514
52f729a7 515extern CORE_ADDR skip_language_trampoline (struct frame_info *, CORE_ADDR pc);
f636b87d 516
9a3d7dfd
AF
517/* Return demangled language symbol, or NULL. */
518extern char *language_demangle (const struct language_defn *current_language,
519 const char *mangled, int options);
520
31c27f77
JJ
521/* Return class name from physname, or NULL. */
522extern char *language_class_name_from_physname (const struct language_defn *,
523 const char *physname);
524
9f0a5303
JB
525/* Splitting strings into words. */
526extern char *default_word_break_characters (void);
527
e79af960
JB
528/* Print the index of an array element using the C99 syntax. */
529extern void default_print_array_index (struct value *index_value,
530 struct ui_file *stream,
79a45b7d 531 const struct value_print_options *options);
e79af960 532
41f1b697
DJ
533/* Return non-zero if TYPE should be passed (and returned) by
534 reference at the language level. */
535int language_pass_by_reference (struct type *type);
536
537/* Return zero; by default, types are passed by value at the language
538 level. The target ABI may pass or return some structs by reference
539 independent of this. */
540int default_pass_by_reference (struct type *type);
541
5c6ce71d
TT
542/* The default implementation of la_print_typedef. */
543void default_print_typedef (struct type *type, struct symbol *new_symbol,
544 struct ui_file *stream);
545
ae6a3a4c 546void default_get_string (struct value *value, gdb_byte **buffer, int *length,
96c07c5b 547 struct type **char_type, const char **charset);
ae6a3a4c
TJB
548
549void c_get_string (struct value *value, gdb_byte **buffer, int *length,
96c07c5b 550 struct type **char_type, const char **charset);
ae6a3a4c 551
c5aa993b 552#endif /* defined (LANGUAGE_H) */
This page took 0.977716 seconds and 4 git commands to generate.