data/c++.m4

   1                                                             -*- Autoconf -*-
   2
   3 # C++ skeleton for Bison
   4
   5 # Copyright (C) 2002-2013 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 m4_include(b4_pkgdatadir/[c.m4])
  21
  22 # b4_comment(TEXT, [PREFIX])
  23 # --------------------------
  24 # Put TEXT in comment. Prefix all the output lines with PREFIX.
  25 m4_define([b4_comment],
  26 [b4_comment_([$1], [$2// ], [$2// ])])
  27
  28
  29 ## ---------------- ##
  30 ## Default values.  ##
  31 ## ---------------- ##
  32
  33 b4_percent_define_default([[parser_class_name]], [[parser]])
  34
  35 # Don't do that so that we remember whether we're using a user
  36 # request, or the default value.
  37 #
  38 # b4_percent_define_default([[api.location.type]], [[location]])
  39
  40 b4_percent_define_default([[filename_type]], [[std::string]])
  41 b4_percent_define_default([[api.namespace]], m4_defn([b4_prefix]))
  42
  43 b4_percent_define_default([[global_tokens_and_yystype]], [[false]])
  44 b4_percent_define_default([[define_location_comparison]],
  45                           [m4_if(b4_percent_define_get([[filename_type]]),
  46                                  [std::string], [[true]], [[false]])])
  47
  48
  49
  50 ## ----------- ##
  51 ## Namespace.  ##
  52 ## ----------- ##
  53
  54 m4_define([b4_namespace_ref], [b4_percent_define_get([[api.namespace]])])
  55
  56
  57 # Don't permit an empty b4_namespace_ref.  Any `::parser::foo' appended to it
  58 # would compile as an absolute reference with `parser' in the global namespace.
  59 # b4_namespace_open would open an anonymous namespace and thus establish
  60 # internal linkage.  This would compile.  However, it's cryptic, and internal
  61 # linkage for the parser would be specified in all translation units that
  62 # include the header, which is always generated.  If we ever need to permit
  63 # internal linkage somehow, surely we can find a cleaner approach.
  64 m4_if(m4_bregexp(b4_namespace_ref, [^[   ]*$]), [-1], [],
  65 [b4_complain_at(b4_percent_define_get_loc([[api.namespace]]),
  66                 [[namespace reference is empty]])])
  67
  68 # Instead of assuming the C++ compiler will do it, Bison should reject any
  69 # invalid b4_namepsace_ref that would be converted to a valid
  70 # b4_namespace_open.  The problem is that Bison doesn't always output
  71 # b4_namespace_ref to uncommented code but should reserve the ability to do so
  72 # in future releases without risking breaking any existing user grammars.
  73 # Specifically, don't allow empty names as b4_namespace_open would just convert
  74 # those into anonymous namespaces, and that might tempt some users.
  75 m4_if(m4_bregexp(b4_namespace_ref, [::[  ]*::]), [-1], [],
  76 [b4_complain_at(b4_percent_define_get_loc([[api.namespace]]),
  77                 [[namespace reference has consecutive "::"]])])
  78 m4_if(m4_bregexp(b4_namespace_ref, [::[  ]*$]), [-1], [],
  79 [b4_complain_at(b4_percent_define_get_loc([[api.namespace]]),
  80                 [[namespace reference has a trailing "::"]])])
  81
  82 m4_define([b4_namespace_open],
  83 [b4_user_code([b4_percent_define_get_syncline([[api.namespace]])
  84 [namespace ]m4_bpatsubst(m4_dquote(m4_bpatsubst(m4_dquote(b4_namespace_ref),
  85                                                 [^\(.\)[         ]*::], [\1])),
  86                          [::], [ { namespace ])[ {]])])
  87
  88 m4_define([b4_namespace_close],
  89 [b4_user_code([b4_percent_define_get_syncline([[api.namespace]])
  90 m4_bpatsubst(m4_dquote(m4_bpatsubst(m4_dquote(b4_namespace_ref[ ]),
  91                                     [^\(.\)[     ]*\(::\)?\([^][:]\|:[^:]\)*],
  92                                     [\1])),
  93              [::\([^][:]\|:[^:]\)*], [} ])[} // ]b4_namespace_ref])])
  94
  95
  96 # b4_token_enums
  97 # --------------
  98 # Output the definition of the tokens as enums.
  99 m4_define([b4_token_enums],
 100 [[enum yytokentype
 101       {
 102         ]m4_join([,
 103         ],
 104                  b4_symbol_map([b4_token_enum]))[
 105       };]dnl
 106 ])
 107
 108
 109
 110
 111 ## ----------------- ##
 112 ## Semantic Values.  ##
 113 ## ----------------- ##
 114
 115 # b4_semantic_type_declare
 116 # ------------------------
 117 # Declare semantic_type.
 118 m4_define([b4_semantic_type_declare],
 119 [    /// Symbol semantic values.
 120 m4_ifdef([b4_stype],
 121 [    union semantic_type
 122     {
 123 b4_user_stype
 124     };],
 125 [m4_if(b4_tag_seen_flag, 0,
 126 [[    typedef int semantic_type;]],
 127 [[    typedef ]b4_api_PREFIX[STYPE semantic_type;]])])])
 128
 129
 130 # b4_public_types_declare
 131 # -----------------------
 132 # Define the public types: token, semantic value, location, and so forth.
 133 # Depending on %define token_lex, may be output in the header or source file.
 134 m4_define([b4_public_types_declare],
 135 [[#ifndef ]b4_api_PREFIX[STYPE
 136 ]b4_semantic_type_declare[
 137 #else
 138     typedef ]b4_api_PREFIX[STYPE semantic_type;
 139 #endif]b4_locations_if([
 140     /// Symbol locations.
 141     typedef b4_percent_define_get([[api.location.type]],
 142                                   [[location]]) location_type;])[
 143
 144     /// Syntax errors thrown from user actions.
 145     struct syntax_error : std::runtime_error
 146     {
 147       syntax_error (]b4_locations_if([const location_type& l, ])[const std::string& m);]b4_locations_if([
 148       location_type location;])[
 149     };
 150
 151     /// Tokens.
 152     struct token
 153     {
 154       ]b4_token_enums[
 155     };
 156
 157     /// Token type.
 158     typedef token::yytokentype token_type;
 159
 160     /// A complete symbol.
 161     ///
 162     /// Expects its Base type to provide access to the symbol type
 163     /// via type_get().
 164     ///
 165     /// Provide access to semantic value]b4_locations_if([ and location])[.
 166     template <typename Base>
 167     struct basic_symbol : Base
 168     {
 169       /// Alias to Base.
 170       typedef Base super_type;
 171
 172       /// Default constructor.
 173       inline basic_symbol ();
 174 ]b4_locations_if([
 175       /// Constructor.
 176       inline basic_symbol (const location_type& l);])[
 177
 178       /// Copy constructor.
 179       inline basic_symbol (const basic_symbol& other);
 180
 181       /// Constructor for valueless symbols.
 182       inline basic_symbol (typename Base::value_type t]b4_locations_if([,
 183                            const location_type& l])[);
 184
 185       /// Constructor for symbols with semantic value.
 186       inline basic_symbol (typename Base::value_type t,
 187                            const semantic_type& v]b4_locations_if([,
 188                            const location_type& l])[);
 189
 190       ~basic_symbol ();
 191       /// Assignment operator.
 192       inline basic_symbol& operator= (const basic_symbol& other);
 193
 194       /// Destructive move, \a s is emptied into this.
 195       inline void move (basic_symbol& s);
 196
 197       /// The semantic value.
 198       semantic_type value;]b4_locations_if([
 199
 200       /// The location.
 201       location_type location;])[
 202     };
 203
 204     /// Type access provider for token (enum) based symbols.
 205     struct by_type
 206     {
 207       /// Default constructor.
 208       inline by_type ();
 209
 210       /// Copy constructor.
 211       inline by_type (const by_type& other);
 212
 213       /// Constructor.
 214       inline by_type (token_type t);
 215
 216       /// Steal the type of \a that.
 217       void move (by_type& that);
 218
 219       /// The symbol type.
 220       ///
 221       /// -1 when this symbol is empty.
 222       int type;
 223
 224       /// The type (corresponding to \a type).
 225       ///
 226       /// -1 when this symbol is empty.
 227       inline int type_get () const;
 228
 229       /// The token.
 230       inline token_type token () const;
 231
 232       /// The type used to store the symbol type.
 233       typedef token_type value_type;
 234     };
 235
 236     /// "External" symbols: returned by the scanner.
 237     typedef basic_symbol<by_type> symbol_type;
 238
 239 ]b4_symbol_constructor_declare])
 240
 241
 242 # b4_public_types_define
 243 # ----------------------
 244 # Provide the implementation needed by the public types.
 245 m4_define([b4_public_types_define],
 246 [[  inline
 247   ]b4_parser_class_name[::syntax_error::syntax_error (]b4_locations_if([const location_type& l, ])[const std::string& m)
 248     : std::runtime_error (m)]b4_locations_if([
 249     , location (l)])[
 250   {}
 251
 252   // basic_symbol.
 253   template <typename Base>
 254   ]b4_parser_class_name[::basic_symbol<Base>::basic_symbol ()
 255     : value ()
 256   {}
 257 ]b4_locations_if([
 258   template <typename Base>
 259   ]b4_parser_class_name[::basic_symbol<Base>::basic_symbol (const location_type& l)
 260     : value ()
 261     , location (l)
 262   {}])[
 263
 264   template <typename Base>
 265   ]b4_parser_class_name[::basic_symbol<Base>&
 266   ]b4_parser_class_name[::basic_symbol<Base>::operator= (const basic_symbol&)
 267   {
 268     abort ();
 269   }
 270
 271   template <typename Base>
 272   ]b4_parser_class_name[::basic_symbol<Base>::basic_symbol (const basic_symbol& other)
 273     : Base (other)
 274     , value ()]b4_locations_if([
 275     , location (other.location)])[
 276   {
 277     ]b4_variant_if([b4_symbol_variant([other.type_get ()], [value], [copy],
 278                                       [other.value])],
 279                    [value = other.value;])[
 280   }
 281
 282
 283   template <typename Base>
 284   ]b4_parser_class_name[::basic_symbol<Base>::basic_symbol (]b4_join(
 285           [typename Base::value_type t],
 286           [const semantic_type& v],
 287           b4_locations_if([const location_type& l]))[)
 288     : Base (t)
 289     , value (]b4_variant_if([], [v])[)]b4_locations_if([
 290     , location (l)])[
 291   {]b4_variant_if([[
 292     (void) v;
 293     ]b4_symbol_variant([this->type_get ()], [value], [copy], [v])])[}
 294
 295   template <typename Base>
 296   ]b4_parser_class_name[::basic_symbol<Base>::basic_symbol (]b4_join(
 297           [typename Base::value_type t],
 298           b4_locations_if([const location_type& l]))[)
 299     : Base (t)
 300     , value ()]b4_locations_if([
 301     , location (l)])[
 302   {}
 303
 304   template <typename Base>
 305   inline
 306   ]b4_parser_class_name[::basic_symbol<Base>::~basic_symbol ()
 307   {]b4_variant_if([[
 308     // User destructor.
 309     int yytype = this->type_get ();
 310     switch (yytype)
 311     {
 312 ]b4_symbol_foreach([b4_symbol_destructor])dnl
 313 [   default:
 314       break;
 315     }
 316
 317     // Type destructor.
 318   ]b4_symbol_variant([[yytype]], [[value]], [[template destroy]])])[
 319   }
 320
 321   template <typename Base>
 322   void
 323   ]b4_parser_class_name[::basic_symbol<Base>::move (basic_symbol& s)
 324   {
 325     super_type::move(s);
 326     ]b4_variant_if([b4_symbol_variant([this->type_get ()], [value], [move],
 327                                       [s.value])],
 328                    [value = s.value;])[]b4_locations_if([
 329     location = s.location;])[
 330   }
 331
 332   // by_type.
 333   ]b4_parser_class_name[::by_type::by_type ()
 334      : type (-1)
 335   {}
 336
 337   ]b4_parser_class_name[::by_type::by_type (const by_type& other)
 338     : type (other.type)
 339   {}
 340
 341   ]b4_parser_class_name[::by_type::by_type (token_type t)
 342     : type (yytranslate_ (t))
 343   {}
 344
 345   inline
 346   void
 347   ]b4_parser_class_name[::by_type::move (by_type& that)
 348   {
 349     type = that.type;
 350     that.type = -1;
 351   }
 352
 353   int
 354   ]b4_parser_class_name[::by_type::type_get () const
 355   {
 356     return type;
 357   }
 358 ]b4_token_ctor_if([[
 359   ]b4_parser_class_name[::token_type
 360   ]b4_parser_class_name[::by_type::token () const
 361   {
 362     // YYTOKNUM[NUM] -- (External) token number corresponding to the
 363     // (internal) symbol number NUM (which must be that of a token).  */
 364     static
 365     const ]b4_int_type_for([b4_toknum])[
 366     yytoken_number_[] =
 367     {
 368   ]b4_toknum[
 369     };
 370     return static_cast<token_type> (yytoken_number_[type]);
 371   }
 372 ]])[]dnl
 373 b4_symbol_constructor_define])
 374
 375
 376 # b4_symbol_constructor_declare
 377 # b4_symbol_constructor_define
 378 # -----------------------------
 379 # Declare/define symbol constructors for all the value types.
 380 # Use at class-level.  Redefined in variant.hh.
 381 m4_define([b4_symbol_constructor_declare], [])
 382 m4_define([b4_symbol_constructor_define], [])
 383
 384
 385 # b4_yytranslate_define
 386 # ---------------------
 387 # Define yytranslate_.  Sometimes used in the header file,
 388 # sometimes in the cc file.
 389 m4_define([b4_yytranslate_define],
 390 [[  // Symbol number corresponding to token number t.
 391   ]b4_parser_class_name[::token_number_type
 392   ]b4_parser_class_name[::yytranslate_ (]b4_token_ctor_if([token_type],
 393                                                           [int])[ t)
 394   {
 395     static
 396     const token_number_type
 397     translate_table[] =
 398     {
 399 ]b4_translate[
 400     };
 401     const unsigned int user_token_number_max_ = ]b4_user_token_number_max[;
 402     const token_number_type undef_token_ = ]b4_undef_token_number[;
 403
 404     if (static_cast<int>(t) <= yyeof_)
 405       return yyeof_;
 406     else if (static_cast<unsigned int> (t) <= user_token_number_max_)
 407       return translate_table[t];
 408     else
 409       return undef_token_;
 410   }
 411 ]])
 412
 413
 414 # b4_lhs_value([TYPE])
 415 # --------------------
 416 # Expansion of $<TYPE>$.
 417 m4_define([b4_lhs_value],
 418 [b4_symbol_value([yyval], [$1])])
 419
 420
 421 # b4_rhs_value(RULE-LENGTH, NUM, [TYPE])
 422 # --------------------------------------
 423 # Expansion of $<TYPE>NUM, where the current rule has RULE-LENGTH
 424 # symbols on RHS.
 425 m4_define([b4_rhs_value],
 426 [b4_symbol_value([yysemantic_stack_@{($1) - ($2)@}], [$3])])
 427
 428
 429 # b4_lhs_location()
 430 # -----------------
 431 # Expansion of @$.
 432 m4_define([b4_lhs_location],
 433 [(yyloc)])
 434
 435
 436 # b4_rhs_location(RULE-LENGTH, NUM)
 437 # ---------------------------------
 438 # Expansion of @NUM, where the current rule has RULE-LENGTH symbols
 439 # on RHS.
 440 m4_define([b4_rhs_location],
 441 [(yylocation_stack_@{($1) - ($2)@})])
 442
 443
 444 # b4_parse_param_decl
 445 # -------------------
 446 # Extra formal arguments of the constructor.
 447 # Change the parameter names from "foo" into "foo_yyarg", so that
 448 # there is no collision bw the user chosen attribute name, and the
 449 # argument name in the constructor.
 450 m4_define([b4_parse_param_decl],
 451 [m4_ifset([b4_parse_param],
 452           [m4_map_sep([b4_parse_param_decl_1], [, ], [b4_parse_param])])])
 453
 454 m4_define([b4_parse_param_decl_1],
 455 [$1_yyarg])
 456
 457
 458
 459 # b4_parse_param_cons
 460 # -------------------
 461 # Extra initialisations of the constructor.
 462 m4_define([b4_parse_param_cons],
 463           [m4_ifset([b4_parse_param],
 464                     [
 465       b4_cc_constructor_calls(b4_parse_param)])])
 466 m4_define([b4_cc_constructor_calls],
 467           [m4_map_sep([b4_cc_constructor_call], [,
 468       ], [$@])])
 469 m4_define([b4_cc_constructor_call],
 470           [$2 ($2_yyarg)])
 471
 472 # b4_parse_param_vars
 473 # -------------------
 474 # Extra instance variables.
 475 m4_define([b4_parse_param_vars],
 476           [m4_ifset([b4_parse_param],
 477                     [
 478     // User arguments.
 479 b4_cc_var_decls(b4_parse_param)])])
 480 m4_define([b4_cc_var_decls],
 481           [m4_map_sep([b4_cc_var_decl], [
 482 ], [$@])])
 483 m4_define([b4_cc_var_decl],
 484           [    $1;])
 485
 486
 487 ## ---------##
 488 ## Values.  ##
 489 ## ---------##
 490
 491 # b4_yylloc_default_define
 492 # ------------------------
 493 # Define YYLLOC_DEFAULT.
 494 m4_define([b4_yylloc_default_define],
 495 [[/* YYLLOC_DEFAULT -- Set CURRENT to span from RHS[1] to RHS[N].
 496    If N is 0, then set CURRENT to the empty location which ends
 497    the previous symbol: RHS[0] (always defined).  */
 498
 499 # ifndef YYLLOC_DEFAULT
 500 #  define YYLLOC_DEFAULT(Current, Rhs, N)                               \
 501     do                                                                  \
 502       if (N)                                                            \
 503         {                                                               \
 504           (Current).begin  = YYRHSLOC (Rhs, 1).begin;                   \
 505           (Current).end    = YYRHSLOC (Rhs, N).end;                     \
 506         }                                                               \
 507       else                                                              \
 508         {                                                               \
 509           (Current).begin = (Current).end = YYRHSLOC (Rhs, 0).end;      \
 510         }                                                               \
 511     while (/*CONSTCOND*/ false)
 512 # endif
 513 ]])