gentoo-x86/eclass/autotools-utils.eclass

# Copyright 1999-2012 Gentoo Foundation
# Distributed under the terms of the GNU General Public License v2
# $Header: /var/cvsroot/gentoo-x86/eclass/autotools-utils.eclass,v 1.56 2012/06/08 17:50:10 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? (
#               x11-libs/qt-core:4
#               x11-libs/qt-gui: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=("${AUTOTOOLS_BUILD_DIR}/apidocs/html/")
#       autotools-utils_src_install
#       if use examples; then
#               dobin "${AUTOTOOLS_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: AUTOTOOLS_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.

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

# Determine using IN or OUT source build
_check_build_dir() {
        : ${ECONF_SOURCE:=${S}}
        if [[ -n ${AUTOTOOLS_IN_SOURCE_BUILD} ]]; then
                AUTOTOOLS_BUILD_DIR="${ECONF_SOURCE}"
        else
                : ${AUTOTOOLS_BUILD_DIR:=${WORKDIR}/${P}_build}
        fi
        echo ">>> Working in BUILD_DIR: \"$AUTOTOOLS_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 "${AUTOTOOLS_BUILD_DIR}" || die "mkdir '${AUTOTOOLS_BUILD_DIR}' failed"
        pushd "${AUTOTOOLS_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 AUTOTOOLS_BUILD_DIR.
autotools-utils_src_compile() {
        debug-print-function ${FUNCNAME} "$@"

        _check_build_dir
        pushd "${AUTOTOOLS_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 "${AUTOTOOLS_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 [[ ${DOCS} ]]; then
                dodoc "${DOCS[@]}" || die "dodoc failed"
        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
        prune_libtool_files
}

# @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 "${AUTOTOOLS_BUILD_DIR}" > /dev/null || die
        # Run default src_test as defined in ebuild.sh
        default_src_test
        popd > /dev/null || die
}
1	mgorny	1.32	# Copyright 1999-2012 Gentoo Foundation
2	reavertm	1.1	# Distributed under the terms of the GNU General Public License v2
3	axs	1.57	# $Header: /var/cvsroot/gentoo-x86/eclass/autotools-utils.eclass,v 1.56 2012/06/08 17:50:10 mgorny Exp $
4	reavertm	1.1
5			# @ECLASS: autotools-utils.eclass
6			# @MAINTAINER:
7			# Maciej Mrozowski <reavertm@gentoo.org>
8	reavertm	1.10	# Michał Górny <mgorny@gentoo.org>
9	reavertm	1.1	# @BLURB: common ebuild functions for autotools-based packages
10			# @DESCRIPTION:
11			# autotools-utils.eclass is autotools.eclass(5) and base.eclass(5) wrapper
12			# providing all inherited features along with econf arguments as Bash array,
13			# out of source build with overridable build dir location, static archives
14	mgorny	1.28	# handling, libtool files removal.
15			#
16	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			# x11-libs/qt-core:4
41			# x11-libs/qt-gui:4
42			# )
43			# tiff? ( media-libs/tiff:0 )
44			# "
45			# RDEPEND="${CDEPEND}
46			# !media-gfx/bar
47			# "
48			# DEPEND="${CDEPEND}
49			# doc? ( app-doc/doxygen )
50			# "
51			#
52			# # bug 123456
53			# AUTOTOOLS_IN_SOURCE_BUILD=1
54			#
55			# DOCS=(AUTHORS ChangeLog README "Read me.txt" TODO)
56			#
57			# PATCHES=(
58			# "${FILESDIR}/${P}-gcc44.patch" # bug 123458
59			# "${FILESDIR}/${P}-as-needed.patch"
60			# "${FILESDIR}/${P}-unbundle_libpng.patch"
61			# )
62			#
63			# src_configure() {
64	reavertm	1.6	# local myeconfargs=(
65	mgorny	1.23	# $(use_enable debug)
66	reavertm	1.1	# $(use_with qt4)
67			# $(use_enable threads multithreading)
68			# $(use_with tiff)
69			# )
70			# autotools-utils_src_configure
71			# }
72			#
73			# src_compile() {
74			# autotools-utils_src_compile
75			# use doc && autotools-utils_src_compile docs
76			# }
77			#
78			# src_install() {
79			# use doc && HTML_DOCS=("${AUTOTOOLS_BUILD_DIR}/apidocs/html/")
80			# autotools-utils_src_install
81			# if use examples; then
82			# dobin "${AUTOTOOLS_BUILD_DIR}"/foo_example{1,2,3} \\
83			# \|\| die 'dobin examples failed'
84			# fi
85			# }
86			#
87			# @CODE
88
89			# Keep variable names synced with cmake-utils and the other way around!
90
91			case ${EAPI:-0} in
92	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			# @ECLASS-VARIABLE: AUTOTOOLS_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
126			# @ECLASS-VARIABLE: AUTOTOOLS_IN_SOURCE_BUILD
127	mgorny	1.30	# @DEFAULT_UNSET
128	reavertm	1.1	# @DESCRIPTION:
129			# Set to enable in-source build.
130
131			# @ECLASS-VARIABLE: ECONF_SOURCE
132	mgorny	1.30	# @DEFAULT_UNSET
133	reavertm	1.1	# @DESCRIPTION:
134			# Specify location of autotools' configure script. By default it uses ${S}.
135
136			# @ECLASS-VARIABLE: myeconfargs
137	mgorny	1.30	# @DEFAULT_UNSET
138	reavertm	1.1	# @DESCRIPTION:
139			# Optional econf arguments as Bash array. Should be defined before calling src_configure.
140			# @CODE
141			# src_configure() {
142	reavertm	1.7	# local myeconfargs=(
143	reavertm	1.1	# --disable-readline
144			# --with-confdir="/etc/nasty foo confdir/"
145			# $(use_enable debug cnddebug)
146			# $(use_enable threads multithreading)
147			# )
148			# autotools-utils_src_configure
149			# }
150			# @CODE
151
152	mgorny	1.30	# @ECLASS-VARIABLE: DOCS
153			# @DEFAULT_UNSET
154			# @DESCRIPTION:
155			# Array containing documents passed to dodoc command.
156			#
157			# Example:
158			# @CODE
159			# DOCS=( NEWS README )
160			# @CODE
161
162			# @ECLASS-VARIABLE: HTML_DOCS
163			# @DEFAULT_UNSET
164			# @DESCRIPTION:
165			# Array containing documents passed to dohtml command.
166			#
167			# Example:
168			# @CODE
169			# HTML_DOCS=( doc/html/ )
170			# @CODE
171
172			# @ECLASS-VARIABLE: PATCHES
173			# @DEFAULT_UNSET
174			# @DESCRIPTION:
175			# PATCHES array variable containing all various patches to be applied.
176			#
177			# Example:
178			# @CODE
179			# PATCHES=( "${FILESDIR}"/${P}-mypatch.patch )
180			# @CODE
181
182	reavertm	1.1	# Determine using IN or OUT source build
183			_check_build_dir() {
184			: ${ECONF_SOURCE:=${S}}
185			if [[ -n ${AUTOTOOLS_IN_SOURCE_BUILD} ]]; then
186			AUTOTOOLS_BUILD_DIR="${ECONF_SOURCE}"
187			else
188			: ${AUTOTOOLS_BUILD_DIR:=${WORKDIR}/${P}_build}
189			fi
190			echo ">>> Working in BUILD_DIR: \"$AUTOTOOLS_BUILD_DIR\""
191			}
192
193			# @FUNCTION: remove_libtool_files
194	mgorny	1.14	# @USAGE: [all]
195	reavertm	1.1	# @DESCRIPTION:
196			# Determines unnecessary libtool files (.la) and libtool static archives (.a)
197			# and removes them from installation image.
198	mgorny	1.14	#
199	reavertm	1.1	# To unconditionally remove all libtool files, pass 'all' as argument.
200	mgorny	1.14	# Otherwise, libtool archives required for static linking will be preserved.
201	reavertm	1.1	#
202			# In most cases it's not necessary to manually invoke this function.
203			# See autotools-utils_src_install for reference.
204			remove_libtool_files() {
205			debug-print-function ${FUNCNAME} "$@"
206	mgorny	1.16	local removing_all
207	mgorny	1.54
208			eqawarn "The remove_libtool_files() function was deprecated."
209			eqawarn "Please use prune_libtool_files() from eutils eclass instead."
210
211	mgorny	1.16	[[ ${#} -le 1 ]] \|\| die "Invalid number of args to ${FUNCNAME}()"
212			if [[ ${#} -eq 1 ]]; then
213			case "${1}" in
214			all)
215			removing_all=1
216			;;
217			*)
218			die "Invalid argument to ${FUNCNAME}(): ${1}"
219			esac
220			fi
221	reavertm	1.1
222	mgorny	1.19	local pc_libs=()
223			if [[ ! ${removing_all} ]]; then
224			local arg
225			for arg in $(find "${D}" -name '*.pc' -exec \
226			sed -n -e 's;^Libs:;;p' {} +); do
227			[[ ${arg} == -l* ]] && pc_libs+=(lib${arg#-l}.la)
228			done
229			fi
230
231	reavertm	1.1	local f
232	mgorny	1.12	find "${D}" -type f -name '*.la' -print0 \| while read -r -d '' f; do
233	reavertm	1.1	local shouldnotlink=$(sed -ne '/^shouldnotlink=yes$/p' "${f}")
234	mgorny	1.14	local archivefile=${f/%.la/.a}
235	mgorny	1.15	[[ "${f}" != "${archivefile}" ]] \|\| die 'regex sanity check failed'
236	mgorny	1.14
237	mgorny	1.18	# Remove static libs we're not supposed to link against.
238	mgorny	1.17	if [[ ${shouldnotlink} ]]; then
239			einfo "Removing unnecessary ${archivefile#${D%/}}"
240			rm -f "${archivefile}" \|\| die
241	mgorny	1.18	# The .la file may be used by a module loader, so avoid removing it
242			# unless explicitly requested.
243	mgorny	1.17	[[ ${removing_all} ]] \|\| continue
244			fi
245
246	mgorny	1.18	# Remove .la files when:
247			# - user explicitly wants us to remove all .la files,
248			# - respective static archive doesn't exist,
249	mgorny	1.19	# - they are covered by a .pc file already,
250	mgorny	1.18	# - they don't provide any new information (no libs & no flags).
251			local removing
252	mgorny	1.20	if [[ ${removing_all} ]]; then removing='forced'
253			elif [[ ! -f ${archivefile} ]]; then removing='no static archive'
254			elif has "$(basename "${f}")" "${pc_libs[@]}"; then
255			removing='covered by .pc'
256	mgorny	1.18	elif [[ ! $(sed -n -e \
257			"s/^\(dependency_libs\\|inherited_linker_flags\)='\(.*\)'$/\2/p" \
258	mgorny	1.20	"${f}") ]]; then removing='no libs & flags'
259	mgorny	1.18	fi
260
261			if [[ ${removing} ]]; then
262	mgorny	1.20	einfo "Removing unnecessary ${f#${D%/}} (${removing})"
263	mgorny	1.15	rm -f "${f}" \|\| die
264	reavertm	1.1	fi
265			done
266			}
267
268	mgorny	1.32	# @FUNCTION: autotools-utils_autoreconf
269			# @DESCRIPTION:
270			# Reconfigure the sources (like gnome-autogen.sh or eautoreconf).
271			autotools-utils_autoreconf() {
272			debug-print-function ${FUNCNAME} "$@"
273
274	mgorny	1.55	eqawarn "The autotools-utils_autoreconf() function was deprecated."
275			eqawarn "Please call autotools-utils_src_prepare()"
276			eqawarn "with AUTOTOOLS_AUTORECONF set instead."
277
278	mgorny	1.32	# Override this func to not require unnecessary eaclocal calls.
279			autotools_check_macro() {
280			local x
281
282			# Add a few additional variants as we don't get expansions.
283	mgorny	1.44	[[ ${1} = AC_CONFIG_HEADERS ]] && set -- "${@}" \
284			AC_CONFIG_HEADER AM_CONFIG_HEADER
285	mgorny	1.32
286			for x; do
287			grep -h "^${x}" configure.{ac,in} 2>/dev/null
288			done
289			}
290
291			einfo "Autoreconfiguring '${PWD}' ..."
292
293			local auxdir=$(sed -n -e 's/^AC_CONFIG_AUX_DIR(\(.*\))$/\1/p' \
294			configure.{ac,in} 2>/dev/null)
295			if [[ ${auxdir} ]]; then
296			auxdir=${auxdir%%]}
297			mkdir -p ${auxdir##[}
298			fi
299
300			# Support running additional tools like gnome-autogen.sh.
301			# Note: you need to add additional depends to the ebuild.
302
303			# gettext
304			if [[ $(autotools_check_macro AM_GLIB_GNU_GETTEXT) ]]; then
305	jlec	1.46	echo 'no' \| autotools_run_tool glib-gettextize --copy --force
306	mgorny	1.32	elif [[ $(autotools_check_macro AM_GNU_GETTEXT) ]]; then
307	mgorny	1.38	eautopoint --force
308	mgorny	1.32	fi
309
310			# intltool
311			if [[ $(autotools_check_macro AC_PROG_INTLTOOL IT_PROG_INTLTOOL) ]]
312			then
313	mgorny	1.38	autotools_run_tool intltoolize --copy --automake --force
314	mgorny	1.32	fi
315
316			# gtk-doc
317			if [[ $(autotools_check_macro GTK_DOC_CHECK) ]]; then
318			autotools_run_tool gtkdocize --copy
319			fi
320
321			# gnome-doc
322			if [[ $(autotools_check_macro GNOME_DOC_INIT) ]]; then
323	mgorny	1.38	autotools_run_tool gnome-doc-prepare --copy --force
324	mgorny	1.32	fi
325
326			if [[ $(autotools_check_macro AC_PROG_LIBTOOL AM_PROG_LIBTOOL LT_INIT) ]]
327			then
328			_elibtoolize --copy --force --install
329			fi
330
331	mgorny	1.50	eaclocal
332	mgorny	1.32	eautoconf
333			eautoheader
334	mgorny	1.36	FROM_EAUTORECONF=sure eautomake
335	mgorny	1.32
336			local x
337	mgorny	1.49	for x in $(autotools_check_macro_val AC_CONFIG_SUBDIRS); do
338	mgorny	1.32	if [[ -d ${x} ]] ; then
339	mgorny	1.52	pushd "${x}" >/dev/null \|\| die
340	mgorny	1.48	autotools-utils_autoreconf
341	mgorny	1.52	popd >/dev/null \|\| die
342	mgorny	1.32	fi
343			done
344			}
345
346	reavertm	1.1	# @FUNCTION: autotools-utils_src_prepare
347			# @DESCRIPTION:
348			# The src_prepare function.
349			#
350			# Supporting PATCHES array and user patches. See base.eclass(5) for reference.
351			autotools-utils_src_prepare() {
352			debug-print-function ${FUNCNAME} "$@"
353
354	mgorny	1.32	local want_autoreconf=${AUTOTOOLS_AUTORECONF}
355
356	mgorny	1.45	[[ ${PATCHES} ]] && epatch "${PATCHES[@]}"
357
358	mgorny	1.47	at_checksum() {
359			find '(' -name 'Makefile.am' \
360			-o -name 'configure.ac' \
361			-o -name 'configure.in' ')' \
362			-exec cksum {} + \| sort -k2
363			}
364
365			[[ ! ${want_autoreconf} ]] && local checksum=$(at_checksum)
366	mgorny	1.30	epatch_user
367	mgorny	1.37	if [[ ! ${want_autoreconf} ]]; then
368	mgorny	1.47	if [[ ${checksum} != $(at_checksum) ]]; then
369	mgorny	1.45	einfo 'Will autoreconfigure due to user patches applied.'
370	mgorny	1.37	want_autoreconf=yep
371			fi
372			fi
373	mgorny	1.30
374	mgorny	1.55	[[ ${want_autoreconf} ]] && eautoreconf
375	mgorny	1.25	elibtoolize --patch-only
376	reavertm	1.1	}
377
378			# @FUNCTION: autotools-utils_src_configure
379			# @DESCRIPTION:
380			# The src_configure function. For out of source build it creates build
381			# directory and runs econf there. Configuration parameters defined
382			# in myeconfargs are passed here to econf. Additionally following USE
383			# flags are known:
384			#
385			# IUSE="static-libs" passes --enable-shared and either --disable-static/--enable-static
386			# to econf respectively.
387			autotools-utils_src_configure() {
388			debug-print-function ${FUNCNAME} "$@"
389
390	mgorny	1.22	[[ -z ${myeconfargs+1} \|\| $(declare -p myeconfargs) == 'declare -a'* ]] \
391			\|\| die 'autotools-utils.eclass: myeconfargs has to be an array.'
392
393	mgorny	1.35	[[ ${EAPI} == 2 ]] && ! use prefix && EPREFIX=
394
395	reavertm	1.1	# Common args
396	mgorny	1.41	local econfargs=()
397
398			_check_build_dir
399	mgorny	1.43	if "${ECONF_SOURCE}"/configure --help 2>&1 \| grep -q '^ *--docdir='; then
400	mgorny	1.41	econfargs+=(
401			--docdir="${EPREFIX}"/usr/share/doc/${PF}
402			)
403			fi
404	reavertm	1.1
405			# Handle static-libs found in IUSE, disable them by default
406	mgorny	1.24	if in_iuse static-libs; then
407	reavertm	1.1	econfargs+=(
408			--enable-shared
409			$(use_enable static-libs static)
410			)
411			fi
412
413			# Append user args
414	reavertm	1.5	econfargs+=("${myeconfargs[@]}")
415	reavertm	1.1
416			mkdir -p "${AUTOTOOLS_BUILD_DIR}" \|\| die "mkdir '${AUTOTOOLS_BUILD_DIR}' failed"
417	mgorny	1.52	pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null \|\| die
418	mgorny	1.30	econf "${econfargs[@]}" "$@"
419	mgorny	1.52	popd > /dev/null \|\| die
420	reavertm	1.1	}
421
422			# @FUNCTION: autotools-utils_src_compile
423			# @DESCRIPTION:
424			# The autotools src_compile function, invokes emake in specified AUTOTOOLS_BUILD_DIR.
425			autotools-utils_src_compile() {
426			debug-print-function ${FUNCNAME} "$@"
427
428			_check_build_dir
429	mgorny	1.52	pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null \|\| die
430	mgorny	1.30	emake "$@" \|\| die 'emake failed'
431	mgorny	1.52	popd > /dev/null \|\| die
432	reavertm	1.1	}
433
434			# @FUNCTION: autotools-utils_src_install
435			# @DESCRIPTION:
436			# The autotools src_install function. Runs emake install, unconditionally
437			# removes unnecessary static libs (based on shouldnotlink libtool property)
438			# and removes unnecessary libtool files when static-libs USE flag is defined
439			# and unset.
440			#
441			# DOCS and HTML_DOCS arrays are supported. See base.eclass(5) for reference.
442			autotools-utils_src_install() {
443			debug-print-function ${FUNCNAME} "$@"
444
445			_check_build_dir
446	mgorny	1.52	pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null \|\| die
447	mgorny	1.30	emake DESTDIR="${D}" "$@" install \|\| die "emake install failed"
448	mgorny	1.52	popd > /dev/null \|\| die
449	reavertm	1.1
450	mgorny	1.35	# Move docs installed by autotools (in EAPI < 4).
451	mgorny	1.40	if [[ ${EAPI} == [23] ]] \
452			&& path_exists "${D}${EPREFIX}"/usr/share/doc/${PF}/*; then
453	mgorny	1.39	if [[ $(find "${D}${EPREFIX}"/usr/share/doc/${PF}/* -type d) ]]; then
454			eqawarn "autotools-utils: directories in docdir require at least EAPI 4"
455			else
456			mkdir "${T}"/temp-docdir
457			mv "${D}${EPREFIX}"/usr/share/doc/${PF}/* "${T}"/temp-docdir/ \
458			\|\| die "moving docs to tempdir failed"
459	mgorny	1.35
460	mgorny	1.39	dodoc "${T}"/temp-docdir/* \|\| die "docdir dodoc failed"
461			rm -r "${T}"/temp-docdir \|\| die
462			fi
463	mgorny	1.35	fi
464
465	mgorny	1.30	# XXX: support installing them from builddir as well?
466			if [[ ${DOCS} ]]; then
467			dodoc "${DOCS[@]}" \|\| die "dodoc failed"
468	mgorny	1.34	else
469			local f
470			# same list as in PMS
471			for f in README* ChangeLog AUTHORS NEWS TODO CHANGES \
472			THANKS BUGS FAQ CREDITS CHANGELOG; do
473			if [[ -s ${f} ]]; then
474			dodoc "${f}" \|\| die "(default) dodoc ${f} failed"
475			fi
476			done
477	mgorny	1.30	fi
478			if [[ ${HTML_DOCS} ]]; then
479			dohtml -r "${HTML_DOCS[@]}" \|\| die "dohtml failed"
480			fi
481
482	reavertm	1.1	# Remove libtool files and unnecessary static libs
483	mgorny	1.54	prune_libtool_files
484	reavertm	1.1	}
485
486			# @FUNCTION: autotools-utils_src_test
487			# @DESCRIPTION:
488			# The autotools src_test function. Runs emake check in build directory.
489			autotools-utils_src_test() {
490			debug-print-function ${FUNCNAME} "$@"
491
492			_check_build_dir
493	mgorny	1.52	pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null \|\| die
494	reavertm	1.1	# Run default src_test as defined in ebuild.sh
495			default_src_test
496	mgorny	1.52	popd > /dev/null \|\| die
497	reavertm	1.1	}