src/muscle-tab.c

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