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