gentoo-x86/eclass/autotools.eclass

# Copyright 1999-2012 Gentoo Foundation
# Distributed under the terms of the GNU General Public License v2
# $Header: /var/cvsroot/gentoo-x86/eclass/autotools.eclass,v 1.144 2012/06/06 17:15:08 mgorny Exp $

# @ECLASS: autotools.eclass
# @MAINTAINER:
# base-system@gentoo.org
# @BLURB: Regenerates auto* build scripts
# @DESCRIPTION:
# This eclass is for safely handling autotooled software packages that need to
# regenerate their build scripts.  All functions will abort in case of errors.

# Note: We require GNU m4, as does autoconf.  So feel free to use any features
# from the GNU version of m4 without worrying about other variants (i.e. BSD).

if [[ ${___ECLASS_ONCE_AUTOTOOLS} != "recur -_+^+_- spank" ]] ; then
___ECLASS_ONCE_AUTOTOOLS="recur -_+^+_- spank"

inherit libtool

# @ECLASS-VARIABLE: WANT_AUTOCONF
# @DESCRIPTION:
# The major version of autoconf your package needs
: ${WANT_AUTOCONF:=latest}

# @ECLASS-VARIABLE: WANT_AUTOMAKE
# @DESCRIPTION:
# The major version of automake your package needs
: ${WANT_AUTOMAKE:=latest}

# @ECLASS-VARIABLE: WANT_LIBTOOL
# @DESCRIPTION:
# Do you want libtool?  Valid values here are "latest" and "none".
: ${WANT_LIBTOOL:=latest}

# @ECLASS-VARIABLE: _LATEST_AUTOMAKE
# @INTERNAL
# @DESCRIPTION:
# CONSTANT!
# The latest major version/slot of automake available on each arch.  #312315
# If a newer slot is stable on any arch, and is NOT reflected in this list,
# then circular dependencies may arise during emerge @system bootstraps.
# Do NOT change this variable in your ebuilds!
# If you want to force a newer minor version, you can specify the correct
# WANT value by using a colon:  <PV>[:<WANT_AUTOMAKE>]
_LATEST_AUTOMAKE=( 1.11.1:1.11 )

_automake_atom="sys-devel/automake"
_autoconf_atom="sys-devel/autoconf"
if [[ -n ${WANT_AUTOMAKE} ]]; then
        case ${WANT_AUTOMAKE} in
                # Even if the package doesn't use automake, we still need to depend
                # on it because we run aclocal to process m4 macros.  This matches
                # the autoreconf tool, so this requirement is correct.  #401605
                none) ;;
                latest)
                        # Use SLOT deps if we can.  For EAPI=0, we get pretty close.
                        if [[ ${EAPI:-0} != 0 ]] ; then
                                _automake_atom="|| ( `printf '>=sys-devel/automake-%s:%s ' ${_LATEST_AUTOMAKE[@]/:/ }` )"
                        else
                                _automake_atom="|| ( `printf '>=sys-devel/automake-%s ' ${_LATEST_AUTOMAKE[@]/%:*}` )"
                        fi
                        ;;
                *)      _automake_atom="=sys-devel/automake-${WANT_AUTOMAKE}*" ;;
        esac
        export WANT_AUTOMAKE
fi

if [[ -n ${WANT_AUTOCONF} ]] ; then
        case ${WANT_AUTOCONF} in
                none)       _autoconf_atom="" ;; # some packages don't require autoconf at all
                2.1)        _autoconf_atom="=sys-devel/autoconf-${WANT_AUTOCONF}*" ;;
                # if you change the "latest" version here, change also autotools_env_setup
                latest|2.5) _autoconf_atom=">=sys-devel/autoconf-2.68" ;;
                *)          die "Invalid WANT_AUTOCONF value '${WANT_AUTOCONF}'" ;;
        esac
        export WANT_AUTOCONF
fi

_libtool_atom="sys-devel/libtool"
if [[ -n ${WANT_LIBTOOL} ]] ; then
        case ${WANT_LIBTOOL} in
                none)   _libtool_atom="" ;;
                latest) ;;
                *)      die "Invalid WANT_LIBTOOL value '${WANT_LIBTOOL}'" ;;
        esac
        export WANT_LIBTOOL
fi

AUTOTOOLS_DEPEND="${_automake_atom} ${_autoconf_atom} ${_libtool_atom}"
RDEPEND=""

# @ECLASS-VARIABLE: AUTOTOOLS_AUTO_DEPEND
# @DESCRIPTION:
# Set to 'no' to disable automatically adding to DEPEND.  This lets
# ebuilds former conditional depends by using ${AUTOTOOLS_DEPEND} in
# their own DEPEND string.
: ${AUTOTOOLS_AUTO_DEPEND:=yes}
if [[ ${AUTOTOOLS_AUTO_DEPEND} != "no" ]] ; then
        DEPEND=${AUTOTOOLS_DEPEND}
fi

unset _automake_atom _autoconf_atom

# @ECLASS-VARIABLE: AM_OPTS
# @DEFAULT_UNSET
# @DESCRIPTION:
# Additional options to pass to automake during
# eautoreconf call.

# @ECLASS-VARIABLE: AT_NOEAUTOMAKE
# @DEFAULT_UNSET
# @DESCRIPTION:
# Don't run eautomake command if set to 'yes'; only used to workaround
# broken packages.  Generally you should, instead, fix the package to
# not call AM_INIT_AUTOMAKE if it doesn't actually use automake.

# @ECLASS-VARIABLE: AT_NOELIBTOOLIZE
# @DEFAULT_UNSET
# @DESCRIPTION:
# Don't run elibtoolize command if set to 'yes',
# useful when elibtoolize needs to be ran with
# particular options

