tests/local.at

   1 # M4 macros used in building Autoconf test suites.        -*- Autotest -*-
   2
   3 # Copyright (C) 2000-2012 Free Software Foundation, Inc.
   4
   5 # This program is free software: you can redistribute it and/or modify
   6 # it under the terms of the GNU General Public License as published by
   7 # the Free Software Foundation, either version 3 of the License, or
   8 # (at your option) any later version.
   9 #
  10 # This program is distributed in the hope that it will be useful,
  11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 # GNU General Public License for more details.
  14 #
  15 # You should have received a copy of the GNU General Public License
  16 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17
  18 m4_version_prereq([2.57])
  19
  20 # Used in many tests.
  21 m4_pattern_allow([^AS_EXIT$])
  22 m4_pattern_allow([^m4_(define|shift)$])
  23
  24 # Programs this package provides
  25 AT_TESTED([autom4te autoconf autoheader autoupdate autoreconf ifnames])
  26
  27 # Enable colored test output.
  28 AT_COLOR_TESTS
  29
  30 ## ---------------- ##
  31 ## Utility macros.  ##
  32 ## ---------------- ##
  33
  34 # AT_CMP(FILE-1, FILE-2)
  35 # ----------------------
  36 # Check FILE-1 and FILE-2 for equality, like `cmp FILE-1 FILE-2'.
  37 m4_define([AT_CMP],
  38 [m4_ifval([$2],, [m4_fatal([AT_CMP takes two arguments.])])[]dnl
  39 AT_CHECK([$at_diff "$1" "$2"])
  40 ])# AT_CMP
  41
  42
  43 ## ---------------- ##
  44 ## Testing syntax.  ##
  45 ## ---------------- ##
  46
  47 # AT_CHECK_SHELL_SYNTAX(PROGRAM)
  48 # ------------------------------
  49 # If the shell handles `-n' well, use it to check the syntax of PROGRAM;
  50 # otherwise, do nothing.
  51 m4_define([AT_CHECK_SHELL_SYNTAX],
  52 [AT_SKIP_IF([test "$ac_cv_sh_n_works" != yes])
  53 AT_CHECK([/bin/sh -n $1])])
  54
  55 m4_define([AT_CHECK_PERL_SYNTAX],
  56 [AT_CHECK([autom4te_perllibdir=$abs_top_srcdir/lib $PERL -c "$abs_top_builddir"/bin/$1],
  57           0, [], [ignore])])
  58
  59 ## ------------------ ##
  60 ## Testing autom4te.  ##
  61 ## ------------------ ##
  62
  63
  64 # AT_CHECK_M4(COMMAND, [EXIT-STATUS = 0], STDOUT, STDERR)
  65 # -------------------------------------------------------
  66 # If stderr is specified, normalize the observed stderr.
  67 # This (using GNU M4 1.4.6)
  68 #
  69 #  /usr/local/bin/m4:script.4s:1: cannot open `foo': No such file or directory
  70 #  autom4te: /usr/local/bin/m4 failed with exit status: 1
  71 #
  72 # or this (GNU M4 1.4.11)
  73 #
  74 #  /usr/local/bin/m4:script.4s:1: include: cannot open `foo': No such file or directory
  75 #  autom4te: /usr/local/bin/m4 failed with exit status: 1
  76 #
  77 # or this (GNU M4 1.4 installed as gm4)
  78 #
  79 #  script.4s:1: /usr/local/bin/gm4: Cannot open foo: No such file or directory
  80 #  autom4te: /usr/local/bin/gm4 failed with exit status: 1
  81 #
  82 # or this (GNU M4 1.4.13 installed as m4-1.4.13):
  83 #
  84 #  /usr/bin/m4-1.4.13:script.4s:1: include: cannot open `foo': No such file or directory
  85 #  autom4te: /usr/bin/m4-1.4.13 failed with exit status: 1
  86 #
  87 # becomes
  88 #
  89 #  m4:script.4s:1: cannot open `foo': No such file or directory
  90 #  autom4te: m4 failed with exit status: 1
  91 #
  92 # We use the following sed patterns:
  93 #
  94 #     (m4): ?(file): ?(line):
  95 # or  (file): ?(line): ?(m4):
  96 # to  m4:(file):(line):
  97 #
  98 # and
  99 #     m4:(file):(line): Cannot open foo:
 100 # or  m4:(file):(line): include: cannot open `foo':
 101 # to  m4:(file):(line): cannot open `foo':
 102 #
 103 # and
 104 #     autom4te: [^ ]m4
 105 # or  autom4te: [^ ]m4.exe
 106 # to  autom4te: m4
 107 #
 108 # Moreover, DJGPP error messages include the error code in brackets;
 109 # remove the error code during normalization.
 110 #
 111 m4_define([AT_CHECK_M4],
 112 [AT_CHECK([$1], [$2], [$3],
 113           m4_case([$4], [], [], [ignore], [ignore], [stderr]))
 114 m4_case([$4], [], [], [ignore], [],
 115 [AT_CHECK([[sed 's/^[^:]*m4[-.ex0-9]*: *\([^:]*:\) *\([0-9][0-9]*: \)/m4:\1\2/
 116         s/^\([^:]*:\) *\([0-9][0-9]*:\)[^:]*m4[-.ex0-9]*: /m4:\1\2 /
 117         s/: C\(annot open \)\([^`:]*\):/: c\1`\2'\'':/
 118         s/: include:\( cannot open\)/:\1/
 119         s/^autom4te: [^ ]*m4[.ex]* /autom4te: m4 /
 120         s/ (E[A-Z]*)$//
 121     ' stderr >&2]], [0], [], [$4])])
 122 ])
 123
 124 # AT_CHECK_AUTOM4TE(FLAGS, [EXIT-STATUS = 0], STDOUT, STDERR)
 125 # -----------------------------------------------------------
 126 m4_define([AT_CHECK_AUTOM4TE],
 127 [AT_CHECK_M4([autom4te $1], [$2], [$3], [$4])])
 128
 129
 130
 131 ## ----------------- ##
 132 ## Testing M4sugar.  ##
 133 ## ----------------- ##
 134
 135
 136 # AT_DATA_M4SUGAR(FILE-NAME, CONTENTS)
 137 # ------------------------------------
 138 # Escape the invalid tokens with @&t@.
 139 m4_define([AT_DATA_M4SUGAR],
 140 [AT_DATA([$1],
 141 [m4_bpatsubst([$2], [\(@.\)\(.@\)\|\(m4\)\(_\)\|\(d\)\(nl\)],
 142               [\1\3\5@&t@\2\4\6])])])
 143
 144
 145 # AT_CHECK_M4SUGAR(FLAGS, [EXIT-STATUS = 0], STDOUT, STDERR)
 146 # ----------------------------------------------------------
 147 m4_define([AT_CHECK_M4SUGAR],
 148 [AT_KEYWORDS([m4sugar])
 149 AT_CHECK_AUTOM4TE([--language=m4sugar script.4s -o script $1],
 150                    [$2], [$3], [$4])])
 151
 152
 153
 154 ## -------------- ##
 155 ## Testing M4sh.  ##
 156 ## -------------- ##
 157
 158
 159 # AT_DATA_M4SH(FILE-NAME, CONTENTS)
 160 # ---------------------------------
 161 # Escape the invalid tokens with @&t@.
 162 m4_define([AT_DATA_M4SH],
 163 [AT_DATA([$1],
 164 [m4_bpatsubst([$2], [\(@.\)\(.@\)\|\(m4\|AS\)\(_\)\|\(d\)\(nl\)],
 165               [\1\3\5@&t@\2\4\6])])])
 166
 167
 168 # AT_CHECK_M4SH(FLAGS, [EXIT-STATUS = 0], STDOUT, STDERR)
 169 # -------------------------------------------------------
 170 m4_define([AT_CHECK_M4SH],
 171 [AT_CHECK_AUTOM4TE([--language=m4sh script.as -o script $1],
 172                    [$2], [$3], [$4])])
 173
 174
 175
 176 ## ------------------ ##
 177 ## Testing Autoconf.  ##
 178 ## ------------------ ##
 179
 180
 181 # AT_DATA_AUTOCONF(FILE-NAME, CONTENTS)
 182 # -------------------------------------
 183 # Escape the invalid tokens with @&t@.
 184 m4_define([AT_DATA_AUTOCONF],
 185 [AT_DATA([$1],
 186 [m4_bpatsubst([$2], [\(@.\)\(.@\)\|\(m4\|AS\|AC\)\(_\)\|\(d\)\(nl\)],
 187               [\1\3\5@&t@\2\4\6])])])
 188
 189
 190
 191 # AT_CONFIGURE_AC(BODY)
 192 # ---------------------
 193 # Create a full configure.ac running BODY, with a config header set up,
 194 # AC_OUTPUT, and environment checking hooks.
 195 m4_define([AT_CONFIGURE_AC],
 196 [AT_DATA([configure.ac],
 197 [[AC_INIT
 198 AC_CONFIG_HEADERS(config.h:config.hin)
 199 AC_STATE_SAVE(before)]
 200 $1
 201 [AC_OUTPUT
 202 AC_STATE_SAVE(after)
 203 ]])
 204 cp "$abs_top_srcdir/build-aux/install-sh" \
 205    "$abs_top_srcdir/build-aux/config.guess" \
 206    "$abs_top_srcdir/build-aux/config.sub" .
 207 cp "$abs_top_srcdir/tests/statesave.m4" aclocal.m4
 208 ])# AT_CONFIGURE_AC
 209
 210
 211 # AT_CHECK_AUTOCONF(ARGS, [EXIT-STATUS = 0], STDOUT, STDERR)
 212 # ----------------------------------------------------------
 213 # We always use "--force", to prevent problems with timestamps if the testsuite
 214 # were running too fast.
 215 m4_define([AT_CHECK_AUTOCONF],
 216 [AT_CHECK_M4([autoconf --force $1], [$2], [$3], [$4])
 217 if test -s configure && test "$ac_cv_sh_n_works" = yes; then
 218   AT_CHECK_SHELL_SYNTAX([configure])
 219 fi
 220 ])
 221
 222
 223 # AT_CHECK_AUTOHEADER(ARGS, [EXIT-STATUS = 0], STDOUT, STDERR)
 224 # ------------------------------------------------------------
 225 m4_define([AT_CHECK_AUTOHEADER],
 226 [AT_CHECK([autoheader $1], [$2], [$3], [$4])
 227 ])
 228
 229
 230 # AT_CHECK_CONFIGURE(END-COMMAND,
 231 #                    [EXIT-STATUS = 0],
 232 #                    [STDOUT = IGNORE], STDERR)
 233 # ---------------------------------------------
 234 # `abs_top_srcdir' is needed so that `./configure' finds install-sh.
 235 # Using --srcdir is more expensive.
 236 m4_define([AT_CHECK_CONFIGURE],
 237 [AT_CAPTURE_FILE([config.log])[]dnl
 238  AT_CHECK([./configure $configure_options $1],
 239           [$2],
 240           m4_default([$3], [ignore]), [$4])])
 241
 242
 243 # AT_CHECK_ENV
 244 # ------------
 245 # Check that the full configure run remained in its variable name space,
 246 # and cleaned up tmp files.
 247 #
 248 # Perhaps grep -E is not supported, or perhaps it chokes on such a big regex.
 249 # In this case just don't pay attention to the env.  It would be great
 250 # to keep the error message but we can't: that would break AT_CHECK.
 251 #
 252 # FreeBSD sh may intermingle the trace output from the egrep and grep
 253 # commands in the pipe, so turn off tracing for these.
 254 #
 255 # Some tests might exit prematurely when they find a problem, in
 256 # which case `env-after' is probably missing.  Don't check it then.
 257 #
 258 # Here are the variables `configure' may modify during execution:
 259 # - ^as_
 260 #   M4sh's shell name space.
 261 # - ^ac_
 262 #   Autoconf's shell name space.
 263 # - prefix and exec_prefix
 264 #   are kept undefined (NONE) until AC_OUTPUT which then sets them to
 265 #   `/usr/local' and `${prefix}' for make.
 266 # - (host|build|target)(_(alias|cpu|vendor|os))?
 267 #   Set by AC_CANONICAL_(HOST|BUILD|TARGET).
 268 # - cross_compiling
 269 #   Set by AC_INIT.
 270 # - interpval
 271 #   Set by AC_SYS_INTERPRETER.
 272 # - CONFIG_STATUS and DEFS
 273 #   Set by AC_OUTPUT.
 274 # - AC_SUBST'ed variables
 275 #   (FIXME: Generate a list of these automatically.)
 276 # - _|@|.[*#?$].|argv|ARGC|LINENO|OLDPWD|PIPESTATUS|RANDOM|SECONDS
 277 #   Some variables some shells use and change.
 278 #   `.[*#?$].' catches `$#' etc. which are displayed like this:
 279 #      | '!'=18186
 280 #      | '#'=0
 281 #      | '$'=6908
 282 #
 283 m4_define([AT_CHECK_ENV],
 284 [m4_divert_once([PREPARE_TESTS], [_AT_CHECK_ENV])dnl
 285 AT_CHECK([at_check_env])])
 286 m4_define([_AT_CHECK_ENV],
 287 [AS_FUNCTION_DESCRIBE([at_check_env], [],
 288 [Compare the directory and environment state both before and after a run,
 289 and return non-zero status if they differ inappropriately.])
 290 at_check_env ()
 291 {
 292 # Compare directory listings.
 293 test -f state-ls.before ||
 294   AS_ERROR([state-ls.before not present])
 295 test -f state-ls.after \
 296   && { $at_diff state-ls.before state-ls.after || return 1; }
 297 # Compare variable space dumps.
 298 if test -f state-env.before && test -f state-env.after; then
 299   set +x
 300   for act_file in state-env.before state-env.after
 301   do
 302     $EGREP -v '^(m4_join([|],
 303       [a[cs]_.*],
 304       [(exec_)?prefix|DEFS|CONFIG_STATUS],
 305       [CC|CFLAGS|CPP|GCC|CXX|CXXFLAGS|CXXCPP|GXX|F77|FFLAGS|FLIBS|G77],
 306       [ERL|ERLC|ERLCFLAGS|ERLANG_PATH_ERL|ERLANG_ROOT_DIR|ERLANG_LIB_DIR],
 307       [ERLANG_LIB_DIR_.*|ERLANG_LIB_VER_.*|ERLANG_INSTALL_LIB_DIR],
 308       [ERLANG_INSTALL_LIB_DIR_.*|ERLANG_ERTS_VER|OBJC|OBJCPP|OBJCFLAGS],
 309       [OBJCXX|OBJCXXCPP|OBJCXXFLAGS],
 310       [GOC|GOFLAGS],
 311       [OPENMP_CFLAGS],
 312       [LIBS|LIB@&t@OBJS|LTLIBOBJS|LDFLAGS],
 313       [INSTALL(_(DATA|PROGRAM|SCRIPT))?],
 314       [CYGWIN|ISC|MINGW32|MINIX|EMXOS2|XENIX|EXEEXT|OBJEXT],
 315       [X_(CFLAGS|(EXTRA_|PRE_)?LIBS)|x_(includes|libraries)|(have|no)_x],
 316       [(host|build|target)(_(alias|cpu|vendor|os))?],
 317       [cross_compiling|U],
 318       [interpval|PATH_SEPARATOR],
 319       [GFC|F77_DUMMY_MAIN|f77_(case|underscore)],
 320       [FC(_DUMMY_MAIN|FLAGS|LIBS|FLAGS_[fF]|_MODEXT|_MODINC|_MODOUT|_DEFINE)?],
 321       [ALLOCA|GETLOADAVG_LIBS|KMEM_GROUP|NEED_SETGID|POW_LIB],
 322       [AWK|LEX|LEXLIB|LEX_OUTPUT_ROOT|LN_S|M4|MKDIR_P|RANLIB|SET_MAKE|YACC],
 323       [GREP|[EF]GREP|SED],
 324       [[_@]|.[*#?$].],
 325       [argv|ARGC|LINENO|OLDPWD|PIPESTATUS|RANDOM|SECONDS]))=' \
 326      $act_file 2>/dev/null |
 327       # There may be variables spread on several lines; remove latter lines.
 328       $GREP '^m4_defn([m4_re_word])=' >clean-$act_file
 329   done
 330   $at_traceon
 331   $at_diff clean-state-env.before clean-state-env.after
 332 fi
 333 } [#]at_check_env])
 334
 335
 336 # AT_CONFIG_CMP(VAR-FILE-A, VAR-FILE-B)
 337 # -------------------------------------
 338 # Check the outcomes of two configure runs for equality by comparing dumps of
 339 # their shell variables.  VAR-FILE-A and VAR-FILE-B are two `set'-style shell
 340 # variable space dumps.
 341 #
 342 # We permit variance between runs in the following shell variables:
 343 # - ^as_
 344 #   M4sh's shell name space.
 345 # - ^ac_, excluding ^ac_cv_
 346 #   Autoconf's private shell name space.
 347 # - PPID [bash, zsh]
 348 # - RANDOM [zsh]
 349 # - SECONDS [zsh]
 350 # - '$' [zsh]
 351 # - argv [zsh]
 352 # - ARGC [zsh]
 353 #
 354 # Furthermore, it is okay for a non-cache variable initialized to empty in one
 355 # run to be unset in another run.  This happens when, for example, cache update
 356 # code tries a number of values in LIBS and eventually restores LIBS to its
 357 # original value. If LIBS was previously unset, it will have become set and
 358 # empty.  (OTOH, cache variables indicate the result of the test even if they
 359 # are empty, so we have to be strict about them.)
 360 #
 361 # Lines that do not look like `foo=bar' are probably latter lines of
 362 # multiline values; trim them.
 363 #
 364 m4_define([AT_CONFIG_CMP],
 365 [for act_file in $1 $2
 366 do
 367   $SED '/^ac_cv_/ b
 368         /^m4_defn([m4_re_word])=./ !d
 369         /^[[^=]]*='\'''\''$/ d
 370         /^a[[cs]]_/ d
 371         /^OLDPWD=/ d
 372         /^PPID=/ d
 373         /^RANDOM=/ d
 374         /^SECONDS=/ d
 375         /'\'\\\$\''=/ d
 376         /^argv=/ d
 377         /^ARGC=/ d
 378         ' $act_file >at_config_vars-$act_file
 379 done
 380 AT_CMP([at_config_vars-$1], [at_config_vars-$2])[]dnl
 381 ])# AT_CONFIG_CMP
 382
 383
 384 # AT_CHECK_DEFINES(CONTENT)
 385 # -------------------------
 386 # Verify that config.h, once stripped, is CONTENT.
 387 # Stripping consists of keeping CPP lines (i.e. containing a hash),
 388 # but those of automatically checked features (STDC_HEADERS etc.)
 389 # and symbols (PACKAGE_...).
 390 # AT_CHECK_HEADER is a better name, but too close from AC_CHECK_HEADER.
 391 m4_define([AT_CHECK_DEFINES],
 392 [AT_CHECK([[sed '/#/!d
 393 /INTTYPES/d
 394 /MEMORY/d
 395 /PACKAGE_/d
 396 /STDC_HEADERS/d
 397 /STDINT/d
 398 /STDLIB/d
 399 /STRING/d
 400 /SYS_STAT/d
 401 /SYS_TYPES/d
 402 /UNISTD/d' config.h]],,
 403           [$1])])
 404
 405
 406 # AT_CHECK_AUTOUPDATE
 407 # -------------------
 408 m4_define([AT_CHECK_AUTOUPDATE],
 409 [AT_CHECK([autoupdate $1], [$2], [$3], [$4])
 410 ])
 411
 412
 413 # _AT_CHECK_AC_MACRO(AC-BODY, PRE-TESTS)
 414 # --------------------------------------
 415 # Create a minimalist configure.ac running the macro named
 416 # NAME-OF-THE-MACRO, check that autoconf runs on that script,
 417 # and that the shell runs correctly the configure.
 418 m4_define([_AT_CHECK_AC_MACRO],
 419 [AT_CONFIGURE_AC([$1])
 420 $2
 421 AT_CHECK_AUTOCONF
 422 AT_CHECK_AUTOHEADER
 423 AT_CHECK_CONFIGURE
 424 AT_CHECK_ENV
 425 ])# _AT_CHECK_AC_MACRO
 426
 427
 428 # AT_CHECK_MACRO(MACRO, [MACRO-USE], [ADDITIONAL-CMDS],
 429 #                [AUTOCONF-FLAGS = -W obsolete])
 430 # -----------------------------------------------------
 431 # Create a minimalist configure.ac running the macro named
 432 # NAME-OF-THE-MACRO, check that autoconf runs on that script,
 433 # and that the shell runs correctly the configure.
 434 #
 435 # We run `configure' twice, both times with a cache, and compare
 436 # the environment after each run to detect inconsistencies.
 437 #
 438 # New macros are not expected to depend upon obsolete macros.
 439 m4_define([AT_CHECK_MACRO],
 440 [AT_SETUP([$1])
 441
 442 AT_CONFIGURE_AC([m4_default([$2], [$1])])
 443
 444 AT_CHECK_AUTOCONF([m4_default([$4], [-W obsolete])])
 445 AT_CHECK_AUTOHEADER
 446
 447 for at_run in r1 r2
 448 do
 449     AT_CHECK_CONFIGURE([-C])
 450     cp -f state-env.after state-env.$at_run
 451     cp -f config.h config-h.$at_run
 452     AT_CHECK_ENV
 453 done
 454
 455 AT_CMP([config-h.r1], [config-h.r2])
 456 AT_CONFIG_CMP([state-env.r1], [state-env.r2])
 457
 458 $3
 459
 460 AT_CLEANUP[]dnl
 461 ])# AT_CHECK_MACRO
 462
 463
 464 # AT_CHECK_MACRO_CROSS(MACRO, [MACRO-USE], [ADDITIONAL-CMDS],
 465 #                      [AUTOCONF-FLAGS = -W obsolete])
 466 # -----------------------------------------------------------
 467 # Like the previous one, but creates two checks: for native
 468 # compile and for cross-compile.
 469 m4_define([AT_CHECK_MACRO_CROSS],
 470 [AT_CHECK_MACRO($@)
 471 AT_CHECK_MACRO([$1 (cross compile)],
 472   [AT_KEYWORDS([cross])
 473   # Exercise the code used when cross-compiling.
 474   cross_compiling=yes
 475   ac_tool_warned=yes
 476   m4_default([$2], [$1])],
 477   [$3], [$4])
 478 ])
 479
 480
 481 # AT_CHECK_AU_MACRO(MACRO)
 482 # ------------------------
 483 # Create a minimalist configure.ac running the macro named
 484 # NAME-OF-THE-MACRO, autoupdate this script, check that autoconf runs
 485 # on that script, and that the shell runs correctly the configure.
 486 #
 487 # Updated configure.ac shall not depend upon obsolete macros, which votes
 488 # in favor of `-W obsolete', but since many of these macros leave a message
 489 # to be removed by the user once her code is adjusted, let's not check.
 490 #
 491 # Remove config.hin to avoid `autoheader: config.hin is unchanged'.
 492 m4_define([AT_CHECK_AU_MACRO],
 493 [AT_SETUP([$1])
 494 AT_KEYWORDS([autoupdate])
 495
 496 AT_CONFIGURE_AC([$1])
 497
 498 AT_CHECK_AUTOCONF
 499 AT_CHECK_AUTOHEADER
 500 AT_CHECK_CONFIGURE
 501 AT_CHECK_ENV
 502
 503 rm config.hin
 504 AT_CHECK_AUTOUPDATE([], 0, [], ignore)
 505 AT_CHECK([grep '^$1$' configure.ac], 1)
 506
 507 AT_CHECK_AUTOCONF
 508 AT_CHECK_AUTOHEADER
 509 AT_CHECK_CONFIGURE
 510 AT_CHECK_ENV
 511
 512 AT_CLEANUP[]dnl
 513 ])# AT_CHECK_AU_MACRO
 514
 515
 516
 517 ## ----------------------- ##
 518 ## Launch the test suite.  ##
 519 ## ----------------------- ##
 520
 521 AT_INIT