eclass/autotools-utils.eclass - mirrors/cros/chromiumos/overlays/portage-stable - Git at Google

 # 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.57 2012/09/27 16:35:41 axs 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
 }
	# 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.57 2012/09/27 16:35:41 axs 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
	}