gentoo-x86/eclass/autotools.eclass

# Copyright 1999-2008 Gentoo Foundation
# Distributed under the terms of the GNU General Public License v2
# $Header: /var/cvsroot/gentoo-x86/eclass/autotools.eclass,v 1.80 2008/07/31 20:45:41 darkside 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.
#
# NB:  If you add anything, please comment it!

inherit eutils libtool

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

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

_automake_atom="sys-devel/automake"
_autoconf_atom="sys-devel/autoconf"
if [[ -n ${WANT_AUTOMAKE} ]]; then
        case ${WANT_AUTOMAKE} in
                none)   _automake_atom="" ;; # some packages don't require automake at all
                latest) _automake_atom="=sys-devel/automake-1.10*" ;;
                *)      _automake_atom="=sys-devel/automake-${WANT_AUTOMAKE}*" ;;
        esac
        [[ ${WANT_AUTOMAKE} == "latest" ]] && WANT_AUTOMAKE="1.10"
        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}*" ;;
                latest|2.5) _autoconf_atom=">=sys-devel/autoconf-2.61" ;;
                *)          _autoconf_atom="INCORRECT-WANT_AUTOCONF-SETTING-IN-EBUILD" ;;
        esac
        [[ ${WANT_AUTOCONF} == "latest" ]] && WANT_AUTOCONF="2.5"
        export WANT_AUTOCONF
fi
DEPEND="${_automake_atom}
        ${_autoconf_atom}
        sys-devel/libtool"
RDEPEND=""
unset _automake_atom _autoconf_atom

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

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

# XXX: M4DIR should be deprecated
# @ECLASS-VARIABLE: AT_M4DIR
# @DESCRIPTION:
# Additional director(y|ies) aclocal should search
AT_M4DIR=${AT_M4DIR:-${M4DIR}}
AT_GNUCONF_UPDATE="no"


# @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 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
        if ${LIBTOOLIZE:-libtoolize} -n --install >& /dev/null ; then
                _elibtoolize --copy --force --install
        else
                _elibtoolize --copy --force
        fi
        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
}

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

        local amflags_file
        for amflags_file in GNUmakefile.am Makefile.am GNUmakefile.in Makefile.in ; do
                [[ -e ${amflags_file} ]] || continue
                aclocal_opts=$(sed -n '/^ACLOCAL_AMFLAGS[[:space:]]*=/s:[^=]*=::p' ${amflags_file})
                eval aclocal_opts=\"${aclocal_opts}\"
                break
        done

        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

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

# @FUNCTION: _elibtoolize
# @DESCRIPTION:
# Runs libtoolize.  Note the '_' prefix .. to not collide with elibtoolize() from
# libtool.eclass.
_elibtoolize() {
        local opts

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

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

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

        # Need to rerun aclocal
        eaclocal
}

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

# @FUNCTION: eautoconf
# @DESCRIPTION:
# Runs autoconf.
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_run_tool autoconf "$@"
}

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

        if [[ -f GNUmakefile.am ]]; then
                makefile_name="GNUmakefile"
        elif [[ -f Makefile.am ]]; then
                makefile_name="Makefile"
        else
                return 0
        fi

        if [[ -z ${FROM_EAUTORECONF} && -f ${makefile_name}.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_name}.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} "$@"
}

