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   false,                        /* la_store_sym_names_in_linkage_form_p */
 208   m2_op_print_tab,              /* expression operators for printing */
 209   &default_varobj_ops,
 210 };
 211
 212 /* Class representing the M2 language.  */
 213
 214 class m2_language : public language_defn
 215 {
 216 public:
 217   m2_language ()
 218     : language_defn (language_m2, m2_language_data)
 219   { /* Nothing.  */ }
 220
 221   /* See language.h.  */
 222
 223   const char *name () const override
 224   { return "modula-2"; }
 225
 226   /* See language.h.  */
 227
 228   const char *natural_name () const override
 229   { return "Modula-2"; }
 230
 231   /* See language.h.  */
 232   void language_arch_info (struct gdbarch *gdbarch,
 233                            struct language_arch_info *lai) const override
 234   {
 235     const struct builtin_m2_type *builtin = builtin_m2_type (gdbarch);
 236
 237     lai->string_char_type = builtin->builtin_char;
 238     lai->primitive_type_vector
 239       = GDBARCH_OBSTACK_CALLOC (gdbarch, nr_m2_primitive_types + 1,
 240                                 struct type *);
 241
 242     lai->primitive_type_vector [m2_primitive_type_char]
 243       = builtin->builtin_char;
 244     lai->primitive_type_vector [m2_primitive_type_int]
 245       = builtin->builtin_int;
 246     lai->primitive_type_vector [m2_primitive_type_card]
 247       = builtin->builtin_card;
 248     lai->primitive_type_vector [m2_primitive_type_real]
 249       = builtin->builtin_real;
 250     lai->primitive_type_vector [m2_primitive_type_bool]
 251       = builtin->builtin_bool;
 252
 253     lai->bool_type_symbol = "BOOLEAN";
 254     lai->bool_type_default = builtin->builtin_bool;
 255   }
 256
 257   /* See language.h.  */
 258
 259   void print_type (struct type *type, const char *varstring,
 260                    struct ui_file *stream, int show, int level,
 261                    const struct type_print_options *flags) const override
 262   {
 263     m2_print_type (type, varstring, stream, show, level, flags);
 264   }
 265
 266   /* See language.h.  */
 267
 268   void value_print_inner
 269         (struct value *val, struct ui_file *stream, int recurse,
 270          const struct value_print_options *options) const override
 271   {
 272     return m2_value_print_inner (val, stream, recurse, options);
 273   }
 274
 275   /* See language.h.  */
 276
 277   int parser (struct parser_state *ps) const override
 278   {
 279     return m2_parse (ps);
 280   }
 281
 282   /* See language.h.  */
 283
 284   void emitchar (int ch, struct type *chtype,
 285                  struct ui_file *stream, int quoter) const override
 286   {
 287     ch &= 0xFF;                 /* Avoid sign bit follies.  */
 288
 289     if (PRINT_LITERAL_FORM (ch))
 290       {
 291         if (ch == '\\' || ch == quoter)
 292           fputs_filtered ("\\", stream);
 293         fprintf_filtered (stream, "%c", ch);
 294       }
 295     else
 296       {
 297         switch (ch)
 298           {
 299           case '\n':
 300             fputs_filtered ("\\n", stream);
 301             break;
 302           case '\b':
 303             fputs_filtered ("\\b", stream);
 304             break;
 305           case '\t':
 306             fputs_filtered ("\\t", stream);
 307             break;
 308           case '\f':
 309             fputs_filtered ("\\f", stream);
 310             break;
 311           case '\r':
 312             fputs_filtered ("\\r", stream);
 313             break;
 314           case '\033':
 315             fputs_filtered ("\\e", stream);
 316             break;
 317           case '\007':
 318             fputs_filtered ("\\a", stream);
 319             break;
 320           default:
 321             fprintf_filtered (stream, "\\%.3o", (unsigned int) ch);
 322             break;
 323           }
 324       }
 325   }
 326
 327   /* See language.h.  */
 328
 329   void printchar (int ch, struct type *chtype,
 330                   struct ui_file *stream) const override
 331   {
 332     m2_printchar (ch, chtype, stream);
 333   }
 334
 335   /* See language.h.  */
 336
 337   void printstr (struct ui_file *stream, struct type *elttype,
 338                  const gdb_byte *string, unsigned int length,
 339                  const char *encoding, int force_ellipses,
 340                  const struct value_print_options *options) const override
 341   {
 342     unsigned int i;
 343     unsigned int things_printed = 0;
 344     int in_quotes = 0;
 345     int need_comma = 0;
 346
 347     if (length == 0)
 348       {
 349         fputs_filtered ("\"\"", gdb_stdout);
 350         return;
 351       }
 352
 353     for (i = 0; i < length && things_printed < options->print_max; ++i)
 354       {
 355         /* Position of the character we are examining
 356            to see whether it is repeated.  */
 357         unsigned int rep1;
 358         /* Number of repetitions we have detected so far.  */
 359         unsigned int reps;
 360
 361         QUIT;
 362
 363         if (need_comma)
 364           {
 365             fputs_filtered (", ", stream);
 366             need_comma = 0;
 367           }
 368
 369         rep1 = i + 1;
 370         reps = 1;
 371         while (rep1 < length && string[rep1] == string[i])
 372           {
 373             ++rep1;
 374             ++reps;
 375           }
 376
 377         if (reps > options->repeat_count_threshold)
 378           {
 379             if (in_quotes)
 380               {
 381                 fputs_filtered ("\", ", stream);
 382                 in_quotes = 0;
 383               }
 384             m2_printchar (string[i], elttype, stream);
 385             fprintf_filtered (stream, " <repeats %u times>", reps);
 386             i = rep1 - 1;
 387             things_printed += options->repeat_count_threshold;
 388             need_comma = 1;
 389           }
 390         else
 391           {
 392             if (!in_quotes)
 393               {
 394                 fputs_filtered ("\"", stream);
 395                 in_quotes = 1;
 396               }
 397             LA_EMIT_CHAR (string[i], elttype, stream, '"');
 398             ++things_printed;
 399           }
 400       }
 401
 402     /* Terminate the quotes if necessary.  */
 403     if (in_quotes)
 404       fputs_filtered ("\"", stream);
 405
 406     if (force_ellipses || i < length)
 407       fputs_filtered ("...", stream);
 408   }
 409
 410   /* See language.h.  */
 411
 412   void print_typedef (struct type *type, struct symbol *new_symbol,
 413                       struct ui_file *stream) const override
 414   {
 415     m2_print_typedef (type, new_symbol, stream);
 416   }
 417
 418   /* See language.h.  */
 419
 420   bool is_string_type_p (struct type *type) const override
 421   {
 422     type = check_typedef (type);
 423     if (type->code () == TYPE_CODE_ARRAY
 424         && TYPE_LENGTH (type) > 0
 425         && TYPE_LENGTH (TYPE_TARGET_TYPE (type)) > 0)
 426       {
 427         struct type *elttype = check_typedef (TYPE_TARGET_TYPE (type));
 428
 429         if (TYPE_LENGTH (elttype) == 1
 430             && (elttype->code () == TYPE_CODE_INT
 431                 || elttype->code () == TYPE_CODE_CHAR))
 432           return true;
 433       }
 434
 435     return false;
 436   }
 437
 438   /* See language.h.  */
 439
 440   bool c_style_arrays_p () const override
 441   { return false; }
 442
 443   /* See language.h.  Despite not having C-style arrays, Modula-2 uses 0
 444      for its string lower bounds.  */
 445
 446   char string_lower_bound () const override
 447   { return 0; }
 448 };
 449
 450 /* Single instance of the M2 language.  */
 451
 452 static m2_language m2_language_defn;
 453
 454 static void *
 455 build_m2_types (struct gdbarch *gdbarch)
 456 {
 457   struct builtin_m2_type *builtin_m2_type
 458     = GDBARCH_OBSTACK_ZALLOC (gdbarch, struct builtin_m2_type);
 459
 460   /* Modula-2 "pervasive" types.  NOTE:  these can be redefined!!! */
 461   builtin_m2_type->builtin_int
 462     = arch_integer_type (gdbarch, gdbarch_int_bit (gdbarch), 0, "INTEGER");
 463   builtin_m2_type->builtin_card
 464     = arch_integer_type (gdbarch, gdbarch_int_bit (gdbarch), 1, "CARDINAL");
 465   builtin_m2_type->builtin_real
 466     = arch_float_type (gdbarch, gdbarch_float_bit (gdbarch), "REAL",
 467                        gdbarch_float_format (gdbarch));
 468   builtin_m2_type->builtin_char
 469     = arch_character_type (gdbarch, TARGET_CHAR_BIT, 1, "CHAR");
 470   builtin_m2_type->builtin_bool
 471     = arch_boolean_type (gdbarch, gdbarch_int_bit (gdbarch), 1, "BOOLEAN");
 472
 473   return builtin_m2_type;
 474 }
 475
 476 static struct gdbarch_data *m2_type_data;
 477
 478 const struct builtin_m2_type *
 479 builtin_m2_type (struct gdbarch *gdbarch)
 480 {
 481   return (const struct builtin_m2_type *) gdbarch_data (gdbarch, m2_type_data);
 482 }
 483
 484
 485 /* Initialization for Modula-2 */
 486
 487 void _initialize_m2_language ();
 488 void
 489 _initialize_m2_language ()
 490 {
 491   m2_type_data = gdbarch_data_register_post_init (build_m2_types);
 492 }