gdb/language.h

   1 /* Source-language-related definitions for GDB.
   2    Copyright 1991, 1992 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., 675 Mass Ave, Cambridge, MA 02139, USA.  */
  21
  22 #if !defined (LANGUAGE_H)
  23 #define LANGUAGE_H 1
  24
  25 #ifdef __STDC__         /* Forward decls for prototypes */
  26 struct value;
  27 struct objfile;
  28 /* enum exp_opcode;     ANSI's `wisdom' didn't include forward enum decls. */
  29 #endif
  30
  31 /* This used to be included to configure GDB for one or more specific
  32    languages.  Now it is shortcutted to configure for all of them.  FIXME.  */
  33 /* #include "lang_def.h" */
  34 #define _LANG_c
  35 #define _LANG_m2
  36 /* start-sanitize-chill */
  37 #define _LANG_chill
  38 /* end-sanitize-chill */
  39
  40 /* range_mode ==
  41    range_mode_auto:   range_check set automatically to default of language.
  42    range_mode_manual: range_check set manually by user.  */
  43
  44 extern enum range_mode {range_mode_auto, range_mode_manual} range_mode;
  45
  46 /* range_check ==
  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.  */
  50
  51 extern enum range_check
  52   {range_check_off, range_check_warn, range_check_on} range_check;
  53
  54 /* type_mode ==
  55    type_mode_auto:   type_check set automatically to default of language
  56    type_mode_manual: type_check set manually by user. */
  57
  58 extern enum type_mode {type_mode_auto, type_mode_manual} type_mode;
  59
  60 /* type_check ==
  61    type_check_on:    Types are checked in GDB expressions, producing errors.
  62    type_check_warn:  Types are checked, producing warnings.
  63    type_check_off:   Types are not checked in GDB expressions.  */
  64
  65 extern enum type_check
  66   {type_check_off, type_check_warn, type_check_on} type_check;
  67 \f
  68 /* Information for doing language dependent formatting of printed values. */
  69
  70 struct language_format_info
  71 {
  72   /* The format that can be passed directly to standard C printf functions
  73      to generate a completely formatted value in the format appropriate for
  74      the language. */
  75
  76   char *la_format;
  77
  78   /* The prefix to be used when directly printing a value, or constructing
  79      a standard C printf format.  This generally is everything up to the
  80      conversion specification (the part introduced by the '%' character
  81      and terminated by the conversion specifier character). */
  82
  83   char *la_format_prefix;
  84
  85   /* The conversion specifier.  This is generally everything after the
  86      field width and precision, typically only a single character such
  87      as 'o' for octal format or 'x' for hexadecimal format. */
  88
  89   char *la_format_specifier;
  90
  91   /* The suffix to be used when directly printing a value, or constructing
  92      a standard C printf format.  This generally is everything after the
  93      conversion specification (the part introduced by the '%' character
  94      and terminated by the conversion specifier character). */
  95
  96   char *la_format_suffix;               /* Suffix for custom format string */
  97 };
  98
  99 /* Structure tying together assorted information about a language.  */
 100
 101 struct language_defn
 102 {
 103   /* Name of the language */
 104
 105   char *la_name;
 106
 107   /* its symtab language-enum (defs.h) */
 108
 109   enum language la_language;
 110
 111   /* Its builtin types */
 112
 113   struct type ** const *la_builtin_type_vector;
 114
 115   /* Default range checking */
 116
 117   enum range_check la_range_check;
 118
 119   /* Default type checking */
 120
 121   enum type_check la_type_check;
 122
 123   /* Parser function. */
 124
 125   int (*la_parser) PARAMS((void));
 126
 127   /* Parser error function */
 128
 129   void (*la_error) PARAMS ((char *));
 130
 131   void (*la_printchar) PARAMS ((int, FILE *));
 132
 133   void (*la_printstr) PARAMS ((FILE *, char *, unsigned int, int));
 134
 135   struct type *(*la_fund_type) PARAMS ((struct objfile *, int));
 136
 137   /* Print a type using syntax appropriate for this language. */
 138
 139   void (*la_print_type) PARAMS ((struct type *, char *, FILE *, int, int));
 140
 141   /* Print a value using syntax appropriate for this language. */
 142
 143   int (*la_val_print) PARAMS ((struct type *, char *,  CORE_ADDR, FILE *,
 144                                int, int, int, enum val_prettyprint));
 145
 146   /* Longest signed integral type */
 147
 148   struct type **la_longest_int;
 149
 150   /* Longest unsigned integral type */
 151
 152   struct type **la_longest_unsigned_int;
 153
 154   /* Longest floating point type */
 155
 156   struct type **la_longest_float;
 157
 158   /* Base 2 (binary) formats. */
 159
 160   struct language_format_info la_binary_format;
 161
 162   /* Base 8 (octal) formats. */
 163
 164   struct language_format_info la_octal_format;
 165
 166   /* Base 10 (decimal) formats */
 167
 168   struct language_format_info la_decimal_format;
 169
 170   /* Base 16 (hexadecimal) formats */
 171
 172   struct language_format_info la_hex_format;
 173
 174
 175   /* Table for printing expressions */
 176
 177   const struct op_print *la_op_print_tab;
 178
 179   /* Add fields above this point, so the magic number is always last. */
 180   /* Magic number for compat checking */
 181
 182   long la_magic;
 183
 184 };
 185
 186 #define LANG_MAGIC      910823L
 187
 188 /* Pointer to the language_defn for our current language.  This pointer
 189    always points to *some* valid struct; it can be used without checking
 190    it for validity.  */
 191
 192 extern const struct language_defn *current_language;
 193
 194 /* Pointer to the language_defn expected by the user, e.g. the language
 195    of main(), or the language we last mentioned in a message, or C.  */
 196
 197 extern const struct language_defn *expected_language;
 198
 199 /* language_mode ==
 200    language_mode_auto:   current_language automatically set upon selection
 201                          of scope (e.g. stack frame)
 202    language_mode_manual: current_language set only by user.  */
 203
 204 extern enum language_mode
 205   {language_mode_auto, language_mode_manual} language_mode;
 206 \f
 207 /* These macros define the behaviour of the expression
 208    evaluator.  */
 209
 210 /* Should we strictly type check expressions? */
 211 #define STRICT_TYPE (type_check != type_check_off)
 212
 213 /* Should we range check values against the domain of their type? */
 214 #define RANGE_CHECK (range_check != range_check_off)
 215
 216 /* "cast" really means conversion */
 217 /* FIXME -- should be a setting in language_defn */
 218 #define CAST_IS_CONVERSION (current_language->la_language == language_c)
 219
 220 extern void
 221 language_info PARAMS ((int));
 222
 223 extern void
 224 set_language PARAMS ((enum language));
 225
 226 \f
 227 /* This page contains functions that return things that are
 228    specific to languages.  Each of these functions is based on
 229    the current setting of working_lang, which the user sets
 230    with the "set language" command. */
 231
 232 /* Returns some built-in types */
 233 #define longest_int()           (*current_language->la_longest_int)
 234 #define longest_unsigned_int()  (*current_language->la_longest_unsigned_int)
 235 #define longest_float()         (*current_language->la_longest_float)
 236
 237 #define create_fundamental_type(objfile,typeid) \
 238   (current_language->la_fund_type(objfile, typeid))
 239
 240 #define LA_PRINT_TYPE(type,varstring,stream,show,level) \
 241   (current_language->la_print_type(type,varstring,stream,show,level))
 242
 243 #define LA_VAL_PRINT(type,valaddr,addr,stream,fmt,deref,recurse,pretty) \
 244   (current_language->la_val_print(type,valaddr,addr,stream,fmt,deref, \
 245                                   recurse,pretty))
 246
 247 /* Return a format string for printf that will print a number in one of
 248    the local (language-specific) formats.  Result is static and is
 249    overwritten by the next call.  Takes printf options like "08" or "l"
 250    (to produce e.g. %08x or %lx).  */
 251
 252 #define local_binary_format() \
 253   (current_language->la_binary_format.la_format)
 254 #define local_binary_format_prefix() \
 255   (current_language->la_binary_format.la_format_prefix)
 256 #define local_binary_format_specifier() \
 257   (current_language->la_binary_format.la_format_specifier)
 258 #define local_binary_format_suffix() \
 259   (current_language->la_binary_format.la_format_suffix)
 260
 261 #define local_octal_format() \
 262   (current_language->la_octal_format.la_format)
 263 #define local_octal_format_prefix() \
 264   (current_language->la_octal_format.la_format_prefix)
 265 #define local_octal_format_specifier() \
 266   (current_language->la_octal_format.la_format_specifier)
 267 #define local_octal_format_suffix() \
 268   (current_language->la_octal_format.la_format_suffix)
 269
 270 #define local_decimal_format() \
 271   (current_language->la_decimal_format.la_format)
 272 #define local_decimal_format_prefix() \
 273   (current_language->la_decimal_format.la_format_prefix)
 274 #define local_decimal_format_specifier() \
 275   (current_language->la_decimal_format.la_format_specifier)
 276 #define local_decimal_format_suffix() \
 277   (current_language->la_decimal_format.la_format_suffix)
 278
 279 #define local_hex_format() \
 280   (current_language->la_hex_format.la_format)
 281 #define local_hex_format_prefix() \
 282   (current_language->la_hex_format.la_format_prefix)
 283 #define local_hex_format_specifier() \
 284   (current_language->la_hex_format.la_format_specifier)
 285 #define local_hex_format_suffix() \
 286   (current_language->la_hex_format.la_format_suffix)
 287
 288 #define LA_PRINT_CHAR(ch, stream) \
 289   (current_language->la_printchar(ch, stream))
 290 #define LA_PRINT_STRING(stream, string, length, force_ellipses) \
 291   (current_language->la_printstr(stream, string, length, force_ellipses))
 292
 293 /* Test a character to decide whether it can be printed in literal form
 294    or needs to be printed in another representation.  For example,
 295    in C the literal form of the character with octal value 141 is 'a'
 296    and the "other representation" is '\141'.  The "other representation"
 297    is program language dependent. */
 298
 299 #define PRINT_LITERAL_FORM(c) \
 300   ((c)>=0x20 && ((c)<0x7F || (c)>=0xA0) && (!sevenbit_strings || (c)<0x80))
 301
 302 /* Return a format string for printf that will print a number in one of
 303    the local (language-specific) formats.  Result is static and is
 304    overwritten by the next call.  Takes printf options like "08" or "l"
 305    (to produce e.g. %08x or %lx).  */
 306
 307 extern char *
 308 local_decimal_format_custom PARAMS ((char *));  /* language.c */
 309
 310 extern char *
 311 local_octal_format_custom PARAMS ((char *));    /* language.c */
 312
 313 extern char *
 314 local_hex_format_custom PARAMS ((char *));      /* language.c */
 315
 316 /* Return a string that contains a number formatted in one of the local
 317    (language-specific) formats.  Result is static and is overwritten by
 318    the next call.  Takes printf options like "08" or "l".  */
 319
 320 extern char *
 321 local_octal_string PARAMS ((int));              /* language.c */
 322
 323 extern char *
 324 local_octal_string_custom PARAMS ((int, char *));/* language.c */
 325
 326 extern char *
 327 local_hex_string PARAMS ((int));                /* language.c */
 328
 329 extern char *
 330 local_hex_string_custom PARAMS ((int, char *)); /* language.c */
 331
 332 /* Type predicates */
 333
 334 extern int
 335 simple_type PARAMS ((struct type *));
 336
 337 extern int
 338 ordered_type PARAMS ((struct type *));
 339
 340 extern int
 341 same_type PARAMS ((struct type *, struct type *));
 342
 343 extern int
 344 integral_type PARAMS ((struct type *));
 345
 346 extern int
 347 numeric_type PARAMS ((struct type *));
 348
 349 extern int
 350 character_type PARAMS ((struct type *));
 351
 352 extern int
 353 boolean_type PARAMS ((struct type *));
 354
 355 extern int
 356 float_type PARAMS ((struct type *));
 357
 358 extern int
 359 pointer_type PARAMS ((struct type *));
 360
 361 extern int
 362 structured_type PARAMS ((struct type *));
 363
 364 /* Checks Binary and Unary operations for semantic type correctness */
 365 /* FIXME:  Does not appear to be used */
 366 #define unop_type_check(v,o) binop_type_check((v),NULL,(o))
 367
 368 extern void
 369 binop_type_check PARAMS ((struct value *, struct value *, int));
 370
 371 /* Error messages */
 372
 373 extern void
 374 op_error PARAMS ((char *fmt, enum exp_opcode, int));
 375
 376 #define type_op_error(f,o) \
 377    op_error((f),(o),type_check==type_check_on ? 1 : 0)
 378 #define range_op_error(f,o) \
 379    op_error((f),(o),range_check==range_check_on ? 1 : 0)
 380
 381 extern void
 382 type_error ();
 383
 384 void
 385 range_error ();
 386
 387 /* Data:  Does this value represent "truth" to the current language?  */
 388
 389 extern int
 390 value_true PARAMS ((struct value *));
 391
 392 /* Misc:  The string representing a particular enum language.  */
 393
 394 extern const struct language_defn *
 395 language_def PARAMS ((enum language));
 396
 397 extern char *
 398 language_str PARAMS ((enum language));
 399
 400 /* Add a language to the set known by GDB (at initialization time).  */
 401
 402 extern void
 403 add_language PARAMS ((const struct language_defn *));
 404
 405 extern enum language
 406 get_frame_language PARAMS ((void));             /* In stack.c */
 407
 408 #endif  /* defined (LANGUAGE_H) */