gentoo-x86/eclass/autotools.eclass

# Copyright 1999-2005 Gentoo Foundation
# Distributed under the terms of the GNU General Public License v2
# $Header: /var/cvsroot/gentoo-x86/eclass/autotools.eclass,v 1.60 2006/12/18 13:41:12 flameeyes Exp $
#
# Author: Diego Pettenò <flameeyes@gentoo.org>
# Enhancements: Martin Schlemmer <azarah@gentoo.org>
#
# This eclass is for handling autotooled software packages that
# needs to regenerate their build scripts.
#
# NB:  If you add anything, please comment it!

inherit eutils libtool

_automake_atom="sys-devel/automake"
_autoconf_atom="sys-devel/autoconf"
if [[ -n ${WANT_AUTOMAKE} ]]; then
        case ${WANT_AUTOMAKE} in
                # workaround while we have different versions of automake in arch and ~arch
                latest) _automake_atom="|| ( =sys-devel/automake-1.10* =sys-devel/automake-1.9* )" ;;
                *) _automake_atom="=sys-devel/automake-${WANT_AUTOMAKE}*" ;;
        esac
fi

if [[ -n ${WANT_AUTOCONF} ]] ; then
        case ${WANT_AUTOCONF} in
                2.1) _autoconf_atom="=sys-devel/autoconf-${WANT_AUTOCONF}*" ;;
                latest | 2.5) _autoconf_atom=">=sys-devel/autoconf-2.59" ;;
        esac
fi
DEPEND="${_automake_atom}
        ${_autoconf_atom}
        sys-devel/libtool"
RDEPEND=""
unset _automake_atom _autoconf_atom

# Variables:
#
#       AT_M4DIR                  - Additional director(y|ies) aclocal should search
#       AM_OPTS                   - Additional options to pass to automake during
#                                               eautoreconf call.
#       AT_NOELIBTOOLIZE  - Don't run elibtoolize command if set to 'yes',
#                                               useful when elibtoolize needs to be ran with
#                                               particular options

# Functions:
#
#       eautoreconf()  - Should do a full autoreconf - normally what most people
#                                        will be interested in.  Also should handle additional
#                                        directories specified by AC_CONFIG_SUBDIRS.
#       eaclocal()         - Runs aclocal.      Respects AT_M4DIR for additional directories
#                                        to search for macro's.
#       _elibtoolize() - Runs libtoolize.  Note the '_' prefix .. to not collide
#                                        with elibtoolize() from libtool.eclass
#       eautoconf          - Runs autoconf.
#       eautoheader        - Runs autoheader.
#       eautomake          - Runs automake
#

# XXX: M4DIR should be depreciated
AT_M4DIR=${AT_M4DIR:-${M4DIR}}
AT_GNUCONF_UPDATE="no"


# 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.
eautoreconf() {
        local pwd=$(pwd) x auxdir

        if [[ -z ${AT_NO_RECURSIVE} ]]; then
                # Take care of subdirs
                for x in $(autotools_get_subdirs); do
                        if [[ -d ${x} ]] ; then
                                cd "${x}"
                                AT_NOELIBTOOLIZE="yes" eautoreconf
                                cd "${pwd}"
                        fi
                done
        fi

        auxdir=$(autotools_get_auxdir)

        einfo "Running eautoreconf in '$(pwd)' ..."
        [[ -n ${auxdir} ]] && mkdir -p ${auxdir}
        eaclocal
        _elibtoolize --copy --force
        eautoconf
        eautoheader
        FROM_EAUTORECONF="yes" eautomake ${AM_OPTS}

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

        # Call it here to prevent failures due to elibtoolize called _before_
        # eautoreconf.
        elibtoolize

        return 0
}

# 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.
eaclocal() {
        local aclocal_opts

        if [[ -n ${AT_M4DIR} ]] ; then
                for x in ${AT_M4DIR} ; do
                        case "${x}" in
                        "-I")
                                # We handle it below
                                ;;
                        *)
                                [[ ! -d ${x} ]] && ewarn "eaclocal: '${x}' does not exist"
                                aclocal_opts="${aclocal_opts} -I ${x}"
                                ;;
                        esac
                done
        fi

        autotools_set_versions
        [[ ! -f aclocal.m4 || -n $(grep -e 'generated.*by aclocal' aclocal.m4) ]] && \
                autotools_run_tool aclocal "$@" ${aclocal_opts}
}

