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.26 2005/12/08 22:51:52 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 gnuconfig

#DEPEND="sys-devel/automake
#       sys-devel/autoconf
#       sys-devel/libtool"
#
# Ebuilds should rather depend on the proper version of the tool.

# Variables:
#
#   AT_M4DIR          - Additional director(y|ies) aclocal should search
#   AT_GNUCONF_UPDATE - Should gnuconfig_update() be run (normally handled by
#                       econf()) [yes|no]
#   AM_OPTS           - Additional options to pass to automake during
#                       eautoreconf call.

# 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.
#
# Note: doesn't run autopoint right now, but runs gnuconfig_update.
eautoreconf() {
        local pwd=$(pwd) x

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

        einfo "Running eautoreconf in '$(pwd)' ..."
        eaclocal
        _elibtoolize --copy --force
        eautoconf
        eautoheader
        eautomake ${AM_OPTS}

        # Normally run by econf()
        [[ ${AT_GNUCONF_UPDATE} == "yes" ]] && gnuconfig_update

        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

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

        if [[ -n ${AT_M4DIR} ]] ; then
                for x in ${AT_M4DIR} ; do
                        case "${x}" in
                        "-I")
                                # We handle it below
                                ;;
                        "-I"*)
                                # Invalid syntax, but maybe we should help out ...
                                ewarn "eaclocal: Proper syntax is (note the space after '-I'): aclocal -I <dir>"
                                aclocal_opts="${aclocal_opts} -I ${x}"
                                ;;
                        *)
                                [[ ! -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}
}

_elibtoolize() {
        local opts

        # Check if we should run libtoolize
        [[ -n $(autotools_check_macro "AC_PROG_LIBTOOL") ]] || 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_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_run_tool autoconf "$@"
}

