/[gentoo-x86]/eclass/autotools.eclass
Gentoo

Contents of /eclass/autotools.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.137 - (show annotations) (download)
Sun May 20 12:58:23 2012 UTC (2 years, 3 months ago) by vapier
Branch: MAIN
Changes since 1.136: +41 -15 lines
optimize autotools_check_macro to cache the result of the autoconf trace as we can end up calling this code multiple times when doing `eautoreconf`

1 # Copyright 1999-2012 Gentoo Foundation
2 # Distributed under the terms of the GNU General Public License v2
3 # $Header: /var/cvsroot/gentoo-x86/eclass/autotools.eclass,v 1.133 2012/05/20 10:39:45 vapier Exp $
4
5 # @ECLASS: autotools.eclass
6 # @MAINTAINER:
7 # base-system@gentoo.org
8 # @BLURB: Regenerates auto* build scripts
9 # @DESCRIPTION:
10 # This eclass is for safely handling autotooled software packages that need to
11 # regenerate their build scripts. All functions will abort in case of errors.
12
13 # Note: We require GNU m4, as does autoconf. So feel free to use any features
14 # from the GNU version of m4 without worrying about other variants (i.e. BSD).
15
16 if [[ ${___ECLASS_ONCE_AUTOTOOLS} != "recur -_+^+_- spank" ]] ; then
17 ___ECLASS_ONCE_AUTOTOOLS="recur -_+^+_- spank"
18
19 inherit libtool
20
21 # @ECLASS-VARIABLE: WANT_AUTOCONF
22 # @DESCRIPTION:
23 # The major version of autoconf your package needs
24 : ${WANT_AUTOCONF:=latest}
25
26 # @ECLASS-VARIABLE: WANT_AUTOMAKE
27 # @DESCRIPTION:
28 # The major version of automake your package needs
29 : ${WANT_AUTOMAKE:=latest}
30
31 # @ECLASS-VARIABLE: WANT_LIBTOOL
32 # @DESCRIPTION:
33 # Do you want libtool? Valid values here are "latest" and "none".
34 : ${WANT_LIBTOOL:=latest}
35
36 # @ECLASS-VARIABLE: _LATEST_AUTOMAKE
37 # @INTERNAL
38 # @DESCRIPTION:
39 # CONSTANT!
40 # The latest major version/slot of automake available on each arch. #312315
41 # If a newer slot is stable on any arch, and is NOT reflected in this list,
42 # then circular dependencies may arise during emerge @system bootstraps.
43 # Do NOT change this variable in your ebuilds!
44 # If you want to force a newer minor version, you can specify the correct
45 # WANT value by using a colon: <PV>[:<WANT_AUTOMAKE>]
46 _LATEST_AUTOMAKE=( 1.11.1:1.11 )
47
48 _automake_atom="sys-devel/automake"
49 _autoconf_atom="sys-devel/autoconf"
50 if [[ -n ${WANT_AUTOMAKE} ]]; then
51 case ${WANT_AUTOMAKE} in
52 # Even if the package doesn't use automake, we still need to depend
53 # on it because we run aclocal to process m4 macros. This matches
54 # the autoreconf tool, so this requirement is correct. #401605
55 none) ;;
56 latest)
57 # Use SLOT deps if we can. For EAPI=0, we get pretty close.
58 if [[ ${EAPI:-0} != 0 ]] ; then
59 _automake_atom="|| ( `printf '>=sys-devel/automake-%s:%s ' ${_LATEST_AUTOMAKE[@]/:/ }` )"
60 else
61 _automake_atom="|| ( `printf '>=sys-devel/automake-%s ' ${_LATEST_AUTOMAKE[@]/%:*}` )"
62 fi
63 ;;
64 *) _automake_atom="=sys-devel/automake-${WANT_AUTOMAKE}*" ;;
65 esac
66 export WANT_AUTOMAKE
67 fi
68
69 if [[ -n ${WANT_AUTOCONF} ]] ; then
70 case ${WANT_AUTOCONF} in
71 none) _autoconf_atom="" ;; # some packages don't require autoconf at all
72 2.1) _autoconf_atom="=sys-devel/autoconf-${WANT_AUTOCONF}*" ;;
73 # if you change the "latest" version here, change also autotools_env_setup
74 latest|2.5) _autoconf_atom=">=sys-devel/autoconf-2.68" ;;
75 *) die "Invalid WANT_AUTOCONF value '${WANT_AUTOCONF}'" ;;
76 esac
77 export WANT_AUTOCONF
78 fi
79
80 _libtool_atom="sys-devel/libtool"
81 if [[ -n ${WANT_LIBTOOL} ]] ; then
82 case ${WANT_LIBTOOL} in
83 none) _libtool_atom="" ;;
84 latest) ;;
85 *) die "Invalid WANT_LIBTOOL value '${WANT_LIBTOOL}'" ;;
86 esac
87 export WANT_LIBTOOL
88 fi
89
90 AUTOTOOLS_DEPEND="${_automake_atom} ${_autoconf_atom} ${_libtool_atom}"
91 RDEPEND=""
92
93 # @ECLASS-VARIABLE: AUTOTOOLS_AUTO_DEPEND
94 # @DESCRIPTION:
95 # Set to 'no' to disable automatically adding to DEPEND. This lets
96 # ebuilds former conditional depends by using ${AUTOTOOLS_DEPEND} in
97 # their own DEPEND string.
98 : ${AUTOTOOLS_AUTO_DEPEND:=yes}
99 if [[ ${AUTOTOOLS_AUTO_DEPEND} != "no" ]] ; then
100 DEPEND=${AUTOTOOLS_DEPEND}
101 fi
102
103 unset _automake_atom _autoconf_atom
104
105 # @ECLASS-VARIABLE: AM_OPTS
106 # @DEFAULT_UNSET
107 # @DESCRIPTION:
108 # Additional options to pass to automake during
109 # eautoreconf call.
110
111 # @ECLASS-VARIABLE: AT_NOEAUTOMAKE
112 # @DEFAULT_UNSET
113 # @DESCRIPTION:
114 # Don't run eautomake command if set to 'yes'; only used to workaround
115 # broken packages. Generally you should, instead, fix the package to
116 # not call AM_INIT_AUTOMAKE if it doesn't actually use automake.
117
118 # @ECLASS-VARIABLE: AT_NOELIBTOOLIZE
119 # @DEFAULT_UNSET
120 # @DESCRIPTION:
121 # Don't run elibtoolize command if set to 'yes',
122 # useful when elibtoolize needs to be ran with
123 # particular options
124
125 # @ECLASS-VARIABLE: AT_M4DIR
126 # @DESCRIPTION:
127 # Additional director(y|ies) aclocal should search
128 : ${AT_M4DIR:=}
129
130 # @ECLASS-VARIABLE: AT_SYS_M4DIR
131 # @INTERNAL
132 # @DESCRIPTION:
133 # For system integrators, a list of additional aclocal search paths.
134 # This variable gets eval-ed, so you can use variables in the definition
135 # that may not be valid until eautoreconf & friends are run.
136 : ${AT_SYS_M4DIR:=}
137
138 # @FUNCTION: eautoreconf
139 # @DESCRIPTION:
140 # This function mimes the behavior of autoreconf, but uses the different
141 # eauto* functions to run the tools. It doesn't accept parameters, but
142 # the directory with include files can be specified with AT_M4DIR variable.
143 #
144 # Should do a full autoreconf - normally what most people will be interested in.
145 # Also should handle additional directories specified by AC_CONFIG_SUBDIRS.
146 eautoreconf() {
147 local x g
148
149 if [[ -z ${AT_NO_RECURSIVE} ]]; then
150 # Take care of subdirs
151 for x in $(autotools_check_macro_val AC_CONFIG_SUBDIRS) ; do
152 if [[ -d ${x} ]] ; then
153 pushd "${x}" >/dev/null
154 AT_NOELIBTOOLIZE="yes" eautoreconf
155 popd >/dev/null
156 fi
157 done
158 fi
159
160 einfo "Running eautoreconf in '${PWD}' ..."
161
162 local m4dirs=$(autotools_check_macro_val AC_CONFIG_{AUX,MACRO}_DIR)
163 [[ -n ${m4dirs} ]] && mkdir -p ${m4dirs}
164
165 eaclocal
166 if grep -q '^AM_GNU_GETTEXT_VERSION' configure.?? ; then
167 eautopoint --force
168 fi
169 _elibtoolize --install --copy --force
170 eautoconf
171 eautoheader
172 [[ ${AT_NOEAUTOMAKE} != "yes" ]] && FROM_EAUTORECONF="yes" eautomake ${AM_OPTS}
173
174 [[ ${AT_NOELIBTOOLIZE} == "yes" ]] && return 0
175
176 # Call it here to prevent failures due to elibtoolize called _before_
177 # eautoreconf. We set $S because elibtoolize runs on that #265319
178 S=${PWD} elibtoolize --force
179
180 return 0
181 }
182
183 # @FUNCTION: eaclocal_amflags
184 # @DESCRIPTION:
185 # Extract the ACLOCAL_AMFLAGS value from the Makefile.am and try to handle
186 # (most) of the crazy crap that people throw at us.
187 eaclocal_amflags() {
188 local aclocal_opts amflags_file
189
190 for amflags_file in GNUmakefile.am Makefile.am GNUmakefile.in Makefile.in ; do
191 [[ -e ${amflags_file} ]] || continue
192 # setup the env in case the pkg does something crazy
193 # in their ACLOCAL_AMFLAGS. like run a shell script
194 # which turns around and runs autotools. #365401
195 # or split across multiple lines. #383525
196 autotools_env_setup
197 aclocal_opts=$(sed -n \
198 "/^ACLOCAL_AMFLAGS[[:space:]]*=/{ \
199 # match the first line
200 s:[^=]*=::p; \
201 # then gobble up all escaped lines
202 : nextline /\\\\$/{ n; p; b nextline; } \
203 }" ${amflags_file})
204 eval aclocal_opts=\""${aclocal_opts}"\"
205 break
206 done
207
208 echo ${aclocal_opts}
209 }
210
211 # @FUNCTION: eaclocal
212 # @DESCRIPTION:
213 # These functions runs the autotools using autotools_run_tool with the
214 # specified parametes. The name of the tool run is the same of the function
215 # without e prefix.
216 # They also force installing the support files for safety.
217 # Respects AT_M4DIR for additional directories to search for macro's.
218 eaclocal() {
219 [[ ! -f aclocal.m4 || -n $(grep -e 'generated.*by aclocal' aclocal.m4) ]] && \
220 autotools_run_tool --at-m4flags aclocal "$@" $(eaclocal_amflags)
221 }
222
223 # @FUNCTION: _elibtoolize
224 # @DESCRIPTION:
225 # Runs libtoolize. If --install is the first arg, automatically drop it if
226 # the active libtool version doesn't support it.
227 #
228 # Note the '_' prefix .. to not collide with elibtoolize() from libtool.eclass.
229 _elibtoolize() {
230 # Check if we should run libtoolize (AM_PROG_LIBTOOL is an older macro,
231 # check for both it and the current AC_PROG_LIBTOOL)
232 [[ -n $(autotools_check_macro AC_PROG_LIBTOOL AM_PROG_LIBTOOL LT_INIT) ]] || return 0
233
234 local LIBTOOLIZE=${LIBTOOLIZE:-libtoolize}
235 type -P glibtoolize && LIBTOOLIZE=glibtoolize
236
237 [[ -f GNUmakefile.am || -f Makefile.am ]] && set -- "$@" --automake
238 if [[ $1 == "--install" ]] ; then
239 ${LIBTOOLIZE} -n --install >& /dev/null || shift
240 fi
241
242 autotools_run_tool ${LIBTOOLIZE} "$@" ${opts}
243
244 # Need to rerun aclocal
245 eaclocal
246 }
247
248 # @FUNCTION: eautoheader
249 # @DESCRIPTION:
250 # Runs autoheader.
251 eautoheader() {
252 # Check if we should run autoheader
253 [[ -n $(autotools_check_macro "AC_CONFIG_HEADERS") ]] || return 0
254 autotools_run_tool --at-no-fail --at-m4flags autoheader "$@"
255 }
256
257 # @FUNCTION: eautoconf
258 # @DESCRIPTION:
259 # Runs autoconf.
260 eautoconf() {
261 if [[ ! -f configure.ac && ! -f configure.in ]] ; then
262 echo
263 eerror "No configure.{ac,in} present in '${PWD}'!"
264 echo
265 die "No configure.{ac,in} present!"
266 fi
267
268 autotools_run_tool --at-m4flags autoconf "$@"
269 }
270
271 # @FUNCTION: eautomake
272 # @DESCRIPTION:
273 # Runs automake.
274 eautomake() {
275 local extra_opts
276 local makefile_name
277
278 # Run automake if:
279 # - a Makefile.am type file exists
280 # - the configure script is using the AM_INIT_AUTOMAKE directive
281 for makefile_name in {GNUmakefile,{M,m}akefile}.am "" ; do
282 [[ -f ${makefile_name} ]] && break
283 done
284
285 if [[ -z ${makefile_name} ]] ; then
286 # Really we should just use autotools_check_macro ...
287 local am_init_automake=$(sed -n '/AM_INIT_AUTOMAKE/{s:#.*::;s:\<dnl\>.*::;p}' configure.??)
288 if [[ ${am_init_automake} != *"AM_INIT_AUTOMAKE"* ]] ; then
289 return 0
290 fi
291
292 elif [[ -z ${FROM_EAUTORECONF} && -f ${makefile_name%.am}.in ]]; then
293 local used_automake
294 local installed_automake
295
296 installed_automake=$(WANT_AUTOMAKE= automake --version | head -n 1 | \
297 sed -e 's:.*(GNU automake) ::')
298 used_automake=$(head -n 1 < ${makefile_name%.am}.in | \
299 sed -e 's:.*by automake \(.*\) from .*:\1:')
300
301 if [[ ${installed_automake} != ${used_automake} ]]; then
302 einfo "Automake used for the package (${used_automake}) differs from"
303 einfo "the installed version (${installed_automake})."
304 eautoreconf
305 return 0
306 fi
307 fi
308
309 [[ -f INSTALL && -f AUTHORS && -f ChangeLog && -f NEWS && -f README ]] \
310 || extra_opts="${extra_opts} --foreign"
311
312 # --force-missing seems not to be recognized by some flavours of automake
313 autotools_run_tool automake --add-missing --copy ${extra_opts} "$@"
314 }
315
316 # @FUNCTION: eautopoint
317 # @DESCRIPTION:
318 # Runs autopoint (from the gettext package).
319 eautopoint() {
320 autotools_run_tool autopoint "$@"
321 }
322
323 # @FUNCTION: config_rpath_update
324 # @USAGE: [destination]
325 # @DESCRIPTION:
326 # Some packages utilize the config.rpath helper script, but don't
327 # use gettext directly. So we have to copy it in manually since
328 # we can't let `autopoint` do it for us.
329 config_rpath_update() {
330 local dst src=$(type -P gettext | sed 's:bin/gettext:share/gettext/config.rpath:')
331
332 [[ $# -eq 0 ]] && set -- $(find -name config.rpath)
333 [[ $# -eq 0 ]] && return 0
334
335 einfo "Updating all config.rpath files"
336 for dst in "$@" ; do
337 einfo " ${dst}"
338 cp "${src}" "${dst}" || die
339 done
340 }
341
342 # @FUNCTION: autotools_env_setup
343 # @INTERNAL
344 # @DESCRIPTION:
345 # Process the WANT_AUTO{CONF,MAKE} flags.
346 autotools_env_setup() {
347 # We do the "latest" → version switch here because it solves
348 # possible order problems, see bug #270010 as an example.
349 if [[ ${WANT_AUTOMAKE} == "latest" ]]; then
350 local pv
351 for pv in ${_LATEST_AUTOMAKE[@]/#*:} ; do
352 # has_version respects ROOT, but in this case, we don't want it to,
353 # thus "ROOT=/" prefix:
354 ROOT=/ has_version "=sys-devel/automake-${pv}*" && export WANT_AUTOMAKE="${pv}"
355 done
356 [[ ${WANT_AUTOMAKE} == "latest" ]] && \
357 die "Cannot find the latest automake! Tried ${_LATEST_AUTOMAKE}"
358 fi
359 [[ ${WANT_AUTOCONF} == "latest" ]] && export WANT_AUTOCONF=2.5
360 }
361
362 # @FUNCTION: autotools_run_tool
363 # @USAGE: [--at-no-fail] [--at-m4flags] <autotool> [tool-specific flags]
364 # @INTERNAL
365 # @DESCRIPTION:
366 # Run the specified autotool helper, but do logging and error checking
367 # around it in the process.
368 autotools_run_tool() {
369 # Process our own internal flags first
370 local autofail=true m4flags=false
371 while [[ -n $1 ]] ; do
372 case $1 in
373 --at-no-fail) autofail=false;;
374 --at-m4flags) m4flags=true;;
375 # whatever is left goes to the actual tool
376 *) break;;
377 esac
378 shift
379 done
380
381 if [[ ${EBUILD_PHASE} != "unpack" && ${EBUILD_PHASE} != "prepare" ]]; then
382 ewarn "QA Warning: running $1 in ${EBUILD_PHASE} phase"
383 fi
384
385 autotools_env_setup
386
387 local STDERR_TARGET="${T}/$1.out"
388 # most of the time, there will only be one run, but if there are
389 # more, make sure we get unique log filenames
390 if [[ -e ${STDERR_TARGET} ]] ; then
391 local i=1
392 while :; do
393 STDERR_TARGET="${T}/$1-${i}.out"
394 [[ -e ${STDERR_TARGET} ]] || break
395 : $(( i++ ))
396 done
397 fi
398
399 if ${m4flags} ; then
400 set -- "${1}" $(autotools_m4dir_include) "${@:2}" $(autotools_m4sysdir_include)
401 fi
402
403 printf "***** $1 *****\n***** PWD: ${PWD}\n***** $*\n\n" > "${STDERR_TARGET}"
404
405 ebegin "Running $@"
406 "$@" >> "${STDERR_TARGET}" 2>&1
407 if ! eend $? && ${autofail} ; then
408 echo
409 eerror "Failed Running $1 !"
410 eerror
411 eerror "Include in your bugreport the contents of:"
412 eerror
413 eerror " ${STDERR_TARGET}"
414 echo
415 die "Failed Running $1 !"
416 fi
417 }
418
419 # Internal function to check for support
420
421 # Keep a list of all the macros we might use so that we only
422 # have to run the trace code once. Order doesn't matter.
423 ALL_AUTOTOOLS_MACROS=(
424 AC_PROG_LIBTOOL AM_PROG_LIBTOOL LT_INIT
425 AC_CONFIG_HEADERS
426 AC_CONFIG_SUBDIRS
427 AC_CONFIG_AUX_DIR AC_CONFIG_MACRO_DIR
428 AM_INIT_AUTOMAKE
429 )
430 autotools_check_macro() {
431 [[ -f configure.ac || -f configure.in ]] || return 0
432
433 # We can run in multiple dirs, so we have to cache the trace
434 # data in $PWD rather than an env var.
435 local trace_file=".__autoconf_trace_data"
436 if [[ ! -e ${trace_file} ]] || [[ aclocal.m4 -nt ${trace_file} ]] ; then
437 WANT_AUTOCONF="2.5" autoconf \
438 $(autotools_m4dir_include) \
439 ${ALL_AUTOTOOLS_MACROS[@]/#/--trace=} > ${trace_file} 2>/dev/null
440 fi
441
442 local macro args=()
443 for macro ; do
444 has ${macro} ${ALL_AUTOTOOLS_MACROS[@]} || die "internal error: add ${macro} to ALL_AUTOTOOLS_MACROS"
445 args+=( -e ":${macro}:" )
446 done
447 grep "${args[@]}" ${trace_file}
448 }
449
450 # @FUNCTION: autotools_check_macro_val
451 # @USAGE: <macro> [macros]
452 # @INTERNAL
453 # @DESCRIPTION:
454 # Look for a macro and extract its value.
455 autotools_check_macro_val() {
456 local macro scan_out
457
458 for macro ; do
459 autotools_check_macro "${macro}" | \
460 gawk -v macro="${macro}" \
461 '($0 !~ /^[[:space:]]*(#|dnl)/) {
462 if (match($0, macro ":(.*)$", res))
463 print res[1]
464 }' | uniq
465 done
466
467 return 0
468 }
469
470 _autotools_m4dir_include() {
471 local x include_opts
472
473 for x in "$@" ; do
474 case ${x} in
475 # We handle it below
476 -I) ;;
477 *)
478 [[ ! -d ${x} ]] && ewarn "autotools.eclass: '${x}' does not exist"
479 include_opts+=" -I ${x}"
480 ;;
481 esac
482 done
483
484 echo ${include_opts}
485 }
486 autotools_m4dir_include() { _autotools_m4dir_include ${AT_M4DIR} ; }
487 autotools_m4sysdir_include() { _autotools_m4dir_include $(eval echo ${AT_SYS_M4DIR}) ; }
488
489 fi

  ViewVC Help
Powered by ViewVC 1.1.20