gdb/language.h

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