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

Contents of /eclass/autotools-utils.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.50 - (hide annotations) (download)
Tue May 22 14:29:06 2012 UTC (2 years, 2 months ago) by mgorny
Branch: MAIN
Changes since 1.49: +2 -5 lines
Call eaclocal unconditionally; _elibtoolize no longer does that.

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.50 # $Header: /var/cvsroot/gentoo-x86/eclass/autotools-utils.eclass,v 1.49 2012/05/21 17:34:53 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     # Please note note that autotools-utils does not support mixing of its phase
17     # 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     # use doc && HTML_DOCS=("${AUTOTOOLS_BUILD_DIR}/apidocs/html/")
80     # autotools-utils_src_install
81     # if use examples; then
82     # dobin "${AUTOTOOLS_BUILD_DIR}"/foo_example{1,2,3} \\
83     # || 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 scarabeus 1.8 2|3|4) ;;
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     [[ ${AUTOTOOLS_AUTORECONF} ]] || _autotools_auto_dep=no
115    
116     AUTOTOOLS_AUTO_DEPEND=${_autotools_auto_dep} \
117 mgorny 1.30 inherit autotools eutils libtool
118 reavertm 1.1
119     EXPORT_FUNCTIONS src_prepare src_configure src_compile src_install src_test
120    
121 mgorny 1.32 unset _autotools_auto_dep
122    
123 reavertm 1.1 # @ECLASS-VARIABLE: AUTOTOOLS_BUILD_DIR
124 mgorny 1.30 # @DEFAULT_UNSET
125 reavertm 1.1 # @DESCRIPTION:
126     # Build directory, location where all autotools generated files should be
127     # placed. For out of source builds it defaults to ${WORKDIR}/${P}_build.
128    
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     AUTOTOOLS_BUILD_DIR="${ECONF_SOURCE}"
190     else
191     : ${AUTOTOOLS_BUILD_DIR:=${WORKDIR}/${P}_build}
192     fi
193     echo ">>> Working in BUILD_DIR: \"$AUTOTOOLS_BUILD_DIR\""
194     }
195    
196     # @FUNCTION: remove_libtool_files
197 mgorny 1.14 # @USAGE: [all]
198 reavertm 1.1 # @DESCRIPTION:
199     # Determines unnecessary libtool files (.la) and libtool static archives (.a)
200     # and removes them from installation image.
201 mgorny 1.14 #
202 reavertm 1.1 # To unconditionally remove all libtool files, pass 'all' as argument.
203 mgorny 1.14 # Otherwise, libtool archives required for static linking will be preserved.
204 reavertm 1.1 #
205     # In most cases it's not necessary to manually invoke this function.
206     # See autotools-utils_src_install for reference.
207     remove_libtool_files() {
208     debug-print-function ${FUNCNAME} "$@"
209 mgorny 1.16 local removing_all
210     [[ ${#} -le 1 ]] || die "Invalid number of args to ${FUNCNAME}()"
211     if [[ ${#} -eq 1 ]]; then
212     case "${1}" in
213     all)
214     removing_all=1
215     ;;
216     *)
217     die "Invalid argument to ${FUNCNAME}(): ${1}"
218     esac
219     fi
220 reavertm 1.1
221 mgorny 1.19 local pc_libs=()
222     if [[ ! ${removing_all} ]]; then
223     local arg
224     for arg in $(find "${D}" -name '*.pc' -exec \
225     sed -n -e 's;^Libs:;;p' {} +); do
226     [[ ${arg} == -l* ]] && pc_libs+=(lib${arg#-l}.la)
227     done
228     fi
229    
230 reavertm 1.1 local f
231 mgorny 1.12 find "${D}" -type f -name '*.la' -print0 | while read -r -d '' f; do
232 reavertm 1.1 local shouldnotlink=$(sed -ne '/^shouldnotlink=yes$/p' "${f}")
233 mgorny 1.14 local archivefile=${f/%.la/.a}
234 mgorny 1.15 [[ "${f}" != "${archivefile}" ]] || die 'regex sanity check failed'
235 mgorny 1.14
236 mgorny 1.18 # Remove static libs we're not supposed to link against.
237 mgorny 1.17 if [[ ${shouldnotlink} ]]; then
238     einfo "Removing unnecessary ${archivefile#${D%/}}"
239     rm -f "${archivefile}" || die
240 mgorny 1.18 # The .la file may be used by a module loader, so avoid removing it
241     # unless explicitly requested.
242 mgorny 1.17 [[ ${removing_all} ]] || continue
243     fi
244    
245 mgorny 1.18 # Remove .la files when:
246     # - user explicitly wants us to remove all .la files,
247     # - respective static archive doesn't exist,
248 mgorny 1.19 # - they are covered by a .pc file already,
249 mgorny 1.18 # - they don't provide any new information (no libs & no flags).
250     local removing
251 mgorny 1.20 if [[ ${removing_all} ]]; then removing='forced'
252     elif [[ ! -f ${archivefile} ]]; then removing='no static archive'
253     elif has "$(basename "${f}")" "${pc_libs[@]}"; then
254     removing='covered by .pc'
255 mgorny 1.18 elif [[ ! $(sed -n -e \
256     "s/^\(dependency_libs\|inherited_linker_flags\)='\(.*\)'$/\2/p" \
257 mgorny 1.20 "${f}") ]]; then removing='no libs & flags'
258 mgorny 1.18 fi
259    
260     if [[ ${removing} ]]; then
261 mgorny 1.20 einfo "Removing unnecessary ${f#${D%/}} (${removing})"
262 mgorny 1.15 rm -f "${f}" || die
263 reavertm 1.1 fi
264     done
265 mgorny 1.29
266     # check for invalid eclass use
267     # this is the most commonly used function, so do it here
268     _check_build_dir
269     if [[ ! -d "${AUTOTOOLS_BUILD_DIR}" ]]; then
270     eqawarn "autotools-utils used but autotools-utils_src_configure was never called."
271     eqawarn "This is not supported and never was. Please report a bug against"
272     eqawarn "the offending ebuild. This will become a fatal error in a near future."
273     fi
274 reavertm 1.1 }
275    
276 mgorny 1.32 # @FUNCTION: autotools-utils_autoreconf
277     # @DESCRIPTION:
278     # Reconfigure the sources (like gnome-autogen.sh or eautoreconf).
279     autotools-utils_autoreconf() {
280     debug-print-function ${FUNCNAME} "$@"
281    
282     # Override this func to not require unnecessary eaclocal calls.
283     autotools_check_macro() {
284     local x
285    
286     # Add a few additional variants as we don't get expansions.
287 mgorny 1.44 [[ ${1} = AC_CONFIG_HEADERS ]] && set -- "${@}" \
288     AC_CONFIG_HEADER AM_CONFIG_HEADER
289 mgorny 1.32
290     for x; do
291     grep -h "^${x}" configure.{ac,in} 2>/dev/null
292     done
293     }
294    
295     einfo "Autoreconfiguring '${PWD}' ..."
296    
297     local auxdir=$(sed -n -e 's/^AC_CONFIG_AUX_DIR(\(.*\))$/\1/p' \
298     configure.{ac,in} 2>/dev/null)
299     if [[ ${auxdir} ]]; then
300     auxdir=${auxdir%%]}
301     mkdir -p ${auxdir##[}
302     fi
303    
304     # Support running additional tools like gnome-autogen.sh.
305     # Note: you need to add additional depends to the ebuild.
306    
307     # gettext
308     if [[ $(autotools_check_macro AM_GLIB_GNU_GETTEXT) ]]; then
309 jlec 1.46 echo 'no' | autotools_run_tool glib-gettextize --copy --force
310 mgorny 1.32 elif [[ $(autotools_check_macro AM_GNU_GETTEXT) ]]; then
311 mgorny 1.38 eautopoint --force
312 mgorny 1.32 fi
313    
314     # intltool
315     if [[ $(autotools_check_macro AC_PROG_INTLTOOL IT_PROG_INTLTOOL) ]]
316     then
317 mgorny 1.38 autotools_run_tool intltoolize --copy --automake --force
318 mgorny 1.32 fi
319    
320     # gtk-doc
321     if [[ $(autotools_check_macro GTK_DOC_CHECK) ]]; then
322     autotools_run_tool gtkdocize --copy
323     fi
324    
325     # gnome-doc
326     if [[ $(autotools_check_macro GNOME_DOC_INIT) ]]; then
327 mgorny 1.38 autotools_run_tool gnome-doc-prepare --copy --force
328 mgorny 1.32 fi
329    
330     if [[ $(autotools_check_macro AC_PROG_LIBTOOL AM_PROG_LIBTOOL LT_INIT) ]]
331     then
332     _elibtoolize --copy --force --install
333     fi
334    
335 mgorny 1.50 eaclocal
336 mgorny 1.32 eautoconf
337     eautoheader
338 mgorny 1.36 FROM_EAUTORECONF=sure eautomake
339 mgorny 1.32
340     local x
341 mgorny 1.49 for x in $(autotools_check_macro_val AC_CONFIG_SUBDIRS); do
342 mgorny 1.32 if [[ -d ${x} ]] ; then
343     pushd "${x}" >/dev/null
344 mgorny 1.48 autotools-utils_autoreconf
345 mgorny 1.32 popd >/dev/null
346     fi
347     done
348     }
349    
350 reavertm 1.1 # @FUNCTION: autotools-utils_src_prepare
351     # @DESCRIPTION:
352     # The src_prepare function.
353     #
354     # Supporting PATCHES array and user patches. See base.eclass(5) for reference.
355     autotools-utils_src_prepare() {
356     debug-print-function ${FUNCNAME} "$@"
357    
358 mgorny 1.32 local want_autoreconf=${AUTOTOOLS_AUTORECONF}
359    
360 mgorny 1.45 [[ ${PATCHES} ]] && epatch "${PATCHES[@]}"
361    
362 mgorny 1.47 at_checksum() {
363     find '(' -name 'Makefile.am' \
364     -o -name 'configure.ac' \
365     -o -name 'configure.in' ')' \
366     -exec cksum {} + | sort -k2
367     }
368    
369     [[ ! ${want_autoreconf} ]] && local checksum=$(at_checksum)
370 mgorny 1.30 epatch_user
371 mgorny 1.37 if [[ ! ${want_autoreconf} ]]; then
372 mgorny 1.47 if [[ ${checksum} != $(at_checksum) ]]; then
373 mgorny 1.45 einfo 'Will autoreconfigure due to user patches applied.'
374 mgorny 1.37 want_autoreconf=yep
375     fi
376     fi
377 mgorny 1.30
378 mgorny 1.32 [[ ${want_autoreconf} ]] && autotools-utils_autoreconf
379 mgorny 1.25 elibtoolize --patch-only
380 reavertm 1.1 }
381    
382     # @FUNCTION: autotools-utils_src_configure
383     # @DESCRIPTION:
384     # The src_configure function. For out of source build it creates build
385     # directory and runs econf there. Configuration parameters defined
386     # in myeconfargs are passed here to econf. Additionally following USE
387     # flags are known:
388     #
389     # IUSE="static-libs" passes --enable-shared and either --disable-static/--enable-static
390     # to econf respectively.
391     autotools-utils_src_configure() {
392     debug-print-function ${FUNCNAME} "$@"
393    
394 mgorny 1.22 [[ -z ${myeconfargs+1} || $(declare -p myeconfargs) == 'declare -a'* ]] \
395     || die 'autotools-utils.eclass: myeconfargs has to be an array.'
396    
397 mgorny 1.35 [[ ${EAPI} == 2 ]] && ! use prefix && EPREFIX=
398    
399 reavertm 1.1 # Common args
400 mgorny 1.41 local econfargs=()
401    
402     _check_build_dir
403 mgorny 1.43 if "${ECONF_SOURCE}"/configure --help 2>&1 | grep -q '^ *--docdir='; then
404 mgorny 1.41 econfargs+=(
405     --docdir="${EPREFIX}"/usr/share/doc/${PF}
406     )
407     fi
408 reavertm 1.1
409     # Handle static-libs found in IUSE, disable them by default
410 mgorny 1.24 if in_iuse static-libs; then
411 reavertm 1.1 econfargs+=(
412     --enable-shared
413     $(use_enable static-libs static)
414     )
415     fi
416    
417     # Append user args
418 reavertm 1.5 econfargs+=("${myeconfargs[@]}")
419 reavertm 1.1
420     mkdir -p "${AUTOTOOLS_BUILD_DIR}" || die "mkdir '${AUTOTOOLS_BUILD_DIR}' failed"
421 mgorny 1.29 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null
422 mgorny 1.30 econf "${econfargs[@]}" "$@"
423 mgorny 1.29 popd > /dev/null
424 reavertm 1.1 }
425    
426     # @FUNCTION: autotools-utils_src_compile
427     # @DESCRIPTION:
428     # The autotools src_compile function, invokes emake in specified AUTOTOOLS_BUILD_DIR.
429     autotools-utils_src_compile() {
430     debug-print-function ${FUNCNAME} "$@"
431    
432     _check_build_dir
433 mgorny 1.29 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null
434 mgorny 1.30 emake "$@" || die 'emake failed'
435 mgorny 1.29 popd > /dev/null
436 reavertm 1.1 }
437    
438     # @FUNCTION: autotools-utils_src_install
439     # @DESCRIPTION:
440     # The autotools src_install function. Runs emake install, unconditionally
441     # removes unnecessary static libs (based on shouldnotlink libtool property)
442     # and removes unnecessary libtool files when static-libs USE flag is defined
443     # and unset.
444     #
445     # DOCS and HTML_DOCS arrays are supported. See base.eclass(5) for reference.
446     autotools-utils_src_install() {
447     debug-print-function ${FUNCNAME} "$@"
448    
449     _check_build_dir
450 mgorny 1.29 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null
451 mgorny 1.30 emake DESTDIR="${D}" "$@" install || die "emake install failed"
452 mgorny 1.29 popd > /dev/null
453 reavertm 1.1
454 mgorny 1.35 # Move docs installed by autotools (in EAPI < 4).
455 mgorny 1.40 if [[ ${EAPI} == [23] ]] \
456     && path_exists "${D}${EPREFIX}"/usr/share/doc/${PF}/*; then
457 mgorny 1.39 if [[ $(find "${D}${EPREFIX}"/usr/share/doc/${PF}/* -type d) ]]; then
458     eqawarn "autotools-utils: directories in docdir require at least EAPI 4"
459     else
460     mkdir "${T}"/temp-docdir
461     mv "${D}${EPREFIX}"/usr/share/doc/${PF}/* "${T}"/temp-docdir/ \
462     || die "moving docs to tempdir failed"
463 mgorny 1.35
464 mgorny 1.39 dodoc "${T}"/temp-docdir/* || die "docdir dodoc failed"
465     rm -r "${T}"/temp-docdir || die
466     fi
467 mgorny 1.35 fi
468    
469 mgorny 1.30 # XXX: support installing them from builddir as well?
470     if [[ ${DOCS} ]]; then
471     dodoc "${DOCS[@]}" || die "dodoc failed"
472 mgorny 1.34 else
473     local f
474     # same list as in PMS
475     for f in README* ChangeLog AUTHORS NEWS TODO CHANGES \
476     THANKS BUGS FAQ CREDITS CHANGELOG; do
477     if [[ -s ${f} ]]; then
478     dodoc "${f}" || die "(default) dodoc ${f} failed"
479     fi
480     done
481 mgorny 1.30 fi
482     if [[ ${HTML_DOCS} ]]; then
483     dohtml -r "${HTML_DOCS[@]}" || die "dohtml failed"
484     fi
485    
486 reavertm 1.1 # Remove libtool files and unnecessary static libs
487 mgorny 1.14 remove_libtool_files
488 reavertm 1.1 }
489    
490     # @FUNCTION: autotools-utils_src_test
491     # @DESCRIPTION:
492     # The autotools src_test function. Runs emake check in build directory.
493     autotools-utils_src_test() {
494     debug-print-function ${FUNCNAME} "$@"
495    
496     _check_build_dir
497 mgorny 1.29 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null
498 reavertm 1.1 # Run default src_test as defined in ebuild.sh
499     default_src_test
500 mgorny 1.29 popd > /dev/null
501 reavertm 1.1 }

  ViewVC Help
Powered by ViewVC 1.1.20