FYI: glr.cc passes calc.at

[Akim Demaille]

Index: ChangeLog
from  Akim Demaille  <address@hidden>

        Have glr.cc pass (some of) the calc.at tests.
        * data/glr.cc (b4_parse_param_orig): New.
        (b4_parse_param): Improve its definition, and bound it more
        clearly in the skeleton.
        (b4_epilogue): Append, instead of prepending, in order to keep
        #line consistency.
        Simplify the generation of auxiliary functions: locations and
        purity are mandated.
        (b4_global_tokens_and_yystype): Honor it.
        * data/location.cc (c++.m4): Don't include it.
        * tests/local.at (_AT_BISON_OPTION_PUSHDEFS): Define AT_GLR_CC_IF
        and AT_SKEL_CC_IF.
        * tests/calc.at (AT_CHECK_CALC): Rely on AT_SKEL_CC_IF instead of
        AT_LALR1_CC_IF.
        Be sure to initialize the first position's filename.
        (AT_CHECK_CALC_LALR1_CC): Add %location and %defines, they are
        mandated anyway.
        (AT_CHECK_CALC_GLR_CC): New.
        Use it to exercise glr.cc as a lalr1.cc drop-in replacement.

Index: data/c.m4
===================================================================
RCS file: /cvsroot/bison/bison/data/c.m4,v
retrieving revision 1.44
diff -u -u -r1.44 c.m4
--- data/c.m4 22 Dec 2005 13:01:50 -0000 1.44
+++ data/c.m4 3 Jan 2006 09:05:55 -0000
@@ -95,6 +95,7 @@
 m4_define([b4_parse_param],
 b4_parse_param))
 
+
 # b4_parse_param_for(DECL, FORMAL, BODY)
 # ---------------------------------------
 # Iterate over the user parameters, binding the declaration to DECL,
Index: data/glr.cc
===================================================================
RCS file: /cvsroot/bison/bison/data/glr.cc,v
retrieving revision 1.8
diff -u -u -r1.8 glr.cc
--- data/glr.cc 2 Jan 2006 16:06:11 -0000 1.8
+++ data/glr.cc 3 Jan 2006 09:05:55 -0000
@@ -18,6 +18,35 @@
 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 # 02110-1301  USA
 
+
+# This skeleton produces a C++ class that encapsulates a C glr parser.
+# This is in order to reduce the maintenance burden.  The glr.c
+# skeleton is clean and pure enough so that there are no real
+# problems.  The C++ interface is the same as that of lalr1.cc.  In
+# fact, glr.c can replace yacc.c without the user noticing any
+# difference, and similarly for glr.cc replacing lalr1.cc.
+#
+# The passing of parse-params
+#
+#   The additional arguments are stored as members of the parser
+#   object, yyparser.  The C routines need to carry yyparser
+#   throughout the C parser; that easy: just let yyparser become an
+#   additional parse-param.  But because the C++ skeleton needs to
+#   know the "real" original parse-param, we save them
+#   (b4_parse_param_orig).  Note that b4_parse_param is overquoted
+#   (and c.m4 strips one level of quotes).  This is a PITA, and
+#   explains why there are so many levels of quotes.
+#
+# The locations
+#
+#   We use location.cc just like lalr1.cc, but because glr.c stores
+#   the locations in a (C++) union, the position and location classes
+#   must not have a constructor.  Therefore, contrary to lalr1.cc, we
+#   must not define "b4_location_constructors".  As a consequence the
+#   user must initialize the first positions (in particular the
+#   filename member).
+
+
 # We require a pure interface using locations.
 m4_define([b4_location_flag], [1])
 m4_define([b4_pure],          [1])
@@ -26,17 +55,16 @@
 m4_include(b4_pkgdatadir/[location.cc])
 
 
+# Save the parse parameters.
+m4_define([b4_parse_param_orig], m4_defn([b4_parse_param]))
+
+
 # b4_yy_symbol_print_generate
 # ---------------------------
 # Bypass the default implementation to generate the "yy_symbol_print"
 # and "yy_symbol_value_print" functions.
 m4_define([b4_yy_symbol_print_generate],
-[b4_c_ansi_function_decl([yyerror],
-    [static void],
-    [[yy::b4_parser_class_name::location_type *yylocationp], [yylocationp]],
-    b4_parse_param,
-    [[const char* msg], [msg]])[
-
+[[
 /*--------------------.
 | Print this symbol.  |
 `--------------------*/
@@ -46,19 +74,33 @@
     [[FILE *],               []],
     [[int yytype],           [yytype]],
     [[const yy::b4_parser_class_name::semantic_type *yyvaluep],
-                             [yyvaluep]][]dnl
-b4_location_if([,
+                             [yyvaluep]],
     [[const yy::b4_parser_class_name::location_type *yylocationp],
-                             [yylocationp]]])[]dnl
-m4_ifset([b4_parse_param], [, b4_parse_param]))[
+                             [yylocationp]],
+    b4_parse_param)[
 {
 ]b4_parse_param_use[]dnl
 [  yyparser.yy_symbol_print_ (yytype, yyvaluep]b4_location_if([, 
yylocationp])[);
 }
 ]])
 
