doc: improve html and pdf rendering

[bison.git] / src / gram.c

diff --git a/src/gram.c b/src/gram.c
index d157608a0064244198b9907efab6fa7e2598546c..3eb6c0678fd7ffb6ad2f0b01ad1d466894e9601e 100644 (file)
--- a/src/gram.c
+++ b/src/gram.c
@@ -1,162 +1,128 @@
-/* Allocate input grammar variables for bison,
-   Copyright (C) 1984, 1986, 1989, 2001, 2002 Free Software Foundation, Inc.
+/* Allocate input grammar variables for Bison.
+
+   Copyright (C) 1984, 1986, 1989, 2001-2003, 2005-2015 Free Software
+   Foundation, Inc.

 
    This file is part of Bison, the GNU Compiler Compiler.
 
 
    This file is part of Bison, the GNU Compiler Compiler.
 

-   Bison is free software; you can redistribute it and/or modify
+   This program is free software: you can redistribute it and/or modify

    it under the terms of the GNU General Public License as published by
    it under the terms of the GNU General Public License as published by

-   the Free Software Foundation; either version 2, or (at your option)
-   any later version.
+   the Free Software Foundation, either version 3 of the License, or
+   (at your option) any later version.

 
 

-   Bison is distributed in the hope that it will be useful,
+   This program is distributed in the hope that it will be useful,

    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.
 
    You should have received a copy of the GNU General Public License
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.
 
    You should have received a copy of the GNU General Public License

-   along with Bison; see the file COPYING.  If not, write to
-   the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
-   Boston, MA 02111-1307, USA.  */
-
+   along with this program.  If not, see <http://www.gnu.org/licenses/>.  */

 
 

+#include <config.h>

 #include "system.h"
 #include "system.h"

-#include "quotearg.h"
-#include "symtab.h"
+
+#include "complain.h"
+#include "getargs.h"

 #include "gram.h"
 #include "gram.h"

-#include "reduce.h"
+#include "print-xml.h"

 #include "reader.h"
 #include "reader.h"

+#include "reduce.h"
+#include "symtab.h"

 
 /* Comments for these variables are in gram.h.  */
 
 
 /* Comments for these variables are in gram.h.  */
 

-item_number_t *ritem = NULL;
+item_number *ritem = NULL;

 unsigned int nritems = 0;
 
 unsigned int nritems = 0;
 

-rule_t *rules = NULL;
-rule_number_t nrules = 0;
+rule *rules = NULL;
+rule_number nrules = 0;

 
 

-symbol_t **symbols = NULL;
+symbol **symbols = NULL;

 int nsyms = 0;
 int ntokens = 1;
 int nvars = 0;
 
 int nsyms = 0;
 int ntokens = 1;
 int nvars = 0;
 

-symbol_number_t *token_translations = NULL;
+symbol_number *token_translations = NULL;

 
 int max_user_token_number = 256;
 
 
 int max_user_token_number = 256;
 

-int glr_parser = 0;
-int pure_parser = 0;
-
-
-/*--------------------------------------------------------------.
-| Return true IFF the rule has a `number' smaller than NRULES.  |
-`--------------------------------------------------------------*/
-

 bool
 bool

-rule_useful_p (rule_t *r)
+rule_useful_in_grammar_p (rule const *r)

 {
   return r->number < nrules;
 }
 
 {
   return r->number < nrules;
 }
 

-
-/*-------------------------------------------------------------.
-| Return true IFF the rule has a `number' higher than NRULES.  |
-`-------------------------------------------------------------*/
-

 bool
 bool

-rule_useless_p (rule_t *r)
+rule_useless_in_grammar_p (rule const *r)

 {
 {

-  return r->number >= nrules;
+  return !rule_useful_in_grammar_p (r);

 }
 
 }
 

-
-/*--------------------------------------------------------------------.
-| Return true IFF the rule is not flagged as useful *and* is useful.  |
-| In other words, it was discarded because of conflicts.              |
-`--------------------------------------------------------------------*/
-

 bool
 bool

-rule_never_reduced_p (rule_t *r)
+rule_useless_in_parser_p (rule const *r)

 {
 {

-  return !r->useful && r->number < nrules;
+  return !r->useful && rule_useful_in_grammar_p (r);

 }
 
 }
 

-
-/*----------------------------------------------------------------.
-| Print this RULE's number and lhs on OUT.  If a PREVIOUS_LHS was |
-| already displayed (by a previous call for another rule), avoid  |
-| useless repetitions.                                            |
-`----------------------------------------------------------------*/
-

 void
 void

