maint: update gnu-web-doc-update.

[bison.git] / src / gram.h

diff --git a/src/gram.h b/src/gram.h
index af3c3249427e7994a4bae28028b62ba792e6cc75..3f75dd8f951a9e3ed71397f65c2e181602c08d4e 100644 (file)
--- a/src/gram.h
+++ b/src/gram.h
@@ -1,23 +1,22 @@
-/* Data definitions for internal representation of bison's input,
-   Copyright (C) 1984, 1986, 1989, 1992, 2001, 2002
-   Free Software Foundation, Inc.
+/* Data definitions for internal representation of Bison's input.
+
+   Copyright (C) 1984, 1986, 1989, 1992, 2001-2007, 2009-2012 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/>.  */

 
 #ifndef GRAM_H_
 # define GRAM_H_
 
 #ifndef GRAM_H_
 # define GRAM_H_


@@ -106,14 +105,15 @@
 # include "location.h"
 # include "symtab.h"
 
 # include "location.h"
 # include "symtab.h"
 

-# define ISTOKEN(s)    ((s) < ntokens)
-# define ISVAR(s)      ((s) >= ntokens)
+# define ISTOKEN(i)    ((i) < ntokens)
+# define ISVAR(i)      ((i) >= ntokens)

 
 extern int nsyms;
 extern int ntokens;
 extern int nvars;
 
 typedef int item_number;
 
 extern int nsyms;
 extern int ntokens;
 extern int nvars;
 
 typedef int item_number;

+#define ITEM_NUMBER_MAX INT_MAX

 extern item_number *ritem;
 extern unsigned int nritems;
 
 extern item_number *ritem;
 extern unsigned int nritems;
 


@@ -124,18 +124,47 @@ extern unsigned int nritems;
 
    Therefore, a symbol_number must be a valid item_number, and we
    sometimes have to perform the converse transformation.  */
 
    Therefore, a symbol_number must be a valid item_number, and we
    sometimes have to perform the converse transformation.  */

-# define symbol_number_as_item_number(Tok) ((item_number) (Tok))
-# define item_number_as_symbol_number(Ite) ((symbol_number) (Ite))

 
 

-extern symbol_number start_symbol;
+static inline item_number
+symbol_number_as_item_number (symbol_number sym)
+{
+  return sym;
+}
+
+static inline symbol_number
+item_number_as_symbol_number (item_number i)
+{
+  return i;
+}
+
+static inline bool
+item_number_is_symbol_number (item_number i)
+{
+  return i >= 0;
+}

 
 /* Rule numbers.  */
 
 /* Rule numbers.  */

-typedef short rule_number;
+typedef int rule_number;
+#define RULE_NUMBER_MAX INT_MAX

 extern rule_number nrules;
 extern rule_number nrules;

-# define int_of_rule_number(RNum) ((int) (RNum))
-# define rule_number_as_item_number(RNum) ((item_number) (- RNum - 1))
-# define item_number_as_rule_number(INum) ((rule_number) (- INum - 1))

 
 

+static inline item_number
+rule_number_as_item_number (rule_number r)
+{
+  return -1 - r;
+}
+
+static inline rule_number
+item_number_as_rule_number (item_number i)
+{
+  return -1 - i;
+}
+
+static inline bool
+item_number_is_rule_number (item_number i)
+{
+  return i < 0;
+}

 
 /*--------.
 | Rules.  |
 
 /*--------.
 | Rules.  |


@@ -157,8 +186,8 @@ typedef struct
   /* This symbol provides both the associativity, and the precedence. */
   symbol *prec;
 
   /* This symbol provides both the associativity, and the precedence. */
   symbol *prec;
 

-  short dprec;
-  short merger;
+  int dprec;
+  int merger;

 
   /* This symbol was attached to the rule via %prec. */
   symbol *precsym;
 
   /* This symbol was attached to the rule via %prec. */
   symbol *precsym;


@@ -175,20 +204,23 @@ extern rule *rules;
 /* A function that selects a rule.  */
 typedef bool (*rule_filter) (rule *);
 
 /* A function that selects a rule.  */
 typedef bool (*rule_filter) (rule *);
 

-/* Return true IFF the rule has a `number' smaller than NRULES.  */
-bool rule_useful_p (rule *r);
+/* Return true IFF the rule has a `number' smaller than NRULES.  That is, it is
+   useful in the grammar.  */
+bool rule_useful_in_grammar_p (rule *r);

 
 

-/* Return true IFF the rule has a `number' higher than NRULES.  */
-bool rule_useless_p (rule *r);
+/* Return true IFF the rule has a `number' higher than NRULES.  That is, it is
+   useless in the grammar.  */
+bool rule_useless_in_grammar_p (rule *r);

 
 

-/* Return true IFF the rule is not flagged as useful *and* is useful.
-   In other words, it was discarded because of conflicts.  */
-bool rule_never_reduced_p (rule *r);
+/* Return true IFF the rule is not flagged as useful but is useful in the
+   grammar.  In other words, it was discarded because of conflicts.  */
+bool rule_useless_in_parser_p (rule *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 rule_lhs_print (rule *r, symbol *previous_lhs, FILE *out);
 
 /* 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 rule_lhs_print (rule *r, symbol *previous_lhs, FILE *out);

+void rule_lhs_print_xml (rule *r, FILE *out, int level);

 
 /* Return the length of the RHS.  */
 int rule_rhs_length (rule *r);
 
 /* Return the length of the RHS.  */
 int rule_rhs_length (rule *r);


@@ -213,39 +245,29 @@ extern int max_user_token_number;
 
 
 
 
 
 

-/* GLR_PARSER is nonzero if the input file says to use the GLR
-   (Generalized LR) parser, and to output some additional
-   information used by the GLR algorithm. */
-
-extern int glr_parser;
-
-/* PURE_PARSER is nonzero if should generate a parser that is all pure
-   and reentrant.  */
-
-extern int pure_parser;
-

 /* Dump RITEM for traces. */
 void ritem_print (FILE *out);
 
 /* Return the size of the longest rule RHS.  */
 size_t ritem_longest_rhs (void);
 
 /* Dump RITEM for traces. */
 void ritem_print (FILE *out);
 
 /* Return the size of the longest rule RHS.  */
 size_t ritem_longest_rhs (void);
 

-/* Print the grammar's rules numbers from BEGIN (inclusive) to END
-   (exclusive) on OUT under TITLE.  */
+/* Print the grammar's rules that match FILTER on OUT under TITLE.  */

 void grammar_rules_partial_print (FILE *out, const char *title,
                                  rule_filter filter);
 
 void grammar_rules_partial_print (FILE *out, const char *title,
                                  rule_filter filter);
 

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

 void grammar_rules_print (FILE *out);
 void grammar_rules_print (FILE *out);

+/* Print all of the grammar's rules with a "usefulness" attribute.  */
+void grammar_rules_print_xml (FILE *out, int level);

 
 /* Dump the grammar. */
 void grammar_dump (FILE *out, const char *title);
 
 /* Report on STDERR the rules that are not flagged USEFUL, using the
 
 /* Dump the grammar. */
 void grammar_dump (FILE *out, const char *title);
 
 /* 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 grammar_rules_never_reduced_report (const char *message);
+   MESSAGE (which can be `rule useless in grammar' when invoked after grammar
+   reduction, or `rule useless in parser due to conflicts' after conflicts
+   were taken into account).  */
+void grammar_rules_useless_report (const char *message);

 
 /* Free the packed grammar. */
 void grammar_free (void);
 
 /* Free the packed grammar. */
 void grammar_free (void);