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 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                          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     int (*la_val_print) (struct type *, const gdb_byte *, int, CORE_ADDR,
 214                          struct ui_file *, int,
 215                          const struct value_print_options *);
 216
 217     /* Print a top-level value using syntax appropriate for this language. */
 218
 219     int (*la_value_print) (struct value *, struct ui_file *,
 220                            const struct value_print_options *);
 221
 222     /* PC is possibly an unknown languages trampoline.
 223        If that PC falls in a trampoline belonging to this language,
 224        return the address of the first pc in the real function, or 0
 225        if it isn't a language tramp for this language.  */
 226     CORE_ADDR (*skip_trampoline) (struct frame_info *, CORE_ADDR);
 227
 228     /* Now come some hooks for lookup_symbol.  */
 229
 230     /* If this is non-NULL, specifies the name that of the implicit
 231        local variable that refers to the current object instance.  */
 232
 233     char *la_name_of_this;
 234
 235     /* This is a function that lookup_symbol will call when it gets to
 236        the part of symbol lookup where C looks up static and global
 237        variables.  */
 238
 239     struct symbol *(*la_lookup_symbol_nonlocal) (const char *,
 240                                                  const char *,
 241                                                  const struct block *,
 242                                                  const domain_enum);
 243
 244     /* Find the definition of the type with the given name.  */
 245     struct type *(*la_lookup_transparent_type) (const char *);
 246
 247     /* Return demangled language symbol, or NULL.  */
 248     char *(*la_demangle) (const char *mangled, int options);
 249
 250     /* Return class name of a mangled method name or NULL.  */
 251     char *(*la_class_name_from_physname) (const char *physname);
 252
 253     /* Table for printing expressions */
 254
 255     const struct op_print *la_op_print_tab;
 256
 257     /* Zero if the language has first-class arrays.  True if there are no
 258        array values, and array objects decay to pointers, as in C. */
 259
 260     char c_style_arrays;
 261
 262     /* Index to use for extracting the first element of a string. */
 263     char string_lower_bound;
 264
 265     /* The list of characters forming word boundaries.  */
 266     char *(*la_word_break_characters) (void);
 267
 268     /* Should return a NULL terminated array of all symbols which
 269        are possible completions for TEXT.  WORD is the entire command
 270        on which the completion is being made.  */
 271     char **(*la_make_symbol_completion_list) (char *text, char *word);
 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                                   const struct value_print_options *options);
 281
 282     /* Return non-zero if TYPE should be passed (and returned) by
 283        reference at the language level.  */
 284     int (*la_pass_by_reference) (struct type *type);
 285
 286     /* Obtain a string from the inferior, storing it in a newly allocated
 287        buffer in BUFFER, which should be freed by the caller.  If the
 288        in- and out-parameter *LENGTH is specified at -1, the string is
 289        read until a null character of the appropriate width is found -
 290        otherwise the string is read to the length of characters specified.
 291        On completion, *LENGTH will hold the size of the string in characters.
 292        If a *LENGTH of -1 was specified it will count only actual
 293        characters, excluding any eventual terminating null character.
 294        Otherwise *LENGTH will include all characters - including any nulls.
 295        CHARSET will hold the encoding used in the string.  */
 296     void (*la_get_string) (struct value *value, gdb_byte **buffer, int *length,
 297                           const char **charset);
 298
 299     /* Add fields above this point, so the magic number is always last. */
 300     /* Magic number for compat checking */
 301
 302     long la_magic;
 303
 304   };
 305
 306 #define LANG_MAGIC      910823L
 307
 308 /* Pointer to the language_defn for our current language.  This pointer
 309    always points to *some* valid struct; it can be used without checking
 310    it for validity.
 311
 312    The current language affects expression parsing and evaluation
 313    (FIXME: it might be cleaner to make the evaluation-related stuff
 314    separate exp_opcodes for each different set of semantics.  We
 315    should at least think this through more clearly with respect to
 316    what happens if the language is changed between parsing and
 317    evaluation) and printing of things like types and arrays.  It does
 318    *not* affect symbol-reading-- each source file in a symbol-file has
 319    its own language and we should keep track of that regardless of the
 320    language when symbols are read.  If we want some manual setting for
 321    the language of symbol files (e.g. detecting when ".c" files are
 322    C++), it should be a separate setting from the current_language.  */
 323
 324 extern const struct language_defn *current_language;
 325
 326 /* Pointer to the language_defn expected by the user, e.g. the language
 327    of main(), or the language we last mentioned in a message, or C.  */
 328
 329 extern const struct language_defn *expected_language;
 330
 331 /* language_mode ==
 332    language_mode_auto:   current_language automatically set upon selection
 333    of scope (e.g. stack frame)
 334    language_mode_manual: current_language set only by user.  */
 335
 336 extern enum language_mode
 337   {
 338     language_mode_auto, language_mode_manual
 339   }
 340 language_mode;
 341
 342 struct type *language_bool_type (const struct language_defn *l,
 343                                  struct gdbarch *gdbarch);
 344
 345 struct type *language_string_char_type (const struct language_defn *l,
 346                                         struct gdbarch *gdbarch);
 347
 348 struct type *language_lookup_primitive_type_by_name (const struct language_defn *l,
 349                                                      struct gdbarch *gdbarch,
 350                                                      const char *name);
 351
 352 \f
 353 /* These macros define the behaviour of the expression
 354    evaluator.  */
 355
 356 /* Should we strictly type check expressions? */
 357 #define STRICT_TYPE (type_check != type_check_off)
 358
 359 /* Should we range check values against the domain of their type? */
 360 #define RANGE_CHECK (range_check != range_check_off)
 361
 362 /* "cast" really means conversion */
 363 /* FIXME -- should be a setting in language_defn */
 364 #define CAST_IS_CONVERSION (current_language->la_language == language_c  || \
 365                             current_language->la_language == language_cplus || \
 366                             current_language->la_language == language_objc)
 367
 368 extern void language_info (int);
 369
 370 extern enum language set_language (enum language);
 371 \f
 372
 373 /* This page contains functions that return things that are
 374    specific to languages.  Each of these functions is based on
 375    the current setting of working_lang, which the user sets
 376    with the "set language" command. */
 377
 378 #define LA_PRINT_TYPE(type,varstring,stream,show,level) \
 379   (current_language->la_print_type(type,varstring,stream,show,level))
 380
 381 #define LA_PRINT_TYPEDEF(type,new_symbol,stream) \
 382   (current_language->la_print_typedef(type,new_symbol,stream))
 383
 384 #define LA_VAL_PRINT(type,valaddr,offset,addr,stream,recurse,options) \
 385   (current_language->la_val_print(type,valaddr,offset,addr,stream, \
 386                                   recurse,options))
 387 #define LA_VALUE_PRINT(val,stream,options) \
 388   (current_language->la_value_print(val,stream,options))
 389
 390 #define LA_PRINT_CHAR(ch, type, stream) \
 391   (current_language->la_printchar(ch, type, stream))
 392 #define LA_PRINT_STRING(stream, elttype, string, length, force_ellipses,options) \
 393   (current_language->la_printstr(stream, elttype, string, length, \
 394                                  force_ellipses,options))
 395 #define LA_EMIT_CHAR(ch, type, stream, quoter) \
 396   (current_language->la_emitchar(ch, type, stream, quoter))
 397 #define LA_GET_STRING(value, buffer, length, encoding) \
 398   (current_language->la_get_string(value, buffer, length, encoding))
 399
 400 #define LA_PRINT_ARRAY_INDEX(index_value, stream, optins) \
 401   (current_language->la_print_array_index(index_value, stream, options))
 402
 403 /* Test a character to decide whether it can be printed in literal form
 404    or needs to be printed in another representation.  For example,
 405    in C the literal form of the character with octal value 141 is 'a'
 406    and the "other representation" is '\141'.  The "other representation"
 407    is program language dependent. */
 408
 409 #define PRINT_LITERAL_FORM(c)           \
 410   ((c) >= 0x20                          \
 411    && ((c) < 0x7F || (c) >= 0xA0)       \
 412    && (!sevenbit_strings || (c) < 0x80))
 413
 414 #if 0
 415 /* FIXME: cagney/2000-03-04: This function does not appear to be used.
 416    It can be deleted once 5.0 has been released. */
 417 /* Return a string that contains the hex digits of the number.  No preceeding
 418    "0x" */
 419
 420 extern char *longest_raw_hex_string (LONGEST);
 421 #endif
 422
 423 /* Type predicates */
 424
 425 extern int simple_type (struct type *);
 426
 427 extern int ordered_type (struct type *);
 428
 429 extern int same_type (struct type *, struct type *);
 430
 431 extern int integral_type (struct type *);
 432
 433 extern int numeric_type (struct type *);
 434
 435 extern int character_type (struct type *);
 436
 437 extern int boolean_type (struct type *);
 438
 439 extern int float_type (struct type *);
 440
 441 extern int pointer_type (struct type *);
 442
 443 extern int structured_type (struct type *);
 444
 445 /* Checks Binary and Unary operations for semantic type correctness */
 446 /* FIXME:  Does not appear to be used */
 447 #define unop_type_check(v,o) binop_type_check((v),NULL,(o))
 448
 449 extern void binop_type_check (struct value *, struct value *, int);
 450
 451 /* Error messages */
 452
 453 extern void type_error (const char *, ...) ATTR_FORMAT (printf, 1, 2);
 454
 455 extern void range_error (const char *, ...) ATTR_FORMAT (printf, 1, 2);
 456
 457 /* Data:  Does this value represent "truth" to the current language?  */
 458
 459 extern int value_true (struct value *);
 460
 461 /* Misc:  The string representing a particular enum language.  */
 462
 463 extern enum language language_enum (char *str);
 464
 465 extern const struct language_defn *language_def (enum language);
 466
 467 extern char *language_str (enum language);
 468
 469 /* Add a language to the set known by GDB (at initialization time).  */
 470
 471 extern void add_language (const struct language_defn *);
 472
 473 extern enum language get_frame_language (void); /* In stack.c */
 474
 475 /* Check for a language-specific trampoline. */
 476
 477 extern CORE_ADDR skip_language_trampoline (struct frame_info *, CORE_ADDR pc);
 478
 479 /* Return demangled language symbol, or NULL.  */
 480 extern char *language_demangle (const struct language_defn *current_language,
 481                                 const char *mangled, int options);
 482
 483 /* Return class name from physname, or NULL.  */
 484 extern char *language_class_name_from_physname (const struct language_defn *,
 485                                                 const char *physname);
 486
 487 /* Splitting strings into words.  */
 488 extern char *default_word_break_characters (void);
 489
 490 /* Print the index of an array element using the C99 syntax.  */
 491 extern void default_print_array_index (struct value *index_value,
 492                                        struct ui_file *stream,
 493                                        const struct value_print_options *options);
 494
 495 /* Return non-zero if TYPE should be passed (and returned) by
 496    reference at the language level.  */
 497 int language_pass_by_reference (struct type *type);
 498
 499 /* Return zero; by default, types are passed by value at the language
 500    level.  The target ABI may pass or return some structs by reference
 501    independent of this.  */
 502 int default_pass_by_reference (struct type *type);
 503
 504 /* The default implementation of la_print_typedef.  */
 505 void default_print_typedef (struct type *type, struct symbol *new_symbol,
 506                             struct ui_file *stream);
 507
 508 void default_get_string (struct value *value, gdb_byte **buffer, int *length,
 509                          const char **charset);
 510
 511 void c_get_string (struct value *value, gdb_byte **buffer, int *length,
 512                    const char **charset);
 513
 514 #endif /* defined (LANGUAGE_H) */