src/muscle-tab.c

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