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