# Internal function to run an autotools' tool
autotools_run_tool() {
        if [[ ${EBUILD_PHASE} != "unpack" && ${EBUILD_PHASE} != "prepare" ]]; then
                ewarn "QA Warning: running $1 in ${EBUILD_PHASE} phase"
        fi

        local STDERR_TARGET="${T}/$$.out"
        local ris

        printf "***** $1 *****\n***** $*\n\n" > "${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 ]] || return 0
        local macro
        for macro ; do
                WANT_AUTOCONF="2.5" autoconf --trace="${macro}" 2>/dev/null
        done
        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	# Copyright 1999-2008 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.80 2008/07/31 20:45:41 darkside 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	# NB: If you add anything, please comment it!
14
15	inherit eutils libtool
16
17	# @ECLASS-VARIABLE: WANT_AUTOCONF
18	# @DESCRIPTION:
19	# The major version of autoconf your package needs
20	[[ -z ${WANT_AUTOCONF} ]] && WANT_AUTOCONF="latest"
21
22	# @ECLASS-VARIABLE: WANT_AUTOMAKE
23	# @DESCRIPTION:
24	# The major version of automake your package needs
25	[[ -z ${WANT_AUTOMAKE} ]] && WANT_AUTOMAKE="latest"
26
27	_automake_atom="sys-devel/automake"
28	_autoconf_atom="sys-devel/autoconf"
29	if [[ -n ${WANT_AUTOMAKE} ]]; then
30	case ${WANT_AUTOMAKE} in
31	none) _automake_atom="" ;; # some packages don't require automake at all
32	latest) _automake_atom="=sys-devel/automake-1.10*" ;;
33	) _automake_atom="=sys-devel/automake-${WANT_AUTOMAKE}" ;;
34	esac
35	[[ ${WANT_AUTOMAKE} == "latest" ]] && WANT_AUTOMAKE="1.10"
36	export WANT_AUTOMAKE
37	fi
38
39	if [[ -n ${WANT_AUTOCONF} ]] ; then
40	case ${WANT_AUTOCONF} in
41	none) _autoconf_atom="" ;; # some packages don't require autoconf at all
42	2.1) _autoconf_atom="=sys-devel/autoconf-${WANT_AUTOCONF}*" ;;
43	latest\|2.5) _autoconf_atom=">=sys-devel/autoconf-2.61" ;;
44	*) _autoconf_atom="INCORRECT-WANT_AUTOCONF-SETTING-IN-EBUILD" ;;
45	esac
46	[[ ${WANT_AUTOCONF} == "latest" ]] && WANT_AUTOCONF="2.5"
47	export WANT_AUTOCONF
48	fi
49	DEPEND="${_automake_atom}
50	${_autoconf_atom}
51	sys-devel/libtool"
52	RDEPEND=""
53	unset _automake_atom _autoconf_atom
54
55	# @ECLASS-VARIABLE: AM_OPTS
56	# @DESCRIPTION:
57	# Additional options to pass to automake during
58	# eautoreconf call.
59
60	# @ECLASS-VARIABLE: AT_NOELIBTOOLIZE
61	# @DESCRIPTION:
62	# Don't run elibtoolize command if set to 'yes',
63	# useful when elibtoolize needs to be ran with
64	# particular options
65
66	# XXX: M4DIR should be deprecated
67	# @ECLASS-VARIABLE: AT_M4DIR
68	# @DESCRIPTION:
69	# Additional director(y\|ies) aclocal should search
70	AT_M4DIR=${AT_M4DIR:-${M4DIR}}
71	AT_GNUCONF_UPDATE="no"
72
73
74	# @FUNCTION: eautoreconf
75	# @DESCRIPTION:
76	# This function mimes the behavior of autoreconf, but uses the different
77	# eauto* functions to run the tools. It doesn't accept parameters, but
78	# the directory with include files can be specified with AT_M4DIR variable.
79	#
80	# Should do a full autoreconf - normally what most people will be interested in.
81	# Also should handle additional directories specified by AC_CONFIG_SUBDIRS.
82	eautoreconf() {
83	local pwd=$(pwd) x auxdir
84
85	if [[ -z ${AT_NO_RECURSIVE} ]]; then
86	# Take care of subdirs
87	for x in $(autotools_get_subdirs); do
88	if [[ -d ${x} ]] ; then
89	cd "${x}"
90	AT_NOELIBTOOLIZE="yes" eautoreconf
91	cd "${pwd}"
92	fi
93	done
94	fi
95
96	auxdir=$(autotools_get_auxdir)
97
98	einfo "Running eautoreconf in '$(pwd)' ..."
99	[[ -n ${auxdir} ]] && mkdir -p ${auxdir}
100	eaclocal
101	if ${LIBTOOLIZE:-libtoolize} -n --install >& /dev/null ; then
102	_elibtoolize --copy --force --install
103	else
104	_elibtoolize --copy --force
105	fi
106	eautoconf
107	eautoheader
108	FROM_EAUTORECONF="yes" eautomake ${AM_OPTS}
109
110	[[ ${AT_NOELIBTOOLIZE} == "yes" ]] && return 0
111
112	# Call it here to prevent failures due to elibtoolize called _before_
113	# eautoreconf.
114	elibtoolize
115
116	return 0
117	}
118
119	# @FUNCTION: eaclocal
120	# @DESCRIPTION:
121	# These functions runs the autotools using autotools_run_tool with the
122	# specified parametes. The name of the tool run is the same of the function
123	# without e prefix.
124	# They also force installing the support files for safety.
125	# Respects AT_M4DIR for additional directories to search for macro's.
126	eaclocal() {
127	local aclocal_opts
128
129	local amflags_file
130	for amflags_file in GNUmakefile.am Makefile.am GNUmakefile.in Makefile.in ; do
131	[[ -e ${amflags_file} ]] \|\| continue
132	aclocal_opts=$(sed -n '/^ACLOCAL_AMFLAGS[[:space:]]=/s:[^=]=::p' ${amflags_file})
133	eval aclocal_opts=\"${aclocal_opts}\"
134	break
135	done
136
137	if [[ -n ${AT_M4DIR} ]] ; then
138	for x in ${AT_M4DIR} ; do
139	case "${x}" in
140	"-I")
141	# We handle it below
142	;;
143	*)
144	[[ ! -d ${x} ]] && ewarn "eaclocal: '${x}' does not exist"
145	aclocal_opts="${aclocal_opts} -I ${x}"
146	;;
147	esac
148	done
149	fi
150
151	[[ ! -f aclocal.m4 \|\| -n $(grep -e 'generated.*by aclocal' aclocal.m4) ]] && \
152	autotools_run_tool aclocal "$@" ${aclocal_opts}
153	}
154
155	# @FUNCTION: _elibtoolize
156	# @DESCRIPTION:
157	# Runs libtoolize. Note the '_' prefix .. to not collide with elibtoolize() from
158	# libtool.eclass.
159	_elibtoolize() {
160	local opts
161
162	# Check if we should run libtoolize (AM_PROG_LIBTOOL is an older macro,
163	# check for both it and the current AC_PROG_LIBTOOL)
164	[[ -n $(autotools_check_macro AC_PROG_LIBTOOL AM_PROG_LIBTOOL LT_INIT) ]] \|\| return 0
165
166	[[ -f GNUmakefile.am \|\| -f Makefile.am ]] && opts="--automake"
167
168	[[ "${USERLAND}" == "Darwin" ]] && LIBTOOLIZE="glibtoolize"
169	autotools_run_tool ${LIBTOOLIZE:-libtoolize} "$@" ${opts}
170
171	# Need to rerun aclocal
172	eaclocal
173	}
174
175	# @FUNCTION: eautoheader
176	# @DESCRIPTION:
177	# Runs autoheader.
178	eautoheader() {
179	# Check if we should run autoheader
180	[[ -n $(autotools_check_macro "AC_CONFIG_HEADERS") ]] \|\| return 0
181	NO_FAIL=1 autotools_run_tool autoheader "$@"
182	}
183
184	# @FUNCTION: eautoconf
185	# @DESCRIPTION:
186	# Runs autoconf.
187	eautoconf() {
188	if [[ ! -f configure.ac && ! -f configure.in ]] ; then
189	echo
190	eerror "No configure.{ac,in} present in '$(pwd \| sed -e 's:.*/::')'!"
191	echo
192	die "No configure.{ac,in} present!"
193	fi
194
195	autotools_run_tool autoconf "$@"
196	}
197
198	# @FUNCTION: eautomake
199	# @DESCRIPTION:
200	# Runs automake.
201	eautomake() {
202	local extra_opts
203	local makefile_name
204
205	if [[ -f GNUmakefile.am ]]; then
206	makefile_name="GNUmakefile"
207	elif [[ -f Makefile.am ]]; then
208	makefile_name="Makefile"
209	else
210	return 0
211	fi
212
213	if [[ -z ${FROM_EAUTORECONF} && -f ${makefile_name}.in ]]; then
214	local used_automake
215	local installed_automake
216
217	installed_automake=$(automake --version \| head -n 1 \| \
218	sed -e 's:.*(GNU automake) ::')
219	used_automake=$(head -n 1 < ${makefile_name}.in \| \
220	sed -e 's:.by automake \(.\) from .*:\1:')
221
222	if [[ ${installed_automake} != ${used_automake} ]]; then
223	einfo "Automake used for the package (${used_automake}) differs from"
224	einfo "the installed version (${installed_automake})."
225	eautoreconf
226	return 0
227	fi
228	fi
229
230	[[ -f INSTALL && -f AUTHORS && -f ChangeLog && -f NEWS ]] \
231	\|\| extra_opts="${extra_opts} --foreign"
232
233	# --force-missing seems not to be recognized by some flavours of automake
234	autotools_run_tool automake --add-missing --copy ${extra_opts} "$@"
235	}
236
237	# Internal function to run an autotools' tool
238	autotools_run_tool() {
239	if [[ ${EBUILD_PHASE} != "unpack" && ${EBUILD_PHASE} != "prepare" ]]; then
240	ewarn "QA Warning: running $1 in ${EBUILD_PHASE} phase"
241	fi
242
243	local STDERR_TARGET="${T}/$$.out"
244	local ris
245
246	printf "*** $1 *\n*** $\n\n" > "${STDERR_TARGET%/}/$1-${STDERR_TARGET##*/}"
247
248	ebegin "Running $@"
249	"$@" >> "${STDERR_TARGET%/}/$1-${STDERR_TARGET##/}" 2>&1
250	ris=$?
251	eend ${ris}
252
253	if [[ ${ris} != 0 && ${NO_FAIL} != 1 ]]; then
254	echo
255	eerror "Failed Running $1 !"
256	eerror
257	eerror "Include in your bugreport the contents of:"
258	eerror
259	eerror " ${STDERR_TARGET%/}/$1-${STDERR_TARGET##/}"
260	echo
261	die "Failed Running $1 !"
262	fi
263	}
264
265	# Internal function to check for support
266	autotools_check_macro() {
267	[[ -f configure.ac \|\| -f configure.in ]] \|\| return 0
268	local macro
269	for macro ; do
270	WANT_AUTOCONF="2.5" autoconf --trace="${macro}" 2>/dev/null
271	done
272	return 0
273	}
274
275	# Internal function to get additional subdirs to configure
276	autotools_get_subdirs() {
277	local subdirs_scan_out
278
279	subdirs_scan_out=$(autotools_check_macro "AC_CONFIG_SUBDIRS")
280	[[ -n ${subdirs_scan_out} ]] \|\| return 0
281
282	echo "${subdirs_scan_out}" \| gawk \
283	'($0 !~ /^[[:space:]]*(#\|dnl)/) {
284	if (match($0, /AC_CONFIG_SUBDIRS:(.*)$/, res))
285	print res[1]
286	}' \| uniq
287
288	return 0
289	}
290
291	autotools_get_auxdir() {
292	local auxdir_scan_out
293
294	auxdir_scan_out=$(autotools_check_macro "AC_CONFIG_AUX_DIR")
295	[[ -n ${auxdir_scan_out} ]] \|\| return 0
296
297	echo ${auxdir_scan_out} \| gawk \
298	'($0 !~ /^[[:space:]]*(#\|dnl)/) {
299	if (match($0, /AC_CONFIG_AUX_DIR:(.*)$/, res))
300	print res[1]
301	}' \| uniq
302
303	return 0
304	}