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       hash_insert (muscle_table, entry);
 124     }
 125   else
 126     free (entry->storage);
 127   entry->value = value;
 128   entry->storage = NULL;
 129 }
 130
 131
 132 /*-------------------------------------------------------------------.
 133 | Append VALUE to the current value of KEY.  If KEY did not already  |
 134 | exist, create it.  Use MUSCLE_OBSTACK.  De-allocate the previously |
 135 | associated value.  Copy VALUE and SEPARATOR.                       |
 136 `-------------------------------------------------------------------*/
 137
 138 void
 139 muscle_grow (const char *key, const char *val, const char *separator)
 140 {
 141   muscle_entry probe;
 142   muscle_entry *entry = NULL;
 143
 144   probe.key = key;
 145   entry = hash_lookup (muscle_table, &probe);
 146
 147   if (!entry)
 148     {
 149       /* First insertion in the hash. */
 150       entry = xmalloc (sizeof *entry);
 151       entry->key = key;
 152       hash_insert (muscle_table, entry);
 153       entry->value = entry->storage = xstrdup (val);
 154     }
 155   else
 156     {
 157       /* Grow the current value. */
 158       char *new_val;
 159       obstack_sgrow (&muscle_obstack, entry->value);
 160       free (entry->storage);
 161       obstack_sgrow (&muscle_obstack, separator);
 162       obstack_sgrow (&muscle_obstack, val);
 163       obstack_1grow (&muscle_obstack, 0);
 164       new_val = obstack_finish (&muscle_obstack);
 165       entry->value = entry->storage = xstrdup (new_val);
 166       obstack_free (&muscle_obstack, new_val);
 167     }
 168 }
 169
 170 /*------------------------------------------------------------------.
 171 | Using muscle_grow, append a synchronization line for the location |
 172 | LOC to the current value of KEY.                                  |
 173 `------------------------------------------------------------------*/
 174
 175 static void
 176 muscle_syncline_grow (char const *key, location loc)
 177 {
 178   char *extension = NULL;
 179   obstack_fgrow1 (&muscle_obstack, "]b4_syncline(%d, [[", loc.start.line);
 180   MUSCLE_OBSTACK_SGROW (&muscle_obstack,
 181                         quotearg_style (c_quoting_style, loc.start.file));
 182   obstack_sgrow (&muscle_obstack, "]])[");
 183   obstack_1grow (&muscle_obstack, 0);
 184   extension = obstack_finish (&muscle_obstack);
 185   muscle_grow (key, extension, "");
 186   obstack_free (&muscle_obstack, extension);
 187 }
 188
 189 /*------------------------------------------------------------------.
 190 | Append VALUE to the current value of KEY, using muscle_grow.  But |
 191 | in addition, issue a synchronization line for the location LOC    |
 192 | using muscle_syncline_grow.                                       |
 193 `------------------------------------------------------------------*/
 194
 195 void
 196 muscle_code_grow (const char *key, const char *val, location loc)
 197 {
 198   muscle_syncline_grow (key, loc);
 199   muscle_grow (key, val, "\n");
 200 }
 201
 202
 203 void muscle_pair_list_grow (const char *muscle,
 204                             const char *a1, const char *a2)
 205 {
 206   char *pair;
 207   obstack_sgrow (&muscle_obstack, "[[[");
 208   MUSCLE_OBSTACK_SGROW (&muscle_obstack, a1);
 209   obstack_sgrow (&muscle_obstack, "]], [[");
 210   MUSCLE_OBSTACK_SGROW (&muscle_obstack, a2);
 211   obstack_sgrow (&muscle_obstack, "]]]");
 212   obstack_1grow (&muscle_obstack, 0);
 213   pair = obstack_finish (&muscle_obstack);
 214   muscle_grow (muscle, pair, ",\n");
 215   obstack_free (&muscle_obstack, pair);
 216 }
 217
 218
 219 /*----------------------------------------------------------------------------.
 220 | Find the value of muscle KEY.  Unlike MUSCLE_FIND, this is always reliable  |
 221 | to determine whether KEY has a value.                                       |
 222 `----------------------------------------------------------------------------*/
 223
 224 char const *
 225 muscle_find_const (char const *key)
 226 {
 227   muscle_entry probe;
 228   muscle_entry *result = NULL;
 229
 230   probe.key = key;
 231   result = hash_lookup (muscle_table, &probe);
 232   if (result)
 233     return result->value;
 234   return NULL;
 235 }
 236
 237
 238 /*----------------------------------------------------------------------------.
 239 | Find the value of muscle KEY.  Abort if muscle_insert was invoked more      |
 240 | recently than muscle_grow for KEY since muscle_find can't return a          |
 241 | char const *.                                                               |
 242 `----------------------------------------------------------------------------*/
 243
 244 char *
 245 muscle_find (char const *key)
 246 {
 247   muscle_entry probe;
 248   muscle_entry *result = NULL;
 249
 250   probe.key = key;
 251   result = hash_lookup (muscle_table, &probe);
 252   if (result)
 253     {
 254       aver (result->value == result->storage);
 255       return result->storage;
 256     }
 257   return NULL;
 258 }
 259
 260
 261 void
 262 muscle_boundary_grow (char const *key, boundary bound)
 263 {
 264   char *extension;
 265   MUSCLE_OBSTACK_SGROW (&muscle_obstack, bound.file);
 266   obstack_1grow (&muscle_obstack, ':');
 267   obstack_fgrow1 (&muscle_obstack, "%d", bound.line);
 268   obstack_1grow (&muscle_obstack, '.');
 269   obstack_fgrow1 (&muscle_obstack, "%d", bound.column);
 270   obstack_1grow (&muscle_obstack, '\0');
 271   extension = obstack_finish (&muscle_obstack);
 272   muscle_grow (key, extension, "");
 273   obstack_free (&muscle_obstack, extension);
 274 }
 275
 276 void
 277 muscle_location_grow (char const *key, location loc)
 278 {
 279   muscle_grow (key, "[[", "");
 280   muscle_boundary_grow (key, loc.start);
 281   muscle_grow (key, "]], [[", "");
 282   muscle_boundary_grow (key, loc.end);
 283   muscle_grow (key, "]]", "");
 284 }
 285
 286 #define MUSCLE_COMMON_DECODE(Value)                                           \
 287   case '$':                                                                   \
 288     aver (*++(Value) == ']');                                                 \
 289     aver (*++(Value) == '[');                                                 \
 290     obstack_sgrow (&muscle_obstack, "$");                                     \
 291     break;                                                                    \
 292   case '@':                                                                   \
 293     switch (*++(Value))                                                       \
 294       {                                                                       \
 295         case '@': obstack_sgrow (&muscle_obstack, "@" ); break;               \
 296         case '{': obstack_sgrow (&muscle_obstack, "[" ); break;               \
 297         case '}': obstack_sgrow (&muscle_obstack, "]" ); break;               \
 298         default: aver (false); break;                                         \
 299       }                                                                       \
 300     break;                                                                    \
 301   default:                                                                    \
 302     obstack_1grow (&muscle_obstack, *(Value));                                \
 303     break;
 304
 305 /* Reverse of MUSCLE_OBSTACK_SGROW.  */
 306 static char *
 307 muscle_string_decode (char const *key)
 308 {
 309   char const *value;
 310   char *value_decoded;
 311   char *result;
 312
 313   value = muscle_find_const (key);
 314   if (!value)
 315     return NULL;
 316   do {
 317     switch (*value)
 318       {
 319         MUSCLE_COMMON_DECODE (value)
 320         case '[':
 321         case ']':
 322           aver (false);
 323           break;
 324       }
 325   } while (*value++);
 326   value_decoded = obstack_finish (&muscle_obstack);
 327   result = xstrdup (value_decoded);
 328   obstack_free (&muscle_obstack, value_decoded);
 329   return result;
 330 }
 331
 332 /* Reverse of muscle_location_grow.  */
 333 static location
 334 muscle_location_decode (char const *key)
 335 {
 336   location loc;
 337   char const *value = muscle_find_const (key);
 338   aver (value);
 339   aver (*value == '[');
 340   aver (*++value == '[');
 341   while (*++value)
 342     switch (*value)
 343       {
 344         MUSCLE_COMMON_DECODE (value)
 345         case '[':
 346           aver (false);
 347           break;
 348         case ']':
 349           {
 350             char *boundary_str;
 351             aver (*++value == ']');
 352             obstack_1grow (&muscle_obstack, '\0');
 353             boundary_str = obstack_finish (&muscle_obstack);
 354             switch (*++value)
 355               {
 356                 case ',':
 357                   boundary_set_from_string (&loc.start, boundary_str);
 358                   obstack_free (&muscle_obstack, boundary_str);
 359                   aver (*++value == ' ');
 360                   aver (*++value == '[');
 361                   aver (*++value == '[');
 362                   break;
 363                 case '\0':
 364                   boundary_set_from_string (&loc.end, boundary_str);
 365                   obstack_free (&muscle_obstack, boundary_str);
 366                   return loc;
 367                   break;
 368                 default:
 369                   aver (false);
 370                   break;
 371               }
 372           }
 373           break;
 374       }
 375   aver (false);
 376   return loc;
 377 }
 378
 379 void
 380 muscle_user_name_list_grow (char const *key, char const *user_name,
 381                             location loc)
 382 {
 383   muscle_grow (key, "[[[[", ",");
 384   muscle_grow (key, user_name, "");
 385   muscle_grow (key, "]], ", "");
 386   muscle_location_grow (key, loc);
 387   muscle_grow (key, "]]", "");
 388 }
 389
 390 #define MUSCLE_USER_NAME_CONVERT(NAME, PREFIX, USER_NAME, SUFFIX)    \
 391 do {                                                                 \
 392   char *tmp;                                                         \
 393   size_t length = strlen ((USER_NAME));                              \
 394   tmp = xmalloc (sizeof (PREFIX) - 1 + length + sizeof (SUFFIX));    \
 395   strcpy (tmp, (PREFIX));                                            \
 396   strcpy (tmp + sizeof (PREFIX) - 1, (USER_NAME));                   \
 397   strcpy (tmp + sizeof (PREFIX) - 1 + length, (SUFFIX));             \
 398   (NAME) = uniqstr_new (tmp);                                        \
 399   free (tmp);                                                        \
 400 } while (0)
 401
 402 void
 403 muscle_percent_define_insert (char const *variable, location variable_loc,
 404                               char const *value,
 405                               muscle_percent_define_how how)
 406 {
 407   char *variable_tr = NULL;
 408   char const *name;
 409   char const *loc_name;
 410   char const *syncline_name;
 411   char const *how_name;
 412
 413   /* Permit certain names with underscores for backward compatibility.  */
 414   if (0 == strcmp (variable, "api.push_pull")
 415       || 0 == strcmp (variable, "lr.keep_unreachable_states"))
 416     {
 417       variable_tr = strdup (variable);
 418       tr (variable_tr, '_', '-');
 419       variable = variable_tr;
 420     }
 421
 422   MUSCLE_USER_NAME_CONVERT (name, "percent_define(", variable, ")");
 423   MUSCLE_USER_NAME_CONVERT (loc_name, "percent_define_loc(", variable, ")");
 424   MUSCLE_USER_NAME_CONVERT (syncline_name,
 425                             "percent_define_syncline(", variable, ")");
 426   MUSCLE_USER_NAME_CONVERT (how_name, "percent_define_how(", variable, ")");
 427
 428   /* Command-line options are processed before the grammar file.  */
 429   if (how == MUSCLE_PERCENT_DEFINE_GRAMMAR_FILE
 430       && muscle_find_const (name))
 431     {
 432       muscle_percent_define_how how_old =
 433         atoi (muscle_find_const (how_name));
 434       if (how_old == MUSCLE_PERCENT_DEFINE_F)
 435         {
 436           free (variable_tr);
 437           return;
 438         }
 439       complain_at (variable_loc, _("%s `%s' redefined"),
 440                    "%define variable", variable);
 441       complain_at (muscle_percent_define_get_loc (variable),
 442                    _("previous definition"));
 443     }
 444
 445   MUSCLE_INSERT_STRING (name, value);
 446   muscle_insert (loc_name, "");
 447   muscle_location_grow (loc_name, variable_loc);
 448   muscle_insert (syncline_name, "");
 449   muscle_syncline_grow (syncline_name, variable_loc);
 450   muscle_user_name_list_grow ("percent_define_user_variables", variable,
 451                               variable_loc);
 452   MUSCLE_INSERT_INT (how_name, how);
 453
 454   free (variable_tr);
 455 }
 456
 457 /* This is used for backward compatibility, e.g., "%define api.pure"
 458    supersedes "%pure-parser".  */
 459 void
 460 muscle_percent_define_ensure (char const *variable, location loc,
 461                               bool value)
 462 {
 463   char const *val = value ? "" : "false";
 464   char const *name;
 465   MUSCLE_USER_NAME_CONVERT (name, "percent_define(", variable, ")");
 466
 467   /* %pure-parser is deprecated in favor of `%define api.pure', so use
 468      `%define api.pure' in a backward-compatible manner here.  First,
 469      don't complain if %pure-parser is specified multiple times.  */
 470   if (!muscle_find_const (name))
 471     muscle_percent_define_insert (variable, loc, val,
 472                                   MUSCLE_PERCENT_DEFINE_GRAMMAR_FILE);
 473   /* In all cases, use api.pure now so that the backend doesn't complain if
 474      the skeleton ignores api.pure, but do warn now if there's a previous
 475      conflicting definition from an actual %define.  */
 476   if (muscle_percent_define_flag_if (variable) != value)
 477     muscle_percent_define_insert (variable, loc, val,
 478                                   MUSCLE_PERCENT_DEFINE_GRAMMAR_FILE);
 479 }
 480
 481 char *
 482 muscle_percent_define_get (char const *variable)
 483 {
 484   char const *name;
 485   char const *usage_name;
 486   char *value;
 487
 488   MUSCLE_USER_NAME_CONVERT (name, "percent_define(", variable, ")");
 489   MUSCLE_USER_NAME_CONVERT (usage_name, "percent_define_bison_variables(",
 490                             variable, ")");
 491
 492   muscle_insert (usage_name, "");
 493   value = muscle_string_decode (name);
 494   if (!value)
 495     value = xstrdup ("");
 496   return value;
 497 }
 498
 499 location
 500 muscle_percent_define_get_loc (char const *variable)
 501 {
 502   char const *loc_name;
 503   MUSCLE_USER_NAME_CONVERT (loc_name, "percent_define_loc(", variable, ")");
 504   if (!muscle_find_const (loc_name))
 505     fatal(_("undefined %%define variable `%s' passed to muscle_percent_define_get_loc"),
 506           variable);
 507   return muscle_location_decode (loc_name);
 508 }
 509
 510 char const *
 511 muscle_percent_define_get_syncline (char const *variable)
 512 {
 513   char const *syncline_name;
 514   char const *syncline;
 515   MUSCLE_USER_NAME_CONVERT (syncline_name,
 516                             "percent_define_syncline(", variable, ")");
 517   syncline = muscle_find_const (syncline_name);
 518   if (!syncline)
 519     fatal(_("undefined %%define variable `%s' passed to muscle_percent_define_get_syncline"),
 520           variable);
 521   return syncline;
 522 }
 523
 524 bool
 525 muscle_percent_define_ifdef (char const *variable)
 526 {
 527   char const *name;
 528   char const *usage_name;
 529   char const *value;
 530
 531   MUSCLE_USER_NAME_CONVERT (name, "percent_define(", variable, ")");
 532   MUSCLE_USER_NAME_CONVERT (usage_name, "percent_define_bison_variables(",
 533                             variable, ")");
 534
 535   value = muscle_find_const (name);
 536   if (value)
 537     {
 538       muscle_insert (usage_name, "");
 539       return true;
 540     }
 541
 542   return false;
 543 }
 544
 545 bool
 546 muscle_percent_define_flag_if (char const *variable)
 547 {
 548   char const *invalid_boolean_name;
 549   bool result = false;
 550
 551   MUSCLE_USER_NAME_CONVERT (invalid_boolean_name,
 552                             "percent_define_invalid_boolean(", variable, ")");
 553
 554   if (muscle_percent_define_ifdef (variable))
 555     {
 556       char *value = muscle_percent_define_get (variable);
 557       if (value[0] == '\0' || 0 == strcmp (value, "true"))
 558         result = true;
 559       else if (0 == strcmp (value, "false"))
 560         result = false;
 561       else if (!muscle_find_const (invalid_boolean_name))
 562         {
 563           muscle_insert (invalid_boolean_name, "");
 564           complain_at(muscle_percent_define_get_loc (variable),
 565                       _("invalid value for %%define Boolean variable `%s'"),
 566                       variable);
 567         }
 568       free (value);
 569     }
 570   else
 571     fatal(_("undefined %%define variable `%s' passed to muscle_percent_define_flag_if"),
 572           variable);
 573
 574   return result;
 575 }
 576
 577 void
 578 muscle_percent_define_default (char const *variable, char const *value)
 579 {
 580   char const *name;
 581   char const *loc_name;
 582   char const *syncline_name;
 583   MUSCLE_USER_NAME_CONVERT (name, "percent_define(", variable, ")");
 584   MUSCLE_USER_NAME_CONVERT (loc_name, "percent_define_loc(", variable, ")");
 585   MUSCLE_USER_NAME_CONVERT (syncline_name,
 586                             "percent_define_syncline(", variable, ")");
 587   if (!muscle_find_const (name))
 588     {
 589       location loc;
 590       MUSCLE_INSERT_STRING (name, value);
 591       loc.start.file = loc.end.file = "<default value>";
 592       loc.start.line = loc.end.line = -1;
 593       loc.start.column = loc.end.column = -1;
 594       muscle_insert (loc_name, "");
 595       muscle_location_grow (loc_name, loc);
 596       muscle_insert (syncline_name, "");
 597     }
 598 }
 599
 600 void
 601 muscle_percent_define_check_values (char const * const *values)
 602 {
 603   for (; *values; ++values)
 604     {
 605       char const * const *variablep = values;
 606       char const *name;
 607       char *value;
 608
 609       MUSCLE_USER_NAME_CONVERT (name, "percent_define(", *variablep, ")");
 610
 611       value = muscle_string_decode (name);
 612       if (value)
 613         {
 614           for (++values; *values; ++values)
 615             {
 616               if (0 == strcmp (value, *values))
 617                 break;
 618             }
 619           if (!*values)
 620             {
 621               location loc = muscle_percent_define_get_loc (*variablep);
 622               complain_at(loc,
 623                           _("invalid value for %%define variable `%s': `%s'"),
 624                           *variablep, value);
 625               for (values = variablep + 1; *values; ++values)
 626                 complain_at (loc, _("accepted value: `%s'"), *values);
 627             }
 628           else
 629             {
 630               while (*values)
 631                 ++values;
 632             }
 633           free (value);
 634         }
 635       else
 636         fatal(_("undefined %%define variable `%s' passed to"
 637                 " muscle_percent_define_check_values"),
 638               *variablep);
 639     }
 640 }
 641
 642 void
 643 muscle_percent_code_grow (char const *qualifier, location qualifier_loc,
 644                           char const *code, location code_loc)
 645 {
 646   char const *name;
 647   MUSCLE_USER_NAME_CONVERT (name, "percent_code(", qualifier, ")");
 648   muscle_code_grow (name, code, code_loc);
 649   muscle_user_name_list_grow ("percent_code_user_qualifiers", qualifier,
 650                                qualifier_loc);
 651 }
 652
 653
 654 /*------------------------------------------------.
 655 | Output the definition of ENTRY as a m4_define.  |
 656 `------------------------------------------------*/
 657
 658 static inline bool
 659 muscle_m4_output (muscle_entry *entry, FILE *out)
 660 {
 661   fprintf (out, "m4_define([b4_%s],\n", entry->key);
 662   fprintf (out, "[[%s]])\n\n\n", entry->value);
 663   return true;
 664 }
 665
 666 static bool
 667 muscle_m4_output_processor (void *entry, void *out)
 668 {
 669   return muscle_m4_output (entry, out);
 670 }
 671
 672
 673 /*----------------------------------------------------------------.
 674 | Output the definition of all the current muscles into a list of |
 675 | m4_defines.                                                     |
 676 `----------------------------------------------------------------*/
 677
 678 void
 679 muscles_m4_output (FILE *out)
 680 {
 681   hash_do_for_each (muscle_table, muscle_m4_output_processor, out);
 682 }