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     /* Given an expression *EXPP created by prefixifying the result of
 184        la_parser, perform any remaining processing necessary to complete
 185        its translation.  *EXPP may change; la_post_parser is responsible
 186        for releasing its previous contents, if necessary.  If
 187        VOID_CONTEXT_P, then no value is expected from the expression.  */
 188
 189     void (*la_post_parser) (struct expression ** expp, int void_context_p);
 190
 191     void (*la_printchar) (int ch, struct ui_file * stream);
 192
 193     void (*la_printstr) (struct ui_file * stream, char *string,
 194                          unsigned int length, int width,
 195                          int force_ellipses);
 196
 197     void (*la_emitchar) (int ch, struct ui_file * stream, int quoter);
 198
 199     struct type *(*la_fund_type) (struct objfile *, int);
 200
 201     /* Print a type using syntax appropriate for this language. */
 202
 203     void (*la_print_type) (struct type *, char *, struct ui_file *, int,
 204                            int);
 205
 206     /* Print a value using syntax appropriate for this language. */
 207
 208     int (*la_val_print) (struct type *, char *, int, CORE_ADDR,
 209                          struct ui_file *, int, int, int,
 210                          enum val_prettyprint);
 211
 212     /* Print a top-level value using syntax appropriate for this language. */
 213
 214     int (*la_value_print) (struct value *, struct ui_file *,
 215                            int, enum val_prettyprint);
 216
 217     /* PC is possibly an unknown languages trampoline.
 218        If that PC falls in a trampoline belonging to this language,
 219        return the address of the first pc in the real function, or 0
 220        if it isn't a language tramp for this language.  */
 221     CORE_ADDR (*skip_trampoline) (CORE_ADDR pc);
 222
 223     /* Now come some hooks for lookup_symbol.  */
 224
 225     /* If this is non-NULL, lookup_symbol will do the 'field_of_this'
 226        check, using this function to find the value of this.  */
 227
 228     /* FIXME: carlton/2003-05-19: Audit all the language_defn structs
 229        to make sure we're setting this appropriately: I'm sure it
 230        could be NULL in more languages.  */
 231
 232     struct value *(*la_value_of_this) (int complain);
 233
 234     /* This is a function that lookup_symbol will call when it gets to
 235        the part of symbol lookup where C looks up static and global
 236        variables.  */
 237
 238     struct symbol *(*la_lookup_symbol_nonlocal) (const char *,
 239                                                  const char *,
 240                                                  const struct block *,
 241                                                  const domain_enum,
 242                                                  struct symtab **);
 243
 244     /* Find the definition of the type with the given name.  */
 245     struct type *(*la_lookup_transparent_type) (const char *);
 246
 247     /* Return demangled language symbol, or NULL.  */
 248     char *(*la_demangle) (const char *mangled, int options);
 249
 250     /* Base 2 (binary) formats. */
 251
 252     struct language_format_info la_binary_format;
 253
 254     /* Base 8 (octal) formats. */
 255
 256     struct language_format_info la_octal_format;
 257
 258     /* Base 10 (decimal) formats */
 259
 260     struct language_format_info la_decimal_format;
 261
 262     /* Base 16 (hexadecimal) formats */
 263
 264     struct language_format_info la_hex_format;
 265
 266     /* Table for printing expressions */
 267
 268     const struct op_print *la_op_print_tab;
 269
 270     /* Zero if the language has first-class arrays.  True if there are no
 271        array values, and array objects decay to pointers, as in C. */
 272
 273     char c_style_arrays;
 274
 275     /* Index to use for extracting the first element of a string. */
 276     char string_lower_bound;
 277
 278     /* Type of elements of strings. */
 279     struct type **string_char_type;
 280
 281     /* The list of characters forming word boundaries.  */
 282     char *(*la_word_break_characters) (void);
 283
 284     /* Add fields above this point, so the magic number is always last. */
 285     /* Magic number for compat checking */
 286
 287     long la_magic;
 288
 289   };
 290
 291 #define LANG_MAGIC      910823L
 292
 293 /* Pointer to the language_defn for our current language.  This pointer
 294    always points to *some* valid struct; it can be used without checking
 295    it for validity.
 296
 297    The current language affects expression parsing and evaluation
 298    (FIXME: it might be cleaner to make the evaluation-related stuff
 299    separate exp_opcodes for each different set of semantics.  We
 300    should at least think this through more clearly with respect to
 301    what happens if the language is changed between parsing and
 302    evaluation) and printing of things like types and arrays.  It does
 303    *not* affect symbol-reading-- each source file in a symbol-file has
 304    its own language and we should keep track of that regardless of the
 305    language when symbols are read.  If we want some manual setting for
 306    the language of symbol files (e.g. detecting when ".c" files are
 307    C++), it should be a separate setting from the current_language.  */
 308
 309 extern const struct language_defn *current_language;
 310
 311 /* Pointer to the language_defn expected by the user, e.g. the language
 312    of main(), or the language we last mentioned in a message, or C.  */
 313
 314 extern const struct language_defn *expected_language;
 315
 316 /* language_mode ==
 317    language_mode_auto:   current_language automatically set upon selection
 318    of scope (e.g. stack frame)
 319    language_mode_manual: current_language set only by user.  */
 320
 321 extern enum language_mode
 322   {
 323     language_mode_auto, language_mode_manual
 324   }
 325 language_mode;
 326 \f
 327 /* These macros define the behaviour of the expression
 328    evaluator.  */
 329
 330 /* Should we strictly type check expressions? */
 331 #define STRICT_TYPE (type_check != type_check_off)
 332
 333 /* Should we range check values against the domain of their type? */
 334 #define RANGE_CHECK (range_check != range_check_off)
 335
 336 /* "cast" really means conversion */
 337 /* FIXME -- should be a setting in language_defn */
 338 #define CAST_IS_CONVERSION (current_language->la_language == language_c  || \
 339                             current_language->la_language == language_cplus || \
 340                             current_language->la_language == language_objc)
 341
 342 extern void language_info (int);
 343
 344 extern enum language set_language (enum language);
 345 \f
 346
 347 /* This page contains functions that return things that are
 348    specific to languages.  Each of these functions is based on
 349    the current setting of working_lang, which the user sets
 350    with the "set language" command. */
 351
 352 #define create_fundamental_type(objfile,typeid) \
 353   (current_language->la_fund_type(objfile, typeid))
 354
 355 #define LA_PRINT_TYPE(type,varstring,stream,show,level) \
 356   (current_language->la_print_type(type,varstring,stream,show,level))
 357
 358 #define LA_VAL_PRINT(type,valaddr,offset,addr,stream,fmt,deref,recurse,pretty) \
 359   (current_language->la_val_print(type,valaddr,offset,addr,stream,fmt,deref, \
 360                                   recurse,pretty))
 361 #define LA_VALUE_PRINT(val,stream,fmt,pretty) \
 362   (current_language->la_value_print(val,stream,fmt,pretty))
 363
 364 /* Return a format string for printf that will print a number in one of
 365    the local (language-specific) formats.  Result is static and is
 366    overwritten by the next call.  Takes printf options like "08" or "l"
 367    (to produce e.g. %08x or %lx).  */
 368
 369 #define local_binary_format() \
 370   (current_language->la_binary_format.la_format)
 371 #define local_binary_format_prefix() \
 372   (current_language->la_binary_format.la_format_prefix)
 373 #define local_binary_format_specifier() \
 374   (current_language->la_binary_format.la_format_specifier)
 375 #define local_binary_format_suffix() \
 376   (current_language->la_binary_format.la_format_suffix)
 377
 378 #define local_octal_format() \
 379   (current_language->la_octal_format.la_format)
 380 #define local_octal_format_prefix() \
 381   (current_language->la_octal_format.la_format_prefix)
 382 #define local_octal_format_specifier() \
 383   (current_language->la_octal_format.la_format_specifier)
 384 #define local_octal_format_suffix() \
 385   (current_language->la_octal_format.la_format_suffix)
 386
 387 #define local_decimal_format() \
 388   (current_language->la_decimal_format.la_format)
 389 #define local_decimal_format_prefix() \
 390   (current_language->la_decimal_format.la_format_prefix)
 391 #define local_decimal_format_specifier() \
 392   (current_language->la_decimal_format.la_format_specifier)
 393 #define local_decimal_format_suffix() \
 394   (current_language->la_decimal_format.la_format_suffix)
 395
 396 #define local_hex_format() \
 397   (current_language->la_hex_format.la_format)
 398 #define local_hex_format_prefix() \
 399   (current_language->la_hex_format.la_format_prefix)
 400 #define local_hex_format_specifier() \
 401   (current_language->la_hex_format.la_format_specifier)
 402 #define local_hex_format_suffix() \
 403   (current_language->la_hex_format.la_format_suffix)
 404
 405 #define LA_PRINT_CHAR(ch, stream) \
 406   (current_language->la_printchar(ch, stream))
 407 #define LA_PRINT_STRING(stream, string, length, width, force_ellipses) \
 408   (current_language->la_printstr(stream, string, length, width, force_ellipses))
 409 #define LA_EMIT_CHAR(ch, stream, quoter) \
 410   (current_language->la_emitchar(ch, stream, quoter))
 411
 412 /* Test a character to decide whether it can be printed in literal form
 413    or needs to be printed in another representation.  For example,
 414    in C the literal form of the character with octal value 141 is 'a'
 415    and the "other representation" is '\141'.  The "other representation"
 416    is program language dependent. */
 417
 418 #define PRINT_LITERAL_FORM(c)           \
 419   ((c) >= 0x20                          \
 420    && ((c) < 0x7F || (c) >= 0xA0)       \
 421    && (!sevenbit_strings || (c) < 0x80))
 422
 423 /* Return a format string for printf that will print a number in one of
 424    the local (language-specific) formats.  Result is static and is
 425    overwritten by the next call.  Takes printf options like "08" or "l"
 426    (to produce e.g. %08x or %lx).  */
 427
 428 extern char *local_decimal_format_custom (char *);      /* language.c */
 429
 430 extern char *local_octal_format_custom (char *);        /* language.c */
 431
 432 extern char *local_hex_format_custom (char *);  /* language.c */
 433
 434 #if 0
 435 /* FIXME: cagney/2000-03-04: This function does not appear to be used.
 436    It can be deleted once 5.0 has been released. */
 437 /* Return a string that contains the hex digits of the number.  No preceeding
 438    "0x" */
 439
 440 extern char *longest_raw_hex_string (LONGEST);
 441 #endif
 442
 443 /* Return a string that contains a number formatted in one of the local
 444    (language-specific) formats.  Result is static and is overwritten by
 445    the next call.  Takes printf options like "08l" or "l".  */
 446
 447 extern char *local_hex_string (LONGEST);        /* language.c */
 448
 449 extern char *local_hex_string_custom (LONGEST, char *); /* language.c */
 450
 451 /* Type predicates */
 452
 453 extern int simple_type (struct type *);
 454
 455 extern int ordered_type (struct type *);
 456
 457 extern int same_type (struct type *, struct type *);
 458
 459 extern int integral_type (struct type *);
 460
 461 extern int numeric_type (struct type *);
 462
 463 extern int character_type (struct type *);
 464
 465 extern int boolean_type (struct type *);
 466
 467 extern int float_type (struct type *);
 468
 469 extern int pointer_type (struct type *);
 470
 471 extern int structured_type (struct type *);
 472
 473 /* Checks Binary and Unary operations for semantic type correctness */
 474 /* FIXME:  Does not appear to be used */
 475 #define unop_type_check(v,o) binop_type_check((v),NULL,(o))
 476
 477 extern void binop_type_check (struct value *, struct value *, int);
 478
 479 /* Error messages */
 480
 481 extern void op_error (const char *lhs, enum exp_opcode,
 482                       const char *rhs);
 483
 484 extern void type_error (const char *, ...) ATTR_FORMAT (printf, 1, 2);
 485
 486 extern void range_error (const char *, ...) ATTR_FORMAT (printf, 1, 2);
 487
 488 /* Data:  Does this value represent "truth" to the current language?  */
 489
 490 extern int value_true (struct value *);
 491
 492 extern struct type *lang_bool_type (void);
 493
 494 /* The type used for Boolean values in the current language. */
 495 #define LA_BOOL_TYPE lang_bool_type ()
 496
 497 /* Misc:  The string representing a particular enum language.  */
 498
 499 extern enum language language_enum (char *str);
 500
 501 extern const struct language_defn *language_def (enum language);
 502
 503 extern char *language_str (enum language);
 504
 505 /* Add a language to the set known by GDB (at initialization time).  */
 506
 507 extern void add_language (const struct language_defn *);
 508
 509 extern enum language get_frame_language (void); /* In stack.c */
 510
 511 /* Check for a language-specific trampoline. */
 512
 513 extern CORE_ADDR skip_language_trampoline (CORE_ADDR pc);
 514
 515 /* Return demangled language symbol, or NULL.  */
 516 extern char *language_demangle (const struct language_defn *current_language,
 517                                 const char *mangled, int options);
 518
 519 /* Splitting strings into words.  */
 520 extern char *default_word_break_characters (void);
 521
 522 #endif /* defined (LANGUAGE_H) */