doc: man page grammar
[gnupg.git] / m4 / pkg.m4
1 # pkg.m4 - Macros to locate and utilise pkg-config.            -*- Autoconf -*-
2 # serial 1 (pkg-config-0.24)
3 #
4 # Copyright © 2004 Scott James Remnant <scott@netsplit.com>.
5 #
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 2 of the License, or
9 # (at your option) any later version.
10 #
11 # This program is distributed in the hope that it will be useful, but
12 # WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14 # General Public License for more details.
15 #
16 # You should have received a copy of the GNU General Public License
17 # along with this program; if not, write to the Free Software
18 # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
19 #
20 # As a special exception to the GNU General Public License, if you
21 # distribute this file as part of a program that contains a
22 # configuration script generated by Autoconf, you may include it under
23 # the same distribution terms that you use for the rest of that program.
24
25 # PKG_PROG_PKG_CONFIG([MIN-VERSION])
26 # ----------------------------------
27 AC_DEFUN([PKG_PROG_PKG_CONFIG],
28 [m4_pattern_forbid([^_?PKG_[A-Z_]+$])
29 m4_pattern_allow([^PKG_CONFIG(_(PATH|LIBDIR|SYSROOT_DIR|ALLOW_SYSTEM_(CFLAGS|LIBS)))?$])
30 m4_pattern_allow([^PKG_CONFIG_(DISABLE_UNINSTALLED|TOP_BUILD_DIR|DEBUG_SPEW)$])
31 AC_ARG_VAR([PKG_CONFIG], [path to pkg-config utility])
32 AC_ARG_VAR([PKG_CONFIG_PATH], [directories to add to pkg-config's search path])
33 AC_ARG_VAR([PKG_CONFIG_LIBDIR], [path overriding pkg-config's built-in search path])
34
35 if test "x$ac_cv_env_PKG_CONFIG_set" != "xset"; then
36         AC_PATH_TOOL([PKG_CONFIG], [pkg-config])
37 fi
38 if test -n "$PKG_CONFIG"; then
39         _pkg_min_version=m4_default([$1], [0.9.0])
40         AC_MSG_CHECKING([pkg-config is at least version $_pkg_min_version])
41         if $PKG_CONFIG --atleast-pkgconfig-version $_pkg_min_version; then
42                 AC_MSG_RESULT([yes])
43         else
44                 AC_MSG_RESULT([no])
45                 PKG_CONFIG=""
46         fi
47 fi[]dnl
48 ])# PKG_PROG_PKG_CONFIG
49
50 # PKG_CHECK_EXISTS(MODULES, [ACTION-IF-FOUND], [ACTION-IF-NOT-FOUND])
51 #
52 # Check to see whether a particular set of modules exists.  Similar
53 # to PKG_CHECK_MODULES(), but does not set variables or print errors.
54 #
55 # Please remember that m4 expands AC_REQUIRE([PKG_PROG_PKG_CONFIG])
56 # only at the first occurrence in configure.ac, so if the first place
57 # it's called might be skipped (such as if it is within an "if", you
58 # have to call PKG_CHECK_EXISTS manually
59 # --------------------------------------------------------------
60 AC_DEFUN([PKG_CHECK_EXISTS],
61 [AC_REQUIRE([PKG_PROG_PKG_CONFIG])dnl
62 if test -n "$PKG_CONFIG" && \
63     AC_RUN_LOG([$PKG_CONFIG --exists --print-errors "$1"]); then
64   m4_default([$2], [:])
65 m4_ifvaln([$3], [else
66   $3])dnl
67 fi])
68
69 # _PKG_CONFIG([VARIABLE], [COMMAND], [MODULES])
70 # ---------------------------------------------
71 m4_define([_PKG_CONFIG],
72 [if test -n "$$1"; then
73     pkg_cv_[]$1="$$1"
74  elif test -n "$PKG_CONFIG"; then
75     PKG_CHECK_EXISTS([$3],
76                      [pkg_cv_[]$1=`$PKG_CONFIG --[]$2 "$3" 2>/dev/null`
77                       test "x$?" != "x0" && pkg_failed=yes ],
78                      [pkg_failed=yes])
79  else
80     pkg_failed=untried
81 fi[]dnl
82 ])# _PKG_CONFIG
83
84 # _PKG_SHORT_ERRORS_SUPPORTED
85 # -----------------------------
86 AC_DEFUN([_PKG_SHORT_ERRORS_SUPPORTED],
87 [AC_REQUIRE([PKG_PROG_PKG_CONFIG])
88 if $PKG_CONFIG --atleast-pkgconfig-version 0.20; then
89         _pkg_short_errors_supported=yes
90 else
91         _pkg_short_errors_supported=no
92 fi[]dnl
93 ])# _PKG_SHORT_ERRORS_SUPPORTED
94
95
96 # PKG_CHECK_MODULES(VARIABLE-PREFIX, MODULES, [ACTION-IF-FOUND],
97 # [ACTION-IF-NOT-FOUND])
98 #
99 #
100 # Note that if there is a possibility the first call to
101 # PKG_CHECK_MODULES might not happen, you should be sure to include an
102 # explicit call to PKG_PROG_PKG_CONFIG in your configure.ac
103 #
104 #
105 # --------------------------------------------------------------
106 AC_DEFUN([PKG_CHECK_MODULES],
107 [AC_REQUIRE([PKG_PROG_PKG_CONFIG])dnl
108 AC_ARG_VAR([$1][_CFLAGS], [C compiler flags for $1, overriding pkg-config])dnl
109 AC_ARG_VAR([$1][_LIBS], [linker flags for $1, overriding pkg-config])dnl
110
111 pkg_failed=no
112 AC_MSG_CHECKING([for $1])
113
114 _PKG_CONFIG([$1][_CFLAGS], [cflags], [$2])
115 _PKG_CONFIG([$1][_LIBS], [libs], [$2])
116
117 m4_define([_PKG_TEXT], [Alternatively, you may set the environment variables $1[]_CFLAGS
118 and $1[]_LIBS to avoid the need to call pkg-config.
119 See the pkg-config man page for more details.])
120
121 if test $pkg_failed = yes; then
122         AC_MSG_RESULT([no])
123         _PKG_SHORT_ERRORS_SUPPORTED
124         if test $_pkg_short_errors_supported = yes; then
125                 $1[]_PKG_ERRORS=`$PKG_CONFIG --short-errors --print-errors --cflags --libs "$2" 2>&1`
126         else
127                 $1[]_PKG_ERRORS=`$PKG_CONFIG --print-errors --cflags --libs "$2" 2>&1`
128         fi
129         # Put the nasty error message in config.log where it belongs
130         echo "$$1[]_PKG_ERRORS" >&AS_MESSAGE_LOG_FD
131
132         m4_default([$4], [AC_MSG_ERROR(
133 [Package requirements ($2) were not met:
134
135 $$1_PKG_ERRORS
136
137 Consider adjusting the PKG_CONFIG_PATH environment variable if you
138 installed software in a non-standard prefix.
139
140 _PKG_TEXT])[]dnl
141         ])
142 elif test $pkg_failed = untried; then
143         AC_MSG_RESULT([no])
144         m4_default([$4], [AC_MSG_FAILURE(
145 [The pkg-config script could not be found or is too old.  Make sure it
146 is in your PATH or set the PKG_CONFIG environment variable to the full
147 path to pkg-config.
148
149 _PKG_TEXT
150
151 To get pkg-config, see <http://pkg-config.freedesktop.org/>.])[]dnl
152         ])
153 else
154         $1[]_CFLAGS=$pkg_cv_[]$1[]_CFLAGS
155         $1[]_LIBS=$pkg_cv_[]$1[]_LIBS
156         AC_MSG_RESULT([yes])
157         $3
158 fi[]dnl
159 ])# PKG_CHECK_MODULES
160
161
162 # PKG_INSTALLDIR(DIRECTORY)
163 # -------------------------
164 # Substitutes the variable pkgconfigdir as the location where a module
165 # should install pkg-config .pc files. By default the directory is
166 # $libdir/pkgconfig, but the default can be changed by passing
167 # DIRECTORY. The user can override through the --with-pkgconfigdir
168 # parameter.
169 AC_DEFUN([PKG_INSTALLDIR],
170 [m4_pushdef([pkg_default], [m4_default([$1], ['${libdir}/pkgconfig'])])
171 m4_pushdef([pkg_description],
172     [pkg-config installation directory @<:@]pkg_default[@:>@])
173 AC_ARG_WITH([pkgconfigdir],
174     [AS_HELP_STRING([--with-pkgconfigdir], pkg_description)],,
175     [with_pkgconfigdir=]pkg_default)
176 AC_SUBST([pkgconfigdir], [$with_pkgconfigdir])
177 m4_popdef([pkg_default])
178 m4_popdef([pkg_description])
179 ]) dnl PKG_INSTALLDIR
180
181
182 # PKG_NOARCH_INSTALLDIR(DIRECTORY)
183 # -------------------------
184 # Substitutes the variable noarch_pkgconfigdir as the location where a
185 # module should install arch-independent pkg-config .pc files. By
186 # default the directory is $datadir/pkgconfig, but the default can be
187 # changed by passing DIRECTORY. The user can override through the
188 # --with-noarch-pkgconfigdir parameter.
189 AC_DEFUN([PKG_NOARCH_INSTALLDIR],
190 [m4_pushdef([pkg_default], [m4_default([$1], ['${datadir}/pkgconfig'])])
191 m4_pushdef([pkg_description],
192     [pkg-config arch-independent installation directory @<:@]pkg_default[@:>@])
193 AC_ARG_WITH([noarch-pkgconfigdir],
194     [AS_HELP_STRING([--with-noarch-pkgconfigdir], pkg_description)],,
195     [with_noarch_pkgconfigdir=]pkg_default)
196 AC_SUBST([noarch_pkgconfigdir], [$with_noarch_pkgconfigdir])
197 m4_popdef([pkg_default])
198 m4_popdef([pkg_description])
199 ]) dnl PKG_NOARCH_INSTALLDIR
200
201
202 # PKG_CHECK_VAR(VARIABLE, MODULE, CONFIG-VARIABLE,
203 # [ACTION-IF-FOUND], [ACTION-IF-NOT-FOUND])
204 # -------------------------------------------
205 # Retrieves the value of the pkg-config variable for the given module.
206 AC_DEFUN([PKG_CHECK_VAR],
207 [AC_REQUIRE([PKG_PROG_PKG_CONFIG])dnl
208 AC_ARG_VAR([$1], [value of $3 for $2, overriding pkg-config])dnl
209
210 _PKG_CONFIG([$1], [variable="][$3]["], [$2])
211 AS_VAR_COPY([$1], [pkg_cv_][$1])
212
213 AS_VAR_IF([$1], [""], [$5], [$4])dnl
214 ])# PKG_CHECK_VAR