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

Contents of /eclass/autotools.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.154 - (show annotations) (download)
Sun Apr 28 16:45:37 2013 UTC (17 months, 3 weeks ago) by vapier
Branch: MAIN
Changes since 1.153: +2 -2 lines
check for AM_CONFIG_HEADER and AC_CONFIG_HEADER when testing for autoheader usage

1 # Copyright 1999-2013 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.153 2013/04/23 19:16:00 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 multiprocessing
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 # We should list both the latest stable, and the latest unstable. #465732
42 # This way the stable builds will still work, but the unstable are allowed
43 # to build & test things for us ahead of time (if they have it installed).
44 # If a newer slot is stable on any arch, and is NOT reflected in this list,
45 # then circular dependencies may arise during emerge @system bootstraps.
46 # Do NOT change this variable in your ebuilds!
47 # If you want to force a newer minor version, you can specify the correct
48 # WANT value by using a colon: <PV>:<WANT_AUTOMAKE>
49 _LATEST_AUTOMAKE=( 1.12:1.12 1.13:1.13 )
50
51 _automake_atom="sys-devel/automake"
52 _autoconf_atom="sys-devel/autoconf"
53 if [[ -n ${WANT_AUTOMAKE} ]]; then
54 case ${WANT_AUTOMAKE} in
55 # Even if the package doesn't use automake, we still need to depend
56 # on it because we run aclocal to process m4 macros. This matches
57 # the autoreconf tool, so this requirement is correct. #401605
58 none) ;;
59 latest)
60 # Use SLOT deps if we can. For EAPI=0, we get pretty close.
61 if [[ ${EAPI:-0} != 0 ]] ; then
62 _automake_atom="|| ( `printf '>=sys-devel/automake-%s:%s ' ${_LATEST_AUTOMAKE[@]/:/ }` )"
63 else
64 _automake_atom="|| ( `printf '>=sys-devel/automake-%s ' ${_LATEST_AUTOMAKE[@]/%:*}` )"
65 fi
66 ;;
67 *) _automake_atom="=sys-devel/automake-${WANT_AUTOMAKE}*" ;;
68 esac
69 export WANT_AUTOMAKE
70 fi
71
72 if [[ -n ${WANT_AUTOCONF} ]] ; then
73 case ${WANT_AUTOCONF} in
74 none) _autoconf_atom="" ;; # some packages don't require autoconf at all
75 2.1) _autoconf_atom="=sys-devel/autoconf-${WANT_AUTOCONF}*" ;;
76 # if you change the "latest" version here, change also autotools_env_setup
77 latest|2.5) _autoconf_atom=">=sys-devel/autoconf-2.68" ;;
78 *) die "Invalid WANT_AUTOCONF value '${WANT_AUTOCONF}'" ;;
79 esac
80 export WANT_AUTOCONF
81 fi
82
83 _libtool_atom="sys-devel/libtool"
84 if [[ -n ${WANT_LIBTOOL} ]] ; then
85 case ${WANT_LIBTOOL} in
86 none) _libtool_atom="" ;;
87 latest) ;;
88 *) die "Invalid WANT_LIBTOOL value '${WANT_LIBTOOL}'" ;;
89 esac
90 export WANT_LIBTOOL
91 fi
92
93 AUTOTOOLS_DEPEND="${_automake_atom} ${_autoconf_atom} ${_libtool_atom}"
94 RDEPEND=""
95
96 # @ECLASS-VARIABLE: AUTOTOOLS_AUTO_DEPEND
97 # @DESCRIPTION:
98 # Set to 'no' to disable automatically adding to DEPEND. This lets
99 # ebuilds former conditional depends by using ${AUTOTOOLS_DEPEND} in
100 # their own DEPEND string.
101 : ${AUTOTOOLS_AUTO_DEPEND:=yes}
102 if [[ ${AUTOTOOLS_AUTO_DEPEND} != "no" ]] ; then
103 DEPEND=${AUTOTOOLS_DEPEND}
104 fi
105
106 unset _automake_atom _autoconf_atom
107
108 # @ECLASS-VARIABLE: AM_OPTS
109 # @DEFAULT_UNSET
110 # @DESCRIPTION:
111 # Additional options to pass to automake during
112 # eautoreconf call.
113
114 # @ECLASS-VARIABLE: AT_NOEAUTOMAKE
115 # @DEFAULT_UNSET
116 # @DESCRIPTION:
117 # Don't run eautomake command if set to 'yes'; only used to workaround
118 # broken packages. Generally you should, instead, fix the package to
119 # not call AM_INIT_AUTOMAKE if it doesn't actually use automake.
120
121 # @ECLASS-VARIABLE: AT_NOELIBTOOLIZE
122 # @DEFAULT_UNSET
123 # @DESCRIPTION:
124 # Don't run elibtoolize command if set to 'yes',
125 # useful when elibtoolize needs to be ran with
126 # particular options
127
128 # @ECLASS-VARIABLE: AT_M4DIR
129 # @DESCRIPTION:
130 # Additional director(y|ies) aclocal should search
131 : ${AT_M4DIR:=}
132
133 # @ECLASS-VARIABLE: AT_SYS_M4DIR
134 # @INTERNAL
135 # @DESCRIPTION:
136 # For system integrators, a list of additional aclocal search paths.
137 # This variable gets eval-ed, so you can use variables in the definition
138 # that may not be valid until eautoreconf & friends are run.
139 : ${AT_SYS_M4DIR:=}
140
141 # @FUNCTION: eautoreconf
142 # @DESCRIPTION:
143 # This function mimes the behavior of autoreconf, but uses the different
144 # eauto* functions to run the tools. It doesn't accept parameters, but
145 # the directory with include files can be specified with AT_M4DIR variable.
146 #
147 # Should do a full autoreconf - normally what most people will be interested in.
148 # Also should handle additional directories specified by AC_CONFIG_SUBDIRS.
149 eautoreconf() {
150 local x g multitop
151
152 if [[ -z ${AT_TOPLEVEL_EAUTORECONF} ]] ; then
153 AT_TOPLEVEL_EAUTORECONF="yes"
154 multitop="yes"
155 multijob_init
156 fi
157
158 if [[ -z ${AT_NO_RECURSIVE} ]] ; then
159 # Take care of subdirs
160 for x in $(autotools_check_macro_val AC_CONFIG_SUBDIRS) ; do
161 if [[ -d ${x} ]] ; then
162 pushd "${x}" >/dev/null
163 if [[ -z ${PAST_TOPLEVEL_EAUTORECONF} ]] ; then
164 PAST_TOPLEVEL_EAUTORECONF="yes" AT_NOELIBTOOLIZE="yes" \
165 multijob_child_init eautoreconf || die
166 else
167 # Avoid unsafe nested multijob_finish_one for bug #426512.
168 AT_NOELIBTOOLIZE="yes" eautoreconf || die
169 fi
170 popd >/dev/null
171 fi
172 done
173 fi
174
175 einfo "Running eautoreconf in '${PWD}' ..."
176
177 local m4dirs=$(autotools_check_macro_val AC_CONFIG_{AUX,MACRO}_DIR)
178 [[ -n ${m4dirs} ]] && mkdir -p ${m4dirs}
179
180 # Run all the tools before aclocal so we can gather the .m4 files.
181 local i tools=(
182 # <tool> <was run> <command>
183 glibgettext false "autotools_run_tool glib-gettextize --copy --force"
184 gettext false "autotools_run_tool --at-missing autopoint --force"
185 # intltool must come after autopoint.
186 intltool false "autotools_run_tool intltoolize --automake --copy --force"
187 gtkdoc false "autotools_run_tool --at-missing gtkdocize --copy"
188 gnomedoc false "autotools_run_tool --at-missing gnome-doc-prepare --copy --force"
189 libtool false "_elibtoolize --install --copy --force"
190 )
191 for (( i = 0; i < ${#tools[@]}; i += 3 )) ; do
192 if _at_uses_${tools[i]} ; then
193 tools[i+1]=true
194 ${tools[i+2]}
195 fi
196 done
197
198 # Generate aclocal.m4 with our up-to-date m4 files.
199 local rerun_aclocal=false
200 eaclocal
201
202 # Check to see if we had macros expanded by other macros or in other
203 # m4 files that we couldn't detect early. This is uncommon, but some
204 # packages do this, so we have to handle it correctly.
205 for (( i = 0; i < ${#tools[@]}; i += 3 )) ; do
206 if ! ${tools[i+1]} && _at_uses_${tools[i]} ; then
207 ${tools[i+2]}
208 rerun_aclocal=true
209 fi
210 done
211 ${rerun_aclocal} && eaclocal
212
213 eautoconf
214 eautoheader
215 [[ ${AT_NOEAUTOMAKE} != "yes" ]] && FROM_EAUTORECONF="yes" eautomake ${AM_OPTS}
216
217 if [[ ${AT_NOELIBTOOLIZE} != "yes" ]] ; then
218 # Call it here to prevent failures due to elibtoolize called _before_
219 # eautoreconf. We set $S because elibtoolize runs on that #265319
220 S=${PWD} elibtoolize --force
221 fi
222
223 if [[ -n ${multitop} ]] ; then
224 unset AT_TOPLEVEL_EAUTORECONF
225 multijob_finish || die
226 fi
227
228 return 0
229 }
230
231 # @FUNCTION: _at_uses_pkg
232 # @USAGE: <macros>
233 # @INTERNAL
234 # See if the specified macros are enabled.
235 _at_uses_pkg() {
236 if [[ -n $(autotools_check_macro "$@") ]] ; then
237 return 0
238 else
239 # If the trace didn't find it (perhaps because aclocal.m4 hasn't
240 # been generated yet), cheat, but be conservative.
241 local macro args=()
242 for macro ; do
243 args+=( -e "^[[:space:]]*${macro}\>" )
244 done
245 egrep -q "${args[@]}" configure.??
246 fi
247 }
248 _at_uses_autoheader() { _at_uses_pkg A{C,M}_CONFIG_HEADER{S,}; }
249 _at_uses_automake() { _at_uses_pkg AM_INIT_AUTOMAKE; }
250 _at_uses_gettext() { _at_uses_pkg AM_GNU_GETTEXT_VERSION; }
251 _at_uses_glibgettext() { _at_uses_pkg AM_GLIB_GNU_GETTEXT; }
252 _at_uses_intltool() { _at_uses_pkg {AC,IT}_PROG_INTLTOOL; }
253 _at_uses_gtkdoc() { _at_uses_pkg GTK_DOC_CHECK; }
254 _at_uses_gnomedoc() { _at_uses_pkg GNOME_DOC_INIT; }
255 _at_uses_libtool() { _at_uses_pkg A{C,M}_PROG_LIBTOOL LT_INIT; }
256
257 # @FUNCTION: eaclocal_amflags
258 # @DESCRIPTION:
259 # Extract the ACLOCAL_AMFLAGS value from the Makefile.am and try to handle
260 # (most) of the crazy crap that people throw at us.
261 eaclocal_amflags() {
262 local aclocal_opts amflags_file
263
264 for amflags_file in GNUmakefile.am Makefile.am GNUmakefile.in Makefile.in ; do
265 [[ -e ${amflags_file} ]] || continue
266 # setup the env in case the pkg does something crazy
267 # in their ACLOCAL_AMFLAGS. like run a shell script
268 # which turns around and runs autotools. #365401
269 # or split across multiple lines. #383525
270 autotools_env_setup
271 aclocal_opts=$(sed -n \
272 "/^ACLOCAL_AMFLAGS[[:space:]]*=/{ \
273 # match the first line
274 s:[^=]*=::p; \
275 # then gobble up all escaped lines
276 : nextline /\\\\$/{ n; p; b nextline; } \
277 }" ${amflags_file})
278 eval aclocal_opts=\""${aclocal_opts}"\"
279 break
280 done
281
282 echo ${aclocal_opts}
283 }
284
285 # @FUNCTION: eaclocal
286 # @DESCRIPTION:
287 # These functions runs the autotools using autotools_run_tool with the
288 # specified parametes. The name of the tool run is the same of the function
289 # without e prefix.
290 # They also force installing the support files for safety.
291 # Respects AT_M4DIR for additional directories to search for macro's.
292 eaclocal() {
293 [[ ! -f aclocal.m4 || -n $(grep -e 'generated.*by aclocal' aclocal.m4) ]] && \
294 autotools_run_tool --at-m4flags aclocal "$@" $(eaclocal_amflags)
295 }
296
297 # @FUNCTION: _elibtoolize
298 # @DESCRIPTION:
299 # Runs libtoolize. If --install is the first arg, automatically drop it if
300 # the active libtool version doesn't support it.
301 #
302 # Note the '_' prefix .. to not collide with elibtoolize() from libtool.eclass.
303 _elibtoolize() {
304 local LIBTOOLIZE=${LIBTOOLIZE:-$(type -P glibtoolize > /dev/null && echo glibtoolize || echo libtoolize)}
305
306 [[ -f GNUmakefile.am || -f Makefile.am ]] && set -- "$@" --automake
307 if [[ $1 == "--install" ]] ; then
308 ${LIBTOOLIZE} -n --install >& /dev/null || shift
309 fi
310
311 autotools_run_tool ${LIBTOOLIZE} "$@" ${opts}
312 }
313
314 # @FUNCTION: eautoheader
315 # @DESCRIPTION:
316 # Runs autoheader.
317 eautoheader() {
318 _at_uses_autoheader || return 0
319 autotools_run_tool --at-no-fail --at-m4flags autoheader "$@"
320 }
321
322 # @FUNCTION: eautoconf
323 # @DESCRIPTION:
324 # Runs autoconf.
325 eautoconf() {
326 if [[ ! -f configure.ac && ! -f configure.in ]] ; then
327 echo
328 eerror "No configure.{ac,in} present in '${PWD}'!"
329 echo
330 die "No configure.{ac,in} present!"
331 fi
332
333 autotools_run_tool --at-m4flags autoconf "$@"
334 }
335
336 # @FUNCTION: eautomake
337 # @DESCRIPTION:
338 # Runs automake.
339 eautomake() {
340 local extra_opts
341 local makefile_name
342
343 # Run automake if:
344 # - a Makefile.am type file exists
345 # - the configure script is using the AM_INIT_AUTOMAKE directive
346 for makefile_name in {GNUmakefile,{M,m}akefile}.am "" ; do
347 [[ -f ${makefile_name} ]] && break
348 done
349
350 if [[ -z ${makefile_name} ]] ; then
351 _at_uses_automake || return 0
352
353 elif [[ -z ${FROM_EAUTORECONF} && -f ${makefile_name%.am}.in ]]; then
354 local used_automake
355 local installed_automake
356
357 installed_automake=$(WANT_AUTOMAKE= automake --version | head -n 1 | \
358 sed -e 's:.*(GNU automake) ::')
359 used_automake=$(head -n 1 < ${makefile_name%.am}.in | \
360 sed -e 's:.*by automake \(.*\) from .*:\1:')
361
362 if [[ ${installed_automake} != ${used_automake} ]]; then
363 einfo "Automake used for the package (${used_automake}) differs from"
364 einfo "the installed version (${installed_automake})."
365 eautoreconf
366 return 0
367 fi
368 fi
369
370 [[ -f INSTALL && -f AUTHORS && -f ChangeLog && -f NEWS && -f README ]] \
371 || extra_opts="${extra_opts} --foreign"
372
373 # --force-missing seems not to be recognized by some flavours of automake
374 autotools_run_tool automake --add-missing --copy ${extra_opts} "$@"
375 }
376
377 # @FUNCTION: eautopoint
378 # @DESCRIPTION:
379 # Runs autopoint (from the gettext package).
380 eautopoint() {
381 autotools_run_tool autopoint "$@"
382 }
383
384 # @FUNCTION: config_rpath_update
385 # @USAGE: [destination]
386 # @DESCRIPTION:
387 # Some packages utilize the config.rpath helper script, but don't
388 # use gettext directly. So we have to copy it in manually since
389 # we can't let `autopoint` do it for us.
390 config_rpath_update() {
391 local dst src=$(type -P gettext | sed 's:bin/gettext:share/gettext/config.rpath:')
392
393 [[ $# -eq 0 ]] && set -- $(find -name config.rpath)
394 [[ $# -eq 0 ]] && return 0
395
396 einfo "Updating all config.rpath files"
397 for dst in "$@" ; do
398 einfo " ${dst}"
399 cp "${src}" "${dst}" || die
400 done
401 }
402
403 # @FUNCTION: autotools_env_setup
404 # @INTERNAL
405 # @DESCRIPTION:
406 # Process the WANT_AUTO{CONF,MAKE} flags.
407 autotools_env_setup() {
408 # We do the "latest" → version switch here because it solves
409 # possible order problems, see bug #270010 as an example.
410 if [[ ${WANT_AUTOMAKE} == "latest" ]]; then
411 local pv
412 for pv in ${_LATEST_AUTOMAKE[@]/#*:} ; do
413 # has_version respects ROOT, but in this case, we don't want it to,
414 # thus "ROOT=/" prefix:
415 ROOT=/ has_version "=sys-devel/automake-${pv}*" && export WANT_AUTOMAKE="${pv}"
416 done
417 [[ ${WANT_AUTOMAKE} == "latest" ]] && \
418 die "Cannot find the latest automake! Tried ${_LATEST_AUTOMAKE}"
419 fi
420 [[ ${WANT_AUTOCONF} == "latest" ]] && export WANT_AUTOCONF=2.5
421 }
422
423 # @FUNCTION: autotools_run_tool
424 # @USAGE: [--at-no-fail] [--at-m4flags] [--at-missing] <autotool> [tool-specific flags]
425 # @INTERNAL
426 # @DESCRIPTION:
427 # Run the specified autotool helper, but do logging and error checking
428 # around it in the process.
429 autotools_run_tool() {
430 # Process our own internal flags first
431 local autofail=true m4flags=false missing_ok=false
432 while [[ -n $1 ]] ; do
433 case $1 in
434 --at-no-fail) autofail=false;;
435 --at-m4flags) m4flags=true;;
436 --at-missing) missing_ok=true;;
437 # whatever is left goes to the actual tool
438 *) break;;
439 esac
440 shift
441 done
442
443 if [[ ${EBUILD_PHASE} != "unpack" && ${EBUILD_PHASE} != "prepare" ]]; then
444 ewarn "QA Warning: running $1 in ${EBUILD_PHASE} phase"
445 fi
446
447 if ${missing_ok} && ! type -P ${1} >/dev/null ; then
448 einfo "Skipping '$*' due $1 not installed"
449 return 0
450 fi
451
452 autotools_env_setup
453
454 local STDERR_TARGET="${T}/$1.out"
455 # most of the time, there will only be one run, but if there are
456 # more, make sure we get unique log filenames
457 if [[ -e ${STDERR_TARGET} ]] ; then
458 local i=1
459 while :; do
460 STDERR_TARGET="${T}/$1-${i}.out"
461 [[ -e ${STDERR_TARGET} ]] || break
462 : $(( i++ ))
463 done
464 fi
465
466 if ${m4flags} ; then
467 set -- "${1}" $(autotools_m4dir_include) "${@:2}" $(autotools_m4sysdir_include)
468 fi
469
470 printf "***** $1 *****\n***** PWD: ${PWD}\n***** $*\n\n" > "${STDERR_TARGET}"
471
472 ebegin "Running $@"
473 "$@" >> "${STDERR_TARGET}" 2>&1
474 if ! eend $? && ${autofail} ; then
475 echo
476 eerror "Failed Running $1 !"
477 eerror
478 eerror "Include in your bugreport the contents of:"
479 eerror
480 eerror " ${STDERR_TARGET}"
481 echo
482 die "Failed Running $1 !"
483 fi
484 }
485
486 # Internal function to check for support
487
488 # Keep a list of all the macros we might use so that we only
489 # have to run the trace code once. Order doesn't matter.
490 ALL_AUTOTOOLS_MACROS=(
491 AC_PROG_LIBTOOL AM_PROG_LIBTOOL LT_INIT
492 AC_CONFIG_HEADERS
493 AC_CONFIG_SUBDIRS
494 AC_CONFIG_AUX_DIR AC_CONFIG_MACRO_DIR
495 AM_INIT_AUTOMAKE
496 AM_GLIB_GNU_GETTEXT
497 AM_GNU_GETTEXT_VERSION
498 {AC,IT}_PROG_INTLTOOL
499 GTK_DOC_CHECK
500 GNOME_DOC_INIT
501 )
502 autotools_check_macro() {
503 [[ -f configure.ac || -f configure.in ]] || return 0
504
505 # We can run in multiple dirs, so we have to cache the trace
506 # data in $PWD rather than an env var.
507 local trace_file=".__autoconf_trace_data"
508 if [[ ! -e ${trace_file} ]] || [[ ! aclocal.m4 -ot ${trace_file} ]] ; then
509 WANT_AUTOCONF="2.5" autoconf \
510 $(autotools_m4dir_include) \
511 ${ALL_AUTOTOOLS_MACROS[@]/#/--trace=} > ${trace_file} 2>/dev/null
512 fi
513
514 local macro args=()
515 for macro ; do
516 has ${macro} ${ALL_AUTOTOOLS_MACROS[@]} || die "internal error: add ${macro} to ALL_AUTOTOOLS_MACROS"
517 args+=( -e ":${macro}:" )
518 done
519 grep "${args[@]}" ${trace_file}
520 }
521
522 # @FUNCTION: autotools_check_macro_val
523 # @USAGE: <macro> [macros]
524 # @INTERNAL
525 # @DESCRIPTION:
526 # Look for a macro and extract its value.
527 autotools_check_macro_val() {
528 local macro scan_out
529
530 for macro ; do
531 autotools_check_macro "${macro}" | \
532 gawk -v macro="${macro}" \
533 '($0 !~ /^[[:space:]]*(#|dnl)/) {
534 if (match($0, macro ":(.*)$", res))
535 print res[1]
536 }' | uniq
537 done
538
539 return 0
540 }
541
542 _autotools_m4dir_include() {
543 local x include_opts flag
544
545 # Use the right flag to autoconf based on the version #448986
546 [[ ${WANT_AUTOCONF} == "2.1" ]] \
547 && flag="l" \
548 || flag="I"
549
550 for x in "$@" ; do
551 case ${x} in
552 # We handle it below
553 -${flag}) ;;
554 *)
555 [[ ! -d ${x} ]] && ewarn "autotools.eclass: '${x}' does not exist"
556 include_opts+=" -${flag} ${x}"
557 ;;
558 esac
559 done
560
561 echo ${include_opts}
562 }
563 autotools_m4dir_include() { _autotools_m4dir_include ${AT_M4DIR} ; }
564 autotools_m4sysdir_include() { _autotools_m4dir_include $(eval echo ${AT_SYS_M4DIR}) ; }
565
566 fi

  ViewVC Help
Powered by ViewVC 1.1.20