1 # Process this -*- Autotest -*- file with autom4te.
3 # Macros for the GNU Bison Test suite.
5 # Copyright (C) 2003-2013 Free Software Foundation, Inc.
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.
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.
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/>.
20 m4_version_prereq([2.58])
23 # m4_null_if(VAL, IF-TRUE, IF-FALSE)
24 # ----------------------------------
25 # If VAL evaluates to empty or 0, run IF-TRUE, otherwise IF-FALSE.
26 m4_define([m4_null_if],
27 [m4_case(m4_quote($1),
32 # AT_SETUP_STRIP(TITLE)
33 # ---------------------
34 # Abbreviate the TITLE to be passed to AT_SETUP. Remove new-lines
35 # that completely break AT_SETUP.
36 m4_define([AT_SETUP_STRIP],
38 [%\(language\|skeleton\) "?\([^\" ]*\)"?],
40 [%define "?\([-A-Za-z0-9_.]+\)"? \({[^\}]+}\|"[^\"]+"\|[-A-Za-z0-9_.]+\)],
42 [%define "?\([-A-Za-z0-9_.]+\)"?],
53 # AT_MATCHES_CHECK(FILE, PERL-REGEXP, COUNT)
54 # ------------------------------------------
55 # Expect COUNT matches of the PERL-REGEXP in FILE. The file is
56 # taken in "slurp" mode, i.e., one can match end-of-lines.
57 m4_define([AT_MATCHES_CHECK],
58 [AT_CHECK([$PERL -0777 -ne '
60 s{$2}{ ++$count; "" }gem;
61 printf "$count\n";' $1], [0], [$3
65 # AT_SAVE_SPECIAL_FILES / AT_RESTORE_SPECIAL_FILES
66 # ------------------------------------------------
67 # Don't interfere with caller's files.
68 m4_divert_text([PREPARE_TESTS],
69 [at_save_special_files ()
71 for at_save_file in stderr experr expout
73 test ! -f at-bison-check-$at_save_file.bak ||
74 as_fn_error 1 "fatal error: back-up on top of a back-up"
75 test ! -f $at_save_file || mv $at_save_file at-bison-check-$at_save_file.bak
79 at_restore_special_files ()
81 for at_save_file in stderr experr expout
83 test ! -f at-bison-check-$at_save_file.bak ||
84 mv at-bison-check-$at_save_file.bak $at_save_file
89 m4_define([AT_SAVE_SPECIAL_FILES], [at_save_special_files])
90 m4_define([AT_RESTORE_SPECIAL_FILES], [at_restore_special_files])
94 ## ------------------------------- ##
95 ## Macros decoding Bison options. ##
96 ## ------------------------------- ##
98 # AT_LOC_PUSHDEF(FIRST-LINE, FIRST-COLUMN, LAST-LINE, LAST-COLUMN)
99 # ----------------------------------------------------------------
100 # Pushdef AT(_LOC)?_(FIRST|LAST)_(LINE|COLUMN).
101 m4_define([AT_LOC_PUSHDEF],
102 [m4_pushdef([AT_FIRST_LINE], [$1])
103 m4_pushdef([AT_FIRST_COLUMN], [$2])
104 m4_pushdef([AT_LAST_LINE], [$3])
105 m4_pushdef([AT_LAST_COLUMN], [$4])
106 m4_pushdef([AT_LOC_FIRST_LINE], [AT_LOC.AT_FIRST_LINE])
107 m4_pushdef([AT_LOC_FIRST_COLUMN], [AT_LOC.AT_FIRST_COLUMN])
108 m4_pushdef([AT_LOC_LAST_LINE], [AT_LOC.AT_LAST_LINE])
109 m4_pushdef([AT_LOC_LAST_COLUMN], [AT_LOC.AT_LAST_COLUMN])])
113 # Popdef AT(_LOC)?_(FIRST|LAST)_(LINE|COLUMN).
114 m4_define([AT_LOC_POPDEF],
115 [m4_popdef([AT_LOC_FIRST_LINE])
116 m4_popdef([AT_LOC_FIRST_COLUMN])
117 m4_popdef([AT_LOC_LAST_LINE])
118 m4_popdef([AT_LOC_LAST_COLUMN])
119 m4_popdef([AT_FIRST_LINE])
120 m4_popdef([AT_FIRST_COLUMN])
121 m4_popdef([AT_LAST_LINE])
122 m4_popdef([AT_LAST_COLUMN])
127 # AT_BISON_OPTION_PUSHDEFS([BISON-OPTIONS])
128 # -----------------------------------------
129 m4_define([AT_BISON_OPTION_PUSHDEFS],
130 [m4_divert_text([KILL],
131 [_AT_BISON_OPTION_PUSHDEFS($[1], $[2], [$1])])])
134 # _AT_BISON_OPTION_PUSHDEFS($1, $2, [BISON-OPTIONS])
135 # --------------------------------------------------
136 # This macro works around the impossibility to define macros
137 # inside macros, because issuing '[$1]' is not possible in M4 :(.
138 # This sucks hard, GNU M4 should really provide M5-like $$1.
139 m4_define([_AT_BISON_OPTION_PUSHDEFS],
140 [m4_if([$1$2], $[1]$[2], [],
141 [m4_fatal([$0: Invalid arguments: $@])])dnl
142 m4_pushdef([AT_DEFINES_IF],
143 [m4_bmatch([$3], [%defines], [$1], [$2])])
144 m4_pushdef([AT_DEBUG_IF],
145 [m4_bmatch([$3], [%debug\|%define parse.trace], [$1], [$2])])
146 m4_pushdef([AT_SKEL_CC_IF],
147 [m4_bmatch([$3], [%language "[Cc]\+\+"\|%skeleton "[a-z0-9]+\.cc"], [$1], [$2])])
148 m4_pushdef([AT_SKEL_JAVA_IF],
149 [m4_bmatch([$3], [%language "[Jj][Aa][Vv][Aa]"\|%skeleton "[a-z0-9]+\.java"], [$1], [$2])])
150 # The target language: "c", "c++", or "java".
151 m4_pushdef([AT_LANG],
152 [AT_SKEL_JAVA_IF([java],
153 [AT_SKEL_CC_IF([c++],
155 m4_pushdef([AT_GLR_IF],
156 [m4_bmatch([$3], [%glr-parser\|%skeleton "glr\..*"], [$1], [$2])])
157 m4_pushdef([AT_LALR1_CC_IF],
158 [AT_SKEL_CC_IF([AT_GLR_IF([$2], [$1])], [$2])])
159 m4_pushdef([AT_GLR_CC_IF],
160 [AT_SKEL_CC_IF([AT_GLR_IF([$1], [$2])], [$2])])
162 m4_pushdef([AT_YACC_IF],
163 [m4_bmatch([$3], [%language\|%glr-parser\|%skeleton], [$2], [$1])])
164 m4_pushdef([AT_LEXPARAM_IF],
165 [m4_bmatch([$3], [%lex-param], [$1], [$2])])
166 m4_pushdef([AT_LOCATION_IF],
167 [m4_bmatch([$3], [%locations], [$1], [$2])])
168 m4_pushdef([AT_LOCATION_TYPE_IF],
169 [m4_bmatch([$3], [%define \(api\.location\.type\|location_type\)], [$1], [$2])])
170 m4_pushdef([AT_PARAM_IF],
171 [m4_bmatch([$3], [%parse-param], [$1], [$2])])
172 # Comma-terminated list of formals parse-parameters.
173 # E.g., %parse-param { int x } %parse-param {int y} -> "int x, int y, ".
174 # FIXME: Support grouped parse-param.
175 m4_pushdef([AT_PARSE_PARAMS])
176 m4_bpatsubst([$3], [%parse-param { *\([^{}]*[^{} ]\) *}],
177 [m4_append([AT_PARSE_PARAMS], [\1, ])])
179 m4_pushdef([AT_PURE_IF],
180 [m4_bmatch([$3], [%define *api\.pure\|%pure-parser],
181 [m4_bmatch([$3], [%define *api\.pure *"?false"?], [$2], [$1])],
183 # AT_NAME_PREFIX: also consider api.namespace.
184 m4_pushdef([AT_NAME_PREFIX],
185 [m4_bmatch([$3], [\(%define api\.\(namespace\|prefix\)\|%name-prefix\) .*],
187 [\(%define api\.\(namespace\|prefix\)\|%name-prefix\) [\{\"]\([^""]*\)[\"\}]],
190 m4_pushdef([AT_TOKEN_CTOR_IF],
191 [m4_bmatch([$3], [%define api\.token\.constructor], [$1], [$2])])
192 m4_pushdef([AT_TOKEN_PREFIX],
193 [m4_bmatch([$3], [%define api\.token\.prefix ".*"],
194 [m4_bregexp([$3], [%define api\.token\.prefix "\(.*\)"], [\1])])])
195 m4_pushdef([AT_VARIANT_IF],
196 [m4_bmatch([$3], [%define api\.value\.type "?variant"?], [$1], [$2])])
197 m4_pushdef([AT_API_prefix],
198 [m4_bmatch([$3], [%define api\.prefix ".*"],
199 [m4_bregexp([$3], [%define api\.prefix "\([^""]*\)"], [\1])],
201 m4_pushdef([AT_API_PREFIX],
202 [m4_toupper(AT_API_prefix)])
203 # yyerror receives the location if %location, and if the parser is pure. For
204 # historical reasons, with the "yacc.c" skeleton, the location is not passed
205 # unless an additional "%parse-param" is present, or if the purity is defined
207 m4_pushdef([AT_YYERROR_ARG_LOC_IF],
208 [AT_LOCATION_IF([AT_PURE_IF([m4_bmatch([$3],
209 m4_quote(m4_join([\|],
210 [%define api\.pure "?full"?],
213 [%skeleton "?glr.c"?])),
218 # yyerror always sees the locations (when activated) if the parser is impure.
219 # When the parser is pure, yyerror sees the location if it is received as an
221 m4_pushdef([AT_YYERROR_SEES_LOC_IF],
222 [AT_LOCATION_IF([AT_YACC_IF([AT_PURE_IF([AT_YYERROR_ARG_LOC_IF([$1], [$2])],
227 # The interface is pure: either because %define api.pure, or because we
228 # are using the C++ parsers.
229 m4_pushdef([AT_PURE_LEX_IF],
231 [AT_SKEL_CC_IF([$1], [$2])])])
233 m4_pushdef([AT_YYSTYPE],
234 [AT_SKEL_CC_IF([AT_NAME_PREFIX[::parser::semantic_type]],
235 [AT_API_PREFIX[STYPE]])])
236 m4_pushdef([AT_YYLTYPE],
237 [AT_SKEL_CC_IF([AT_NAME_PREFIX[::parser::location_type]],
238 [AT_API_PREFIX[LTYPE]])])
242 [m4_pushdef([AT_LOC], [(*llocp)])
243 m4_pushdef([AT_VAL], [(*lvalp)])
244 m4_pushdef([AT_YYLEX_FORMALS],
245 [AT_YYSTYPE *lvalp[]AT_LOCATION_IF([, AT_YYLTYPE *llocp])])
246 m4_pushdef([AT_YYLEX_ARGS],
247 [lvalp[]AT_LOCATION_IF([, llocp])])
248 m4_pushdef([AT_USE_LEX_ARGS],
249 [(void) lvalp;AT_LOCATION_IF([(void) llocp])])
250 m4_pushdef([AT_YYLEX_PRE_FORMALS],
251 [AT_YYLEX_FORMALS, ])
252 m4_pushdef([AT_YYLEX_PRE_ARGS],
255 [m4_pushdef([AT_LOC], [[(]AT_NAME_PREFIX[lloc)]])
256 m4_pushdef([AT_VAL], [[(]AT_NAME_PREFIX[lval)]])
257 m4_pushdef([AT_YYLEX_FORMALS], [void])
258 m4_pushdef([AT_YYLEX_ARGS], [])
259 m4_pushdef([AT_USE_LEX_ARGS], [])
260 m4_pushdef([AT_YYLEX_PRE_FORMALS], [])
261 m4_pushdef([AT_YYLEX_PRE_ARGS], [])
264 # Handle the different types of location components.
267 [AT_LOCATION_TYPE_IF(
268 [AT_LOC_PUSHDEF([first.l], [first.c], [last.l], [last.c])],
269 [AT_LOC_PUSHDEF([begin.line], [begin.column], [end.line], [end.column])])],
270 [AT_LOC_PUSHDEF([first_line], [first_column], [last_line], [last_column])])
273 AT_GLR_IF([AT_KEYWORDS([glr])])
274 ])# _AT_BISON_OPTION_PUSHDEFS
277 # AT_BISON_OPTION_POPDEFS
278 # -----------------------
279 m4_define([AT_BISON_OPTION_POPDEFS],
280 [m4_divert_text([KILL],
281 [m4_popdef([AT_YYLEX_PRE_ARGS])
282 m4_popdef([AT_YYLEX_PRE_FORMALS])
283 m4_popdef([AT_USE_LEX_ARGS])
284 m4_popdef([AT_YYLEX_ARGS])
285 m4_popdef([AT_YYLEX_FORMALS])
286 m4_popdef([AT_YYLTYPE])
287 m4_popdef([AT_YYSTYPE])
290 m4_popdef([AT_PURE_LEX_IF])
291 m4_popdef([AT_YYERROR_SEES_LOC_IF])
292 m4_popdef([AT_YYERROR_ARG_LOC_IF])
293 m4_popdef([AT_API_PREFIX])
294 m4_popdef([AT_API_prefix])
295 m4_popdef([AT_VARIANT_IF])
296 m4_popdef([AT_TOKEN_PREFIX])
297 m4_popdef([AT_TOKEN_CTOR_IF])
298 m4_popdef([AT_NAME_PREFIX])
299 m4_popdef([AT_LOCATION_TYPE_IF])
300 m4_popdef([AT_LOCATION_IF])
301 m4_popdef([AT_PARSE_PARAMS])
302 m4_popdef([AT_PARAM_IF])
303 m4_popdef([AT_LEXPARAM_IF])
304 m4_popdef([AT_YACC_IF])
305 m4_popdef([AT_GLR_IF])
306 m4_popdef([AT_SKEL_CC_IF])
308 m4_popdef([AT_SKEL_JAVA_IF])
309 m4_popdef([AT_GLR_CC_IF])
310 m4_popdef([AT_LALR1_CC_IF])
311 m4_popdef([AT_DEFINES_IF])
312 m4_popdef([AT_DEBUG_IF])
314 ])# AT_BISON_OPTION_POPDEFS
318 ## -------------------------- ##
319 ## Generating Grammar Files. ##
320 ## -------------------------- ##
322 # _AT_LANG_DISPATCH(LANG, MACRO, ARGS)
323 # ------------------------------------
324 # Call the specialization of MACRO for LANG with ARGS. Complain if
326 m4_define([_AT_LANG_DISPATCH],
328 [m4_indir([$2($1)], m4_shift2($@))],
329 [m4_fatal([$2: unknown language: $1])])])
332 # AT_LANG_DISPATCH(MACRO, ARGS)
333 # -----------------------------
334 # Call the specialization of MACRO for AT_LANG with ARGS. Complain if
336 m4_define([AT_LANG_DISPATCH],
337 [_AT_LANG_DISPATCH(AT_LANG, $@)])
341 # AT_DATA_SOURCE_PROLOGUE
342 # ------------------------
343 # The prologue that should be included in any source code that is
344 # meant to be compiled.
345 m4_define([AT_DATA_SOURCE_PROLOGUE],
346 [[#include <config.h>
347 /* We don't need perfect functions for these tests. */
353 # AT_DATA_GRAMMAR_PROLOGUE
354 # ------------------------
355 # The prologue that should be included in any grammar which parser is
356 # meant to be compiled.
357 m4_define([AT_DATA_GRAMMAR_PROLOGUE],
359 ]AT_DATA_SOURCE_PROLOGUE[]dnl
363 # AT_DATA_SOURCE(NAME, CONTENT)
364 # -----------------------------
365 # Generate the file NAME, which CONTENT is preceded by
366 # AT_DATA_SOURCE_PROLOGUE.
367 m4_define([AT_DATA_SOURCE],
369 [AT_DATA_SOURCE_PROLOGUE
373 # AT_DATA_GRAMMAR(NAME, CONTENT)
374 # ------------------------------
375 # Generate the file NAME, which CONTENT is preceded by
376 # AT_DATA_GRAMMAR_PROLOGUE.
377 m4_define([AT_DATA_GRAMMAR],
379 [AT_DATA_GRAMMAR_PROLOGUE
384 # AT_YYLEX_DECLARE_EXTERN
386 # AT_YYLEX_DEFINE([INPUT], [ACTION])
387 # ----------------------------------
388 # INPUT can be empty, or in double quotes, or a list (in braces).
389 # ACTION may compute yylval for instance, using "res" as token type,
390 # and "toknum" as the number of calls to yylex (starting at 0).
391 m4_define([AT_YYLEX_PROTOTYPE],
392 [int AT_NAME_PREFIX[]lex (]AT_YYLEX_FORMALS[)[]dnl
395 m4_define([AT_YYLEX_DECLARE_EXTERN],
396 [AT_YYLEX_PROTOTYPE;dnl
399 m4_define([AT_YYLEX_DECLARE],
400 [static AT_YYLEX_DECLARE_EXTERN[]dnl
403 m4_define([AT_YYLEX_DEFINE],
404 [[#include <assert.h>
408 ]m4_bmatch([$1], [^\(".*"\)?$],
409 [[static char const input[] = ]m4_default([$1], [""])],
410 [[static int const input[] = ]$1])[;
411 static size_t toknum = 0;
414 assert (toknum < sizeof input / sizeof input[0]);
415 res = input[toknum++];
416 ]$2[;]AT_LOCATION_IF([[
417 ]AT_LOC_FIRST_LINE[ = ]AT_LOC_LAST_LINE[ = 1;
418 ]AT_LOC_FIRST_COLUMN[ = ]AT_LOC_LAST_COLUMN[ = toknum;]])[
424 # AT_YYERROR_PROTOTYPE
425 # AT_YYERROR_DECLARE_EXTERN
428 # -------------------------
429 # Must be called inside a AT_BISON_OPTION_PUSHDEFS/POPDEFS pair.
430 m4_define([AT_YYERROR_FORMALS], [AT_LANG_DISPATCH([$0], $@)])
431 m4_define([AT_YYERROR_PROTOTYPE],[AT_LANG_DISPATCH([$0], $@)])
432 m4_define([AT_YYERROR_DECLARE_EXTERN], [AT_LANG_DISPATCH([$0], $@)])
433 m4_define([AT_YYERROR_DECLARE], [AT_LANG_DISPATCH([$0], $@)])
434 m4_define([AT_YYERROR_DEFINE], [AT_LANG_DISPATCH([$0], $@)])
438 m4_define([AT_MAIN_DEFINE], [AT_LANG_DISPATCH([$0], $@)])
446 m4_define([AT_YYERROR_FORMALS(c)],
447 [AT_YYERROR_ARG_LOC_IF([AT_YYLTYPE const * const llocp, ])AT_PARSE_PARAMS[const char *msg]])
449 m4_define([AT_YYERROR_PROTOTYPE(c)],
450 [[void ]AT_NAME_PREFIX[error (]AT_YYERROR_FORMALS[)]])
452 m4_define([AT_YYERROR_DECLARE_EXTERN(c)],
453 [AT_YYERROR_PROTOTYPE;])
455 m4_define([AT_YYERROR_DECLARE(c)],
458 #if defined ]AT_YYLTYPE[_IS_TRIVIAL && ]AT_YYLTYPE[_IS_TRIVIAL
459 static unsigned location_print (FILE *yyo, ]AT_YYLTYPE[ const * const yylocp);
460 # ifndef LOCATION_PRINT
461 # define LOCATION_PRINT(File, Loc) location_print (File, &(Loc))
465 static AT_YYERROR_DECLARE_EXTERN])
468 m4_define([AT_YYERROR_DEFINE(c)],
471 # if defined ]AT_YYLTYPE[_IS_TRIVIAL && ]AT_YYLTYPE[_IS_TRIVIAL
472 /* Print *YYLOCP on YYO. */
473 __attribute__((__unused__))
475 location_print (FILE *yyo, ]AT_YYLTYPE[ const * const yylocp)
478 int end_col = 0 != yylocp->last_column ? yylocp->last_column - 1 : 0;
479 if (0 <= yylocp->first_line)
481 res += fprintf (yyo, "%d", yylocp->first_line);
482 if (0 <= yylocp->first_column)
483 res += fprintf (yyo, ".%d", yylocp->first_column);
485 if (0 <= yylocp->last_line)
487 if (yylocp->first_line < yylocp->last_line)
489 res += fprintf (yyo, "-%d", yylocp->last_line);
491 res += fprintf (yyo, ".%d", end_col);
493 else if (0 <= end_col && yylocp->first_column < end_col)
494 res += fprintf (yyo, "-%d", end_col);
500 /* A C error reporting function. */
502 ]AT_YYERROR_PROTOTYPE[
503 {]m4_bpatsubst(m4_defn([AT_PARSE_PARAMS]),
504 [[^,]+[^A-Za-z_0-9]\([A-Za-z_][A-Za-z_0-9]*\), *], [
506 AT_YYERROR_SEES_LOC_IF([[
507 LOCATION_PRINT (stderr, ]AT_LOC[);
508 fprintf (stderr, ": ");]])[
509 fprintf (stderr, "%s\n", msg);
513 m4_define([AT_MAIN_DEFINE(c)],
514 [[#include <stdlib.h> /* getenv. */
515 #include <string.h> /* strcmp. */
517 main (int argc, char const* argv[])
519 if (getenv("YYDEBUG")
521 && (!strcmp (argv[1], "-d") || !strcmp (argv[1], "--debug"))))
525 return ]AT_NAME_PREFIX[parse ();
533 # No need to declare, it's part of the class interface.
534 m4_define([AT_YYERROR_DECLARE(c++)], [])
535 m4_define([AT_YYERROR_DECLARE_EXTERN(c++)], [])
537 m4_define([AT_YYERROR_DEFINE(c++)],
538 [[/* A C++ error reporting function. */
540 ]AT_NAME_PREFIX[::parser::error (]AT_LOCATION_IF([[const location_type& l, ]])[const std::string& m)
542 std::cerr << ]AT_LOCATION_IF([l << ": " << ])[m << std::endl;
546 m4_define([AT_MAIN_DEFINE(c++)],
547 [[#include <cstdlib> // getenv.
548 #include <cstring> // strcmp.
550 main (int argc, char const* argv[])
552 ]AT_NAME_PREFIX[::parser p;]AT_DEBUG_IF([[
553 if (getenv("YYDEBUG")
555 && (!strcmp (argv[1], "-d") || !strcmp (argv[1], "--debug"))))
556 p.set_debug_level (true);]], [[
568 m4_define([AT_YYERROR_DEFINE(java)],
569 [AT_LOCATION_IF([[public void yyerror (Calc.Location l, String s)
572 System.err.println (s);
574 System.err.println (l + ": " + s);
577 public void yyerror (String s)
579 System.err.println (s);
583 m4_define([AT_MAIN_DEFINE(java)],
586 public static void main (String args[]) throws IOException
588 YYParser p = new YYParser ();
595 ## --------------- ##
597 ## --------------- ##
599 # AT_BISON_CHECK(BISON_ARGS, [OTHER_AT_CHECK_ARGS])
600 # -------------------------------------------------
601 # High-level routine that may call bison several times, under different
604 # Check Bison by invoking 'bison BISON_ARGS'. BISON_ARGS should not contain
605 # shell constructs (such as redirection or pipes) that would prevent
606 # appending additional command-line arguments for bison. OTHER_AT_CHECK_ARGS
607 # are the usual remaining arguments to AT_CHECK: STATUS, STDOUT, etc.
609 # This macro or AT_BISON_CHECK_NO_XML should always be used whenever invoking
610 # Bison in the test suite. For now it ensures that:
612 # 1. Valgrind doesn't report reachable memory when Bison is expected to have
613 # a non-zero exit status since Bison doesn't always try to free all memory
616 # 2. In the case of maintainer-xml-check, XML/XSLT output is compared with
617 # --graph and --report=all output for every working grammar.
619 # 3. If stderr contains a warning, -Werror and --warnings=error
620 # convert the warning to an error.
622 # 4. If stderr contains a warning, -Wnone and --warnings=none suppress it.
623 m4_define([AT_BISON_CHECK],
624 [m4_null_if([$2], [AT_BISON_CHECK_XML($@)])
625 AT_BISON_CHECK_NO_XML($@)])
627 # AT_BISON_CHECK_(BISON_ARGS, [OTHER_AT_CHECK_ARGS])
628 # --------------------------------------------------
629 # Low-level macro to run bison once.
630 m4_define([AT_BISON_CHECK_],
631 [AT_CHECK(AT_QUELL_VALGRIND[[ bison -fno-caret ]]$@)])
634 # AT_BISON_CHECK_WARNINGS(BISON_ARGS, [OTHER_AT_CHECK_ARGS])
635 # ----------------------------------------------------------
636 # Check that warnings (if some are expected) are correctly
637 # turned into errors with -Werror, etc.
638 m4_define([AT_BISON_CHECK_WARNINGS],
639 [m4_if(m4_bregexp([$4], [: warning: ]), [-1], [],
640 [m4_null_if([$2], [AT_BISON_CHECK_WARNINGS_($@)])])])
642 m4_define([AT_BISON_CHECK_WARNINGS_],
643 [[# Defining POSIXLY_CORRECT causes bison to complain if options are
644 # added after the grammar file name, so skip these checks in that
646 if test "$POSIXLY_CORRECT_IS_EXPORTED" = false; then
647 ]AT_SAVE_SPECIAL_FILES[
649 # To avoid expanding it repeatedly, store specified stdout.
650 ]AT_DATA([expout], [$3])[
653 ]AT_BISON_CHECK_([$1[ -Werror]], [[1]], [expout], [stderr])[
655 # Build expected stderr up to and including the "warnings being
656 # treated as errors" message.
657 ]AT_DATA([[experr]], [$4])[
658 $PERL -pi -e 's{(.*): warning: (.*)\[-W(.*)\]$}
659 {$][1: error: $][2\@<:@-Werror=$][3@:>@}' experr
660 ]AT_CHECK([[sed 's,.*/$,,' stderr 1>&2]], [[0]], [[]], [experr])[
662 # Now check --warnings=error.
664 ]AT_BISON_CHECK_([$1[ --warnings=error]], [[1]], [expout], [experr])[
666 # Now check -Wnone and --warnings=none by making sure that
667 # -Werror doesn't change the exit status when -Wnone or
668 # --warnings=none is specified.
669 ]AT_BISON_CHECK_([$1[ -Wnone -Werror]], [[0]], [expout])[
670 ]AT_BISON_CHECK_([$1[ --warnings=none -Werror]], [[0]], [expout])[
672 ]AT_RESTORE_SPECIAL_FILES[
676 # AT_BISON_CHECK_NO_XML(BISON_ARGS, [OTHER_AT_CHECK_ARGS])
677 # --------------------------------------------------------
678 # Same as AT_BISON_CHECK except don't perform XML/XSLT checks. This is useful
679 # when a tortured grammar's XML is known to be too large for xsltproc to
681 m4_define([AT_BISON_CHECK_NO_XML],
682 [AT_CHECK(m4_null_if([$2], [], [AT_QUELL_VALGRIND ])[[bison -fno-caret ]]$@)
683 AT_BISON_CHECK_WARNINGS($@)])
685 # AT_BISON_CHECK_XML(BISON_ARGS, [OTHER_AT_CHECK_ARGS])
686 # -----------------------------------------------------
687 # Run AT_BISON_CHECK's XML/XSLT checks if $BISON_TEST_XML=1 and $XSLTPROC is
688 # defined. It doesn't make sense to invoke this macro if Bison is expected to
689 # have a non-zero exit status.
690 m4_define([AT_BISON_CHECK_XML],
691 [[if test x"$BISON_TEST_XML" = x1 && test x"$XSLTPROC" != x""; then]
692 AT_SAVE_SPECIAL_FILES
694 m4_pushdef([AT_BISON_ARGS],
695 [m4_bpatsubsts([[$1]],
696 [--report(-file)?=[^][ ]*], [],
697 [--graph=[^][ ]*], [],
698 [--xml=[^][ ]*], [])])dnl
699 # Don't combine these Bison invocations since we want to be sure that
700 # --report=all isn't required to get the full XML file.
701 AT_BISON_CHECK_([[--report=all --report-file=xml-tests/test.output \
702 --graph=xml-tests/test.dot ]]AT_BISON_ARGS,
703 [[0]], [ignore], [ignore])
704 AT_BISON_CHECK_([[--xml=xml-tests/test.xml ]]AT_BISON_ARGS,
705 [[0]], [ignore], [ignore])
706 m4_popdef([AT_BISON_ARGS])dnl
707 [cp xml-tests/test.output expout]
708 AT_CHECK([[$XSLTPROC \
709 `]]AT_QUELL_VALGRIND[[ bison --print-datadir`/xslt/xml2text.xsl \
710 xml-tests/test.xml]], [[0]], [expout])
711 [sort xml-tests/test.dot > expout]
712 AT_CHECK([[$XSLTPROC \
713 `]]AT_QUELL_VALGRIND[[ bison --print-datadir`/xslt/xml2dot.xsl \
714 xml-tests/test.xml | sort]], [[0]], [expout])
715 [rm -rf xml-tests expout]
716 AT_RESTORE_SPECIAL_FILES
721 # Put this before a Bison invocation to keep Valgrind from complaining about
724 # Do not quote invocations of this macro within the first argument of AT_CHECK.
725 # The triple quoting below will cause test cases to fail if you do. If you do
726 # so anyway but also decrease the quoting below to avoid that problem, AT_CHECK
727 # will then fail to shell-escape its contents when attempting to print them.
728 # The testsuite verbose output, at least, will be incorrect, but nothing may
729 # fail to make sure you notice.
730 m4_define([AT_QUELL_VALGRIND],
731 [[[VALGRIND_OPTS="$VALGRIND_OPTS --leak-check=summary --show-reachable=no"; export VALGRIND_OPTS;]]])
735 ## ------------------------ ##
736 ## Compiling C, C++ Files. ##
737 ## ------------------------ ##
740 # AT_COMPILE(OUTPUT, [SOURCES = OUTPUT.c])
741 # ----------------------------------------
742 # Compile SOURCES into OUTPUT.
744 # If OUTPUT does not contain '.', assume that we are linking too,
745 # otherwise pass "-c"; this is a hack. The default SOURCES is OUTPUT
746 # with trailing .o removed, and ".c" appended.
747 m4_define([AT_COMPILE],
748 [AT_CHECK([$BISON_C_WORKS], 0, ignore, ignore)
749 AT_CHECK(m4_join([ ],
750 [$CC $CFLAGS $CPPFLAGS],
751 [m4_bmatch([$1], [[.]], [-c], [$LDFLAGS])],
753 [m4_default([$2], [m4_bpatsubst([$1], [\.o$]).c])],
754 [m4_bmatch([$1], [[.]], [], [$LIBS])]),
755 0, [ignore], [ignore])])
757 # AT_COMPILE_CXX(OUTPUT, [SOURCES = OUTPUT.cc])
758 # ---------------------------------------------
759 # Compile SOURCES into OUTPUT. If the C++ compiler does not work,
762 # If OUTPUT does not contain '.', assume that we are linking too,
763 # otherwise pass "-c"; this is a hack. The default SOURCES is OUTPUT
764 # with trailing .o removed, and ".cc" appended.
765 m4_define([AT_COMPILE_CXX],
767 AT_CHECK([$BISON_CXX_WORKS], 0, ignore, ignore)
768 AT_CHECK(m4_join([ ],
769 [$CXX $CXXFLAGS $CPPFLAGS],
770 [m4_bmatch([$1], [[.]], [-c], [$LDFLAGS])],
772 [m4_default([$2], [m4_bpatsubst([$1], [\.o$]).cc])],
773 [m4_bmatch([$1], [[.]], [], [$LIBS])]),
774 0, [ignore], [ignore])])
777 # AT_JAVA_COMPILE(SOURCES)
778 # ------------------------
779 # Compile SOURCES into Java class files. Skip the test if java or javac
781 m4_define([AT_JAVA_COMPILE],
783 AT_SKIP_IF([[test -z "$CONF_JAVAC"]])
784 AT_SKIP_IF([[test -z "$CONF_JAVA"]])
785 AT_CHECK([[$SHELL ../../../javacomp.sh ]$1],
786 [[0]], [ignore], [ignore])])
789 # AT_LANG_COMPILE(OUTPUT, [SOURCES = OUTPUT.c]
790 # --------------------------------------------
791 # Compile SOURCES into OUTPUT. Skip if compiler does not work.
793 # If OUTPUT does not contain '.', assume that we are linking too,
794 # otherwise pass "-c"; this is a hack. The default SOURCES is OUTPUT
795 # with trailing .o removed, and ".c"/".cc" appended.
796 m4_define([AT_LANG_COMPILE], [AT_LANG_DISPATCH([$0], $@)])
797 m4_define([AT_LANG_COMPILE(c)], [AT_COMPILE([$1], [$2])])
798 m4_define([AT_LANG_COMPILE(c++)], [AT_COMPILE_CXX([$1], [$2])])
799 m4_define([AT_LANG_COMPILE(java)], [AT_JAVA_COMPILE([$1.java], [$2])])
802 # AT_FULL_COMPILE(OUTPUT, [OTHER1], [OTHER2])
803 # -------------------------------------------
804 # Compile OUTPUT.y to OUTPUT.c, OUTPUT.cc, or OUTPUT.java, and then
805 # compile it to OUTPUT or OUTPUT.class. If OTHER is specified, compile
806 # OUTPUT-OTHER.c, OUTPUT-OTHER.cc, or OUTPUT-OTHER.java to OUTPUT or
807 # OUTPUT.java along with it. Relies on AT_SKEL_CC_IF and
809 m4_define([AT_FULL_COMPILE], [AT_LANG_DISPATCH([$0], $@)])
810 m4_define([AT_FULL_COMPILE(c)],
811 [AT_BISON_CHECK([-o $1.c $1.y])
812 AT_LANG_COMPILE([$1],
815 m4_ifval($2, [[$1-$2.c]]),
816 m4_ifval($3, [[$1-$3.c]])))])
818 m4_define([AT_FULL_COMPILE(c++)],
819 [AT_BISON_CHECK([-o $1.cc $1.y])
820 AT_LANG_COMPILE([$1],
823 m4_ifval($2, [[$1-$2.cc]]),
824 m4_ifval($3, [[$1-$3.cc]])))])
826 m4_define([AT_FULL_COMPILE(java)],
827 [AT_BISON_CHECK([-o $1.java $1.y])
828 AT_LANG_COMPILE([$1],
831 m4_ifval($2, [[$1-$2.java]]),
832 m4_ifval($3, [[$1-$3.java]])))])
837 # AT_SKIP_IF_CANNOT_LINK_C_AND_CXX
838 # --------------------------------
839 # Check that we can link together C and C++ objects.
840 m4_define([AT_SKIP_IF_CANNOT_LINK_C_AND_CXX],
841 [AT_DATA([c-and-cxx.h],
852 [[#include "c-and-cxx.h"
856 return fortytwo () == 42 ? 0 : 1;
859 AT_DATA([cxx-only.cc],
860 [[#include "c-and-cxx.h"
866 AT_COMPILE([c-only.o], [c-only.c])
867 AT_COMPILE_CXX([cxx-only.o], [cxx-only.cc])
868 AT_CHECK([$CXX $CXXFLAGS $CPPFLAGS $LDFLAGS c-only.o cxx-only.o -o c-and-cxx ||
869 exit 77], [ignore], [ignore])
870 AT_PARSER_CHECK([./c-and-cxx])
874 ## ---------------------------- ##
875 ## Running a generated parser. ##
876 ## ---------------------------- ##
879 # AT_PARSER_CHECK(COMMAND, EXIT-STATUS, EXPOUT, EXPERR, [PRE])
880 # ------------------------------------------------------------
881 # So that we can run './testsuite PREPARSER='valgrind -q' for instance.
883 # Get rid of spurious messages when compiled with --coverage:
884 # +profiling:/[...]/lib/fprintf.gcda:Merge mismatch for summaries
885 m4_define([AT_PARSER_CHECK],
886 [AT_CHECK([$5 $PREPARSER $1], [$2], [$3], [stderr])
887 AT_CHECK([sed >&2 -e '/^profiling:.*:Merge mismatch for summaries/d' stderr],
892 # AT_JAVA_PARSER_CHECK(COMMAND, EXIT-STATUS, EXPOUT, EXPERR, [PRE])
893 # -----------------------------------------------------------------
894 m4_define([AT_JAVA_PARSER_CHECK],
895 [AT_CHECK([$5[ $SHELL ../../../javaexec.sh ]$1], [$2], [$3], [$4])])
898 # AT_TEST_TABLES_AND_PARSE(TITLE, COND-VALUE, TEST-SPEC,
899 # DECLS, GRAMMAR, INPUT,
900 # BISON-STDERR, TABLES-OR-LAST-STATE,
902 # [PARSER-EXIT-VALUE],
903 # [PARSER-STDOUT], [PARSER-STDERR])
904 # -------------------------------------------------------------
905 # Using TITLE as the test group title, check the generated parser tables
906 # and parser for a specified grammar file under a condition labeled by
909 # TEST-SPEC is a comma-delimited list of attributes of this test. Each
910 # recognized attribute is described below where it is relevant.
912 # Insert DECLS and GRAMMAR into the declarations and grammar section of
913 # the grammar file. Insert basic yyerror, yylex, and main function
914 # definitions as well. Hardcode yylex to return the (possibly empty)
915 # comma-delimited series of tokens in INPUT followed by token 0.
917 # If TEST-SPEC contains the attribute no-xml, then invoke bison using
918 # AT_BISON_CHECK_NO_XML. Otherwise, invoke bison using AT_BISON_CHECK.
919 # On the bison command-line, specify `--report=all --defines'. Check
920 # that Bison exits with value 0, has no stdout, and has stderr
923 # If TEST-SPEC contains the attribute 'last-state', check that the value
924 # of TABLES-OR-LAST-STATE is the index of the last state generated for
925 # the grammar; in other words, check the number of states (minus one).
926 # Otherwise, check that everything in the '.output' file starting with
927 # the definition of state 0 is the same as the entire value of
928 # TABLES-OR-LAST-STATE.
930 # Expand the M4 in OTHER-CHECKS to perform additional checks of the
931 # '.output' file, which is named 'input.output', and/or grammar file,
932 # which is named 'input.y'.
934 # Finally, compile the generated parser and then run it using
935 # AT_PARSER_CHECK with PARSER-EXIT-VALUE, PARSER-STDOUT, and
936 # PARSER-STDERR as the 2nd-4th arguments.
938 # As a precondition, you must properly double-quote all arguments that
939 # are to be interpreted as strings.
941 # AT_COND_CASE (when appearing in single-quoted segments of arguments)
942 # invokes m4_case with its own arguments but COND-VALUE inserted as the
943 # first argument. This is useful, for example, when wrapping multiple
944 # AT_TEST_TABLES_AND_PARSE invocations, each representing a different
945 # condition, in another macro.
949 # # AT_TEST_SYNTAX_ERROR(DESCRIPTION, DECLS, GRAMMAR, INPUT, LAST-STATE,
950 # # PARSER-EXIT-VALUE, PARSER-STDOUT, PARSER-STDERR)
951 # # ---------------------------------------------------------------------
952 # m4_define([AT_TEST_SYNTAX_ERROR],
954 # AT_TEST_TABLES_AND_PARSE([$1[ with %error-verbose]], [[verbose]],
956 # [[%error-verbose ]$2], [$3], [$4],
957 # [[]], [$5], [], [$6], [$7], [$8])
958 # AT_TEST_TABLES_AND_PARSE([$1[ with no %error-verbose]], [[no verbose]],
961 # [[]], [$5], [], [$6], [$7], [$8])
964 # AT_TEST_SYNTAX_ERROR([[Single Char Grammar]],
965 # [[%token 'b']], [[start: 'a' ;]], [['a', 'b']],
968 # [AT_COND_CASE([[no verbose]],
971 # [[syntax error, unexpected 'b', expecting $end
973 m4_define([AT_TEST_TABLES_AND_PARSE],
974 [m4_pushdef([AT_COND_CASE], [m4_case([$2], $][@)])
977 AT_BISON_OPTION_PUSHDEFS([$4])
978 AT_DATA_GRAMMAR([[input.y]],
995 static int const input[] = {
996 ]m4_if([$6], [], [], [$6], [[]], [], [$6[, ]])[0
998 static int const *inputp = input;
1005 # In some versions of Autoconf, AT_CHECK invokes AS_ESCAPE before
1006 # expanding macros, so it corrupts some special characters in the
1007 # macros. To avoid this, expand now and pass it the result with proper
1008 # string quotation. Assume args 7 through 12 expand to properly quoted
1011 m4_if(m4_index(m4_quote($3), [no-xml]), -1,
1013 [AT_BISON_CHECK_NO_XML])([[-Wall --report=all --defines -o input.c input.y]],
1014 [0], [], m4_dquote($7))
1016 m4_if(m4_index(m4_quote($3), [last-state]), -1,
1017 [AT_CHECK([[sed -n '/^State 0$/,$p' input.output]], [[0]],
1019 [AT_CHECK([[sed -n 's/^State //p' input.output | tail -1]], [[0]],
1025 # Canonical LR generates very large tables, resulting in very long
1026 # files with #line directives that may overflow what the standards
1027 # (C90 and C++98) guarantee: 32767. In that case, GCC's -pedantic
1028 # will issue an error.
1030 # There is no "" around `wc` since some indent the result.
1031 m4_bmatch([$4], [%define lr.type canonical-lr],
1032 [if test 32767 -lt `wc -l < input.c`; then
1033 CFLAGS=`echo " $CFLAGS " | sed -e 's/ -pedantic / /'`
1034 CXXFLAGS=`echo " $CXXFLAGS " | sed -e 's/ -pedantic / /'`
1036 AT_COMPILE([[input]])
1038 AT_PARSER_CHECK([[./input]],
1039 m4_ifval([$10], [m4_dquote($10)]),
1040 m4_ifval([$11], [m4_dquote($11)]),
1041 m4_ifval([$12], [m4_dquote($12)]))
1043 AT_BISON_OPTION_POPDEFS
1046 m4_popdef([AT_COND_CASE])])
1051 ## ----------------------- ##
1052 ## Launch the test suite. ##
1053 ## ----------------------- ##
1059 # Redefine AT_SETUP to be more concise. Must be done after AT_INIT.
1060 m4_copy_force([AT_SETUP], [B4_SETUP])
1061 m4_define([AT_SETUP],
1062 [B4_SETUP(m4_expand([AT_SETUP_STRIP([[$1]])]))])
1064 # Cannot assign CC and CFLAGS here, since atlocal is loaded after
1065 # options are processed, so we don't know the value of CXX and
1068 # Note that it also means that command line values for CXX and
1069 # CXXFLAGS will not be propagated to CC and CFLAGS.
1070 AT_ARG_OPTION([compile-c-with-cxx],
1071 [compile C parsers with the C++ compiler])