maint: use *.texi.

[bison.git] / data / glr.cc

diff --git a/data/glr.cc b/data/glr.cc
index 824ce7676cc3b6a6f78ebcc8930fd742c6fc8d17..0bc1f9fa53e0958e926d3ba3921259d0ce08097e 100644 (file)
--- a/data/glr.cc
+++ b/data/glr.cc
@@ -1,87 +1,136 @@
-m4_divert(-1)                                                       -*- C -*-
+                                                                    -*- C -*-

 
 # C++ GLR skeleton for Bison
 
 # C++ GLR skeleton for Bison

-# Copyright (C) 2002, 2003, 2004, 2005 Free Software Foundation, Inc.

 
 

-# This program is free software; you can redistribute it and/or modify
+# Copyright (C) 2002-2012 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
 # it under the terms of the GNU General Public License as published by

-# the Free Software Foundation; either version 2 of the License, or
+# the Free Software Foundation, either version 3 of the License, or

 # (at your option) any later version.
 # (at your option) any later version.

-
+#

 # 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.
 # 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
 # You should have received a copy of the GNU General Public License

-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
-# 02110-1301  USA
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+
+# 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.
 
 # We require a pure interface using locations.

-m4_define([b4_location_flag], [1])
-m4_define([b4_pure],          [1])
+m4_define([b4_locations_flag], [1])
+m4_define([b4_pure_flag],      [1])
+
+# The header is mandatory.
+b4_defines_if([],
+              [b4_fatal([b4_skeleton[: using %%defines is mandatory]])])

 
 m4_include(b4_pkgdatadir/[c++.m4])
 
 m4_include(b4_pkgdatadir/[c++.m4])

-m4_include(b4_pkgdatadir/[location.cc])
+b4_percent_define_ifdef([[location_type]], [],
+                        [m4_include(b4_pkgdatadir/[location.cc])])

 
 

+m4_define([b4_parser_class_name],
+          [b4_percent_define_get([[parser_class_name]])])

 
 

-# b4_yysymprint_generate(FUNCTION-DECLARATOR)
-# -------------------------------------------
-# Generate the "yysymprint" function, which declaration is issued using
-# FUNCTION-DECLARATOR, which may be "b4_c_ansi_function_def" for ISO C
-# or "b4_c_function_def" for K&R.
-m4_define([b4_yysymprint_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]])[
+# Save the parse parameters.
+m4_define([b4_parse_param_orig], m4_defn([b4_parse_param]))

 
 

-/*--------------------------------.
-| Print this symbol on YYOUTPUT.  |
-`--------------------------------*/

 
 

-]$1([yysymprint],
+# 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],
+[[
+/*--------------------.
+| Print this symbol.  |
+`--------------------*/
+
+]b4_c_ansi_function_def([yy_symbol_print],

     [static void],
     [static void],

-    [[FILE *yyoutput],       [yyoutput]],
+    [[FILE *],               []],

     [[int yytype],           [yytype]],
     [[int yytype],           [yytype]],

-    [[const yy::b4_parser_class_name::semantic_type *yyvaluep],
-                             [yyvaluep]][]dnl
-b4_location_if([,
-    [[const yy::b4_parser_class_name::location_type *yylocationp],
-                             [yylocationp]]])[]dnl
-m4_ifset([b4_parse_param], [, b4_parse_param]))[
+    [[const b4_namespace_ref::b4_parser_class_name::semantic_type *yyvaluep],
+                             [yyvaluep]],
+    [[const b4_namespace_ref::b4_parser_class_name::location_type *yylocationp],
+                             [yylocationp]],
+    b4_parse_param)[

 {
 {

-  (void) yyoutput;
-  yyparser.yysymprint_ (yytype, yyvaluep]b4_location_if([, yylocationp])[);
+]b4_parse_param_use[]dnl
+[  yyparser.yy_symbol_print_ (yytype, yyvaluep]b4_locations_if([, yylocationp])[);

 }
 ]])
 
 }
 ]])
 

