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

Contents of /eclass/autotools-utils.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.58 - (show annotations) (download)
Sat Dec 1 16:26:03 2012 UTC (2 years ago) by mgorny
Branch: MAIN
Changes since 1.57: +19 -13 lines
Use a common BUILD_DIR variable. Acked by scarabeus.

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.57 2012/09/27 16:35:41 axs 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 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=("${BUILD_DIR}/apidocs/html/")
80 # autotools-utils_src_install
81 # if use examples; then
82 # dobin "${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|5) ;;
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 # This is usually necessary when using live sources or applying patches
103 # modifying configure.ac or Makefile.am files. Note that in the latter case
104 # setting this variable is obligatory even though the eclass will work without
105 # it (to add the necessary dependencies).
106 #
107 # The eclass will try to determine the correct autotools to run including a few
108 # external tools: gettext, glib-gettext, intltool, gtk-doc, gnome-doc-prepare.
109 # If your tool is not supported, please open a bug and we'll add support for it.
110 #
111 # Note that dependencies are added for autoconf, automake and libtool only.
112 # If your package needs one of the external tools listed above, you need to add
113 # appropriate packages to DEPEND yourself.
114 [[ ${AUTOTOOLS_AUTORECONF} ]] || : ${AUTOTOOLS_AUTO_DEPEND:=no}
115
116 inherit autotools eutils libtool
117
118 EXPORT_FUNCTIONS src_prepare src_configure src_compile src_install src_test
119
120 # @ECLASS-VARIABLE: BUILD_DIR
121 # @DEFAULT_UNSET
122 # @DESCRIPTION:
123 # Build directory, location where all autotools generated files should be
124 # placed. For out of source builds it defaults to ${WORKDIR}/${P}_build.
125 #
126 # This variable has been called AUTOTOOLS_BUILD_DIR formerly.
127 # It is set under that name for compatibility.
128
129 # @ECLASS-VARIABLE: AUTOTOOLS_IN_SOURCE_BUILD
130 # @DEFAULT_UNSET
131 # @DESCRIPTION:
132 # Set to enable in-source build.
133
134 # @ECLASS-VARIABLE: ECONF_SOURCE
135 # @DEFAULT_UNSET
136 # @DESCRIPTION:
137 # Specify location of autotools' configure script. By default it uses ${S}.
138
139 # @ECLASS-VARIABLE: myeconfargs
140 # @DEFAULT_UNSET
141 # @DESCRIPTION:
142 # Optional econf arguments as Bash array. Should be defined before calling src_configure.
143 # @CODE
144 # src_configure() {
145 # local myeconfargs=(
146 # --disable-readline
147 # --with-confdir="/etc/nasty foo confdir/"
148 # $(use_enable debug cnddebug)
149 # $(use_enable threads multithreading)
150 # )
151 # autotools-utils_src_configure
152 # }
153 # @CODE
154
155 # @ECLASS-VARIABLE: DOCS
156 # @DEFAULT_UNSET
157 # @DESCRIPTION:
158 # Array containing documents passed to dodoc command.
159 #
160 # Example:
161 # @CODE
162 # DOCS=( NEWS README )
163 # @CODE
164
165 # @ECLASS-VARIABLE: HTML_DOCS
166 # @DEFAULT_UNSET
167 # @DESCRIPTION:
168 # Array containing documents passed to dohtml command.
169 #
170 # Example:
171 # @CODE
172 # HTML_DOCS=( doc/html/ )
173 # @CODE
174
175 # @ECLASS-VARIABLE: PATCHES
176 # @DEFAULT_UNSET
177 # @DESCRIPTION:
178 # PATCHES array variable containing all various patches to be applied.
179 #
180 # Example:
181 # @CODE
182 # PATCHES=( "${FILESDIR}"/${P}-mypatch.patch )
183 # @CODE
184
185 # Determine using IN or OUT source build
186 _check_build_dir() {
187 : ${ECONF_SOURCE:=${S}}
188 if [[ -n ${AUTOTOOLS_IN_SOURCE_BUILD} ]]; then
189 BUILD_DIR="${ECONF_SOURCE}"
190 else
191 : ${BUILD_DIR:=${AUTOTOOLS_BUILD_DIR:-${WORKDIR}/${P}_build}}
192 fi
193
194 # Backwards compatibility.
195 AUTOTOOLS_BUILD_DIR=${BUILD_DIR}
196 echo ">>> Working in BUILD_DIR: \"${BUILD_DIR}\""
197 }
198
199 # @FUNCTION: remove_libtool_files
200 # @USAGE: [all]
201 # @DESCRIPTION:
202 # Determines unnecessary libtool files (.la) and libtool static archives (.a)
203 # and removes them from installation image.
204 #
205 # To unconditionally remove all libtool files, pass 'all' as argument.
206 # Otherwise, libtool archives required for static linking will be preserved.
207 #
208 # In most cases it's not necessary to manually invoke this function.
209 # See autotools-utils_src_install for reference.
210 remove_libtool_files() {
211 debug-print-function ${FUNCNAME} "$@"
212 local removing_all
213
214 eqawarn "The remove_libtool_files() function was deprecated."
215 eqawarn "Please use prune_libtool_files() from eutils eclass instead."
216
217 [[ ${#} -le 1 ]] || die "Invalid number of args to ${FUNCNAME}()"
218 if [[ ${#} -eq 1 ]]; then
219 case "${1}" in
220 all)
221 removing_all=1
222 ;;
223 *)
224 die "Invalid argument to ${FUNCNAME}(): ${1}"
225 esac
226 fi
227
228 local pc_libs=()
229 if [[ ! ${removing_all} ]]; then
230 local arg
231 for arg in $(find "${D}" -name '*.pc' -exec \
232 sed -n -e 's;^Libs:;;p' {} +); do
233 [[ ${arg} == -l* ]] && pc_libs+=(lib${arg#-l}.la)
234 done
235 fi
236
237 local f
238 find "${D}" -type f -name '*.la' -print0 | while read -r -d '' f; do
239 local shouldnotlink=$(sed -ne '/^shouldnotlink=yes$/p' "${f}")
240 local archivefile=${f/%.la/.a}
241 [[ "${f}" != "${archivefile}" ]] || die 'regex sanity check failed'
242
243 # Remove static libs we're not supposed to link against.
244 if [[ ${shouldnotlink} ]]; then
245 einfo "Removing unnecessary ${archivefile#${D%/}}"
246 rm -f "${archivefile}" || die
247 # The .la file may be used by a module loader, so avoid removing it
248 # unless explicitly requested.
249 [[ ${removing_all} ]] || continue
250 fi
251
252 # Remove .la files when:
253 # - user explicitly wants us to remove all .la files,
254 # - respective static archive doesn't exist,
255 # - they are covered by a .pc file already,
256 # - they don't provide any new information (no libs & no flags).
257 local removing
258 if [[ ${removing_all} ]]; then removing='forced'
259 elif [[ ! -f ${archivefile} ]]; then removing='no static archive'
260 elif has "$(basename "${f}")" "${pc_libs[@]}"; then
261 removing='covered by .pc'
262 elif [[ ! $(sed -n -e \
263 "s/^\(dependency_libs\|inherited_linker_flags\)='\(.*\)'$/\2/p" \
264 "${f}") ]]; then removing='no libs & flags'
265 fi
266
267 if [[ ${removing} ]]; then
268 einfo "Removing unnecessary ${f#${D%/}} (${removing})"
269 rm -f "${f}" || die
270 fi
271 done
272 }
273
274 # @FUNCTION: autotools-utils_autoreconf
275 # @DESCRIPTION:
276 # Reconfigure the sources (like gnome-autogen.sh or eautoreconf).
277 autotools-utils_autoreconf() {
278 debug-print-function ${FUNCNAME} "$@"
279
280 eqawarn "The autotools-utils_autoreconf() function was deprecated."
281 eqawarn "Please call autotools-utils_src_prepare()"
282 eqawarn "with AUTOTOOLS_AUTORECONF set instead."
283
284 # Override this func to not require unnecessary eaclocal calls.
285 autotools_check_macro() {
286 local x
287
288 # Add a few additional variants as we don't get expansions.
289 [[ ${1} = AC_CONFIG_HEADERS ]] && set -- "${@}" \
290 AC_CONFIG_HEADER AM_CONFIG_HEADER
291
292 for x; do
293 grep -h "^${x}" configure.{ac,in} 2>/dev/null
294 done
295 }
296
297 einfo "Autoreconfiguring '${PWD}' ..."
298
299 local auxdir=$(sed -n -e 's/^AC_CONFIG_AUX_DIR(\(.*\))$/\1/p' \
300 configure.{ac,in} 2>/dev/null)
301 if [[ ${auxdir} ]]; then
302 auxdir=${auxdir%%]}
303 mkdir -p ${auxdir##[}
304 fi
305
306 # Support running additional tools like gnome-autogen.sh.
307 # Note: you need to add additional depends to the ebuild.
308
309 # gettext
310 if [[ $(autotools_check_macro AM_GLIB_GNU_GETTEXT) ]]; then
311 echo 'no' | autotools_run_tool glib-gettextize --copy --force
312 elif [[ $(autotools_check_macro AM_GNU_GETTEXT) ]]; then
313 eautopoint --force
314 fi
315
316 # intltool
317 if [[ $(autotools_check_macro AC_PROG_INTLTOOL IT_PROG_INTLTOOL) ]]
318 then
319 autotools_run_tool intltoolize --copy --automake --force
320 fi
321
322 # gtk-doc
323 if [[ $(autotools_check_macro GTK_DOC_CHECK) ]]; then
324 autotools_run_tool gtkdocize --copy
325 fi
326
327 # gnome-doc
328 if [[ $(autotools_check_macro GNOME_DOC_INIT) ]]; then
329 autotools_run_tool gnome-doc-prepare --copy --force
330 fi
331
332 if [[ $(autotools_check_macro AC_PROG_LIBTOOL AM_PROG_LIBTOOL LT_INIT) ]]
333 then
334 _elibtoolize --copy --force --install
335 fi
336
337 eaclocal
338 eautoconf
339 eautoheader
340 FROM_EAUTORECONF=sure eautomake
341
342 local x
343 for x in $(autotools_check_macro_val AC_CONFIG_SUBDIRS); do
344 if [[ -d ${x} ]] ; then
345 pushd "${x}" >/dev/null || die
346 autotools-utils_autoreconf
347 popd >/dev/null || die
348 fi
349 done
350 }
351
352 # @FUNCTION: autotools-utils_src_prepare
353 # @DESCRIPTION:
354 # The src_prepare function.
355 #
356 # Supporting PATCHES array and user patches. See base.eclass(5) for reference.
357 autotools-utils_src_prepare() {
358 debug-print-function ${FUNCNAME} "$@"
359
360 local want_autoreconf=${AUTOTOOLS_AUTORECONF}
361
362 [[ ${PATCHES} ]] && epatch "${PATCHES[@]}"
363
364 at_checksum() {
365 find '(' -name 'Makefile.am' \
366 -o -name 'configure.ac' \
367 -o -name 'configure.in' ')' \
368 -exec cksum {} + | sort -k2
369 }
370
371 [[ ! ${want_autoreconf} ]] && local checksum=$(at_checksum)
372 epatch_user
373 if [[ ! ${want_autoreconf} ]]; then
374 if [[ ${checksum} != $(at_checksum) ]]; then
375 einfo 'Will autoreconfigure due to user patches applied.'
376 want_autoreconf=yep
377 fi
378 fi
379
380 [[ ${want_autoreconf} ]] && eautoreconf
381 elibtoolize --patch-only
382 }
383
384 # @FUNCTION: autotools-utils_src_configure
385 # @DESCRIPTION:
386 # The src_configure function. For out of source build it creates build
387 # directory and runs econf there. Configuration parameters defined
388 # in myeconfargs are passed here to econf. Additionally following USE
389 # flags are known:
390 #
391 # IUSE="static-libs" passes --enable-shared and either --disable-static/--enable-static
392 # to econf respectively.
393 autotools-utils_src_configure() {
394 debug-print-function ${FUNCNAME} "$@"
395
396 [[ -z ${myeconfargs+1} || $(declare -p myeconfargs) == 'declare -a'* ]] \
397 || die 'autotools-utils.eclass: myeconfargs has to be an array.'
398
399 [[ ${EAPI} == 2 ]] && ! use prefix && EPREFIX=
400
401 # Common args
402 local econfargs=()
403
404 _check_build_dir
405 if "${ECONF_SOURCE}"/configure --help 2>&1 | grep -q '^ *--docdir='; then
406 econfargs+=(
407 --docdir="${EPREFIX}"/usr/share/doc/${PF}
408 )
409 fi
410
411 # Handle static-libs found in IUSE, disable them by default
412 if in_iuse static-libs; then
413 econfargs+=(
414 --enable-shared
415 $(use_enable static-libs static)
416 )
417 fi
418
419 # Append user args
420 econfargs+=("${myeconfargs[@]}")
421
422 mkdir -p "${BUILD_DIR}" || die
423 pushd "${BUILD_DIR}" > /dev/null || die
424 econf "${econfargs[@]}" "$@"
425 popd > /dev/null || die
426 }
427
428 # @FUNCTION: autotools-utils_src_compile
429 # @DESCRIPTION:
430 # The autotools src_compile function, invokes emake in specified BUILD_DIR.
431 autotools-utils_src_compile() {
432 debug-print-function ${FUNCNAME} "$@"
433
434 _check_build_dir
435 pushd "${BUILD_DIR}" > /dev/null || die
436 emake "$@" || die 'emake failed'
437 popd > /dev/null || die
438 }
439
440 # @FUNCTION: autotools-utils_src_install
441 # @DESCRIPTION:
442 # The autotools src_install function. Runs emake install, unconditionally
443 # removes unnecessary static libs (based on shouldnotlink libtool property)
444 # and removes unnecessary libtool files when static-libs USE flag is defined
445 # and unset.
446 #
447 # DOCS and HTML_DOCS arrays are supported. See base.eclass(5) for reference.
448 autotools-utils_src_install() {
449 debug-print-function ${FUNCNAME} "$@"
450
451 _check_build_dir
452 pushd "${BUILD_DIR}" > /dev/null || die
453 emake DESTDIR="${D}" "$@" install || die "emake install failed"
454 popd > /dev/null || die
455
456 # Move docs installed by autotools (in EAPI < 4).
457 if [[ ${EAPI} == [23] ]] \
458 && path_exists "${D}${EPREFIX}"/usr/share/doc/${PF}/*; then
459 if [[ $(find "${D}${EPREFIX}"/usr/share/doc/${PF}/* -type d) ]]; then
460 eqawarn "autotools-utils: directories in docdir require at least EAPI 4"
461 else
462 mkdir "${T}"/temp-docdir
463 mv "${D}${EPREFIX}"/usr/share/doc/${PF}/* "${T}"/temp-docdir/ \
464 || die "moving docs to tempdir failed"
465
466 dodoc "${T}"/temp-docdir/* || die "docdir dodoc failed"
467 rm -r "${T}"/temp-docdir || die
468 fi
469 fi
470
471 # XXX: support installing them from builddir as well?
472 if [[ ${DOCS} ]]; then
473 dodoc "${DOCS[@]}" || die "dodoc failed"
474 else
475 local f
476 # same list as in PMS
477 for f in README* ChangeLog AUTHORS NEWS TODO CHANGES \
478 THANKS BUGS FAQ CREDITS CHANGELOG; do
479 if [[ -s ${f} ]]; then
480 dodoc "${f}" || die "(default) dodoc ${f} failed"
481 fi
482 done
483 fi
484 if [[ ${HTML_DOCS} ]]; then
485 dohtml -r "${HTML_DOCS[@]}" || die "dohtml failed"
486 fi
487
488 # Remove libtool files and unnecessary static libs
489 prune_libtool_files
490 }
491
492 # @FUNCTION: autotools-utils_src_test
493 # @DESCRIPTION:
494 # The autotools src_test function. Runs emake check in build directory.
495 autotools-utils_src_test() {
496 debug-print-function ${FUNCNAME} "$@"
497
498 _check_build_dir
499 pushd "${BUILD_DIR}" > /dev/null || die
500 # Run default src_test as defined in ebuild.sh
501 default_src_test
502 popd > /dev/null || die
503 }

  ViewVC Help
Powered by ViewVC 1.1.20