1 # Process this -*- Autotest -*- file with autom4te.
3 # Macros for the GNU Bison Test suite.
5 # Copyright (C) 2003-2012 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),
36 # AT_MATCHES_CHECK(FILE, PERL-REGEXP, COUNT)
37 # ------------------------------------------
38 # Expect COUNT matches of the PERL-REGEXP in FILE. The file is
39 # taken in "slurp" mode, i.e., one can match end-of-lines.
40 m4_define([AT_MATCHES_CHECK],
41 [AT_CHECK([$PERL -0777 -ne '
43 s{$2}{ ++$count; "" }gem;
44 printf "$count\n";' $1], [0], [$3
48 # AT_SAVE_SPECIAL_FILES / AT_RESTORE_SPECIAL_FILES
49 # ------------------------------------------------
50 # Don't interfere with caller's files.
51 m4_divert_text([PREPARE_TESTS],
52 [at_save_special_files ()
54 for at_save_file in stderr experr expout
56 test ! -f at-bison-check-$at_save_file.bak ||
57 as_fn_error 1 "fatal error: back-up on top of a back-up"
58 test ! -f $at_save_file || mv $at_save_file at-bison-check-$at_save_file.bak
62 at_restore_special_files ()
64 for at_save_file in stderr experr expout
66 test ! -f at-bison-check-$at_save_file.bak ||
67 mv at-bison-check-$at_save_file.bak $at_save_file
72 m4_define([AT_SAVE_SPECIAL_FILES], [at_save_special_files])
73 m4_define([AT_RESTORE_SPECIAL_FILES], [at_restore_special_files])
77 ## ------------------------------- ##
78 ## Macros decoding Bison options. ##
79 ## ------------------------------- ##
81 # AT_LOC_PUSHDEF(FIRST-LINE, FIRST-COLUMN, LAST-LINE, LAST-COLUMN)
82 # ----------------------------------------------------------------
83 # Pushdef AT_LOC_(FIRST|LAST)_(LINE|COLUMN).
84 m4_define([AT_LOC_PUSHDEF],
85 [m4_pushdef([AT_LOC_FIRST_LINE], [AT_LOC.$1])
86 m4_pushdef([AT_LOC_FIRST_COLUMN], [AT_LOC.$2])
87 m4_pushdef([AT_LOC_LAST_LINE], [AT_LOC.$3])
88 m4_pushdef([AT_LOC_LAST_COLUMN], [AT_LOC.$4])])
92 # Popdef AT_LOC_(FIRST|LAST)_(LINE|COL).
93 m4_define([AT_LOC_POPDEF],
94 [m4_popdef([AT_LOC_FIRST_LINE])
95 m4_popdef([AT_LOC_FIRST_COLUMN])
96 m4_popdef([AT_LOC_LAST_LINE])
97 m4_popdef([AT_LOC_LAST_COLUMN])])
101 # AT_BISON_OPTION_PUSHDEFS([BISON-OPTIONS])
102 # -----------------------------------------
103 m4_define([AT_BISON_OPTION_PUSHDEFS],
104 [m4_divert_text([KILL],
105 [_AT_BISON_OPTION_PUSHDEFS($[1], $[2], [$1])])])
108 # _AT_BISON_OPTION_PUSHDEFS($1, $2, [BISON-OPTIONS])
109 # --------------------------------------------------
110 # This macro works around the impossibility to define macros
111 # inside macros, because issuing `[$1]' is not possible in M4 :(.
112 # This sucks hard, GNU M4 should really provide M5-like $$1.
113 m4_define([_AT_BISON_OPTION_PUSHDEFS],
114 [m4_if([$1$2], $[1]$[2], [],
115 [m4_fatal([$0: Invalid arguments: $@])])dnl
116 m4_pushdef([AT_DEFINES_IF],
117 [m4_bmatch([$3], [%defines], [$1], [$2])])
118 m4_pushdef([AT_SKEL_CC_IF],
119 [m4_bmatch([$3], [%language "[Cc]\+\+"\|%skeleton "[a-z0-9]+\.cc"], [$1], [$2])])
120 m4_pushdef([AT_SKEL_JAVA_IF],
121 [m4_bmatch([$3], [%language "[Jj][Aa][Vv][Aa]"\|%skeleton "[a-z0-9]+\.java"], [$1], [$2])])
122 # The target language: "c", "c++", or "java".
123 m4_pushdef([AT_LANG],
124 [AT_SKEL_JAVA_IF([java],
125 [AT_SKEL_CC_IF([c++],
127 m4_pushdef([AT_GLR_IF],
128 [m4_bmatch([$3], [%glr-parser\|%skeleton "glr\..*"], [$1], [$2])])
129 m4_pushdef([AT_LALR1_CC_IF],
130 [AT_SKEL_CC_IF([AT_GLR_IF([$2], [$1])], [$2])])
131 m4_pushdef([AT_GLR_CC_IF],
132 [AT_SKEL_CC_IF([AT_GLR_IF([$1], [$2])], [$2])])
134 m4_pushdef([AT_YACC_IF],
135 [m4_bmatch([$3], [%language\|%glr-parser\|%skeleton], [$2], [$1])])
136 m4_pushdef([AT_LEXPARAM_IF],
137 [m4_bmatch([$3], [%lex-param], [$1], [$2])])
138 m4_pushdef([AT_LOCATION_IF],
139 [m4_bmatch([$3], [%locations], [$1], [$2])])
140 m4_pushdef([AT_LOCATION_TYPE_IF],
141 [m4_bmatch([$3], [%define \(api\.location\.type\|location_type\)], [$1], [$2])])
142 m4_pushdef([AT_PARAM_IF],
143 [m4_bmatch([$3], [%parse-param], [$1], [$2])])
144 # Comma-terminated list of formals parse-parameters.
145 # E.g., %parse-param { int x } %parse-param {int y} -> "int x, int y, ".
146 # FIXME: Support grouped parse-param.
147 m4_pushdef([AT_PARSE_PARAMS])
148 m4_bpatsubst([$3], [%parse-param { *\([^{}]*[^{} ]\) *}],
149 [m4_append([AT_PARSE_PARAMS], [\1, ])])
151 m4_pushdef([AT_PURE_IF],
152 [m4_bmatch([$3], [%define *api\.pure\|%pure-parser],
153 [m4_bmatch([$3], [%define *api\.pure *"?false"?], [$2], [$1])],
155 m4_pushdef([AT_PURE_AND_LOC_IF],
156 [m4_bmatch([$3], [%locations], [AT_PURE_IF($@)], [$2])])
157 m4_pushdef([AT_GLR_OR_PARAM_IF],
158 [m4_bmatch([$3], [%glr-parser\|%parse-param], [$1], [$2])])
159 m4_pushdef([AT_NAME_PREFIX],
160 [m4_bmatch([$3], [\(%define api\.prefix\|%name-prefix\) ".*"],
161 [m4_bregexp([$3], [\(%define api\.prefix\|%name-prefix\) "\([^""]*\)"], [\2])],
163 m4_pushdef([AT_TOKEN_CTOR_IF],
164 [m4_bmatch([$3], [%define api.token.constructor], [$1], [$2])])
165 m4_pushdef([AT_TOKEN_PREFIX],
166 [m4_bmatch([$3], [%define api.token.prefix ".*"],
167 [m4_bregexp([$3], [%define api.token.prefix "\(.*\)"], [\1])])])
168 m4_pushdef([AT_API_prefix],
169 [m4_bmatch([$3], [%define api\.prefix ".*"],
170 [m4_bregexp([$3], [%define api\.prefix "\([^""]*\)"], [\1])],
172 m4_pushdef([AT_API_PREFIX],
173 [m4_toupper(AT_API_prefix)])
174 # yyerror receives the location if %location & %pure & (%glr or %parse-param).
175 m4_pushdef([AT_YYERROR_ARG_LOC_IF],
176 [AT_GLR_OR_PARAM_IF([AT_PURE_AND_LOC_IF([$1], [$2])],
178 # yyerror always sees the locations (when activated), except if
179 # (yacc & pure & !param). FIXME: This is wrong. See the manual.
180 m4_pushdef([AT_YYERROR_SEES_LOC_IF],
181 [AT_LOCATION_IF([AT_YACC_IF([AT_PURE_IF([AT_PARAM_IF([$1], [$2])],
186 # The interface is pure: either because %define api.pure, or because we
187 # are using the C++ parsers.
188 m4_pushdef([AT_PURE_LEX_IF],
190 [AT_SKEL_CC_IF([$1], [$2])])])
192 m4_pushdef([AT_YYSTYPE],
193 [AT_SKEL_CC_IF([AT_NAME_PREFIX[::parser::semantic_type]],
194 [AT_API_PREFIX[STYPE]])])
195 m4_pushdef([AT_YYLTYPE],
196 [AT_SKEL_CC_IF([AT_NAME_PREFIX[::parser::location_type]],
197 [AT_API_PREFIX[LTYPE]])])
201 [m4_pushdef([AT_LOC], [(*llocp)])
202 m4_pushdef([AT_VAL], [(*lvalp)])
203 m4_pushdef([AT_YYLEX_FORMALS],
204 [AT_YYSTYPE *lvalp[]AT_LOCATION_IF([, AT_YYLTYPE *llocp])])
205 m4_pushdef([AT_YYLEX_ARGS],
206 [lvalp[]AT_LOCATION_IF([, llocp])])
207 m4_pushdef([AT_USE_LEX_ARGS],
208 [(void) lvalp;AT_LOCATION_IF([(void) llocp])])
209 m4_pushdef([AT_YYLEX_PRE_FORMALS],
210 [AT_YYLEX_FORMALS, ])
211 m4_pushdef([AT_YYLEX_PRE_ARGS],
214 [m4_pushdef([AT_LOC], [[(]AT_NAME_PREFIX[lloc)]])
215 m4_pushdef([AT_VAL], [[(]AT_NAME_PREFIX[lval)]])
216 m4_pushdef([AT_YYLEX_FORMALS], [void])
217 m4_pushdef([AT_YYLEX_ARGS], [])
218 m4_pushdef([AT_USE_LEX_ARGS], [])
219 m4_pushdef([AT_YYLEX_PRE_FORMALS], [])
220 m4_pushdef([AT_YYLEX_PRE_ARGS], [])
223 # Handle the different types of location components.
226 [AT_LOCATION_TYPE_IF(
227 [AT_LOC_PUSHDEF([first.l], [first.c], [last.l], [last.c])],
228 [AT_LOC_PUSHDEF([begin.line], [begin.column], [end.line], [end.column])])],
229 [AT_LOC_PUSHDEF([first_line], [first_column], [last_line], [last_column])])
232 AT_GLR_IF([AT_KEYWORDS([glr])])
233 ])# _AT_BISON_OPTION_PUSHDEFS
236 # AT_BISON_OPTION_POPDEFS
237 # -----------------------
238 m4_define([AT_BISON_OPTION_POPDEFS],
239 [m4_divert_text([KILL],
240 [m4_popdef([AT_YYLEX_PRE_ARGS])
241 m4_popdef([AT_YYLEX_PRE_FORMALS])
242 m4_popdef([AT_USE_LEX_ARGS])
243 m4_popdef([AT_YYLEX_ARGS])
244 m4_popdef([AT_YYLEX_FORMALS])
245 m4_popdef([AT_YYLTYPE])
246 m4_popdef([AT_YYSTYPE])
249 m4_popdef([AT_PURE_LEX_IF])
250 m4_popdef([AT_YYERROR_SEES_LOC_IF])
251 m4_popdef([AT_YYERROR_ARG_LOC_IF])
252 m4_popdef([AT_API_PREFIX])
253 m4_popdef([AT_API_prefix])
254 m4_popdef([AT_TOKEN_PREFIX])
255 m4_popdef([AT_TOKEN_CTOR_IF])
256 m4_popdef([AT_NAME_PREFIX])
257 m4_popdef([AT_GLR_OR_PARAM_IF])
258 m4_popdef([AT_PURE_AND_LOC_IF])
259 m4_popdef([AT_LOCATION_TYPE_IF])
260 m4_popdef([AT_LOCATION_IF])
261 m4_popdef([AT_PARSE_PARAMS])
262 m4_popdef([AT_PARAM_IF])
263 m4_popdef([AT_LEXPARAM_IF])
264 m4_popdef([AT_YACC_IF])
265 m4_popdef([AT_GLR_IF])
266 m4_popdef([AT_SKEL_CC_IF])
268 m4_popdef([AT_SKEL_JAVA_IF])
269 m4_popdef([AT_GLR_CC_IF])
270 m4_popdef([AT_LALR1_CC_IF])
271 m4_popdef([AT_DEFINES_IF])
273 ])# AT_BISON_OPTION_POPDEFS
277 ## -------------------------- ##
278 ## Generating Grammar Files. ##
279 ## -------------------------- ##
281 # AT_DATA_SOURCE_PROLOGUE
282 # ------------------------
283 # The prologue that should be included in any source code that is
284 # meant to be compiled.
285 m4_define([AT_DATA_SOURCE_PROLOGUE],
286 [[#include <config.h>
287 /* We don't need perfect functions for these tests. */
293 # AT_DATA_GRAMMAR_PROLOGUE
294 # ------------------------
295 # The prologue that should be included in any grammar which parser is
296 # meant to be compiled.
297 m4_define([AT_DATA_GRAMMAR_PROLOGUE],
299 ]AT_DATA_SOURCE_PROLOGUE[]dnl
303 # AT_DATA_SOURCE(NAME, CONTENT)
304 # -----------------------------
305 # Generate the file NAME, which CONTENT is preceded by
306 # AT_DATA_SOURCE_PROLOGUE.
307 m4_define([AT_DATA_SOURCE],
309 [AT_DATA_SOURCE_PROLOGUE
313 # AT_DATA_GRAMMAR(NAME, CONTENT)
314 # ------------------------------
315 # Generate the file NAME, which CONTENT is preceded by
316 # AT_DATA_GRAMMAR_PROLOGUE.
317 m4_define([AT_DATA_GRAMMAR],
319 [AT_DATA_GRAMMAR_PROLOGUE
324 # AT_YYLEX_DECLARE_EXTERN
326 # AT_YYLEX_DEFINE([INPUT], [ACTION])
327 # ----------------------------------
328 # INPUT can be empty, or in double quotes, or a list (in braces).
329 # ACTION may compute yylval for instance, using "res" as token type,
330 # and "toknum" as the number of calls to yylex (starting at 0).
331 m4_define([AT_YYLEX_PROTOTYPE],
332 [int AT_NAME_PREFIX[]lex (]AT_YYLEX_FORMALS[)[]dnl
335 m4_define([AT_YYLEX_DECLARE_EXTERN],
336 [AT_YYLEX_PROTOTYPE;dnl
339 m4_define([AT_YYLEX_DECLARE],
340 [static AT_YYLEX_DECLARE_EXTERN[]dnl
343 m4_define([AT_YYLEX_DEFINE],
344 [[#include <assert.h>
348 ]m4_bmatch([$1], [^\(".*"\)?$],
349 [[static char const input[] = ]m4_default([$1], [""])],
350 [[static int const input[] = ]$1])[;
351 static size_t toknum = 0;
354 assert (toknum < sizeof input / sizeof input[0]);
355 res = input[toknum++];
356 ]$2[;]AT_LOCATION_IF([[
357 ]AT_LOC_FIRST_LINE[ = ]AT_LOC_LAST_LINE[ = 1;
358 ]AT_LOC_FIRST_COLUMN[ = ]AT_LOC_LAST_COLUMN[ = toknum;]])[
363 # AT_YYERROR_PROTOTYPE
364 # AT_YYERROR_DECLARE_EXTERN
367 # -------------------------
368 # Must be called inside a AT_BISON_OPTION_PUSHDEFS/POPDEFS pair.
369 m4_define([AT_YYERROR_FORMALS],
371 [c], [AT_YYERROR_ARG_LOC_IF([AT_YYLTYPE *llocp, ])AT_PARSE_PARAMS [const char *msg]])[]dnl
374 m4_define([AT_YYERROR_PROTOTYPE],
376 [c], [[void ]AT_NAME_PREFIX[error (]AT_YYERROR_FORMALS[)]])[]dnl
379 m4_define([AT_YYERROR_DECLARE_EXTERN],
381 [c], [AT_YYERROR_PROTOTYPE;])[]dnl
384 m4_define([AT_YYERROR_DECLARE],
386 [c], [static AT_YYERROR_DECLARE_EXTERN])[]dnl
389 m4_define([AT_YYERROR_DEFINE],
391 [c], [[#include <stdio.h>
392 /* A C error reporting function. */
394 ]AT_YYERROR_PROTOTYPE[
395 {]m4_bpatsubst(m4_defn([AT_PARSE_PARAMS]),
396 [[^,]+[^A-Za-z_0-9]\([A-Za-z_][A-Za-z_0-9]*\), *], [
398 AT_YYERROR_SEES_LOC_IF([[
399 YY_LOCATION_PRINT (stderr, ]AT_LOC[);
400 fprintf (stderr, ": ");]])[
401 fprintf (stderr, "%s\n", msg);
403 [c++], [[/* A C++ error reporting function. */
405 ]AT_NAME_PREFIX[::parser::error (]AT_LOCATION_IF([[const location_type& l, ]])[const std::string& m)
406 { std::cerr << ]AT_LOCATION_IF([l << ": " << ])[m << std::endl;
408 [java], [AT_LOCATION_IF([[public void yyerror (Calc.Location l, String s)
411 System.err.println (s);
413 System.err.println (l + ": " + s);
416 public void yyerror (String s)
418 System.err.println (s);
420 [m4_fatal([$0: invalid language: ]AT_LANG)])dnl
424 ## --------------- ##
426 ## --------------- ##
428 # AT_BISON_CHECK(BISON_ARGS, [OTHER_AT_CHECK_ARGS])
429 # -------------------------------------------------
430 # High-level routine that may call bison several times, under different
433 # Check Bison by invoking `bison BISON_ARGS'. BISON_ARGS should not contain
434 # shell constructs (such as redirection or pipes) that would prevent
435 # appending additional command-line arguments for bison. OTHER_AT_CHECK_ARGS
436 # are the usual remaining arguments to AT_CHECK: STATUS, STDOUT, etc.
438 # This macro or AT_BISON_CHECK_NO_XML should always be used whenever invoking
439 # Bison in the test suite. For now it ensures that:
441 # 1. Valgrind doesn't report reachable memory when Bison is expected to have
442 # a non-zero exit status since Bison doesn't always try to free all memory
445 # 2. In the case of maintainer-xml-check, XML/XSLT output is compared with
446 # --graph and --report=all output for every working grammar.
448 # 3. If stderr contains a warning, -Werror and --warnings=error
449 # convert the warning to an error.
451 # 4. If stderr contains a warning, -Wnone and --warnings=none suppress it.
452 m4_define([AT_BISON_CHECK],
453 [m4_null_if([$2], [AT_BISON_CHECK_XML($@)])
454 AT_BISON_CHECK_NO_XML($@)])
456 # AT_BISON_CHECK_(BISON_ARGS, [OTHER_AT_CHECK_ARGS])
457 # --------------------------------------------------
458 # Low-level macro to run bison once.
459 m4_define([AT_BISON_CHECK_],
460 [AT_CHECK(AT_QUELL_VALGRIND[[ bison ]]$@)])
463 # AT_BISON_CHECK_WARNINGS(BISON_ARGS, [OTHER_AT_CHECK_ARGS])
464 # ----------------------------------------------------------
465 # Check that warnings (if some are expected) are correctly
466 # turned into errors with -Werror, etc.
467 m4_define([AT_BISON_CHECK_WARNINGS],
468 [m4_if(m4_bregexp([$4], [: warning: ]), [-1], [],
469 [m4_null_if([$2], [AT_BISON_CHECK_WARNINGS_($@)])])])
471 m4_define([AT_BISON_CHECK_WARNINGS_],
472 [[# Defining POSIXLY_CORRECT causes bison to complain if options are
473 # added after the grammar file name, so skip these checks in that
475 if test "$POSIXLY_CORRECT_IS_EXPORTED" = false; then
476 ]AT_SAVE_SPECIAL_FILES[
478 # To avoid expanding it repeatedly, store specified stdout.
479 ]AT_DATA([expout], [$3])[
482 ]AT_BISON_CHECK_([$1[ -Werror]], [[1]], [expout], [stderr])[
484 # Build expected stderr up to and including the "warnings being
485 # treated as errors" message.
486 ]AT_DATA([[experr]], [$4])[
487 $PERL -pi -e 's{(.*): warning: (.*)\[-W(.*)\]$}
488 {$][1: error: $][2\@<:@-Werror=$][3@:>@}' experr
489 ]AT_CHECK([[sed 's,.*/$,,' stderr 1>&2]], [[0]], [[]], [experr])[
491 # Now check --warnings=error.
493 ]AT_BISON_CHECK_([$1[ --warnings=error]], [[1]], [expout], [experr])[
495 # Now check -Wnone and --warnings=none by making sure that
496 # -Werror doesn't change the exit status when -Wnone or
497 # --warnings=none is specified.
498 ]AT_BISON_CHECK_([$1[ -Wnone -Werror]], [[0]], [expout])[
499 ]AT_BISON_CHECK_([$1[ --warnings=none -Werror]], [[0]], [expout])[
501 ]AT_RESTORE_SPECIAL_FILES[
505 # AT_BISON_CHECK_NO_XML(BISON_ARGS, [OTHER_AT_CHECK_ARGS])
506 # --------------------------------------------------------
507 # Same as AT_BISON_CHECK except don't perform XML/XSLT checks. This is useful
508 # when a tortured grammar's XML is known to be too large for xsltproc to
510 m4_define([AT_BISON_CHECK_NO_XML],
511 [AT_CHECK(m4_null_if([$2], [], [AT_QUELL_VALGRIND ])[[bison ]]$@)
512 AT_BISON_CHECK_WARNINGS($@)])
514 # AT_BISON_CHECK_XML(BISON_ARGS, [OTHER_AT_CHECK_ARGS])
515 # -----------------------------------------------------
516 # Run AT_BISON_CHECK's XML/XSLT checks if $BISON_TEST_XML=1 and $XSLTPROC is
517 # defined. It doesn't make sense to invoke this macro if Bison is expected to
518 # have a non-zero exit status.
519 m4_define([AT_BISON_CHECK_XML],
520 [[if test x"$BISON_TEST_XML" = x1 && test x"$XSLTPROC" != x""; then]
521 AT_SAVE_SPECIAL_FILES
523 m4_pushdef([AT_BISON_ARGS],
524 [m4_bpatsubsts([[$1]],
525 [--report(-file)?=[^][ ]*], [],
526 [--graph=[^][ ]*], [],
527 [--xml=[^][ ]*], [])])dnl
528 # Don't combine these Bison invocations since we want to be sure that
529 # --report=all isn't required to get the full XML file.
530 AT_BISON_CHECK_([[--report=all --report-file=xml-tests/test.output \
531 --graph=xml-tests/test.dot ]]AT_BISON_ARGS,
532 [[0]], [ignore], [ignore])
533 AT_BISON_CHECK_([[--xml=xml-tests/test.xml ]]AT_BISON_ARGS,
534 [[0]], [ignore], [ignore])
535 m4_popdef([AT_BISON_ARGS])dnl
536 [cp xml-tests/test.output expout]
537 AT_CHECK([[$XSLTPROC \
538 `]]AT_QUELL_VALGRIND[[ bison --print-datadir`/xslt/xml2text.xsl \
539 xml-tests/test.xml]], [[0]], [expout])
540 [sort xml-tests/test.dot > expout]
541 AT_CHECK([[$XSLTPROC \
542 `]]AT_QUELL_VALGRIND[[ bison --print-datadir`/xslt/xml2dot.xsl \
543 xml-tests/test.xml | sort]], [[0]], [expout])
544 [rm -rf xml-tests expout]
545 AT_RESTORE_SPECIAL_FILES
550 # Put this before a Bison invocation to keep Valgrind from complaining about
553 # Do not quote invocations of this macro within the first argument of AT_CHECK.
554 # The triple quoting below will cause test cases to fail if you do. If you do
555 # so anyway but also decrease the quoting below to avoid that problem, AT_CHECK
556 # will then fail to shell-escape its contents when attempting to print them.
557 # The testsuite verbose output, at least, will be incorrect, but nothing may
558 # fail to make sure you notice.
559 m4_define([AT_QUELL_VALGRIND],
560 [[[VALGRIND_OPTS="$VALGRIND_OPTS --leak-check=summary --show-reachable=no"; export VALGRIND_OPTS;]]])
564 ## ------------------------ ##
565 ## Compiling C, C++ Files. ##
566 ## ------------------------ ##
569 # AT_COMPILE(OUTPUT, [SOURCES = OUTPUT.c])
570 # ----------------------------------------
571 # Compile SOURCES into OUTPUT.
573 # If OUTPUT does not contain '.', assume that we are linking too,
574 # otherwise pass "-c"; this is a hack. The default SOURCES is OUTPUT
575 # with trailing .o removed, and ".c" appended.
576 m4_define([AT_COMPILE],
577 [AT_CHECK([case $POSIXLY_CORRECT_IS_EXPORTED:$C_COMPILER_POSIXLY_CORRECT in
578 true:false) echo 'cannot compile properly with POSIXLY_CORRECT' && exit 77;;
580 AT_CHECK(m4_join([ ],
581 [$CC $CFLAGS $CPPFLAGS],
582 [m4_bmatch([$1], [[.]], [-c], [$LDFLAGS])],
584 [m4_default([$2], [m4_bpatsubst([$1], [\.o$]).c])],
585 [m4_bmatch([$1], [[.]], [], [$LIBS])]),
586 0, [ignore], [ignore])])
588 # AT_COMPILE_CXX(OUTPUT, [SOURCES = OUTPUT.cc])
589 # ---------------------------------------------
590 # Compile SOURCES into OUTPUT. If the C++ compiler does not work,
593 # If OUTPUT does not contain '.', assume that we are linking too,
594 # otherwise pass "-c"; this is a hack. The default SOURCES is OUTPUT
595 # with trailing .o removed, and ".cc" appended.
596 m4_define([AT_COMPILE_CXX],
598 AT_CHECK([$BISON_CXX_WORKS], 0, ignore, ignore)
599 AT_CHECK(m4_join([ ],
600 [$CXX $CXXFLAGS $CPPFLAGS],
601 [m4_bmatch([$1], [[.]], [-c], [$LDFLAGS])],
603 [m4_default([$2], [m4_bpatsubst([$1], [\.o$]).cc])],
604 [m4_bmatch([$1], [[.]], [], [$LIBS])]),
605 0, [ignore], [ignore])])
607 # AT_JAVA_COMPILE(SOURCES)
608 # ------------------------
609 # Compile SOURCES into Java class files. Skip the test if java or javac
611 m4_define([AT_JAVA_COMPILE],
613 AT_SKIP_IF([[test -z "$CONF_JAVAC"]])
614 AT_SKIP_IF([[test -z "$CONF_JAVA"]])
615 AT_CHECK([[$SHELL ../../../javacomp.sh ]$1],
616 [[0]], [ignore], [ignore])])
618 # AT_LANG_COMPILE(OUTPUT, [SOURCES = OUTPUT.c]
619 # --------------------------------------------
620 # Compile SOURCES into OUTPUT. Skip if compiler does not work.
622 # If OUTPUT does not contain '.', assume that we are linking too,
623 # otherwise pass "-c"; this is a hack. The default SOURCES is OUTPUT
624 # with trailing .o removed, and ".c"/".cc" appended.
625 m4_define([AT_LANG_COMPILE],
627 [c], [AT_COMPILE([$1], [$2])],
628 [c++], [AT_COMPILE_CXX([$1], [$2])],
629 [java], [AT_JAVA_COMPILE([$1.java], [$2])],
630 [m4_fatal([unknown language: ]m4_defn([AT_LANG]))])[]dnl
633 # AT_FULL_COMPILE(OUTPUT, [OTHER1], [OTHER2])
634 # -------------------------------------------
635 # Compile OUTPUT.y to OUTPUT.c, OUTPUT.cc, or OUTPUT.java, and then
636 # compile it to OUTPUT or OUTPUT.class. If OTHER is specified, compile
637 # OUTPUT-OTHER.c, OUTPUT-OTHER.cc, or OUTPUT-OTHER.java to OUTPUT or
638 # OUTPUT.java along with it. Relies on AT_SKEL_CC_IF and
640 m4_define([AT_FULL_COMPILE],
643 [AT_BISON_CHECK([-o $1.java $1.y])
644 AT_LANG_COMPILE([$1],
647 m4_ifval($2, [[$1-$2.java]]),
648 m4_ifval($3, [[$1-$3.java]])))],
650 [AT_BISON_CHECK([-o $1.cc $1.y])
651 AT_LANG_COMPILE([$1],
654 m4_ifval($2, [[$1-$2.cc]]),
655 m4_ifval($3, [[$1-$3.cc]])))],
657 [AT_BISON_CHECK([-o $1.c $1.y])
658 AT_LANG_COMPILE([$1],
661 m4_ifval($2, [[$1-$2.c]]),
662 m4_ifval($3, [[$1-$3.c]])))])
667 # AT_SKIP_IF_CANNOT_LINK_C_AND_CXX
668 # --------------------------------
669 # Check that we can link together C and C++ objects.
670 m4_define([AT_SKIP_IF_CANNOT_LINK_C_AND_CXX],
671 [AT_DATA([c-and-cxx.h],
682 [[#include "c-and-cxx.h"
686 return fortytwo () == 42 ? 0 : 1;
689 AT_DATA([cxx-only.cc],
690 [[#include "c-and-cxx.h"
696 AT_COMPILE([c-only.o], [c-only.c])
697 AT_COMPILE_CXX([cxx-only.o], [cxx-only.cc])
698 AT_CHECK([$CXX $CXXFLAGS $CPPFLAGS $LDFLAGS c-only.o cxx-only.o -o c-and-cxx ||
699 exit 77], [ignore], [ignore])
700 AT_PARSER_CHECK([./c-and-cxx])
704 ## ---------------------------- ##
705 ## Running a generated parser. ##
706 ## ---------------------------- ##
709 # AT_PARSER_CHECK(COMMAND, EXIT-STATUS, EXPOUT, EXPERR, [PRE])
710 # ------------------------------------------------------------
711 # So that we can run `./testsuite PREPARSER='valgrind -q' for instance.
713 # Get rid of spurious messages when compiled with --coverage:
714 # +profiling:/[...]/lib/fprintf.gcda:Merge mismatch for summaries
715 m4_define([AT_PARSER_CHECK],
716 [AT_CHECK([$5 $PREPARSER $1], [$2], [$3], [stderr])
717 AT_CHECK([sed >&2 -e '/^profiling:.*:Merge mismatch for summaries/d' stderr],
722 # AT_JAVA_PARSER_CHECK(COMMAND, EXIT-STATUS, EXPOUT, EXPERR, [PRE])
723 # -----------------------------------------------------------------
724 m4_define([AT_JAVA_PARSER_CHECK],
725 [AT_CHECK([$5[ $SHELL ../../../javaexec.sh ]$1], [$2], [$3], [$4])])
728 # AT_TEST_TABLES_AND_PARSE(TITLE, COND-VALUE, TEST-SPEC,
729 # DECLS, GRAMMAR, INPUT,
730 # BISON-STDERR, TABLES-OR-LAST-STATE,
732 # [PARSER-EXIT-VALUE],
733 # [PARSER-STDOUT], [PARSER-STDERR])
734 # -------------------------------------------------------------
735 # Using TITLE as the test group title, check the generated parser tables
736 # and parser for a specified grammar file under a condition labeled by
739 # TEST-SPEC is a comma-delimited list of attributes of this test. Each
740 # recognized attribute is described below where it is relevant.
742 # Insert DECLS and GRAMMAR into the declarations and grammar section of
743 # the grammar file. Insert basic yyerror, yylex, and main function
744 # definitions as well. Hardcode yylex to return the (possibly empty)
745 # comma-delimited series of tokens in INPUT followed by token 0.
747 # If TEST-SPEC contains the attribute no-xml, then invoke bison using
748 # AT_BISON_CHECK_NO_XML. Otherwise, invoke bison using AT_BISON_CHECK.
749 # On the bison command-line, specify `--report=all --defines'. Check
750 # that Bison exits with value 0, has no stdout, and has stderr
753 # If TEST-SPEC contains the attribute `last-state', check that the value
754 # of TABLES-OR-LAST-STATE is the index of the last state generated for
755 # the grammar; in other words, check the number of states (minus one).
756 # Otherwise, check that everything in the `.output' file starting with
757 # the definition of state 0 is the same as the entire value of
758 # TABLES-OR-LAST-STATE.
760 # Expand the M4 in OTHER-CHECKS to perform additional checks of the
761 # `.output' file, which is named `input.output', and/or grammar file,
762 # which is named `input.y'.
764 # Finally, compile the generated parser and then run it using
765 # AT_PARSER_CHECK with PARSER-EXIT-VALUE, PARSER-STDOUT, and
766 # PARSER-STDERR as the 2nd-4th arguments.
768 # As a precondition, you must properly double-quote all arguments that
769 # are to be interpreted as strings.
771 # AT_COND_CASE (when appearing in single-quoted segments of arguments)
772 # invokes m4_case with its own arguments but COND-VALUE inserted as the
773 # first argument. This is useful, for example, when wrapping multiple
774 # AT_TEST_TABLES_AND_PARSE invocations, each representing a different
775 # condition, in another macro.
779 # # AT_TEST_SYNTAX_ERROR(DESCRIPTION, DECLS, GRAMMAR, INPUT, LAST-STATE,
780 # # PARSER-EXIT-VALUE, PARSER-STDOUT, PARSER-STDERR)
781 # # ---------------------------------------------------------------------
782 # m4_define([AT_TEST_SYNTAX_ERROR],
784 # AT_TEST_TABLES_AND_PARSE([$1[ with %error-verbose]], [[verbose]],
786 # [[%error-verbose ]$2], [$3], [$4],
787 # [[]], [$5], [], [$6], [$7], [$8])
788 # AT_TEST_TABLES_AND_PARSE([$1[ with no %error-verbose]], [[no verbose]],
791 # [[]], [$5], [], [$6], [$7], [$8])
794 # AT_TEST_SYNTAX_ERROR([[Single Char Grammar]],
795 # [[%token 'b']], [[start: 'a' ;]], [['a', 'b']],
798 # [AT_COND_CASE([[no verbose]],
801 # [[syntax error, unexpected 'b', expecting $end
803 m4_define([AT_TEST_TABLES_AND_PARSE],
804 [m4_pushdef([AT_COND_CASE], [m4_case([$2], $][@)])
807 AT_BISON_OPTION_PUSHDEFS([$4])
808 AT_DATA_GRAMMAR([[input.y]],
826 static int const input[] = {
827 ]m4_if([$6], [], [], [$6], [[]], [], [$6[, ]])[0
829 static int const *inputp = input;
840 # In some versions of Autoconf, AT_CHECK invokes AS_ESCAPE before
841 # expanding macros, so it corrupts some special characters in the
842 # macros. To avoid this, expand now and pass it the result with proper
843 # string quotation. Assume args 7 through 12 expand to properly quoted
846 m4_if(m4_index(m4_quote($3), [no-xml]), -1,
848 [AT_BISON_CHECK_NO_XML])([[--report=all --defines -o input.c input.y]],
849 [0], [], m4_dquote($7))
851 m4_if(m4_index(m4_quote($3), [last-state]), -1,
852 [AT_CHECK([[sed -n '/^State 0$/,$p' input.output]], [[0]],
854 [AT_CHECK([[sed -n 's/^State //p' input.output | tail -1]], [[0]],
860 # Canonical LR generates very large tables, resulting in very long
861 # files with #line directives that may overflow what the standards
862 # (C90 and C++98) guarantee: 32767. In that case, GCC's -pedantic
863 # will issue an error.
865 # There is no "" around `wc` since some indent the result.
866 m4_bmatch([$4], [%define lr.type canonical-lr],
867 [if test 32767 -lt `wc -l < input.c`; then
868 CFLAGS=`echo " $CFLAGS " | sed -e 's/ -pedantic //'`
869 CXXFLAGS=`echo " $CXXFLAGS " | sed -e 's/ -pedantic //'`
871 AT_COMPILE([[input]])
873 AT_PARSER_CHECK([[./input]],
874 m4_ifval([$10], [m4_dquote($10)]),
875 m4_ifval([$11], [m4_dquote($11)]),
876 m4_ifval([$12], [m4_dquote($12)]))
878 AT_BISON_OPTION_POPDEFS
881 m4_popdef([AT_COND_CASE])])
885 ## ----------------------- ##
886 ## Launch the test suite. ##
887 ## ----------------------- ##
891 # Cannot assign CC and CFLAGS here, since atlocal is loaded after
892 # options are processed, so we don't know the value of CXX and
895 # Note that it also means that command line values for CXX and
896 # CXXFLAGS will not be propagated to CC and CFLAGS.
897 AT_ARG_OPTION([compile-c-with-cxx],
898 [compile C parsers with the C++ compiler])