1 # Copyright 1999-2015 Gentoo Foundation
2 # Distributed under the terms of the GNU General Public License v2
5 # @ECLASS: autotools-utils.eclass
7 # Maciej Mrozowski <reavertm@gentoo.org>
8 # Michał Górny <mgorny@gentoo.org>
9 # @BLURB: common ebuild functions for autotools-based packages
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 # handling, libtool files removal.
16 # Please 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.
21 # Typical ebuild using autotools-utils.eclass:
26 # inherit autotools-utils
28 # DESCRIPTION="Foo bar application"
29 # HOMEPAGE="http://example.org/foo/"
30 # SRC_URI="mirror://sourceforge/foo/${P}.tar.bz2"
35 # IUSE="debug doc examples qt4 static-libs tiff"
43 # tiff? ( media-libs/tiff:0 )
49 # doc? ( app-doc/doxygen )
53 # AUTOTOOLS_IN_SOURCE_BUILD=1
55 # DOCS=(AUTHORS ChangeLog README "Read me.txt" TODO)
58 # "${FILESDIR}/${P}-gcc44.patch" # bug 123458
59 # "${FILESDIR}/${P}-as-needed.patch"
60 # "${FILESDIR}/${P}-unbundle_libpng.patch"
67 # $(use_enable threads multithreading)
70 # autotools-utils_src_configure
74 # autotools-utils_src_compile
75 # use doc && autotools-utils_src_compile docs
79 # use doc && HTML_DOCS=("${BUILD_DIR}/apidocs/html/")
80 # autotools-utils_src_install
81 # if use examples; then
82 # dobin "${BUILD_DIR}"/foo_example{1,2,3} \\
83 # || die 'dobin examples failed'
89 # Keep variable names synced with cmake-utils and the other way around!
93 *) die "EAPI=${EAPI} is not supported" ;;
96 # @ECLASS-VARIABLE: AUTOTOOLS_AUTORECONF
99 # Set to a non-empty value before calling inherit to enable running autoreconf
100 # in src_prepare() and adding autotools dependencies.
102 # 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).
107 # 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.
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_DEPEND:=no}
116 inherit autotools eutils libtool
118 EXPORT_FUNCTIONS src_prepare src_configure src_compile src_install src_test
120 # @ECLASS-VARIABLE: BUILD_DIR
123 # Build directory, location where all autotools generated files should be
124 # placed. For out of source builds it defaults to ${WORKDIR}/${P}_build.
126 # This variable has been called AUTOTOOLS_BUILD_DIR formerly.
127 # It is set under that name for compatibility.
129 # @ECLASS-VARIABLE: AUTOTOOLS_IN_SOURCE_BUILD
132 # Set to enable in-source build.
134 # @ECLASS-VARIABLE: ECONF_SOURCE
137 # Specify location of autotools' configure script. By default it uses ${S}.
139 # @ECLASS-VARIABLE: DOCS
142 # Array containing documents passed to dodoc command.
144 # In EAPIs 4+, can list directories as well.
148 # DOCS=( NEWS README )
151 # @ECLASS-VARIABLE: HTML_DOCS
154 # Array containing documents passed to dohtml command.
158 # HTML_DOCS=( doc/html/ )
161 # @ECLASS-VARIABLE: PATCHES
164 # PATCHES array variable containing all various patches to be applied.
168 # PATCHES=( "${FILESDIR}"/${P}-mypatch.patch )
171 # @ECLASS-VARIABLE: AUTOTOOLS_PRUNE_LIBTOOL_FILES
174 # Sets the mode of pruning libtool files. The values correspond to
175 # prune_libtool_files parameters, with leading dashes stripped.
177 # Defaults to pruning the libtool files when static libraries are not
178 # installed or can be linked properly without them. Libtool files
179 # for modules (plugins) will be kept in case plugin loader needs them.
181 # If set to 'modules', the .la files for modules will be removed
182 # as well. This is often the preferred option.
184 # If set to 'all', all .la files will be removed unconditionally. This
185 # option is discouraged and shall be used only if 'modules' does not
188 # If set to 'none', no .la files will be pruned ever. Use in corner
191 # Determine using IN or OUT source build
193 : ${ECONF_SOURCE:=${S}}
194 # Respect both the old variable and the new one, depending
195 # on which one was set by the ebuild.
196 if [[ ! ${BUILD_DIR} && ${AUTOTOOLS_BUILD_DIR} ]]; then
197 eqawarn "The AUTOTOOLS_BUILD_DIR variable has been renamed to BUILD_DIR."
198 eqawarn "Please migrate the ebuild to use the new one."
200 # In the next call, both variables will be set already
201 # and we'd have to know which one takes precedence.
202 _RESPECT_AUTOTOOLS_BUILD_DIR=1
205 if [[ ${_RESPECT_AUTOTOOLS_BUILD_DIR} ]]; then
206 BUILD_DIR=${AUTOTOOLS_BUILD_DIR:-${WORKDIR}/${P}_build}
208 if [[ -n ${AUTOTOOLS_IN_SOURCE_BUILD} ]]; then
209 : ${BUILD_DIR:=${ECONF_SOURCE}}
211 : ${BUILD_DIR:=${WORKDIR}/${P}_build}
215 # Backwards compatibility for getting the value.
216 AUTOTOOLS_BUILD_DIR=${BUILD_DIR}
217 echo ">>> Working in BUILD_DIR: \"${BUILD_DIR}\""
220 # @FUNCTION: autotools-utils_src_prepare
222 # The src_prepare function.
224 # Supporting PATCHES array and user patches. See base.eclass(5) for reference.
225 autotools-utils_src_prepare() {
226 debug-print-function ${FUNCNAME} "$@"
228 local want_autoreconf=${AUTOTOOLS_AUTORECONF}
230 [[ ${PATCHES} ]] && epatch "${PATCHES[@]}"
233 find '(' -name 'Makefile.am' \
234 -o -name 'configure.ac' \
235 -o -name 'configure.in' ')' \
236 -exec cksum {} + | sort -k2
239 [[ ! ${want_autoreconf} ]] && local checksum=$(at_checksum)
241 if [[ ! ${want_autoreconf} ]]; then
242 if [[ ${checksum} != $(at_checksum) ]]; then
243 einfo 'Will autoreconfigure due to user patches applied.'
248 [[ ${want_autoreconf} ]] && eautoreconf
249 elibtoolize --patch-only
252 # @FUNCTION: autotools-utils_src_configure
254 # The src_configure function. For out of source build it creates build
255 # directory and runs econf there. Configuration parameters defined
256 # in myeconfargs are passed here to econf. Additionally following USE
259 # IUSE="static-libs" passes --enable-shared and either --disable-static/--enable-static
260 # to econf respectively.
262 # @VARIABLE: myeconfargs
265 # Optional econf arguments as Bash array. Should be defined before calling src_configure.
268 # local myeconfargs=(
270 # --with-confdir="/etc/nasty foo confdir/"
271 # $(use_enable debug cnddebug)
272 # $(use_enable threads multithreading)
274 # autotools-utils_src_configure
277 autotools-utils_src_configure() {
278 debug-print-function ${FUNCNAME} "$@"
280 [[ -z ${myeconfargs+1} || $(declare -p myeconfargs) == 'declare -a'* ]] \
281 || die 'autotools-utils.eclass: myeconfargs has to be an array.'
283 [[ ${EAPI} == 2 ]] && ! use prefix && EPREFIX=
289 if "${ECONF_SOURCE}"/configure --help 2>&1 | grep -q '^ *--docdir='; then
291 --docdir="${EPREFIX}"/usr/share/doc/${PF}
295 # Handle static-libs found in IUSE, disable them by default
296 if in_iuse static-libs; then
299 $(use_enable static-libs static)
304 econfargs+=("${myeconfargs[@]}")
306 mkdir -p "${BUILD_DIR}" || die
307 pushd "${BUILD_DIR}" > /dev/null || die
308 econf "${econfargs[@]}" "$@"
309 popd > /dev/null || die
312 # @FUNCTION: autotools-utils_src_compile
314 # The autotools src_compile function, invokes emake in specified BUILD_DIR.
315 autotools-utils_src_compile() {
316 debug-print-function ${FUNCNAME} "$@"
319 pushd "${BUILD_DIR}" > /dev/null || die
320 emake "$@" || die 'emake failed'
321 popd > /dev/null || die
324 # @FUNCTION: autotools-utils_src_install
326 # The autotools src_install function. Runs emake install, unconditionally
327 # removes unnecessary static libs (based on shouldnotlink libtool property)
328 # and removes unnecessary libtool files when static-libs USE flag is defined
331 # DOCS and HTML_DOCS arrays are supported. See base.eclass(5) for reference.
332 autotools-utils_src_install() {
333 debug-print-function ${FUNCNAME} "$@"
336 pushd "${BUILD_DIR}" > /dev/null || die
337 emake DESTDIR="${D}" "$@" install || die "emake install failed"
338 popd > /dev/null || die
340 # Move docs installed by autotools (in EAPI < 4).
341 if [[ ${EAPI} == [23] ]] \
342 && path_exists "${D}${EPREFIX}"/usr/share/doc/${PF}/*; then
343 if [[ $(find "${D}${EPREFIX}"/usr/share/doc/${PF}/* -type d) ]]; then
344 eqawarn "autotools-utils: directories in docdir require at least EAPI 4"
346 mkdir "${T}"/temp-docdir
347 mv "${D}${EPREFIX}"/usr/share/doc/${PF}/* "${T}"/temp-docdir/ \
348 || die "moving docs to tempdir failed"
350 dodoc "${T}"/temp-docdir/* || die "docdir dodoc failed"
351 rm -r "${T}"/temp-docdir || die
355 # XXX: support installing them from builddir as well?
356 if declare -p DOCS &>/dev/null; then
357 # an empty list == don't install anything
358 if [[ ${DOCS[@]} ]]; then
359 if [[ ${EAPI} == [23] ]]; then
360 dodoc "${DOCS[@]}" || die
363 dodoc -r "${DOCS[@]}"
368 # same list as in PMS
369 for f in README* ChangeLog AUTHORS NEWS TODO CHANGES \
370 THANKS BUGS FAQ CREDITS CHANGELOG; do
371 if [[ -s ${f} ]]; then
372 dodoc "${f}" || die "(default) dodoc ${f} failed"
376 if [[ ${HTML_DOCS} ]]; then
377 dohtml -r "${HTML_DOCS[@]}" || die "dohtml failed"
380 # Remove libtool files and unnecessary static libs
381 local prune_ltfiles=${AUTOTOOLS_PRUNE_LIBTOOL_FILES}
382 if [[ ${prune_ltfiles} != none ]]; then
383 prune_libtool_files ${prune_ltfiles:+--${prune_ltfiles}}
387 # @FUNCTION: autotools-utils_src_test
389 # The autotools src_test function. Runs emake check in build directory.
390 autotools-utils_src_test() {
391 debug-print-function ${FUNCNAME} "$@"
394 pushd "${BUILD_DIR}" > /dev/null || die
396 if make -ni check "${@}" &>/dev/null; then
397 emake check "${@}" || die 'emake check failed.'
398 elif make -ni test "${@}" &>/dev/null; then
399 emake test "${@}" || die 'emake test failed.'
402 popd > /dev/null || die