+# AT_BISON_CHECK(BISON_ARGS, [OTHER_AT_CHECK_ARGS])
+# -------------------------------------------------
+# Check Bison by invoking `bison BISON_ARGS'. BISON_ARGS should not contain
+# shell constructs (such as redirection or pipes) that would prevent
+# appending additional command-line arguments for bison. OTHER_AT_CHECK_ARGS
+# are the usual remaining arguments to AT_CHECK: STATUS, STDOUT, etc.
+#
+# This macro or AT_BISON_CHECK_NO_XML should always be used whenever invoking
+# Bison in the test suite. For now it ensures that:
+#
+# 1. Valgrind doesn't report reachable memory when Bison is expected to have
+# a non-zero exit status since Bison doesn't always try to free all memory
+# in that case.
+#
+# 2. In the case of maintainer-xml-check, XML/XSLT output is compared with
+# --graph and --report=all output for every working grammar.
+#
+# 3. If stderr contains a warning, -Werror and --warnings=error
+# convert the warning to an error.
+#
+# 4. If stderr contains a warning, -Wnone and --warnings=none suppress it.
+m4_define([AT_BISON_CHECK],
+[m4_if(m4_quote($2), [0], [AT_BISON_CHECK_XML($@)],
+ m4_quote($2), [], [AT_BISON_CHECK_XML($@)])
+AT_BISON_CHECK_NO_XML($@)])
+
+m4_define([AT_BISON_WERROR_MSG],
+ [[bison: warnings being treated as errors]])
+
+# AT_BISON_CHECK_NO_XML(BISON_ARGS, [OTHER_AT_CHECK_ARGS])
+# --------------------------------------------------------
+# Same as AT_BISON_CHECK except don't perform XML/XSLT checks. This is useful
+# when a tortured grammar's XML is known to be too large for xsltproc to
+# handle.
+m4_define([AT_BISON_CHECK_NO_XML],
+[AT_CHECK(m4_if(m4_quote($2), [0], [], m4_quote($2), [], [],
+ [AT_QUELL_VALGRIND ])[[bison ]]$@)
+m4_if(m4_bregexp([$4], [: warning: ]), [-1], [],
+ m4_quote(m4_if(m4_quote($2), [], [0], [$2])), [0], [[
+ # Defining POSIXLY_CORRECT causes bison to complain if options
+ # are added after the grammar file name, so skip these checks
+ # in that case.
+ if test -z "${POSIXLY_CORRECT+set}"; then
+ ]AT_SAVE_SPECIAL_FILES[
+
+ # To avoid expanding it repeatedly, store specified stdout.
+ ]AT_DATA([expout], [$3])[
+
+ # Run with -Werror.
+ ]AT_CHECK(AT_QUELL_VALGRIND[[ bison ]$1[ -Werror]],
+ [[1]], [expout], [stderr])[
+
+ # Build expected stderr up to and including the "warnings being
+ # treated as errors" message.
+ ]AT_DATA([[at-bison-check-warnings]], [$4])[
+ at_bison_check_first=`sed -n \
+ '/: warning: /{=;q;}' at-bison-check-warnings`
+ : ${at_bison_check_first:=1}
+ at_bison_check_first_tmp=`sed -n \
+ '/conflicts: [0-9].*reduce$/{=;q;}' at-bison-check-warnings`
+ : ${at_bison_check_first_tmp:=1}
+ if test $at_bison_check_first_tmp -lt $at_bison_check_first; then
+ at_bison_check_first=$at_bison_check_first_tmp
+ fi
+ if test $at_bison_check_first -gt 1; then
+ sed -n "1,`expr $at_bison_check_first - 1`"p \
+ at-bison-check-warnings > experr
+ fi
+ echo ']AT_BISON_WERROR_MSG[' >> experr
+
+ # Finish building expected stderr and check. Unlike warnings,
+ # complaints cause bison to exit early. Thus, with -Werror, bison
+ # does not necessarily report all warnings that it does without
+ # -Werror, but it at least reports one.
+ at_bison_check_last=`sed -n '$=' stderr`
+ : ${at_bison_check_last:=1}
+ at_bison_check_last=`expr $at_bison_check_last - 1`
+ sed -n "$at_bison_check_first,$at_bison_check_last"p \
+ at-bison-check-warnings >> experr
+ ]AT_CHECK([[sed 's,.*/\(]AT_BISON_WERROR_MSG[\)$,\1,' \
+ stderr 1>&2]], [[0]], [[]], [experr])[
+
+ # Now check --warnings=error.
+ cp stderr experr
+ ]AT_CHECK(AT_QUELL_VALGRIND[[ bison ]$1[ --warnings=error]],
+ [[1]], [expout], [experr])[
+
+ # Now check -Wnone and --warnings=none by making sure that
+ # -Werror doesn't change the exit status when -Wnone or
+ # --warnings=none is specified.
+ ]AT_CHECK(AT_QUELL_VALGRIND[[ bison ]$1[ -Wnone -Werror]],
+ [[0]], [expout])[
+ ]AT_CHECK(AT_QUELL_VALGRIND[[ bison ]$1[ --warnings=none \
+ -Werror]], [[0]], [expout])[
+
+ ]AT_RESTORE_SPECIAL_FILES[
+ fi
+ ]])
+])
+
+# AT_BISON_CHECK_XML(BISON_ARGS, [OTHER_AT_CHECK_ARGS])
+# -----------------------------------------------------
+# Run AT_BISON_CHECK's XML/XSLT checks if $BISON_TEST_XML=1 and $XSLTPROC is
+# defined. It doesn't make sense to invoke this macro if Bison is expected to
+# have a non-zero exit status.
+m4_define([AT_BISON_CHECK_XML],
+[[if test x"$BISON_TEST_XML" = x1 && test x"$XSLTPROC" != x""; then]
+ AT_SAVE_SPECIAL_FILES
+ [mkdir xml-tests]
+ m4_pushdef([AT_BISON_ARGS],
+ [m4_bpatsubsts([[$1]],
+ [--report(-file)?=[^][ ]*], [],
+ [--graph=[^][ ]*], [],
+ [--xml=[^][ ]*], [])])dnl
+ # Don't combine these Bison invocations since we want to be sure that
+ # --report=all isn't required to get the full XML file.
+ AT_CHECK([[bison --report=all --report-file=xml-tests/test.output \
+ --graph=xml-tests/test.dot ]]AT_BISON_ARGS,
+ [[0]], [ignore], [ignore])
+ AT_CHECK([[bison --xml=xml-tests/test.xml ]]AT_BISON_ARGS,
+ [[0]], [ignore], [ignore])
+ m4_popdef([AT_BISON_ARGS])dnl
+ [cp xml-tests/test.output expout]
+ AT_CHECK([[$XSLTPROC \
+ `]]AT_QUELL_VALGRIND[[ bison --print-datadir`/xslt/xml2text.xsl \
+ xml-tests/test.xml]], [[0]], [expout])
+ [cp xml-tests/test.dot expout]
+ AT_CHECK([[$XSLTPROC \
+ `]]AT_QUELL_VALGRIND[[ bison --print-datadir`/xslt/xml2dot.xsl \
+ xml-tests/test.xml]], [[0]], [expout])
+ [rm -rf xml-tests expout]
+ AT_RESTORE_SPECIAL_FILES
+[fi]])
+
+# AT_QUELL_VALGRIND
+# -----------------
+# Put this before a Bison invocation to keep Valgrind from complaining about
+# reachable memory.
+#
+# Do not quote invocations of this macro within the first argument of AT_CHECK.
+# The triple quoting below will cause test cases to fail if you do. If you do
+# so anyway but also decrease the quoting below to avoid that problem, AT_CHECK
+# will then fail to shell-escape its contents when attempting to print them.
+# The testsuite verbose output, at least, will be incorrect, but nothing may
+# fail to make sure you notice.
+m4_define([AT_QUELL_VALGRIND],
+[[[VALGRIND_OPTS="$VALGRIND_OPTS --leak-check=summary --show-reachable=no"; export VALGRIND_OPTS;]]])
projects / bison.git / blobdiff