-rule_lhs_print (rule_t *rule, symbol_t *previous_lhs, FILE *out)
+rule_lhs_print (rule const *r, symbol const *previous_lhs, FILE *out)

 {
 {

-  fprintf (out, "  %3d ", rule->number);
-  if (previous_lhs != rule->lhs)
-    {
-      fprintf (out, "%s:", rule->lhs->tag);
-    }
+  fprintf (out, "  %3d ", r->number);
+  if (previous_lhs != r->lhs)
+    fprintf (out, "%s:", r->lhs->tag);

   else
   else

-    {
-      int n;
-      for (n = strlen (previous_lhs->tag); n > 0; --n)
-       fputc (' ', out);
-      fputc ('|', out);
-    }
+    fprintf (out, "%*s|", (int) strlen (previous_lhs->tag), "");

 }
 
 }
 

+void
+rule_lhs_print_xml (rule const *r, FILE *out, int level)
+{
+  xml_printf (out, level, "<lhs>%s</lhs>", r->lhs->tag);
+}

 
 

-/*--------------------------------------.
-| Return the number of symbols in RHS.  |
-`--------------------------------------*/
-
-int
-rule_rhs_length (rule_t *rule)
+size_t
+rule_rhs_length (rule const *r)

 {
 {

-  int res = 0;
-  item_number_t *rhsp;
-  for (rhsp = rule->rhs; *rhsp >= 0; ++rhsp)
+  size_t res = 0;
+  item_number *rhsp;
+  for (rhsp = r->rhs; *rhsp >= 0; ++rhsp)

     ++res;
   return res;
 }
 
     ++res;
   return res;
 }
 

-
-/*-------------------------------.
-| Print this RULE's RHS on OUT.  |
-`-------------------------------*/
-

 void
 void

-rule_rhs_print (rule_t *rule, FILE *out)
+rule_rhs_print (rule const *r, FILE *out)

 {
 {

-  if (*rule->rhs >= 0)
+  if (0 <= *r->rhs)

     {
     {

-      item_number_t *r;
-      for (r = rule->rhs; *r >= 0; r++)
-       fprintf (out, " %s", symbols[*r]->tag);
-      fputc ('\n', out);
+      item_number *rp;
+      for (rp = r->rhs; *rp >= 0; rp++)
+        fprintf (out, " %s", symbols[*rp]->tag);

     }
   else
     }
   else

-    {
-      fprintf (out, " /* %s */\n", _("empty"));
-    }
+    fputs (" %empty", out);

 }
 
 }
 

-
-/*-------------------------.
-| Print this RULE on OUT.  |
-`-------------------------*/
-
-void
-rule_print (rule_t *rule, FILE *out)
+static void
+rule_rhs_print_xml (rule const *r, FILE *out, int level)

 {
 {

-  fprintf (out, "%s:", rule->lhs->tag);
-  rule_rhs_print (rule, out);
+  if (*r->rhs >= 0)
+    {
+      item_number *rp;
+      xml_puts (out, level, "<rhs>");
+      for (rp = r->rhs; *rp >= 0; rp++)
+        xml_printf (out, level + 1, "<symbol>%s</symbol>",
+                    xml_escape (symbols[*rp]->tag));
+      xml_puts (out, level, "</rhs>");
+    }
+  else
+    {
+      xml_puts (out, level, "<rhs>");
+      xml_puts (out, level + 1, "<empty/>");
+      xml_puts (out, level, "</rhs>");
+    }

 }
 
 }
 

-
-/*------------------------.
-| Dump RITEM for traces.  |
-`------------------------*/
-

 void
 ritem_print (FILE *out)
 {
 void
 ritem_print (FILE *out)
 {


@@ -170,165 +136,174 @@ ritem_print (FILE *out)
   fputs ("\n\n", out);
 }
 
   fputs ("\n\n", out);
 }
 

-
-/*------------------------------------------.
-| Return the size of the longest rule RHS.  |
-`------------------------------------------*/
-

 size_t
 ritem_longest_rhs (void)
 {
   int max = 0;
 size_t
 ritem_longest_rhs (void)
 {
   int max = 0;

-  rule_number_t r;
+  rule_number r;

 
   for (r = 0; r < nrules; ++r)
     {
       int length = rule_rhs_length (&rules[r]);
       if (length > max)
 
   for (r = 0; r < nrules; ++r)
     {
       int length = rule_rhs_length (&rules[r]);
       if (length > max)

-       max = length;
+        max = length;

     }
 
   return max;
 }
 
     }
 
   return max;
 }
 

