/[gentoo-x86]/eclass/autotools-utils.eclass
Gentoo

Contents of /eclass/autotools-utils.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.34 - (show annotations) (download)
Sat Jan 14 14:41:10 2012 UTC (2 years, 3 months ago) by mgorny
Branch: MAIN
Changes since 1.33: +10 -1 lines
Support installing default docs, similarly to EAPI4; wrt bug #397659.

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-utils.eclass,v 1.33 2012/01/09 10:16:25 jlec Exp $
4
5 # @ECLASS: autotools-utils.eclass
6 # @MAINTAINER:
7 # Maciej Mrozowski <reavertm@gentoo.org>
8 # Michał Górny <mgorny@gentoo.org>
9 # @BLURB: common ebuild functions for autotools-based packages
10 # @DESCRIPTION:
11 # autotools-utils.eclass is autotools.eclass(5) and base.eclass(5) wrapper
12 # providing all inherited features along with econf arguments as Bash array,
13 # out of source build with overridable build dir location, static archives
14 # handling, libtool files removal.
15 #
16 # Please note note that autotools-utils does not support mixing of its phase
17 # functions with regular econf/emake calls. If necessary, please call
18 # autotools-utils_src_compile instead of the latter.
19 #
20 # @EXAMPLE:
21 # Typical ebuild using autotools-utils.eclass:
22 #
23 # @CODE
24 # EAPI="2"
25 #
26 # inherit autotools-utils
27 #
28 # DESCRIPTION="Foo bar application"
29 # HOMEPAGE="http://example.org/foo/"
30 # SRC_URI="mirror://sourceforge/foo/${P}.tar.bz2"
31 #
32 # LICENSE="LGPL-2.1"
33 # KEYWORDS=""
34 # SLOT="0"
35 # IUSE="debug doc examples qt4 static-libs tiff"
36 #
37 # CDEPEND="
38 # media-libs/libpng:0
39 # qt4? (
40 # x11-libs/qt-core:4
41 # x11-libs/qt-gui:4
42 # )
43 # tiff? ( media-libs/tiff:0 )
44 # "
45 # RDEPEND="${CDEPEND}
46 # !media-gfx/bar
47 # "
48 # DEPEND="${CDEPEND}
49 # doc? ( app-doc/doxygen )
50 # "
51 #
52 # # bug 123456
53 # AUTOTOOLS_IN_SOURCE_BUILD=1
54 #
55 # DOCS=(AUTHORS ChangeLog README "Read me.txt" TODO)
56 #
57 # PATCHES=(
58 # "${FILESDIR}/${P}-gcc44.patch" # bug 123458
59 # "${FILESDIR}/${P}-as-needed.patch"
60 # "${FILESDIR}/${P}-unbundle_libpng.patch"
61 # )
62 #
63 # src_configure() {
64 # local myeconfargs=(
65 # $(use_enable debug)
66 # $(use_with qt4)
67 # $(use_enable threads multithreading)
68 # $(use_with tiff)
69 # )
70 # autotools-utils_src_configure
71 # }
72 #
73 # src_compile() {
74 # autotools-utils_src_compile
75 # use doc && autotools-utils_src_compile docs
76 # }
77 #
78 # src_install() {
79 # use doc && HTML_DOCS=("${AUTOTOOLS_BUILD_DIR}/apidocs/html/")
80 # autotools-utils_src_install
81 # if use examples; then
82 # dobin "${AUTOTOOLS_BUILD_DIR}"/foo_example{1,2,3} \\
83 # || die 'dobin examples failed'
84 # fi
85 # }
86 #
87 # @CODE
88
89 # Keep variable names synced with cmake-utils and the other way around!
90
91 case ${EAPI:-0} in
92 2|3|4) ;;
93 *) die "EAPI=${EAPI} is not supported" ;;
94 esac
95
96 # @ECLASS-VARIABLE: AUTOTOOLS_AUTORECONF
97 # @DEFAULT_UNSET
98 # @DESCRIPTION:
99 # Set to a non-empty value in order to enable running autoreconf
100 # in src_prepare() and adding autotools dependencies.
101 #
102 # The eclass will try to determine the correct autotools to run including a few
103 # external tools: gettext, glib-gettext, intltool, gtk-doc, gnome-doc-prepare.
104 # If your tool is not supported, please open a bug and we'll add support for it.
105 #
106 # Note that dependencies are added for autoconf, automake and libtool only.
107 # If your package needs one of the external tools listed above, you need to add
108 # appropriate packages to DEPEND yourself.
109 [[ ${AUTOTOOLS_AUTORECONF} ]] || _autotools_auto_dep=no
110
111 AUTOTOOLS_AUTO_DEPEND=${_autotools_auto_dep} \
112 inherit autotools eutils libtool
113
114 EXPORT_FUNCTIONS src_prepare src_configure src_compile src_install src_test
115
116 unset _autotools_auto_dep
117
118 # @ECLASS-VARIABLE: AUTOTOOLS_BUILD_DIR
119 # @DEFAULT_UNSET
120 # @DESCRIPTION:
121 # Build directory, location where all autotools generated files should be
122 # placed. For out of source builds it defaults to ${WORKDIR}/${P}_build.
123
124 # @ECLASS-VARIABLE: AUTOTOOLS_IN_SOURCE_BUILD
125 # @DEFAULT_UNSET
126 # @DESCRIPTION:
127 # Set to enable in-source build.
128
129 # @ECLASS-VARIABLE: ECONF_SOURCE
130 # @DEFAULT_UNSET
131 # @DESCRIPTION:
132 # Specify location of autotools' configure script. By default it uses ${S}.
133
134 # @ECLASS-VARIABLE: myeconfargs
135 # @DEFAULT_UNSET
136 # @DESCRIPTION:
137 # Optional econf arguments as Bash array. Should be defined before calling src_configure.
138 # @CODE
139 # src_configure() {
140 # local myeconfargs=(
141 # --disable-readline
142 # --with-confdir="/etc/nasty foo confdir/"
143 # $(use_enable debug cnddebug)
144 # $(use_enable threads multithreading)
145 # )
146 # autotools-utils_src_configure
147 # }
148 # @CODE
149
150 # @ECLASS-VARIABLE: DOCS
151 # @DEFAULT_UNSET
152 # @DESCRIPTION:
153 # Array containing documents passed to dodoc command.
154 #
155 # Example:
156 # @CODE
157 # DOCS=( NEWS README )
158 # @CODE
159
160 # @ECLASS-VARIABLE: HTML_DOCS
161 # @DEFAULT_UNSET
162 # @DESCRIPTION:
163 # Array containing documents passed to dohtml command.
164 #
165 # Example:
166 # @CODE
167 # HTML_DOCS=( doc/html/ )
168 # @CODE
169
170 # @ECLASS-VARIABLE: PATCHES
171 # @DEFAULT_UNSET
172 # @DESCRIPTION:
173 # PATCHES array variable containing all various patches to be applied.
174 #
175 # Example:
176 # @CODE
177 # PATCHES=( "${FILESDIR}"/${P}-mypatch.patch )
178 # @CODE
179
180 # Determine using IN or OUT source build
181 _check_build_dir() {
182 : ${ECONF_SOURCE:=${S}}
183 if [[ -n ${AUTOTOOLS_IN_SOURCE_BUILD} ]]; then
184 AUTOTOOLS_BUILD_DIR="${ECONF_SOURCE}"
185 else
186 : ${AUTOTOOLS_BUILD_DIR:=${WORKDIR}/${P}_build}
187 fi
188 echo ">>> Working in BUILD_DIR: \"$AUTOTOOLS_BUILD_DIR\""
189 }
190
191 # @FUNCTION: remove_libtool_files
192 # @USAGE: [all]
193 # @DESCRIPTION:
194 # Determines unnecessary libtool files (.la) and libtool static archives (.a)
195 # and removes them from installation image.
196 #
197 # To unconditionally remove all libtool files, pass 'all' as argument.
198 # Otherwise, libtool archives required for static linking will be preserved.
199 #
200 # In most cases it's not necessary to manually invoke this function.
201 # See autotools-utils_src_install for reference.
202 remove_libtool_files() {
203 debug-print-function ${FUNCNAME} "$@"
204 local removing_all
205 [[ ${#} -le 1 ]] || die "Invalid number of args to ${FUNCNAME}()"
206 if [[ ${#} -eq 1 ]]; then
207 case "${1}" in
208 all)
209 removing_all=1
210 ;;
211 *)
212 die "Invalid argument to ${FUNCNAME}(): ${1}"
213 esac
214 fi
215
216 local pc_libs=()
217 if [[ ! ${removing_all} ]]; then
218 local arg
219 for arg in $(find "${D}" -name '*.pc' -exec \
220 sed -n -e 's;^Libs:;;p' {} +); do
221 [[ ${arg} == -l* ]] && pc_libs+=(lib${arg#-l}.la)
222 done
223 fi
224
225 local f
226 find "${D}" -type f -name '*.la' -print0 | while read -r -d '' f; do
227 local shouldnotlink=$(sed -ne '/^shouldnotlink=yes$/p' "${f}")
228 local archivefile=${f/%.la/.a}
229 [[ "${f}" != "${archivefile}" ]] || die 'regex sanity check failed'
230
231 # Remove static libs we're not supposed to link against.
232 if [[ ${shouldnotlink} ]]; then
233 einfo "Removing unnecessary ${archivefile#${D%/}}"
234 rm -f "${archivefile}" || die
235 # The .la file may be used by a module loader, so avoid removing it
236 # unless explicitly requested.
237 [[ ${removing_all} ]] || continue
238 fi
239
240 # Remove .la files when:
241 # - user explicitly wants us to remove all .la files,
242 # - respective static archive doesn't exist,
243 # - they are covered by a .pc file already,
244 # - they don't provide any new information (no libs & no flags).
245 local removing
246 if [[ ${removing_all} ]]; then removing='forced'
247 elif [[ ! -f ${archivefile} ]]; then removing='no static archive'
248 elif has "$(basename "${f}")" "${pc_libs[@]}"; then
249 removing='covered by .pc'
250 elif [[ ! $(sed -n -e \
251 "s/^\(dependency_libs\|inherited_linker_flags\)='\(.*\)'$/\2/p" \
252 "${f}") ]]; then removing='no libs & flags'
253 fi
254
255 if [[ ${removing} ]]; then
256 einfo "Removing unnecessary ${f#${D%/}} (${removing})"
257 rm -f "${f}" || die
258 fi
259 done
260
261 # check for invalid eclass use
262 # this is the most commonly used function, so do it here
263 _check_build_dir
264 if [[ ! -d "${AUTOTOOLS_BUILD_DIR}" ]]; then
265 eqawarn "autotools-utils used but autotools-utils_src_configure was never called."
266 eqawarn "This is not supported and never was. Please report a bug against"
267 eqawarn "the offending ebuild. This will become a fatal error in a near future."
268 fi
269 }
270
271 # @FUNCTION: autotools-utils_autoreconf
272 # @DESCRIPTION:
273 # Reconfigure the sources (like gnome-autogen.sh or eautoreconf).
274 autotools-utils_autoreconf() {
275 debug-print-function ${FUNCNAME} "$@"
276
277 # Override this func to not require unnecessary eaclocal calls.
278 autotools_check_macro() {
279 local x
280
281 # Add a few additional variants as we don't get expansions.
282 [[ ${1} = AC_CONFIG_HEADERS ]] && set -- "${@}" AC_CONFIG_HEADER
283
284 for x; do
285 grep -h "^${x}" configure.{ac,in} 2>/dev/null
286 done
287 }
288
289 einfo "Autoreconfiguring '${PWD}' ..."
290
291 local auxdir=$(sed -n -e 's/^AC_CONFIG_AUX_DIR(\(.*\))$/\1/p' \
292 configure.{ac,in} 2>/dev/null)
293 if [[ ${auxdir} ]]; then
294 auxdir=${auxdir%%]}
295 mkdir -p ${auxdir##[}
296 fi
297
298 # Support running additional tools like gnome-autogen.sh.
299 # Note: you need to add additional depends to the ebuild.
300
301 # gettext
302 if [[ $(autotools_check_macro AM_GLIB_GNU_GETTEXT) ]]; then
303 echo 'no' | autotools_run_tool glib-gettextize --copy
304 elif [[ $(autotools_check_macro AM_GNU_GETTEXT) ]]; then
305 eautopoint
306 fi
307
308 # intltool
309 if [[ $(autotools_check_macro AC_PROG_INTLTOOL IT_PROG_INTLTOOL) ]]
310 then
311 autotools_run_tool intltoolize --copy --automake
312 fi
313
314 # gtk-doc
315 if [[ $(autotools_check_macro GTK_DOC_CHECK) ]]; then
316 autotools_run_tool gtkdocize --copy
317 fi
318
319 # gnome-doc
320 if [[ $(autotools_check_macro GNOME_DOC_INIT) ]]; then
321 autotools_run_tool gnome-doc-prepare --copy
322 fi
323
324 # We need to perform the check twice to know whether to run eaclocal.
325 # (_elibtoolize does that itself)
326 if [[ $(autotools_check_macro AC_PROG_LIBTOOL AM_PROG_LIBTOOL LT_INIT) ]]
327 then
328 _elibtoolize --copy --force --install
329 else
330 eaclocal
331 fi
332
333 eautoconf
334 eautoheader
335 eautomake
336
337 local x
338 for x in $(autotools_get_subdirs); do
339 if [[ -d ${x} ]] ; then
340 pushd "${x}" >/dev/null
341 autotools-utils_eautoreconf
342 popd >/dev/null
343 fi
344 done
345 }
346
347 # @FUNCTION: autotools-utils_src_prepare
348 # @DESCRIPTION:
349 # The src_prepare function.
350 #
351 # Supporting PATCHES array and user patches. See base.eclass(5) for reference.
352 autotools-utils_src_prepare() {
353 debug-print-function ${FUNCNAME} "$@"
354
355 local want_autoreconf=${AUTOTOOLS_AUTORECONF}
356
357 [[ ${PATCHES} ]] && epatch "${PATCHES[@]}"
358 epatch_user
359
360 [[ ${want_autoreconf} ]] && autotools-utils_autoreconf
361 elibtoolize --patch-only
362 }
363
364 # @FUNCTION: autotools-utils_src_configure
365 # @DESCRIPTION:
366 # The src_configure function. For out of source build it creates build
367 # directory and runs econf there. Configuration parameters defined
368 # in myeconfargs are passed here to econf. Additionally following USE
369 # flags are known:
370 #
371 # IUSE="static-libs" passes --enable-shared and either --disable-static/--enable-static
372 # to econf respectively.
373 autotools-utils_src_configure() {
374 debug-print-function ${FUNCNAME} "$@"
375
376 [[ -z ${myeconfargs+1} || $(declare -p myeconfargs) == 'declare -a'* ]] \
377 || die 'autotools-utils.eclass: myeconfargs has to be an array.'
378
379 # Common args
380 local econfargs=()
381
382 # Handle static-libs found in IUSE, disable them by default
383 if in_iuse static-libs; then
384 econfargs+=(
385 --enable-shared
386 $(use_enable static-libs static)
387 )
388 fi
389
390 # Append user args
391 econfargs+=("${myeconfargs[@]}")
392
393 _check_build_dir
394 mkdir -p "${AUTOTOOLS_BUILD_DIR}" || die "mkdir '${AUTOTOOLS_BUILD_DIR}' failed"
395 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null
396 econf "${econfargs[@]}" "$@"
397 popd > /dev/null
398 }
399
400 # @FUNCTION: autotools-utils_src_compile
401 # @DESCRIPTION:
402 # The autotools src_compile function, invokes emake in specified AUTOTOOLS_BUILD_DIR.
403 autotools-utils_src_compile() {
404 debug-print-function ${FUNCNAME} "$@"
405
406 _check_build_dir
407 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null
408 emake "$@" || die 'emake failed'
409 popd > /dev/null
410 }
411
412 # @FUNCTION: autotools-utils_src_install
413 # @DESCRIPTION:
414 # The autotools src_install function. Runs emake install, unconditionally
415 # removes unnecessary static libs (based on shouldnotlink libtool property)
416 # and removes unnecessary libtool files when static-libs USE flag is defined
417 # and unset.
418 #
419 # DOCS and HTML_DOCS arrays are supported. See base.eclass(5) for reference.
420 autotools-utils_src_install() {
421 debug-print-function ${FUNCNAME} "$@"
422
423 _check_build_dir
424 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null
425 emake DESTDIR="${D}" "$@" install || die "emake install failed"
426 popd > /dev/null
427
428 # XXX: support installing them from builddir as well?
429 if [[ ${DOCS} ]]; then
430 dodoc "${DOCS[@]}" || die "dodoc failed"
431 else
432 local f
433 # same list as in PMS
434 for f in README* ChangeLog AUTHORS NEWS TODO CHANGES \
435 THANKS BUGS FAQ CREDITS CHANGELOG; do
436 if [[ -s ${f} ]]; then
437 dodoc "${f}" || die "(default) dodoc ${f} failed"
438 fi
439 done
440 fi
441 if [[ ${HTML_DOCS} ]]; then
442 dohtml -r "${HTML_DOCS[@]}" || die "dohtml failed"
443 fi
444
445 # Remove libtool files and unnecessary static libs
446 remove_libtool_files
447 }
448
449 # @FUNCTION: autotools-utils_src_test
450 # @DESCRIPTION:
451 # The autotools src_test function. Runs emake check in build directory.
452 autotools-utils_src_test() {
453 debug-print-function ${FUNCNAME} "$@"
454
455 _check_build_dir
456 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null
457 # Run default src_test as defined in ebuild.sh
458 default_src_test
459 popd > /dev/null
460 }

  ViewVC Help
Powered by ViewVC 1.1.20