-m4_prepend([b4_epilogue],
-[[
+
+# Declare yyerror.
+m4_append([b4_post_prologue],
+[b4_syncline([@oline@], [@ofile@])
+
+b4_c_ansi_function_decl([yyerror],
+    [static void],
+    [[const b4_namespace_ref::b4_parser_class_name::location_type *yylocationp],
+                        [yylocationp]],
+    b4_parse_param,
+    [[const char* msg], [msg]])])
+
+
+# Define yyerror.
+m4_append([b4_epilogue],
+[b4_syncline([@oline@], [@ofile@])[

 /*------------------.
 | Report an error.  |
 `------------------*/
 
 ]b4_c_ansi_function_def([yyerror],
     [static void],
 /*------------------.
 | Report an error.  |
 `------------------*/
 
 ]b4_c_ansi_function_def([yyerror],
     [static void],

-    [[yy::b4_parser_class_name::location_type *yylocationp], [yylocationp]],
+    [[const b4_namespace_ref::b4_parser_class_name::location_type *yylocationp],
+                        [yylocationp]],

     b4_parse_param,
     [[const char* msg], [msg]])[
 {
     b4_parse_param,
     [[const char* msg], [msg]])[
 {

-  yyparser.error (*yylocationp, msg);
+]b4_parse_param_use[]dnl
+[  yyparser.error (*yylocationp, msg);

 }
 
 
 }
 
 

-namespace yy
-{
-]dnl Restore the actual parser params.
-m4_popdef([b4_parse_param])dnl
-[
-  /// Build a parser object.
-  ]b4_parser_class_name::b4_parser_class_name[ (]b4_parse_param_decl[)
-    : yycdebug_ (&std::cerr)]b4_parse_param_cons[
+]b4_namespace_open[
+]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[)]m4_ifset([b4_parse_param], [
+    :])[
+#if YYDEBUG
+    ]m4_ifset([b4_parse_param], [  ], [ :])[yydebug_ (false),
+      yycdebug_ (&std::cerr)]m4_ifset([b4_parse_param], [,])[
+#endif]b4_parse_param_cons[

   {
   }
 
   {
   }
 


@@ -96,31 +145,38 @@ m4_popdef([b4_parse_param])dnl
   }
 
 #if YYDEBUG
   }
 
 #if YYDEBUG

-
-  /*--------------------------------.
-  | Print this symbol on YYOUTPUT.  |
-  `--------------------------------*/
-
-  void
-  ]b4_parser_class_name[::yysymprint_ (int yytype,
-                           const semantic_type* yyvaluep, const location_type* yylocationp)
+  /*--------------------.
+  | Print this symbol.  |
+  `--------------------*/
+
+  inline void
+  ]b4_parser_class_name[::yy_symbol_value_print_ (int yytype,
+                           const semantic_type* yyvaluep,
+                           const location_type* yylocationp)

   {
   {

-    /* Pacify ``unused variable'' warnings.  */
-    (void) yyvaluep;
-    (void) yylocationp;
-    /* Backward compatibility, but should be removed eventually. */
-    std::ostream& cdebug_ = *yycdebug_;
-    (void) cdebug_;
-
-    *yycdebug_ << (yytype < YYNTOKENS ? "token" : "nterm")
-              << ' ' << yytname[yytype] << " ("
-               << *yylocationp << ": ";
+    YYUSE (yylocationp);
+    YYUSE (yyvaluep);
+    std::ostream& yyoutput = debug_stream ();
+    std::ostream& yyo = yyoutput;
+    YYUSE (yyo);

     switch (yytype)
       {
   ]m4_map([b4_symbol_actions], m4_defn([b4_symbol_printers]))dnl
 [        default:
           break;
       }
     switch (yytype)
       {
   ]m4_map([b4_symbol_actions], m4_defn([b4_symbol_printers]))dnl
 [        default:
           break;
       }

+  }
+
+
+  void
+  ]b4_parser_class_name[::yy_symbol_print_ (int yytype,
+                           const semantic_type* yyvaluep,
+                           const location_type* yylocationp)
+  {
+    *yycdebug_ << (yytype < YYNTOKENS ? "token" : "nterm")
+               << ' ' << yytname[yytype] << " ("
+               << *yylocationp << ": ";
+    yy_symbol_value_print_ (yytype, yyvaluep, yylocationp);

     *yycdebug_ << ')';
   }
 
     *yycdebug_ << ')';
   }
 


@@ -140,78 +196,55 @@ m4_popdef([b4_parse_param])dnl
   ]b4_parser_class_name[::debug_level_type
   ]b4_parser_class_name[::debug_level () const
   {
   ]b4_parser_class_name[::debug_level_type
   ]b4_parser_class_name[::debug_level () const
   {

-    return ::yydebug;
+    return yydebug_;

   }
 
   void
   ]b4_parser_class_name[::set_debug_level (debug_level_type l)
   {
   }
 
   void
   ]b4_parser_class_name[::set_debug_level (debug_level_type l)
   {

-    ::yydebug = l;
+    yydebug_ = l;

   }
 
   }
 

-#endif /* ! YYDEBUG */
-
-} // namespace yy
+#endif
+]m4_popdef([b4_parse_param])dnl
+b4_namespace_close[

 
 ]])
 
 
 ]])
 

