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       /// Default constructor.
 170       inline basic_symbol ();
 171 ]b4_locations_if([
 172       /// Constructor.
 173       inline basic_symbol (const location_type& l);])[
 174
 175       /// Copy constructor.
 176       inline basic_symbol (const basic_symbol& other);
 177
 178       /// Constructor for valueless symbols.
 179       inline basic_symbol (typename Base::value_type t]b4_locations_if([,
 180                            const location_type& l])[);
 181
 182       /// Constructor for symbols with semantic value.
 183       inline basic_symbol (typename Base::value_type t,
 184                            const semantic_type& v]b4_locations_if([,
 185                            const location_type& l])[);
 186
 187       /// Assignment operator.
 188       inline basic_symbol& operator= (const basic_symbol& other);
 189
 190       /// Destructive move, \a s is emptied into this.
 191       inline void move (basic_symbol& s);
 192
 193       /// The semantic value.
 194       semantic_type value;]b4_locations_if([
 195
 196       /// The location.
 197       location_type location;])[
 198     };
 199
 200     /// Type access provider for token (enum) based symbols.
 201     struct by_type
 202     {
 203       /// Default constructor.
 204       inline by_type ();
 205
 206       /// Copy constructor.
 207       inline by_type (const by_type& other);
 208
 209       /// Constructor.
 210       inline by_type (token_type t);
 211
 212       /// The symbol type.
 213       int type;
 214
 215       /// The type (corresponding to \a type).
 216       inline int type_get () const;
 217
 218       /// The token.
 219       inline token_type token () const;
 220
 221       /// The type used to store the symbol type.
 222       typedef token_type value_type;
 223     };
 224
 225     /// "External" symbols: returned by the scanner.
 226     typedef basic_symbol<by_type> symbol_type;
 227
 228 ]b4_symbol_constructor_declare])
 229
 230
 231 # b4_public_types_define
 232 # ----------------------
 233 # Provide the implementation needed by the public types.
 234 m4_define([b4_public_types_define],
 235 [[  inline
 236   ]b4_parser_class_name[::syntax_error::syntax_error (]b4_locations_if([const location_type& l, ])[const std::string& m)
 237     : std::runtime_error (m)]b4_locations_if([
 238     , location (l)])[
 239   {}
 240
 241   // basic_symbol.
 242   template <typename Base>
 243   ]b4_parser_class_name[::basic_symbol<Base>::basic_symbol ()
 244     : value ()
 245   {}
 246 ]b4_locations_if([
 247   template <typename Base>
 248   ]b4_parser_class_name[::basic_symbol<Base>::basic_symbol (const location_type& l)
 249     : value ()
 250     , location (l)
 251   {}])[
 252
 253   template <typename Base>
 254   ]b4_parser_class_name[::basic_symbol<Base>&
 255   ]b4_parser_class_name[::basic_symbol<Base>::operator= (const basic_symbol&)
 256   {
 257     abort ();
 258   }
 259
 260   template <typename Base>
 261   ]b4_parser_class_name[::basic_symbol<Base>::basic_symbol (const basic_symbol& other)
 262     : Base (other)
 263     , value ()]b4_locations_if([
 264     , location (other.location)])[
 265   {
 266     ]b4_variant_if([b4_symbol_variant([other.type_get ()], [value], [copy],
 267                                       [other.value])],
 268                    [value = other.value;])[
 269   }
 270
 271
 272   template <typename Base>
 273   ]b4_parser_class_name[::basic_symbol<Base>::basic_symbol (]b4_join(
 274           [typename Base::value_type t],
 275           [const semantic_type& v],
 276           b4_locations_if([const location_type& l]))[)
 277     : Base (t)
 278     , value ()]b4_locations_if([
 279     , location (l)])[
 280   {
 281     // FIXME: The YYUSE macro is only available in the .cc skeleton files.  It
 282     // is not available in .hh files, where this code is when using %defines.
 283     (void) v;
 284     ]b4_variant_if([b4_symbol_variant([this->type_get ()], [value], [copy],
 285                                       [v])],
 286                    [value = v;])[
 287   }
 288
 289   template <typename Base>
 290   ]b4_parser_class_name[::basic_symbol<Base>::basic_symbol (]b4_join(
 291           [typename Base::value_type t],
 292           b4_locations_if([const location_type& l]))[)
 293     : Base (t)]b4_locations_if([
 294     , location (l)])[
 295   {}
 296
 297   template <typename Base>
 298   void
 299   ]b4_parser_class_name[::basic_symbol<Base>::move (basic_symbol& s)
 300   {
 301     this->type = s.type_get ();]b4_locations_if([
 302     location = s.location;])[
 303     ]b4_variant_if([b4_symbol_variant([s.type_get ()], [value], [move],
 304                                       [s.value])],
 305                    [value = s.value;])[
 306   }
 307
 308   // by_type.
 309   ]b4_parser_class_name[::by_type::by_type ()
 310      : type ()
 311   {}
 312
 313   ]b4_parser_class_name[::by_type::by_type (const by_type& other)
 314     : type (other.type)
 315   {}
 316
 317   ]b4_parser_class_name[::by_type::by_type (token_type t)
 318     : type (yytranslate_ (t))
 319   {}
 320
 321   int
 322   ]b4_parser_class_name[::by_type::type_get () const
 323   {
 324     return type;
 325   }
 326 ]b4_token_ctor_if([[
 327   ]b4_parser_class_name[::token_type
 328   ]b4_parser_class_name[::by_type::token () const
 329   {
 330     // YYTOKNUM[NUM] -- (External) token number corresponding to the
 331     // (internal) symbol number NUM (which must be that of a token).  */
 332     static
 333     const ]b4_int_type_for([b4_toknum])[
 334     yytoken_number_[] =
 335     {
 336   ]b4_toknum[
 337     };
 338     return static_cast<token_type> (yytoken_number_[type]);
 339   }
 340 ]])[]dnl
 341 b4_symbol_constructor_define])
 342
 343
 344 # b4_symbol_constructor_declare
 345 # b4_symbol_constructor_define
 346 # -----------------------------
 347 # Declare/define symbol constructors for all the value types.
 348 # Use at class-level.  Redefined in variant.hh.
 349 m4_define([b4_symbol_constructor_declare], [])
 350 m4_define([b4_symbol_constructor_define], [])
 351
 352
 353 # b4_yytranslate_define
 354 # ---------------------
 355 # Define yytranslate_.  Sometimes used in the header file,
 356 # sometimes in the cc file.
 357 m4_define([b4_yytranslate_define],
 358 [[  // Symbol number corresponding to token number t.
 359   ]b4_parser_class_name[::token_number_type
 360   ]b4_parser_class_name[::yytranslate_ (]b4_token_ctor_if([token_type],
 361                                                           [int])[ t)
 362   {
 363     static
 364     const token_number_type
 365     translate_table[] =
 366     {
 367 ]b4_translate[
 368     };
 369     const unsigned int user_token_number_max_ = ]b4_user_token_number_max[;
 370     const token_number_type undef_token_ = ]b4_undef_token_number[;
 371
 372     if (static_cast<int>(t) <= yyeof_)
 373       return yyeof_;
 374     else if (static_cast<unsigned int> (t) <= user_token_number_max_)
 375       return translate_table[t];
 376     else
 377       return undef_token_;
 378   }
 379 ]])
 380
 381
 382 # b4_lhs_value([TYPE])
 383 # --------------------
 384 # Expansion of $<TYPE>$.
 385 m4_define([b4_lhs_value],
 386 [b4_symbol_value([yyval], [$1])])
 387
 388
 389 # b4_rhs_value(RULE-LENGTH, NUM, [TYPE])
 390 # --------------------------------------
 391 # Expansion of $<TYPE>NUM, where the current rule has RULE-LENGTH
 392 # symbols on RHS.
 393 m4_define([b4_rhs_value],
 394 [b4_symbol_value([yysemantic_stack_@{($1) - ($2)@}], [$3])])
 395
 396
 397 # b4_lhs_location()
 398 # -----------------
 399 # Expansion of @$.
 400 m4_define([b4_lhs_location],
 401 [(yyloc)])
 402
 403
 404 # b4_rhs_location(RULE-LENGTH, NUM)
 405 # ---------------------------------
 406 # Expansion of @NUM, where the current rule has RULE-LENGTH symbols
 407 # on RHS.
 408 m4_define([b4_rhs_location],
 409 [(yylocation_stack_@{($1) - ($2)@})])
 410
 411
 412 # b4_parse_param_decl
 413 # -------------------
 414 # Extra formal arguments of the constructor.
 415 # Change the parameter names from "foo" into "foo_yyarg", so that
 416 # there is no collision bw the user chosen attribute name, and the
 417 # argument name in the constructor.
 418 m4_define([b4_parse_param_decl],
 419 [m4_ifset([b4_parse_param],
 420           [m4_map_sep([b4_parse_param_decl_1], [, ], [b4_parse_param])])])
 421
 422 m4_define([b4_parse_param_decl_1],
 423 [$1_yyarg])
 424
 425
 426
 427 # b4_parse_param_cons
 428 # -------------------
 429 # Extra initialisations of the constructor.
 430 m4_define([b4_parse_param_cons],
 431           [m4_ifset([b4_parse_param],
 432                     [
 433       b4_cc_constructor_calls(b4_parse_param)])])
 434 m4_define([b4_cc_constructor_calls],
 435           [m4_map_sep([b4_cc_constructor_call], [,
 436       ], [$@])])
 437 m4_define([b4_cc_constructor_call],
 438           [$2 ($2_yyarg)])
 439
 440 # b4_parse_param_vars
 441 # -------------------
 442 # Extra instance variables.
 443 m4_define([b4_parse_param_vars],
 444           [m4_ifset([b4_parse_param],
 445                     [
 446     // User arguments.
 447 b4_cc_var_decls(b4_parse_param)])])
 448 m4_define([b4_cc_var_decls],
 449           [m4_map_sep([b4_cc_var_decl], [
 450 ], [$@])])
 451 m4_define([b4_cc_var_decl],
 452           [    $1;])
 453
 454
 455 ## ---------##
 456 ## Values.  ##
 457 ## ---------##
 458
 459 # b4_yylloc_default_define
 460 # ------------------------
 461 # Define YYLLOC_DEFAULT.
 462 m4_define([b4_yylloc_default_define],
 463 [[/* YYLLOC_DEFAULT -- Set CURRENT to span from RHS[1] to RHS[N].
 464    If N is 0, then set CURRENT to the empty location which ends
 465    the previous symbol: RHS[0] (always defined).  */
 466
 467 # ifndef YYLLOC_DEFAULT
 468 #  define YYLLOC_DEFAULT(Current, Rhs, N)                               \
 469     do                                                                  \
 470       if (N)                                                            \
 471         {                                                               \
 472           (Current).begin  = YYRHSLOC (Rhs, 1).begin;                   \
 473           (Current).end    = YYRHSLOC (Rhs, N).end;                     \
 474         }                                                               \
 475       else                                                              \
 476         {                                                               \
 477           (Current).begin = (Current).end = YYRHSLOC (Rhs, 0).end;      \
 478         }                                                               \
 479     while (/*CONSTCOND*/ false)
 480 # endif
 481 ]])