1 # Process this -*- Autotest -*- file with autom4te.
3 # Macros for the GNU Bison Test suite.
4 # Copyright (C) 2003-2010 Free Software Foundation, Inc.
6 # This program is free software: you can redistribute it and/or modify
7 # it under the terms of the GNU General Public License as published by
8 # the Free Software Foundation, either version 3 of the License, or
9 # (at your option) any later version.
11 # This program is distributed in the hope that it will be useful,
12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 # GNU General Public License for more details.
16 # You should have received a copy of the GNU General Public License
17 # along with this program. If not, see <http://www.gnu.org/licenses/>.
19 # We want a recent Autotest.
20 m4_version_prereq([2.58])
27 # AT_MATCHES_CHECK(FILE, PERL-REGEXP, COUNT)
28 # ------------------------------------------
29 # Expect COUNT matches of the PERL-REGEXP in FILE. The file is
30 # taken in "slurp" mode, i.e., one can match end-of-lines.
31 m4_define([AT_MATCHES_CHECK],
32 [AT_CHECK([perl -0777 -ne '
34 s{$2}{ ++$count; "" }gem;
35 printf "$count\n";' $1], [0], [$3
39 ## ------------------------------- ##
40 ## Macros decoding Bison options. ##
41 ## ------------------------------- ##
44 # AT_BISON_OPTION_PUSHDEFS([BISON-OPTIONS])
45 # -----------------------------------------
46 m4_define([AT_BISON_OPTION_PUSHDEFS],
47 [_AT_BISON_OPTION_PUSHDEFS($[1], $[2], [$1])])
50 # _AT_BISON_OPTION_PUSHDEFS($1, $2, [BISON-OPTIONS])
51 # --------------------------------------------------
52 # This macro works around the impossibility to define macros
53 # inside macros, because issuing `[$1]' is not possible in M4 :(.
54 # This sucks hard, GNU M4 should really provide M5-like $$1.
55 m4_define([_AT_BISON_OPTION_PUSHDEFS],
56 [m4_if([$1$2], $[1]$[2], [],
57 [m4_fatal([$0: Invalid arguments: $@])])dnl
58 m4_pushdef([AT_DEFINES_IF],
59 [m4_bmatch([$3], [%defines], [$1], [$2])])
60 m4_pushdef([AT_SKEL_CC_IF],
61 [m4_bmatch([$3], [%language "[Cc]\+\+"\|%skeleton "[a-z0-9]+\.cc"], [$1], [$2])])
62 m4_pushdef([AT_GLR_IF],
63 [m4_bmatch([$3], [%glr-parser\|%skeleton "glr\.], [$1], [$2])])
64 m4_pushdef([AT_LALR1_CC_IF],
65 [AT_SKEL_CC_IF([AT_GLR_IF([$2], [$1])], [$2])])
66 m4_pushdef([AT_GLR_CC_IF],
67 [AT_SKEL_CC_IF([AT_GLR_IF([$1], [$2])], [$2])])
69 m4_pushdef([AT_YACC_IF],
70 [m4_bmatch([$3], [%language\|%glr-parser\|%skeleton], [$2], [$1])])
71 m4_pushdef([AT_LEXPARAM_IF],
72 [m4_bmatch([$3], [%lex-param], [$1], [$2])])
73 m4_pushdef([AT_PARAM_IF],
74 [m4_bmatch([$3], [%parse-param], [$1], [$2])])
75 m4_pushdef([AT_LOCATION_IF],
76 [m4_bmatch([$3], [%locations], [$1], [$2])])
77 m4_pushdef([AT_PURE_IF],
78 [m4_bmatch([$3], [%define *api\.pure\|%pure-parser],
79 [m4_bmatch([$3], [%define *api\.pure *"?false"?], [$2], [$1])],
81 m4_pushdef([AT_PURE_AND_LOC_IF],
82 [m4_bmatch([$3], [%locations], [AT_PURE_IF($@)], [$2])])
83 m4_pushdef([AT_GLR_OR_PARAM_IF],
84 [m4_bmatch([$3], [%glr-parser\|%parse-param], [$1], [$2])])
85 m4_pushdef([AT_NAME_PREFIX],
86 [m4_bmatch([$3], [%name-prefix ".*"],
87 [m4_bregexp([$3], [name-prefix "\([^"]*\)"], [\1])],
89 m4_pushdef([AT_TOKEN_PREFIX],
90 [m4_bmatch([$3], [%define api.tokens.prefix ".*"],
91 [m4_bregexp([$3], [%define api.tokens.prefix "\(.*\)"], [\1])])])
92 # yyerror receives the location if %location & %pure & (%glr or %parse-param).
93 m4_pushdef([AT_YYERROR_ARG_LOC_IF],
94 [AT_GLR_OR_PARAM_IF([AT_PURE_AND_LOC_IF([$1], [$2])],
96 # yyerror always sees the locations (when activated), except if
97 # (yacc & pure & !param). FIXME: This is wrong. See the manual.
98 m4_pushdef([AT_YYERROR_SEES_LOC_IF],
99 [AT_LOCATION_IF([AT_YACC_IF([AT_PURE_IF([AT_PARAM_IF([$1], [$2])],
104 # The interface is pure: either because %define api.pure, or because we
105 # are using the C++ parsers.
106 m4_pushdef([AT_PURE_LEX_IF],
108 [AT_SKEL_CC_IF([$1], [$2])])])
111 [m4_pushdef([AT_LOC], [(*llocp)])
112 m4_pushdef([AT_VAL], [(*lvalp)])
113 m4_pushdef([AT_LEX_FORMALS],
114 [YYSTYPE *lvalp[]AT_LOCATION_IF([, YYLTYPE *llocp])])
115 m4_pushdef([AT_LEX_ARGS],
116 [lvalp[]AT_LOCATION_IF([, llocp])])
117 m4_pushdef([AT_USE_LEX_ARGS],
118 [(void) lvalp;AT_LOCATION_IF([(void) llocp])])
119 m4_pushdef([AT_LEX_PRE_FORMALS],
121 m4_pushdef([AT_LEX_PRE_ARGS],
124 [m4_pushdef([AT_LOC], [[(]AT_NAME_PREFIX[lloc)]])
125 m4_pushdef([AT_VAL], [[(]AT_NAME_PREFIX[lval)]])
126 m4_pushdef([AT_LEX_FORMALS], [void])
127 m4_pushdef([AT_LEX_ARGS], [])
128 m4_pushdef([AT_USE_LEX_ARGS], [])
129 m4_pushdef([AT_LEX_PRE_FORMALS], [])
130 m4_pushdef([AT_LEX_PRE_ARGS], [])
132 AT_GLR_IF([AT_KEYWORDS([glr])])
133 ])# _AT_BISON_OPTION_PUSHDEFS
136 # AT_BISON_OPTION_POPDEFS
137 # -----------------------
138 m4_define([AT_BISON_OPTION_POPDEFS],
139 [m4_popdef([AT_LEX_PRE_ARGS])
140 m4_popdef([AT_LEX_PRE_FORMALS])
141 m4_popdef([AT_USE_LEX_ARGS])
142 m4_popdef([AT_LEX_ARGS])
143 m4_popdef([AT_LEX_FORMALS])
146 m4_popdef([AT_PURE_LEX_IF])
147 m4_popdef([AT_YYERROR_SEES_LOC_IF])
148 m4_popdef([AT_YYERROR_ARG_LOC_IF])
149 m4_popdef([AT_NAME_PREFIX])
150 m4_popdef([AT_GLR_OR_PARAM_IF])
151 m4_popdef([AT_PURE_AND_LOC_IF])
152 m4_popdef([AT_LOCATION_IF])
153 m4_popdef([AT_PARAM_IF])
154 m4_popdef([AT_LEXPARAM_IF])
155 m4_popdef([AT_YACC_IF])
156 m4_popdef([AT_GLR_IF])
157 m4_popdef([AT_SKEL_CC_IF])
158 m4_popdef([AT_GLR_CC_IF])
159 m4_popdef([AT_LALR1_CC_IF])
160 m4_popdef([AT_DEFINES_IF])
161 ])# AT_BISON_OPTION_POPDEFS
165 ## -------------------------- ##
166 ## Generating Grammar Files. ##
167 ## -------------------------- ##
169 # AT_DATA_SOURCE_PROLOGUE
170 # ------------------------
171 # The prologue that should be included in any source code that is
172 # meant to be compiled.
173 m4_define([AT_DATA_SOURCE_PROLOGUE],
174 [[#include <config.h>
175 /* We don't need perfect functions for these tests. */
181 # AT_DATA_GRAMMAR_PROLOGUE
182 # ------------------------
183 # The prologue that should be included in any grammar which parser is
184 # meant to be compiled.
185 m4_define([AT_DATA_GRAMMAR_PROLOGUE],
187 ]AT_DATA_SOURCE_PROLOGUE[]dnl
191 # AT_DATA_SOURCE(NAME, CONTENT)
192 # -----------------------------
193 # Generate the file NAME, which CONTENT is preceded by
194 # AT_DATA_SOURCE_PROLOGUE.
195 m4_define([AT_DATA_SOURCE],
197 [AT_DATA_SOURCE_PROLOGUE
201 # AT_DATA_GRAMMAR(NAME, CONTENT)
202 # ------------------------------
203 # Generate the file NAME, which CONTENT is preceded by
204 # AT_DATA_GRAMMAR_PROLOGUE.
205 m4_define([AT_DATA_GRAMMAR],
207 [AT_DATA_GRAMMAR_PROLOGUE
211 # AT_BISON_CHECK(BISON_ARGS, [OTHER_AT_CHECK_ARGS])
212 # -------------------------------------------------
213 # Check Bison by invoking `bison BISON_ARGS'. OTHER_AT_CHECK_ARGS are the
214 # usual remaining arguments to AT_CHECK: STATUS, STDOUT, etc.
216 # This macro or AT_BISON_CHECK_NO_XML should always be used whenever invoking
217 # Bison in the test suite. For now it ensures that:
219 # 1. Valgrind doesn't report reachable memory when Bison is expected to have
220 # a non-zero exit status since Bison doesn't always try to free all memory
223 # 2. In the case of maintainer-xml-check, XML/XSLT output is compared with
224 # --graph and --report=all output for every working grammar.
225 m4_define([AT_BISON_CHECK],
226 [m4_if(m4_quote($2), [0], [AT_BISON_CHECK_XML($@)],
227 m4_quote($2), [], [AT_BISON_CHECK_XML($@)])
228 AT_BISON_CHECK_NO_XML($@)])
230 # AT_BISON_CHECK_NO_XML(BISON_ARGS, [OTHER_AT_CHECK_ARGS])
231 # --------------------------------------------------------
232 # Same as AT_BISON_CHECK except don't perform XML/XSLT checks. This is useful
233 # when a tortured grammar's XML is known to be too large for xsltproc to
235 m4_define([AT_BISON_CHECK_NO_XML],
236 [AT_CHECK(m4_if(m4_quote($2), [0], [], m4_quote($2), [], [],
237 [AT_QUELL_VALGRIND ])[[bison ]]$@)])
239 # AT_BISON_CHECK_XML(BISON_ARGS, [OTHER_AT_CHECK_ARGS])
240 # -----------------------------------------------------
241 # Run AT_BISON_CHECK's XML/XSLT checks if $BISON_TEST_XML=1 and $XSLTPROC is
242 # defined. It doesn't make sense to invoke this macro if Bison is expected to
243 # have a non-zero exit status.
244 m4_define([AT_BISON_CHECK_XML],
245 [[if test x"$BISON_TEST_XML" = x1 && test x"$XSLTPROC" != x""; then
247 m4_pushdef([AT_BISON_ARGS],
248 [m4_bpatsubsts([[$1]],
249 [--report(-file)?=[^][ ]*], [],
250 [--graph=[^][ ]*], [],
251 [--xml=[^][ ]*], [])])dnl
252 # Don't combine these Bison invocations since we want to be sure that
253 # --report=all isn't required to get the full XML file.
254 AT_CHECK([[bison --report=all --report-file=xml-tests/test.output \
255 --graph=xml-tests/test.dot ]]AT_BISON_ARGS,
256 [[0]], [ignore], [ignore])
257 AT_CHECK([[bison --xml=xml-tests/test.xml ]]AT_BISON_ARGS,
258 [[0]], [ignore], [ignore])
259 m4_popdef([AT_BISON_ARGS])dnl
260 [cp xml-tests/test.output expout]
261 AT_CHECK([[$XSLTPROC \
262 `]]AT_QUELL_VALGRIND[[ bison --print-datadir`/xslt/xml2text.xsl \
263 xml-tests/test.xml]], [[0]], [expout])
264 [cp xml-tests/test.dot expout]
265 AT_CHECK([[$XSLTPROC \
266 `]]AT_QUELL_VALGRIND[[ bison --print-datadir`/xslt/xml2dot.xsl \
267 xml-tests/test.xml]], [[0]], [expout])
268 [rm -rf xml-tests expout
273 # Put this before a Bison invocation to keep Valgrind from complaining about
276 # Do not quote invocations of this macro within the first argument of AT_CHECK.
277 # The triple quoting below will cause test cases to fail if you do. If you do
278 # so anyway but also decrease the quoting below to avoid that problem, AT_CHECK
279 # will then fail to shell-escape its contents when attempting to print them.
280 # The testsuite verbose output, at least, will be incorrect, but nothing may
281 # fail to make sure you notice.
282 m4_define([AT_QUELL_VALGRIND],
283 [[[VALGRIND_OPTS="$VALGRIND_OPTS --leak-check=summary --show-reachable=no"; export VALGRIND_OPTS;]]])
285 ## ------------------------ ##
286 ## Compiling C, C++ Files. ##
287 ## ------------------------ ##
290 # AT_COMPILE(OUTPUT, [SOURCES = OUTPUT.c])
291 # ----------------------------------------
292 # Compile SOURCES into OUTPUT. If OUTPUT does not contain '.',
293 # assume that we are linking too; this is a hack.
294 m4_define([AT_COMPILE],
295 [AT_CHECK([$CC $CFLAGS $CPPFLAGS m4_bmatch([$1], [[.]], [], [$LDFLAGS ])-o $1 m4_default([$2], [$1.c])[]m4_bmatch([$1], [[.]], [], [ $LIBS])],
296 0, [ignore], [ignore])])
298 # AT_COMPILE_CXX(OUTPUT, [SOURCES = OUTPUT.cc])
299 # --------------------------------------------
300 # Compile SOURCES into OUTPUT. If OUTPUT does not contain '.',
301 # assume that we are linking too; this is a hack.
302 # If the C++ compiler does not work, ignore the test.
303 m4_define([AT_COMPILE_CXX],
305 AT_CHECK([$BISON_CXX_WORKS], 0, ignore, ignore)
306 AT_CHECK([$CXX $CXXFLAGS $CPPFLAGS m4_bmatch([$1], [[.]], [], [$LDFLAGS ])-o $1 m4_default([$2], [$1.cc])[]m4_bmatch([$1], [[.]], [], [ $LIBS])],
307 0, [ignore], [ignore])])
310 # AT_FULL_COMPILE(OUTPUT, [OTHER])
311 # --------------------------------
312 # Compile OUTPUT.y to OUTPUT.c or OUTPUT.cc, and compile it to OUTPUT.
313 # If OTHER is specified, compile OUTPUT-OTHER.c or OUTPUT-OTHER.cc to OUTPUT
315 # Relies on AT_SKEL_CC_IF.
316 m4_define([AT_FULL_COMPILE],
318 [AT_BISON_CHECK([-o $1.cc $1.y])
319 AT_COMPILE_CXX([$1]m4_ifval($2, [, [$1.cc $1-$2.cc]]))],
320 [AT_BISON_CHECK([-o $1.c $1.y])
321 AT_COMPILE([$1]m4_ifval($2, [, [$1.c $1-$2.c]]))])
325 ## ---------------------------- ##
326 ## Running a generated parser. ##
327 ## ---------------------------- ##
329 # AT_PARSER_CHECK(COMMAND, EXIT-STATUS, EXPOUT, EXPERR, [PRE])
330 # ------------------------------------------------------------
331 # So that we can run `./testsuite PREPARSER='valgrind -q' for instance.
332 m4_define([AT_PARSER_CHECK],
333 [AT_CHECK([$5 $PREPARSER $1], [$2], [$3], [$4])])
335 # AT_TEST_TABLES_AND_PARSE(TITLE, COND-VALUE, TEST-SPEC,
336 # DECLS, GRAMMAR, INPUT,
337 # BISON-STDERR, TABLES-OR-LAST-STATE,
339 # [PARSER-EXIT-VALUE],
340 # [PARSER-STDOUT], [PARSER-STDERR])
341 # -------------------------------------------------------------
342 # Using TITLE as the test group title, check the generated parser tables
343 # and parser for a specified grammar file under a condition labeled by
346 # TEST-SPEC is a comma-delimited list of attributes of this test. Each
347 # recognized attribute is described below where it is relevant.
349 # Insert DECLS and GRAMMAR into the declarations and grammar section of
350 # the grammar file. Insert basic yyerror, yylex, and main function
351 # definitions as well. Hardcode yylex to return the (possibly empty)
352 # comma-delimited series of tokens in INPUT followed by token 0.
354 # If TEST-SPEC contains the attribute no-xml, then invoke bison using
355 # AT_BISON_CHECK_NO_XML. Otherwise, invoke bison using AT_BISON_CHECK.
356 # On the bison command-line, specify `--report=all --defines'. Check
357 # that Bison exits with value 0, has no stdout, and has stderr
360 # If TEST-SPEC contains the attribute `last-state', check that the value
361 # of TABLES-OR-LAST-STATE is the index of the last state generated for
362 # the grammar; in other words, check the number of states (minus one).
363 # Otherwise, check that everything in the `.output' file starting with
364 # the definition of state 0 is the same as the entire value of
365 # TABLES-OR-LAST-STATE.
367 # Expand the M4 in OTHER-CHECKS to perform additional checks of the
368 # `.output' file, which is named `input.output', and/or grammar file,
369 # which is named `input.y'.
371 # Finally, compile the generated parser and then run it using
372 # AT_PARSER_CHECK with PARSER-EXIT-VALUE, PARSER-STDOUT, and
373 # PARSER-STDERR as the 2nd-4th arguments.
375 # As a precondition, you must properly double-quote all arguments that
376 # are to be interpreted as strings.
378 # AT_COND_CASE (when appearing in single-quoted segments of arguments)
379 # invokes m4_case with its own arguments but COND-VALUE inserted as the
380 # first argument. This is useful, for example, when wrapping multiple
381 # AT_TEST_TABLES_AND_PARSE invocations, each representing a different
382 # condition, in another macro.
386 # # AT_TEST_SYNTAX_ERROR(DESCRIPTION, DECLS, GRAMMAR, INPUT, LAST-STATE,
387 # # PARSER-EXIT-VALUE, PARSER-STDOUT, PARSER-STDERR)
388 # # ---------------------------------------------------------------------
389 # m4_define([AT_TEST_SYNTAX_ERROR],
391 # AT_TEST_TABLES_AND_PARSE([$1[ with %error-verbose]], [[verbose]],
393 # [[%error-verbose ]$2], [$3], [$4],
394 # [[]], [$5], [], [$6], [$7], [$8])
395 # AT_TEST_TABLES_AND_PARSE([$1[ with no %error-verbose]], [[no verbose]],
398 # [[]], [$5], [], [$6], [$7], [$8])
401 # AT_TEST_SYNTAX_ERROR([[Single Char Grammar]],
402 # [[%token 'b']], [[start: 'a' ;]], [['a', 'b']],
405 # [AT_COND_CASE([[no verbose]],
408 # [[syntax error, unexpected 'b', expecting $end
410 m4_define([AT_TEST_TABLES_AND_PARSE],
411 [m4_pushdef([AT_COND_CASE], [m4_case([$2], $][@)])
415 AT_DATA_GRAMMAR([[input.y]],
418 static void yyerror (char const *msg);
419 static int yylex (void);
431 yyerror (char const *msg)
433 fprintf (stderr, "%s\n", msg);
439 static int const input[] = {
440 ]m4_if([$6], [], [], [$6], [[]], [], [$6[, ]])[0
442 static int const *inputp = input;
453 # In some versions of Autoconf, AT_CHECK invokes AS_ESCAPE before
454 # expanding macros, so it corrupts some special characters in the
455 # macros. To avoid this, expand now and pass it the result with proper
456 # string quotation. Assume args 7 thru 12 expand to properly quoted
459 m4_if(m4_index(m4_quote($3), [no-xml]), -1,
461 [AT_BISON_CHECK_NO_XML])([[--report=all --defines -o input.c input.y]],
462 [0], [], m4_dquote($7))
464 m4_if(m4_index(m4_quote($3), [last-state]), -1,
465 [AT_CHECK([[sed -n '/^state 0$/,$p' input.output]], [[0]],
467 [AT_CHECK([[sed -n 's/^state //p' input.output | tail -1]], [[0]],
473 AT_COMPILE([[input]])
475 AT_PARSER_CHECK([[./input]],
476 m4_ifval([$10], [m4_dquote($10)]),
477 m4_ifval([$11], [m4_dquote($11)]),
478 m4_ifval([$12], [m4_dquote($12)]))
482 m4_popdef([AT_COND_CASE])])
486 ## ----------------------- ##
487 ## Launch the test suite. ##
488 ## ----------------------- ##