1 # Copyright 1999-2018 Gentoo Foundation
2 # Distributed under the terms of the GNU General Public License v2
4 # @ECLASS: autotools-utils.eclass
6 # Maciej Mrozowski <reavertm@gentoo.org>
7 # Michał Górny <mgorny@gentoo.org>
8 # @SUPPORTED_EAPIS: 4 5
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!
92 6) die "${ECLASS}.eclass is banned in EAPI ${EAPI}";;
94 *) die "EAPI=${EAPI} is not supported" ;;
97 # @ECLASS-VARIABLE: AUTOTOOLS_AUTORECONF
100 # Set to a non-empty value before calling inherit to enable running autoreconf
101 # in src_prepare() and adding autotools dependencies.
103 # This is usually necessary when using live sources or applying patches
104 # modifying configure.ac or Makefile.am files. Note that in the latter case
105 # setting this variable is obligatory even though the eclass will work without
106 # it (to add the necessary dependencies).
108 # The eclass will try to determine the correct autotools to run including a few
109 # external tools: gettext, glib-gettext, intltool, gtk-doc, gnome-doc-prepare.
110 # If your tool is not supported, please open a bug and we'll add support for it.
112 # Note that dependencies are added for autoconf, automake and libtool only.
113 # If your package needs one of the external tools listed above, you need to add
114 # appropriate packages to DEPEND yourself.
115 [[ ${AUTOTOOLS_AUTORECONF} ]] || : ${AUTOTOOLS_AUTO_DEPEND:=no}
117 # eutils for eqawarn, path_exists
118 inherit autotools epatch eutils libtool ltprune
120 EXPORT_FUNCTIONS src_prepare src_configure src_compile src_install src_test
122 # @ECLASS-VARIABLE: BUILD_DIR
125 # Build directory, location where all autotools generated files should be
126 # placed. For out of source builds it defaults to ${WORKDIR}/${P}_build.
128 # This variable has been called AUTOTOOLS_BUILD_DIR formerly.
129 # It is set under that name for compatibility.
131 # @ECLASS-VARIABLE: AUTOTOOLS_IN_SOURCE_BUILD
134 # Set to enable in-source build.
136 # @ECLASS-VARIABLE: ECONF_SOURCE
139 # Specify location of autotools' configure script. By default it uses ${S}.
141 # @ECLASS-VARIABLE: DOCS
144 # Array containing documents passed to dodoc command.
146 # In EAPIs 4+, can list directories as well.
150 # DOCS=( NEWS README )
153 # @ECLASS-VARIABLE: HTML_DOCS
156 # Array containing documents passed to dohtml command.
160 # HTML_DOCS=( doc/html/ )
163 # @ECLASS-VARIABLE: PATCHES
166 # PATCHES array variable containing all various patches to be applied.
170 # PATCHES=( "${FILESDIR}"/${P}-mypatch.patch )
173 # @ECLASS-VARIABLE: AUTOTOOLS_PRUNE_LIBTOOL_FILES
176 # Sets the mode of pruning libtool files. The values correspond to
177 # prune_libtool_files parameters, with leading dashes stripped.
179 # Defaults to pruning the libtool files when static libraries are not
180 # installed or can be linked properly without them. Libtool files
181 # for modules (plugins) will be kept in case plugin loader needs them.
183 # If set to 'modules', the .la files for modules will be removed
184 # as well. This is often the preferred option.
186 # If set to 'all', all .la files will be removed unconditionally. This
187 # option is discouraged and shall be used only if 'modules' does not
190 # If set to 'none', no .la files will be pruned ever. Use in corner
193 # Determine using IN or OUT source build
195 : ${ECONF_SOURCE:=${S}}
196 # Respect both the old variable and the new one, depending
197 # on which one was set by the ebuild.
198 if [[ ! ${BUILD_DIR} && ${AUTOTOOLS_BUILD_DIR} ]]; then
199 eqawarn "The AUTOTOOLS_BUILD_DIR variable has been renamed to BUILD_DIR."
200 eqawarn "Please migrate the ebuild to use the new one."
202 # In the next call, both variables will be set already
203 # and we'd have to know which one takes precedence.
204 _RESPECT_AUTOTOOLS_BUILD_DIR=1
207 if [[ ${_RESPECT_AUTOTOOLS_BUILD_DIR} ]]; then
208 BUILD_DIR=${AUTOTOOLS_BUILD_DIR:-${WORKDIR}/${P}_build}
210 if [[ -n ${AUTOTOOLS_IN_SOURCE_BUILD} ]]; then
211 : ${BUILD_DIR:=${ECONF_SOURCE}}
213 : ${BUILD_DIR:=${WORKDIR}/${P}_build}
217 # Backwards compatibility for getting the value.
218 AUTOTOOLS_BUILD_DIR=${BUILD_DIR}
219 echo ">>> Working in BUILD_DIR: \"${BUILD_DIR}\""
222 # @FUNCTION: autotools-utils_src_prepare
224 # The src_prepare function.
226 # Supporting PATCHES array and user patches. See base.eclass(5) for reference.
227 autotools-utils_src_prepare() {
228 debug-print-function ${FUNCNAME} "$@"
230 local want_autoreconf=${AUTOTOOLS_AUTORECONF}
232 [[ ${PATCHES} ]] && epatch "${PATCHES[@]}"
235 find '(' -name 'Makefile.am' \
236 -o -name 'configure.ac' \
237 -o -name 'configure.in' ')' \
238 -exec cksum {} + | sort -k2
241 [[ ! ${want_autoreconf} ]] && local checksum=$(at_checksum)
243 if [[ ! ${want_autoreconf} ]]; then
244 if [[ ${checksum} != $(at_checksum) ]]; then
245 einfo 'Will autoreconfigure due to user patches applied.'
250 [[ ${want_autoreconf} ]] && eautoreconf
251 elibtoolize --patch-only
254 # @FUNCTION: autotools-utils_src_configure
256 # The src_configure function. For out of source build it creates build
257 # directory and runs econf there. Configuration parameters defined
258 # in myeconfargs are passed here to econf. Additionally following USE
261 # IUSE="static-libs" passes --enable-shared and either --disable-static/--enable-static
262 # to econf respectively.
264 # @VARIABLE: myeconfargs
267 # Optional econf arguments as Bash array. Should be defined before calling src_configure.
270 # local myeconfargs=(
272 # --with-confdir="/etc/nasty foo confdir/"
273 # $(use_enable debug cnddebug)
274 # $(use_enable threads multithreading)
276 # autotools-utils_src_configure
279 autotools-utils_src_configure() {
280 debug-print-function ${FUNCNAME} "$@"
282 [[ -z ${myeconfargs+1} || $(declare -p myeconfargs) == 'declare -a'* ]] \
283 || die 'autotools-utils.eclass: myeconfargs has to be an array.'
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 # XXX: support installing them from builddir as well?
341 if declare -p DOCS &>/dev/null; then
342 # an empty list == don't install anything
343 if [[ ${DOCS[@]} ]]; then
345 dodoc -r "${DOCS[@]}"
349 # same list as in PMS
350 for f in README* ChangeLog AUTHORS NEWS TODO CHANGES \
351 THANKS BUGS FAQ CREDITS CHANGELOG; do
352 if [[ -s ${f} ]]; then
353 dodoc "${f}" || die "(default) dodoc ${f} failed"
357 if [[ ${HTML_DOCS} ]]; then
358 dohtml -r "${HTML_DOCS[@]}" || die "dohtml failed"
361 # Remove libtool files and unnecessary static libs
362 local prune_ltfiles=${AUTOTOOLS_PRUNE_LIBTOOL_FILES}
363 if [[ ${prune_ltfiles} != none ]]; then
364 prune_libtool_files ${prune_ltfiles:+--${prune_ltfiles}}
368 # @FUNCTION: autotools-utils_src_test
370 # The autotools src_test function. Runs emake check in build directory.
371 autotools-utils_src_test() {
372 debug-print-function ${FUNCNAME} "$@"
375 pushd "${BUILD_DIR}" > /dev/null || die
377 if make -ni check "${@}" &>/dev/null; then
378 emake check "${@}" || die 'emake check failed.'
379 elif make -ni test "${@}" &>/dev/null; then
380 emake test "${@}" || die 'emake test failed.'
383 popd > /dev/null || die