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