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
  34 /* enum exp_opcode;     ANSI's `wisdom' didn't include forward enum decls. */
  35
  36 /* This used to be included to configure GDB for one or more specific
  37    languages.  Now it is left out to configure for all of them.  FIXME.  */
  38 /* #include "lang_def.h" */
  39 #define _LANG_c
  40 #define _LANG_m2
  41 #define  _LANG_fortran
  42 #define  _LANG_pascal
  43
  44 #define MAX_FORTRAN_DIMS  7     /* Maximum number of F77 array dims */
  45
  46 /* range_mode ==
  47    range_mode_auto:   range_check set automatically to default of language.
  48    range_mode_manual: range_check set manually by user.  */
  49
  50 extern enum range_mode
  51   {
  52     range_mode_auto, range_mode_manual
  53   }
  54 range_mode;
  55
  56 /* range_check ==
  57    range_check_on:    Ranges are checked in GDB expressions, producing errors.
  58    range_check_warn:  Ranges are checked, producing warnings.
  59    range_check_off:   Ranges are not checked in GDB expressions.  */
  60
  61 extern enum range_check
  62   {
  63     range_check_off, range_check_warn, range_check_on
  64   }
  65 range_check;
  66
  67 /* type_mode ==
  68    type_mode_auto:   type_check set automatically to default of language
  69    type_mode_manual: type_check set manually by user. */
  70
  71 extern enum type_mode
  72   {
  73     type_mode_auto, type_mode_manual
  74   }
  75 type_mode;
  76
  77 /* type_check ==
  78    type_check_on:    Types are checked in GDB expressions, producing errors.
  79    type_check_warn:  Types are checked, producing warnings.
  80    type_check_off:   Types are not checked in GDB expressions.  */
  81
  82 extern enum type_check
  83   {
  84     type_check_off, type_check_warn, type_check_on
  85   }
  86 type_check;
  87
  88 /* case_mode ==
  89    case_mode_auto:   case_sensitivity set upon selection of scope
  90    case_mode_manual: case_sensitivity set only by user.  */
  91
  92 extern enum case_mode
  93   {
  94     case_mode_auto, case_mode_manual
  95   }
  96 case_mode;
  97
  98 /* array_ordering ==
  99    array_row_major:     Arrays are in row major order
 100    array_column_major:  Arrays are in column major order.*/
 101
 102 extern enum array_ordering
 103   {
 104     array_row_major, array_column_major
 105   }
 106 array_ordering;
 107
 108
 109 /* case_sensitivity ==
 110    case_sensitive_on:   Case sensitivity in name matching is used
 111    case_sensitive_off:  Case sensitivity in name matching is not used  */
 112
 113 extern enum case_sensitivity
 114   {
 115     case_sensitive_on, case_sensitive_off
 116   }
 117 case_sensitivity;
 118 \f
 119 /* Per architecture (OS/ABI) language information.  */
 120
 121 struct language_arch_info
 122 {
 123   /* Its primitive types.  This is a vector ended by a NULL pointer.
 124      These types can be specified by name in parsing types in
 125      expressions, regardless of whether the program being debugged
 126      actually defines such a type.  */
 127   struct type **primitive_type_vector;
 128   /* Type of elements of strings. */
 129   struct type *string_char_type;
 130 };
 131
 132 struct type *language_string_char_type (const struct language_defn *l,
 133                                         struct gdbarch *gdbarch);
 134
 135 struct type *language_lookup_primitive_type_by_name (const struct language_defn *l,
 136                                                      struct gdbarch *gdbarch,
 137                                                      const char *name);
 138
 139 /* Structure tying together assorted information about a language.  */
 140
 141 struct language_defn
 142   {
 143     /* Name of the language */
 144
 145     char *la_name;
 146
 147     /* its symtab language-enum (defs.h) */
 148
 149     enum language la_language;
 150
 151     /* Its builtin types.  This is a vector ended by a NULL pointer.  These
 152        types can be specified by name in parsing types in expressions,
 153        regardless of whether the program being debugged actually defines
 154        such a type.  */
 155
 156     struct type **const *la_builtin_type_vector;
 157
 158     /* Default range checking */
 159
 160     enum range_check la_range_check;
 161
 162     /* Default type checking */
 163
 164     enum type_check la_type_check;
 165
 166     /* Default case sensitivity */
 167     enum case_sensitivity la_case_sensitivity;
 168
 169     /* Multi-dimensional array ordering */
 170     enum array_ordering la_array_ordering;
 171
 172     /* Definitions related to expression printing, prefixifying, and
 173        dumping */
 174
 175     const struct exp_descriptor *la_exp_desc;
 176
 177     /* Parser function. */
 178
 179     int (*la_parser) (void);
 180
 181     /* Parser error function */
 182
 183     void (*la_error) (char *);
 184
 185     /* Given an expression *EXPP created by prefixifying the result of
 186        la_parser, perform any remaining processing necessary to complete
 187        its translation.  *EXPP may change; la_post_parser is responsible
 188        for releasing its previous contents, if necessary.  If
 189        VOID_CONTEXT_P, then no value is expected from the expression.  */
 190
 191     void (*la_post_parser) (struct expression ** expp, int void_context_p);
 192
 193     void (*la_printchar) (int ch, struct ui_file * stream);
 194
 195     void (*la_printstr) (struct ui_file * stream, const gdb_byte *string,
 196                          unsigned int length, int width,
 197                          int force_ellipses);
 198
 199     void (*la_emitchar) (int ch, struct ui_file * stream, int quoter);
 200
 201     struct type *(*la_fund_type) (struct objfile *, int);
 202
 203     /* Print a type using syntax appropriate for this language. */
 204
 205     void (*la_print_type) (struct type *, char *, struct ui_file *, int,
 206                            int);
 207
 208     /* Print a value using syntax appropriate for this language. */
 209
 210     int (*la_val_print) (struct type *, const gdb_byte *, int, CORE_ADDR,
 211                          struct ui_file *, int, int, int,
 212                          enum val_prettyprint);
 213
 214     /* Print a top-level value using syntax appropriate for this language. */
 215
 216     int (*la_value_print) (struct value *, struct ui_file *,
 217                            int, enum val_prettyprint);
 218
 219     /* PC is possibly an unknown languages trampoline.
 220        If that PC falls in a trampoline belonging to this language,
 221        return the address of the first pc in the real function, or 0
 222        if it isn't a language tramp for this language.  */
 223     CORE_ADDR (*skip_trampoline) (struct frame_info *, CORE_ADDR);
 224
 225     /* Now come some hooks for lookup_symbol.  */
 226
 227     /* If this is non-NULL, lookup_symbol will do the 'field_of_this'
 228        check, using this function to find the value of this.  */
 229
 230     /* FIXME: carlton/2003-05-19: Audit all the language_defn structs
 231        to make sure we're setting this appropriately: I'm sure it
 232        could be NULL in more languages.  */
 233
 234     struct value *(*la_value_of_this) (int complain);
 235
 236     /* This is a function that lookup_symbol will call when it gets to
 237        the part of symbol lookup where C looks up static and global
 238        variables.  */
 239
 240     struct symbol *(*la_lookup_symbol_nonlocal) (const char *,
 241                                                  const char *,
 242                                                  const struct block *,
 243                                                  const domain_enum,
 244                                                  struct symtab **);
 245
 246     /* Find the definition of the type with the given name.  */
 247     struct type *(*la_lookup_transparent_type) (const char *);
 248
 249     /* Return demangled language symbol, or NULL.  */
 250     char *(*la_demangle) (const char *mangled, int options);
 251
 252     /* Return class name of a mangled method name or NULL.  */
 253     char *(*la_class_name_from_physname) (const char *physname);
 254
 255     /* Table for printing expressions */
 256
 257     const struct op_print *la_op_print_tab;
 258
 259     /* Zero if the language has first-class arrays.  True if there are no
 260        array values, and array objects decay to pointers, as in C. */
 261
 262     char c_style_arrays;
 263
 264     /* Index to use for extracting the first element of a string. */
 265     char string_lower_bound;
 266
 267     /* Type of elements of strings. */
 268     struct type **string_char_type;
 269
 270     /* The list of characters forming word boundaries.  */
 271     char *(*la_word_break_characters) (void);
 272
 273     /* The per-architecture (OS/ABI) language information.  */
 274     void (*la_language_arch_info) (struct gdbarch *,
 275                                    struct language_arch_info *);
 276
 277     /* Print the index of an element of an array.  */
 278     void (*la_print_array_index) (struct value *index_value,
 279                                   struct ui_file *stream,
 280                                   int format,
 281                                   enum val_prettyprint pretty);
 282
 283     /* Return non-zero if TYPE should be passed (and returned) by
 284        reference at the language level.  */
 285     int (*la_pass_by_reference) (struct type *type);
 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 #define LA_PRINT_CHAR(ch, stream) \
 368   (current_language->la_printchar(ch, stream))
 369 #define LA_PRINT_STRING(stream, string, length, width, force_ellipses) \
 370   (current_language->la_printstr(stream, string, length, width, force_ellipses))
 371 #define LA_EMIT_CHAR(ch, stream, quoter) \
 372   (current_language->la_emitchar(ch, stream, quoter))
 373
 374 #define LA_PRINT_ARRAY_INDEX(index_value, stream, format, pretty) \
 375   (current_language->la_print_array_index(index_value, stream, format, pretty))
 376
 377 /* Test a character to decide whether it can be printed in literal form
 378    or needs to be printed in another representation.  For example,
 379    in C the literal form of the character with octal value 141 is 'a'
 380    and the "other representation" is '\141'.  The "other representation"
 381    is program language dependent. */
 382
 383 #define PRINT_LITERAL_FORM(c)           \
 384   ((c) >= 0x20                          \
 385    && ((c) < 0x7F || (c) >= 0xA0)       \
 386    && (!sevenbit_strings || (c) < 0x80))
 387
 388 #if 0
 389 /* FIXME: cagney/2000-03-04: This function does not appear to be used.
 390    It can be deleted once 5.0 has been released. */
 391 /* Return a string that contains the hex digits of the number.  No preceeding
 392    "0x" */
 393
 394 extern char *longest_raw_hex_string (LONGEST);
 395 #endif
 396
 397 /* Type predicates */
 398
 399 extern int simple_type (struct type *);
 400
 401 extern int ordered_type (struct type *);
 402
 403 extern int same_type (struct type *, struct type *);
 404
 405 extern int integral_type (struct type *);
 406
 407 extern int numeric_type (struct type *);
 408
 409 extern int character_type (struct type *);
 410
 411 extern int boolean_type (struct type *);
 412
 413 extern int float_type (struct type *);
 414
 415 extern int pointer_type (struct type *);
 416
 417 extern int structured_type (struct type *);
 418
 419 /* Checks Binary and Unary operations for semantic type correctness */
 420 /* FIXME:  Does not appear to be used */
 421 #define unop_type_check(v,o) binop_type_check((v),NULL,(o))
 422
 423 extern void binop_type_check (struct value *, struct value *, int);
 424
 425 /* Error messages */
 426
 427 extern void op_error (const char *lhs, enum exp_opcode,
 428                       const char *rhs);
 429
 430 extern void type_error (const char *, ...) ATTR_FORMAT (printf, 1, 2);
 431
 432 extern void range_error (const char *, ...) ATTR_FORMAT (printf, 1, 2);
 433
 434 /* Data:  Does this value represent "truth" to the current language?  */
 435
 436 extern int value_true (struct value *);
 437
 438 extern struct type *lang_bool_type (void);
 439
 440 /* The type used for Boolean values in the current language. */
 441 #define LA_BOOL_TYPE lang_bool_type ()
 442
 443 /* Misc:  The string representing a particular enum language.  */
 444
 445 extern enum language language_enum (char *str);
 446
 447 extern const struct language_defn *language_def (enum language);
 448
 449 extern char *language_str (enum language);
 450
 451 /* Add a language to the set known by GDB (at initialization time).  */
 452
 453 extern void add_language (const struct language_defn *);
 454
 455 extern enum language get_frame_language (void); /* In stack.c */
 456
 457 /* Check for a language-specific trampoline. */
 458
 459 extern CORE_ADDR skip_language_trampoline (struct frame_info *, CORE_ADDR pc);
 460
 461 /* Return demangled language symbol, or NULL.  */
 462 extern char *language_demangle (const struct language_defn *current_language,
 463                                 const char *mangled, int options);
 464
 465 /* Return class name from physname, or NULL.  */
 466 extern char *language_class_name_from_physname (const struct language_defn *,
 467                                                 const char *physname);
 468
 469 /* Splitting strings into words.  */
 470 extern char *default_word_break_characters (void);
 471
 472 /* Print the index of an array element using the C99 syntax.  */
 473 extern void default_print_array_index (struct value *index_value,
 474                                        struct ui_file *stream,
 475                                        int format,
 476                                        enum val_prettyprint pretty);
 477
 478 /* Return non-zero if TYPE should be passed (and returned) by
 479    reference at the language level.  */
 480 int language_pass_by_reference (struct type *type);
 481
 482 /* Return zero; by default, types are passed by value at the language
 483    level.  The target ABI may pass or return some structs by reference
 484    independent of this.  */
 485 int default_pass_by_reference (struct type *type);
 486
 487 #endif /* defined (LANGUAGE_H) */