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

Contents of /eclass/autotools-utils.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.60 - (hide annotations) (download)
Mon Dec 3 12:05:51 2012 UTC (19 months, 4 weeks ago) by mgorny
Branch: MAIN
Changes since 1.59: +5 -4 lines
Improve the compatibility code thanks to Arfrever.

1 mgorny 1.32 # Copyright 1999-2012 Gentoo Foundation
2 reavertm 1.1 # Distributed under the terms of the GNU General Public License v2
3 mgorny 1.60 # $Header: /var/cvsroot/gentoo-x86/eclass/autotools-utils.eclass,v 1.59 2012/12/03 09:29:09 mgorny Exp $
4 reavertm 1.1
5     # @ECLASS: autotools-utils.eclass
6     # @MAINTAINER:
7     # Maciej Mrozowski <reavertm@gentoo.org>
8 reavertm 1.10 # Michał Górny <mgorny@gentoo.org>
9 reavertm 1.1 # @BLURB: common ebuild functions for autotools-based packages
10     # @DESCRIPTION:
11     # autotools-utils.eclass is autotools.eclass(5) and base.eclass(5) wrapper
12     # providing all inherited features along with econf arguments as Bash array,
13     # out of source build with overridable build dir location, static archives
14 mgorny 1.28 # handling, libtool files removal.
15     #
16 mgorny 1.56 # Please note that autotools-utils does not support mixing of its phase
17 mgorny 1.28 # functions with regular econf/emake calls. If necessary, please call
18     # autotools-utils_src_compile instead of the latter.
19 reavertm 1.1 #
20     # @EXAMPLE:
21     # Typical ebuild using autotools-utils.eclass:
22     #
23     # @CODE
24     # EAPI="2"
25     #
26     # inherit autotools-utils
27     #
28     # DESCRIPTION="Foo bar application"
29     # HOMEPAGE="http://example.org/foo/"
30     # SRC_URI="mirror://sourceforge/foo/${P}.tar.bz2"
31     #
32     # LICENSE="LGPL-2.1"
33     # KEYWORDS=""
34     # SLOT="0"
35     # IUSE="debug doc examples qt4 static-libs tiff"
36     #
37     # CDEPEND="
38     # media-libs/libpng:0
39     # qt4? (
40     # x11-libs/qt-core:4
41     # x11-libs/qt-gui:4
42     # )
43     # tiff? ( media-libs/tiff:0 )
44     # "
45     # RDEPEND="${CDEPEND}
46     # !media-gfx/bar
47     # "
48     # DEPEND="${CDEPEND}
49     # doc? ( app-doc/doxygen )
50     # "
51     #
52     # # bug 123456
53     # AUTOTOOLS_IN_SOURCE_BUILD=1
54     #
55     # DOCS=(AUTHORS ChangeLog README "Read me.txt" TODO)
56     #
57     # PATCHES=(
58     # "${FILESDIR}/${P}-gcc44.patch" # bug 123458
59     # "${FILESDIR}/${P}-as-needed.patch"
60     # "${FILESDIR}/${P}-unbundle_libpng.patch"
61     # )
62     #
63     # src_configure() {
64 reavertm 1.6 # local myeconfargs=(
65 mgorny 1.23 # $(use_enable debug)
66 reavertm 1.1 # $(use_with qt4)
67     # $(use_enable threads multithreading)
68     # $(use_with tiff)
69     # )
70     # autotools-utils_src_configure
71     # }
72     #
73     # src_compile() {
74     # autotools-utils_src_compile
75     # use doc && autotools-utils_src_compile docs
76     # }
77     #
78     # src_install() {
79 mgorny 1.58 # use doc && HTML_DOCS=("${BUILD_DIR}/apidocs/html/")
80 reavertm 1.1 # autotools-utils_src_install
81     # if use examples; then
82 mgorny 1.58 # dobin "${BUILD_DIR}"/foo_example{1,2,3} \\
83 reavertm 1.1 # || die 'dobin examples failed'
84     # fi
85     # }
86     #
87     # @CODE
88    
89     # Keep variable names synced with cmake-utils and the other way around!
90    
91     case ${EAPI:-0} in
92 axs 1.57 2|3|4|5) ;;
93 reavertm 1.2 *) die "EAPI=${EAPI} is not supported" ;;
94 reavertm 1.1 esac
95    
96 mgorny 1.32 # @ECLASS-VARIABLE: AUTOTOOLS_AUTORECONF
97 jlec 1.33 # @DEFAULT_UNSET
98 mgorny 1.32 # @DESCRIPTION:
99     # Set to a non-empty value in order to enable running autoreconf
100     # in src_prepare() and adding autotools dependencies.
101     #
102 mgorny 1.37 # This is usually necessary when using live sources or applying patches
103     # modifying configure.ac or Makefile.am files. Note that in the latter case
104     # setting this variable is obligatory even though the eclass will work without
105     # it (to add the necessary dependencies).
106     #
107 mgorny 1.32 # The eclass will try to determine the correct autotools to run including a few
108     # external tools: gettext, glib-gettext, intltool, gtk-doc, gnome-doc-prepare.
109     # If your tool is not supported, please open a bug and we'll add support for it.
110     #
111     # Note that dependencies are added for autoconf, automake and libtool only.
112     # If your package needs one of the external tools listed above, you need to add
113     # appropriate packages to DEPEND yourself.
114 mgorny 1.51 [[ ${AUTOTOOLS_AUTORECONF} ]] || : ${AUTOTOOLS_AUTO_DEPEND:=no}
115 mgorny 1.32
116 mgorny 1.30 inherit autotools eutils libtool
117 reavertm 1.1
118     EXPORT_FUNCTIONS src_prepare src_configure src_compile src_install src_test
119    
120 mgorny 1.58 # @ECLASS-VARIABLE: BUILD_DIR
121 mgorny 1.30 # @DEFAULT_UNSET
122 reavertm 1.1 # @DESCRIPTION:
123     # Build directory, location where all autotools generated files should be
124     # placed. For out of source builds it defaults to ${WORKDIR}/${P}_build.
125 mgorny 1.58 #
126     # This variable has been called AUTOTOOLS_BUILD_DIR formerly.
127     # It is set under that name for compatibility.
128 reavertm 1.1
129     # @ECLASS-VARIABLE: AUTOTOOLS_IN_SOURCE_BUILD
130 mgorny 1.30 # @DEFAULT_UNSET
131 reavertm 1.1 # @DESCRIPTION:
132     # Set to enable in-source build.
133    
134     # @ECLASS-VARIABLE: ECONF_SOURCE
135 mgorny 1.30 # @DEFAULT_UNSET
136 reavertm 1.1 # @DESCRIPTION:
137     # Specify location of autotools' configure script. By default it uses ${S}.
138    
139     # @ECLASS-VARIABLE: myeconfargs
140 mgorny 1.30 # @DEFAULT_UNSET
141 reavertm 1.1 # @DESCRIPTION:
142     # Optional econf arguments as Bash array. Should be defined before calling src_configure.
143     # @CODE
144     # src_configure() {
145 reavertm 1.7 # local myeconfargs=(
146 reavertm 1.1 # --disable-readline
147     # --with-confdir="/etc/nasty foo confdir/"
148     # $(use_enable debug cnddebug)
149     # $(use_enable threads multithreading)
150     # )
151     # autotools-utils_src_configure
152     # }
153     # @CODE
154    
155 mgorny 1.30 # @ECLASS-VARIABLE: DOCS
156     # @DEFAULT_UNSET
157     # @DESCRIPTION:
158     # Array containing documents passed to dodoc command.
159     #
160     # Example:
161     # @CODE
162     # DOCS=( NEWS README )
163     # @CODE
164    
165     # @ECLASS-VARIABLE: HTML_DOCS
166     # @DEFAULT_UNSET
167     # @DESCRIPTION:
168     # Array containing documents passed to dohtml command.
169     #
170     # Example:
171     # @CODE
172     # HTML_DOCS=( doc/html/ )
173     # @CODE
174    
175     # @ECLASS-VARIABLE: PATCHES
176     # @DEFAULT_UNSET
177     # @DESCRIPTION:
178     # PATCHES array variable containing all various patches to be applied.
179     #
180     # Example:
181     # @CODE
182     # PATCHES=( "${FILESDIR}"/${P}-mypatch.patch )
183     # @CODE
184    
185 reavertm 1.1 # Determine using IN or OUT source build
186     _check_build_dir() {
187     : ${ECONF_SOURCE:=${S}}
188     if [[ -n ${AUTOTOOLS_IN_SOURCE_BUILD} ]]; then
189 mgorny 1.58 BUILD_DIR="${ECONF_SOURCE}"
190 reavertm 1.1 else
191 mgorny 1.59 # Respect both the old variable and the new one, depending
192     # on which one was set by the ebuild.
193     if [[ ! ${BUILD_DIR} && ${AUTOTOOLS_BUILD_DIR} ]]; then
194     eqawarn "The AUTOTOOLS_BUILD_DIR variable has been renamed to BUILD_DIR."
195     eqawarn "Please migrate the ebuild to use the new one."
196    
197     # In the next call, both variables will be set already
198     # and we'd have to know which one takes precedence.
199     _RESPECT_AUTOTOOLS_BUILD_DIR=1
200     fi
201 mgorny 1.60
202 mgorny 1.59 if [[ ${_RESPECT_AUTOTOOLS_BUILD_DIR} ]]; then
203 mgorny 1.60 BUILD_DIR=${AUTOTOOLS_BUILD_DIR:-${WORKDIR}/${P}_build}
204     else
205     : ${BUILD_DIR:=${WORKDIR}/${P}_build}
206 mgorny 1.59 fi
207 reavertm 1.1 fi
208 mgorny 1.58
209 mgorny 1.59 # Backwards compatibility for getting the value.
210 mgorny 1.58 AUTOTOOLS_BUILD_DIR=${BUILD_DIR}
211     echo ">>> Working in BUILD_DIR: \"${BUILD_DIR}\""
212 reavertm 1.1 }
213    
214     # @FUNCTION: remove_libtool_files
215 mgorny 1.14 # @USAGE: [all]
216 reavertm 1.1 # @DESCRIPTION:
217     # Determines unnecessary libtool files (.la) and libtool static archives (.a)
218     # and removes them from installation image.
219 mgorny 1.14 #
220 reavertm 1.1 # To unconditionally remove all libtool files, pass 'all' as argument.
221 mgorny 1.14 # Otherwise, libtool archives required for static linking will be preserved.
222 reavertm 1.1 #
223     # In most cases it's not necessary to manually invoke this function.
224     # See autotools-utils_src_install for reference.
225     remove_libtool_files() {
226     debug-print-function ${FUNCNAME} "$@"
227 mgorny 1.16 local removing_all
228 mgorny 1.54
229     eqawarn "The remove_libtool_files() function was deprecated."
230     eqawarn "Please use prune_libtool_files() from eutils eclass instead."
231    
232 mgorny 1.16 [[ ${#} -le 1 ]] || die "Invalid number of args to ${FUNCNAME}()"
233     if [[ ${#} -eq 1 ]]; then
234     case "${1}" in
235     all)
236     removing_all=1
237     ;;
238     *)
239     die "Invalid argument to ${FUNCNAME}(): ${1}"
240     esac
241     fi
242 reavertm 1.1
243 mgorny 1.19 local pc_libs=()
244     if [[ ! ${removing_all} ]]; then
245     local arg
246     for arg in $(find "${D}" -name '*.pc' -exec \
247     sed -n -e 's;^Libs:;;p' {} +); do
248     [[ ${arg} == -l* ]] && pc_libs+=(lib${arg#-l}.la)
249     done
250     fi
251    
252 reavertm 1.1 local f
253 mgorny 1.12 find "${D}" -type f -name '*.la' -print0 | while read -r -d '' f; do
254 reavertm 1.1 local shouldnotlink=$(sed -ne '/^shouldnotlink=yes$/p' "${f}")
255 mgorny 1.14 local archivefile=${f/%.la/.a}
256 mgorny 1.15 [[ "${f}" != "${archivefile}" ]] || die 'regex sanity check failed'
257 mgorny 1.14
258 mgorny 1.18 # Remove static libs we're not supposed to link against.
259 mgorny 1.17 if [[ ${shouldnotlink} ]]; then
260     einfo "Removing unnecessary ${archivefile#${D%/}}"
261     rm -f "${archivefile}" || die
262 mgorny 1.18 # The .la file may be used by a module loader, so avoid removing it
263     # unless explicitly requested.
264 mgorny 1.17 [[ ${removing_all} ]] || continue
265     fi
266    
267 mgorny 1.18 # Remove .la files when:
268     # - user explicitly wants us to remove all .la files,
269     # - respective static archive doesn't exist,
270 mgorny 1.19 # - they are covered by a .pc file already,
271 mgorny 1.18 # - they don't provide any new information (no libs & no flags).
272     local removing
273 mgorny 1.20 if [[ ${removing_all} ]]; then removing='forced'
274     elif [[ ! -f ${archivefile} ]]; then removing='no static archive'
275     elif has "$(basename "${f}")" "${pc_libs[@]}"; then
276     removing='covered by .pc'
277 mgorny 1.18 elif [[ ! $(sed -n -e \
278     "s/^\(dependency_libs\|inherited_linker_flags\)='\(.*\)'$/\2/p" \
279 mgorny 1.20 "${f}") ]]; then removing='no libs & flags'
280 mgorny 1.18 fi
281    
282     if [[ ${removing} ]]; then
283 mgorny 1.20 einfo "Removing unnecessary ${f#${D%/}} (${removing})"
284 mgorny 1.15 rm -f "${f}" || die
285 reavertm 1.1 fi
286     done
287     }
288    
289 mgorny 1.32 # @FUNCTION: autotools-utils_autoreconf
290     # @DESCRIPTION:
291     # Reconfigure the sources (like gnome-autogen.sh or eautoreconf).
292     autotools-utils_autoreconf() {
293     debug-print-function ${FUNCNAME} "$@"
294    
295 mgorny 1.55 eqawarn "The autotools-utils_autoreconf() function was deprecated."
296     eqawarn "Please call autotools-utils_src_prepare()"
297     eqawarn "with AUTOTOOLS_AUTORECONF set instead."
298    
299 mgorny 1.32 # Override this func to not require unnecessary eaclocal calls.
300     autotools_check_macro() {
301     local x
302    
303     # Add a few additional variants as we don't get expansions.
304 mgorny 1.44 [[ ${1} = AC_CONFIG_HEADERS ]] && set -- "${@}" \
305     AC_CONFIG_HEADER AM_CONFIG_HEADER
306 mgorny 1.32
307     for x; do
308     grep -h "^${x}" configure.{ac,in} 2>/dev/null
309     done
310     }
311    
312     einfo "Autoreconfiguring '${PWD}' ..."
313    
314     local auxdir=$(sed -n -e 's/^AC_CONFIG_AUX_DIR(\(.*\))$/\1/p' \
315     configure.{ac,in} 2>/dev/null)
316     if [[ ${auxdir} ]]; then
317     auxdir=${auxdir%%]}
318     mkdir -p ${auxdir##[}
319     fi
320    
321     # Support running additional tools like gnome-autogen.sh.
322     # Note: you need to add additional depends to the ebuild.
323    
324     # gettext
325     if [[ $(autotools_check_macro AM_GLIB_GNU_GETTEXT) ]]; then
326 jlec 1.46 echo 'no' | autotools_run_tool glib-gettextize --copy --force
327 mgorny 1.32 elif [[ $(autotools_check_macro AM_GNU_GETTEXT) ]]; then
328 mgorny 1.38 eautopoint --force
329 mgorny 1.32 fi
330    
331     # intltool
332     if [[ $(autotools_check_macro AC_PROG_INTLTOOL IT_PROG_INTLTOOL) ]]
333     then
334 mgorny 1.38 autotools_run_tool intltoolize --copy --automake --force
335 mgorny 1.32 fi
336    
337     # gtk-doc
338     if [[ $(autotools_check_macro GTK_DOC_CHECK) ]]; then
339     autotools_run_tool gtkdocize --copy
340     fi
341    
342     # gnome-doc
343     if [[ $(autotools_check_macro GNOME_DOC_INIT) ]]; then
344 mgorny 1.38 autotools_run_tool gnome-doc-prepare --copy --force
345 mgorny 1.32 fi
346    
347     if [[ $(autotools_check_macro AC_PROG_LIBTOOL AM_PROG_LIBTOOL LT_INIT) ]]
348     then
349     _elibtoolize --copy --force --install
350     fi
351    
352 mgorny 1.50 eaclocal
353 mgorny 1.32 eautoconf
354     eautoheader
355 mgorny 1.36 FROM_EAUTORECONF=sure eautomake
356 mgorny 1.32
357     local x
358 mgorny 1.49 for x in $(autotools_check_macro_val AC_CONFIG_SUBDIRS); do
359 mgorny 1.32 if [[ -d ${x} ]] ; then
360 mgorny 1.52 pushd "${x}" >/dev/null || die
361 mgorny 1.48 autotools-utils_autoreconf
362 mgorny 1.52 popd >/dev/null || die
363 mgorny 1.32 fi
364     done
365     }
366    
367 reavertm 1.1 # @FUNCTION: autotools-utils_src_prepare
368     # @DESCRIPTION:
369     # The src_prepare function.
370     #
371     # Supporting PATCHES array and user patches. See base.eclass(5) for reference.
372     autotools-utils_src_prepare() {
373     debug-print-function ${FUNCNAME} "$@"
374    
375 mgorny 1.32 local want_autoreconf=${AUTOTOOLS_AUTORECONF}
376    
377 mgorny 1.45 [[ ${PATCHES} ]] && epatch "${PATCHES[@]}"
378    
379 mgorny 1.47 at_checksum() {
380     find '(' -name 'Makefile.am' \
381     -o -name 'configure.ac' \
382     -o -name 'configure.in' ')' \
383     -exec cksum {} + | sort -k2
384     }
385    
386     [[ ! ${want_autoreconf} ]] && local checksum=$(at_checksum)
387 mgorny 1.30 epatch_user
388 mgorny 1.37 if [[ ! ${want_autoreconf} ]]; then
389 mgorny 1.47 if [[ ${checksum} != $(at_checksum) ]]; then
390 mgorny 1.45 einfo 'Will autoreconfigure due to user patches applied.'
391 mgorny 1.37 want_autoreconf=yep
392     fi
393     fi
394 mgorny 1.30
395 mgorny 1.55 [[ ${want_autoreconf} ]] && eautoreconf
396 mgorny 1.25 elibtoolize --patch-only
397 reavertm 1.1 }
398    
399     # @FUNCTION: autotools-utils_src_configure
400     # @DESCRIPTION:
401     # The src_configure function. For out of source build it creates build
402     # directory and runs econf there. Configuration parameters defined
403     # in myeconfargs are passed here to econf. Additionally following USE
404     # flags are known:
405     #
406     # IUSE="static-libs" passes --enable-shared and either --disable-static/--enable-static
407     # to econf respectively.
408     autotools-utils_src_configure() {
409     debug-print-function ${FUNCNAME} "$@"
410    
411 mgorny 1.22 [[ -z ${myeconfargs+1} || $(declare -p myeconfargs) == 'declare -a'* ]] \
412     || die 'autotools-utils.eclass: myeconfargs has to be an array.'
413    
414 mgorny 1.35 [[ ${EAPI} == 2 ]] && ! use prefix && EPREFIX=
415    
416 reavertm 1.1 # Common args
417 mgorny 1.41 local econfargs=()
418    
419     _check_build_dir
420 mgorny 1.43 if "${ECONF_SOURCE}"/configure --help 2>&1 | grep -q '^ *--docdir='; then
421 mgorny 1.41 econfargs+=(
422     --docdir="${EPREFIX}"/usr/share/doc/${PF}
423     )
424     fi
425 reavertm 1.1
426     # Handle static-libs found in IUSE, disable them by default
427 mgorny 1.24 if in_iuse static-libs; then
428 reavertm 1.1 econfargs+=(
429     --enable-shared
430     $(use_enable static-libs static)
431     )
432     fi
433    
434     # Append user args
435 reavertm 1.5 econfargs+=("${myeconfargs[@]}")
436 reavertm 1.1
437 mgorny 1.58 mkdir -p "${BUILD_DIR}" || die
438     pushd "${BUILD_DIR}" > /dev/null || die
439 mgorny 1.30 econf "${econfargs[@]}" "$@"
440 mgorny 1.52 popd > /dev/null || die
441 reavertm 1.1 }
442    
443     # @FUNCTION: autotools-utils_src_compile
444     # @DESCRIPTION:
445 mgorny 1.58 # The autotools src_compile function, invokes emake in specified BUILD_DIR.
446 reavertm 1.1 autotools-utils_src_compile() {
447     debug-print-function ${FUNCNAME} "$@"
448    
449     _check_build_dir
450 mgorny 1.58 pushd "${BUILD_DIR}" > /dev/null || die
451 mgorny 1.30 emake "$@" || die 'emake failed'
452 mgorny 1.52 popd > /dev/null || die
453 reavertm 1.1 }
454    
455     # @FUNCTION: autotools-utils_src_install
456     # @DESCRIPTION:
457     # The autotools src_install function. Runs emake install, unconditionally
458     # removes unnecessary static libs (based on shouldnotlink libtool property)
459     # and removes unnecessary libtool files when static-libs USE flag is defined
460     # and unset.
461     #
462     # DOCS and HTML_DOCS arrays are supported. See base.eclass(5) for reference.
463     autotools-utils_src_install() {
464     debug-print-function ${FUNCNAME} "$@"
465    
466     _check_build_dir
467 mgorny 1.58 pushd "${BUILD_DIR}" > /dev/null || die
468 mgorny 1.30 emake DESTDIR="${D}" "$@" install || die "emake install failed"
469 mgorny 1.52 popd > /dev/null || die
470 reavertm 1.1
471 mgorny 1.35 # Move docs installed by autotools (in EAPI < 4).
472 mgorny 1.40 if [[ ${EAPI} == [23] ]] \
473     && path_exists "${D}${EPREFIX}"/usr/share/doc/${PF}/*; then
474 mgorny 1.39 if [[ $(find "${D}${EPREFIX}"/usr/share/doc/${PF}/* -type d) ]]; then
475     eqawarn "autotools-utils: directories in docdir require at least EAPI 4"
476     else
477     mkdir "${T}"/temp-docdir
478     mv "${D}${EPREFIX}"/usr/share/doc/${PF}/* "${T}"/temp-docdir/ \
479     || die "moving docs to tempdir failed"
480 mgorny 1.35
481 mgorny 1.39 dodoc "${T}"/temp-docdir/* || die "docdir dodoc failed"
482     rm -r "${T}"/temp-docdir || die
483     fi
484 mgorny 1.35 fi
485    
486 mgorny 1.30 # XXX: support installing them from builddir as well?
487     if [[ ${DOCS} ]]; then
488     dodoc "${DOCS[@]}" || die "dodoc failed"
489 mgorny 1.34 else
490     local f
491     # same list as in PMS
492     for f in README* ChangeLog AUTHORS NEWS TODO CHANGES \
493     THANKS BUGS FAQ CREDITS CHANGELOG; do
494     if [[ -s ${f} ]]; then
495     dodoc "${f}" || die "(default) dodoc ${f} failed"
496     fi
497     done
498 mgorny 1.30 fi
499     if [[ ${HTML_DOCS} ]]; then
500     dohtml -r "${HTML_DOCS[@]}" || die "dohtml failed"
501     fi
502    
503 reavertm 1.1 # Remove libtool files and unnecessary static libs
504 mgorny 1.54 prune_libtool_files
505 reavertm 1.1 }
506    
507     # @FUNCTION: autotools-utils_src_test
508     # @DESCRIPTION:
509     # The autotools src_test function. Runs emake check in build directory.
510     autotools-utils_src_test() {
511     debug-print-function ${FUNCNAME} "$@"
512    
513     _check_build_dir
514 mgorny 1.58 pushd "${BUILD_DIR}" > /dev/null || die
515 reavertm 1.1 # Run default src_test as defined in ebuild.sh
516     default_src_test
517 mgorny 1.52 popd > /dev/null || die
518 reavertm 1.1 }

  ViewVC Help
Powered by ViewVC 1.1.20