gentoo-x86/eclass/autotools-utils.eclass

# Copyright 1999-2013 Gentoo Foundation
# Distributed under the terms of the GNU General Public License v2
# $Header: /var/cvsroot/gentoo-x86/eclass/autotools-utils.eclass,v 1.63 2013/03/03 00:22:56 pesa Exp $

# @ECLASS: autotools-utils.eclass
# @MAINTAINER:
# Maciej Mrozowski <reavertm@gentoo.org>
# Michał Górny <mgorny@gentoo.org>
# @BLURB: common ebuild functions for autotools-based packages
# @DESCRIPTION:
# autotools-utils.eclass is autotools.eclass(5) and base.eclass(5) wrapper
# providing all inherited features along with econf arguments as Bash array,
# out of source build with overridable build dir location, static archives
# handling, libtool files removal.
#
# Please note that autotools-utils does not support mixing of its phase
# functions with regular econf/emake calls. If necessary, please call
# autotools-utils_src_compile instead of the latter.
#
# @EXAMPLE:
# Typical ebuild using autotools-utils.eclass:
#
# @CODE
# EAPI="2"
#
# inherit autotools-utils
#
# DESCRIPTION="Foo bar application"
# HOMEPAGE="http://example.org/foo/"
# SRC_URI="mirror://sourceforge/foo/${P}.tar.bz2"
#
# LICENSE="LGPL-2.1"
# KEYWORDS=""
# SLOT="0"
# IUSE="debug doc examples qt4 static-libs tiff"
#
# CDEPEND="
#       media-libs/libpng:0
#       qt4? (
#               dev-qt/qtcore:4
#               dev-qt/qtgui:4
#       )
#       tiff? ( media-libs/tiff:0 )
# "
# RDEPEND="${CDEPEND}
#       !media-gfx/bar
# "
# DEPEND="${CDEPEND}
#       doc? ( app-doc/doxygen )
# "
#
# # bug 123456
# AUTOTOOLS_IN_SOURCE_BUILD=1
#
# DOCS=(AUTHORS ChangeLog README "Read me.txt" TODO)
#
# PATCHES=(
#       "${FILESDIR}/${P}-gcc44.patch" # bug 123458
#       "${FILESDIR}/${P}-as-needed.patch"
#       "${FILESDIR}/${P}-unbundle_libpng.patch"
# )
#
# src_configure() {
#       local myeconfargs=(
#               $(use_enable debug)
#               $(use_with qt4)
#               $(use_enable threads multithreading)
#               $(use_with tiff)
#       )
#       autotools-utils_src_configure
# }
#
# src_compile() {
#       autotools-utils_src_compile
#       use doc && autotools-utils_src_compile docs
# }
#
# src_install() {
#       use doc && HTML_DOCS=("${BUILD_DIR}/apidocs/html/")
#       autotools-utils_src_install
#       if use examples; then
#               dobin "${BUILD_DIR}"/foo_example{1,2,3} \\
#                       || die 'dobin examples failed'
#       fi
# }
#
# @CODE

# Keep variable names synced with cmake-utils and the other way around!

case ${EAPI:-0} in
        2|3|4|5) ;;
        *) die "EAPI=${EAPI} is not supported" ;;
esac

# @ECLASS-VARIABLE: AUTOTOOLS_AUTORECONF
# @DEFAULT_UNSET
# @DESCRIPTION:
# Set to a non-empty value in order to enable running autoreconf
# in src_prepare() and adding autotools dependencies.
#
# This is usually necessary when using live sources or applying patches
# modifying configure.ac or Makefile.am files. Note that in the latter case
# setting this variable is obligatory even though the eclass will work without
# it (to add the necessary dependencies).
#
# The eclass will try to determine the correct autotools to run including a few
# external tools: gettext, glib-gettext, intltool, gtk-doc, gnome-doc-prepare.
# If your tool is not supported, please open a bug and we'll add support for it.
#
# Note that dependencies are added for autoconf, automake and libtool only.
# If your package needs one of the external tools listed above, you need to add
# appropriate packages to DEPEND yourself.
[[ ${AUTOTOOLS_AUTORECONF} ]] || : ${AUTOTOOLS_AUTO_DEPEND:=no}

inherit autotools eutils libtool

EXPORT_FUNCTIONS src_prepare src_configure src_compile src_install src_test

# @ECLASS-VARIABLE: BUILD_DIR
# @DEFAULT_UNSET
# @DESCRIPTION:
# Build directory, location where all autotools generated files should be
# placed. For out of source builds it defaults to ${WORKDIR}/${P}_build.
#
# This variable has been called AUTOTOOLS_BUILD_DIR formerly.
# It is set under that name for compatibility.

# @ECLASS-VARIABLE: AUTOTOOLS_IN_SOURCE_BUILD
# @DEFAULT_UNSET
# @DESCRIPTION:
# Set to enable in-source build.