eautomake() {
        local extra_opts

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

        [[ -f INSTALL && -f AUTHORS && -f ChangeLog ]] \
                || 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() {
        local STDERR_TARGET="${T}/$$.out"
        local PATCH_TARGET="${T}/$$.patch"
        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 ]]; 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 ]] && \
                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
}

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	azarah	1.27	# $Header: /var/cvsroot/gentoo-x86/eclass/autotools.eclass,v 1.26 2005/12/08 22:51:52 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	azarah	1.11	inherit eutils gnuconfig
14
15	azarah	1.12	#DEPEND="sys-devel/automake
16			# sys-devel/autoconf
17			# sys-devel/libtool"
18			#
19			# Ebuilds should rather depend on the proper version of the tool.
20	azarah	1.11
21	azarah	1.16	# Variables:
22			#
23	azarah	1.17	# AT_M4DIR - Additional director(y\|ies) aclocal should search
24	azarah	1.16	# AT_GNUCONF_UPDATE - Should gnuconfig_update() be run (normally handled by
25	azarah	1.17	# econf()) [yes\|no]
26	flameeyes	1.23	# AM_OPTS - Additional options to pass to automake during
27			# eautoreconf call.
28	azarah	1.17
29			# Functions:
30			#
31			# eautoreconf() - Should do a full autoreconf - normally what most people
32			# will be interested in. Also should handle additional
33			# directories specified by AC_CONFIG_SUBDIRS.
34			# eaclocal() - Runs aclocal. Respects AT_M4DIR for additional directories
35			# to search for macro's.
36			# _elibtoolize() - Runs libtoolize. Note the '_' prefix .. to not collide
37			# with elibtoolize() from libtool.eclass
38			# eautoconf - Runs autoconf.
39			# eautoheader - Runs autoheader.
40			# eautomake - Runs automake
41			#
42	azarah	1.16
43			# XXX: M4DIR should be depreciated
44			AT_M4DIR=${AT_M4DIR:-${M4DIR}}
45			AT_GNUCONF_UPDATE="no"
46
47	azarah	1.11
48	azarah	1.17	# This function mimes the behavior of autoreconf, but uses the different
49			# eauto* functions to run the tools. It doesn't accept parameters, but
50			# the directory with include files can be specified with AT_M4DIR variable.
51			#
52			# Note: doesn't run autopoint right now, but runs gnuconfig_update.
53			eautoreconf() {
54			local pwd=$(pwd) x
55	azarah	1.11
56	azarah	1.17	# Take care of subdirs
57			for x in $(autotools_get_subdirs); do
58			if [[ -d ${x} ]] ; then
59			cd "${x}"
60			eautoreconf
61			cd "${pwd}"
62			fi
63			done
64	azarah	1.11
65	flameeyes	1.26	einfo "Running eautoreconf in '$(pwd)' ..."
66	azarah	1.17	eaclocal
67			_elibtoolize --copy --force
68			eautoconf
69			eautoheader
70	flameeyes	1.23	eautomake ${AM_OPTS}
71	azarah	1.1
72	azarah	1.17	# Normally run by econf()
73			[[ ${AT_GNUCONF_UPDATE} == "yes" ]] && gnuconfig_update
74	flameeyes	1.21
75			return 0
76	azarah	1.12	}
77
78	azarah	1.11	# These functions runs the autotools using autotools_run_tool with the
79			# specified parametes. The name of the tool run is the same of the function
80			# without e prefix.
81			# They also force installing the support files for safety.
82			eaclocal() {
83	azarah	1.12	local aclocal_opts
84
85	azarah	1.16	# XXX: M4DIR should be depreciated
86			AT_M4DIR=${AT_M4DIR:-${M4DIR}}
87
88			if [[ -n ${AT_M4DIR} ]] ; then
89			for x in ${AT_M4DIR} ; do
90			case "${x}" in
91			"-I")
92			# We handle it below
93			;;
94			"-I"*)
95			# Invalid syntax, but maybe we should help out ...
96			ewarn "eaclocal: Proper syntax is (note the space after '-I'): aclocal -I <dir>"
97			aclocal_opts="${aclocal_opts} -I ${x}"
98			;;
99			*)
100			[[ ! -d ${x} ]] && ewarn "eaclocal: '${x}' does not exist"
101			aclocal_opts="${aclocal_opts} -I ${x}"
102			;;
103			esac
104			done
105			fi
106	flameeyes	1.15
107	flameeyes	1.22	[[ ! -f aclocal.m4 \|\| -n $(grep -e 'generated.*by aclocal' aclocal.m4) ]] && \
108	azarah	1.12	autotools_run_tool aclocal "$@" ${aclocal_opts}
109			}
110
111			_elibtoolize() {
112	azarah	1.19	local opts
113	swegener	1.20
114	azarah	1.12	# Check if we should run libtoolize
115			[[ -n $(autotools_check_macro "AC_PROG_LIBTOOL") ]] \|\| return 0
116	azarah	1.19
117			[[ -f Makefile.am ]] && opts="--automake"
118	swegener	1.20
119	flameeyes	1.18	[[ "${USERLAND}" == "Darwin" ]] && LIBTOOLIZE="glibtoolize"
120	azarah	1.19	autotools_run_tool ${LIBTOOLIZE:-libtoolize} "$@" ${opts}
121	flameeyes	1.15
122	azarah	1.12	# Need to rerun aclocal
123			eaclocal
124	azarah	1.11	}
125	azarah	1.1
126	azarah	1.11	eautoheader() {
127	azarah	1.12	# Check if we should run autoheader
128			[[ -n $(autotools_check_macro "AC_CONFIG_HEADERS") ]] \|\| return 0
129	azarah	1.11	autotools_run_tool autoheader "$@"
130			}
131	azarah	1.1
132	azarah	1.11	eautoconf() {
133	azarah	1.12	if [[ ! -f configure.ac && ! -f configure.in ]] ; then
134			echo
135			eerror "No configure.{ac,in} present in '$(pwd \| sed -e 's:.*/::')'!"
136			echo
137			die "No configure.{ac,in} present!"
138			fi
139
140	azarah	1.11	autotools_run_tool autoconf "$@"
141			}
142	azarah	1.1
143	azarah	1.11	eautomake() {
144	flameeyes	1.24	local extra_opts
145
146	azarah	1.12	[[ -f Makefile.am ]] \|\| return 0
147	flameeyes	1.24
148			[[ -f INSTALL && -f AUTHORS && -f ChangeLog ]] \
149			\|\| extra_opts="${extra_opts} --foreign"
150
151	flameeyes	1.14	# --force-missing seems not to be recognized by some flavours of automake
152	flameeyes	1.24	autotools_run_tool automake --add-missing --copy ${extra_opts} "$@"
153	azarah	1.1	}
154
155	azarah	1.11
156
157	azarah	1.17	# Internal function to run an autotools' tool
158			autotools_run_tool() {
159			local STDERR_TARGET="${T}/$$.out"
160			local PATCH_TARGET="${T}/$$.patch"
161			local ris
162
163			echo "*** $1 **" > ${STDERR_TARGET%/}/$1-${STDERR_TARGET##*/}
164			echo >> ${STDERR_TARGET%/}/$1-${STDERR_TARGET##/}
165
166	azarah	1.27	ebegin "Running $@"
167	azarah	1.17	$@ >> ${STDERR_TARGET%/}/$1-${STDERR_TARGET##/} 2>&1
168			ris=$?
169			eend ${ris}
170
171			if [[ ${ris} != 0 ]]; then
172			echo
173			eerror "Failed Running $1 !"
174			eerror
175			eerror "Include in your bugreport the contents of:"
176			eerror
177			eerror " ${STDERR_TARGET%/}/$1-${STDERR_TARGET##/}"
178			echo
179			die "Failed Running $1 !"
180			fi
181			}
182
183			# Internal function to check for support
184			autotools_check_macro() {
185			[[ -f configure.ac \|\| -f configure.in ]] && \
186			autoconf --trace=$1 2>/dev/null
187			return 0
188			}
189
190			# Internal function to get additional subdirs to configure
191			autotools_get_subdirs() {
192			local subdirs_scan_out
193
194			subdirs_scan_out=$(autotools_check_macro "AC_CONFIG_SUBDIRS")
195			[[ -n ${subdirs_scan_out} ]] \|\| return 0
196
197			echo "${subdirs_scan_out}" \| gawk \
198			'($0 !~ /^[[:space:]]*(#\|dnl)/) {
199	azarah	1.25	if (match($0, /AC_CONFIG_SUBDIRS:(.*)$/, res))
200			print res[1]
201	azarah	1.17	}' \| uniq
202	azarah	1.16
203	azarah	1.17	return 0
204	azarah	1.11	}
205	azarah	1.17