data/c.m4

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