gdb/m2-lang.c

   1 /* Modula 2 language support routines for GDB, the GNU debugger.
   2
   3    Copyright (C) 1992-2020 Free Software Foundation, Inc.
   4
   5    This file is part of GDB.
   6
   7    This program is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 3 of the License, or
  10    (at your option) any later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  19
  20 #include "defs.h"
  21 #include "symtab.h"
  22 #include "gdbtypes.h"
  23 #include "expression.h"
  24 #include "parser-defs.h"
  25 #include "language.h"
  26 #include "varobj.h"
  27 #include "m2-lang.h"
  28 #include "c-lang.h"
  29 #include "valprint.h"
  30 #include "gdbarch.h"
  31
  32 static void m2_printchar (int, struct type *, struct ui_file *);
  33
  34 /* FIXME:  This is a copy of the same function from c-exp.y.  It should
  35    be replaced with a true Modula version.  */
  36
  37 static void
  38 m2_printchar (int c, struct type *type, struct ui_file *stream)
  39 {
  40   fputs_filtered ("'", stream);
  41   LA_EMIT_CHAR (c, type, stream, '\'');
  42   fputs_filtered ("'", stream);
  43 }
  44
  45 static struct value *
  46 evaluate_subexp_modula2 (struct type *expect_type, struct expression *exp,
  47                          int *pos, enum noside noside)
  48 {
  49   enum exp_opcode op = exp->elts[*pos].opcode;
  50   struct value *arg1;
  51   struct value *arg2;
  52   struct type *type;
  53
  54   switch (op)
  55     {
  56     case UNOP_HIGH:
  57       (*pos)++;
  58       arg1 = evaluate_subexp_with_coercion (exp, pos, noside);
  59
  60       if (noside == EVAL_SKIP || noside == EVAL_AVOID_SIDE_EFFECTS)
  61         return arg1;
  62       else
  63         {
  64           arg1 = coerce_ref (arg1);
  65           type = check_typedef (value_type (arg1));
  66
  67           if (m2_is_unbounded_array (type))
  68             {
  69               struct value *temp = arg1;
  70
  71               type = type->field (1).type ();
  72               /* i18n: Do not translate the "_m2_high" part!  */
  73               arg1 = value_struct_elt (&temp, NULL, "_m2_high", NULL,
  74                                        _("unbounded structure "
  75                                          "missing _m2_high field"));
  76
  77               if (value_type (arg1) != type)
  78                 arg1 = value_cast (type, arg1);
  79             }
  80         }
  81       return arg1;
  82
  83     case BINOP_SUBSCRIPT:
  84       (*pos)++;
  85       arg1 = evaluate_subexp_with_coercion (exp, pos, noside);
  86       arg2 = evaluate_subexp_with_coercion (exp, pos, noside);
  87       if (noside == EVAL_SKIP)
  88         goto nosideret;
  89       /* If the user attempts to subscript something that is not an
  90          array or pointer type (like a plain int variable for example),
  91          then report this as an error.  */
  92
  93       arg1 = coerce_ref (arg1);
  94       type = check_typedef (value_type (arg1));
  95
  96       if (m2_is_unbounded_array (type))
  97         {
  98           struct value *temp = arg1;
  99           type = type->field (0).type ();
 100           if (type == NULL || (type->code () != TYPE_CODE_PTR))
 101             {
 102               warning (_("internal error: unbounded "
 103                          "array structure is unknown"));
 104               return evaluate_subexp_standard (expect_type, exp, pos, noside);
 105             }
 106           /* i18n: Do not translate the "_m2_contents" part!  */
 107           arg1 = value_struct_elt (&temp, NULL, "_m2_contents", NULL,
 108                                    _("unbounded structure "
 109                                      "missing _m2_contents field"));
 110
 111           if (value_type (arg1) != type)
 112             arg1 = value_cast (type, arg1);
 113
 114           check_typedef (value_type (arg1));
 115           return value_ind (value_ptradd (arg1, value_as_long (arg2)));
 116         }
 117       else
 118         if (type->code () != TYPE_CODE_ARRAY)
 119           {
 120             if (type->name ())
 121               error (_("cannot subscript something of type `%s'"),
 122                      type->name ());
 123             else
 124               error (_("cannot subscript requested type"));
 125           }
 126
 127       if (noside == EVAL_AVOID_SIDE_EFFECTS)
 128         return value_zero (TYPE_TARGET_TYPE (type), VALUE_LVAL (arg1));
 129       else
 130         return value_subscript (arg1, value_as_long (arg2));
 131
 132     default:
 133       return evaluate_subexp_standard (expect_type, exp, pos, noside);
 134     }
 135
 136  nosideret:
 137   return value_from_longest (builtin_type (exp->gdbarch)->builtin_int, 1);
 138 }
 139 \f
 140
 141 /* Table of operators and their precedences for printing expressions.  */
 142
 143 static const struct op_print m2_op_print_tab[] =
 144 {
 145   {"+", BINOP_ADD, PREC_ADD, 0},
 146   {"+", UNOP_PLUS, PREC_PREFIX, 0},
 147   {"-", BINOP_SUB, PREC_ADD, 0},
 148   {"-", UNOP_NEG, PREC_PREFIX, 0},
 149   {"*", BINOP_MUL, PREC_MUL, 0},
 150   {"/", BINOP_DIV, PREC_MUL, 0},
 151   {"DIV", BINOP_INTDIV, PREC_MUL, 0},
 152   {"MOD", BINOP_REM, PREC_MUL, 0},
 153   {":=", BINOP_ASSIGN, PREC_ASSIGN, 1},
 154   {"OR", BINOP_LOGICAL_OR, PREC_LOGICAL_OR, 0},
 155   {"AND", BINOP_LOGICAL_AND, PREC_LOGICAL_AND, 0},
 156   {"NOT", UNOP_LOGICAL_NOT, PREC_PREFIX, 0},
 157   {"=", BINOP_EQUAL, PREC_EQUAL, 0},
 158   {"<>", BINOP_NOTEQUAL, PREC_EQUAL, 0},
 159   {"<=", BINOP_LEQ, PREC_ORDER, 0},
 160   {">=", BINOP_GEQ, PREC_ORDER, 0},
 161   {">", BINOP_GTR, PREC_ORDER, 0},
 162   {"<", BINOP_LESS, PREC_ORDER, 0},
 163   {"^", UNOP_IND, PREC_PREFIX, 0},
 164   {"@", BINOP_REPEAT, PREC_REPEAT, 0},
 165   {"CAP", UNOP_CAP, PREC_BUILTIN_FUNCTION, 0},
 166   {"CHR", UNOP_CHR, PREC_BUILTIN_FUNCTION, 0},
 167   {"ORD", UNOP_ORD, PREC_BUILTIN_FUNCTION, 0},
 168   {"FLOAT", UNOP_FLOAT, PREC_BUILTIN_FUNCTION, 0},
 169   {"HIGH", UNOP_HIGH, PREC_BUILTIN_FUNCTION, 0},
 170   {"MAX", UNOP_MAX, PREC_BUILTIN_FUNCTION, 0},
 171   {"MIN", UNOP_MIN, PREC_BUILTIN_FUNCTION, 0},
 172   {"ODD", UNOP_ODD, PREC_BUILTIN_FUNCTION, 0},
 173   {"TRUNC", UNOP_TRUNC, PREC_BUILTIN_FUNCTION, 0},
 174   {NULL, OP_NULL, PREC_BUILTIN_FUNCTION, 0}
 175 };
 176 \f
 177 /* The built-in types of Modula-2.  */
 178
 179 enum m2_primitive_types {
 180   m2_primitive_type_char,
 181   m2_primitive_type_int,
 182   m2_primitive_type_card,
 183   m2_primitive_type_real,
 184   m2_primitive_type_bool,
 185   nr_m2_primitive_types
 186 };
 187
 188 const struct exp_descriptor exp_descriptor_modula2 =
 189 {
 190   print_subexp_standard,
 191   operator_length_standard,
 192   operator_check_standard,
 193   op_name_standard,
 194   dump_subexp_body_standard,
 195   evaluate_subexp_modula2
 196 };
 197
 198 /* Constant data describing the M2 language.  */
 199
 200 extern const struct language_data m2_language_data =
 201 {
 202   range_check_on,
 203   case_sensitive_on,
 204   array_row_major,
 205   macro_expansion_no,
 206   &exp_descriptor_modula2,
 207   m2_op_print_tab,              /* expression operators for printing */
 208   &default_varobj_ops,
 209 };
 210
 211 /* Class representing the M2 language.  */
 212
 213 class m2_language : public language_defn
 214 {
 215 public:
 216   m2_language ()
 217     : language_defn (language_m2, m2_language_data)
 218   { /* Nothing.  */ }
 219
 220   /* See language.h.  */
 221
 222   const char *name () const override
 223   { return "modula-2"; }
 224
 225   /* See language.h.  */
 226
 227   const char *natural_name () const override
 228   { return "Modula-2"; }
 229
 230   /* See language.h.  */
 231   void language_arch_info (struct gdbarch *gdbarch,
 232                            struct language_arch_info *lai) const override
 233   {
 234     const struct builtin_m2_type *builtin = builtin_m2_type (gdbarch);
 235
 236     lai->string_char_type = builtin->builtin_char;
 237     lai->primitive_type_vector
 238       = GDBARCH_OBSTACK_CALLOC (gdbarch, nr_m2_primitive_types + 1,
 239                                 struct type *);
 240
 241     lai->primitive_type_vector [m2_primitive_type_char]
 242       = builtin->builtin_char;
 243     lai->primitive_type_vector [m2_primitive_type_int]
 244       = builtin->builtin_int;
 245     lai->primitive_type_vector [m2_primitive_type_card]
 246       = builtin->builtin_card;
 247     lai->primitive_type_vector [m2_primitive_type_real]
 248       = builtin->builtin_real;
 249     lai->primitive_type_vector [m2_primitive_type_bool]
 250       = builtin->builtin_bool;
 251
 252     lai->bool_type_symbol = "BOOLEAN";
 253     lai->bool_type_default = builtin->builtin_bool;
 254   }
 255
 256   /* See language.h.  */
 257
 258   void print_type (struct type *type, const char *varstring,
 259                    struct ui_file *stream, int show, int level,
 260                    const struct type_print_options *flags) const override
 261   {
 262     m2_print_type (type, varstring, stream, show, level, flags);
 263   }
 264
 265   /* See language.h.  */
 266
 267   void value_print_inner
 268         (struct value *val, struct ui_file *stream, int recurse,
 269          const struct value_print_options *options) const override
 270   {
 271     return m2_value_print_inner (val, stream, recurse, options);
 272   }
 273
 274   /* See language.h.  */
 275
 276   int parser (struct parser_state *ps) const override
 277   {
 278     return m2_parse (ps);
 279   }
 280
 281   /* See language.h.  */
 282
 283   void emitchar (int ch, struct type *chtype,
 284                  struct ui_file *stream, int quoter) const override
 285   {
 286     ch &= 0xFF;                 /* Avoid sign bit follies.  */
 287
 288     if (PRINT_LITERAL_FORM (ch))
 289       {
 290         if (ch == '\\' || ch == quoter)
 291           fputs_filtered ("\\", stream);
 292         fprintf_filtered (stream, "%c", ch);
 293       }
 294     else
 295       {
 296         switch (ch)
 297           {
 298           case '\n':
 299             fputs_filtered ("\\n", stream);
 300             break;
 301           case '\b':
 302             fputs_filtered ("\\b", stream);
 303             break;
 304           case '\t':
 305             fputs_filtered ("\\t", stream);
 306             break;
 307           case '\f':
 308             fputs_filtered ("\\f", stream);
 309             break;
 310           case '\r':
 311             fputs_filtered ("\\r", stream);
 312             break;
 313           case '\033':
 314             fputs_filtered ("\\e", stream);
 315             break;
 316           case '\007':
 317             fputs_filtered ("\\a", stream);
 318             break;
 319           default:
 320             fprintf_filtered (stream, "\\%.3o", (unsigned int) ch);
 321             break;
 322           }
 323       }
 324   }
 325
 326   /* See language.h.  */
 327
 328   void printchar (int ch, struct type *chtype,
 329                   struct ui_file *stream) const override
 330   {
 331     m2_printchar (ch, chtype, stream);
 332   }
 333
 334   /* See language.h.  */
 335
 336   void printstr (struct ui_file *stream, struct type *elttype,
 337                  const gdb_byte *string, unsigned int length,
 338                  const char *encoding, int force_ellipses,
 339                  const struct value_print_options *options) const override
 340   {
 341     unsigned int i;
 342     unsigned int things_printed = 0;
 343     int in_quotes = 0;
 344     int need_comma = 0;
 345
 346     if (length == 0)
 347       {
 348         fputs_filtered ("\"\"", gdb_stdout);
 349         return;
 350       }
 351
 352     for (i = 0; i < length && things_printed < options->print_max; ++i)
 353       {
 354         /* Position of the character we are examining
 355            to see whether it is repeated.  */
 356         unsigned int rep1;
 357         /* Number of repetitions we have detected so far.  */
 358         unsigned int reps;
 359
 360         QUIT;
 361
 362         if (need_comma)
 363           {
 364             fputs_filtered (", ", stream);
 365             need_comma = 0;
 366           }
 367
 368         rep1 = i + 1;
 369         reps = 1;
 370         while (rep1 < length && string[rep1] == string[i])
 371           {
 372             ++rep1;
 373             ++reps;
 374           }
 375
 376         if (reps > options->repeat_count_threshold)
 377           {
 378             if (in_quotes)
 379               {
 380                 fputs_filtered ("\", ", stream);
 381                 in_quotes = 0;
 382               }
 383             m2_printchar (string[i], elttype, stream);
 384             fprintf_filtered (stream, " <repeats %u times>", reps);
 385             i = rep1 - 1;
 386             things_printed += options->repeat_count_threshold;
 387             need_comma = 1;
 388           }
 389         else
 390           {
 391             if (!in_quotes)
 392               {
 393                 fputs_filtered ("\"", stream);
 394                 in_quotes = 1;
 395               }
 396             LA_EMIT_CHAR (string[i], elttype, stream, '"');
 397             ++things_printed;
 398           }
 399       }
 400
 401     /* Terminate the quotes if necessary.  */
 402     if (in_quotes)
 403       fputs_filtered ("\"", stream);
 404
 405     if (force_ellipses || i < length)
 406       fputs_filtered ("...", stream);
 407   }
 408
 409   /* See language.h.  */
 410
 411   void print_typedef (struct type *type, struct symbol *new_symbol,
 412                       struct ui_file *stream) const override
 413   {
 414     m2_print_typedef (type, new_symbol, stream);
 415   }
 416
 417   /* See language.h.  */
 418
 419   bool is_string_type_p (struct type *type) const override
 420   {
 421     type = check_typedef (type);
 422     if (type->code () == TYPE_CODE_ARRAY
 423         && TYPE_LENGTH (type) > 0
 424         && TYPE_LENGTH (TYPE_TARGET_TYPE (type)) > 0)
 425       {
 426         struct type *elttype = check_typedef (TYPE_TARGET_TYPE (type));
 427
 428         if (TYPE_LENGTH (elttype) == 1
 429             && (elttype->code () == TYPE_CODE_INT
 430                 || elttype->code () == TYPE_CODE_CHAR))
 431           return true;
 432       }
 433
 434     return false;
 435   }
 436
 437   /* See language.h.  */
 438
 439   bool c_style_arrays_p () const override
 440   { return false; }
 441
 442   /* See language.h.  Despite not having C-style arrays, Modula-2 uses 0
 443      for its string lower bounds.  */
 444
 445   char string_lower_bound () const override
 446   { return 0; }
 447 };
 448
 449 /* Single instance of the M2 language.  */
 450
 451 static m2_language m2_language_defn;
 452
 453 static void *
 454 build_m2_types (struct gdbarch *gdbarch)
 455 {
 456   struct builtin_m2_type *builtin_m2_type
 457     = GDBARCH_OBSTACK_ZALLOC (gdbarch, struct builtin_m2_type);
 458
 459   /* Modula-2 "pervasive" types.  NOTE:  these can be redefined!!! */
 460   builtin_m2_type->builtin_int
 461     = arch_integer_type (gdbarch, gdbarch_int_bit (gdbarch), 0, "INTEGER");
 462   builtin_m2_type->builtin_card
 463     = arch_integer_type (gdbarch, gdbarch_int_bit (gdbarch), 1, "CARDINAL");
 464   builtin_m2_type->builtin_real
 465     = arch_float_type (gdbarch, gdbarch_float_bit (gdbarch), "REAL",
 466                        gdbarch_float_format (gdbarch));
 467   builtin_m2_type->builtin_char
 468     = arch_character_type (gdbarch, TARGET_CHAR_BIT, 1, "CHAR");
 469   builtin_m2_type->builtin_bool
 470     = arch_boolean_type (gdbarch, gdbarch_int_bit (gdbarch), 1, "BOOLEAN");
 471
 472   return builtin_m2_type;
 473 }
 474
 475 static struct gdbarch_data *m2_type_data;
 476
 477 const struct builtin_m2_type *
 478 builtin_m2_type (struct gdbarch *gdbarch)
 479 {
 480   return (const struct builtin_m2_type *) gdbarch_data (gdbarch, m2_type_data);
 481 }
 482
 483
 484 /* Initialization for Modula-2 */
 485
 486 void _initialize_m2_language ();
 487 void
 488 _initialize_m2_language ()
 489 {
 490   m2_type_data = gdbarch_data_register_post_init (build_m2_types);
 491 }