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

Contents of /eclass/autotools.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.159 - (show annotations) (download)
Tue Dec 31 16:53:05 2013 UTC (6 months, 2 weeks ago) by vapier
Branch: MAIN
Changes since 1.158: +3 -3 lines
elibtoolize: accept explicit dir args on command line #496320 by Arfrever Frehtes Taifersar Arahesis

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

  ViewVC Help
Powered by ViewVC 1.1.20