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.67 2013/05/03 09:20:56 mgorny 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.
#
# If set to 'none', no .la files will be pruned ever. Use in corner
# cases only.

# 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}
        if [[ ${prune_ltfiles} != none ]]; then
                prune_libtool_files ${prune_ltfiles:+--${prune_ltfiles}}
        fi
}

# @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

        if make -n check &>/dev/null; then
                emake check "${@}" || die 'emake check failed.'
        elif make -n test &>/dev/null; then
                emake test "${@}" || die 'emake test failed.'
        fi

        popd > /dev/null || die
}
1	# Copyright 1999-2013 Gentoo Foundation
2	# Distributed under the terms of the GNU General Public License v2
3	# $Header: /var/cvsroot/gentoo-x86/eclass/autotools-utils.eclass,v 1.67 2013/05/03 09:20:56 mgorny Exp $
4
5	# @ECLASS: autotools-utils.eclass
6	# @MAINTAINER:
7	# Maciej Mrozowski <reavertm@gentoo.org>
8	# Michał Górny <mgorny@gentoo.org>
9	# @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	# handling, libtool files removal.
15	#
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.
19	#
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	# dev-qt/qtcore:4
41	# dev-qt/qtgui: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	# local myeconfargs=(
65	# $(use_enable debug)
66	# $(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=("${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'
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	2\|3\|4\|5) ;;
93	*) die "EAPI=${EAPI} is not supported" ;;
94	esac
95
96	# @ECLASS-VARIABLE: AUTOTOOLS_AUTORECONF
97	# @DEFAULT_UNSET
98	# @DESCRIPTION:
99	# Set to a non-empty value in order to enable running autoreconf
100	# in src_prepare() and adding autotools dependencies.
101	#
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).
106	#
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.
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_DEPEND:=no}
115
116	inherit autotools eutils libtool
117
118	EXPORT_FUNCTIONS src_prepare src_configure src_compile src_install src_test
119
120	# @ECLASS-VARIABLE: BUILD_DIR
121	# @DEFAULT_UNSET
122	# @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	#
126	# This variable has been called AUTOTOOLS_BUILD_DIR formerly.
127	# It is set under that name for compatibility.
128
129	# @ECLASS-VARIABLE: AUTOTOOLS_IN_SOURCE_BUILD
130	# @DEFAULT_UNSET
131	# @DESCRIPTION:
132	# Set to enable in-source build.
133
134	# @ECLASS-VARIABLE: ECONF_SOURCE
135	# @DEFAULT_UNSET
136	# @DESCRIPTION:
137	# Specify location of autotools' configure script. By default it uses ${S}.
138
139	# @ECLASS-VARIABLE: myeconfargs
140	# @DEFAULT_UNSET
141	# @DESCRIPTION:
142	# Optional econf arguments as Bash array. Should be defined before calling src_configure.
143	# @CODE
144	# src_configure() {
145	# local myeconfargs=(
146	# --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	# @ECLASS-VARIABLE: DOCS
156	# @DEFAULT_UNSET
157	# @DESCRIPTION:
158	# Array containing documents passed to dodoc command.
159	#
160	# In EAPIs 4+, can list directories as well.
161	#
162	# 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	# @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	# If set to 'none', no .la files will be pruned ever. Use in corner
205	# cases only.
206
207	# Determine using IN or OUT source build
208	_check_build_dir() {
209	: ${ECONF_SOURCE:=${S}}
210	if [[ -n ${AUTOTOOLS_IN_SOURCE_BUILD} ]]; then
211	BUILD_DIR="${ECONF_SOURCE}"
212	else
213	# Respect both the old variable and the new one, depending
214	# on which one was set by the ebuild.
215	if [[ ! ${BUILD_DIR} && ${AUTOTOOLS_BUILD_DIR} ]]; then
216	eqawarn "The AUTOTOOLS_BUILD_DIR variable has been renamed to BUILD_DIR."
217	eqawarn "Please migrate the ebuild to use the new one."
218
219	# In the next call, both variables will be set already
220	# and we'd have to know which one takes precedence.
221	_RESPECT_AUTOTOOLS_BUILD_DIR=1
222	fi
223
224	if [[ ${_RESPECT_AUTOTOOLS_BUILD_DIR} ]]; then
225	BUILD_DIR=${AUTOTOOLS_BUILD_DIR:-${WORKDIR}/${P}_build}
226	else
227	: ${BUILD_DIR:=${WORKDIR}/${P}_build}
228	fi
229	fi
230
231	# Backwards compatibility for getting the value.
232	AUTOTOOLS_BUILD_DIR=${BUILD_DIR}
233	echo ">>> Working in BUILD_DIR: \"${BUILD_DIR}\""
234	}
235
236	# @FUNCTION: remove_libtool_files
237	# @USAGE: [all]
238	# @DESCRIPTION:
239	# Determines unnecessary libtool files (.la) and libtool static archives (.a)
240	# and removes them from installation image.
241	#
242	# To unconditionally remove all libtool files, pass 'all' as argument.
243	# Otherwise, libtool archives required for static linking will be preserved.
244	#
245	# In most cases it's not necessary to manually invoke this function.
246	# See autotools-utils_src_install for reference.
247	remove_libtool_files() {
248	debug-print-function ${FUNCNAME} "$@"
249	local removing_all
250
251	eqawarn "The remove_libtool_files() function was deprecated."
252	eqawarn "Please use prune_libtool_files() from eutils eclass instead."
253
254	[[ ${#} -le 1 ]] \|\| die "Invalid number of args to ${FUNCNAME}()"
255	if [[ ${#} -eq 1 ]]; then
256	case "${1}" in
257	all)
258	removing_all=1
259	;;
260	*)
261	die "Invalid argument to ${FUNCNAME}(): ${1}"
262	esac
263	fi
264
265	local pc_libs=()
266	if [[ ! ${removing_all} ]]; then
267	local arg
268	for arg in $(find "${D}" -name '*.pc' -exec \
269	sed -n -e 's;^Libs:;;p' {} +); do
270	[[ ${arg} == -l* ]] && pc_libs+=(lib${arg#-l}.la)
271	done
272	fi
273
274	local f
275	find "${D}" -type f -name '*.la' -print0 \| while read -r -d '' f; do
276	local shouldnotlink=$(sed -ne '/^shouldnotlink=yes$/p' "${f}")
277	local archivefile=${f/%.la/.a}
278	[[ "${f}" != "${archivefile}" ]] \|\| die 'regex sanity check failed'
279
280	# Remove static libs we're not supposed to link against.
281	if [[ ${shouldnotlink} ]]; then
282	einfo "Removing unnecessary ${archivefile#${D%/}}"
283	rm -f "${archivefile}" \|\| die
284	# The .la file may be used by a module loader, so avoid removing it
285	# unless explicitly requested.
286	[[ ${removing_all} ]] \|\| continue
287	fi
288
289	# Remove .la files when:
290	# - user explicitly wants us to remove all .la files,
291	# - respective static archive doesn't exist,
292	# - they are covered by a .pc file already,
293	# - they don't provide any new information (no libs & no flags).
294	local removing
295	if [[ ${removing_all} ]]; then removing='forced'
296	elif [[ ! -f ${archivefile} ]]; then removing='no static archive'
297	elif has "$(basename "${f}")" "${pc_libs[@]}"; then
298	removing='covered by .pc'
299	elif [[ ! $(sed -n -e \
300	"s/^\(dependency_libs\\|inherited_linker_flags\)='\(.*\)'$/\2/p" \
301	"${f}") ]]; then removing='no libs & flags'
302	fi
303
304	if [[ ${removing} ]]; then
305	einfo "Removing unnecessary ${f#${D%/}} (${removing})"
306	rm -f "${f}" \|\| die
307	fi
308	done
309	}
310
311	# @FUNCTION: autotools-utils_autoreconf
312	# @DESCRIPTION:
313	# Reconfigure the sources (like gnome-autogen.sh or eautoreconf).
314	autotools-utils_autoreconf() {
315	debug-print-function ${FUNCNAME} "$@"
316
317	eqawarn "The autotools-utils_autoreconf() function was deprecated."
318	eqawarn "Please call autotools-utils_src_prepare()"
319	eqawarn "with AUTOTOOLS_AUTORECONF set instead."
320
321	# Override this func to not require unnecessary eaclocal calls.
322	autotools_check_macro() {
323	local x
324
325	# Add a few additional variants as we don't get expansions.
326	[[ ${1} = AC_CONFIG_HEADERS ]] && set -- "${@}" \
327	AC_CONFIG_HEADER AM_CONFIG_HEADER
328
329	for x; do
330	grep -h "^${x}" configure.{ac,in} 2>/dev/null
331	done
332	}
333
334	einfo "Autoreconfiguring '${PWD}' ..."
335
336	local auxdir=$(sed -n -e 's/^AC_CONFIG_AUX_DIR(\(.*\))$/\1/p' \
337	configure.{ac,in} 2>/dev/null)
338	if [[ ${auxdir} ]]; then
339	auxdir=${auxdir%%]}
340	mkdir -p ${auxdir##[}
341	fi
342
343	# Support running additional tools like gnome-autogen.sh.
344	# Note: you need to add additional depends to the ebuild.
345
346	# gettext
347	if [[ $(autotools_check_macro AM_GLIB_GNU_GETTEXT) ]]; then
348	echo 'no' \| autotools_run_tool glib-gettextize --copy --force
349	elif [[ $(autotools_check_macro AM_GNU_GETTEXT) ]]; then
350	eautopoint --force
351	fi
352
353	# intltool
354	if [[ $(autotools_check_macro AC_PROG_INTLTOOL IT_PROG_INTLTOOL) ]]
355	then
356	autotools_run_tool intltoolize --copy --automake --force
357	fi
358
359	# gtk-doc
360	if [[ $(autotools_check_macro GTK_DOC_CHECK) ]]; then
361	autotools_run_tool gtkdocize --copy
362	fi
363
364	# gnome-doc
365	if [[ $(autotools_check_macro GNOME_DOC_INIT) ]]; then
366	autotools_run_tool gnome-doc-prepare --copy --force
367	fi
368
369	if [[ $(autotools_check_macro AC_PROG_LIBTOOL AM_PROG_LIBTOOL LT_INIT) ]]
370	then
371	_elibtoolize --copy --force --install
372	fi
373
374	eaclocal
375	eautoconf
376	eautoheader
377	FROM_EAUTORECONF=sure eautomake
378
379	local x
380	for x in $(autotools_check_macro_val AC_CONFIG_SUBDIRS); do
381	if [[ -d ${x} ]] ; then
382	pushd "${x}" >/dev/null \|\| die
383	autotools-utils_autoreconf
384	popd >/dev/null \|\| die
385	fi
386	done
387	}
388
389	# @FUNCTION: autotools-utils_src_prepare
390	# @DESCRIPTION:
391	# The src_prepare function.
392	#
393	# Supporting PATCHES array and user patches. See base.eclass(5) for reference.
394	autotools-utils_src_prepare() {
395	debug-print-function ${FUNCNAME} "$@"
396
397	local want_autoreconf=${AUTOTOOLS_AUTORECONF}
398
399	[[ ${PATCHES} ]] && epatch "${PATCHES[@]}"
400
401	at_checksum() {
402	find '(' -name 'Makefile.am' \
403	-o -name 'configure.ac' \
404	-o -name 'configure.in' ')' \
405	-exec cksum {} + \| sort -k2
406	}
407
408	[[ ! ${want_autoreconf} ]] && local checksum=$(at_checksum)
409	epatch_user
410	if [[ ! ${want_autoreconf} ]]; then
411	if [[ ${checksum} != $(at_checksum) ]]; then
412	einfo 'Will autoreconfigure due to user patches applied.'
413	want_autoreconf=yep
414	fi
415	fi
416
417	[[ ${want_autoreconf} ]] && eautoreconf
418	elibtoolize --patch-only
419	}
420
421	# @FUNCTION: autotools-utils_src_configure
422	# @DESCRIPTION:
423	# The src_configure function. For out of source build it creates build
424	# directory and runs econf there. Configuration parameters defined
425	# in myeconfargs are passed here to econf. Additionally following USE
426	# flags are known:
427	#
428	# IUSE="static-libs" passes --enable-shared and either --disable-static/--enable-static
429	# to econf respectively.
430	autotools-utils_src_configure() {
431	debug-print-function ${FUNCNAME} "$@"
432
433	[[ -z ${myeconfargs+1} \|\| $(declare -p myeconfargs) == 'declare -a'* ]] \
434	\|\| die 'autotools-utils.eclass: myeconfargs has to be an array.'
435
436	[[ ${EAPI} == 2 ]] && ! use prefix && EPREFIX=
437
438	# Common args
439	local econfargs=()
440
441	_check_build_dir
442	if "${ECONF_SOURCE}"/configure --help 2>&1 \| grep -q '^ *--docdir='; then
443	econfargs+=(
444	--docdir="${EPREFIX}"/usr/share/doc/${PF}
445	)
446	fi
447
448	# Handle static-libs found in IUSE, disable them by default
449	if in_iuse static-libs; then
450	econfargs+=(
451	--enable-shared
452	$(use_enable static-libs static)
453	)
454	fi
455
456	# Append user args
457	econfargs+=("${myeconfargs[@]}")
458
459	mkdir -p "${BUILD_DIR}" \|\| die
460	pushd "${BUILD_DIR}" > /dev/null \|\| die
461	econf "${econfargs[@]}" "$@"
462	popd > /dev/null \|\| die
463	}
464
465	# @FUNCTION: autotools-utils_src_compile
466	# @DESCRIPTION:
467	# The autotools src_compile function, invokes emake in specified BUILD_DIR.
468	autotools-utils_src_compile() {
469	debug-print-function ${FUNCNAME} "$@"
470
471	_check_build_dir
472	pushd "${BUILD_DIR}" > /dev/null \|\| die
473	emake "$@" \|\| die 'emake failed'
474	popd > /dev/null \|\| die
475	}
476
477	# @FUNCTION: autotools-utils_src_install
478	# @DESCRIPTION:
479	# The autotools src_install function. Runs emake install, unconditionally
480	# removes unnecessary static libs (based on shouldnotlink libtool property)
481	# and removes unnecessary libtool files when static-libs USE flag is defined
482	# and unset.
483	#
484	# DOCS and HTML_DOCS arrays are supported. See base.eclass(5) for reference.
485	autotools-utils_src_install() {
486	debug-print-function ${FUNCNAME} "$@"
487
488	_check_build_dir
489	pushd "${BUILD_DIR}" > /dev/null \|\| die
490	emake DESTDIR="${D}" "$@" install \|\| die "emake install failed"
491	popd > /dev/null \|\| die
492
493	# Move docs installed by autotools (in EAPI < 4).
494	if [[ ${EAPI} == [23] ]] \
495	&& path_exists "${D}${EPREFIX}"/usr/share/doc/${PF}/*; then
496	if [[ $(find "${D}${EPREFIX}"/usr/share/doc/${PF}/* -type d) ]]; then
497	eqawarn "autotools-utils: directories in docdir require at least EAPI 4"
498	else
499	mkdir "${T}"/temp-docdir
500	mv "${D}${EPREFIX}"/usr/share/doc/${PF}/* "${T}"/temp-docdir/ \
501	\|\| die "moving docs to tempdir failed"
502
503	dodoc "${T}"/temp-docdir/* \|\| die "docdir dodoc failed"
504	rm -r "${T}"/temp-docdir \|\| die
505	fi
506	fi
507
508	# XXX: support installing them from builddir as well?
509	if declare -p DOCS &>/dev/null; then
510	# an empty list == don't install anything
511	if [[ ${DOCS[@]} ]]; then
512	if [[ ${EAPI} == [23] ]]; then
513	dodoc "${DOCS[@]}" \|\| die
514	else
515	# dies by itself
516	dodoc -r "${DOCS[@]}"
517	fi
518	fi
519	else
520	local f
521	# same list as in PMS
522	for f in README* ChangeLog AUTHORS NEWS TODO CHANGES \
523	THANKS BUGS FAQ CREDITS CHANGELOG; do
524	if [[ -s ${f} ]]; then
525	dodoc "${f}" \|\| die "(default) dodoc ${f} failed"
526	fi
527	done
528	fi
529	if [[ ${HTML_DOCS} ]]; then
530	dohtml -r "${HTML_DOCS[@]}" \|\| die "dohtml failed"
531	fi
532
533	# Remove libtool files and unnecessary static libs
534	local prune_ltfiles=${AUTOTOOLS_PRUNE_LIBTOOL_FILES}
535	if [[ ${prune_ltfiles} != none ]]; then
536	prune_libtool_files ${prune_ltfiles:+--${prune_ltfiles}}
537	fi
538	}
539
540	# @FUNCTION: autotools-utils_src_test
541	# @DESCRIPTION:
542	# The autotools src_test function. Runs emake check in build directory.
543	autotools-utils_src_test() {
544	debug-print-function ${FUNCNAME} "$@"
545
546	_check_build_dir
547	pushd "${BUILD_DIR}" > /dev/null \|\| die
548
549	if make -n check &>/dev/null; then
550	emake check "${@}" \|\| die 'emake check failed.'
551	elif make -n test &>/dev/null; then
552	emake test "${@}" \|\| die 'emake test failed.'
553	fi
554
555	popd > /dev/null \|\| die
556	}