_elibtoolize() {
        local opts
        local lttest

        # Check if we should run libtoolize (AM_PROG_LIBTOOL is an older macro,
        # check for both it and the current AC_PROG_LIBTOOL)
        lttest="$(autotools_check_macro "AC_PROG_LIBTOOL")$(autotools_check_macro "AM_PROG_LIBTOOL")"
        [[ -n $lttest ]] || return 0

        [[ -f Makefile.am ]] && opts="--automake"

        [[ "${USERLAND}" == "Darwin" ]] && LIBTOOLIZE="glibtoolize"
        autotools_run_tool ${LIBTOOLIZE:-libtoolize} "$@" ${opts}

        # Need to rerun aclocal
        eaclocal
}

eautoheader() {
        # Check if we should run autoheader
        [[ -n $(autotools_check_macro "AC_CONFIG_HEADERS") ]] || return 0
        autotools_set_versions
        NO_FAIL=1 autotools_run_tool autoheader "$@"
}

eautoconf() {
        if [[ ! -f configure.ac && ! -f configure.in ]] ; then
                echo
                eerror "No configure.{ac,in} present in '$(pwd | sed -e 's:.*/::')'!"
                echo
                die "No configure.{ac,in} present!"
        fi

        autotools_set_versions
        autotools_run_tool autoconf "$@"
}

eautomake() {
        local extra_opts

        [[ -f Makefile.am ]] || return 0

        autotools_set_versions
        if [[ -z ${FROM_EAUTORECONF} && -f Makefile.in ]]; then
                local used_automake
                local installed_automake

                installed_automake=$(automake --version | head -n 1 | \
                        sed -e 's:.*(GNU automake) ::')
                used_automake=$(head -n 1 < Makefile.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 ]] \
                || 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} "$@"
}

autotools_set_versions() {
        [[ -n ${autotools_version_sets} ]] && return 0

        if [[ -n ${WANT_AUTOCONF} ]]; then
                [[ ${WANT_AUTOCONF} == "latest" ]] && WANT_AUTOCONF="2.5"
                export WANT_AUTOCONF
                einfo "Requested autoconf ${WANT_AUTOCONF}"
                einfo "Using $(autoconf --version 2>/dev/null | head -n 1)"
                einfo "Using $(autoheader --version 2>/dev/null | head -n 1)"
        else
                ewarn "QA Notice: \${WANT_AUTOCONF} variable unset. Please report on http://bugs.gentoo.org/"
        fi

        if [[ -n ${WANT_AUTOMAKE} ]]; then
                local latest_automake
                if [[ ${WANT_AUTOMAKE} == "latest" ]]; then
                        latest_automake="latest: "
                        for amver in 1.10 1.9 1.8 1.7 1.6; do
                                WANT_AUTOMAKE="${amver}"
                                ROOT=/ has_version =sys-devel/automake-${amver}* && break
                        done
                fi
                export WANT_AUTOMAKE
                einfo "Requested automake ${latest_automake}${WANT_AUTOMAKE}"
                einfo "Using $(automake --version 2>/dev/null | head -n 1)"
                einfo "Using $(aclocal --version 2>/dev/null | head -n 1)"
        else
                ewarn "QA Notice: \${WANT_AUTOMAKE} variable unset. Please report on http://bugs.gentoo.org/"
        fi

        autotools_version_sets="yes"
}

# Internal function to run an autotools' tool
autotools_run_tool() {
        local STDERR_TARGET="${T}/$$.out"
        local ris

        echo "***** $1 *****" > ${STDERR_TARGET%/*}/$1-${STDERR_TARGET##*/}
        echo >> ${STDERR_TARGET%/*}/$1-${STDERR_TARGET##*/}

        ebegin "Running $@"
        $@ >> ${STDERR_TARGET%/*}/$1-${STDERR_TARGET##*/} 2>&1
        ris=$?
        eend ${ris}

        if [[ ${ris} != 0 && ${NO_FAIL} != 1 ]]; then
                echo
                eerror "Failed Running $1 !"
                eerror
                eerror "Include in your bugreport the contents of:"
                eerror
                eerror "  ${STDERR_TARGET%/*}/$1-${STDERR_TARGET##*/}"
                echo
                die "Failed Running $1 !"
        fi
}

