contrib/gdb/gdb/language.h

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