gdb/language.h

   1 /* Source-language-related definitions for GDB.
   2    Copyright 1991, 1992 Free Software Foundation, Inc.
   3    Contributed by the Department of Computer Science at the State University
   4    of New York at Buffalo.
   5
   6 This file is part of GDB.
   7
   8 This program is free software; you can redistribute it and/or modify
   9 it under the terms of the GNU General Public License as published by
  10 the Free Software Foundation; either version 2 of the License, or
  11 (at your option) any later version.
  12
  13 This program is distributed in the hope that it will be useful,
  14 but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 GNU General Public License for more details.
  17
  18 You should have received a copy of the GNU General Public License
  19 along with this program; if not, write to the Free Software
  20 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.  */
  21
  22 #if !defined (LANGUAGE_H)
  23 #define LANGUAGE_H 1
  24
  25 #ifdef __STDC__         /* Forward decls for prototypes */
  26 struct value;
  27 /* enum exp_opcode;     ANSI's `wisdom' didn't include forward enum decls. */
  28 #endif
  29
  30 /* This used to be included to configure GDB for one or more specific
  31    languages.  Now it is shortcutted to configure for all of them.  FIXME.  */
  32 /* #include "lang_def.h" */
  33 #define _LANG_c
  34 #define _LANG_m2
  35 #define _LANG_chill
  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 {range_mode_auto, range_mode_manual} range_mode;
  42
  43 /* range_check ==
  44    range_check_on:    Ranges are checked in GDB expressions, producing errors.
  45    range_check_warn:  Ranges are checked, producing warnings.
  46    range_check_off:   Ranges are not checked in GDB expressions.  */
  47
  48 extern enum range_check
  49   {range_check_off, range_check_warn, range_check_on} range_check;
  50
  51 /* type_mode ==
  52    type_mode_auto:   type_check set automatically to default of language
  53    type_mode_manual: type_check set manually by user. */
  54
  55 extern enum type_mode {type_mode_auto, type_mode_manual} type_mode;
  56
  57 /* type_check ==
  58    type_check_on:    Types are checked in GDB expressions, producing errors.
  59    type_check_warn:  Types are checked, producing warnings.
  60    type_check_off:   Types are not checked in GDB expressions.  */
  61
  62 extern enum type_check
  63   {type_check_off, type_check_warn, type_check_on} type_check;
  64 \f
  65 /* Structure tying together assorted information about a language.  */
  66
  67 struct language_defn {
  68   char *           la_name;             /* Name of the language */
  69   enum language    la_language;         /* its symtab language-enum (defs.h) */
  70   struct type ** const
  71                   *la_builtin_type_vector;  /* Its builtin types */
  72   enum range_check la_range_check;      /* Default range checking */
  73   enum type_check  la_type_check;       /* Default type checking */
  74   int            (*la_parser) PARAMS((void));   /* Parser function */
  75   void           (*la_error) PARAMS ((char *)); /* Parser error function */
  76   struct type    **la_longest_int;      /* Longest signed integral type */
  77   struct type    **la_longest_unsigned_int; /* Longest uns integral type */
  78   struct type    **la_longest_float;    /* Longest floating point type */
  79   char            *la_hex_format;       /* Hexadecimal printf format str */
  80   char            *la_hex_format_pre;   /* Prefix for custom format string */
  81   char            *la_hex_format_suf;   /* Suffix for custom format string */
  82   char            *la_octal_format;     /* Octal printf format str */
  83   char            *la_octal_format_pre; /* Prefix for custom format string */
  84   char            *la_octal_format_suf; /* Suffix for custom format string */
  85 const struct op_print
  86                   *la_op_print_tab;     /* Table for printing expressions */
  87 /* Add fields above this point, so the magic number is always last. */
  88   long             la_magic;            /* Magic number for compat checking */
  89 };
  90
  91 #define LANG_MAGIC      910823L
  92
  93 /* Pointer to the language_defn for our current language.  This pointer
  94    always points to *some* valid struct; it can be used without checking
  95    it for validity.  */
  96
  97 extern const struct language_defn *current_language;
  98
  99 /* Pointer to the language_defn expected by the user, e.g. the language
 100    of main(), or the language we last mentioned in a message, or C.  */
 101
 102 extern const struct language_defn *expected_language;
 103
 104 /* language_mode ==
 105    language_mode_auto:   current_language automatically set upon selection
 106                          of scope (e.g. stack frame)
 107    language_mode_manual: current_language set only by user.  */
 108
 109 extern enum language_mode
 110   {language_mode_auto, language_mode_manual} language_mode;
 111 \f
 112 /* These macros define the behaviour of the expression
 113    evaluator.  */
 114
 115 /* Should we strictly type check expressions? */
 116 #define STRICT_TYPE (type_check != type_check_off)
 117
 118 /* Should we range check values against the domain of their type? */
 119 #define RANGE_CHECK (range_check != range_check_off)
 120
 121 /* "cast" really means conversion */
 122 /* FIXME -- should be a setting in language_defn */
 123 #define CAST_IS_CONVERSION (current_language->la_language == language_c)
 124
 125 extern void
 126 language_info PARAMS ((int));
 127
 128 extern void
 129 set_language PARAMS ((enum language));
 130
 131 \f
 132 /* This page contains functions that return things that are
 133    specific to languages.  Each of these functions is based on
 134    the current setting of working_lang, which the user sets
 135    with the "set language" command. */
 136
 137 /* Returns some built-in types */
 138 #define longest_int()           (*current_language->la_longest_int)
 139 #define longest_unsigned_int()  (*current_language->la_longest_unsigned_int)
 140 #define longest_float()         (*current_language->la_longest_float)
 141
 142 /* Hexadecimal number formatting is in defs.h because it is so common
 143    throughout GDB.  */
 144
 145 /* Return a format string for printf that will print a number in the local
 146    (language-specific) octal format.  Result is static and is
 147    overwritten by the next call.  local_octal_format_custom takes printf
 148    options like "08" or "l" (to produce e.g. %08x or %lx).  */
 149
 150 #define local_octal_format() (current_language->la_octal_format)
 151
 152 extern char *
 153 local_octal_format_custom PARAMS ((char *));
 154
 155 /* Type predicates */
 156
 157 extern int
 158 simple_type PARAMS ((struct type *));
 159
 160 extern int
 161 ordered_type PARAMS ((struct type *));
 162
 163 extern int
 164 same_type PARAMS ((struct type *, struct type *));
 165
 166 extern int
 167 integral_type PARAMS ((struct type *));
 168
 169 extern int
 170 numeric_type PARAMS ((struct type *));
 171
 172 extern int
 173 character_type PARAMS ((struct type *));
 174
 175 extern int
 176 boolean_type PARAMS ((struct type *));
 177
 178 extern int
 179 float_type PARAMS ((struct type *));
 180
 181 extern int
 182 pointer_type PARAMS ((struct type *));
 183
 184 extern int
 185 structured_type PARAMS ((struct type *));
 186
 187 /* Checks Binary and Unary operations for semantic type correctness */
 188 /* FIXME:  Does not appear to be used */
 189 #define unop_type_check(v,o) binop_type_check((v),NULL,(o))
 190
 191 extern void
 192 binop_type_check PARAMS ((struct value *, struct value *, int));
 193
 194 /* Error messages */
 195
 196 extern void
 197 op_error PARAMS ((char *fmt, enum exp_opcode, int));
 198
 199 #define type_op_error(f,o) \
 200    op_error((f),(o),type_check==type_check_on ? 1 : 0)
 201 #define range_op_error(f,o) \
 202    op_error((f),(o),range_check==range_check_on ? 1 : 0)
 203
 204 extern void
 205 type_error ();
 206
 207 void
 208 range_error ();
 209
 210 /* Data:  Does this value represent "truth" to the current language?  */
 211
 212 extern int
 213 value_true PARAMS ((struct value *));
 214
 215 /* Misc:  The string representing a particular enum language.  */
 216
 217 extern char *
 218 language_str PARAMS ((enum language));
 219
 220 /* Add a language to the set known by GDB (at initialization time).  */
 221
 222 extern void
 223 add_language PARAMS ((const struct language_defn *));
 224
 225 extern enum language
 226 get_frame_language PARAMS ((void));             /* In stack.c */
 227
 228 #endif  /* defined (LANGUAGE_H) */