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