gdb/language.h

   1 /* Source-language-related definitions for GDB.
   2
   3    Copyright 1991, 1992, 1993, 1994, 1995, 1998, 1999, 2000, 2003 Free
   4    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 2 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, write to the Free Software
  23    Foundation, Inc., 59 Temple Place - Suite 330,
  24    Boston, MA 02111-1307, USA.  */
  25
  26 #if !defined (LANGUAGE_H)
  27 #define LANGUAGE_H 1
  28
  29 /* Forward decls for prototypes */
  30 struct value;
  31 struct objfile;
  32 struct expression;
  33 /* enum exp_opcode;     ANSI's `wisdom' didn't include forward enum decls. */
  34
  35 /* This used to be included to configure GDB for one or more specific
  36    languages.  Now it is left out to configure for all of them.  FIXME.  */
  37 /* #include "lang_def.h" */
  38 #define _LANG_c
  39 #define _LANG_m2
  40 #define  _LANG_fortran
  41 #define  _LANG_pascal
  42
  43 #define MAX_FORTRAN_DIMS  7     /* Maximum number of F77 array dims */
  44
  45 /* range_mode ==
  46    range_mode_auto:   range_check set automatically to default of language.
  47    range_mode_manual: range_check set manually by user.  */
  48
  49 extern enum range_mode
  50   {
  51     range_mode_auto, range_mode_manual
  52   }
  53 range_mode;
  54
  55 /* range_check ==
  56    range_check_on:    Ranges are checked in GDB expressions, producing errors.
  57    range_check_warn:  Ranges are checked, producing warnings.
  58    range_check_off:   Ranges are not checked in GDB expressions.  */
  59
  60 extern enum range_check
  61   {
  62     range_check_off, range_check_warn, range_check_on
  63   }
  64 range_check;
  65
  66 /* type_mode ==
  67    type_mode_auto:   type_check set automatically to default of language
  68    type_mode_manual: type_check set manually by user. */
  69
  70 extern enum type_mode
  71   {
  72     type_mode_auto, type_mode_manual
  73   }
  74 type_mode;
  75
  76 /* type_check ==
  77    type_check_on:    Types are checked in GDB expressions, producing errors.
  78    type_check_warn:  Types are checked, producing warnings.
  79    type_check_off:   Types are not checked in GDB expressions.  */
  80
  81 extern enum type_check
  82   {
  83     type_check_off, type_check_warn, type_check_on
  84   }
  85 type_check;
  86
  87 /* case_mode ==
  88    case_mode_auto:   case_sensitivity set upon selection of scope
  89    case_mode_manual: case_sensitivity set only by user.  */
  90
  91 extern enum case_mode
  92   {
  93     case_mode_auto, case_mode_manual
  94   }
  95 case_mode;
  96
  97 /* case_sensitivity ==
  98    case_sensitive_on:   Case sensitivity in name matching is used
  99    case_sensitive_off:  Case sensitivity in name matching is not used  */
 100
 101 extern enum case_sensitivity
 102   {
 103     case_sensitive_on, case_sensitive_off
 104   }
 105 case_sensitivity;
 106 \f
 107 /* Information for doing language dependent formatting of printed values. */
 108
 109 struct language_format_info
 110   {
 111     /* The format that can be passed directly to standard C printf functions
 112        to generate a completely formatted value in the format appropriate for
 113        the language. */
 114
 115     char *la_format;
 116
 117     /* The prefix to be used when directly printing a value, or constructing
 118        a standard C printf format.  This generally is everything up to the
 119        conversion specification (the part introduced by the '%' character
 120        and terminated by the conversion specifier character). */
 121
 122     char *la_format_prefix;
 123
 124     /* The conversion specifier.  This is generally everything after the
 125        field width and precision, typically only a single character such
 126        as 'o' for octal format or 'x' for hexadecimal format. */
 127
 128     char *la_format_specifier;
 129
 130     /* The suffix to be used when directly printing a value, or constructing
 131        a standard C printf format.  This generally is everything after the
 132        conversion specification (the part introduced by the '%' character
 133        and terminated by the conversion specifier character). */
 134
 135     char *la_format_suffix;     /* Suffix for custom format string */
 136   };
 137
 138 /* Structure tying together assorted information about a language.  */
 139
 140 struct language_defn
 141   {
 142     /* Name of the language */
 143
 144     char *la_name;
 145
 146     /* its symtab language-enum (defs.h) */
 147
 148     enum language la_language;
 149
 150     /* Its builtin types.  This is a vector ended by a NULL pointer.  These
 151        types can be specified by name in parsing types in expressions,
 152        regardless of whether the program being debugged actually defines
 153        such a type.  */
 154
 155     struct type **const *la_builtin_type_vector;
 156
 157     /* Default range checking */
 158
 159     enum range_check la_range_check;
 160
 161     /* Default type checking */
 162
 163     enum type_check la_type_check;
 164
 165     /* Default case sensitivity */
 166     enum case_sensitivity la_case_sensitivity;
 167
 168     /* Parser function. */
 169
 170     int (*la_parser) (void);
 171
 172     /* Parser error function */
 173
 174     void (*la_error) (char *);
 175
 176     /* Evaluate an expression. */
 177     struct value *(*evaluate_exp) (struct type *, struct expression *,
 178                                    int *, enum noside);
 179
 180     void (*la_printchar) (int ch, struct ui_file * stream);
 181
 182     void (*la_printstr) (struct ui_file * stream, char *string,
 183                          unsigned int length, int width,
 184                          int force_ellipses);
 185
 186     void (*la_emitchar) (int ch, struct ui_file * stream, int quoter);
 187
 188     struct type *(*la_fund_type) (struct objfile *, int);
 189
 190     /* Print a type using syntax appropriate for this language. */
 191
 192     void (*la_print_type) (struct type *, char *, struct ui_file *, int,
 193                            int);
 194
 195     /* Print a value using syntax appropriate for this language. */
 196
 197     int (*la_val_print) (struct type *, char *, int, CORE_ADDR,
 198                          struct ui_file *, int, int, int,
 199                          enum val_prettyprint);
 200
 201     /* Print a top-level value using syntax appropriate for this language. */
 202
 203     int (*la_value_print) (struct value *, struct ui_file *,
 204                            int, enum val_prettyprint);
 205
 206     /* PC is possibly an unknown languages trampoline.
 207        If that PC falls in a trampoline belonging to this language,
 208        return the address of the first pc in the real function, or 0
 209        if it isn't a language tramp for this language.  */
 210     CORE_ADDR (*skip_trampoline) (CORE_ADDR pc);
 211
 212     /* Base 2 (binary) formats. */
 213
 214     struct language_format_info la_binary_format;
 215
 216     /* Base 8 (octal) formats. */
 217
 218     struct language_format_info la_octal_format;
 219
 220     /* Base 10 (decimal) formats */
 221
 222     struct language_format_info la_decimal_format;
 223
 224     /* Base 16 (hexadecimal) formats */
 225
 226     struct language_format_info la_hex_format;
 227
 228     /* Table for printing expressions */
 229
 230     const struct op_print *la_op_print_tab;
 231
 232     /* Zero if the language has first-class arrays.  True if there are no
 233        array values, and array objects decay to pointers, as in C. */
 234
 235     char c_style_arrays;
 236
 237     /* Index to use for extracting the first element of a string. */
 238     char string_lower_bound;
 239
 240     /* Type of elements of strings. */
 241     struct type **string_char_type;
 242
 243     /* Add fields above this point, so the magic number is always last. */
 244     /* Magic number for compat checking */
 245
 246     long la_magic;
 247
 248   };
 249
 250 #define LANG_MAGIC      910823L
 251
 252 /* Pointer to the language_defn for our current language.  This pointer
 253    always points to *some* valid struct; it can be used without checking
 254    it for validity.
 255
 256    The current language affects expression parsing and evaluation
 257    (FIXME: it might be cleaner to make the evaluation-related stuff
 258    separate exp_opcodes for each different set of semantics.  We
 259    should at least think this through more clearly with respect to
 260    what happens if the language is changed between parsing and
 261    evaluation) and printing of things like types and arrays.  It does
 262    *not* affect symbol-reading-- each source file in a symbol-file has
 263    its own language and we should keep track of that regardless of the
 264    language when symbols are read.  If we want some manual setting for
 265    the language of symbol files (e.g. detecting when ".c" files are
 266    C++), it should be a separate setting from the current_language.  */
 267
 268 extern const struct language_defn *current_language;
 269
 270 /* Pointer to the language_defn expected by the user, e.g. the language
 271    of main(), or the language we last mentioned in a message, or C.  */
 272
 273 extern const struct language_defn *expected_language;
 274
 275 /* language_mode ==
 276    language_mode_auto:   current_language automatically set upon selection
 277    of scope (e.g. stack frame)
 278    language_mode_manual: current_language set only by user.  */
 279
 280 extern enum language_mode
 281   {
 282     language_mode_auto, language_mode_manual
 283   }
 284 language_mode;
 285 \f
 286 /* These macros define the behaviour of the expression
 287    evaluator.  */
 288
 289 /* Should we strictly type check expressions? */
 290 #define STRICT_TYPE (type_check != type_check_off)
 291
 292 /* Should we range check values against the domain of their type? */
 293 #define RANGE_CHECK (range_check != range_check_off)
 294
 295 /* "cast" really means conversion */
 296 /* FIXME -- should be a setting in language_defn */
 297 #define CAST_IS_CONVERSION (current_language->la_language == language_c  || \
 298                             current_language->la_language == language_cplus || \
 299                             current_language->la_language == language_objc)
 300
 301 extern void language_info (int);
 302
 303 extern enum language set_language (enum language);
 304 \f
 305
 306 /* This page contains functions that return things that are
 307    specific to languages.  Each of these functions is based on
 308    the current setting of working_lang, which the user sets
 309    with the "set language" command. */
 310
 311 #define create_fundamental_type(objfile,typeid) \
 312   (current_language->la_fund_type(objfile, typeid))
 313
 314 #define LA_PRINT_TYPE(type,varstring,stream,show,level) \
 315   (current_language->la_print_type(type,varstring,stream,show,level))
 316
 317 #define LA_VAL_PRINT(type,valaddr,offset,addr,stream,fmt,deref,recurse,pretty) \
 318   (current_language->la_val_print(type,valaddr,offset,addr,stream,fmt,deref, \
 319                                   recurse,pretty))
 320 #define LA_VALUE_PRINT(val,stream,fmt,pretty) \
 321   (current_language->la_value_print(val,stream,fmt,pretty))
 322
 323 /* Return a format string for printf that will print a number in one of
 324    the local (language-specific) formats.  Result is static and is
 325    overwritten by the next call.  Takes printf options like "08" or "l"
 326    (to produce e.g. %08x or %lx).  */
 327
 328 #define local_binary_format() \
 329   (current_language->la_binary_format.la_format)
 330 #define local_binary_format_prefix() \
 331   (current_language->la_binary_format.la_format_prefix)
 332 #define local_binary_format_specifier() \
 333   (current_language->la_binary_format.la_format_specifier)
 334 #define local_binary_format_suffix() \
 335   (current_language->la_binary_format.la_format_suffix)
 336
 337 #define local_octal_format() \
 338   (current_language->la_octal_format.la_format)
 339 #define local_octal_format_prefix() \
 340   (current_language->la_octal_format.la_format_prefix)
 341 #define local_octal_format_specifier() \
 342   (current_language->la_octal_format.la_format_specifier)
 343 #define local_octal_format_suffix() \
 344   (current_language->la_octal_format.la_format_suffix)
 345
 346 #define local_decimal_format() \
 347   (current_language->la_decimal_format.la_format)
 348 #define local_decimal_format_prefix() \
 349   (current_language->la_decimal_format.la_format_prefix)
 350 #define local_decimal_format_specifier() \
 351   (current_language->la_decimal_format.la_format_specifier)
 352 #define local_decimal_format_suffix() \
 353   (current_language->la_decimal_format.la_format_suffix)
 354
 355 #define local_hex_format() \
 356   (current_language->la_hex_format.la_format)
 357 #define local_hex_format_prefix() \
 358   (current_language->la_hex_format.la_format_prefix)
 359 #define local_hex_format_specifier() \
 360   (current_language->la_hex_format.la_format_specifier)
 361 #define local_hex_format_suffix() \
 362   (current_language->la_hex_format.la_format_suffix)
 363
 364 #define LA_PRINT_CHAR(ch, stream) \
 365   (current_language->la_printchar(ch, stream))
 366 #define LA_PRINT_STRING(stream, string, length, width, force_ellipses) \
 367   (current_language->la_printstr(stream, string, length, width, force_ellipses))
 368 #define LA_EMIT_CHAR(ch, stream, quoter) \
 369   (current_language->la_emitchar(ch, stream, quoter))
 370
 371 /* Test a character to decide whether it can be printed in literal form
 372    or needs to be printed in another representation.  For example,
 373    in C the literal form of the character with octal value 141 is 'a'
 374    and the "other representation" is '\141'.  The "other representation"
 375    is program language dependent. */
 376
 377 #define PRINT_LITERAL_FORM(c)           \
 378   ((c) >= 0x20                          \
 379    && ((c) < 0x7F || (c) >= 0xA0)       \
 380    && (!sevenbit_strings || (c) < 0x80))
 381
 382 /* Return a format string for printf that will print a number in one of
 383    the local (language-specific) formats.  Result is static and is
 384    overwritten by the next call.  Takes printf options like "08" or "l"
 385    (to produce e.g. %08x or %lx).  */
 386
 387 extern char *local_decimal_format_custom (char *);      /* language.c */
 388
 389 extern char *local_octal_format_custom (char *);        /* language.c */
 390
 391 extern char *local_hex_format_custom (char *);  /* language.c */
 392
 393 #if 0
 394 /* FIXME: cagney/2000-03-04: This function does not appear to be used.
 395    It can be deleted once 5.0 has been released. */
 396 /* Return a string that contains the hex digits of the number.  No preceeding
 397    "0x" */
 398
 399 extern char *longest_raw_hex_string (LONGEST);
 400 #endif
 401
 402 /* Return a string that contains a number formatted in one of the local
 403    (language-specific) formats.  Result is static and is overwritten by
 404    the next call.  Takes printf options like "08l" or "l".  */
 405
 406 extern char *local_hex_string (LONGEST);        /* language.c */
 407
 408 extern char *local_hex_string_custom (LONGEST, char *); /* language.c */
 409
 410 /* Type predicates */
 411
 412 extern int simple_type (struct type *);
 413
 414 extern int ordered_type (struct type *);
 415
 416 extern int same_type (struct type *, struct type *);
 417
 418 extern int integral_type (struct type *);
 419
 420 extern int numeric_type (struct type *);
 421
 422 extern int character_type (struct type *);
 423
 424 extern int boolean_type (struct type *);
 425
 426 extern int float_type (struct type *);
 427
 428 extern int pointer_type (struct type *);
 429
 430 extern int structured_type (struct type *);
 431
 432 /* Checks Binary and Unary operations for semantic type correctness */
 433 /* FIXME:  Does not appear to be used */
 434 #define unop_type_check(v,o) binop_type_check((v),NULL,(o))
 435
 436 extern void binop_type_check (struct value *, struct value *, int);
 437
 438 /* Error messages */
 439
 440 extern void op_error (char *fmt, enum exp_opcode, int);
 441
 442 #define type_op_error(f,o) \
 443    op_error((f),(o),type_check==type_check_on ? 1 : 0)
 444 #define range_op_error(f,o) \
 445    op_error((f),(o),range_check==range_check_on ? 1 : 0)
 446
 447 extern void type_error (const char *, ...) ATTR_FORMAT (printf, 1, 2);
 448
 449 extern void range_error (const char *, ...) ATTR_FORMAT (printf, 1, 2);
 450
 451 /* Data:  Does this value represent "truth" to the current language?  */
 452
 453 extern int value_true (struct value *);
 454
 455 extern struct type *lang_bool_type (void);
 456
 457 /* The type used for Boolean values in the current language. */
 458 #define LA_BOOL_TYPE lang_bool_type ()
 459
 460 /* Misc:  The string representing a particular enum language.  */
 461
 462 extern enum language language_enum (char *str);
 463
 464 extern const struct language_defn *language_def (enum language);
 465
 466 extern char *language_str (enum language);
 467
 468 /* Add a language to the set known by GDB (at initialization time).  */
 469
 470 extern void add_language (const struct language_defn *);
 471
 472 extern enum language get_frame_language (void); /* In stack.c */
 473
 474 /* Check for a language-specific trampoline. */
 475
 476 extern CORE_ADDR skip_language_trampoline (CORE_ADDR pc);
 477
 478 #endif /* defined (LANGUAGE_H) */