# @ECLASS-VARIABLE: ECONF_SOURCE
# @DEFAULT_UNSET
# @DESCRIPTION:
# Specify location of autotools' configure script. By default it uses ${S}.

# @ECLASS-VARIABLE: myeconfargs
# @DEFAULT_UNSET
# @DESCRIPTION:
# Optional econf arguments as Bash array. Should be defined before calling src_configure.
# @CODE
# src_configure() {
#       local myeconfargs=(
#               --disable-readline
#               --with-confdir="/etc/nasty foo confdir/"
#               $(use_enable debug cnddebug)
#               $(use_enable threads multithreading)
#       )
#       autotools-utils_src_configure
# }
# @CODE

# @ECLASS-VARIABLE: DOCS
# @DEFAULT_UNSET
# @DESCRIPTION:
# Array containing documents passed to dodoc command.
#
# In EAPIs 4+, can list directories as well.
#
# Example:
# @CODE
# DOCS=( NEWS README )
# @CODE

# @ECLASS-VARIABLE: HTML_DOCS
# @DEFAULT_UNSET
# @DESCRIPTION:
# Array containing documents passed to dohtml command.
#
# Example:
# @CODE
# HTML_DOCS=( doc/html/ )
# @CODE

# @ECLASS-VARIABLE: PATCHES
# @DEFAULT_UNSET
# @DESCRIPTION:
# PATCHES array variable containing all various patches to be applied.
#
# Example:
# @CODE
# PATCHES=( "${FILESDIR}"/${P}-mypatch.patch )
# @CODE

# @ECLASS-VARIABLE: AUTOTOOLS_PRUNE_LIBTOOL_FILES
# @DEFAULT-UNSET
# @DESCRIPTION:
# Sets the mode of pruning libtool files. The values correspond to
# prune_libtool_files parameters, with leading dashes stripped.
#
# Defaults to pruning the libtool files when static libraries are not
# installed or can be linked properly without them. Libtool files
# for modules (plugins) will be kept in case plugin loader needs them.
#
# If set to 'modules', the .la files for modules will be removed
# as well. This is often the preferred option.
#
# If set to 'all', all .la files will be removed unconditionally. This
# option is discouraged and shall be used only if 'modules' does not
# remove the files.

# Determine using IN or OUT source build
_check_build_dir() {
        : ${ECONF_SOURCE:=${S}}
        if [[ -n ${AUTOTOOLS_IN_SOURCE_BUILD} ]]; then
                BUILD_DIR="${ECONF_SOURCE}"
        else
                # Respect both the old variable and the new one, depending
                # on which one was set by the ebuild.
                if [[ ! ${BUILD_DIR} && ${AUTOTOOLS_BUILD_DIR} ]]; then
                        eqawarn "The AUTOTOOLS_BUILD_DIR variable has been renamed to BUILD_DIR."
                        eqawarn "Please migrate the ebuild to use the new one."

                        # In the next call, both variables will be set already
                        # and we'd have to know which one takes precedence.
                        _RESPECT_AUTOTOOLS_BUILD_DIR=1
                fi

                if [[ ${_RESPECT_AUTOTOOLS_BUILD_DIR} ]]; then
                        BUILD_DIR=${AUTOTOOLS_BUILD_DIR:-${WORKDIR}/${P}_build}
                else
                        : ${BUILD_DIR:=${WORKDIR}/${P}_build}
                fi
        fi

        # Backwards compatibility for getting the value.
        AUTOTOOLS_BUILD_DIR=${BUILD_DIR}
        echo ">>> Working in BUILD_DIR: \"${BUILD_DIR}\""
}

