This commit was generated by cvs2svn to track changes on a CVS vendor
[external/binutils.git] / gdb / language.h
1 /* Source-language-related definitions for GDB.
2    Copyright 1991, 1992, 2000 Free Software Foundation, Inc.
3    Contributed by the Department of Computer Science at the State University
4    of New York at Buffalo.
5
6    This file is part of GDB.
7
8    This program is free software; you can redistribute it and/or modify
9    it under the terms of the GNU General Public License as published by
10    the Free Software Foundation; either version 2 of the License, or
11    (at your option) any later version.
12
13    This program is distributed in the hope that it will be useful,
14    but WITHOUT ANY WARRANTY; without even the implied warranty of
15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16    GNU General Public License for more details.
17
18    You should have received a copy of the GNU General Public License
19    along with this program; if not, write to the Free Software
20    Foundation, Inc., 59 Temple Place - Suite 330,
21    Boston, MA 02111-1307, USA.  */
22
23 #if !defined (LANGUAGE_H)
24 #define LANGUAGE_H 1
25
26 /* Forward decls for prototypes */
27 struct value;
28 struct objfile;
29 struct expression;
30 /* enum exp_opcode;     ANSI's `wisdom' didn't include forward enum decls. */
31
32 /* This used to be included to configure GDB for one or more specific
33    languages.  Now it is shortcutted to configure for all of them.  FIXME.  */
34 /* #include "lang_def.h" */
35 #define _LANG_c
36 #define _LANG_m2
37 #define _LANG_chill
38 #define _LANG_fortran
39
40 #define MAX_FORTRAN_DIMS  7     /* Maximum number of F77 array dims */
41
42 /* range_mode ==
43    range_mode_auto:   range_check set automatically to default of language.
44    range_mode_manual: range_check set manually by user.  */
45
46 extern enum range_mode
47   {
48     range_mode_auto, range_mode_manual
49   }
50 range_mode;
51
52 /* range_check ==
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.  */
56
57 extern enum range_check
58   {
59     range_check_off, range_check_warn, range_check_on
60   }
61 range_check;
62
63 /* type_mode ==
64    type_mode_auto:   type_check set automatically to default of language
65    type_mode_manual: type_check set manually by user. */
66
67 extern enum type_mode
68   {
69     type_mode_auto, type_mode_manual
70   }
71 type_mode;
72
73 /* type_check ==
74    type_check_on:    Types are checked in GDB expressions, producing errors.
75    type_check_warn:  Types are checked, producing warnings.
76    type_check_off:   Types are not checked in GDB expressions.  */
77
78 extern enum type_check
79   {
80     type_check_off, type_check_warn, type_check_on
81   }
82 type_check;
83 \f
84 /* Information for doing language dependent formatting of printed values. */
85
86 struct language_format_info
87   {
88     /* The format that can be passed directly to standard C printf functions
89        to generate a completely formatted value in the format appropriate for
90        the language. */
91
92     char *la_format;
93
94     /* The prefix to be used when directly printing a value, or constructing
95        a standard C printf format.  This generally is everything up to the
96        conversion specification (the part introduced by the '%' character
97        and terminated by the conversion specifier character). */
98
99     char *la_format_prefix;
100
101     /* The conversion specifier.  This is generally everything after the
102        field width and precision, typically only a single character such
103        as 'o' for octal format or 'x' for hexadecimal format. */
104
105     char *la_format_specifier;
106
107     /* The suffix to be used when directly printing a value, or constructing
108        a standard C printf format.  This generally is everything after the
109        conversion specification (the part introduced by the '%' character
110        and terminated by the conversion specifier character). */
111
112     char *la_format_suffix;     /* Suffix for custom format string */
113   };
114
115 /* Structure tying together assorted information about a language.  */
116
117 struct language_defn
118   {
119     /* Name of the language */
120
121     char *la_name;
122
123     /* its symtab language-enum (defs.h) */
124
125     enum language la_language;
126
127     /* Its builtin types.  This is a vector ended by a NULL pointer.  These
128        types can be specified by name in parsing types in expressions,
129        regardless of whether the program being debugged actually defines
130        such a type.  */
131
132     struct type **const *la_builtin_type_vector;
133
134     /* Default range checking */
135
136     enum range_check la_range_check;
137
138     /* Default type checking */
139
140     enum type_check la_type_check;
141
142     /* Parser function. */
143
144     int (*la_parser) PARAMS ((void));
145
146     /* Parser error function */
147
148     void (*la_error) PARAMS ((char *));
149
150     /* Evaluate an expression. */
151     struct value *(*evaluate_exp) PARAMS ((struct type *, struct expression *,
152                                            int *, enum noside));
153
154     void (*la_printchar) (int ch, struct ui_file * stream);
155
156     void (*la_printstr) (struct ui_file * stream, char *string,
157                          unsigned int length, int width,
158                          int force_ellipses);
159
160     void (*la_emitchar) (int ch, struct ui_file * stream, int quoter);
161
162     struct type *(*la_fund_type) PARAMS ((struct objfile *, int));
163
164     /* Print a type using syntax appropriate for this language. */
165
166     void (*la_print_type) (struct type *, char *, struct ui_file *, int,
167                            int);
168
169     /* Print a value using syntax appropriate for this language. */
170
171     int (*la_val_print) (struct type *, char *, int, CORE_ADDR,
172                          struct ui_file *, int, int, int,
173                          enum val_prettyprint);
174
175     /* Print a top-level value using syntax appropriate for this language. */
176
177     int (*la_value_print) (struct value *, struct ui_file *,
178                            int, enum val_prettyprint);
179
180     /* Base 2 (binary) formats. */
181
182     struct language_format_info la_binary_format;
183
184     /* Base 8 (octal) formats. */
185
186     struct language_format_info la_octal_format;
187
188     /* Base 10 (decimal) formats */
189
190     struct language_format_info la_decimal_format;
191
192     /* Base 16 (hexadecimal) formats */
193
194     struct language_format_info la_hex_format;
195
196     /* Table for printing expressions */
197
198     const struct op_print *la_op_print_tab;
199
200     /* Zero if the language has first-class arrays.  True if there are no
201        array values, and array objects decay to pointers, as in C. */
202
203     char c_style_arrays;
204
205     /* Index to use for extracting the first element of a string. */
206     char string_lower_bound;
207
208     /* Type of elements of strings. */
209     struct type **string_char_type;
210
211     /* Add fields above this point, so the magic number is always last. */
212     /* Magic number for compat checking */
213
214     long la_magic;
215
216   };
217
218 #define LANG_MAGIC      910823L
219
220 /* Pointer to the language_defn for our current language.  This pointer
221    always points to *some* valid struct; it can be used without checking
222    it for validity.
223
224    The current language affects expression parsing and evaluation
225    (FIXME: it might be cleaner to make the evaluation-related stuff
226    separate exp_opcodes for each different set of semantics.  We
227    should at least think this through more clearly with respect to
228    what happens if the language is changed between parsing and
229    evaluation) and printing of things like types and arrays.  It does
230    *not* affect symbol-reading-- each source file in a symbol-file has
231    its own language and we should keep track of that regardless of the
232    language when symbols are read.  If we want some manual setting for
233    the language of symbol files (e.g. detecting when ".c" files are
234    C++), it should be a seprate setting from the current_language.  */
235
236 extern const struct language_defn *current_language;
237
238 /* Pointer to the language_defn expected by the user, e.g. the language
239    of main(), or the language we last mentioned in a message, or C.  */
240
241 extern const struct language_defn *expected_language;
242
243 /* language_mode == 
244    language_mode_auto:   current_language automatically set upon selection
245    of scope (e.g. stack frame)
246    language_mode_manual: current_language set only by user.  */
247
248 extern enum language_mode
249   {
250     language_mode_auto, language_mode_manual
251   }
252 language_mode;
253 \f
254 /* These macros define the behaviour of the expression 
255    evaluator.  */
256
257 /* Should we strictly type check expressions? */
258 #define STRICT_TYPE (type_check != type_check_off)
259
260 /* Should we range check values against the domain of their type? */
261 #define RANGE_CHECK (range_check != range_check_off)
262
263 /* "cast" really means conversion */
264 /* FIXME -- should be a setting in language_defn */
265 #define CAST_IS_CONVERSION (current_language->la_language == language_c  || \
266                             current_language->la_language == language_cplus)
267
268 extern void
269 language_info PARAMS ((int));
270
271 extern enum language
272 set_language PARAMS ((enum language));
273 \f
274
275 /* This page contains functions that return things that are
276    specific to languages.  Each of these functions is based on
277    the current setting of working_lang, which the user sets
278    with the "set language" command. */
279
280 #define create_fundamental_type(objfile,typeid) \
281   (current_language->la_fund_type(objfile, typeid))
282
283 #define LA_PRINT_TYPE(type,varstring,stream,show,level) \
284   (current_language->la_print_type(type,varstring,stream,show,level))
285
286 #define LA_VAL_PRINT(type,valaddr,offset,addr,stream,fmt,deref,recurse,pretty) \
287   (current_language->la_val_print(type,valaddr,offset,addr,stream,fmt,deref, \
288                                   recurse,pretty))
289 #define LA_VALUE_PRINT(val,stream,fmt,pretty) \
290   (current_language->la_value_print(val,stream,fmt,pretty))
291
292 /* Return a format string for printf that will print a number in one of
293    the local (language-specific) formats.  Result is static and is
294    overwritten by the next call.  Takes printf options like "08" or "l"
295    (to produce e.g. %08x or %lx).  */
296
297 #define local_binary_format() \
298   (current_language->la_binary_format.la_format)
299 #define local_binary_format_prefix() \
300   (current_language->la_binary_format.la_format_prefix)
301 #define local_binary_format_specifier() \
302   (current_language->la_binary_format.la_format_specifier)
303 #define local_binary_format_suffix() \
304   (current_language->la_binary_format.la_format_suffix)
305
306 #define local_octal_format() \
307   (current_language->la_octal_format.la_format)
308 #define local_octal_format_prefix() \
309   (current_language->la_octal_format.la_format_prefix)
310 #define local_octal_format_specifier() \
311   (current_language->la_octal_format.la_format_specifier)
312 #define local_octal_format_suffix() \
313   (current_language->la_octal_format.la_format_suffix)
314
315 #define local_decimal_format() \
316   (current_language->la_decimal_format.la_format)
317 #define local_decimal_format_prefix() \
318   (current_language->la_decimal_format.la_format_prefix)
319 #define local_decimal_format_specifier() \
320   (current_language->la_decimal_format.la_format_specifier)
321 #define local_decimal_format_suffix() \
322   (current_language->la_decimal_format.la_format_suffix)
323
324 #define local_hex_format() \
325   (current_language->la_hex_format.la_format)
326 #define local_hex_format_prefix() \
327   (current_language->la_hex_format.la_format_prefix)
328 #define local_hex_format_specifier() \
329   (current_language->la_hex_format.la_format_specifier)
330 #define local_hex_format_suffix() \
331   (current_language->la_hex_format.la_format_suffix)
332
333 #define LA_PRINT_CHAR(ch, stream) \
334   (current_language->la_printchar(ch, stream))
335 #define LA_PRINT_STRING(stream, string, length, width, force_ellipses) \
336   (current_language->la_printstr(stream, string, length, width, force_ellipses))
337 #define LA_EMIT_CHAR(ch, stream, quoter) \
338   (current_language->la_emitchar(ch, stream, quoter))
339
340 /* Test a character to decide whether it can be printed in literal form
341    or needs to be printed in another representation.  For example,
342    in C the literal form of the character with octal value 141 is 'a'
343    and the "other representation" is '\141'.  The "other representation"
344    is program language dependent. */
345
346 #define PRINT_LITERAL_FORM(c)           \
347   ((c) >= 0x20                          \
348    && ((c) < 0x7F || (c) >= 0xA0)       \
349    && (!sevenbit_strings || (c) < 0x80))
350
351 /* Return a format string for printf that will print a number in one of
352    the local (language-specific) formats.  Result is static and is
353    overwritten by the next call.  Takes printf options like "08" or "l"
354    (to produce e.g. %08x or %lx).  */
355
356 extern char *
357   local_decimal_format_custom PARAMS ((char *));        /* language.c */
358
359 extern char *
360   local_octal_format_custom PARAMS ((char *));  /* language.c */
361
362 extern char *
363   local_hex_format_custom PARAMS ((char *));    /* language.c */
364
365 /* Return a string that contains the hex digits of the number.  No preceeding
366    "0x" */
367
368 extern char *
369   longest_raw_hex_string PARAMS ((LONGEST));
370
371 /* Return a string that contains a number formatted in one of the local
372    (language-specific) formats.  Result is static and is overwritten by
373    the next call.  Takes printf options like "08l" or "l".  */
374
375 extern char *
376   local_hex_string PARAMS ((unsigned long));    /* language.c */
377
378 extern char *
379   longest_local_hex_string PARAMS ((LONGEST));  /* language.c */
380
381 extern char *
382   local_hex_string_custom PARAMS ((unsigned long, char *));     /* language.c */
383
384 extern char *
385   longest_local_hex_string_custom PARAMS ((LONGEST, char *));   /* language.c */
386
387 /* Type predicates */
388
389 extern int
390 simple_type PARAMS ((struct type *));
391
392 extern int
393 ordered_type PARAMS ((struct type *));
394
395 extern int
396 same_type PARAMS ((struct type *, struct type *));
397
398 extern int
399 integral_type PARAMS ((struct type *));
400
401 extern int
402 numeric_type PARAMS ((struct type *));
403
404 extern int
405 character_type PARAMS ((struct type *));
406
407 extern int
408 boolean_type PARAMS ((struct type *));
409
410 extern int
411 float_type PARAMS ((struct type *));
412
413 extern int
414 pointer_type PARAMS ((struct type *));
415
416 extern int
417 structured_type PARAMS ((struct type *));
418
419 /* Checks Binary and Unary operations for semantic type correctness */
420 /* FIXME:  Does not appear to be used */
421 #define unop_type_check(v,o) binop_type_check((v),NULL,(o))
422
423 extern void
424 binop_type_check PARAMS ((struct value *, struct value *, int));
425
426 /* Error messages */
427
428 extern void
429 op_error PARAMS ((char *fmt, enum exp_opcode, int));
430
431 #define type_op_error(f,o) \
432    op_error((f),(o),type_check==type_check_on ? 1 : 0)
433 #define range_op_error(f,o) \
434    op_error((f),(o),range_check==range_check_on ? 1 : 0)
435
436 extern void
437   type_error
438 PARAMS ((char *,...))
439 ATTR_FORMAT (printf, 1, 2);
440
441      void
442      range_error PARAMS ((char *,...))
443   ATTR_FORMAT (printf, 1, 2);
444
445 /* Data:  Does this value represent "truth" to the current language?  */
446
447      extern int
448      value_true PARAMS ((struct value *));
449
450      extern struct type *lang_bool_type PARAMS ((void));
451
452 /* The type used for Boolean values in the current language. */
453 #define LA_BOOL_TYPE lang_bool_type ()
454
455 /* Misc:  The string representing a particular enum language.  */
456
457      extern enum language language_enum PARAMS ((char *str));
458
459      extern const struct language_defn *language_def PARAMS ((enum language));
460
461      extern char *language_str PARAMS ((enum language));
462
463 /* Add a language to the set known by GDB (at initialization time).  */
464
465      extern void
466      add_language PARAMS ((const struct language_defn *));
467
468      extern enum language
469      get_frame_language PARAMS ((void));        /* In stack.c */
470
471 #endif /* defined (LANGUAGE_H) */