-# 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([[[b4_namespace_ref::b4_parser_class_name& yyparser], [[yyparser]]],]
+m4_defn([b4_parse_param])))],
+[m4_pushdef([b4_parse_param],
+            [[[[b4_namespace_ref::b4_parser_class_name& yyparser], [[yyparser]]]]])
+])

 m4_include(b4_pkgdatadir/[glr.c])
 m4_include(b4_pkgdatadir/[glr.c])

-@output @output_header_name@
-b4_copyright([C++ Skeleton parser for GLALR(1) parsing with Bison],
-             [2002, 2003, 2004, 2005])[
-#ifndef PARSER_HEADER_H
-# define PARSER_HEADER_H
+m4_popdef([b4_parse_param])

 
 

-#include <string>
-#include <iostream>
+m4_divert_push(0)
+@output(b4_spec_defines_file@)@
+b4_copyright([Skeleton interface for Bison GLR parsers in C++],
+             [2002-2006, 2009-2012])[

 
 

-/* Using locations.  */
-#define YYLSP_NEEDED ]b4_locations_flag[
+/* C++ GLR parser skeleton written by Akim Demaille.  */

 
 

-namespace yy
-{
-  class position;
-  class location;
-}
+]b4_cpp_guard_open([b4_spec_defines_file])[

 
 

-/* Copy the first part of user declarations.  */
-]b4_pre_prologue[
+]b4_percent_code_get([[requires]])[

 
 

-]/* Line __line__ of glr.cc.  */
-b4_syncline([@oline@], [@ofile@])[
+#include <string>
+#include <iostream>
+]b4_percent_define_ifdef([[location_type]], [],
+                         [[#include "location.hh"]])[

 
 

-#include "stack.hh"
-#include "location.hh"
+/* Using locations.  */
+#define YYLSP_NEEDED ]b4_locations_flag[

 
 /* Enabling traces.  */
 #ifndef YYDEBUG
 
 /* Enabling traces.  */
 #ifndef YYDEBUG

-# define YYDEBUG ]b4_debug[
-#endif
-
-/* Enabling verbose error messages.  */
-#ifdef YYERROR_VERBOSE
-# undef YYERROR_VERBOSE
-# define YYERROR_VERBOSE 1
-#else
-# define YYERROR_VERBOSE ]b4_error_verbose[
-#endif
-
-/* Enabling the token table.  */
-#ifndef YYTOKEN_TABLE
-# define YYTOKEN_TABLE ]b4_token_table[
-#endif
-
-#if 0
-/* Copy the second part of user declarations.  */
-]b4_post_prologue[
-
-]/* Line __line__ of glr.cc.  */
-
-b4_syncline([@oline@], [@ofile@])[
+# define YYDEBUG ]b4_debug_flag[

 #endif
 
 /* YYLLOC_DEFAULT -- Set CURRENT to span from RHS[1] to RHS[N].
 #endif
 
 /* YYLLOC_DEFAULT -- Set CURRENT to span from RHS[1] to RHS[N].


@@ -219,44 +252,48 @@ b4_syncline([@oline@], [@ofile@])[
    the previous symbol: RHS[0] (always defined).  */
 
 #ifndef YYLLOC_DEFAULT
    the previous symbol: RHS[0] (always defined).  */
 
 #ifndef YYLLOC_DEFAULT

-# define YYLLOC_DEFAULT(Current, Rhs, N)                               \
-    do                                                                 \
-      if (N)                                                           \
-       {                                                               \
-         (Current).begin  = YYRHSLOC (Rhs, 1).begin;                   \
-         (Current).end    = YYRHSLOC (Rhs, N).end;                     \
-       }                                                               \
-      else                                                             \
-       {                                                               \
-         (Current).begin = (Current).end = YYRHSLOC (Rhs, 0).end;      \
-       }                                                               \
+# define YYLLOC_DEFAULT(Current, Rhs, N)                                \
+    do                                                                  \
+      if (N)                                                            \
+        {                                                               \
+          (Current).begin  = YYRHSLOC (Rhs, 1).begin;                   \
+          (Current).end    = YYRHSLOC (Rhs, N).end;                     \
+        }                                                               \
+      else                                                              \
+        {                                                               \
+          (Current).begin = (Current).end = YYRHSLOC (Rhs, 0).end;      \
+        }                                                               \

     while (/*CONSTCOND*/ 0)
 #endif
 
     while (/*CONSTCOND*/ 0)
 #endif
 

-namespace yy
-{
+]b4_namespace_open[

   /// A Bison parser.
   class ]b4_parser_class_name[
   {
   public:
     /// Symbol semantic values.
   /// A Bison parser.
   class ]b4_parser_class_name[
   {
   public:
     /// Symbol semantic values.

-#if ! defined (YYSTYPE)
+#ifndef YYSTYPE

 ]m4_ifdef([b4_stype],
 ]m4_ifdef([b4_stype],

-[b4_syncline([b4_stype_line], [b4_file_name])
-    union semantic_type b4_stype;
-/* Line __line__ of lalr1.cc.  */
-b4_syncline([@oline@], [@ofile@])],
-[    typedef int semantic_type;])[
+[    union semantic_type
+    {
+b4_user_stype
+    };],
+[m4_if(b4_tag_seen_flag, 0,
+[[    typedef int semantic_type;]],
+[[    typedef YYSTYPE semantic_type;]])])[

 #else
     typedef YYSTYPE semantic_type;
 #endif
     /// Symbol locations.
 #else
     typedef YYSTYPE semantic_type;
 #endif
     /// Symbol locations.

-    typedef ]b4_location_type[ location_type;
+    typedef ]b4_percent_define_get([[location_type]],
+                                   [[location]])[ location_type;

     /// Tokens.
     struct token
     {
       ]b4_token_enums(b4_tokens)[
     };
     /// Tokens.
     struct token
     {
       ]b4_token_enums(b4_tokens)[
     };

+    /// Token type.
+    typedef token::yytokentype token_type;

 
     /// Build a parser object.
     ]b4_parser_class_name[ (]b4_parse_param_decl[);
 
     /// Build a parser object.
     ]b4_parser_class_name[ (]b4_parse_param_decl[);


@@ -289,36 +326,41 @@ b4_syncline([@oline@], [@ofile@])],
 
 #if YYDEBUG
   public:
 
 #if YYDEBUG
   public:

-    /// \brief Report a symbol on the debug stream.
+    /// \brief Report a symbol value on the debug stream.

     /// \param yytype       The token type.
     /// \param yyvaluep     Its semantic value.
     /// \param yylocationp  Its location.
     /// \param yytype       The token type.
     /// \param yyvaluep     Its semantic value.
     /// \param yylocationp  Its location.

-    virtual void yysymprint_ (int yytype,
-                             const semantic_type* yyvaluep,
-                             const location_type* yylocationp);
-  private:
-#endif /* ! YYDEBUG */
-
-
-    /// \brief Reclaim the memory associated to a symbol.
-    /// \param yymsg        Why this token is reclaimed.
-    /// \param yytype       The symbol type.
+    virtual void yy_symbol_value_print_ (int yytype,
+                                         const semantic_type* yyvaluep,
+                                         const location_type* yylocationp);
+    /// \brief Report a symbol on the debug stream.
+    /// \param yytype       The token type.

     /// \param yyvaluep     Its semantic value.
     /// \param yylocationp  Its location.
     /// \param yyvaluep     Its semantic value.
     /// \param yylocationp  Its location.

-    inline void yydestruct_ (const char* yymsg,
-                             int yytype,
-                             semantic_type* yyvaluep,
-                             location_type* yylocationp);
-
+    virtual void yy_symbol_print_ (int yytype,
+                                   const semantic_type* yyvaluep,
+                                   const location_type* yylocationp);
+  private:

     /* Debugging.  */
     /* Debugging.  */

+    int yydebug_;

     std::ostream* yycdebug_;
     std::ostream* yycdebug_;

+#endif
+

 ]b4_parse_param_vars[
   };
 
 ]dnl Redirections for glr.c.
 ]b4_parse_param_vars[
   };
 
 ]dnl Redirections for glr.c.

-[#define YYSTYPE yy::]b4_parser_class_name[::semantic_type
-#define YYLTYPE yy::]b4_parser_class_name[::location_type
-
-}
+b4_percent_define_flag_if([[global_tokens_and_yystype]],
+[b4_token_defines(b4_tokens)])
+[
+#ifndef YYSTYPE
+# define YYSTYPE ]b4_namespace_ref[::]b4_parser_class_name[::semantic_type
+#endif
+#ifndef YYLTYPE
+# define YYLTYPE ]b4_namespace_ref[::]b4_parser_class_name[::location_type
+#endif

 
 

-#endif /* ! defined PARSER_HEADER_H */]
+]b4_namespace_close[
+]b4_percent_code_get([[provides]])[
+]b4_cpp_guard_close([b4_spec_defines_file])[
+]m4_divert_pop(0)