Update ELisp manual to match 'string-collate-equalp' doc string
[emacs.git] / m4 / gnulib-common.m4
blobf8454c8a0149ddcf1b74c5d8877bfb6c32aadf46
1 # gnulib-common.m4 serial 36
2 dnl Copyright (C) 2007-2016 Free Software Foundation, Inc.
3 dnl This file is free software; the Free Software Foundation
4 dnl gives unlimited permission to copy and/or distribute it,
5 dnl with or without modifications, as long as this notice is preserved.
7 # gl_COMMON
8 # is expanded unconditionally through gnulib-tool magic.
9 AC_DEFUN([gl_COMMON], [
10   dnl Use AC_REQUIRE here, so that the code is expanded once only.
11   AC_REQUIRE([gl_00GNULIB])
12   AC_REQUIRE([gl_COMMON_BODY])
14 AC_DEFUN([gl_COMMON_BODY], [
15   AH_VERBATIM([_Noreturn],
16 [/* The _Noreturn keyword of C11.  */
17 #if ! (defined _Noreturn \
18        || (defined __STDC_VERSION__ && 201112 <= __STDC_VERSION__))
19 # if (3 <= __GNUC__ || (__GNUC__ == 2 && 8 <= __GNUC_MINOR__) \
20       || 0x5110 <= __SUNPRO_C)
21 #  define _Noreturn __attribute__ ((__noreturn__))
22 # elif defined _MSC_VER && 1200 <= _MSC_VER
23 #  define _Noreturn __declspec (noreturn)
24 # else
25 #  define _Noreturn
26 # endif
27 #endif
29   AH_VERBATIM([isoc99_inline],
30 [/* Work around a bug in Apple GCC 4.0.1 build 5465: In C99 mode, it supports
31    the ISO C 99 semantics of 'extern inline' (unlike the GNU C semantics of
32    earlier versions), but does not display it by setting __GNUC_STDC_INLINE__.
33    __APPLE__ && __MACH__ test for Mac OS X.
34    __APPLE_CC__ tests for the Apple compiler and its version.
35    __STDC_VERSION__ tests for the C99 mode.  */
36 #if defined __APPLE__ && defined __MACH__ && __APPLE_CC__ >= 5465 && !defined __cplusplus && __STDC_VERSION__ >= 199901L && !defined __GNUC_STDC_INLINE__
37 # define __GNUC_STDC_INLINE__ 1
38 #endif])
39   AH_VERBATIM([unused_parameter],
40 [/* Define as a marker that can be attached to declarations that might not
41     be used.  This helps to reduce warnings, such as from
42     GCC -Wunused-parameter.  */
43 #if __GNUC__ >= 3 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 7)
44 # define _GL_UNUSED __attribute__ ((__unused__))
45 #else
46 # define _GL_UNUSED
47 #endif
48 /* The name _UNUSED_PARAMETER_ is an earlier spelling, although the name
49    is a misnomer outside of parameter lists.  */
50 #define _UNUSED_PARAMETER_ _GL_UNUSED
52 /* gcc supports the "unused" attribute on possibly unused labels, and
53    g++ has since version 4.5.  Note to support C++ as well as C,
54    _GL_UNUSED_LABEL should be used with a trailing ;  */
55 #if !defined __cplusplus || __GNUC__ > 4 \
56     || (__GNUC__ == 4 && __GNUC_MINOR__ >= 5)
57 # define _GL_UNUSED_LABEL _GL_UNUSED
58 #else
59 # define _GL_UNUSED_LABEL
60 #endif
62 /* The __pure__ attribute was added in gcc 2.96.  */
63 #if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 96)
64 # define _GL_ATTRIBUTE_PURE __attribute__ ((__pure__))
65 #else
66 # define _GL_ATTRIBUTE_PURE /* empty */
67 #endif
69 /* The __const__ attribute was added in gcc 2.95.  */
70 #if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 95)
71 # define _GL_ATTRIBUTE_CONST __attribute__ ((__const__))
72 #else
73 # define _GL_ATTRIBUTE_CONST /* empty */
74 #endif
76   dnl Preparation for running test programs:
77   dnl Tell glibc to write diagnostics from -D_FORTIFY_SOURCE=2 to stderr, not
78   dnl to /dev/tty, so they can be redirected to log files.  Such diagnostics
79   dnl arise e.g., in the macros gl_PRINTF_DIRECTIVE_N, gl_SNPRINTF_DIRECTIVE_N.
80   LIBC_FATAL_STDERR_=1
81   export LIBC_FATAL_STDERR_
84 # gl_MODULE_INDICATOR_CONDITION
85 # expands to a C preprocessor expression that evaluates to 1 or 0, depending
86 # whether a gnulib module that has been requested shall be considered present
87 # or not.
88 m4_define([gl_MODULE_INDICATOR_CONDITION], [1])
90 # gl_MODULE_INDICATOR_SET_VARIABLE([modulename])
91 # sets the shell variable that indicates the presence of the given module to
92 # a C preprocessor expression that will evaluate to 1.
93 AC_DEFUN([gl_MODULE_INDICATOR_SET_VARIABLE],
95   gl_MODULE_INDICATOR_SET_VARIABLE_AUX(
96     [GNULIB_[]m4_translit([[$1]],
97                           [abcdefghijklmnopqrstuvwxyz./-],
98                           [ABCDEFGHIJKLMNOPQRSTUVWXYZ___])],
99     [gl_MODULE_INDICATOR_CONDITION])
102 # gl_MODULE_INDICATOR_SET_VARIABLE_AUX([variable])
103 # modifies the shell variable to include the gl_MODULE_INDICATOR_CONDITION.
104 # The shell variable's value is a C preprocessor expression that evaluates
105 # to 0 or 1.
106 AC_DEFUN([gl_MODULE_INDICATOR_SET_VARIABLE_AUX],
108   m4_if(m4_defn([gl_MODULE_INDICATOR_CONDITION]), [1],
109     [
110      dnl Simplify the expression VALUE || 1 to 1.
111      $1=1
112     ],
113     [gl_MODULE_INDICATOR_SET_VARIABLE_AUX_OR([$1],
114                                              [gl_MODULE_INDICATOR_CONDITION])])
117 # gl_MODULE_INDICATOR_SET_VARIABLE_AUX_OR([variable], [condition])
118 # modifies the shell variable to include the given condition.  The shell
119 # variable's value is a C preprocessor expression that evaluates to 0 or 1.
120 AC_DEFUN([gl_MODULE_INDICATOR_SET_VARIABLE_AUX_OR],
122   dnl Simplify the expression 1 || CONDITION to 1.
123   if test "$[]$1" != 1; then
124     dnl Simplify the expression 0 || CONDITION to CONDITION.
125     if test "$[]$1" = 0; then
126       $1=$2
127     else
128       $1="($[]$1 || $2)"
129     fi
130   fi
133 # gl_MODULE_INDICATOR([modulename])
134 # defines a C macro indicating the presence of the given module
135 # in a location where it can be used.
136 #                                             |  Value  |   Value   |
137 #                                             | in lib/ | in tests/ |
138 # --------------------------------------------+---------+-----------+
139 # Module present among main modules:          |    1    |     1     |
140 # --------------------------------------------+---------+-----------+
141 # Module present among tests-related modules: |    0    |     1     |
142 # --------------------------------------------+---------+-----------+
143 # Module not present at all:                  |    0    |     0     |
144 # --------------------------------------------+---------+-----------+
145 AC_DEFUN([gl_MODULE_INDICATOR],
147   AC_DEFINE_UNQUOTED([GNULIB_]m4_translit([[$1]],
148       [abcdefghijklmnopqrstuvwxyz./-],
149       [ABCDEFGHIJKLMNOPQRSTUVWXYZ___]),
150     [gl_MODULE_INDICATOR_CONDITION],
151     [Define to a C preprocessor expression that evaluates to 1 or 0,
152      depending whether the gnulib module $1 shall be considered present.])
155 # gl_MODULE_INDICATOR_FOR_TESTS([modulename])
156 # defines a C macro indicating the presence of the given module
157 # in lib or tests. This is useful to determine whether the module
158 # should be tested.
159 #                                             |  Value  |   Value   |
160 #                                             | in lib/ | in tests/ |
161 # --------------------------------------------+---------+-----------+
162 # Module present among main modules:          |    1    |     1     |
163 # --------------------------------------------+---------+-----------+
164 # Module present among tests-related modules: |    1    |     1     |
165 # --------------------------------------------+---------+-----------+
166 # Module not present at all:                  |    0    |     0     |
167 # --------------------------------------------+---------+-----------+
168 AC_DEFUN([gl_MODULE_INDICATOR_FOR_TESTS],
170   AC_DEFINE([GNULIB_TEST_]m4_translit([[$1]],
171       [abcdefghijklmnopqrstuvwxyz./-],
172       [ABCDEFGHIJKLMNOPQRSTUVWXYZ___]), [1],
173     [Define to 1 when the gnulib module $1 should be tested.])
176 # gl_ASSERT_NO_GNULIB_POSIXCHECK
177 # asserts that there will never be a need to #define GNULIB_POSIXCHECK.
178 # and thereby enables an optimization of configure and config.h.
179 # Used by Emacs.
180 AC_DEFUN([gl_ASSERT_NO_GNULIB_POSIXCHECK],
182   dnl Override gl_WARN_ON_USE_PREPARE.
183   dnl But hide this definition from 'aclocal'.
184   AC_DEFUN([gl_W][ARN_ON_USE_PREPARE], [])
187 # gl_ASSERT_NO_GNULIB_TESTS
188 # asserts that there will be no gnulib tests in the scope of the configure.ac
189 # and thereby enables an optimization of config.h.
190 # Used by Emacs.
191 AC_DEFUN([gl_ASSERT_NO_GNULIB_TESTS],
193   dnl Override gl_MODULE_INDICATOR_FOR_TESTS.
194   AC_DEFUN([gl_MODULE_INDICATOR_FOR_TESTS], [])
197 # Test whether <features.h> exists.
198 # Set HAVE_FEATURES_H.
199 AC_DEFUN([gl_FEATURES_H],
201   AC_CHECK_HEADERS_ONCE([features.h])
202   if test $ac_cv_header_features_h = yes; then
203     HAVE_FEATURES_H=1
204   else
205     HAVE_FEATURES_H=0
206   fi
207   AC_SUBST([HAVE_FEATURES_H])
210 # m4_foreach_w
211 # is a backport of autoconf-2.59c's m4_foreach_w.
212 # Remove this macro when we can assume autoconf >= 2.60.
213 m4_ifndef([m4_foreach_w],
214   [m4_define([m4_foreach_w],
215     [m4_foreach([$1], m4_split(m4_normalize([$2]), [ ]), [$3])])])
217 # AS_VAR_IF(VAR, VALUE, [IF-MATCH], [IF-NOT-MATCH])
218 # ----------------------------------------------------
219 # Backport of autoconf-2.63b's macro.
220 # Remove this macro when we can assume autoconf >= 2.64.
221 m4_ifndef([AS_VAR_IF],
222 [m4_define([AS_VAR_IF],
223 [AS_IF([test x"AS_VAR_GET([$1])" = x""$2], [$3], [$4])])])
225 # gl_PROG_CC_C99
226 # Modifies the value of the shell variable CC in an attempt to make $CC
227 # understand ISO C99 source code.
228 # This is like AC_PROG_CC_C99, except that
229 # - AC_PROG_CC_C99 did not exist in Autoconf versions < 2.60,
230 # - AC_PROG_CC_C99 does not mix well with AC_PROG_CC_STDC
231 #   <http://lists.gnu.org/archive/html/bug-gnulib/2011-09/msg00367.html>,
232 #   but many more packages use AC_PROG_CC_STDC than AC_PROG_CC_C99
233 #   <http://lists.gnu.org/archive/html/bug-gnulib/2011-09/msg00441.html>.
234 # Remaining problems:
235 # - When AC_PROG_CC_STDC is invoked twice, it adds the C99 enabling options
236 #   to CC twice
237 #   <http://lists.gnu.org/archive/html/bug-gnulib/2011-09/msg00431.html>.
238 # - AC_PROG_CC_STDC is likely to change now that C11 is an ISO standard.
239 AC_DEFUN([gl_PROG_CC_C99],
241   dnl Change that version number to the minimum Autoconf version that supports
242   dnl mixing AC_PROG_CC_C99 calls with AC_PROG_CC_STDC calls.
243   m4_version_prereq([9.0],
244     [AC_REQUIRE([AC_PROG_CC_C99])],
245     [AC_REQUIRE([AC_PROG_CC_STDC])])
248 # gl_PROG_AR_RANLIB
249 # Determines the values for AR, ARFLAGS, RANLIB that fit with the compiler.
250 # The user can set the variables AR, ARFLAGS, RANLIB if he wants to override
251 # the values.
252 AC_DEFUN([gl_PROG_AR_RANLIB],
254   dnl Minix 3 comes with two toolchains: The Amsterdam Compiler Kit compiler
255   dnl as "cc", and GCC as "gcc". They have different object file formats and
256   dnl library formats. In particular, the GNU binutils programs ar and ranlib
257   dnl produce libraries that work only with gcc, not with cc.
258   AC_REQUIRE([AC_PROG_CC])
259   AC_BEFORE([$0], [AM_PROG_AR])
260   AC_CACHE_CHECK([for Minix Amsterdam compiler], [gl_cv_c_amsterdam_compiler],
261     [
262       AC_EGREP_CPP([Amsterdam],
263         [
264 #ifdef __ACK__
265 Amsterdam
266 #endif
267         ],
268         [gl_cv_c_amsterdam_compiler=yes],
269         [gl_cv_c_amsterdam_compiler=no])
270     ])
272   dnl Don't compete with AM_PROG_AR's decision about AR/ARFLAGS if we are not
273   dnl building with __ACK__.
274   if test $gl_cv_c_amsterdam_compiler = yes; then
275     if test -z "$AR"; then
276       AR='cc -c.a'
277     fi
278     if test -z "$ARFLAGS"; then
279       ARFLAGS='-o'
280     fi
281   else
282     dnl AM_PROG_AR was added in automake v1.11.2.  AM_PROG_AR does not AC_SUBST
283     dnl ARFLAGS variable (it is filed into Makefile.in directly by automake
284     dnl script on-demand, if not specified by ./configure of course).
285     dnl Don't AC_REQUIRE the AM_PROG_AR otherwise the code for __ACK__ above
286     dnl will be ignored.  Also, pay attention to call AM_PROG_AR in else block
287     dnl because AM_PROG_AR is written so it could re-set AR variable even for
288     dnl __ACK__.  It may seem like its easier to avoid calling the macro here,
289     dnl but we need to AC_SUBST both AR/ARFLAGS (thus those must have some good
290     dnl default value and automake should usually know them).
291     m4_ifdef([AM_PROG_AR], [AM_PROG_AR], [:])
292   fi
294   dnl In case the code above has not helped with setting AR/ARFLAGS, use
295   dnl Automake-documented default values for AR and ARFLAGS, but prefer
296   dnl ${host}-ar over ar (useful for cross-compiling).
297   AC_CHECK_TOOL([AR], [ar], [ar])
298   if test -z "$ARFLAGS"; then
299     ARFLAGS='cr'
300   fi
302   AC_SUBST([AR])
303   AC_SUBST([ARFLAGS])
304   if test -z "$RANLIB"; then
305     if test $gl_cv_c_amsterdam_compiler = yes; then
306       RANLIB=':'
307     else
308       dnl Use the ranlib program if it is available.
309       AC_PROG_RANLIB
310     fi
311   fi
312   AC_SUBST([RANLIB])
315 # AC_PROG_MKDIR_P
316 # is a backport of autoconf-2.60's AC_PROG_MKDIR_P, with a fix
317 # for interoperability with automake-1.9.6 from autoconf-2.62.
318 # Remove this macro when we can assume autoconf >= 2.62 or
319 # autoconf >= 2.60 && automake >= 1.10.
320 # AC_AUTOCONF_VERSION was introduced in 2.62, so use that as the witness.
321 m4_ifndef([AC_AUTOCONF_VERSION],[
322 m4_ifdef([AC_PROG_MKDIR_P], [
323   dnl For automake-1.9.6 && autoconf < 2.62: Ensure MKDIR_P is AC_SUBSTed.
324   m4_define([AC_PROG_MKDIR_P],
325     m4_defn([AC_PROG_MKDIR_P])[
326     AC_SUBST([MKDIR_P])])], [
327   dnl For autoconf < 2.60: Backport of AC_PROG_MKDIR_P.
328   AC_DEFUN_ONCE([AC_PROG_MKDIR_P],
329     [AC_REQUIRE([AM_PROG_MKDIR_P])dnl defined by automake
330      MKDIR_P='$(mkdir_p)'
331      AC_SUBST([MKDIR_P])])])
334 # AC_C_RESTRICT
335 # This definition is copied from post-2.69 Autoconf and overrides the
336 # AC_C_RESTRICT macro from autoconf 2.60..2.69.  It can be removed
337 # once autoconf >= 2.70 can be assumed.  It's painful to check version
338 # numbers, and in practice this macro is more up-to-date than Autoconf
339 # is, so override Autoconf unconditionally.
340 AC_DEFUN([AC_C_RESTRICT],
341 [AC_CACHE_CHECK([for C/C++ restrict keyword], [ac_cv_c_restrict],
342   [ac_cv_c_restrict=no
343    # The order here caters to the fact that C++ does not require restrict.
344    for ac_kw in __restrict __restrict__ _Restrict restrict; do
345      AC_COMPILE_IFELSE(
346       [AC_LANG_PROGRAM(
347          [[typedef int *int_ptr;
348            int foo (int_ptr $ac_kw ip) { return ip[0]; }
349            int bar (int [$ac_kw]); /* Catch GCC bug 14050.  */
350            int bar (int ip[$ac_kw]) { return ip[0]; }
351          ]],
352          [[int s[1];
353            int *$ac_kw t = s;
354            t[0] = 0;
355            return foo (t) + bar (t);
356          ]])],
357       [ac_cv_c_restrict=$ac_kw])
358      test "$ac_cv_c_restrict" != no && break
359    done
360   ])
361  AH_VERBATIM([restrict],
362 [/* Define to the equivalent of the C99 'restrict' keyword, or to
363    nothing if this is not supported.  Do not define if restrict is
364    supported directly.  */
365 #undef restrict
366 /* Work around a bug in Sun C++: it does not support _Restrict or
367    __restrict__, even though the corresponding Sun C compiler ends up with
368    "#define restrict _Restrict" or "#define restrict __restrict__" in the
369    previous line.  Perhaps some future version of Sun C++ will work with
370    restrict; if so, hopefully it defines __RESTRICT like Sun C does.  */
371 #if defined __SUNPRO_CC && !defined __RESTRICT
372 # define _Restrict
373 # define __restrict__
374 #endif])
375  case $ac_cv_c_restrict in
376    restrict) ;;
377    no) AC_DEFINE([restrict], []) ;;
378    *)  AC_DEFINE_UNQUOTED([restrict], [$ac_cv_c_restrict]) ;;
379  esac
380 ])# AC_C_RESTRICT
382 # gl_BIGENDIAN
383 # is like AC_C_BIGENDIAN, except that it can be AC_REQUIREd.
384 # Note that AC_REQUIRE([AC_C_BIGENDIAN]) does not work reliably because some
385 # macros invoke AC_C_BIGENDIAN with arguments.
386 AC_DEFUN([gl_BIGENDIAN],
388   AC_C_BIGENDIAN
391 # gl_CACHE_VAL_SILENT(cache-id, command-to-set-it)
392 # is like AC_CACHE_VAL(cache-id, command-to-set-it), except that it does not
393 # output a spurious "(cached)" mark in the midst of other configure output.
394 # This macro should be used instead of AC_CACHE_VAL when it is not surrounded
395 # by an AC_MSG_CHECKING/AC_MSG_RESULT pair.
396 AC_DEFUN([gl_CACHE_VAL_SILENT],
398   saved_as_echo_n="$as_echo_n"
399   as_echo_n=':'
400   AC_CACHE_VAL([$1], [$2])
401   as_echo_n="$saved_as_echo_n"
404 # AS_VAR_COPY was added in autoconf 2.63b
405 m4_define_default([AS_VAR_COPY],
406 [AS_LITERAL_IF([$1[]$2], [$1=$$2], [eval $1=\$$2])])
408 # AC_PROG_SED was added in autoconf 2.59b
409 m4_ifndef([AC_PROG_SED],
410 [AC_DEFUN([AC_PROG_SED],
411 [AC_CACHE_CHECK([for a sed that does not truncate output], ac_cv_path_SED,
412     [dnl ac_script should not contain more than 99 commands (for HP-UX sed),
413      dnl but more than about 7000 bytes, to catch a limit in Solaris 8 /usr/ucb/sed.
414      ac_script=s/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb/
415      for ac_i in 1 2 3 4 5 6 7; do
416        ac_script="$ac_script$as_nl$ac_script"
417      done
418      echo "$ac_script" 2>/dev/null | sed 99q >conftest.sed
419      AS_UNSET([ac_script])
420      if test -z "$SED"; then
421        ac_path_SED_found=false
422        _AS_PATH_WALK([], [
423          for ac_prog in sed gsed; do
424            for ac_exec_ext in '' $ac_executable_extensions; do
425              ac_path_SED="$as_dir/$ac_prog$ac_exec_ext"
426              AS_EXECUTABLE_P(["$ac_path_SED"]) || continue
427              case `"$ac_path_SED" --version 2>&1` in
428                *GNU*) ac_cv_path_SED=$ac_path_SED ac_path_SED_found=:;;
429                *)
430                  ac_count=0
431                  _AS_ECHO_N([0123456789]) >conftest.in
432                  while :
433                  do
434                    cat conftest.in conftest.in >conftest.tmp
435                    mv conftest.tmp conftest.in
436                    cp conftest.in conftest.nl
437                    echo >> conftest.nl
438                    "$ac_path_SED" -f conftest.sed <conftest.nl >conftest.out 2>/dev/null || break
439                    diff conftest.out conftest.nl >/dev/null 2>&1 || break
440                    ac_count=`expr $ac_count + 1`
441                    if test $ac_count -gt ${ac_path_SED_max-0}; then
442                      # Best so far, but keep looking for better
443                      ac_cv_path_SED=$ac_path_SED
444                      ac_path_SED_max=$ac_count
445                    fi
446                    test $ac_count -gt 10 && break
447                  done
448                  rm -f conftest.in conftest.tmp conftest.nl conftest.out;;
449              esac
450              $ac_path_SED_found && break 3
451            done
452          done])
453        if test -z "$ac_cv_path_SED"; then
454          AC_ERROR([no acceptable sed could be found in \$PATH])
455        fi
456      else
457        ac_cv_path_SED=$SED
458      fi
459  SED="$ac_cv_path_SED"
460  AC_SUBST([SED])dnl
461  rm -f conftest.sed
462 ])])])