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