# Internal function to check for support
autotools_check_macro() {
        [[ -f configure.ac || -f configure.in ]] && \
                WANT_AUTOCONF="2.5" autoconf --trace=$1 2>/dev/null
        return 0
}

# Internal function to get additional subdirs to configure
autotools_get_subdirs() {
        local subdirs_scan_out

        subdirs_scan_out=$(autotools_check_macro "AC_CONFIG_SUBDIRS")
        [[ -n ${subdirs_scan_out} ]] || return 0

        echo "${subdirs_scan_out}" | gawk \
        '($0 !~ /^[[:space:]]*(#|dnl)/) {
                if (match($0, /AC_CONFIG_SUBDIRS:(.*)$/, res))
                        print res[1]
        }' | uniq

        return 0
}

autotools_get_auxdir() {
        local auxdir_scan_out

        auxdir_scan_out=$(autotools_check_macro "AC_CONFIG_AUX_DIR")
        [[ -n ${auxdir_scan_out} ]] || return 0

        echo ${auxdir_scan_out} | gawk \
        '($0 !~ /^[[:space:]]*(#|dnl)/) {
                if (match($0, /AC_CONFIG_AUX_DIR:(.*)$/, res))
                        print res[1]
        }' | uniq

        return 0
}
1	azarah	1.11	# Copyright 1999-2005 Gentoo Foundation
2	vapier	1.6	# Distributed under the terms of the GNU General Public License v2
3	flameeyes	1.61	# $Header: /var/cvsroot/gentoo-x86/eclass/autotools.eclass,v 1.60 2006/12/18 13:41:12 flameeyes Exp $
4	vapier	1.7	#
5	azarah	1.11	# Author: Diego Pettenò <flameeyes@gentoo.org>
6	azarah	1.12	# Enhancements: Martin Schlemmer <azarah@gentoo.org>
7	vapier	1.7	#
8	azarah	1.11	# This eclass is for handling autotooled software packages that
9			# needs to regenerate their build scripts.
10	azarah	1.1	#
11	azarah	1.11	# NB: If you add anything, please comment it!
12	azarah	1.1
13	flameeyes	1.37	inherit eutils libtool
14	azarah	1.11
15	vapier	1.40	_automake_atom="sys-devel/automake"
16			_autoconf_atom="sys-devel/autoconf"
17	peper	1.55	if [[ -n ${WANT_AUTOMAKE} ]]; then
18	flameeyes	1.49	case ${WANT_AUTOMAKE} in
19			# workaround while we have different versions of automake in arch and ~arch
20	flameeyes	1.50	latest) _automake_atom="\|\| ( =sys-devel/automake-1.10* =sys-devel/automake-1.9* )" ;;
21	flameeyes	1.49	) _automake_atom="=sys-devel/automake-${WANT_AUTOMAKE}" ;;
22			esac
23	flameeyes	1.48	fi
24
25	vapier	1.45	if [[ -n ${WANT_AUTOCONF} ]] ; then
26	flameeyes	1.41	case ${WANT_AUTOCONF} in
27			2.1) _autoconf_atom="=sys-devel/autoconf-${WANT_AUTOCONF}*" ;;
28	flameeyes	1.49	latest \| 2.5) _autoconf_atom=">=sys-devel/autoconf-2.59" ;;
29	flameeyes	1.41	esac
30			fi
31	vapier	1.40	DEPEND="${_automake_atom}
32			${_autoconf_atom}
33	flameeyes	1.28	sys-devel/libtool"
34	flameeyes	1.46	RDEPEND=""
35	vapier	1.40	unset _automake_atom _autoconf_atom
36	azarah	1.11
37	azarah	1.16	# Variables:
38			#
39	flameeyes	1.38	# AT_M4DIR - Additional director(y\|ies) aclocal should search
40			# AM_OPTS - Additional options to pass to automake during
41			# eautoreconf call.
42	flameeyes	1.60	# AT_NOELIBTOOLIZE - Don't run elibtoolize command if set to 'yes',
43			# useful when elibtoolize needs to be ran with
44			# particular options
45	azarah	1.17
46			# Functions:
47			#
48	flameeyes	1.38	# eautoreconf() - Should do a full autoreconf - normally what most people
49			# will be interested in. Also should handle additional
50			# directories specified by AC_CONFIG_SUBDIRS.
51			# eaclocal() - Runs aclocal. Respects AT_M4DIR for additional directories
52			# to search for macro's.
53			# _elibtoolize() - Runs libtoolize. Note the '_' prefix .. to not collide
54			# with elibtoolize() from libtool.eclass
55			# eautoconf - Runs autoconf.
56			# eautoheader - Runs autoheader.
57			# eautomake - Runs automake
58	azarah	1.17	#
59	azarah	1.16
60			# XXX: M4DIR should be depreciated
61			AT_M4DIR=${AT_M4DIR:-${M4DIR}}
62			AT_GNUCONF_UPDATE="no"
63
64	azarah	1.11
65	azarah	1.17	# This function mimes the behavior of autoreconf, but uses the different
66			# eauto* functions to run the tools. It doesn't accept parameters, but
67			# the directory with include files can be specified with AT_M4DIR variable.
68			eautoreconf() {
69	flameeyes	1.38	local pwd=$(pwd) x auxdir
70	azarah	1.11
71	flameeyes	1.39	if [[ -z ${AT_NO_RECURSIVE} ]]; then
72			# Take care of subdirs
73			for x in $(autotools_get_subdirs); do
74			if [[ -d ${x} ]] ; then
75			cd "${x}"
76			AT_NOELIBTOOLIZE="yes" eautoreconf
77			cd "${pwd}"
78			fi
79			done
80			fi
81	azarah	1.11
82	flameeyes	1.38	auxdir=$(autotools_get_auxdir)
83
84	flameeyes	1.26	einfo "Running eautoreconf in '$(pwd)' ..."
85	flameeyes	1.38	[[ -n ${auxdir} ]] && mkdir -p ${auxdir}
86	azarah	1.17	eaclocal
87			_elibtoolize --copy --force
88			eautoconf
89			eautoheader
90	flameeyes	1.35	FROM_EAUTORECONF="yes" eautomake ${AM_OPTS}
91	azarah	1.1
92	flameeyes	1.32	[[ ${AT_NOELIBTOOLIZE} == "yes" ]] && return 0
93
94	flameeyes	1.30	# Call it here to prevent failures due to elibtoolize called _before_
95			# eautoreconf.
96			elibtoolize
97
98	flameeyes	1.21	return 0
99	azarah	1.12	}
100
101	azarah	1.11	# These functions runs the autotools using autotools_run_tool with the
102			# specified parametes. The name of the tool run is the same of the function
103			# without e prefix.
104			# They also force installing the support files for safety.
105			eaclocal() {
106	azarah	1.12	local aclocal_opts
107
108	azarah	1.16	if [[ -n ${AT_M4DIR} ]] ; then
109			for x in ${AT_M4DIR} ; do
110			case "${x}" in
111			"-I")
112			# We handle it below
113			;;
114			*)
115			[[ ! -d ${x} ]] && ewarn "eaclocal: '${x}' does not exist"
116			aclocal_opts="${aclocal_opts} -I ${x}"
117			;;
118			esac
119			done
120			fi
121	flameeyes	1.15
122	flameeyes	1.47	autotools_set_versions
123	flameeyes	1.22	[[ ! -f aclocal.m4 \|\| -n $(grep -e 'generated.*by aclocal' aclocal.m4) ]] && \
124	azarah	1.12	autotools_run_tool aclocal "$@" ${aclocal_opts}
125			}
126
127			_elibtoolize() {
128	azarah	1.19	local opts
129	flameeyes	1.34	local lttest
130	swegener	1.20
131	flameeyes	1.34	# Check if we should run libtoolize (AM_PROG_LIBTOOL is an older macro,
132			# check for both it and the current AC_PROG_LIBTOOL)
133			lttest="$(autotools_check_macro "AC_PROG_LIBTOOL")$(autotools_check_macro "AM_PROG_LIBTOOL")"
134			[[ -n $lttest ]] \|\| return 0
135	azarah	1.19
136			[[ -f Makefile.am ]] && opts="--automake"
137	swegener	1.20
138	flameeyes	1.18	[[ "${USERLAND}" == "Darwin" ]] && LIBTOOLIZE="glibtoolize"
139	azarah	1.19	autotools_run_tool ${LIBTOOLIZE:-libtoolize} "$@" ${opts}
140	flameeyes	1.15
141	azarah	1.12	# Need to rerun aclocal
142			eaclocal
143	azarah	1.11	}
144	azarah	1.1
145	azarah	1.11	eautoheader() {
146	azarah	1.12	# Check if we should run autoheader
147			[[ -n $(autotools_check_macro "AC_CONFIG_HEADERS") ]] \|\| return 0
148	flameeyes	1.47	autotools_set_versions
149	flameeyes	1.58	NO_FAIL=1 autotools_run_tool autoheader "$@"
150	azarah	1.11	}
151	azarah	1.1
152	azarah	1.11	eautoconf() {
153	azarah	1.12	if [[ ! -f configure.ac && ! -f configure.in ]] ; then
154			echo
155			eerror "No configure.{ac,in} present in '$(pwd \| sed -e 's:.*/::')'!"
156			echo
157			die "No configure.{ac,in} present!"
158			fi
159
160	flameeyes	1.47	autotools_set_versions
161	azarah	1.11	autotools_run_tool autoconf "$@"
162			}
163	azarah	1.1
164	azarah	1.11	eautomake() {
165	flameeyes	1.24	local extra_opts
166
167	azarah	1.12	[[ -f Makefile.am ]] \|\| return 0
168	flameeyes	1.24
169	flameeyes	1.47	autotools_set_versions
170	flameeyes	1.35	if [[ -z ${FROM_EAUTORECONF} && -f Makefile.in ]]; then
171			local used_automake
172			local installed_automake
173
174			installed_automake=$(automake --version \| head -n 1 \| \
175			sed -e 's:.*(GNU automake) ::')
176			used_automake=$(head -n 1 < Makefile.in \| \
177			sed -e 's:.by automake \(.\) from .*:\1:')
178
179			if [[ ${installed_automake} != ${used_automake} ]]; then
180			einfo "Automake used for the package (${used_automake}) differs from"
181			einfo "the installed version (${installed_automake})."
182			eautoreconf
183	flameeyes	1.36	return 0
184	flameeyes	1.35	fi
185			fi
186
187	flameeyes	1.33	[[ -f INSTALL && -f AUTHORS && -f ChangeLog && -f NEWS ]] \
188	flameeyes	1.24	\|\| extra_opts="${extra_opts} --foreign"
189
190	flameeyes	1.14	# --force-missing seems not to be recognized by some flavours of automake
191	flameeyes	1.24	autotools_run_tool automake --add-missing --copy ${extra_opts} "$@"
192	azarah	1.1	}
193
194	flameeyes	1.47	autotools_set_versions() {
195			[[ -n ${autotools_version_sets} ]] && return 0
196
197			if [[ -n ${WANT_AUTOCONF} ]]; then
198	flameeyes	1.48	[[ ${WANT_AUTOCONF} == "latest" ]] && WANT_AUTOCONF="2.5"
199	flameeyes	1.47	export WANT_AUTOCONF
200			einfo "Requested autoconf ${WANT_AUTOCONF}"
201			einfo "Using $(autoconf --version 2>/dev/null \| head -n 1)"
202			einfo "Using $(autoheader --version 2>/dev/null \| head -n 1)"
203	flameeyes	1.61	else
204			ewarn "QA Notice: \${WANT_AUTOCONF} variable unset. Please report on http://bugs.gentoo.org/"
205	flameeyes	1.47	fi
206	azarah	1.11
207	flameeyes	1.47	if [[ -n ${WANT_AUTOMAKE} ]]; then
208	flameeyes	1.56	local latest_automake
209	flameeyes	1.48	if [[ ${WANT_AUTOMAKE} == "latest" ]]; then
210	flameeyes	1.56	latest_automake="latest: "
211	flameeyes	1.52	for amver in 1.10 1.9 1.8 1.7 1.6; do
212	flameeyes	1.54	WANT_AUTOMAKE="${amver}"
213			ROOT=/ has_version =sys-devel/automake-${amver}* && break
214	flameeyes	1.52	done
215	flameeyes	1.48	fi
216	flameeyes	1.47	export WANT_AUTOMAKE
217	flameeyes	1.56	einfo "Requested automake ${latest_automake}${WANT_AUTOMAKE}"
218	flameeyes	1.47	einfo "Using $(automake --version 2>/dev/null \| head -n 1)"
219			einfo "Using $(aclocal --version 2>/dev/null \| head -n 1)"
220	flameeyes	1.61	else
221			ewarn "QA Notice: \${WANT_AUTOMAKE} variable unset. Please report on http://bugs.gentoo.org/"
222	flameeyes	1.47	fi
223
224			autotools_version_sets="yes"
225			}
226	azarah	1.11
227	azarah	1.17	# Internal function to run an autotools' tool
228			autotools_run_tool() {
229			local STDERR_TARGET="${T}/$$.out"
230			local ris
231
232			echo "*** $1 **" > ${STDERR_TARGET%/}/$1-${STDERR_TARGET##*/}
233			echo >> ${STDERR_TARGET%/}/$1-${STDERR_TARGET##/}
234
235	azarah	1.27	ebegin "Running $@"
236	azarah	1.17	$@ >> ${STDERR_TARGET%/}/$1-${STDERR_TARGET##/} 2>&1
237			ris=$?
238			eend ${ris}
239
240	flameeyes	1.57	if [[ ${ris} != 0 && ${NO_FAIL} != 1 ]]; then
241	azarah	1.17	echo
242			eerror "Failed Running $1 !"
243			eerror
244			eerror "Include in your bugreport the contents of:"
245			eerror
246			eerror " ${STDERR_TARGET%/}/$1-${STDERR_TARGET##/}"
247			echo
248			die "Failed Running $1 !"
249			fi
250			}
251
252			# Internal function to check for support
253			autotools_check_macro() {
254			[[ -f configure.ac \|\| -f configure.in ]] && \
255	flameeyes	1.31	WANT_AUTOCONF="2.5" autoconf --trace=$1 2>/dev/null
256	azarah	1.17	return 0
257			}
258
259			# Internal function to get additional subdirs to configure
260			autotools_get_subdirs() {
261			local subdirs_scan_out
262
263			subdirs_scan_out=$(autotools_check_macro "AC_CONFIG_SUBDIRS")
264			[[ -n ${subdirs_scan_out} ]] \|\| return 0
265
266			echo "${subdirs_scan_out}" \| gawk \
267			'($0 !~ /^[[:space:]]*(#\|dnl)/) {
268	azarah	1.25	if (match($0, /AC_CONFIG_SUBDIRS:(.*)$/, res))
269			print res[1]
270	azarah	1.17	}' \| uniq
271	azarah	1.16
272	azarah	1.17	return 0
273	azarah	1.11	}
274	azarah	1.17
275	flameeyes	1.38	autotools_get_auxdir() {
276			local auxdir_scan_out
277
278			auxdir_scan_out=$(autotools_check_macro "AC_CONFIG_AUX_DIR")
279			[[ -n ${auxdir_scan_out} ]] \|\| return 0
280
281			echo ${auxdir_scan_out} \| gawk \
282			'($0 !~ /^[[:space:]]*(#\|dnl)/) {
283			if (match($0, /AC_CONFIG_AUX_DIR:(.*)$/, res))
284			print res[1]
285			}' \| uniq
286
287			return 0
288	vapier	1.40	}