# @ECLASS-VARIABLE: AT_M4DIR
# @DESCRIPTION:
# Additional director(y|ies) aclocal should search
: ${AT_M4DIR:=}

# @ECLASS-VARIABLE: AT_SYS_M4DIR
# @INTERNAL
# @DESCRIPTION:
# For system integrators, a list of additional aclocal search paths.
# This variable gets eval-ed, so you can use variables in the definition
# that may not be valid until eautoreconf & friends are run.
: ${AT_SYS_M4DIR:=}

# @FUNCTION: eautoreconf
# @DESCRIPTION:
# This function mimes the behavior of autoreconf, but uses the different
# eauto* functions to run the tools. It doesn't accept parameters, but
# the directory with include files can be specified with AT_M4DIR variable.
#
# Should do a full autoreconf - normally what most people will be interested in.
# Also should handle additional directories specified by AC_CONFIG_SUBDIRS.
eautoreconf() {
        local x g

        if [[ -z ${AT_NO_RECURSIVE} ]]; then
                # Take care of subdirs
                for x in $(autotools_check_macro_val AC_CONFIG_SUBDIRS) ; do
                        if [[ -d ${x} ]] ; then
                                pushd "${x}" >/dev/null
                                AT_NOELIBTOOLIZE="yes" eautoreconf
                                popd >/dev/null
                        fi
                done
        fi

        einfo "Running eautoreconf in '${PWD}' ..."

        local m4dirs=$(autotools_check_macro_val AC_CONFIG_{AUX,MACRO}_DIR)
        [[ -n ${m4dirs} ]] && mkdir -p ${m4dirs}

        # Run all the tools before aclocal so we can gather the .m4 files.
        local i tools=(
                # <tool> <was run> <command>
                glibgettext false "autotools_run_tool glib-gettextize --copy --force"
                gettext     false "autotools_run_tool --at-missing autopoint --force"
                # intltool must come after autopoint.
                intltool    false "autotools_run_tool intltoolize --automake --copy --force"
                gtkdoc      false "autotools_run_tool --at-missing gtkdocize --copy"
                gnomedoc    false "autotools_run_tool --at-missing gnome-doc-prepare --copy --force"
                libtool     false "_elibtoolize --install --copy --force"
        )
        for (( i = 0; i < ${#tools[@]}; i += 3 )) ; do
                if _at_uses_${tools[i]} ; then
                        tools[i+1]=true
                        ${tools[i+2]}
                fi
        done

        # Generate aclocal.m4 with our up-to-date m4 files.
        local rerun_aclocal=false
        eaclocal

        # Check to see if we had macros expanded by other macros or in other
        # m4 files that we couldn't detect early.  This is uncommon, but some
        # packages do this, so we have to handle it correctly.
        for (( i = 0; i < ${#tools[@]}; i += 3 )) ; do
                if ! ${tools[i+1]} && _at_uses_${tools[i]} ; then
                        ${tools[i+2]}
                        rerun_aclocal=true
                fi
        done
        ${rerun_aclocal} && eaclocal

        eautoconf
        eautoheader
        [[ ${AT_NOEAUTOMAKE} != "yes" ]] && FROM_EAUTORECONF="yes" eautomake ${AM_OPTS}

        [[ ${AT_NOELIBTOOLIZE} == "yes" ]] && return 0

        # Call it here to prevent failures due to elibtoolize called _before_
        # eautoreconf.  We set $S because elibtoolize runs on that #265319
        S=${PWD} elibtoolize --force

        return 0
}

# @FUNCTION: _at_uses_pkg
# @USAGE: <macros>
# @INTERNAL
# See if the specified macros are enabled.
_at_uses_pkg() {
        if [[ -n $(autotools_check_macro "$@") ]] ; then
                return 0
        else
                # If the trace didn't find it (perhaps because aclocal.m4 hasn't
                # been generated yet), cheat, but be conservative.
                local macro args=()
                for macro ; do
                        args+=( -e "^[[:space:]]*${macro}\>" )
                done
                egrep -q "${args[@]}" configure.??
        fi
}
_at_uses_autoheader()  { _at_uses_pkg AC_CONFIG_HEADERS; }
_at_uses_automake()    { _at_uses_pkg AM_INIT_AUTOMAKE; }
_at_uses_gettext()     { _at_uses_pkg AM_GNU_GETTEXT_VERSION; }
_at_uses_glibgettext() { _at_uses_pkg AM_GLIB_GNU_GETTEXT; }
_at_uses_intltool()    { _at_uses_pkg {AC,IT}_PROG_INTLTOOL; }
_at_uses_gtkdoc()      { _at_uses_pkg GTK_DOC_CHECK; }
_at_uses_gnomedoc()    { _at_uses_pkg GNOME_DOC_INIT; }
_at_uses_libtool()     { _at_uses_pkg A{C,M}_PROG_LIBTOOL LT_INIT; }

# @FUNCTION: eaclocal_amflags
# @DESCRIPTION:
# Extract the ACLOCAL_AMFLAGS value from the Makefile.am and try to handle
# (most) of the crazy crap that people throw at us.
eaclocal_amflags() {
        local aclocal_opts amflags_file

        for amflags_file in GNUmakefile.am Makefile.am GNUmakefile.in Makefile.in ; do
                [[ -e ${amflags_file} ]] || continue
                # setup the env in case the pkg does something crazy
                # in their ACLOCAL_AMFLAGS.  like run a shell script
                # which turns around and runs autotools. #365401
                # or split across multiple lines. #383525
                autotools_env_setup
                aclocal_opts=$(sed -n \
                        "/^ACLOCAL_AMFLAGS[[:space:]]*=/{ \
                          # match the first line
                          s:[^=]*=::p; \
                          # then gobble up all escaped lines
                          : nextline /\\\\$/{ n; p; b nextline; } \
                        }" ${amflags_file})
                eval aclocal_opts=\""${aclocal_opts}"\"
                break
        done

        echo ${aclocal_opts}
}

# @FUNCTION: eaclocal
# @DESCRIPTION:
# These functions runs the autotools using autotools_run_tool with the
# specified parametes. The name of the tool run is the same of the function
# without e prefix.
# They also force installing the support files for safety.
# Respects AT_M4DIR for additional directories to search for macro's.
eaclocal() {
        [[ ! -f aclocal.m4 || -n $(grep -e 'generated.*by aclocal' aclocal.m4) ]] && \
                autotools_run_tool --at-m4flags aclocal "$@" $(eaclocal_amflags)
}

# @FUNCTION: _elibtoolize
# @DESCRIPTION:
# Runs libtoolize.  If --install is the first arg, automatically drop it if
# the active libtool version doesn't support it.
#
# Note the '_' prefix .. to not collide with elibtoolize() from libtool.eclass.
_elibtoolize() {
        local LIBTOOLIZE=${LIBTOOLIZE:-libtoolize}
        type -P glibtoolize > /dev/null && LIBTOOLIZE=glibtoolize

        [[ -f GNUmakefile.am || -f Makefile.am ]] && set -- "$@" --automake
        if [[ $1 == "--install" ]] ; then
                ${LIBTOOLIZE} -n --install >& /dev/null || shift
        fi

        autotools_run_tool ${LIBTOOLIZE} "$@" ${opts}
}

# @FUNCTION: eautoheader
# @DESCRIPTION:
# Runs autoheader.
eautoheader() {
        _at_uses_autoheader || return 0
        autotools_run_tool --at-no-fail --at-m4flags autoheader "$@"
}

# @FUNCTION: eautoconf
# @DESCRIPTION:
# Runs autoconf.
eautoconf() {
        if [[ ! -f configure.ac && ! -f configure.in ]] ; then
                echo
                eerror "No configure.{ac,in} present in '${PWD}'!"
                echo
                die "No configure.{ac,in} present!"
        fi

        autotools_run_tool --at-m4flags autoconf "$@"
}

# @FUNCTION: eautomake
# @DESCRIPTION:
# Runs automake.
eautomake() {
        local extra_opts
        local makefile_name

        # Run automake if:
        #  - a Makefile.am type file exists
        #  - the configure script is using the AM_INIT_AUTOMAKE directive
        for makefile_name in {GNUmakefile,{M,m}akefile}.am "" ; do
                [[ -f ${makefile_name} ]] && break
        done

        if [[ -z ${makefile_name} ]] ; then
                _at_uses_automake || return 0

        elif [[ -z ${FROM_EAUTORECONF} && -f ${makefile_name%.am}.in ]]; then
                local used_automake
                local installed_automake

                installed_automake=$(WANT_AUTOMAKE= automake --version | head -n 1 | \
                        sed -e 's:.*(GNU automake) ::')
                used_automake=$(head -n 1 < ${makefile_name%.am}.in | \
                        sed -e 's:.*by automake \(.*\) from .*:\1:')

                if [[ ${installed_automake} != ${used_automake} ]]; then
                        einfo "Automake used for the package (${used_automake}) differs from"
                        einfo "the installed version (${installed_automake})."
                        eautoreconf
                        return 0
                fi
        fi

        [[ -f INSTALL && -f AUTHORS && -f ChangeLog && -f NEWS && -f README ]] \
                || extra_opts="${extra_opts} --foreign"

        # --force-missing seems not to be recognized by some flavours of automake
        autotools_run_tool automake --add-missing --copy ${extra_opts} "$@"
}

# @FUNCTION: eautopoint
# @DESCRIPTION:
# Runs autopoint (from the gettext package).
eautopoint() {
        autotools_run_tool autopoint "$@"
}

# @FUNCTION: config_rpath_update
# @USAGE: [destination]
# @DESCRIPTION:
# Some packages utilize the config.rpath helper script, but don't
# use gettext directly.  So we have to copy it in manually since
# we can't let `autopoint` do it for us.
config_rpath_update() {
        local dst src=$(type -P gettext | sed 's:bin/gettext:share/gettext/config.rpath:')

        [[ $# -eq 0 ]] && set -- $(find -name config.rpath)
        [[ $# -eq 0 ]] && return 0

        einfo "Updating all config.rpath files"
        for dst in "$@" ; do
                einfo "   ${dst}"
                cp "${src}" "${dst}" || die
        done
}

# @FUNCTION: autotools_env_setup
# @INTERNAL
# @DESCRIPTION:
# Process the WANT_AUTO{CONF,MAKE} flags.
autotools_env_setup() {
        # We do the "latest" → version switch here because it solves
        # possible order problems, see bug #270010 as an example.
        if [[ ${WANT_AUTOMAKE} == "latest" ]]; then
                local pv
                for pv in ${_LATEST_AUTOMAKE[@]/#*:} ; do
                        # has_version respects ROOT, but in this case, we don't want it to,
                        # thus "ROOT=/" prefix:
                        ROOT=/ has_version "=sys-devel/automake-${pv}*" && export WANT_AUTOMAKE="${pv}"
                done
                [[ ${WANT_AUTOMAKE} == "latest" ]] && \
                        die "Cannot find the latest automake! Tried ${_LATEST_AUTOMAKE}"
        fi
        [[ ${WANT_AUTOCONF} == "latest" ]] && export WANT_AUTOCONF=2.5
}

# @FUNCTION: autotools_run_tool
# @USAGE: [--at-no-fail] [--at-m4flags] [--at-missing] <autotool> [tool-specific flags]
# @INTERNAL
# @DESCRIPTION:
# Run the specified autotool helper, but do logging and error checking
# around it in the process.
autotools_run_tool() {
        # Process our own internal flags first
        local autofail=true m4flags=false missing_ok=false
        while [[ -n $1 ]] ; do
                case $1 in
                --at-no-fail) autofail=false;;
                --at-m4flags) m4flags=true;;
                --at-missing) missing_ok=true;;
                # whatever is left goes to the actual tool
                *) break;;
                esac
                shift
        done

        if [[ ${EBUILD_PHASE} != "unpack" && ${EBUILD_PHASE} != "prepare" ]]; then
                ewarn "QA Warning: running $1 in ${EBUILD_PHASE} phase"
        fi

        if ${missing_ok} && ! type -P ${1} >/dev/null ; then
                einfo "Skipping '$*' due $1 not installed"
                return 0
        fi

        autotools_env_setup

        local STDERR_TARGET="${T}/$1.out"
        # most of the time, there will only be one run, but if there are
        # more, make sure we get unique log filenames
        if [[ -e ${STDERR_TARGET} ]] ; then
                local i=1
                while :; do
                        STDERR_TARGET="${T}/$1-${i}.out"
                        [[ -e ${STDERR_TARGET} ]] || break
                        : $(( i++ ))
                done
        fi

        if ${m4flags} ; then
                set -- "${1}" $(autotools_m4dir_include) "${@:2}" $(autotools_m4sysdir_include)
        fi

        printf "***** $1 *****\n***** PWD: ${PWD}\n***** $*\n\n" > "${STDERR_TARGET}"

        ebegin "Running $@"
        "$@" >> "${STDERR_TARGET}" 2>&1
        if ! eend $? && ${autofail} ; then
                echo
                eerror "Failed Running $1 !"
                eerror
                eerror "Include in your bugreport the contents of:"
                eerror
                eerror "  ${STDERR_TARGET}"
                echo
                die "Failed Running $1 !"
        fi
}

# Internal function to check for support

# Keep a list of all the macros we might use so that we only
# have to run the trace code once.  Order doesn't matter.
ALL_AUTOTOOLS_MACROS=(
        AC_PROG_LIBTOOL AM_PROG_LIBTOOL LT_INIT
        AC_CONFIG_HEADERS
        AC_CONFIG_SUBDIRS
        AC_CONFIG_AUX_DIR AC_CONFIG_MACRO_DIR
        AM_INIT_AUTOMAKE
        AM_GLIB_GNU_GETTEXT
        AM_GNU_GETTEXT_VERSION
        {AC,IT}_PROG_INTLTOOL
        GTK_DOC_CHECK
        GNOME_DOC_INIT
)
autotools_check_macro() {
        [[ -f configure.ac || -f configure.in ]] || return 0

        # We can run in multiple dirs, so we have to cache the trace
        # data in $PWD rather than an env var.
        local trace_file=".__autoconf_trace_data"
        if [[ ! -e ${trace_file} ]] || [[ aclocal.m4 -nt ${trace_file} ]] ; then
                WANT_AUTOCONF="2.5" autoconf \
                        $(autotools_m4dir_include) \
                        ${ALL_AUTOTOOLS_MACROS[@]/#/--trace=} > ${trace_file} 2>/dev/null
        fi

        local macro args=()
        for macro ; do
                has ${macro} ${ALL_AUTOTOOLS_MACROS[@]} || die "internal error: add ${macro} to ALL_AUTOTOOLS_MACROS"
                args+=( -e ":${macro}:" )
        done
        grep "${args[@]}" ${trace_file}
}

# @FUNCTION: autotools_check_macro_val
# @USAGE: <macro> [macros]
# @INTERNAL
# @DESCRIPTION:
# Look for a macro and extract its value.
autotools_check_macro_val() {
        local macro scan_out

        for macro ; do
                autotools_check_macro "${macro}" | \
                        gawk -v macro="${macro}" \
                                '($0 !~ /^[[:space:]]*(#|dnl)/) {
                                        if (match($0, macro ":(.*)$", res))
                                                print res[1]
                                }' | uniq
        done

        return 0
}

_autotools_m4dir_include() {
        local x include_opts

        for x in "$@" ; do
                case ${x} in
                        # We handle it below
                        -I) ;;
                        *)
                                [[ ! -d ${x} ]] && ewarn "autotools.eclass: '${x}' does not exist"
                                include_opts+=" -I ${x}"
                                ;;
                esac
        done

        echo ${include_opts}
}
autotools_m4dir_include()    { _autotools_m4dir_include ${AT_M4DIR} ; }
autotools_m4sysdir_include() { _autotools_m4dir_include $(eval echo ${AT_SYS_M4DIR}) ; }

fi
1	# Copyright 1999-2012 Gentoo Foundation
2	# Distributed under the terms of the GNU General Public License v2
3	# $Header: /var/cvsroot/gentoo-x86/eclass/autotools.eclass,v 1.144 2012/06/06 17:15:08 mgorny Exp $
4
5	# @ECLASS: autotools.eclass
6	# @MAINTAINER:
7	# base-system@gentoo.org
8	# @BLURB: Regenerates auto* build scripts
9	# @DESCRIPTION:
10	# This eclass is for safely handling autotooled software packages that need to
11	# regenerate their build scripts. All functions will abort in case of errors.
12
13	# Note: We require GNU m4, as does autoconf. So feel free to use any features
14	# from the GNU version of m4 without worrying about other variants (i.e. BSD).
15
16	if [[ ${___ECLASS_ONCE_AUTOTOOLS} != "recur -_+^+_- spank" ]] ; then
17	___ECLASS_ONCE_AUTOTOOLS="recur -_+^+_- spank"
18
19	inherit libtool
20
21	# @ECLASS-VARIABLE: WANT_AUTOCONF
22	# @DESCRIPTION:
23	# The major version of autoconf your package needs
24	: ${WANT_AUTOCONF:=latest}
25
26	# @ECLASS-VARIABLE: WANT_AUTOMAKE
27	# @DESCRIPTION:
28	# The major version of automake your package needs
29	: ${WANT_AUTOMAKE:=latest}
30
31	# @ECLASS-VARIABLE: WANT_LIBTOOL
32	# @DESCRIPTION:
33	# Do you want libtool? Valid values here are "latest" and "none".
34	: ${WANT_LIBTOOL:=latest}
35
36	# @ECLASS-VARIABLE: _LATEST_AUTOMAKE
37	# @INTERNAL
38	# @DESCRIPTION:
39	# CONSTANT!
40	# The latest major version/slot of automake available on each arch. #312315
41	# If a newer slot is stable on any arch, and is NOT reflected in this list,
42	# then circular dependencies may arise during emerge @system bootstraps.
43	# Do NOT change this variable in your ebuilds!
44	# If you want to force a newer minor version, you can specify the correct
45	# WANT value by using a colon: <PV>[:<WANT_AUTOMAKE>]
46	_LATEST_AUTOMAKE=( 1.11.1:1.11 )
47
48	_automake_atom="sys-devel/automake"
49	_autoconf_atom="sys-devel/autoconf"
50	if [[ -n ${WANT_AUTOMAKE} ]]; then
51	case ${WANT_AUTOMAKE} in
52	# Even if the package doesn't use automake, we still need to depend
53	# on it because we run aclocal to process m4 macros. This matches
54	# the autoreconf tool, so this requirement is correct. #401605
55	none) ;;
56	latest)
57	# Use SLOT deps if we can. For EAPI=0, we get pretty close.
58	if [[ ${EAPI:-0} != 0 ]] ; then
59	_automake_atom="\|\| ( `printf '>=sys-devel/automake-%s:%s ' ${_LATEST_AUTOMAKE[@]/:/ }` )"
60	else
61	_automake_atom="\|\| ( `printf '>=sys-devel/automake-%s ' ${_LATEST_AUTOMAKE[@]/%:*}` )"
62	fi
63	;;
64	) _automake_atom="=sys-devel/automake-${WANT_AUTOMAKE}" ;;
65	esac
66	export WANT_AUTOMAKE
67	fi
68
69	if [[ -n ${WANT_AUTOCONF} ]] ; then
70	case ${WANT_AUTOCONF} in
71	none) _autoconf_atom="" ;; # some packages don't require autoconf at all
72	2.1) _autoconf_atom="=sys-devel/autoconf-${WANT_AUTOCONF}*" ;;
73	# if you change the "latest" version here, change also autotools_env_setup
74	latest\|2.5) _autoconf_atom=">=sys-devel/autoconf-2.68" ;;
75	*) die "Invalid WANT_AUTOCONF value '${WANT_AUTOCONF}'" ;;
76	esac
77	export WANT_AUTOCONF
78	fi
79
80	_libtool_atom="sys-devel/libtool"
81	if [[ -n ${WANT_LIBTOOL} ]] ; then
82	case ${WANT_LIBTOOL} in
83	none) _libtool_atom="" ;;
84	latest) ;;
85	*) die "Invalid WANT_LIBTOOL value '${WANT_LIBTOOL}'" ;;
86	esac
87	export WANT_LIBTOOL
88	fi
89
90	AUTOTOOLS_DEPEND="${_automake_atom} ${_autoconf_atom} ${_libtool_atom}"
91	RDEPEND=""
92
93	# @ECLASS-VARIABLE: AUTOTOOLS_AUTO_DEPEND
94	# @DESCRIPTION:
95	# Set to 'no' to disable automatically adding to DEPEND. This lets
96	# ebuilds former conditional depends by using ${AUTOTOOLS_DEPEND} in
97	# their own DEPEND string.
98	: ${AUTOTOOLS_AUTO_DEPEND:=yes}
99	if [[ ${AUTOTOOLS_AUTO_DEPEND} != "no" ]] ; then
100	DEPEND=${AUTOTOOLS_DEPEND}
101	fi
102
103	unset _automake_atom _autoconf_atom
104
105	# @ECLASS-VARIABLE: AM_OPTS
106	# @DEFAULT_UNSET
107	# @DESCRIPTION:
108	# Additional options to pass to automake during
109	# eautoreconf call.
110
111	# @ECLASS-VARIABLE: AT_NOEAUTOMAKE
112	# @DEFAULT_UNSET
113	# @DESCRIPTION:
114	# Don't run eautomake command if set to 'yes'; only used to workaround
115	# broken packages. Generally you should, instead, fix the package to
116	# not call AM_INIT_AUTOMAKE if it doesn't actually use automake.
117
118	# @ECLASS-VARIABLE: AT_NOELIBTOOLIZE
119	# @DEFAULT_UNSET
120	# @DESCRIPTION:
121	# Don't run elibtoolize command if set to 'yes',
122	# useful when elibtoolize needs to be ran with
123	# particular options
124
125	# @ECLASS-VARIABLE: AT_M4DIR
126	# @DESCRIPTION:
127	# Additional director(y\|ies) aclocal should search
128	: ${AT_M4DIR:=}
129
130	# @ECLASS-VARIABLE: AT_SYS_M4DIR
131	# @INTERNAL
132	# @DESCRIPTION:
133	# For system integrators, a list of additional aclocal search paths.
134	# This variable gets eval-ed, so you can use variables in the definition
135	# that may not be valid until eautoreconf & friends are run.
136	: ${AT_SYS_M4DIR:=}
137
138	# @FUNCTION: eautoreconf
139	# @DESCRIPTION:
140	# This function mimes the behavior of autoreconf, but uses the different
141	# eauto* functions to run the tools. It doesn't accept parameters, but
142	# the directory with include files can be specified with AT_M4DIR variable.
143	#
144	# Should do a full autoreconf - normally what most people will be interested in.
145	# Also should handle additional directories specified by AC_CONFIG_SUBDIRS.
146	eautoreconf() {
147	local x g
148
149	if [[ -z ${AT_NO_RECURSIVE} ]]; then
150	# Take care of subdirs
151	for x in $(autotools_check_macro_val AC_CONFIG_SUBDIRS) ; do
152	if [[ -d ${x} ]] ; then
153	pushd "${x}" >/dev/null
154	AT_NOELIBTOOLIZE="yes" eautoreconf
155	popd >/dev/null
156	fi
157	done
158	fi
159
160	einfo "Running eautoreconf in '${PWD}' ..."
161
162	local m4dirs=$(autotools_check_macro_val AC_CONFIG_{AUX,MACRO}_DIR)
163	[[ -n ${m4dirs} ]] && mkdir -p ${m4dirs}
164
165	# Run all the tools before aclocal so we can gather the .m4 files.
166	local i tools=(
167	# <tool> <was run> <command>
168	glibgettext false "autotools_run_tool glib-gettextize --copy --force"
169	gettext false "autotools_run_tool --at-missing autopoint --force"
170	# intltool must come after autopoint.
171	intltool false "autotools_run_tool intltoolize --automake --copy --force"
172	gtkdoc false "autotools_run_tool --at-missing gtkdocize --copy"
173	gnomedoc false "autotools_run_tool --at-missing gnome-doc-prepare --copy --force"
174	libtool false "_elibtoolize --install --copy --force"
175	)
176	for (( i = 0; i < ${#tools[@]}; i += 3 )) ; do
177	if _at_uses_${tools[i]} ; then
178	tools[i+1]=true
179	${tools[i+2]}
180	fi
181	done
182
183	# Generate aclocal.m4 with our up-to-date m4 files.
184	local rerun_aclocal=false
185	eaclocal
186
187	# Check to see if we had macros expanded by other macros or in other
188	# m4 files that we couldn't detect early. This is uncommon, but some
189	# packages do this, so we have to handle it correctly.
190	for (( i = 0; i < ${#tools[@]}; i += 3 )) ; do
191	if ! ${tools[i+1]} && _at_uses_${tools[i]} ; then
192	${tools[i+2]}
193	rerun_aclocal=true
194	fi
195	done
196	${rerun_aclocal} && eaclocal
197
198	eautoconf
199	eautoheader
200	[[ ${AT_NOEAUTOMAKE} != "yes" ]] && FROM_EAUTORECONF="yes" eautomake ${AM_OPTS}
201
202	[[ ${AT_NOELIBTOOLIZE} == "yes" ]] && return 0
203
204	# Call it here to prevent failures due to elibtoolize called _before_
205	# eautoreconf. We set $S because elibtoolize runs on that #265319
206	S=${PWD} elibtoolize --force
207
208	return 0
209	}
210
211	# @FUNCTION: _at_uses_pkg
212	# @USAGE: <macros>
213	# @INTERNAL
214	# See if the specified macros are enabled.
215	_at_uses_pkg() {
216	if [[ -n $(autotools_check_macro "$@") ]] ; then
217	return 0
218	else
219	# If the trace didn't find it (perhaps because aclocal.m4 hasn't
220	# been generated yet), cheat, but be conservative.
221	local macro args=()
222	for macro ; do
223	args+=( -e "^[[:space:]]*${macro}\>" )
224	done
225	egrep -q "${args[@]}" configure.??
226	fi
227	}
228	_at_uses_autoheader() { _at_uses_pkg AC_CONFIG_HEADERS; }
229	_at_uses_automake() { _at_uses_pkg AM_INIT_AUTOMAKE; }
230	_at_uses_gettext() { _at_uses_pkg AM_GNU_GETTEXT_VERSION; }
231	_at_uses_glibgettext() { _at_uses_pkg AM_GLIB_GNU_GETTEXT; }
232	_at_uses_intltool() { _at_uses_pkg {AC,IT}_PROG_INTLTOOL; }
233	_at_uses_gtkdoc() { _at_uses_pkg GTK_DOC_CHECK; }
234	_at_uses_gnomedoc() { _at_uses_pkg GNOME_DOC_INIT; }
235	_at_uses_libtool() { _at_uses_pkg A{C,M}_PROG_LIBTOOL LT_INIT; }
236
237	# @FUNCTION: eaclocal_amflags
238	# @DESCRIPTION:
239	# Extract the ACLOCAL_AMFLAGS value from the Makefile.am and try to handle
240	# (most) of the crazy crap that people throw at us.
241	eaclocal_amflags() {
242	local aclocal_opts amflags_file
243
244	for amflags_file in GNUmakefile.am Makefile.am GNUmakefile.in Makefile.in ; do
245	[[ -e ${amflags_file} ]] \|\| continue
246	# setup the env in case the pkg does something crazy
247	# in their ACLOCAL_AMFLAGS. like run a shell script
248	# which turns around and runs autotools. #365401
249	# or split across multiple lines. #383525
250	autotools_env_setup
251	aclocal_opts=$(sed -n \
252	"/^ACLOCAL_AMFLAGS[[:space:]]*=/{ \
253	# match the first line
254	s:[^=]*=::p; \
255	# then gobble up all escaped lines
256	: nextline /\\\\$/{ n; p; b nextline; } \
257	}" ${amflags_file})
258	eval aclocal_opts=\""${aclocal_opts}"\"
259	break
260	done
261
262	echo ${aclocal_opts}
263	}
264
265	# @FUNCTION: eaclocal
266	# @DESCRIPTION:
267	# These functions runs the autotools using autotools_run_tool with the
268	# specified parametes. The name of the tool run is the same of the function
269	# without e prefix.
270	# They also force installing the support files for safety.
271	# Respects AT_M4DIR for additional directories to search for macro's.
272	eaclocal() {
273	[[ ! -f aclocal.m4 \|\| -n $(grep -e 'generated.*by aclocal' aclocal.m4) ]] && \
274	autotools_run_tool --at-m4flags aclocal "$@" $(eaclocal_amflags)
275	}
276
277	# @FUNCTION: _elibtoolize
278	# @DESCRIPTION:
279	# Runs libtoolize. If --install is the first arg, automatically drop it if
280	# the active libtool version doesn't support it.
281	#
282	# Note the '_' prefix .. to not collide with elibtoolize() from libtool.eclass.
283	_elibtoolize() {
284	local LIBTOOLIZE=${LIBTOOLIZE:-libtoolize}
285	type -P glibtoolize > /dev/null && LIBTOOLIZE=glibtoolize
286
287	[[ -f GNUmakefile.am \|\| -f Makefile.am ]] && set -- "$@" --automake
288	if [[ $1 == "--install" ]] ; then
289	${LIBTOOLIZE} -n --install >& /dev/null \|\| shift
290	fi
291
292	autotools_run_tool ${LIBTOOLIZE} "$@" ${opts}
293	}
294
295	# @FUNCTION: eautoheader
296	# @DESCRIPTION:
297	# Runs autoheader.
298	eautoheader() {
299	_at_uses_autoheader \|\| return 0
300	autotools_run_tool --at-no-fail --at-m4flags autoheader "$@"
301	}
302
303	# @FUNCTION: eautoconf
304	# @DESCRIPTION:
305	# Runs autoconf.
306	eautoconf() {
307	if [[ ! -f configure.ac && ! -f configure.in ]] ; then
308	echo
309	eerror "No configure.{ac,in} present in '${PWD}'!"
310	echo
311	die "No configure.{ac,in} present!"
312	fi
313
314	autotools_run_tool --at-m4flags autoconf "$@"
315	}
316
317	# @FUNCTION: eautomake
318	# @DESCRIPTION:
319	# Runs automake.
320	eautomake() {
321	local extra_opts
322	local makefile_name
323
324	# Run automake if:
325	# - a Makefile.am type file exists
326	# - the configure script is using the AM_INIT_AUTOMAKE directive
327	for makefile_name in {GNUmakefile,{M,m}akefile}.am "" ; do
328	[[ -f ${makefile_name} ]] && break
329	done
330
331	if [[ -z ${makefile_name} ]] ; then
332	_at_uses_automake \|\| return 0
333
334	elif [[ -z ${FROM_EAUTORECONF} && -f ${makefile_name%.am}.in ]]; then
335	local used_automake
336	local installed_automake
337
338	installed_automake=$(WANT_AUTOMAKE= automake --version \| head -n 1 \| \
339	sed -e 's:.*(GNU automake) ::')
340	used_automake=$(head -n 1 < ${makefile_name%.am}.in \| \
341	sed -e 's:.by automake \(.\) from .*:\1:')
342
343	if [[ ${installed_automake} != ${used_automake} ]]; then
344	einfo "Automake used for the package (${used_automake}) differs from"
345	einfo "the installed version (${installed_automake})."
346	eautoreconf
347	return 0
348	fi
349	fi
350
351	[[ -f INSTALL && -f AUTHORS && -f ChangeLog && -f NEWS && -f README ]] \
352	\|\| extra_opts="${extra_opts} --foreign"
353
354	# --force-missing seems not to be recognized by some flavours of automake
355	autotools_run_tool automake --add-missing --copy ${extra_opts} "$@"
356	}
357
358	# @FUNCTION: eautopoint
359	# @DESCRIPTION:
360	# Runs autopoint (from the gettext package).
361	eautopoint() {
362	autotools_run_tool autopoint "$@"
363	}
364
365	# @FUNCTION: config_rpath_update
366	# @USAGE: [destination]
367	# @DESCRIPTION:
368	# Some packages utilize the config.rpath helper script, but don't
369	# use gettext directly. So we have to copy it in manually since
370	# we can't let `autopoint` do it for us.
371	config_rpath_update() {
372	local dst src=$(type -P gettext \| sed 's:bin/gettext:share/gettext/config.rpath:')
373
374	[[ $# -eq 0 ]] && set -- $(find -name config.rpath)
375	[[ $# -eq 0 ]] && return 0
376
377	einfo "Updating all config.rpath files"
378	for dst in "$@" ; do
379	einfo " ${dst}"
380	cp "${src}" "${dst}" \|\| die
381	done
382	}
383
384	# @FUNCTION: autotools_env_setup
385	# @INTERNAL
386	# @DESCRIPTION:
387	# Process the WANT_AUTO{CONF,MAKE} flags.
388	autotools_env_setup() {
389	# We do the "latest" → version switch here because it solves
390	# possible order problems, see bug #270010 as an example.
391	if [[ ${WANT_AUTOMAKE} == "latest" ]]; then
392	local pv
393	for pv in ${_LATEST_AUTOMAKE[@]/#*:} ; do
394	# has_version respects ROOT, but in this case, we don't want it to,
395	# thus "ROOT=/" prefix:
396	ROOT=/ has_version "=sys-devel/automake-${pv}*" && export WANT_AUTOMAKE="${pv}"
397	done
398	[[ ${WANT_AUTOMAKE} == "latest" ]] && \
399	die "Cannot find the latest automake! Tried ${_LATEST_AUTOMAKE}"
400	fi
401	[[ ${WANT_AUTOCONF} == "latest" ]] && export WANT_AUTOCONF=2.5
402	}
403
404	# @FUNCTION: autotools_run_tool
405	# @USAGE: [--at-no-fail] [--at-m4flags] [--at-missing] <autotool> [tool-specific flags]
406	# @INTERNAL
407	# @DESCRIPTION:
408	# Run the specified autotool helper, but do logging and error checking
409	# around it in the process.
410	autotools_run_tool() {
411	# Process our own internal flags first
412	local autofail=true m4flags=false missing_ok=false
413	while [[ -n $1 ]] ; do
414	case $1 in
415	--at-no-fail) autofail=false;;
416	--at-m4flags) m4flags=true;;
417	--at-missing) missing_ok=true;;
418	# whatever is left goes to the actual tool
419	*) break;;
420	esac
421	shift
422	done
423
424	if [[ ${EBUILD_PHASE} != "unpack" && ${EBUILD_PHASE} != "prepare" ]]; then
425	ewarn "QA Warning: running $1 in ${EBUILD_PHASE} phase"
426	fi
427
428	if ${missing_ok} && ! type -P ${1} >/dev/null ; then
429	einfo "Skipping '$*' due $1 not installed"
430	return 0
431	fi
432
433	autotools_env_setup
434
435	local STDERR_TARGET="${T}/$1.out"
436	# most of the time, there will only be one run, but if there are
437	# more, make sure we get unique log filenames
438	if [[ -e ${STDERR_TARGET} ]] ; then
439	local i=1
440	while :; do
441	STDERR_TARGET="${T}/$1-${i}.out"
442	[[ -e ${STDERR_TARGET} ]] \|\| break
443	: $(( i++ ))
444	done
445	fi
446
447	if ${m4flags} ; then
448	set -- "${1}" $(autotools_m4dir_include) "${@:2}" $(autotools_m4sysdir_include)
449	fi
450
451	printf "*** $1 *\n* PWD: ${PWD}\n*** $*\n\n" > "${STDERR_TARGET}"
452
453	ebegin "Running $@"
454	"$@" >> "${STDERR_TARGET}" 2>&1
455	if ! eend $? && ${autofail} ; then
456	echo
457	eerror "Failed Running $1 !"
458	eerror
459	eerror "Include in your bugreport the contents of:"
460	eerror
461	eerror " ${STDERR_TARGET}"
462	echo
463	die "Failed Running $1 !"
464	fi
465	}
466
467	# Internal function to check for support
468
469	# Keep a list of all the macros we might use so that we only
470	# have to run the trace code once. Order doesn't matter.
471	ALL_AUTOTOOLS_MACROS=(
472	AC_PROG_LIBTOOL AM_PROG_LIBTOOL LT_INIT
473	AC_CONFIG_HEADERS
474	AC_CONFIG_SUBDIRS
475	AC_CONFIG_AUX_DIR AC_CONFIG_MACRO_DIR
476	AM_INIT_AUTOMAKE
477	AM_GLIB_GNU_GETTEXT
478	AM_GNU_GETTEXT_VERSION
479	{AC,IT}_PROG_INTLTOOL
480	GTK_DOC_CHECK
481	GNOME_DOC_INIT
482	)
483	autotools_check_macro() {
484	[[ -f configure.ac \|\| -f configure.in ]] \|\| return 0
485
486	# We can run in multiple dirs, so we have to cache the trace
487	# data in $PWD rather than an env var.
488	local trace_file=".__autoconf_trace_data"
489	if [[ ! -e ${trace_file} ]] \|\| [[ aclocal.m4 -nt ${trace_file} ]] ; then
490	WANT_AUTOCONF="2.5" autoconf \
491	$(autotools_m4dir_include) \
492	${ALL_AUTOTOOLS_MACROS[@]/#/--trace=} > ${trace_file} 2>/dev/null
493	fi
494
495	local macro args=()
496	for macro ; do
497	has ${macro} ${ALL_AUTOTOOLS_MACROS[@]} \|\| die "internal error: add ${macro} to ALL_AUTOTOOLS_MACROS"
498	args+=( -e ":${macro}:" )
499	done
500	grep "${args[@]}" ${trace_file}
501	}
502
503	# @FUNCTION: autotools_check_macro_val
504	# @USAGE: <macro> [macros]
505	# @INTERNAL
506	# @DESCRIPTION:
507	# Look for a macro and extract its value.
508	autotools_check_macro_val() {
509	local macro scan_out
510
511	for macro ; do
512	autotools_check_macro "${macro}" \| \
513	gawk -v macro="${macro}" \
514	'($0 !~ /^[[:space:]]*(#\|dnl)/) {
515	if (match($0, macro ":(.*)$", res))
516	print res[1]
517	}' \| uniq
518	done
519
520	return 0
521	}
522
523	_autotools_m4dir_include() {
524	local x include_opts
525
526	for x in "$@" ; do
527	case ${x} in
528	# We handle it below
529	-I) ;;
530	*)
531	[[ ! -d ${x} ]] && ewarn "autotools.eclass: '${x}' does not exist"
532	include_opts+=" -I ${x}"
533	;;
534	esac
535	done
536
537	echo ${include_opts}
538	}
539	autotools_m4dir_include() { _autotools_m4dir_include ${AT_M4DIR} ; }
540	autotools_m4sysdir_include() { _autotools_m4dir_include $(eval echo ${AT_SYS_M4DIR}) ; }
541
542	fi