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