data/glr.cc

   1                                                                     -*- C -*-
   2
   3 # C++ GLR skeleton for Bison
   4
   5 # Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009,
   6 # 2010 Free Software Foundation, Inc.
   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
  22 # This skeleton produces a C++ class that encapsulates a C glr parser.
  23 # This is in order to reduce the maintenance burden.  The glr.c
  24 # skeleton is clean and pure enough so that there are no real
  25 # problems.  The C++ interface is the same as that of lalr1.cc.  In
  26 # fact, glr.c can replace yacc.c without the user noticing any
  27 # difference, and similarly for glr.cc replacing lalr1.cc.
  28 #
  29 # The passing of parse-params
  30 #
  31 #   The additional arguments are stored as members of the parser
  32 #   object, yyparser.  The C routines need to carry yyparser
  33 #   throughout the C parser; that easy: just let yyparser become an
  34 #   additional parse-param.  But because the C++ skeleton needs to
  35 #   know the "real" original parse-param, we save them
  36 #   (b4_parse_param_orig).  Note that b4_parse_param is overquoted
  37 #   (and c.m4 strips one level of quotes).  This is a PITA, and
  38 #   explains why there are so many levels of quotes.
  39 #
  40 # The locations
  41 #
  42 #   We use location.cc just like lalr1.cc, but because glr.c stores
  43 #   the locations in a (C++) union, the position and location classes
  44 #   must not have a constructor.  Therefore, contrary to lalr1.cc, we
  45 #   must not define "b4_location_constructors".  As a consequence the
  46 #   user must initialize the first positions (in particular the
  47 #   filename member).
  48
  49 # We require a pure interface using locations.
  50 m4_define([b4_locations_flag], [1])
  51 m4_define([b4_pure_flag],      [1])
  52
  53 # The header is mandatory.
  54 b4_defines_if([],
  55               [b4_fatal([b4_skeleton[: using %%defines is mandatory]])])
  56
  57 m4_include(b4_pkgdatadir/[c++.m4])
  58 m4_include(b4_pkgdatadir/[location.cc])
  59
  60 m4_define([b4_parser_class_name],
  61           [b4_percent_define_get([[parser_class_name]])])
  62
  63 # Save the parse parameters.
  64 m4_define([b4_parse_param_orig], m4_defn([b4_parse_param]))
  65
  66
  67 # b4_yy_symbol_print_generate
  68 # ---------------------------
  69 # Bypass the default implementation to generate the "yy_symbol_print"
  70 # and "yy_symbol_value_print" functions.
  71 m4_define([b4_yy_symbol_print_generate],
  72 [[
  73 /*--------------------.
  74 | Print this symbol.  |
  75 `--------------------*/
  76
  77 ]b4_c_ansi_function_def([yy_symbol_print],
  78     [static void],
  79     [[FILE *],               []],
  80     [[int yytype],           [yytype]],
  81     [[const b4_namespace_ref::b4_parser_class_name::semantic_type *yyvaluep],
  82                              [yyvaluep]],
  83     [[const b4_namespace_ref::b4_parser_class_name::location_type *yylocationp],
  84                              [yylocationp]],
  85     b4_parse_param)[
  86 {
  87 ]b4_parse_param_use[]dnl
  88 [  yyparser.yy_symbol_print_ (yytype, yyvaluep]b4_locations_if([, yylocationp])[);
  89 }
  90 ]])
  91
  92
  93 # Declare yyerror.
  94 m4_append([b4_post_prologue],
  95 [b4_syncline([@oline@], [@ofile@])
  96
  97 b4_c_ansi_function_decl([yyerror],
  98     [static void],
  99     [[b4_namespace_ref::b4_parser_class_name::location_type *yylocationp], [yylocationp]],
 100     b4_parse_param,
 101     [[const char* msg], [msg]])])
 102
 103
 104 # Define yyerror.
 105 m4_append([b4_epilogue],
 106 [b4_syncline([@oline@], [@ofile@])[
 107 /*------------------.
 108 | Report an error.  |
 109 `------------------*/
 110
 111 ]b4_c_ansi_function_def([yyerror],
 112     [static void],
 113     [[b4_namespace_ref::b4_parser_class_name::location_type *yylocationp], [yylocationp]],
 114     b4_parse_param,
 115     [[const char* msg], [msg]])[
 116 {
 117 ]b4_parse_param_use[]dnl
 118 [  yyparser.error (*yylocationp, msg);
 119 }
 120
 121
 122 ]b4_namespace_open[
 123 ]dnl In this section, the parse param are the original parse_params.
 124 m4_pushdef([b4_parse_param], m4_defn([b4_parse_param_orig]))dnl
 125 [  /// Build a parser object.
 126   ]b4_parser_class_name::b4_parser_class_name[ (]b4_parse_param_decl[)]m4_ifset([b4_parse_param], [
 127     :])[
 128 #if YYDEBUG
 129     ]m4_ifset([b4_parse_param], [  ], [ :])[yydebug_ (false),
 130       yycdebug_ (&std::cerr)]m4_ifset([b4_parse_param], [,])[
 131 #endif]b4_parse_param_cons[
 132   {
 133   }
 134
 135   ]b4_parser_class_name::~b4_parser_class_name[ ()
 136   {
 137   }
 138
 139   int
 140   ]b4_parser_class_name[::parse ()
 141   {
 142     return ::yyparse (*this]b4_user_args[);
 143   }
 144
 145 #if YYDEBUG
 146   /*--------------------.
 147   | Print this symbol.  |
 148   `--------------------*/
 149
 150   inline void
 151   ]b4_parser_class_name[::yy_symbol_value_print_ (int yytype,
 152                            const semantic_type* yyvaluep, const location_type* yylocationp)
 153   {
 154     /* Pacify ``unused variable'' warnings.  */
 155     YYUSE (yyvaluep);
 156     YYUSE (yylocationp);
 157     switch (yytype)
 158       {
 159   ]m4_map([b4_symbol_actions], m4_defn([b4_symbol_printers]))dnl
 160 [        default:
 161           break;
 162       }
 163   }
 164
 165
 166   void
 167   ]b4_parser_class_name[::yy_symbol_print_ (int yytype,
 168                            const semantic_type* yyvaluep, const location_type* yylocationp)
 169   {
 170     *yycdebug_ << (yytype < YYNTOKENS ? "token" : "nterm")
 171                << ' ' << yytname[yytype] << " ("
 172                << *yylocationp << ": ";
 173     yy_symbol_value_print_ (yytype, yyvaluep, yylocationp);
 174     *yycdebug_ << ')';
 175   }
 176
 177   std::ostream&
 178   ]b4_parser_class_name[::debug_stream () const
 179   {
 180     return *yycdebug_;
 181   }
 182
 183   void
 184   ]b4_parser_class_name[::set_debug_stream (std::ostream& o)
 185   {
 186     yycdebug_ = &o;
 187   }
 188
 189
 190   ]b4_parser_class_name[::debug_level_type
 191   ]b4_parser_class_name[::debug_level () const
 192   {
 193     return yydebug_;
 194   }
 195
 196   void
 197   ]b4_parser_class_name[::set_debug_level (debug_level_type l)
 198   {
 199     yydebug_ = l;
 200   }
 201
 202 #endif
 203 ]m4_popdef([b4_parse_param])dnl
 204 b4_namespace_close[
 205
 206 ]])
 207
 208
 209 # Let glr.c believe that the user arguments include the parser itself.
 210 m4_ifset([b4_parse_param],
 211 [m4_pushdef([b4_parse_param],
 212             m4_dquote([[[b4_namespace_ref::b4_parser_class_name& yyparser], [[yyparser]]],]
 213 m4_defn([b4_parse_param])))],
 214 [m4_pushdef([b4_parse_param],
 215             [[[[b4_namespace_ref::b4_parser_class_name& yyparser], [[yyparser]]]]])
 216 ])
 217 m4_include(b4_pkgdatadir/[glr.c])
 218 m4_popdef([b4_parse_param])
 219
 220 m4_divert_push(0)
 221 @output(b4_spec_defines_file@)@
 222 b4_copyright([Skeleton interface for Bison GLR parsers in C++],
 223              [2002, 2003, 2004, 2005, 2006, 2009, 2010])[
 224
 225 /* C++ GLR parser skeleton written by Akim Demaille.  */
 226
 227 #ifndef PARSER_HEADER_H
 228 # define PARSER_HEADER_H
 229
 230 ]b4_percent_code_get([[requires]])[
 231
 232 #include <string>
 233 #include <iostream>
 234
 235 /* Using locations.  */
 236 #define YYLSP_NEEDED ]b4_locations_flag[
 237
 238 ]b4_namespace_open[
 239   class position;
 240   class location;
 241 ]b4_namespace_close[
 242
 243 #include "location.hh"
 244
 245 /* Enabling traces.  */
 246 #ifndef YYDEBUG
 247 # define YYDEBUG ]b4_debug_flag[
 248 #endif
 249
 250 /* YYLLOC_DEFAULT -- Set CURRENT to span from RHS[1] to RHS[N].
 251    If N is 0, then set CURRENT to the empty location which ends
 252    the previous symbol: RHS[0] (always defined).  */
 253
 254 #ifndef YYLLOC_DEFAULT
 255 # define YYLLOC_DEFAULT(Current, Rhs, N)                                \
 256     do                                                                  \
 257       if (N)                                                            \
 258         {                                                               \
 259           (Current).begin  = YYRHSLOC (Rhs, 1).begin;                   \
 260           (Current).end    = YYRHSLOC (Rhs, N).end;                     \
 261         }                                                               \
 262       else                                                              \
 263         {                                                               \
 264           (Current).begin = (Current).end = YYRHSLOC (Rhs, 0).end;      \
 265         }                                                               \
 266     while (/*CONSTCOND*/ 0)
 267 #endif
 268
 269 ]b4_namespace_open[
 270   /// A Bison parser.
 271   class ]b4_parser_class_name[
 272   {
 273   public:
 274     /// Symbol semantic values.
 275 #ifndef YYSTYPE
 276 ]m4_ifdef([b4_stype],
 277 [    union semantic_type
 278     {
 279 b4_user_stype
 280     };],
 281 [m4_if(b4_tag_seen_flag, 0,
 282 [[    typedef int semantic_type;]],
 283 [[    typedef YYSTYPE semantic_type;]])])[
 284 #else
 285     typedef YYSTYPE semantic_type;
 286 #endif
 287     /// Symbol locations.
 288     typedef ]b4_percent_define_get([[location_type]])[ location_type;
 289     /// Tokens.
 290     struct token
 291     {
 292       ]b4_token_enums(b4_tokens)[
 293     };
 294     /// Token type.
 295     typedef token::yytokentype token_type;
 296
 297     /// Build a parser object.
 298     ]b4_parser_class_name[ (]b4_parse_param_decl[);
 299     virtual ~]b4_parser_class_name[ ();
 300
 301     /// Parse.
 302     /// \returns  0 iff parsing succeeded.
 303     virtual int parse ();
 304
 305     /// The current debugging stream.
 306     std::ostream& debug_stream () const;
 307     /// Set the current debugging stream.
 308     void set_debug_stream (std::ostream &);
 309
 310     /// Type for debugging levels.
 311     typedef int debug_level_type;
 312     /// The current debugging level.
 313     debug_level_type debug_level () const;
 314     /// Set the current debugging level.
 315     void set_debug_level (debug_level_type l);
 316
 317   private:
 318
 319   public:
 320     /// Report a syntax error.
 321     /// \param loc    where the syntax error is found.
 322     /// \param msg    a description of the syntax error.
 323     virtual void error (const location_type& loc, const std::string& msg);
 324   private:
 325
 326 #if YYDEBUG
 327   public:
 328     /// \brief Report a symbol value on the debug stream.
 329     /// \param yytype       The token type.
 330     /// \param yyvaluep     Its semantic value.
 331     /// \param yylocationp  Its location.
 332     virtual void yy_symbol_value_print_ (int yytype,
 333                                          const semantic_type* yyvaluep,
 334                                          const location_type* yylocationp);
 335     /// \brief Report a symbol on the debug stream.
 336     /// \param yytype       The token type.
 337     /// \param yyvaluep     Its semantic value.
 338     /// \param yylocationp  Its location.
 339     virtual void yy_symbol_print_ (int yytype,
 340                                    const semantic_type* yyvaluep,
 341                                    const location_type* yylocationp);
 342   private:
 343     /* Debugging.  */
 344     int yydebug_;
 345     std::ostream* yycdebug_;
 346 #endif
 347
 348
 349     /// \brief Reclaim the memory associated to a symbol.
 350     /// \param yymsg        Why this token is reclaimed.
 351     /// \param yytype       The symbol type.
 352     /// \param yyvaluep     Its semantic value.
 353     /// \param yylocationp  Its location.
 354     inline void yydestruct_ (const char* yymsg,
 355                              int yytype,
 356                              semantic_type* yyvaluep,
 357                              location_type* yylocationp);
 358
 359 ]b4_parse_param_vars[
 360   };
 361
 362 ]dnl Redirections for glr.c.
 363 b4_percent_define_flag_if([[global_tokens_and_yystype]],
 364 [b4_token_defines(b4_tokens)])
 365 [
 366 #ifndef YYSTYPE
 367 # define YYSTYPE ]b4_namespace_ref[::]b4_parser_class_name[::semantic_type
 368 #endif
 369 #ifndef YYLTYPE
 370 # define YYLTYPE ]b4_namespace_ref[::]b4_parser_class_name[::location_type
 371 #endif
 372
 373 ]b4_namespace_close[
 374
 375 ]b4_percent_code_get([[provides]])[]dnl
 376
 377 [#endif /* ! defined PARSER_HEADER_H */]
 378 m4_divert_pop(0)