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