src/muscle-tab.c

   1 /* Muscle table manager for Bison.
   2
   3    Copyright (C) 2001-2013 Free Software Foundation, Inc.
   4
   5    This file is part of Bison, the GNU Compiler Compiler.
   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 <config.h>
  21 #include "system.h"
  22
  23 #include <hash.h>
  24
  25 #include "complain.h"
  26 #include "files.h"
  27 #include "getargs.h"
  28 #include "muscle-tab.h"
  29 #include "quote.h"
  30
  31 muscle_kind
  32 muscle_kind_new (char const *k)
  33 {
  34   if (STREQ (k, "code"))
  35     return muscle_code;
  36   else if (STREQ (k, "keyword"))
  37     return muscle_keyword;
  38   else if (STREQ (k, "string"))
  39     return muscle_string;
  40   aver (0);
  41 }
  42
  43 char const *
  44 muscle_kind_string (muscle_kind k)
  45 {
  46   switch (k)
  47     {
  48     case muscle_code:    return "code";
  49     case muscle_keyword: return "keyword";
  50     case muscle_string:  return "string";
  51     }
  52   aver (0);
  53 }
  54
  55
  56 /* A key-value pair, along with storage that can be reclaimed when
  57    this pair is no longer needed.  */
  58 typedef struct
  59 {
  60   char const *key;
  61   char const *value;
  62   char *storage;
  63   muscle_kind kind;
  64 } muscle_entry;
  65
  66
  67 /* The name of muscle for the %define variable VAR (corresponding to
  68    FIELD, if defined).  */
  69 static uniqstr
  70 muscle_name (char const *var, char const *field)
  71 {
  72   if (field)
  73     return UNIQSTR_CONCAT ("percent_define_", field, "(", var, ")");
  74   else
  75     return UNIQSTR_CONCAT ("percent_define(", var, ")");
  76 }
  77
  78 /* An obstack used to create some entries.  */
  79 struct obstack muscle_obstack;
  80
  81 /* Initial capacity of muscles hash table.  */
  82 #define HT_INITIAL_CAPACITY 257
  83
  84 static struct hash_table *muscle_table = NULL;
  85
  86 static bool
  87 hash_compare_muscles (void const *x, void const *y)
  88 {
  89   muscle_entry const *m1 = x;
  90   muscle_entry const *m2 = y;
  91   return STREQ (m1->key, m2->key);
  92 }
  93
  94 static size_t
  95 hash_muscle (const void *x, size_t tablesize)
  96 {
  97   muscle_entry const *m = x;
  98   return hash_string (m->key, tablesize);
  99 }
 100
 101 /* Create a fresh muscle name KEY, and insert in the hash table.  */
 102 static void *
 103 muscle_entry_new (char const *key)
 104 {
 105   muscle_entry *res = xmalloc (sizeof *res);
 106   res->key = key;
 107   res->value = NULL;
 108   res->storage = NULL;
 109   if (!hash_insert (muscle_table, res))
 110     xalloc_die ();
 111   return res;
 112 }
 113
 114 static void
 115 muscle_entry_free (void *entry)
 116 {
 117   muscle_entry *mentry = entry;
 118   free (mentry->storage);
 119   free (mentry);
 120 }
 121
 122 void
 123 muscle_init (void)
 124 {
 125   /* Initialize the muscle obstack.  */
 126   obstack_init (&muscle_obstack);
 127
 128   muscle_table = hash_initialize (HT_INITIAL_CAPACITY, NULL, hash_muscle,
 129                                   hash_compare_muscles, muscle_entry_free);
 130
 131   /* Version and input file.  */
 132   MUSCLE_INSERT_STRING ("version", VERSION);
 133 }
 134
 135
 136 void
 137 muscle_free (void)
 138 {
 139   hash_free (muscle_table);
 140   obstack_free (&muscle_obstack, NULL);
 141 }
 142
 143 /* Look for the muscle named KEY.  Return NULL if does not exist.  */
 144 static
 145 muscle_entry *
 146 muscle_lookup (char const *key)
 147 {
 148   muscle_entry probe;
 149   probe.key = key;
 150   return hash_lookup (muscle_table, &probe);
 151 }
 152
 153
 154 void
 155 muscle_insert (char const *key, char const *value)
 156 {
 157   muscle_entry *entry = muscle_lookup (key);
 158   if (entry)
 159     free (entry->storage);
 160   else
 161     /* First insertion in the hash. */
 162     entry = muscle_entry_new (key);
 163   entry->value = value;
 164   entry->storage = NULL;
 165 }
 166
 167
 168 /* Append VALUE to the current value of KEY.  If KEY did not already
 169    exist, create it.  Use MUSCLE_OBSTACK.  De-allocate the previously
 170    associated value.  Copy VALUE and SEPARATOR.  If VALUE does not end
 171    with TERMINATOR, append one.  */
 172
 173 static void
 174 muscle_grow (const char *key, const char *val,
 175              const char *separator, const char *terminator)
 176 {
 177   muscle_entry *entry = muscle_lookup (key);
 178   size_t vals = strlen (val);
 179   size_t terms = strlen (terminator);
 180
 181   if (entry)
 182     {
 183       obstack_sgrow (&muscle_obstack, entry->value);
 184       obstack_sgrow (&muscle_obstack, separator);
 185       free (entry->storage);
 186     }
 187   else
 188     entry = muscle_entry_new (key);
 189
 190   obstack_sgrow (&muscle_obstack, val);
 191
 192   if (terms <= vals
 193       && STRNEQ (val + vals - terms, terminator))
 194     obstack_sgrow (&muscle_obstack, terminator);
 195
 196   {
 197     char *new_val = obstack_finish0 (&muscle_obstack);
 198     entry->value = entry->storage = xstrdup (new_val);
 199     obstack_free (&muscle_obstack, new_val);
 200   }
 201 }
 202
 203 /*------------------------------------------------------------------.
 204 | Using muscle_grow, append a synchronization line for the location |
 205 | LOC to the current value of KEY.                                  |
 206 `------------------------------------------------------------------*/
 207
 208 static void
 209 muscle_syncline_grow (char const *key, location loc)
 210 {
 211   char *extension = NULL;
 212   obstack_printf (&muscle_obstack, "]b4_syncline(%d, ", loc.start.line);
 213   obstack_quote (&muscle_obstack,
 214                  quotearg_style (c_quoting_style, loc.start.file));
 215   obstack_sgrow (&muscle_obstack, ")[");
 216   extension = obstack_finish0 (&muscle_obstack);
 217   muscle_grow (key, extension, "", "");
 218   obstack_free (&muscle_obstack, extension);
 219 }
 220
 221 /*------------------------------------------------------------------.
 222 | Append VALUE to the current value of KEY, using muscle_grow.  But |
 223 | in addition, issue a synchronization line for the location LOC    |
 224 | using muscle_syncline_grow.                                       |
 225 `------------------------------------------------------------------*/
 226
 227 void
 228 muscle_code_grow (const char *key, const char *val, location loc)
 229 {
 230   muscle_syncline_grow (key, loc);
 231   muscle_grow (key, val, "\n", "\n");
 232 }
 233
 234
 235 void
 236 muscle_pair_list_grow (const char *muscle,
 237                        const char *a1, const char *a2)
 238 {
 239   char *pair;
 240   obstack_sgrow (&muscle_obstack, "[");
 241   obstack_quote (&muscle_obstack, a1);
 242   obstack_sgrow (&muscle_obstack, ", ");
 243   obstack_quote (&muscle_obstack, a2);
 244   obstack_sgrow (&muscle_obstack, "]");
 245   pair = obstack_finish0 (&muscle_obstack);
 246   muscle_grow (muscle, pair, ",\n", "");
 247   obstack_free (&muscle_obstack, pair);
 248 }
 249
 250
 251 char const *
 252 muscle_find_const (char const *key)
 253 {
 254   muscle_entry *entry = muscle_lookup (key);
 255   return entry ? entry->value : NULL;
 256 }
 257
 258
 259 char *
 260 muscle_find (char const *key)
 261 {
 262   muscle_entry *entry = muscle_lookup (key);
 263   if (entry)
 264     {
 265       aver (entry->value == entry->storage);
 266       return entry->storage;
 267     }
 268   return NULL;
 269 }
 270
 271
 272 /* In the format 'file_name:line.column', append BOUND to MUSCLE.  Use
 273    digraphs for special characters in the file name.  */
 274
 275 static void
 276 muscle_boundary_grow (char const *key, boundary bound)
 277 {
 278   char *extension;
 279   obstack_sgrow  (&muscle_obstack, "[[");
 280   obstack_escape (&muscle_obstack, bound.file);
 281   obstack_printf (&muscle_obstack, ":%d.%d]]", bound.line, bound.column);
 282   extension = obstack_finish0 (&muscle_obstack);
 283   muscle_grow (key, extension, "", "");
 284   obstack_free (&muscle_obstack, extension);
 285 }
 286
 287
 288 /* In the format '[[file_name:line.column]], [[file_name:line.column]]',
 289    append LOC to MUSCLE.  Use digraphs for special characters in each
 290    file name.  */
 291
 292 static void
 293 muscle_location_grow (char const *key, location loc)
 294 {
 295   muscle_boundary_grow (key, loc.start);
 296   muscle_grow (key, "", ", ", "");
 297   muscle_boundary_grow (key, loc.end);
 298 }
 299
 300 #define COMMON_DECODE(Value)                                    \
 301   case '$':                                                     \
 302     aver (*++(Value) == ']');                                   \
 303     aver (*++(Value) == '[');                                   \
 304     obstack_sgrow (&muscle_obstack, "$");                       \
 305     break;                                                      \
 306   case '@':                                                     \
 307     switch (*++(Value))                                         \
 308       {                                                         \
 309         case '@': obstack_sgrow (&muscle_obstack, "@" ); break; \
 310         case '{': obstack_sgrow (&muscle_obstack, "[" ); break; \
 311         case '}': obstack_sgrow (&muscle_obstack, "]" ); break; \
 312         default: aver (false); break;                           \
 313       }                                                         \
 314     break;                                                      \
 315   default:                                                      \
 316     obstack_1grow (&muscle_obstack, *(Value));                  \
 317     break;
 318
 319 /* Reverse of obstack_escape.  */
 320 static char *
 321 string_decode (char const *key)
 322 {
 323   char const *value = muscle_find_const (key);
 324   char *value_decoded;
 325   char *result;
 326
 327   if (!value)
 328     return NULL;
 329   do {
 330     switch (*value)
 331       {
 332         COMMON_DECODE (value)
 333         case '[':
 334         case ']':
 335           aver (false);
 336           break;
 337       }
 338   } while (*value++);
 339   value_decoded = obstack_finish (&muscle_obstack);
 340   result = xstrdup (value_decoded);
 341   obstack_free (&muscle_obstack, value_decoded);
 342   return result;
 343 }
 344
 345 /* Reverse of muscle_location_grow.  */
 346 static location
 347 location_decode (char const *key)
 348 {
 349   location loc;
 350   char const *value = muscle_find_const (key);
 351   aver (value);
 352   aver (*value == '[');
 353   aver (*++value == '[');
 354   while (*++value)
 355     switch (*value)
 356       {
 357         COMMON_DECODE (value)
 358         case '[':
 359           aver (false);
 360           break;
 361         case ']':
 362           {
 363             char *boundary_str;
 364             aver (*++value == ']');
 365             boundary_str = obstack_finish0 (&muscle_obstack);
 366             switch (*++value)
 367               {
 368                 case ',':
 369                   boundary_set_from_string (&loc.start, boundary_str);
 370                   obstack_free (&muscle_obstack, boundary_str);
 371                   aver (*++value == ' ');
 372                   aver (*++value == '[');
 373                   aver (*++value == '[');
 374                   break;
 375                 case '\0':
 376                   boundary_set_from_string (&loc.end, boundary_str);
 377                   obstack_free (&muscle_obstack, boundary_str);
 378                   return loc;
 379                   break;
 380                 default:
 381                   aver (false);
 382                   break;
 383               }
 384           }
 385           break;
 386       }
 387   aver (false);
 388   return loc;
 389 }
 390
 391 void
 392 muscle_user_name_list_grow (char const *key, char const *user_name,
 393                             location loc)
 394 {
 395   muscle_grow (key, "[[[[", ",", "");
 396   muscle_grow (key, user_name, "", "");
 397   muscle_grow (key, "]], ", "", "");
 398   muscle_location_grow (key, loc);
 399   muscle_grow (key, "]]", "", "");
 400 }
 401
 402
 403 /** Return an allocated string that represents the %define directive
 404     that performs the assignment.
 405
 406     @param assignment "VAR", or "VAR=VAL".
 407     @param value      default value if VAL \a assignment has no '='.
 408
 409     For instance:
 410     "foo", NULL      => "%define foo"
 411     "foo", "baz"     => "%define foo baz"
 412     "foo=bar", NULL  => "%define foo bar"
 413     "foo=bar", "baz" => "%define foo bar"
 414     "foo=", NULL     => "%define foo"
 415     "foo=", "baz"    => "%define foo"
 416  */
 417
 418 static
 419 char *
 420 define_directive (char const *assignment, char const *value)
 421 {
 422   char *eq = strchr (assignment, '=');
 423   char const *fmt = !eq && value && *value ? "%%define %s %s" : "%%define %s";
 424   char *res = xmalloc (strlen (fmt) + strlen (assignment)
 425                        + (value ? strlen (value) : 0));
 426   sprintf (res, fmt, assignment, value);
 427   eq = strchr (res, '=');
 428   if (eq)
 429     *eq = eq[1] ? ' ' : '\0';
 430   return res;
 431 }
 432
 433 /** If the \a variable name is obsolete, return the name to use,
 434  * otherwise \a variable.  If the \a value is obsolete, update it too.
 435  *
 436  * Allocates the returned value.  */
 437 static
 438 char *
 439 muscle_percent_variable_update (char const *variable, location variable_loc,
 440                                 char const **value)
 441 {
 442   typedef struct
 443   {
 444     const char *obsolete;
 445     const char *updated;
 446   } conversion_type;
 447   const conversion_type conversion[] =
 448     {
 449       { "api.push_pull", "api.push-pull", },
 450       { "api.tokens.prefix", "api.token.prefix", },
 451       { "lex_symbol", "api.token.constructor", },
 452       { "location_type", "api.location.type", },
 453       { "lr.default-reductions", "lr.default-reduction", },
 454       { "lr.keep-unreachable-states", "lr.keep-unreachable-state", },
 455       { "lr.keep_unreachable_states", "lr.keep-unreachable-state", },
 456       { "namespace", "api.namespace", },
 457       { "stype", "api.value.type", },
 458       { "variant=",     "api.value.type=variant", },
 459       { "variant=true", "api.value.type=variant", },
 460       { NULL, NULL, }
 461     };
 462   conversion_type const *c;
 463   for (c = conversion; c->obsolete; ++c)
 464     {
 465       char const *eq = strchr (c->obsolete, '=');
 466       if (eq
 467           ? (!strncmp (c->obsolete, variable, eq - c->obsolete)
 468              && STREQ (eq + 1, *value))
 469           : STREQ (c->obsolete, variable))
 470         {
 471           char *old = define_directive (c->obsolete, *value);
 472           char *upd = define_directive (c->updated, *value);
 473           deprecated_directive (&variable_loc, old, upd);
 474           free (old);
 475           free (upd);
 476           char *res = xstrdup (c->updated);
 477           {
 478             char *eq2 = strchr (res, '=');
 479             if (eq2)
 480               {
 481                 *eq2 = '\0';
 482                 *value = eq2 + 1;
 483               }
 484           }
 485           return res;
 486         }
 487     }
 488   return xstrdup (variable);
 489 }
 490
 491 void
 492 muscle_percent_define_insert (char const *var, location variable_loc,
 493                               muscle_kind kind,
 494                               char const *value,
 495                               muscle_percent_define_how how)
 496 {
 497   /* Backward compatibility.  */
 498   char *variable = muscle_percent_variable_update (var, variable_loc, &value);
 499   uniqstr name = muscle_name (variable, NULL);
 500   uniqstr loc_name = muscle_name (variable, "loc");
 501   uniqstr syncline_name = muscle_name (variable, "syncline");
 502   uniqstr how_name = muscle_name (variable, "how");
 503   uniqstr kind_name = muscle_name (variable, "kind");
 504
 505   /* Command-line options are processed before the grammar file.  */
 506   if (how == MUSCLE_PERCENT_DEFINE_GRAMMAR_FILE
 507       && muscle_find_const (name))
 508     {
 509       muscle_percent_define_how how_old = atoi (muscle_find_const (how_name));
 510       unsigned i = 0;
 511       if (how_old == MUSCLE_PERCENT_DEFINE_F)
 512         goto end;
 513       complain_indent (&variable_loc, complaint, &i,
 514                        _("%%define variable %s redefined"),
 515                        quote (variable));
 516       i += SUB_INDENT;
 517       location loc = muscle_percent_define_get_loc (variable);
 518       complain_indent (&loc, complaint, &i, _("previous definition"));
 519     }
 520
 521   MUSCLE_INSERT_STRING (name, value);
 522   muscle_insert (loc_name, "");
 523   muscle_location_grow (loc_name, variable_loc);
 524   muscle_insert (syncline_name, "");
 525   muscle_syncline_grow (syncline_name, variable_loc);
 526   muscle_user_name_list_grow ("percent_define_user_variables", variable,
 527                               variable_loc);
 528   MUSCLE_INSERT_INT (how_name, how);
 529   MUSCLE_INSERT_STRING (kind_name, muscle_kind_string (kind));
 530  end:
 531   free (variable);
 532 }
 533
 534 /* This is used for backward compatibility, e.g., "%define api.pure"
 535    supersedes "%pure-parser".  */
 536 void
 537 muscle_percent_define_ensure (char const *variable, location loc,
 538                               bool value)
 539 {
 540   uniqstr name = muscle_name (variable, NULL);
 541   char const *val = value ? "" : "false";
 542
 543   /* Don't complain is VARIABLE is already defined, but be sure to set
 544      its value to VAL.  */
 545   if (!muscle_find_const (name))
 546     muscle_percent_define_insert (variable, loc, muscle_keyword, val,
 547                                   MUSCLE_PERCENT_DEFINE_GRAMMAR_FILE);
 548   if (muscle_percent_define_flag_if (variable) != value)
 549     muscle_percent_define_insert (variable, loc, muscle_keyword, val,
 550                                   MUSCLE_PERCENT_DEFINE_GRAMMAR_FILE);
 551 }
 552
 553 char *
 554 muscle_percent_define_get (char const *variable)
 555 {
 556   uniqstr name = muscle_name (variable, NULL);
 557   uniqstr usage_name = muscle_name (variable, "bison_variables");
 558   char *value = string_decode (name);
 559   if (!value)
 560     value = xstrdup ("");
 561
 562   muscle_insert (usage_name, "");
 563   return value;
 564 }
 565
 566 location
 567 muscle_percent_define_get_loc (char const *variable)
 568 {
 569   uniqstr loc_name = muscle_name (variable, "loc");
 570   if (!muscle_find_const (loc_name))
 571     complain (NULL, fatal, _("%s: undefined %%define variable %s"),
 572               "muscle_percent_define_get_loc", quote (variable));
 573   return location_decode (loc_name);
 574 }
 575
 576 char const *
 577 muscle_percent_define_get_syncline (char const *variable)
 578 {
 579   uniqstr syncline_name = muscle_name (variable, "syncline");
 580   char const *syncline = muscle_find_const (syncline_name);
 581   if (!syncline)
 582     complain (NULL, fatal, _("%s: undefined %%define variable %s"),
 583               "muscle_percent_define_get_syncline", quote (variable));
 584   return syncline;
 585 }
 586
 587 bool
 588 muscle_percent_define_ifdef (char const *variable)
 589 {
 590   char const *value = muscle_find_const (muscle_name (variable, NULL));
 591   if (value)
 592     {
 593       uniqstr usage_name = muscle_name (variable, "bison_variables");
 594       muscle_insert (usage_name, "");
 595       return true;
 596     }
 597
 598   return false;
 599 }
 600
 601 bool
 602 muscle_percent_define_flag_if (char const *variable)
 603 {
 604   uniqstr invalid_boolean_name = muscle_name (variable, "invalid_boolean");
 605   bool result = false;
 606
 607   if (muscle_percent_define_ifdef (variable))
 608     {
 609       char *value = muscle_percent_define_get (variable);
 610       if (value[0] == '\0' || STREQ (value, "true"))
 611         result = true;
 612       else if (STREQ (value, "false"))
 613         result = false;
 614       else if (!muscle_find_const (invalid_boolean_name))
 615         {
 616           muscle_insert (invalid_boolean_name, "");
 617           location loc = muscle_percent_define_get_loc (variable);
 618           complain (&loc, complaint,
 619                     _("invalid value for %%define Boolean variable %s"),
 620                     quote (variable));
 621         }
 622       free (value);
 623     }
 624   else
 625     complain (NULL, fatal, _("%s: undefined %%define variable %s"),
 626               "muscle_percent_define_flag", quote (variable));
 627
 628   return result;
 629 }
 630
 631 void
 632 muscle_percent_define_default (char const *variable, char const *value)
 633 {
 634   uniqstr name = muscle_name (variable, NULL);
 635   uniqstr loc_name = muscle_name (variable, "loc");
 636   uniqstr syncline_name = muscle_name (variable, "syncline");
 637   if (!muscle_find_const (name))
 638     {
 639       location loc;
 640       MUSCLE_INSERT_STRING (name, value);
 641       loc.start.file = loc.end.file = "<default value>";
 642       loc.start.line = loc.end.line = -1;
 643       loc.start.column = loc.end.column = -1;
 644       muscle_insert (loc_name, "");
 645       muscle_location_grow (loc_name, loc);
 646       muscle_insert (syncline_name, "");
 647     }
 648 }
 649
 650 void
 651 muscle_percent_define_check_values (char const * const *values)
 652 {
 653   for (; *values; ++values)
 654     {
 655       char const * const *variablep = values;
 656       uniqstr name = muscle_name (*variablep, NULL);
 657       char *value = string_decode (name);
 658       if (value)
 659         {
 660           for (++values; *values; ++values)
 661             {
 662               if (STREQ (value, *values))
 663                 break;
 664             }
 665           if (!*values)
 666             {
 667               unsigned i = 0;
 668               location loc = muscle_percent_define_get_loc (*variablep);
 669               complain_indent (&loc, complaint, &i,
 670                                _("invalid value for %%define variable %s: %s"),
 671                                quote (*variablep), quote_n (1, value));
 672               i += SUB_INDENT;
 673               for (values = variablep + 1; *values; ++values)
 674                 complain_indent (&loc, complaint | no_caret | silent, &i,
 675                                  _("accepted value: %s"), quote (*values));
 676             }
 677           else
 678             {
 679               while (*values)
 680                 ++values;
 681             }
 682           free (value);
 683         }
 684       else
 685         complain (NULL, fatal, _("%s: undefined %%define variable %s"),
 686                   "muscle_percent_define_check_values", quote (*variablep));
 687     }
 688 }
 689
 690 void
 691 muscle_percent_code_grow (char const *qualifier, location qualifier_loc,
 692                           char const *code, location code_loc)
 693 {
 694   char const *name = UNIQSTR_CONCAT ("percent_code(", qualifier, ")");
 695   muscle_code_grow (name, code, code_loc);
 696   muscle_user_name_list_grow ("percent_code_user_qualifiers", qualifier,
 697                                qualifier_loc);
 698 }
 699
 700
 701 /*------------------------------------------------.
 702 | Output the definition of ENTRY as a m4_define.  |
 703 `------------------------------------------------*/
 704
 705 static inline bool
 706 muscle_m4_output (muscle_entry *entry, FILE *out)
 707 {
 708   fprintf (out,
 709            "m4_define([b4_%s],\n"
 710            "[[%s]])\n\n\n", entry->key, entry->value);
 711   return true;
 712 }
 713
 714 static bool
 715 muscle_m4_output_processor (void *entry, void *out)
 716 {
 717   return muscle_m4_output (entry, out);
 718 }
 719
 720
 721 void
 722 muscles_m4_output (FILE *out)
 723 {
 724   hash_do_for_each (muscle_table, muscle_m4_output_processor, out);
 725 }