data/c.m4

   1                                                             -*- Autoconf -*-
   2
   3 # C M4 Macros for Bison.
   4
   5 # Copyright (C) 2002, 2004-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 ## Identification.  ##
  22 ## ---------------- ##
  23
  24 # b4_comment_(TEXT, OPEN, CONTINUE, END)
  25 # -------------------------------------
  26 # Put TEXT in comment.  Avoid trailing spaces: don't indent empty lines.
  27 # Avoid adding indentation to the first line, as the indentation comes
  28 # from OPEN.  That's why we don't patsubst([$1], [^\(.\)], [   \1]).
  29 #
  30 # Prefix all the output lines with PREFIX.
  31 m4_define([b4_comment_], [$2[]m4_bpatsubst([$1], [
  32 \(.\)], [
  33 $3\1])$4])
  34
  35
  36 # b4_c_comment(TEXT, [PREFIX])
  37 # ----------------------------
  38 # Put TEXT in comment.  Avoid trailing spaces: don't indent empty lines.
  39 # Avoid adding indentation to the first line, as the indentation comes
  40 # from "/*".  That's why we don't patsubst([$1], [^\(.\)], [   \1]).
  41 #
  42 # Prefix all the output lines with PREFIX.
  43 m4_define([b4_c_comment],
  44 [b4_comment_([$1], [$2/* ], [$2   ], [$2  */])])
  45
  46
  47 # b4_comment(TEXT, [PREFIX])
  48 # --------------------------
  49 # By default, C comments.
  50 m4_define([b4_comment], [b4_c_comment($@)])
  51
  52
  53 # b4_identification
  54 # -----------------
  55 # Depends on individual skeletons to define b4_pure_flag, b4_push_flag, or
  56 # b4_pull_flag if they use the values of the %define variables api.pure or
  57 # api.push-pull.
  58 m4_define([b4_identification],
  59 [[/* Identify Bison output.  */
  60 #define YYBISON 1
  61
  62 /* Bison version.  */
  63 #define YYBISON_VERSION "]b4_version["
  64
  65 /* Skeleton name.  */
  66 #define YYSKELETON_NAME ]b4_skeleton[]m4_ifdef([b4_pure_flag], [[
  67
  68 /* Pure parsers.  */
  69 #define YYPURE ]b4_pure_flag])[]m4_ifdef([b4_push_flag], [[
  70
  71 /* Push parsers.  */
  72 #define YYPUSH ]b4_push_flag])[]m4_ifdef([b4_pull_flag], [[
  73
  74 /* Pull parsers.  */
  75 #define YYPULL ]b4_pull_flag])[
  76
  77 /* Using locations.  */
  78 #define YYLSP_NEEDED ]b4_locations_if([1], [0])[
  79 ]])
  80
  81
  82 ## ---------------- ##
  83 ## Default values.  ##
  84 ## ---------------- ##
  85
  86 # If the %union is not named, its name is YYSTYPE.
  87 m4_define_default([b4_union_name], [YYSTYPE])
  88
  89 # If the %name-prefix is not given, it is yy.
  90 m4_define_default([b4_prefix], [yy])
  91
  92 ## ------------------------ ##
  93 ## Pure/impure interfaces.  ##
  94 ## ------------------------ ##
  95
  96 # b4_user_args
  97 # ------------
  98 m4_define([b4_user_args],
  99 [m4_ifset([b4_parse_param], [, b4_c_args(b4_parse_param)])])
 100
 101
 102 # b4_parse_param
 103 # --------------
 104 # If defined, b4_parse_param arrives double quoted, but below we prefer
 105 # it to be single quoted.
 106 m4_define([b4_parse_param],
 107 b4_parse_param)
 108
 109
 110 # b4_parse_param_for(DECL, FORMAL, BODY)
 111 # ---------------------------------------
 112 # Iterate over the user parameters, binding the declaration to DECL,
 113 # the formal name to FORMAL, and evaluating the BODY.
 114 m4_define([b4_parse_param_for],
 115 [m4_foreach([$1_$2], m4_defn([b4_parse_param]),
 116 [m4_pushdef([$1], m4_unquote(m4_car($1_$2)))dnl
 117 m4_pushdef([$2], m4_shift($1_$2))dnl
 118 $3[]dnl
 119 m4_popdef([$2])dnl
 120 m4_popdef([$1])dnl
 121 ])])
 122
 123 # b4_parse_param_use([VAL], [LOC])
 124 # --------------------------------
 125 # `YYUSE' VAL, LOC if locations are enabled, and all the parse-params.
 126 m4_define([b4_parse_param_use],
 127 [m4_ifvaln([$1], [  YYUSE([$1]);])dnl
 128 b4_locations_if([m4_ifvaln([$2], [  YYUSE ([$2]);])])dnl
 129 b4_parse_param_for([Decl], [Formal], [  YYUSE (Formal);
 130 ])dnl
 131 ])
 132
 133
 134 ## ------------ ##
 135 ## Data Types.  ##
 136 ## ------------ ##
 137
 138 # b4_int_type(MIN, MAX)
 139 # ---------------------
 140 # Return the smallest int type able to handle numbers ranging from
 141 # MIN to MAX (included).
 142 m4_define([b4_int_type],
 143 [m4_if(b4_ints_in($@,      [0],   [255]), [1], [unsigned char],
 144        b4_ints_in($@,   [-128],   [127]), [1], [signed char],
 145
 146        b4_ints_in($@,      [0], [65535]), [1], [unsigned short int],
 147        b4_ints_in($@, [-32768], [32767]), [1], [short int],
 148
 149        m4_eval([0 <= $1]),                [1], [unsigned int],
 150
 151                                                [int])])
 152
 153
 154 # b4_int_type_for(NAME)
 155 # ---------------------
 156 # Return the smallest int type able to handle numbers ranging from
 157 # `NAME_min' to `NAME_max' (included).
 158 m4_define([b4_int_type_for],
 159 [b4_int_type($1_min, $1_max)])
 160
 161
 162 # b4_table_value_equals(TABLE, VALUE, LITERAL)
 163 # --------------------------------------------
 164 # Without inducing a comparison warning from the compiler, check if the
 165 # literal value LITERAL equals VALUE from table TABLE, which must have
 166 # TABLE_min and TABLE_max defined.  YYID must be defined as an identity
 167 # function that suppresses warnings about constant conditions.
 168 m4_define([b4_table_value_equals],
 169 [m4_if(m4_eval($3 < m4_indir([b4_]$1[_min])
 170                || m4_indir([b4_]$1[_max]) < $3), [1],
 171        [[YYID (0)]],
 172        [[((]$2[) == (]$3[))]])])
 173
 174 ## ---------##
 175 ## Values.  ##
 176 ## ---------##
 177
 178 # b4_null
 179 ---------
 180 # Return a null pointer constant.  NULL infringes on the user name
 181 # space in C, so use 0 rather than NULL.
 182 m4_define([b4_null], [0])
 183
 184
 185 # b4_integral_parser_table_define(TABLE-NAME, CONTENT, COMMENT)
 186 # -------------------------------------------------------------
 187 # Define "yy<TABLE-NAME>" which contents is CONTENT.
 188 m4_define([b4_integral_parser_table_define],
 189 [m4_ifvaln([$3], [b4_c_comment([$3], [  ])])dnl
 190 static const b4_int_type_for([$2]) yy$1[[]] =
 191 {
 192   $2
 193 };dnl
 194 ])
 195
 196
 197 ## ------------------------- ##
 198 ## Assigning token numbers.  ##
 199 ## ------------------------- ##
 200
 201 # b4_token_define(TOKEN-NAME, TOKEN-NUMBER)
 202 # -----------------------------------------
 203 # Output the definition of this token as #define.
 204 m4_define([b4_token_define],
 205 [#define b4_percent_define_get([api.tokens.prefix])$1 $2
 206 ])
 207
 208
 209 # b4_token_defines(LIST-OF-PAIRS-TOKEN-NAME-TOKEN-NUMBER)
 210 # -------------------------------------------------------
 211 # Output the definition of the tokens (if there are) as #defines.
 212 m4_define([b4_token_defines],
 213 [m4_if([$#$1], [1], [],
 214 [/* Tokens.  */
 215 m4_map([b4_token_define], [$@])])
 216 ])
 217
 218
 219 # b4_token_enum(TOKEN-NAME, TOKEN-NUMBER)
 220 # ---------------------------------------
 221 # Output the definition of this token as an enum.
 222 m4_define([b4_token_enum],
 223 [b4_percent_define_get([api.tokens.prefix])$1 = $2])
 224
 225
 226 # b4_token_enums(LIST-OF-PAIRS-TOKEN-NAME-TOKEN-NUMBER)
 227 # -----------------------------------------------------
 228 # Output the definition of the tokens (if there are) as enums.
 229 m4_define([b4_token_enums],
 230 [m4_if([$#$1], [1], [],
 231 [/* Tokens.  */
 232 #ifndef YYTOKENTYPE
 233 # define YYTOKENTYPE
 234    /* Put the tokens into the symbol table, so that GDB and other debuggers
 235       know about them.  */
 236    enum yytokentype {
 237 m4_map_sep([     b4_token_enum], [,
 238 ],
 239            [$@])
 240    };
 241 #endif
 242 ])])
 243
 244
 245 # b4_token_enums_defines(LIST-OF-PAIRS-TOKEN-NAME-TOKEN-NUMBER)
 246 # -------------------------------------------------------------
 247 # Output the definition of the tokens (if there are any) as enums and, if POSIX
 248 # Yacc is enabled, as #defines.
 249 m4_define([b4_token_enums_defines],
 250 [b4_token_enums($@)b4_yacc_if([b4_token_defines($@)], [])
 251 ])
 252
 253
 254 ## ----------------- ##
 255 ## Semantic Values.  ##
 256 ## ----------------- ##
 257
 258
 259 # b4_symbol_value(VAL, [TYPE])
 260 # ----------------------------
 261 # Given a semantic value VAL ($$, $1 etc.), extract its value of type
 262 # TYPE if TYPE is given, otherwise just return VAL.  The result can be
 263 # used safetly, it is put in parens to avoid nasty precedence issues.
 264 # TYPE is *not* put in braces, provide some if needed.
 265 m4_define([b4_symbol_value],
 266 [($1[]m4_ifval([$2], [.$2]))])
 267
 268
 269
 270 ## --------------------------------------------- ##
 271 ## Defining C functions in both K&R and ANSI-C.  ##
 272 ## --------------------------------------------- ##
 273
 274
 275 # b4_modern_c
 276 # -----------
 277 # A predicate useful in #if to determine whether C is ancient or modern.
 278 #
 279 # If __STDC__ is defined, the compiler is modern.  IBM xlc 7.0 when run
 280 # as 'cc' doesn't define __STDC__ (or __STDC_VERSION__) for pedantic
 281 # reasons, but it defines __C99__FUNC__ so check that as well.
 282 # Microsoft C normally doesn't define these macros, but it defines _MSC_VER.
 283 # Consider a C++ compiler to be modern if it defines __cplusplus.
 284 #
 285 m4_define([b4_c_modern],
 286   [[(defined __STDC__ || defined __C99__FUNC__ \
 287      || defined __cplusplus || defined _MSC_VER)]])
 288
 289 # b4_c_function_def(NAME, RETURN-VALUE, [DECL1, NAME1], ...)
 290 # ----------------------------------------------------------
 291 # Declare the function NAME.
 292 m4_define([b4_c_function_def],
 293 [#if b4_c_modern
 294 b4_c_ansi_function_def($@)
 295 #else
 296 $2
 297 $1 (b4_c_knr_formal_names(m4_shift2($@)))
 298 b4_c_knr_formal_decls(m4_shift2($@))
 299 #endif[]dnl
 300 ])
 301
 302
 303 # b4_c_ansi_function_def(NAME, RETURN-VALUE, [DECL1, NAME1], ...)
 304 # ---------------------------------------------------------------
 305 # Declare the function NAME in ANSI.
 306 m4_define([b4_c_ansi_function_def],
 307 [$2
 308 $1 (b4_c_ansi_formals(m4_shift2($@)))[]dnl
 309 ])
 310
 311
 312 # b4_c_ansi_formals([DECL1, NAME1], ...)
 313 # --------------------------------------
 314 # Output the arguments ANSI-C definition.
 315 m4_define([b4_c_ansi_formals],
 316 [m4_if([$#], [0], [void],
 317        [$#$1], [1], [void],
 318                [m4_map_sep([b4_c_ansi_formal], [, ], [$@])])])
 319
 320 m4_define([b4_c_ansi_formal],
 321 [$1])
 322
 323
 324 # b4_c_knr_formal_names([DECL1, NAME1], ...)
 325 # ------------------------------------------
 326 # Output the argument names.
 327 m4_define([b4_c_knr_formal_names],
 328 [m4_map_sep([b4_c_knr_formal_name], [, ], [$@])])
 329
 330 m4_define([b4_c_knr_formal_name],
 331 [$2])
 332
 333
 334 # b4_c_knr_formal_decls([DECL1, NAME1], ...)
 335 # ------------------------------------------
 336 # Output the K&R argument declarations.
 337 m4_define([b4_c_knr_formal_decls],
 338 [m4_map_sep([b4_c_knr_formal_decl],
 339             [
 340 ],
 341             [$@])])
 342
 343 m4_define([b4_c_knr_formal_decl],
 344 [    $1;])
 345
 346
 347
 348 ## ------------------------------------------------------------ ##
 349 ## Declaring (prototyping) C functions in both K&R and ANSI-C.  ##
 350 ## ------------------------------------------------------------ ##
 351
 352
 353 # b4_c_function_decl(NAME, RETURN-VALUE, [DECL1, NAME1], ...)
 354 # -----------------------------------------------------------
 355 # Declare the function NAME.
 356 m4_define([b4_c_function_decl],
 357 [#if b4_c_modern
 358 b4_c_ansi_function_decl($@)
 359 #else
 360 $2 $1 ();
 361 #endif[]dnl
 362 ])
 363
 364
 365 # b4_c_ansi_function_decl(NAME, RETURN-VALUE, [DECL1, NAME1], ...)
 366 # ----------------------------------------------------------------
 367 # Declare the function NAME.
 368 m4_define([b4_c_ansi_function_decl],
 369 [$2 $1 (b4_c_ansi_formals(m4_shift2($@)));[]dnl
 370 ])
 371
 372
 373
 374
 375 ## --------------------- ##
 376 ## Calling C functions.  ##
 377 ## --------------------- ##
 378
 379
 380 # b4_c_function_call(NAME, RETURN-VALUE, [DECL1, NAME1], ...)
 381 # -----------------------------------------------------------
 382 # Call the function NAME with arguments NAME1, NAME2 etc.
 383 m4_define([b4_c_function_call],
 384 [$1 (b4_c_args(m4_shift2($@)))[]dnl
 385 ])
 386
 387
 388 # b4_c_args([DECL1, NAME1], ...)
 389 # ------------------------------
 390 # Output the arguments NAME1, NAME2...
 391 m4_define([b4_c_args],
 392 [m4_map_sep([b4_c_arg], [, ], [$@])])
 393
 394 m4_define([b4_c_arg],
 395 [$2])
 396
 397
 398 ## ----------- ##
 399 ## Synclines.  ##
 400 ## ----------- ##
 401
 402 # b4_sync_start(LINE, FILE)
 403 # -----------------------
 404 m4_define([b4_sync_start], [[#]line $1 $2])
 405
 406
 407 ## -------------- ##
 408 ## User actions.  ##
 409 ## -------------- ##
 410
 411 # b4_case(LABEL, STATEMENTS)
 412 # --------------------------
 413 m4_define([b4_case],
 414 [  case $1:
 415 $2
 416 b4_syncline([@oline@], [@ofile@])
 417     break;])
 418
 419
 420 # b4_predicate_case(LABEL, CONDITIONS)
 421 # ------------------------------------
 422 m4_define([b4_predicate_case],
 423 [  case $1:
 424     if (! ($2)) YYERROR;
 425 b4_syncline([@oline@], [@ofile@])
 426     break;])
 427
 428
 429 # b4_yydestruct_generate(FUNCTION-DECLARATOR)
 430 # -------------------------------------------
 431 # Generate the "yydestruct" function, which declaration is issued using
 432 # FUNCTION-DECLARATOR, which may be "b4_c_ansi_function_def" for ISO C
 433 # or "b4_c_function_def" for K&R.
 434 m4_define_default([b4_yydestruct_generate],
 435 [[/*-----------------------------------------------.
 436 | Release the memory associated to this symbol.  |
 437 `-----------------------------------------------*/
 438
 439 /*ARGSUSED*/
 440 ]$1([yydestruct],
 441     [static void],
 442     [[const char *yymsg],    [yymsg]],
 443     [[int yytype],           [yytype]],
 444     [[YYSTYPE *yyvaluep],    [yyvaluep]][]dnl
 445 b4_locations_if(            [, [[YYLTYPE *yylocationp], [yylocationp]]])[]dnl
 446 m4_ifset([b4_parse_param], [, b4_parse_param]))[
 447 {
 448 ]b4_parse_param_use([yyvaluep], [yylocationp])dnl
 449 [  if (!yymsg)
 450     yymsg = "Deleting";
 451   YY_SYMBOL_PRINT (yymsg, yytype, yyvaluep, yylocationp);
 452
 453   switch (yytype)
 454     {
 455 ]b4_symbol_foreach([b4_symbol_destructor])dnl
 456 [      default:
 457         break;
 458     }
 459 }]dnl
 460 ])
 461
 462
 463 # b4_yy_symbol_print_generate(FUNCTION-DECLARATOR)
 464 # ------------------------------------------------
 465 # Generate the "yy_symbol_print" function, which declaration is issued using
 466 # FUNCTION-DECLARATOR, which may be "b4_c_ansi_function_def" for ISO C
 467 # or "b4_c_function_def" for K&R.
 468 m4_define_default([b4_yy_symbol_print_generate],
 469 [[
 470 /*--------------------------------.
 471 | Print this symbol on YYOUTPUT.  |
 472 `--------------------------------*/
 473
 474 /*ARGSUSED*/
 475 ]$1([yy_symbol_value_print],
 476     [static void],
 477                [[FILE *yyoutput],                       [yyoutput]],
 478                [[int yytype],                           [yytype]],
 479                [[YYSTYPE const * const yyvaluep],       [yyvaluep]][]dnl
 480 b4_locations_if([, [[YYLTYPE const * const yylocationp], [yylocationp]]])[]dnl
 481 m4_ifset([b4_parse_param], [, b4_parse_param]))[
 482 {
 483 ]b4_parse_param_use([yyoutput], [yylocationp])dnl
 484 [  if (!yyvaluep)
 485     return;]
 486 dnl glr.c does not feature yytoknum.
 487 m4_if(b4_skeleton, ["yacc.c"],
 488 [[# ifdef YYPRINT
 489   if (yytype < YYNTOKENS)
 490     YYPRINT (yyoutput, yytoknum[yytype], *yyvaluep);
 491 # endif
 492 ]])dnl
 493 [  switch (yytype)
 494     {
 495 ]b4_symbol_foreach([b4_symbol_printer])dnl
 496 [      default:
 497         break;
 498     }
 499 }
 500
 501
 502 /*--------------------------------.
 503 | Print this symbol on YYOUTPUT.  |
 504 `--------------------------------*/
 505
 506 ]$1([yy_symbol_print],
 507     [static void],
 508                [[FILE *yyoutput],                       [yyoutput]],
 509                [[int yytype],                           [yytype]],
 510                [[YYSTYPE const * const yyvaluep],       [yyvaluep]][]dnl
 511 b4_locations_if([, [[YYLTYPE const * const yylocationp], [yylocationp]]])[]dnl
 512 m4_ifset([b4_parse_param], [, b4_parse_param]))[
 513 {
 514   if (yytype < YYNTOKENS)
 515     YYFPRINTF (yyoutput, "token %s (", yytname[yytype]);
 516   else
 517     YYFPRINTF (yyoutput, "nterm %s (", yytname[yytype]);
 518
 519 ]b4_locations_if([  YY_LOCATION_PRINT (yyoutput, *yylocationp);
 520   YYFPRINTF (yyoutput, ": ");
 521 ])dnl
 522 [  yy_symbol_value_print (yyoutput, yytype, yyvaluep]dnl
 523 b4_locations_if([, yylocationp])[]b4_user_args[);
 524   YYFPRINTF (yyoutput, ")");
 525 }]dnl
 526 ])