data/glr.cc

   1                                                                     -*- C -*-
   2
   3 # C++ GLR skeleton for Bison
   4
   5 # Copyright (C) 2002-2012 Free Software Foundation, Inc.
   6
   7 # This program is free software: you can redistribute it and/or modify
   8 # it under the terms of the GNU General Public License as published by
   9 # the Free Software Foundation, either version 3 of the License, or
  10 # (at your option) any later version.
  11 #
  12 # This program is distributed in the hope that it will be useful,
  13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 # GNU General Public License for more details.
  16 #
  17 # You should have received a copy of the GNU General Public License
  18 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19
  20
  21 # This skeleton produces a C++ class that encapsulates a C glr parser.
  22 # This is in order to reduce the maintenance burden.  The glr.c
  23 # skeleton is clean and pure enough so that there are no real
  24 # problems.  The C++ interface is the same as that of lalr1.cc.  In
  25 # fact, glr.c can replace yacc.c without the user noticing any
  26 # difference, and similarly for glr.cc replacing lalr1.cc.
  27 #
  28 # The passing of parse-params
  29 #
  30 #   The additional arguments are stored as members of the parser
  31 #   object, yyparser.  The C routines need to carry yyparser
  32 #   throughout the C parser; that easy: just let yyparser become an
  33 #   additional parse-param.  But because the C++ skeleton needs to
  34 #   know the "real" original parse-param, we save them
  35 #   (b4_parse_param_orig).  Note that b4_parse_param is overquoted
  36 #   (and c.m4 strips one level of quotes).  This is a PITA, and
  37 #   explains why there are so many levels of quotes.
  38 #
  39 # The locations
  40 #
  41 #   We use location.cc just like lalr1.cc, but because glr.c stores
  42 #   the locations in a (C++) union, the position and location classes
  43 #   must not have a constructor.  Therefore, contrary to lalr1.cc, we
  44 #   must not define "b4_location_constructors".  As a consequence the
  45 #   user must initialize the first positions (in particular the
  46 #   filename member).
  47
  48 # We require a pure interface using locations.
  49 m4_define([b4_locations_flag], [1])
  50 m4_define([b4_pure_flag],      [1])
  51
  52 # The header is mandatory.
  53 b4_defines_if([],
  54               [b4_fatal([b4_skeleton[: using %%defines is mandatory]])])
  55
  56 m4_include(b4_pkgdatadir/[c++.m4])
  57 b4_percent_define_ifdef([[location_type]], [],
  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     YYUSE (yylocationp);
 155     YYUSE (yyvaluep);
 156     std::ostream& yyoutput = debug_stream ();
 157     std::ostream& yyo = yyoutput;
 158     YYUSE (yyo);
 159     switch (yytype)
 160       {
 161   ]m4_map([b4_symbol_actions], m4_defn([b4_symbol_printers]))dnl
 162 [        default:
 163           break;
 164       }
 165   }
 166
 167
 168   void
 169   ]b4_parser_class_name[::yy_symbol_print_ (int yytype,
 170                            const semantic_type* yyvaluep, const location_type* yylocationp)
 171   {
 172     *yycdebug_ << (yytype < YYNTOKENS ? "token" : "nterm")
 173                << ' ' << yytname[yytype] << " ("
 174                << *yylocationp << ": ";
 175     yy_symbol_value_print_ (yytype, yyvaluep, yylocationp);
 176     *yycdebug_ << ')';
 177   }
 178
 179   std::ostream&
 180   ]b4_parser_class_name[::debug_stream () const
 181   {
 182     return *yycdebug_;
 183   }
 184
 185   void
 186   ]b4_parser_class_name[::set_debug_stream (std::ostream& o)
 187   {
 188     yycdebug_ = &o;
 189   }
 190
 191
 192   ]b4_parser_class_name[::debug_level_type
 193   ]b4_parser_class_name[::debug_level () const
 194   {
 195     return yydebug_;
 196   }
 197
 198   void
 199   ]b4_parser_class_name[::set_debug_level (debug_level_type l)
 200   {
 201     yydebug_ = l;
 202   }
 203
 204 #endif
 205 ]m4_popdef([b4_parse_param])dnl
 206 b4_namespace_close[
 207
 208 ]])
 209
 210
 211 # Let glr.c believe that the user arguments include the parser itself.
 212 m4_ifset([b4_parse_param],
 213 [m4_pushdef([b4_parse_param],
 214             m4_dquote([[[b4_namespace_ref::b4_parser_class_name& yyparser], [[yyparser]]],]
 215 m4_defn([b4_parse_param])))],
 216 [m4_pushdef([b4_parse_param],
 217             [[[[b4_namespace_ref::b4_parser_class_name& yyparser], [[yyparser]]]]])
 218 ])
 219 m4_include(b4_pkgdatadir/[glr.c])
 220 m4_popdef([b4_parse_param])
 221
 222 m4_divert_push(0)
 223 @output(b4_spec_defines_file@)@
 224 b4_copyright([Skeleton interface for Bison GLR parsers in C++],
 225              [2002-2006, 2009-2012])[
 226
 227 /* C++ GLR parser skeleton written by Akim Demaille.  */
 228
 229 #ifndef PARSER_HEADER_H
 230 # define PARSER_HEADER_H
 231
 232 ]b4_percent_code_get([[requires]])[
 233
 234 #include <string>
 235 #include <iostream>
 236 ]b4_percent_define_ifdef([[location_type]], [],
 237                          [[#include "location.hh"]])[
 238
 239 /* Using locations.  */
 240 #define YYLSP_NEEDED ]b4_locations_flag[
 241
 242 /* Enabling traces.  */
 243 #ifndef YYDEBUG
 244 # define YYDEBUG ]b4_debug_flag[
 245 #endif
 246
 247 /* YYLLOC_DEFAULT -- Set CURRENT to span from RHS[1] to RHS[N].
 248    If N is 0, then set CURRENT to the empty location which ends
 249    the previous symbol: RHS[0] (always defined).  */
 250
 251 #ifndef YYLLOC_DEFAULT
 252 # define YYLLOC_DEFAULT(Current, Rhs, N)                                \
 253     do                                                                  \
 254       if (N)                                                            \
 255         {                                                               \
 256           (Current).begin  = YYRHSLOC (Rhs, 1).begin;                   \
 257           (Current).end    = YYRHSLOC (Rhs, N).end;                     \
 258         }                                                               \
 259       else                                                              \
 260         {                                                               \
 261           (Current).begin = (Current).end = YYRHSLOC (Rhs, 0).end;      \
 262         }                                                               \
 263     while (/*CONSTCOND*/ 0)
 264 #endif
 265
 266 ]b4_namespace_open[
 267   /// A Bison parser.
 268   class ]b4_parser_class_name[
 269   {
 270   public:
 271     /// Symbol semantic values.
 272 #ifndef YYSTYPE
 273 ]m4_ifdef([b4_stype],
 274 [    union semantic_type
 275     {
 276 b4_user_stype
 277     };],
 278 [m4_if(b4_tag_seen_flag, 0,
 279 [[    typedef int semantic_type;]],
 280 [[    typedef YYSTYPE semantic_type;]])])[
 281 #else
 282     typedef YYSTYPE semantic_type;
 283 #endif
 284     /// Symbol locations.
 285     typedef ]b4_percent_define_get([[location_type]],
 286                                    [[location]])[ location_type;
 287     /// Tokens.
 288     struct token
 289     {
 290       ]b4_token_enums(b4_tokens)[
 291     };
 292     /// Token type.
 293     typedef token::yytokentype token_type;
 294
 295     /// Build a parser object.
 296     ]b4_parser_class_name[ (]b4_parse_param_decl[);
 297     virtual ~]b4_parser_class_name[ ();
 298
 299     /// Parse.
 300     /// \returns  0 iff parsing succeeded.
 301     virtual int parse ();
 302
 303     /// The current debugging stream.
 304     std::ostream& debug_stream () const;
 305     /// Set the current debugging stream.
 306     void set_debug_stream (std::ostream &);
 307
 308     /// Type for debugging levels.
 309     typedef int debug_level_type;
 310     /// The current debugging level.
 311     debug_level_type debug_level () const;
 312     /// Set the current debugging level.
 313     void set_debug_level (debug_level_type l);
 314
 315   private:
 316
 317   public:
 318     /// Report a syntax error.
 319     /// \param loc    where the syntax error is found.
 320     /// \param msg    a description of the syntax error.
 321     virtual void error (const location_type& loc, const std::string& msg);
 322   private:
 323
 324 #if YYDEBUG
 325   public:
 326     /// \brief Report a symbol value on the debug stream.
 327     /// \param yytype       The token type.
 328     /// \param yyvaluep     Its semantic value.
 329     /// \param yylocationp  Its location.
 330     virtual void yy_symbol_value_print_ (int yytype,
 331                                          const semantic_type* yyvaluep,
 332                                          const location_type* yylocationp);
 333     /// \brief Report a symbol on the debug stream.
 334     /// \param yytype       The token type.
 335     /// \param yyvaluep     Its semantic value.
 336     /// \param yylocationp  Its location.
 337     virtual void yy_symbol_print_ (int yytype,
 338                                    const semantic_type* yyvaluep,
 339                                    const location_type* yylocationp);
 340   private:
 341     /* Debugging.  */
 342     int yydebug_;
 343     std::ostream* yycdebug_;
 344 #endif
 345
 346
 347     /// \brief Reclaim the memory associated to a symbol.
 348     /// \param yymsg        Why this token is reclaimed.
 349     /// \param yytype       The symbol type.
 350     /// \param yyvaluep     Its semantic value.
 351     /// \param yylocationp  Its location.
 352     inline void yydestruct_ (const char* yymsg,
 353                              int yytype,
 354                              semantic_type* yyvaluep,
 355                              location_type* yylocationp);
 356
 357 ]b4_parse_param_vars[
 358   };
 359
 360 ]dnl Redirections for glr.c.
 361 b4_percent_define_flag_if([[global_tokens_and_yystype]],
 362 [b4_token_defines(b4_tokens)])
 363 [
 364 #ifndef YYSTYPE
 365 # define YYSTYPE ]b4_namespace_ref[::]b4_parser_class_name[::semantic_type
 366 #endif
 367 #ifndef YYLTYPE
 368 # define YYLTYPE ]b4_namespace_ref[::]b4_parser_class_name[::location_type
 369 #endif
 370
 371 ]b4_namespace_close[
 372
 373 ]b4_percent_code_get([[provides]])[]dnl
 374
 375 [#endif /* ! defined PARSER_HEADER_H */]
 376 m4_divert_pop(0)