-
-/*-----------------------------------------------------------------.
-| Print the grammar's rules that match FILTER on OUT under TITLE.  |
-`-----------------------------------------------------------------*/
-

 void
 grammar_rules_partial_print (FILE *out, const char *title,
 void
 grammar_rules_partial_print (FILE *out, const char *title,

-                            rule_filter_t filter)
+                             rule_filter filter)

 {
 {

-  int r;
+  rule_number r;

   bool first = true;
   bool first = true;

-  symbol_t *previous_lhs = NULL;
+  symbol *previous_lhs = NULL;

 
   /* rule # : LHS -> RHS */
   for (r = 0; r < nrules + nuseless_productions; r++)
     {
       if (filter && !filter (&rules[r]))
 
   /* rule # : LHS -> RHS */
   for (r = 0; r < nrules + nuseless_productions; r++)
     {
       if (filter && !filter (&rules[r]))

-       continue;
+        continue;

       if (first)
       if (first)

-       fprintf (out, "%s\n\n", title);
+        fprintf (out, "%s\n\n", title);

       else if (previous_lhs && previous_lhs != rules[r].lhs)
       else if (previous_lhs && previous_lhs != rules[r].lhs)

-       fputc ('\n', out);
+        fputc ('\n', out);

       first = false;
       rule_lhs_print (&rules[r], previous_lhs, out);
       rule_rhs_print (&rules[r], out);
       first = false;
       rule_lhs_print (&rules[r], previous_lhs, out);
       rule_rhs_print (&rules[r], out);

+      fprintf (out, "\n");

       previous_lhs = rules[r].lhs;
     }
   if (!first)
     fputs ("\n\n", out);
 }
 
       previous_lhs = rules[r].lhs;
     }
   if (!first)
     fputs ("\n\n", out);
 }
 

-
-/*------------------------------------------.
-| Print the grammar's useful rules on OUT.  |
-`------------------------------------------*/
-

 void
 grammar_rules_print (FILE *out)
 {
 void
 grammar_rules_print (FILE *out)
 {

-  grammar_rules_partial_print (out, _("Grammar"), rule_useful_p);
+  grammar_rules_partial_print (out, _("Grammar"), rule_useful_in_grammar_p);

 }
 
 }
 