-m4_prepend([b4_epilogue],
-[[
+
+# Declare yyerror.
+m4_append([b4_post_prologue],
+[/* Line __line__ of glr.cc.  */
+b4_syncline(address@hidden@], address@hidden@])
+
+b4_c_ansi_function_decl([yyerror],
+    [static void],
+    [[yy::b4_parser_class_name::location_type *yylocationp], [yylocationp]],
+    b4_parse_param,
+    [[const char* msg], [msg]])])
+
+
+# Define yyerror.
+m4_append([b4_epilogue],
+[/* Line __line__ of glr.cc.  */
+b4_syncline(address@hidden@], address@hidden@])[
 /*------------------.
 | Report an error.  |
 `------------------*/
@@ -76,10 +118,9 @@
 
 namespace yy
 {
-]dnl Restore the actual parser params.
-m4_popdef([b4_parse_param])dnl
-[
-  /// Build a parser object.
+]dnl In this section, the parse param are the original parse_params.
+m4_pushdef([b4_parse_param], m4_defn([b4_parse_param_orig]))dnl
+[  /// Build a parser object.
   ]b4_parser_class_name::b4_parser_class_name[ (]b4_parse_param_decl[)
     : yycdebug_ (&std::cerr)]b4_parse_param_cons[
   {
@@ -153,16 +194,24 @@
   }
 
 #endif /* ! YYDEBUG */
-
-} // namespace yy
+]m4_popdef([b4_parse_param])dnl
+[} // namespace yy
 
 ]])
 
-# Let glr.c believe that the user arguments are only the parser itself.
-m4_pushdef([b4_parse_param],
-          [[yy::b4_parser_class_name& yyparser, yyparser],]
-           m4_defn([b4_parse_param]))
+
+# Let glr.c believe that the user arguments include the parser itself.
+m4_ifset([b4_parse_param],
+[m4_pushdef([b4_parse_param],
+            m4_dquote([[[yy::b4_parser_class_name& yyparser], [[yyparser]]],]
+m4_defn([b4_parse_param])))],
+[m4_pushdef([b4_parse_param],
+            [[[[yy::b4_parser_class_name& yyparser], [[yyparser]]]]])
+])
 m4_include(b4_pkgdatadir/[glr.c])
+m4_popdef([b4_parse_param])
+
+
 @output @output_header_name@
 b4_copyright([C++ Skeleton parser for GLALR(1) parsing with Bison],
              [2002, 2003, 2004, 2005])[
@@ -328,8 +377,15 @@
   };
 
 ]dnl Redirections for glr.c.
