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