+void
+grammar_rules_print_xml (FILE *out, int level)
+{
+  rule_number r;
+  bool first = true;

 
 

-/*-------------------.
-| Dump the grammar.  |
-`-------------------*/
+  for (r = 0; r < nrules + nuseless_productions; r++)
+    {
+      if (first)
+        xml_puts (out, level + 1, "<rules>");
+      first = false;
+      {
+        char const *usefulness;
+        if (rule_useless_in_grammar_p (&rules[r]))
+          usefulness = "useless-in-grammar";
+        else if (rule_useless_in_parser_p (&rules[r]))
+          usefulness = "useless-in-parser";
+        else
+          usefulness = "useful";
+        xml_indent (out, level + 2);
+        fprintf (out, "<rule number=\"%d\" usefulness=\"%s\"",
+                 rules[r].number, usefulness);
+        if (rules[r].precsym)
+          fprintf (out, " percent_prec=\"%s\"",
+                   xml_escape (rules[r].precsym->tag));
+        fputs (">\n", out);
+      }
+      rule_lhs_print_xml (&rules[r], out, level + 3);
+      rule_rhs_print_xml (&rules[r], out, level + 3);
+      xml_puts (out, level + 2, "</rule>");
+    }
+  if (!first)
+    xml_puts (out, level + 1, "</rules>");
+  else
+   xml_puts (out, level + 1, "<rules/>");
+}

 
 void
 grammar_dump (FILE *out, const char *title)
 {
   fprintf (out, "%s\n\n", title);
   fprintf (out,
 
 void
 grammar_dump (FILE *out, const char *title)
 {
   fprintf (out, "%s\n\n", title);
   fprintf (out,

-          "ntokens = %d, nvars = %d, nsyms = %d, nrules = %d, nritems = %d\n\n",
-          ntokens, nvars, nsyms, nrules, nritems);
+           "ntokens = %d, nvars = %d, nsyms = %d, nrules = %d, nritems = %d\n\n",
+           ntokens, nvars, nsyms, nrules, nritems);

 
 
   fprintf (out, "Variables\n---------\n\n");
   {
 
 
   fprintf (out, "Variables\n---------\n\n");
   {

-    symbol_number_t i;
+    symbol_number i;

     fprintf (out, "Value  Sprec  Sassoc  Tag\n");
 
     for (i = ntokens; i < nsyms; i++)
       fprintf (out, "%5d  %5d   %5d  %s\n",
     fprintf (out, "Value  Sprec  Sassoc  Tag\n");
 
     for (i = ntokens; i < nsyms; i++)
       fprintf (out, "%5d  %5d   %5d  %s\n",

-              i,
-              symbols[i]->prec, symbols[i]->assoc,
-              symbols[i]->tag);
+               i,
+               symbols[i]->prec, symbols[i]->assoc,
+               symbols[i]->tag);

     fprintf (out, "\n\n");
   }
 
   fprintf (out, "Rules\n-----\n\n");
   {
     fprintf (out, "\n\n");
   }
 
   fprintf (out, "Rules\n-----\n\n");
   {

-    rule_number_t i;
-    fprintf (out, "Num (Prec, Assoc, Useful, Ritem Range) Lhs -> Rhs (Ritem range) [Num]\n");
+    rule_number i;
+    fprintf (out,
+             "Num (Prec, Assoc, Useful, Ritem Range) Lhs"
+             " -> Rhs (Ritem range) [Num]\n");

     for (i = 0; i < nrules + nuseless_productions; i++)
       {
     for (i = 0; i < nrules + nuseless_productions; i++)
       {

-       rule_t *rule = &rules[i];
-       item_number_t *r = NULL;
-       unsigned int rhs_itemno = rule->rhs - ritem;
-       unsigned int rhs_count = 0;
-       /* Find the last RHS index in ritems. */
-       for (r = rule->rhs; *r >= 0; ++r)
-         ++rhs_count;
-       fprintf (out, "%3d (%2d, %2d, %2d, %2u-%2u)   %2d ->",
-                i,
-                rule->prec ? rule->prec->prec : 0,
-                rule->prec ? rule->prec->assoc : 0,
-                rule->useful,
-                rhs_itemno,
-                rhs_itemno + rhs_count - 1,
-                rule->lhs->number);
-       /* Dumped the RHS. */
-       for (r = rule->rhs; *r >= 0; r++)
-         fprintf (out, " %3d", *r);
-       fprintf (out, "  [%d]\n", item_number_as_rule_number (*r));
+        rule const *rule_i = &rules[i];
+        item_number *rp = NULL;
+        unsigned int rhs_itemno = rule_i->rhs - ritem;
+        unsigned int rhs_count = 0;
+        /* Find the last RHS index in ritems. */
+        for (rp = rule_i->rhs; *rp >= 0; ++rp)
+          ++rhs_count;
+        fprintf (out, "%3d (%2d, %2d, %2d, %2u-%2u)   %2d ->",
+                 i,
+                 rule_i->prec ? rule_i->prec->prec : 0,
+                 rule_i->prec ? rule_i->prec->assoc : 0,
+                 rule_i->useful,
+                 rhs_itemno,
+                 rhs_itemno + rhs_count - 1,
+                 rule_i->lhs->number);
+        /* Dumped the RHS. */
+        for (rp = rule_i->rhs; *rp >= 0; rp++)
+          fprintf (out, " %3d", *rp);
+        fprintf (out, "  [%d]\n", item_number_as_rule_number (*rp));

       }
   }
   fprintf (out, "\n\n");
 
   fprintf (out, "Rules interpreted\n-----------------\n\n");
   {
       }
   }
   fprintf (out, "\n\n");
 
   fprintf (out, "Rules interpreted\n-----------------\n\n");
   {

-    rule_number_t r;
+    rule_number r;

     for (r = 0; r < nrules + nuseless_productions; r++)
       {
     for (r = 0; r < nrules + nuseless_productions; r++)
       {

-       fprintf (out, "%-5d  ", r);
-       rule_print (&rules[r], out);
+        fprintf (out, "%-5d  %s:", r, rules[r].lhs->tag);
+        rule_rhs_print (&rules[r], out);
+        fprintf (out, "\n");

       }
   }
   fprintf (out, "\n\n");
 }
 
       }
   }
   fprintf (out, "\n\n");
 }
 

-
-/*------------------------------------------------------------------.
-| Report on STDERR the rules that are not flagged USEFUL, using the |
-| MESSAGE (which can be `useless rule' when invoked after grammar   |
-| reduction, or `never reduced' after conflicts were taken into     |
-| account).                                                         |
-`------------------------------------------------------------------*/
-

 void
 void

-grammar_rules_never_reduced_report (const char *message)
+grammar_rules_useless_report (const char *message)

 {
 {

-  rule_number_t r;
+  rule_number r;

   for (r = 0; r < nrules ; ++r)
     if (!rules[r].useful)
   for (r = 0; r < nrules ; ++r)
     if (!rules[r].useful)

-      {
-       location_print (stderr, rules[r].location);
-       fprintf (stderr, ": %s: %s: ",
-                _("warning"), message);
-       rule_print (&rules[r], stderr);
-      }
+      complain (&rules[r].location, Wother, "%s", message);

 }
 
 void
 grammar_free (void)
 {
 }
 
 void
 grammar_free (void)
 {

-  XFREE (ritem);
+  if (ritem)
+    free (ritem - 1);

   free (rules);
   free (rules);

-  XFREE (token_translations);
+  free (token_translations);

   /* Free the symbol table data structure.  */
   symbols_free ();
   free_merger_functions ();
   /* Free the symbol table data structure.  */
   symbols_free ();
   free_merger_functions ();