-[#define YYSTYPE yy::]b4_parser_class_name[::semantic_type
-#define YYLTYPE yy::]b4_parser_class_name[::location_type
+m4_ifset([b4_global_tokens_and_yystype],
+[b4_token_defines(b4_tokens)])
+[
+#ifndef YYSTYPE
+# define YYSTYPE yy::]b4_parser_class_name[::semantic_type
+#endif
+#ifndef YYLTYPE
+# define YYLTYPE yy::]b4_parser_class_name[::location_type
+#endif
 
 }
 
Index: data/location.cc
===================================================================
RCS file: /cvsroot/bison/bison/data/location.cc,v
retrieving revision 1.5
diff -u -u -r1.5 location.cc
--- data/location.cc 22 Dec 2005 04:38:26 -0000 1.5
+++ data/location.cc 3 Jan 2006 09:05:55 -0000
@@ -2,7 +2,7 @@
 
 # C++ skeleton for Bison
 
-# Copyright (C) 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
+# Copyright (C) 2002, 2003, 2004, 2005, 2006 Free Software Foundation, Inc.
 
 # 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
@@ -19,8 +19,6 @@
 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 # 02110-1301  USA
 
-m4_include(b4_pkgdatadir/[c++.m4])
-
 # We do want M4 expansion after # for CPP macros.
 m4_changecom()
 m4_divert(0)dnl
Index: tests/calc.at
===================================================================
RCS file: /cvsroot/bison/bison/tests/calc.at,v
retrieving revision 1.85
diff -u -u -r1.85 calc.at
--- tests/calc.at 27 Dec 2005 17:50:00 -0000 1.85
+++ tests/calc.at 3 Jan 2006 09:05:55 -0000
@@ -1,6 +1,6 @@
 # Simple calculator.                         -*- Autotest -*-
 
-# Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005 Free Software
+# Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, 2006 Free Software
 # Foundation, Inc.
 
 # This program is free software; you can redistribute it and/or modify
@@ -40,7 +40,7 @@
 AT_DATA_GRAMMAR([calc.y],
 [[/* Infix notation calculator--calc */
 ]$4
-AT_LALR1_CC_IF(
+AT_SKEL_CC_IF(
 [%define "global_tokens_and_yystype"])[
 %{
 #include <stdio.h>
@@ -71,8 +71,10 @@
 
 %{
 static int power (int base, int exponent);
-]AT_LALR1_CC_IF(
-[typedef yy::location YYLTYPE;
+]AT_SKEL_CC_IF(
+[#ifndef YYLTYPE
+# define YYLTYPE yy::location
+#endif
 #define first_line   begin.line
 #define first_column begin.column
 #define last_line    end.line
@@ -90,6 +92,17 @@
 static void unget_char (]AT_LEX_PRE_FORMALS[ int c);
 %}
 
+]AT_SKEL_CC_IF(
+[/* The lalr1.cc skeleton, for backward compatibility, defines
+   a constructor for position that initializes the filename.  The
+   glr.cc skeleton does not (and in fact cannot: location/position
+   are stored in a union, from which objects with constructors are
+   excluded in C++. */
+%initial-action {
+  @$.begin.filename = @$.end.filename = 0;
+}
+])[
+
 /* Bison Declarations */
 %token CALC_EOF 0 "end of input"
 %token <ival> NUM "number"
@@ -136,7 +149,7 @@
 /* The input.  */
 static FILE *input;
 
-]AT_LALR1_CC_IF(
+]AT_SKEL_CC_IF(
 [/* A C++ error reporting function.  */
 void
 yy::parser::error (const location& l, const std::string& m)
@@ -319,7 +332,7 @@
       return 3;
     }
 
-]AT_LALR1_CC_IF([], [m4_bmatch([$4], [%debug],
+]AT_SKEL_CC_IF([], [m4_bmatch([$4], [%debug],
 [  yydebug = 1;])])[
   status = yyparse (]AT_PARAM_IF([&result, &count])[);
   if (global_result != result)
@@ -438,7 +451,7 @@
 
 AT_DATA_CALC_Y([$1])
 
-AT_LALR1_CC_IF(
+AT_SKEL_CC_IF(
   [AT_CHECK([bison -o calc.cc calc.y])
    AT_COMPILE_CXX([calc])],
   [AT_CHECK([bison -o calc.c calc.y])
@@ -525,7 +538,7 @@
 # Simple LALR Calculator.  #
 # ------------------------ #
 
-AT_BANNER([[Simple LALR Calculator.]])
+AT_BANNER([[Simple LALR(1) Calculator.]])
 
 # AT_CHECK_CALC_LALR([BISON-OPTIONS])
 # -----------------------------------
@@ -596,34 +609,45 @@
 # Simple LALR1 C++ Calculator.  #
 # ----------------------------- #
 
-AT_BANNER([[Simple LALR1 C++ Calculator.]])
+AT_BANNER([[Simple LALR(1) C++ Calculator.]])
 
 # AT_CHECK_CALC_LALR1_CC([BISON-OPTIONS])
 # ---------------------------------------
 # Start a testing chunk which compiles `calc' grammar with
 # the C++ skeleton, and performs several tests over the parser.
 m4_define([AT_CHECK_CALC_LALR1_CC],
-[AT_CHECK_CALC([%skeleton "lalr1.cc"] $@)])
+[AT_CHECK_CALC([%skeleton "lalr1.cc" %defines %locations] $@)])
+
+AT_CHECK_CALC_LALR1_CC([])
+AT_CHECK_CALC_LALR1_CC([%error-verbose %name-prefix="calc" %verbose %yacc])
 
-# AT_CHECK_CALC_LALR1_CC()
+AT_CHECK_CALC_LALR1_CC([%error-verbose %debug %name-prefix="calc" %verbose 
%yacc])
 
-AT_CHECK_CALC_LALR1_CC([%defines %locations])
+AT_CHECK_CALC_LALR1_CC([%pure-parser %error-verbose %debug %name-prefix="calc" 
%verbose %yacc])
 
-AT_CHECK_CALC_LALR1_CC([%defines])
-# AT_CHECK_CALC_LALR1_CC([%locations])
-# AT_CHECK_CALC_LALR1_CC([%name-prefix="calc"])
-# AT_CHECK_CALC_LALR1_CC([%verbose])
-# AT_CHECK_CALC_LALR1_CC([%yacc])
-# AT_CHECK_CALC_LALR1_CC([%error-verbose])
+AT_CHECK_CALC_LALR1_CC([%pure-parser %error-verbose %debug %name-prefix="calc" 
%verbose %yacc %parse-param {semantic_value *result} %parse-param {int *count}])
 
-# AT_CHECK_CALC_LALR1_CC([%pure-parser %locations])
-# AT_CHECK_CALC_LALR1_CC([%error-verbose %locations])
 
-AT_CHECK_CALC_LALR1_CC([%error-verbose %locations %defines %name-prefix="calc" 
%verbose %yacc])
 
-# AT_CHECK_CALC_LALR1_CC([%debug])
-AT_CHECK_CALC_LALR1_CC([%error-verbose %debug %locations %defines 
%name-prefix="calc" %verbose %yacc])
+# --------------------------- #
+# Simple GLR C++ Calculator.  #
+# --------------------------- #
+
+AT_BANNER([[Simple GLR C++ Calculator.]])
+
+# AT_CHECK_CALC_GLR_CC([BISON-OPTIONS])
+# -------------------------------------
+# Start a testing chunk which compiles `calc' grammar with
+# the GLR C++ skeleton, and performs several tests over the parser.
+m4_define([AT_CHECK_CALC_GLR_CC],
+[AT_CHECK_CALC([%skeleton "glr.cc" %defines %locations] $@)])
+
+#AT_CHECK_CALC_GLR_CC([])
+#AT_CHECK_CALC_GLR_CC([%error-verbose %name-prefix="calc" %verbose %yacc])
+
+# AT_CHECK_CALC_GLR_CC([%debug])
+#AT_CHECK_CALC_GLR_CC([%error-verbose %debug %name-prefix="calc" %verbose 
%yacc])
 
-AT_CHECK_CALC_LALR1_CC([%pure-parser %error-verbose %debug %locations %defines 
%name-prefix="calc" %verbose %yacc])
+AT_CHECK_CALC_GLR_CC([%pure-parser %error-verbose %debug %name-prefix="calc" 
%verbose %yacc])
 
-AT_CHECK_CALC_LALR1_CC([%pure-parser %error-verbose %debug %locations %defines 
%name-prefix="calc" %verbose %yacc %parse-param {semantic_value *result} 
%parse-param {int *count}])
+AT_CHECK_CALC_GLR_CC([%pure-parser %error-verbose %debug %name-prefix="calc" 
%verbose %yacc %parse-param {semantic_value *result} %parse-param {int *count}])
Index: tests/local.at
===================================================================
RCS file: /cvsroot/bison/bison/tests/local.at,v
retrieving revision 1.12
diff -u -u -r1.12 local.at
--- tests/local.at 21 Sep 2005 21:05:53 -0000 1.12
+++ tests/local.at 3 Jan 2006 09:05:55 -0000
@@ -1,7 +1,7 @@
 # Process this -*- Autotest -*- file with autom4te.
 
 # Macros for the GNU Bison Test suite.
-# Copyright (C) 2003, 2004, 2005 Free Software Foundation, Inc.
+# Copyright (C) 2003, 2004, 2005, 2006 Free Software Foundation, Inc.
 
 # 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
@@ -43,6 +43,10 @@
        [m4_fatal([$0: Invalid arguments: address@hidden)])dnl
 m4_pushdef([AT_LALR1_CC_IF],
 [m4_bmatch([$3], ["lalr1.cc"], [$1], [$2])])
+m4_pushdef([AT_GLR_CC_IF],
+[m4_bmatch([$3], ["glr.cc"], [$1], [$2])])
+m4_pushdef([AT_SKEL_CC_IF],
+[m4_bmatch([$3], ["\(glr\|lalr1\).cc"], [$1], [$2])])
 m4_pushdef([AT_GLR_IF],
 [m4_bmatch([$3], [%glr-parser], [$1], [$2])])
 # Using yacc.c?
@@ -122,6 +126,8 @@
 m4_popdef([AT_PARAM_IF])
 m4_popdef([AT_YACC_IF])
 m4_popdef([AT_GLR_IF])
+m4_popdef([AT_SKEL_CC_IF])
+m4_popdef([AT_GLR_CC_IF])
 m4_popdef([AT_LALR1_CC_IF])
 ])# AT_BISON_OPTION_POPDEFS