# @FUNCTION: remove_libtool_files
# @USAGE: [all]
# @DESCRIPTION:
# Determines unnecessary libtool files (.la) and libtool static archives (.a)
# and removes them from installation image.
#
# To unconditionally remove all libtool files, pass 'all' as argument.
# Otherwise, libtool archives required for static linking will be preserved.
#
# In most cases it's not necessary to manually invoke this function.
# See autotools-utils_src_install for reference.
remove_libtool_files() {
        debug-print-function ${FUNCNAME} "$@"
        local removing_all

        eqawarn "The remove_libtool_files() function was deprecated."
        eqawarn "Please use prune_libtool_files() from eutils eclass instead."

        [[ ${#} -le 1 ]] || die "Invalid number of args to ${FUNCNAME}()"
        if [[ ${#} -eq 1 ]]; then
                case "${1}" in
                        all)
                                removing_all=1
                                ;;
                        *)
                                die "Invalid argument to ${FUNCNAME}(): ${1}"
                esac
        fi

        local pc_libs=()
        if [[ ! ${removing_all} ]]; then
                local arg
                for arg in $(find "${D}" -name '*.pc' -exec \
                                        sed -n -e 's;^Libs:;;p' {} +); do
                        [[ ${arg} == -l* ]] && pc_libs+=(lib${arg#-l}.la)
                done
        fi

        local f
        find "${D}" -type f -name '*.la' -print0 | while read -r -d '' f; do
                local shouldnotlink=$(sed -ne '/^shouldnotlink=yes$/p' "${f}")
                local archivefile=${f/%.la/.a}
                [[ "${f}" != "${archivefile}" ]] || die 'regex sanity check failed'

                # Remove static libs we're not supposed to link against.
                if [[ ${shouldnotlink} ]]; then
                        einfo "Removing unnecessary ${archivefile#${D%/}}"
                        rm -f "${archivefile}" || die
                        # The .la file may be used by a module loader, so avoid removing it
                        # unless explicitly requested.
                        [[ ${removing_all} ]] || continue
                fi

                # Remove .la files when:
                # - user explicitly wants us to remove all .la files,
                # - respective static archive doesn't exist,
                # - they are covered by a .pc file already,
                # - they don't provide any new information (no libs & no flags).
                local removing
                if [[ ${removing_all} ]]; then removing='forced'
                elif [[ ! -f ${archivefile} ]]; then removing='no static archive'
                elif has "$(basename "${f}")" "${pc_libs[@]}"; then
                        removing='covered by .pc'
                elif [[ ! $(sed -n -e \
                        "s/^\(dependency_libs\|inherited_linker_flags\)='\(.*\)'$/\2/p" \
                        "${f}") ]]; then removing='no libs & flags'
                fi

                if [[ ${removing} ]]; then
                        einfo "Removing unnecessary ${f#${D%/}} (${removing})"
                        rm -f "${f}" || die
                fi
        done
}

# @FUNCTION: autotools-utils_autoreconf
# @DESCRIPTION:
# Reconfigure the sources (like gnome-autogen.sh or eautoreconf).
autotools-utils_autoreconf() {
        debug-print-function ${FUNCNAME} "$@"

        eqawarn "The autotools-utils_autoreconf() function was deprecated."
        eqawarn "Please call autotools-utils_src_prepare()"
        eqawarn "with AUTOTOOLS_AUTORECONF set instead."

        # Override this func to not require unnecessary eaclocal calls.
        autotools_check_macro() {
                local x

                # Add a few additional variants as we don't get expansions.
                [[ ${1} = AC_CONFIG_HEADERS ]] && set -- "${@}" \
                        AC_CONFIG_HEADER AM_CONFIG_HEADER

                for x; do
                        grep -h "^${x}" configure.{ac,in} 2>/dev/null
                done
        }

        einfo "Autoreconfiguring '${PWD}' ..."

        local auxdir=$(sed -n -e 's/^AC_CONFIG_AUX_DIR(\(.*\))$/\1/p' \
                        configure.{ac,in} 2>/dev/null)
        if [[ ${auxdir} ]]; then
                auxdir=${auxdir%%]}
                mkdir -p ${auxdir##[}
        fi

        # Support running additional tools like gnome-autogen.sh.
        # Note: you need to add additional depends to the ebuild.

        # gettext
        if [[ $(autotools_check_macro AM_GLIB_GNU_GETTEXT) ]]; then
                echo 'no' | autotools_run_tool glib-gettextize --copy --force
        elif [[ $(autotools_check_macro AM_GNU_GETTEXT) ]]; then
                eautopoint --force
        fi

        # intltool
        if [[ $(autotools_check_macro AC_PROG_INTLTOOL IT_PROG_INTLTOOL) ]]
        then
                autotools_run_tool intltoolize --copy --automake --force
        fi

        # gtk-doc
        if [[ $(autotools_check_macro GTK_DOC_CHECK) ]]; then
                autotools_run_tool gtkdocize --copy
        fi

        # gnome-doc
        if [[ $(autotools_check_macro GNOME_DOC_INIT) ]]; then
                autotools_run_tool gnome-doc-prepare --copy --force
        fi

        if [[ $(autotools_check_macro AC_PROG_LIBTOOL AM_PROG_LIBTOOL LT_INIT) ]]
        then
                _elibtoolize --copy --force --install
        fi

        eaclocal
        eautoconf
        eautoheader
        FROM_EAUTORECONF=sure eautomake

        local x
        for x in $(autotools_check_macro_val AC_CONFIG_SUBDIRS); do
                if [[ -d ${x} ]] ; then
                        pushd "${x}" >/dev/null || die
                        autotools-utils_autoreconf
                        popd >/dev/null || die
                fi
        done
}

# @FUNCTION: autotools-utils_src_prepare
# @DESCRIPTION:
# The src_prepare function.
#
# Supporting PATCHES array and user patches. See base.eclass(5) for reference.
autotools-utils_src_prepare() {
        debug-print-function ${FUNCNAME} "$@"

        local want_autoreconf=${AUTOTOOLS_AUTORECONF}

        [[ ${PATCHES} ]] && epatch "${PATCHES[@]}"

        at_checksum() {
                find '(' -name 'Makefile.am' \
                        -o -name 'configure.ac' \
                        -o -name 'configure.in' ')' \
                        -exec cksum {} + | sort -k2
        }

        [[ ! ${want_autoreconf} ]] && local checksum=$(at_checksum)
        epatch_user
        if [[ ! ${want_autoreconf} ]]; then
                if [[ ${checksum} != $(at_checksum) ]]; then
                        einfo 'Will autoreconfigure due to user patches applied.'
                        want_autoreconf=yep
                fi
        fi

        [[ ${want_autoreconf} ]] && eautoreconf
        elibtoolize --patch-only
}

# @FUNCTION: autotools-utils_src_configure
# @DESCRIPTION:
# The src_configure function. For out of source build it creates build
# directory and runs econf there. Configuration parameters defined
# in myeconfargs are passed here to econf. Additionally following USE
# flags are known:
#
# IUSE="static-libs" passes --enable-shared and either --disable-static/--enable-static
# to econf respectively.
autotools-utils_src_configure() {
        debug-print-function ${FUNCNAME} "$@"

        [[ -z ${myeconfargs+1} || $(declare -p myeconfargs) == 'declare -a'* ]] \
                || die 'autotools-utils.eclass: myeconfargs has to be an array.'

        [[ ${EAPI} == 2 ]] && ! use prefix && EPREFIX=

        # Common args
        local econfargs=()

        _check_build_dir
        if "${ECONF_SOURCE}"/configure --help 2>&1 | grep -q '^ *--docdir='; then
                econfargs+=(
                        --docdir="${EPREFIX}"/usr/share/doc/${PF}
                )
        fi

        # Handle static-libs found in IUSE, disable them by default
        if in_iuse static-libs; then
                econfargs+=(
                        --enable-shared
                        $(use_enable static-libs static)
                )
        fi

        # Append user args
        econfargs+=("${myeconfargs[@]}")

        mkdir -p "${BUILD_DIR}" || die
        pushd "${BUILD_DIR}" > /dev/null || die
        econf "${econfargs[@]}" "$@"
        popd > /dev/null || die
}

# @FUNCTION: autotools-utils_src_compile
# @DESCRIPTION:
# The autotools src_compile function, invokes emake in specified BUILD_DIR.
autotools-utils_src_compile() {
        debug-print-function ${FUNCNAME} "$@"

        _check_build_dir
        pushd "${BUILD_DIR}" > /dev/null || die
        emake "$@" || die 'emake failed'
        popd > /dev/null || die
}

# @FUNCTION: autotools-utils_src_install
# @DESCRIPTION:
# The autotools src_install function. Runs emake install, unconditionally
# removes unnecessary static libs (based on shouldnotlink libtool property)
# and removes unnecessary libtool files when static-libs USE flag is defined
# and unset.
#
# DOCS and HTML_DOCS arrays are supported. See base.eclass(5) for reference.
autotools-utils_src_install() {
        debug-print-function ${FUNCNAME} "$@"

        _check_build_dir
        pushd "${BUILD_DIR}" > /dev/null || die
        emake DESTDIR="${D}" "$@" install || die "emake install failed"
        popd > /dev/null || die

        # Move docs installed by autotools (in EAPI < 4).
        if [[ ${EAPI} == [23] ]] \
                        && path_exists "${D}${EPREFIX}"/usr/share/doc/${PF}/*; then
                if [[ $(find "${D}${EPREFIX}"/usr/share/doc/${PF}/* -type d) ]]; then
                        eqawarn "autotools-utils: directories in docdir require at least EAPI 4"
                else
                        mkdir "${T}"/temp-docdir
                        mv "${D}${EPREFIX}"/usr/share/doc/${PF}/* "${T}"/temp-docdir/ \
                                || die "moving docs to tempdir failed"

                        dodoc "${T}"/temp-docdir/* || die "docdir dodoc failed"
                        rm -r "${T}"/temp-docdir || die
                fi
        fi

        # XXX: support installing them from builddir as well?
        if declare -p DOCS &>/dev/null; then
                # an empty list == don't install anything
                if [[ ${DOCS[@]} ]]; then
                        if [[ ${EAPI} == [23] ]]; then
                                dodoc "${DOCS[@]}" || die
                        else
                                # dies by itself
                                dodoc -r "${DOCS[@]}"
                        fi
                fi
        else
                local f
                # same list as in PMS
                for f in README* ChangeLog AUTHORS NEWS TODO CHANGES \
                                THANKS BUGS FAQ CREDITS CHANGELOG; do
                        if [[ -s ${f} ]]; then
                                dodoc "${f}" || die "(default) dodoc ${f} failed"
                        fi
                done
        fi
        if [[ ${HTML_DOCS} ]]; then
                dohtml -r "${HTML_DOCS[@]}" || die "dohtml failed"
        fi

        # Remove libtool files and unnecessary static libs
        local prune_ltfiles=${AUTOTOOLS_PRUNE_LIBTOOL_FILES}
        prune_libtool_files ${prune_ltfiles:+--${prune_ltfiles}}
}

# @FUNCTION: autotools-utils_src_test
# @DESCRIPTION:
# The autotools src_test function. Runs emake check in build directory.
autotools-utils_src_test() {
        debug-print-function ${FUNCNAME} "$@"

        _check_build_dir
        pushd "${BUILD_DIR}" > /dev/null || die
        # Run default src_test as defined in ebuild.sh
        default_src_test
        popd > /dev/null || die
}
1	mgorny	1.62	# Copyright 1999-2013 Gentoo Foundation
2	reavertm	1.1	# Distributed under the terms of the GNU General Public License v2
3	mgorny	1.64	# $Header: /var/cvsroot/gentoo-x86/eclass/autotools-utils.eclass,v 1.63 2013/03/03 00:22:56 pesa 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	pesa	1.63	# dev-qt/qtcore:4
41			# dev-qt/qtgui:4
42	reavertm	1.1	# )
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	mgorny	1.61	# In EAPIs 4+, can list directories as well.
161			#
162	mgorny	1.30	# Example:
163			# @CODE
164			# DOCS=( NEWS README )
165			# @CODE
166
167			# @ECLASS-VARIABLE: HTML_DOCS
168			# @DEFAULT_UNSET
169			# @DESCRIPTION:
170			# Array containing documents passed to dohtml command.
171			#
172			# Example:
173			# @CODE
174			# HTML_DOCS=( doc/html/ )
175			# @CODE
176
177			# @ECLASS-VARIABLE: PATCHES
178			# @DEFAULT_UNSET
179			# @DESCRIPTION:
180			# PATCHES array variable containing all various patches to be applied.
181			#
182			# Example:
183			# @CODE
184			# PATCHES=( "${FILESDIR}"/${P}-mypatch.patch )
185			# @CODE
186
187	mgorny	1.64	# @ECLASS-VARIABLE: AUTOTOOLS_PRUNE_LIBTOOL_FILES
188			# @DEFAULT-UNSET
189			# @DESCRIPTION:
190			# Sets the mode of pruning libtool files. The values correspond to
191			# prune_libtool_files parameters, with leading dashes stripped.
192			#
193			# Defaults to pruning the libtool files when static libraries are not
194			# installed or can be linked properly without them. Libtool files
195			# for modules (plugins) will be kept in case plugin loader needs them.
196			#
197			# If set to 'modules', the .la files for modules will be removed
198			# as well. This is often the preferred option.
199			#
200			# If set to 'all', all .la files will be removed unconditionally. This
201			# option is discouraged and shall be used only if 'modules' does not
202			# remove the files.
203
204	reavertm	1.1	# Determine using IN or OUT source build
205			_check_build_dir() {
206			: ${ECONF_SOURCE:=${S}}
207			if [[ -n ${AUTOTOOLS_IN_SOURCE_BUILD} ]]; then
208	mgorny	1.58	BUILD_DIR="${ECONF_SOURCE}"
209	reavertm	1.1	else
210	mgorny	1.59	# Respect both the old variable and the new one, depending
211			# on which one was set by the ebuild.
212			if [[ ! ${BUILD_DIR} && ${AUTOTOOLS_BUILD_DIR} ]]; then
213			eqawarn "The AUTOTOOLS_BUILD_DIR variable has been renamed to BUILD_DIR."
214			eqawarn "Please migrate the ebuild to use the new one."
215
216			# In the next call, both variables will be set already
217			# and we'd have to know which one takes precedence.
218			_RESPECT_AUTOTOOLS_BUILD_DIR=1
219			fi
220	mgorny	1.60
221	mgorny	1.59	if [[ ${_RESPECT_AUTOTOOLS_BUILD_DIR} ]]; then
222	mgorny	1.60	BUILD_DIR=${AUTOTOOLS_BUILD_DIR:-${WORKDIR}/${P}_build}
223			else
224			: ${BUILD_DIR:=${WORKDIR}/${P}_build}
225	mgorny	1.59	fi
226	reavertm	1.1	fi
227	mgorny	1.58
228	mgorny	1.59	# Backwards compatibility for getting the value.
229	mgorny	1.58	AUTOTOOLS_BUILD_DIR=${BUILD_DIR}
230			echo ">>> Working in BUILD_DIR: \"${BUILD_DIR}\""
231	reavertm	1.1	}
232
233			# @FUNCTION: remove_libtool_files
234	mgorny	1.14	# @USAGE: [all]
235	reavertm	1.1	# @DESCRIPTION:
236			# Determines unnecessary libtool files (.la) and libtool static archives (.a)
237			# and removes them from installation image.
238	mgorny	1.14	#
239	reavertm	1.1	# To unconditionally remove all libtool files, pass 'all' as argument.
240	mgorny	1.14	# Otherwise, libtool archives required for static linking will be preserved.
241	reavertm	1.1	#
242			# In most cases it's not necessary to manually invoke this function.
243			# See autotools-utils_src_install for reference.
244			remove_libtool_files() {
245			debug-print-function ${FUNCNAME} "$@"
246	mgorny	1.16	local removing_all
247	mgorny	1.54
248			eqawarn "The remove_libtool_files() function was deprecated."
249			eqawarn "Please use prune_libtool_files() from eutils eclass instead."
250
251	mgorny	1.16	[[ ${#} -le 1 ]] \|\| die "Invalid number of args to ${FUNCNAME}()"
252			if [[ ${#} -eq 1 ]]; then
253			case "${1}" in
254			all)
255			removing_all=1
256			;;
257			*)
258			die "Invalid argument to ${FUNCNAME}(): ${1}"
259			esac
260			fi
261	reavertm	1.1
262	mgorny	1.19	local pc_libs=()
263			if [[ ! ${removing_all} ]]; then
264			local arg
265			for arg in $(find "${D}" -name '*.pc' -exec \
266			sed -n -e 's;^Libs:;;p' {} +); do
267			[[ ${arg} == -l* ]] && pc_libs+=(lib${arg#-l}.la)
268			done
269			fi
270
271	reavertm	1.1	local f
272	mgorny	1.12	find "${D}" -type f -name '*.la' -print0 \| while read -r -d '' f; do
273	reavertm	1.1	local shouldnotlink=$(sed -ne '/^shouldnotlink=yes$/p' "${f}")
274	mgorny	1.14	local archivefile=${f/%.la/.a}
275	mgorny	1.15	[[ "${f}" != "${archivefile}" ]] \|\| die 'regex sanity check failed'
276	mgorny	1.14
277	mgorny	1.18	# Remove static libs we're not supposed to link against.
278	mgorny	1.17	if [[ ${shouldnotlink} ]]; then
279			einfo "Removing unnecessary ${archivefile#${D%/}}"
280			rm -f "${archivefile}" \|\| die
281	mgorny	1.18	# The .la file may be used by a module loader, so avoid removing it
282			# unless explicitly requested.
283	mgorny	1.17	[[ ${removing_all} ]] \|\| continue
284			fi
285
286	mgorny	1.18	# Remove .la files when:
287			# - user explicitly wants us to remove all .la files,
288			# - respective static archive doesn't exist,
289	mgorny	1.19	# - they are covered by a .pc file already,
290	mgorny	1.18	# - they don't provide any new information (no libs & no flags).
291			local removing
292	mgorny	1.20	if [[ ${removing_all} ]]; then removing='forced'
293			elif [[ ! -f ${archivefile} ]]; then removing='no static archive'
294			elif has "$(basename "${f}")" "${pc_libs[@]}"; then
295			removing='covered by .pc'
296	mgorny	1.18	elif [[ ! $(sed -n -e \
297			"s/^\(dependency_libs\\|inherited_linker_flags\)='\(.*\)'$/\2/p" \
298	mgorny	1.20	"${f}") ]]; then removing='no libs & flags'
299	mgorny	1.18	fi
300
301			if [[ ${removing} ]]; then
302	mgorny	1.20	einfo "Removing unnecessary ${f#${D%/}} (${removing})"
303	mgorny	1.15	rm -f "${f}" \|\| die
304	reavertm	1.1	fi
305			done
306			}
307
308	mgorny	1.32	# @FUNCTION: autotools-utils_autoreconf
309			# @DESCRIPTION:
310			# Reconfigure the sources (like gnome-autogen.sh or eautoreconf).
311			autotools-utils_autoreconf() {
312			debug-print-function ${FUNCNAME} "$@"
313
314	mgorny	1.55	eqawarn "The autotools-utils_autoreconf() function was deprecated."
315			eqawarn "Please call autotools-utils_src_prepare()"
316			eqawarn "with AUTOTOOLS_AUTORECONF set instead."
317
318	mgorny	1.32	# Override this func to not require unnecessary eaclocal calls.
319			autotools_check_macro() {
320			local x
321
322			# Add a few additional variants as we don't get expansions.
323	mgorny	1.44	[[ ${1} = AC_CONFIG_HEADERS ]] && set -- "${@}" \
324			AC_CONFIG_HEADER AM_CONFIG_HEADER
325	mgorny	1.32
326			for x; do
327			grep -h "^${x}" configure.{ac,in} 2>/dev/null
328			done
329			}
330
331			einfo "Autoreconfiguring '${PWD}' ..."
332
333			local auxdir=$(sed -n -e 's/^AC_CONFIG_AUX_DIR(\(.*\))$/\1/p' \
334			configure.{ac,in} 2>/dev/null)
335			if [[ ${auxdir} ]]; then
336			auxdir=${auxdir%%]}
337			mkdir -p ${auxdir##[}
338			fi
339
340			# Support running additional tools like gnome-autogen.sh.
341			# Note: you need to add additional depends to the ebuild.
342
343			# gettext
344			if [[ $(autotools_check_macro AM_GLIB_GNU_GETTEXT) ]]; then
345	jlec	1.46	echo 'no' \| autotools_run_tool glib-gettextize --copy --force
346	mgorny	1.32	elif [[ $(autotools_check_macro AM_GNU_GETTEXT) ]]; then
347	mgorny	1.38	eautopoint --force
348	mgorny	1.32	fi
349
350			# intltool
351			if [[ $(autotools_check_macro AC_PROG_INTLTOOL IT_PROG_INTLTOOL) ]]
352			then
353	mgorny	1.38	autotools_run_tool intltoolize --copy --automake --force
354	mgorny	1.32	fi
355
356			# gtk-doc
357			if [[ $(autotools_check_macro GTK_DOC_CHECK) ]]; then
358			autotools_run_tool gtkdocize --copy
359			fi
360
361			# gnome-doc
362			if [[ $(autotools_check_macro GNOME_DOC_INIT) ]]; then
363	mgorny	1.38	autotools_run_tool gnome-doc-prepare --copy --force
364	mgorny	1.32	fi
365
366			if [[ $(autotools_check_macro AC_PROG_LIBTOOL AM_PROG_LIBTOOL LT_INIT) ]]
367			then
368			_elibtoolize --copy --force --install
369			fi
370
371	mgorny	1.50	eaclocal
372	mgorny	1.32	eautoconf
373			eautoheader
374	mgorny	1.36	FROM_EAUTORECONF=sure eautomake
375	mgorny	1.32
376			local x
377	mgorny	1.49	for x in $(autotools_check_macro_val AC_CONFIG_SUBDIRS); do
378	mgorny	1.32	if [[ -d ${x} ]] ; then
379	mgorny	1.52	pushd "${x}" >/dev/null \|\| die
380	mgorny	1.48	autotools-utils_autoreconf
381	mgorny	1.52	popd >/dev/null \|\| die
382	mgorny	1.32	fi
383			done
384			}
385
386	reavertm	1.1	# @FUNCTION: autotools-utils_src_prepare
387			# @DESCRIPTION:
388			# The src_prepare function.
389			#
390			# Supporting PATCHES array and user patches. See base.eclass(5) for reference.
391			autotools-utils_src_prepare() {
392			debug-print-function ${FUNCNAME} "$@"
393
394	mgorny	1.32	local want_autoreconf=${AUTOTOOLS_AUTORECONF}
395
396	mgorny	1.45	[[ ${PATCHES} ]] && epatch "${PATCHES[@]}"
397
398	mgorny	1.47	at_checksum() {
399			find '(' -name 'Makefile.am' \
400			-o -name 'configure.ac' \
401			-o -name 'configure.in' ')' \
402			-exec cksum {} + \| sort -k2
403			}
404
405			[[ ! ${want_autoreconf} ]] && local checksum=$(at_checksum)
406	mgorny	1.30	epatch_user
407	mgorny	1.37	if [[ ! ${want_autoreconf} ]]; then
408	mgorny	1.47	if [[ ${checksum} != $(at_checksum) ]]; then
409	mgorny	1.45	einfo 'Will autoreconfigure due to user patches applied.'
410	mgorny	1.37	want_autoreconf=yep
411			fi
412			fi
413	mgorny	1.30
414	mgorny	1.55	[[ ${want_autoreconf} ]] && eautoreconf
415	mgorny	1.25	elibtoolize --patch-only
416	reavertm	1.1	}
417
418			# @FUNCTION: autotools-utils_src_configure
419			# @DESCRIPTION:
420			# The src_configure function. For out of source build it creates build
421			# directory and runs econf there. Configuration parameters defined
422			# in myeconfargs are passed here to econf. Additionally following USE
423			# flags are known:
424			#
425			# IUSE="static-libs" passes --enable-shared and either --disable-static/--enable-static
426			# to econf respectively.
427			autotools-utils_src_configure() {
428			debug-print-function ${FUNCNAME} "$@"
429
430	mgorny	1.22	[[ -z ${myeconfargs+1} \|\| $(declare -p myeconfargs) == 'declare -a'* ]] \
431			\|\| die 'autotools-utils.eclass: myeconfargs has to be an array.'
432
433	mgorny	1.35	[[ ${EAPI} == 2 ]] && ! use prefix && EPREFIX=
434
435	reavertm	1.1	# Common args
436	mgorny	1.41	local econfargs=()
437
438			_check_build_dir
439	mgorny	1.43	if "${ECONF_SOURCE}"/configure --help 2>&1 \| grep -q '^ *--docdir='; then
440	mgorny	1.41	econfargs+=(
441			--docdir="${EPREFIX}"/usr/share/doc/${PF}
442			)
443			fi
444	reavertm	1.1
445			# Handle static-libs found in IUSE, disable them by default
446	mgorny	1.24	if in_iuse static-libs; then
447	reavertm	1.1	econfargs+=(
448			--enable-shared
449			$(use_enable static-libs static)
450			)
451			fi
452
453			# Append user args
454	reavertm	1.5	econfargs+=("${myeconfargs[@]}")
455	reavertm	1.1
456	mgorny	1.58	mkdir -p "${BUILD_DIR}" \|\| die
457			pushd "${BUILD_DIR}" > /dev/null \|\| die
458	mgorny	1.30	econf "${econfargs[@]}" "$@"
459	mgorny	1.52	popd > /dev/null \|\| die
460	reavertm	1.1	}
461
462			# @FUNCTION: autotools-utils_src_compile
463			# @DESCRIPTION:
464	mgorny	1.58	# The autotools src_compile function, invokes emake in specified BUILD_DIR.
465	reavertm	1.1	autotools-utils_src_compile() {
466			debug-print-function ${FUNCNAME} "$@"
467
468			_check_build_dir
469	mgorny	1.58	pushd "${BUILD_DIR}" > /dev/null \|\| die
470	mgorny	1.30	emake "$@" \|\| die 'emake failed'
471	mgorny	1.52	popd > /dev/null \|\| die
472	reavertm	1.1	}
473
474			# @FUNCTION: autotools-utils_src_install
475			# @DESCRIPTION:
476			# The autotools src_install function. Runs emake install, unconditionally
477			# removes unnecessary static libs (based on shouldnotlink libtool property)
478			# and removes unnecessary libtool files when static-libs USE flag is defined
479			# and unset.
480			#
481			# DOCS and HTML_DOCS arrays are supported. See base.eclass(5) for reference.
482			autotools-utils_src_install() {
483			debug-print-function ${FUNCNAME} "$@"
484
485			_check_build_dir
486	mgorny	1.58	pushd "${BUILD_DIR}" > /dev/null \|\| die
487	mgorny	1.30	emake DESTDIR="${D}" "$@" install \|\| die "emake install failed"
488	mgorny	1.52	popd > /dev/null \|\| die
489	reavertm	1.1
490	mgorny	1.35	# Move docs installed by autotools (in EAPI < 4).
491	mgorny	1.40	if [[ ${EAPI} == [23] ]] \
492			&& path_exists "${D}${EPREFIX}"/usr/share/doc/${PF}/*; then
493	mgorny	1.39	if [[ $(find "${D}${EPREFIX}"/usr/share/doc/${PF}/* -type d) ]]; then
494			eqawarn "autotools-utils: directories in docdir require at least EAPI 4"
495			else
496			mkdir "${T}"/temp-docdir
497			mv "${D}${EPREFIX}"/usr/share/doc/${PF}/* "${T}"/temp-docdir/ \
498			\|\| die "moving docs to tempdir failed"
499	mgorny	1.35
500	mgorny	1.39	dodoc "${T}"/temp-docdir/* \|\| die "docdir dodoc failed"
501			rm -r "${T}"/temp-docdir \|\| die
502			fi
503	mgorny	1.35	fi
504
505	mgorny	1.30	# XXX: support installing them from builddir as well?
506	mgorny	1.62	if declare -p DOCS &>/dev/null; then
507			# an empty list == don't install anything
508			if [[ ${DOCS[@]} ]]; then
509			if [[ ${EAPI} == [23] ]]; then
510			dodoc "${DOCS[@]}" \|\| die
511			else
512			# dies by itself
513			dodoc -r "${DOCS[@]}"
514			fi
515	mgorny	1.61	fi
516	mgorny	1.34	else
517			local f
518			# same list as in PMS
519			for f in README* ChangeLog AUTHORS NEWS TODO CHANGES \
520			THANKS BUGS FAQ CREDITS CHANGELOG; do
521			if [[ -s ${f} ]]; then
522			dodoc "${f}" \|\| die "(default) dodoc ${f} failed"
523			fi
524			done
525	mgorny	1.30	fi
526			if [[ ${HTML_DOCS} ]]; then
527			dohtml -r "${HTML_DOCS[@]}" \|\| die "dohtml failed"
528			fi
529
530	reavertm	1.1	# Remove libtool files and unnecessary static libs
531	mgorny	1.64	local prune_ltfiles=${AUTOTOOLS_PRUNE_LIBTOOL_FILES}
532			prune_libtool_files ${prune_ltfiles:+--${prune_ltfiles}}
533	reavertm	1.1	}
534
535			# @FUNCTION: autotools-utils_src_test
536			# @DESCRIPTION:
537			# The autotools src_test function. Runs emake check in build directory.
538			autotools-utils_src_test() {
539			debug-print-function ${FUNCNAME} "$@"
540
541			_check_build_dir
542	mgorny	1.58	pushd "${BUILD_DIR}" > /dev/null \|\| die
543	reavertm	1.1	# Run default src_test as defined in ebuild.sh
544			default_src_test
545	mgorny	1.52	popd > /dev/null \|\| die
546	reavertm	1.1	}