gdb/language.h

   1 /* Source-language-related definitions for GDB.
   2
   3    Copyright (C) 1991, 1992, 1993, 1994, 1995, 1998, 1999, 2000, 2003, 2004,
   4    2007 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 3 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, see <http://www.gnu.org/licenses/>.  */
  23
  24 #if !defined (LANGUAGE_H)
  25 #define LANGUAGE_H 1
  26
  27 /* Forward decls for prototypes */
  28 struct value;
  29 struct objfile;
  30 struct frame_info;
  31 struct expression;
  32 struct ui_file;
  33 enum exp_opcode;
  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 /* array_ordering ==
  98    array_row_major:     Arrays are in row major order
  99    array_column_major:  Arrays are in column major order.*/
 100
 101 extern enum array_ordering
 102   {
 103     array_row_major, array_column_major
 104   }
 105 array_ordering;
 106
 107
 108 /* case_sensitivity ==
 109    case_sensitive_on:   Case sensitivity in name matching is used
 110    case_sensitive_off:  Case sensitivity in name matching is not used  */
 111
 112 extern enum case_sensitivity
 113   {
 114     case_sensitive_on, case_sensitive_off
 115   }
 116 case_sensitivity;
 117 \f
 118 /* Per architecture (OS/ABI) language information.  */
 119
 120 struct language_arch_info
 121 {
 122   /* Its primitive types.  This is a vector ended by a NULL pointer.
 123      These types can be specified by name in parsing types in
 124      expressions, regardless of whether the program being debugged
 125      actually defines such a type.  */
 126   struct type **primitive_type_vector;
 127   /* Type of elements of strings. */
 128   struct type *string_char_type;
 129 };
 130
 131 /* Structure tying together assorted information about a language.  */
 132
 133 struct language_defn
 134   {
 135     /* Name of the language */
 136
 137     char *la_name;
 138
 139     /* its symtab language-enum (defs.h) */
 140
 141     enum language la_language;
 142
 143     /* Default range checking */
 144
 145     enum range_check la_range_check;
 146
 147     /* Default type checking */
 148
 149     enum type_check la_type_check;
 150
 151     /* Default case sensitivity */
 152     enum case_sensitivity la_case_sensitivity;
 153
 154     /* Multi-dimensional array ordering */
 155     enum array_ordering la_array_ordering;
 156
 157     /* Definitions related to expression printing, prefixifying, and
 158        dumping */
 159
 160     const struct exp_descriptor *la_exp_desc;
 161
 162     /* Parser function. */
 163
 164     int (*la_parser) (void);
 165
 166     /* Parser error function */
 167
 168     void (*la_error) (char *);
 169
 170     /* Given an expression *EXPP created by prefixifying the result of
 171        la_parser, perform any remaining processing necessary to complete
 172        its translation.  *EXPP may change; la_post_parser is responsible
 173        for releasing its previous contents, if necessary.  If
 174        VOID_CONTEXT_P, then no value is expected from the expression.  */
 175
 176     void (*la_post_parser) (struct expression ** expp, int void_context_p);
 177
 178     void (*la_printchar) (int ch, struct ui_file * stream);
 179
 180     void (*la_printstr) (struct ui_file * stream, const gdb_byte *string,
 181                          unsigned int length, int width,
 182                          int force_ellipses);
 183
 184     void (*la_emitchar) (int ch, struct ui_file * stream, int quoter);
 185
 186     /* Print a type using syntax appropriate for this language. */
 187
 188     void (*la_print_type) (struct type *, char *, struct ui_file *, int,
 189                            int);
 190
 191     /* Print a value using syntax appropriate for this language. */
 192
 193     int (*la_val_print) (struct type *, const gdb_byte *, int, CORE_ADDR,
 194                          struct ui_file *, int, int, int,
 195                          enum val_prettyprint);
 196
 197     /* Print a top-level value using syntax appropriate for this language. */
 198
 199     int (*la_value_print) (struct value *, struct ui_file *,
 200                            int, enum val_prettyprint);
 201
 202     /* PC is possibly an unknown languages trampoline.
 203        If that PC falls in a trampoline belonging to this language,
 204        return the address of the first pc in the real function, or 0
 205        if it isn't a language tramp for this language.  */
 206     CORE_ADDR (*skip_trampoline) (struct frame_info *, CORE_ADDR);
 207
 208     /* Now come some hooks for lookup_symbol.  */
 209
 210     /* If this is non-NULL, lookup_symbol will do the 'field_of_this'
 211        check, using this function to find the value of this.  */
 212
 213     /* FIXME: carlton/2003-05-19: Audit all the language_defn structs
 214        to make sure we're setting this appropriately: I'm sure it
 215        could be NULL in more languages.  */
 216
 217     struct value *(*la_value_of_this) (int complain);
 218
 219     /* This is a function that lookup_symbol will call when it gets to
 220        the part of symbol lookup where C looks up static and global
 221        variables.  */
 222
 223     struct symbol *(*la_lookup_symbol_nonlocal) (const char *,
 224                                                  const char *,
 225                                                  const struct block *,
 226                                                  const domain_enum,
 227                                                  struct symtab **);
 228
 229     /* Find the definition of the type with the given name.  */
 230     struct type *(*la_lookup_transparent_type) (const char *);
 231
 232     /* Return demangled language symbol, or NULL.  */
 233     char *(*la_demangle) (const char *mangled, int options);
 234
 235     /* Return class name of a mangled method name or NULL.  */
 236     char *(*la_class_name_from_physname) (const char *physname);
 237
 238     /* Table for printing expressions */
 239
 240     const struct op_print *la_op_print_tab;
 241
 242     /* Zero if the language has first-class arrays.  True if there are no
 243        array values, and array objects decay to pointers, as in C. */
 244
 245     char c_style_arrays;
 246
 247     /* Index to use for extracting the first element of a string. */
 248     char string_lower_bound;
 249
 250     /* The list of characters forming word boundaries.  */
 251     char *(*la_word_break_characters) (void);
 252
 253     /* The per-architecture (OS/ABI) language information.  */
 254     void (*la_language_arch_info) (struct gdbarch *,
 255                                    struct language_arch_info *);
 256
 257     /* Print the index of an element of an array.  */
 258     void (*la_print_array_index) (struct value *index_value,
 259                                   struct ui_file *stream,
 260                                   int format,
 261                                   enum val_prettyprint pretty);
 262
 263     /* Return non-zero if TYPE should be passed (and returned) by
 264        reference at the language level.  */
 265     int (*la_pass_by_reference) (struct type *type);
 266
 267     /* Add fields above this point, so the magic number is always last. */
 268     /* Magic number for compat checking */
 269
 270     long la_magic;
 271
 272   };
 273
 274 #define LANG_MAGIC      910823L
 275
 276 /* Pointer to the language_defn for our current language.  This pointer
 277    always points to *some* valid struct; it can be used without checking
 278    it for validity.
 279
 280    The current language affects expression parsing and evaluation
 281    (FIXME: it might be cleaner to make the evaluation-related stuff
 282    separate exp_opcodes for each different set of semantics.  We
 283    should at least think this through more clearly with respect to
 284    what happens if the language is changed between parsing and
 285    evaluation) and printing of things like types and arrays.  It does
 286    *not* affect symbol-reading-- each source file in a symbol-file has
 287    its own language and we should keep track of that regardless of the
 288    language when symbols are read.  If we want some manual setting for
 289    the language of symbol files (e.g. detecting when ".c" files are
 290    C++), it should be a separate setting from the current_language.  */
 291
 292 extern const struct language_defn *current_language;
 293
 294 /* Pointer to the language_defn expected by the user, e.g. the language
 295    of main(), or the language we last mentioned in a message, or C.  */
 296
 297 extern const struct language_defn *expected_language;
 298
 299 /* language_mode ==
 300    language_mode_auto:   current_language automatically set upon selection
 301    of scope (e.g. stack frame)
 302    language_mode_manual: current_language set only by user.  */
 303
 304 extern enum language_mode
 305   {
 306     language_mode_auto, language_mode_manual
 307   }
 308 language_mode;
 309
 310 struct type *language_string_char_type (const struct language_defn *l,
 311                                         struct gdbarch *gdbarch);
 312
 313 struct type *language_lookup_primitive_type_by_name (const struct language_defn *l,
 314                                                      struct gdbarch *gdbarch,
 315                                                      const char *name);
 316
 317 \f
 318 /* These macros define the behaviour of the expression
 319    evaluator.  */
 320
 321 /* Should we strictly type check expressions? */
 322 #define STRICT_TYPE (type_check != type_check_off)
 323
 324 /* Should we range check values against the domain of their type? */
 325 #define RANGE_CHECK (range_check != range_check_off)
 326
 327 /* "cast" really means conversion */
 328 /* FIXME -- should be a setting in language_defn */
 329 #define CAST_IS_CONVERSION (current_language->la_language == language_c  || \
 330                             current_language->la_language == language_cplus || \
 331                             current_language->la_language == language_objc)
 332
 333 extern void language_info (int);
 334
 335 extern enum language set_language (enum language);
 336 \f
 337
 338 /* This page contains functions that return things that are
 339    specific to languages.  Each of these functions is based on
 340    the current setting of working_lang, which the user sets
 341    with the "set language" command. */
 342
 343 #define LA_PRINT_TYPE(type,varstring,stream,show,level) \
 344   (current_language->la_print_type(type,varstring,stream,show,level))
 345
 346 #define LA_VAL_PRINT(type,valaddr,offset,addr,stream,fmt,deref,recurse,pretty) \
 347   (current_language->la_val_print(type,valaddr,offset,addr,stream,fmt,deref, \
 348                                   recurse,pretty))
 349 #define LA_VALUE_PRINT(val,stream,fmt,pretty) \
 350   (current_language->la_value_print(val,stream,fmt,pretty))
 351
 352 #define LA_PRINT_CHAR(ch, stream) \
 353   (current_language->la_printchar(ch, stream))
 354 #define LA_PRINT_STRING(stream, string, length, width, force_ellipses) \
 355   (current_language->la_printstr(stream, string, length, width, force_ellipses))
 356 #define LA_EMIT_CHAR(ch, stream, quoter) \
 357   (current_language->la_emitchar(ch, stream, quoter))
 358
 359 #define LA_PRINT_ARRAY_INDEX(index_value, stream, format, pretty) \
 360   (current_language->la_print_array_index(index_value, stream, format, pretty))
 361
 362 /* Test a character to decide whether it can be printed in literal form
 363    or needs to be printed in another representation.  For example,
 364    in C the literal form of the character with octal value 141 is 'a'
 365    and the "other representation" is '\141'.  The "other representation"
 366    is program language dependent. */
 367
 368 #define PRINT_LITERAL_FORM(c)           \
 369   ((c) >= 0x20                          \
 370    && ((c) < 0x7F || (c) >= 0xA0)       \
 371    && (!sevenbit_strings || (c) < 0x80))
 372
 373 #if 0
 374 /* FIXME: cagney/2000-03-04: This function does not appear to be used.
 375    It can be deleted once 5.0 has been released. */
 376 /* Return a string that contains the hex digits of the number.  No preceeding
 377    "0x" */
 378
 379 extern char *longest_raw_hex_string (LONGEST);
 380 #endif
 381
 382 /* Type predicates */
 383
 384 extern int simple_type (struct type *);
 385
 386 extern int ordered_type (struct type *);
 387
 388 extern int same_type (struct type *, struct type *);
 389
 390 extern int integral_type (struct type *);
 391
 392 extern int numeric_type (struct type *);
 393
 394 extern int character_type (struct type *);
 395
 396 extern int boolean_type (struct type *);
 397
 398 extern int float_type (struct type *);
 399
 400 extern int pointer_type (struct type *);
 401
 402 extern int structured_type (struct type *);
 403
 404 /* Checks Binary and Unary operations for semantic type correctness */
 405 /* FIXME:  Does not appear to be used */
 406 #define unop_type_check(v,o) binop_type_check((v),NULL,(o))
 407
 408 extern void binop_type_check (struct value *, struct value *, int);
 409
 410 /* Error messages */
 411
 412 extern void op_error (const char *lhs, enum exp_opcode,
 413                       const char *rhs);
 414
 415 extern void type_error (const char *, ...) ATTR_FORMAT (printf, 1, 2);
 416
 417 extern void range_error (const char *, ...) ATTR_FORMAT (printf, 1, 2);
 418
 419 /* Data:  Does this value represent "truth" to the current language?  */
 420
 421 extern int value_true (struct value *);
 422
 423 extern struct type *lang_bool_type (void);
 424
 425 /* The type used for Boolean values in the current language. */
 426 #define LA_BOOL_TYPE lang_bool_type ()
 427
 428 /* Misc:  The string representing a particular enum language.  */
 429
 430 extern enum language language_enum (char *str);
 431
 432 extern const struct language_defn *language_def (enum language);
 433
 434 extern char *language_str (enum language);
 435
 436 /* Add a language to the set known by GDB (at initialization time).  */
 437
 438 extern void add_language (const struct language_defn *);
 439
 440 extern enum language get_frame_language (void); /* In stack.c */
 441
 442 /* Check for a language-specific trampoline. */
 443
 444 extern CORE_ADDR skip_language_trampoline (struct frame_info *, CORE_ADDR pc);
 445
 446 /* Return demangled language symbol, or NULL.  */
 447 extern char *language_demangle (const struct language_defn *current_language,
 448                                 const char *mangled, int options);
 449
 450 /* Return class name from physname, or NULL.  */
 451 extern char *language_class_name_from_physname (const struct language_defn *,
 452                                                 const char *physname);
 453
 454 /* Splitting strings into words.  */
 455 extern char *default_word_break_characters (void);
 456
 457 /* Print the index of an array element using the C99 syntax.  */
 458 extern void default_print_array_index (struct value *index_value,
 459                                        struct ui_file *stream,
 460                                        int format,
 461                                        enum val_prettyprint pretty);
 462
 463 /* Return non-zero if TYPE should be passed (and returned) by
 464    reference at the language level.  */
 465 int language_pass_by_reference (struct type *type);
 466
 467 /* Return zero; by default, types are passed by value at the language
 468    level.  The target ABI may pass or return some structs by reference
 469    independent of this.  */
 470 int default_pass_by_reference (struct type *type);
 471
 472 #endif /* defined (LANGUAGE_H) */