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

Contents of /eclass/autotools.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.144 - (show annotations) (download)
Wed Jun 6 17:15:08 2012 UTC (22 months, 1 week ago) by mgorny
Branch: MAIN
Changes since 1.143: +18 -9 lines
Support other GNOME-related tools in eautoreconf: gtk-doc, gnome-doc & glib-gettext.

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.143 2012/06/05 18:31:54 grobian 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 # Run all the tools before aclocal so we can gather the .m4 files.
166 local i tools=(
167 # <tool> <was run> <command>
168 glibgettext false "autotools_run_tool glib-gettextize --copy --force"
169 gettext false "eautopoint --force"
170 # intltool must come after autopoint.
171 intltool false "autotools_run_tool intltoolize --automake --copy --force"
172 gtkdoc false "autotools_run_tool gtkdocize --copy"
173 gnomedoc false "autotools_run_tool gnome-doc-prepare --copy --force"
174 libtool false "_elibtoolize --install --copy --force"
175 )
176 for (( i = 0; i < ${#tools[@]}; i += 3 )) ; do
177 if _at_uses_${tools[i]} ; then
178 tools[i+1]=true
179 ${tools[i+2]}
180 fi
181 done
182
183 # Generate aclocal.m4 with our up-to-date m4 files.
184 local rerun_aclocal=false
185 eaclocal
186
187 # Check to see if we had macros expanded by other macros or in other
188 # m4 files that we couldn't detect early. This is uncommon, but some
189 # packages do this, so we have to handle it correctly.
190 for (( i = 0; i < ${#tools[@]}; i += 3 )) ; do
191 if ! ${tools[i+1]} && _at_uses_${tools[i]} ; then
192 ${tools[i+2]}
193 rerun_aclocal=true
194 fi
195 done
196 ${rerun_aclocal} && eaclocal
197
198 eautoconf
199 eautoheader
200 [[ ${AT_NOEAUTOMAKE} != "yes" ]] && FROM_EAUTORECONF="yes" eautomake ${AM_OPTS}
201
202 [[ ${AT_NOELIBTOOLIZE} == "yes" ]] && return 0
203
204 # Call it here to prevent failures due to elibtoolize called _before_
205 # eautoreconf. We set $S because elibtoolize runs on that #265319
206 S=${PWD} elibtoolize --force
207
208 return 0
209 }
210
211 # @FUNCTION: _at_uses_pkg
212 # @USAGE: <macros>
213 # @INTERNAL
214 # See if the specified macros are enabled.
215 _at_uses_pkg() {
216 if [[ -n $(autotools_check_macro "$@") ]] ; then
217 return 0
218 else
219 # If the trace didn't find it (perhaps because aclocal.m4 hasn't
220 # been generated yet), cheat, but be conservative.
221 local macro args=()
222 for macro ; do
223 args+=( -e "^[[:space:]]*${macro}\>" )
224 done
225 egrep -q "${args[@]}" configure.??
226 fi
227 }
228 _at_uses_autoheader() { _at_uses_pkg AC_CONFIG_HEADERS; }
229 _at_uses_automake() { _at_uses_pkg AM_INIT_AUTOMAKE; }
230 _at_uses_gettext() { _at_uses_pkg AM_GNU_GETTEXT_VERSION; }
231 _at_uses_glibgettext() { _at_uses_pkg AM_GLIB_GNU_GETTEXT; }
232 _at_uses_intltool() { _at_uses_pkg {AC,IT}_PROG_INTLTOOL; }
233 _at_uses_gtkdoc() { _at_uses_pkg GTK_DOC_CHECK; }
234 _at_uses_gnomedoc() { _at_uses_pkg GNOME_DOC_INIT; }
235 _at_uses_libtool() { _at_uses_pkg A{C,M}_PROG_LIBTOOL LT_INIT; }
236
237 # @FUNCTION: eaclocal_amflags
238 # @DESCRIPTION:
239 # Extract the ACLOCAL_AMFLAGS value from the Makefile.am and try to handle
240 # (most) of the crazy crap that people throw at us.
241 eaclocal_amflags() {
242 local aclocal_opts amflags_file
243
244 for amflags_file in GNUmakefile.am Makefile.am GNUmakefile.in Makefile.in ; do
245 [[ -e ${amflags_file} ]] || continue
246 # setup the env in case the pkg does something crazy
247 # in their ACLOCAL_AMFLAGS. like run a shell script
248 # which turns around and runs autotools. #365401
249 # or split across multiple lines. #383525
250 autotools_env_setup
251 aclocal_opts=$(sed -n \
252 "/^ACLOCAL_AMFLAGS[[:space:]]*=/{ \
253 # match the first line
254 s:[^=]*=::p; \
255 # then gobble up all escaped lines
256 : nextline /\\\\$/{ n; p; b nextline; } \
257 }" ${amflags_file})
258 eval aclocal_opts=\""${aclocal_opts}"\"
259 break
260 done
261
262 echo ${aclocal_opts}
263 }
264
265 # @FUNCTION: eaclocal
266 # @DESCRIPTION:
267 # These functions runs the autotools using autotools_run_tool with the
268 # specified parametes. The name of the tool run is the same of the function
269 # without e prefix.
270 # They also force installing the support files for safety.
271 # Respects AT_M4DIR for additional directories to search for macro's.
272 eaclocal() {
273 [[ ! -f aclocal.m4 || -n $(grep -e 'generated.*by aclocal' aclocal.m4) ]] && \
274 autotools_run_tool --at-m4flags aclocal "$@" $(eaclocal_amflags)
275 }
276
277 # @FUNCTION: _elibtoolize
278 # @DESCRIPTION:
279 # Runs libtoolize. If --install is the first arg, automatically drop it if
280 # the active libtool version doesn't support it.
281 #
282 # Note the '_' prefix .. to not collide with elibtoolize() from libtool.eclass.
283 _elibtoolize() {
284 local LIBTOOLIZE=${LIBTOOLIZE:-libtoolize}
285 type -P glibtoolize > /dev/null && LIBTOOLIZE=glibtoolize
286
287 [[ -f GNUmakefile.am || -f Makefile.am ]] && set -- "$@" --automake
288 if [[ $1 == "--install" ]] ; then
289 ${LIBTOOLIZE} -n --install >& /dev/null || shift
290 fi
291
292 autotools_run_tool ${LIBTOOLIZE} "$@" ${opts}
293 }
294
295 # @FUNCTION: eautoheader
296 # @DESCRIPTION:
297 # Runs autoheader.
298 eautoheader() {
299 _at_uses_autoheader || return 0
300 autotools_run_tool --at-no-fail --at-m4flags autoheader "$@"
301 }
302
303 # @FUNCTION: eautoconf
304 # @DESCRIPTION:
305 # Runs autoconf.
306 eautoconf() {
307 if [[ ! -f configure.ac && ! -f configure.in ]] ; then
308 echo
309 eerror "No configure.{ac,in} present in '${PWD}'!"
310 echo
311 die "No configure.{ac,in} present!"
312 fi
313
314 autotools_run_tool --at-m4flags autoconf "$@"
315 }
316
317 # @FUNCTION: eautomake
318 # @DESCRIPTION:
319 # Runs automake.
320 eautomake() {
321 local extra_opts
322 local makefile_name
323
324 # Run automake if:
325 # - a Makefile.am type file exists
326 # - the configure script is using the AM_INIT_AUTOMAKE directive
327 for makefile_name in {GNUmakefile,{M,m}akefile}.am "" ; do
328 [[ -f ${makefile_name} ]] && break
329 done
330
331 if [[ -z ${makefile_name} ]] ; then
332 _at_uses_automake || return 0
333
334 elif [[ -z ${FROM_EAUTORECONF} && -f ${makefile_name%.am}.in ]]; then
335 local used_automake
336 local installed_automake
337
338 installed_automake=$(WANT_AUTOMAKE= automake --version | head -n 1 | \
339 sed -e 's:.*(GNU automake) ::')
340 used_automake=$(head -n 1 < ${makefile_name%.am}.in | \
341 sed -e 's:.*by automake \(.*\) from .*:\1:')
342
343 if [[ ${installed_automake} != ${used_automake} ]]; then
344 einfo "Automake used for the package (${used_automake}) differs from"
345 einfo "the installed version (${installed_automake})."
346 eautoreconf
347 return 0
348 fi
349 fi
350
351 [[ -f INSTALL && -f AUTHORS && -f ChangeLog && -f NEWS && -f README ]] \
352 || extra_opts="${extra_opts} --foreign"
353
354 # --force-missing seems not to be recognized by some flavours of automake
355 autotools_run_tool automake --add-missing --copy ${extra_opts} "$@"
356 }
357
358 # @FUNCTION: eautopoint
359 # @DESCRIPTION:
360 # Runs autopoint (from the gettext package).
361 eautopoint() {
362 autotools_run_tool autopoint "$@"
363 }
364
365 # @FUNCTION: config_rpath_update
366 # @USAGE: [destination]
367 # @DESCRIPTION:
368 # Some packages utilize the config.rpath helper script, but don't
369 # use gettext directly. So we have to copy it in manually since
370 # we can't let `autopoint` do it for us.
371 config_rpath_update() {
372 local dst src=$(type -P gettext | sed 's:bin/gettext:share/gettext/config.rpath:')
373
374 [[ $# -eq 0 ]] && set -- $(find -name config.rpath)
375 [[ $# -eq 0 ]] && return 0
376
377 einfo "Updating all config.rpath files"
378 for dst in "$@" ; do
379 einfo " ${dst}"
380 cp "${src}" "${dst}" || die
381 done
382 }
383
384 # @FUNCTION: autotools_env_setup
385 # @INTERNAL
386 # @DESCRIPTION:
387 # Process the WANT_AUTO{CONF,MAKE} flags.
388 autotools_env_setup() {
389 # We do the "latest" → version switch here because it solves
390 # possible order problems, see bug #270010 as an example.
391 if [[ ${WANT_AUTOMAKE} == "latest" ]]; then
392 local pv
393 for pv in ${_LATEST_AUTOMAKE[@]/#*:} ; do
394 # has_version respects ROOT, but in this case, we don't want it to,
395 # thus "ROOT=/" prefix:
396 ROOT=/ has_version "=sys-devel/automake-${pv}*" && export WANT_AUTOMAKE="${pv}"
397 done
398 [[ ${WANT_AUTOMAKE} == "latest" ]] && \
399 die "Cannot find the latest automake! Tried ${_LATEST_AUTOMAKE}"
400 fi
401 [[ ${WANT_AUTOCONF} == "latest" ]] && export WANT_AUTOCONF=2.5
402 }
403
404 # @FUNCTION: autotools_run_tool
405 # @USAGE: [--at-no-fail] [--at-m4flags] <autotool> [tool-specific flags]
406 # @INTERNAL
407 # @DESCRIPTION:
408 # Run the specified autotool helper, but do logging and error checking
409 # around it in the process.
410 autotools_run_tool() {
411 # Process our own internal flags first
412 local autofail=true m4flags=false
413 while [[ -n $1 ]] ; do
414 case $1 in
415 --at-no-fail) autofail=false;;
416 --at-m4flags) m4flags=true;;
417 # whatever is left goes to the actual tool
418 *) break;;
419 esac
420 shift
421 done
422
423 if [[ ${EBUILD_PHASE} != "unpack" && ${EBUILD_PHASE} != "prepare" ]]; then
424 ewarn "QA Warning: running $1 in ${EBUILD_PHASE} phase"
425 fi
426
427 autotools_env_setup
428
429 local STDERR_TARGET="${T}/$1.out"
430 # most of the time, there will only be one run, but if there are
431 # more, make sure we get unique log filenames
432 if [[ -e ${STDERR_TARGET} ]] ; then
433 local i=1
434 while :; do
435 STDERR_TARGET="${T}/$1-${i}.out"
436 [[ -e ${STDERR_TARGET} ]] || break
437 : $(( i++ ))
438 done
439 fi
440
441 if ${m4flags} ; then
442 set -- "${1}" $(autotools_m4dir_include) "${@:2}" $(autotools_m4sysdir_include)
443 fi
444
445 printf "***** $1 *****\n***** PWD: ${PWD}\n***** $*\n\n" > "${STDERR_TARGET}"
446
447 ebegin "Running $@"
448 "$@" >> "${STDERR_TARGET}" 2>&1
449 if ! eend $? && ${autofail} ; then
450 echo
451 eerror "Failed Running $1 !"
452 eerror
453 eerror "Include in your bugreport the contents of:"
454 eerror
455 eerror " ${STDERR_TARGET}"
456 echo
457 die "Failed Running $1 !"
458 fi
459 }
460
461 # Internal function to check for support
462
463 # Keep a list of all the macros we might use so that we only
464 # have to run the trace code once. Order doesn't matter.
465 ALL_AUTOTOOLS_MACROS=(
466 AC_PROG_LIBTOOL AM_PROG_LIBTOOL LT_INIT
467 AC_CONFIG_HEADERS
468 AC_CONFIG_SUBDIRS
469 AC_CONFIG_AUX_DIR AC_CONFIG_MACRO_DIR
470 AM_INIT_AUTOMAKE
471 AM_GLIB_GNU_GETTEXT
472 AM_GNU_GETTEXT_VERSION
473 {AC,IT}_PROG_INTLTOOL
474 GTK_DOC_CHECK
475 GNOME_DOC_INIT
476 )
477 autotools_check_macro() {
478 [[ -f configure.ac || -f configure.in ]] || return 0
479
480 # We can run in multiple dirs, so we have to cache the trace
481 # data in $PWD rather than an env var.
482 local trace_file=".__autoconf_trace_data"
483 if [[ ! -e ${trace_file} ]] || [[ aclocal.m4 -nt ${trace_file} ]] ; then
484 WANT_AUTOCONF="2.5" autoconf \
485 $(autotools_m4dir_include) \
486 ${ALL_AUTOTOOLS_MACROS[@]/#/--trace=} > ${trace_file} 2>/dev/null
487 fi
488
489 local macro args=()
490 for macro ; do
491 has ${macro} ${ALL_AUTOTOOLS_MACROS[@]} || die "internal error: add ${macro} to ALL_AUTOTOOLS_MACROS"
492 args+=( -e ":${macro}:" )
493 done
494 grep "${args[@]}" ${trace_file}
495 }
496
497 # @FUNCTION: autotools_check_macro_val
498 # @USAGE: <macro> [macros]
499 # @INTERNAL
500 # @DESCRIPTION:
501 # Look for a macro and extract its value.
502 autotools_check_macro_val() {
503 local macro scan_out
504
505 for macro ; do
506 autotools_check_macro "${macro}" | \
507 gawk -v macro="${macro}" \
508 '($0 !~ /^[[:space:]]*(#|dnl)/) {
509 if (match($0, macro ":(.*)$", res))
510 print res[1]
511 }' | uniq
512 done
513
514 return 0
515 }
516
517 _autotools_m4dir_include() {
518 local x include_opts
519
520 for x in "$@" ; do
521 case ${x} in
522 # We handle it below
523 -I) ;;
524 *)
525 [[ ! -d ${x} ]] && ewarn "autotools.eclass: '${x}' does not exist"
526 include_opts+=" -I ${x}"
527 ;;
528 esac
529 done
530
531 echo ${include_opts}
532 }
533 autotools_m4dir_include() { _autotools_m4dir_include ${AT_M4DIR} ; }
534 autotools_m4sysdir_include() { _autotools_m4dir_include $(eval echo ${AT_SYS_M4DIR}) ; }
535
536 fi

  ViewVC Help
Powered by ViewVC 1.1.20