src/muscle_tab.c

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