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

Contents of /eclass/autotools-utils.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.65 - (show annotations) (download)
Fri Apr 5 14:54:48 2013 UTC (20 months, 3 weeks ago) by mgorny
Branch: MAIN
Changes since 1.64: +2 -2 lines
Fix eclassdoc.

1 # Copyright 1999-2013 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.64 2013/04/01 09:16:07 mgorny 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 # dev-qt/qtcore:4
41 # dev-qt/qtgui: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 # In EAPIs 4+, can list directories as well.
161 #
162 # Example:
163 # @CODE
164 # DOCS=( NEWS README )
165 # @CODE
166
167 # @ECLASS-VARIABLE: HTML_DOCS
168 # @DEFAULT_UNSET
169 # @DESCRIPTION:
170 # Array containing documents passed to dohtml command.
171 #
172 # Example:
173 # @CODE
174 # HTML_DOCS=( doc/html/ )
175 # @CODE
176
177 # @ECLASS-VARIABLE: PATCHES
178 # @DEFAULT_UNSET
179 # @DESCRIPTION:
180 # PATCHES array variable containing all various patches to be applied.
181 #
182 # Example:
183 # @CODE
184 # PATCHES=( "${FILESDIR}"/${P}-mypatch.patch )
185 # @CODE
186
187 # @ECLASS-VARIABLE: AUTOTOOLS_PRUNE_LIBTOOL_FILES
188 # @DEFAULT_UNSET
189 # @DESCRIPTION:
190 # Sets the mode of pruning libtool files. The values correspond to
191 # prune_libtool_files parameters, with leading dashes stripped.
192 #
193 # Defaults to pruning the libtool files when static libraries are not
194 # installed or can be linked properly without them. Libtool files
195 # for modules (plugins) will be kept in case plugin loader needs them.
196 #
197 # If set to 'modules', the .la files for modules will be removed
198 # as well. This is often the preferred option.
199 #
200 # If set to 'all', all .la files will be removed unconditionally. This
201 # option is discouraged and shall be used only if 'modules' does not
202 # remove the files.
203
204 # Determine using IN or OUT source build
205 _check_build_dir() {
206 : ${ECONF_SOURCE:=${S}}
207 if [[ -n ${AUTOTOOLS_IN_SOURCE_BUILD} ]]; then
208 BUILD_DIR="${ECONF_SOURCE}"
209 else
210 # Respect both the old variable and the new one, depending
211 # on which one was set by the ebuild.
212 if [[ ! ${BUILD_DIR} && ${AUTOTOOLS_BUILD_DIR} ]]; then
213 eqawarn "The AUTOTOOLS_BUILD_DIR variable has been renamed to BUILD_DIR."
214 eqawarn "Please migrate the ebuild to use the new one."
215
216 # In the next call, both variables will be set already
217 # and we'd have to know which one takes precedence.
218 _RESPECT_AUTOTOOLS_BUILD_DIR=1
219 fi
220
221 if [[ ${_RESPECT_AUTOTOOLS_BUILD_DIR} ]]; then
222 BUILD_DIR=${AUTOTOOLS_BUILD_DIR:-${WORKDIR}/${P}_build}
223 else
224 : ${BUILD_DIR:=${WORKDIR}/${P}_build}
225 fi
226 fi
227
228 # Backwards compatibility for getting the value.
229 AUTOTOOLS_BUILD_DIR=${BUILD_DIR}
230 echo ">>> Working in BUILD_DIR: \"${BUILD_DIR}\""
231 }
232
233 # @FUNCTION: remove_libtool_files
234 # @USAGE: [all]
235 # @DESCRIPTION:
236 # Determines unnecessary libtool files (.la) and libtool static archives (.a)
237 # and removes them from installation image.
238 #
239 # To unconditionally remove all libtool files, pass 'all' as argument.
240 # Otherwise, libtool archives required for static linking will be preserved.
241 #
242 # In most cases it's not necessary to manually invoke this function.
243 # See autotools-utils_src_install for reference.
244 remove_libtool_files() {
245 debug-print-function ${FUNCNAME} "$@"
246 local removing_all
247
248 eqawarn "The remove_libtool_files() function was deprecated."
249 eqawarn "Please use prune_libtool_files() from eutils eclass instead."
250
251 [[ ${#} -le 1 ]] || die "Invalid number of args to ${FUNCNAME}()"
252 if [[ ${#} -eq 1 ]]; then
253 case "${1}" in
254 all)
255 removing_all=1
256 ;;
257 *)
258 die "Invalid argument to ${FUNCNAME}(): ${1}"
259 esac
260 fi
261
262 local pc_libs=()
263 if [[ ! ${removing_all} ]]; then
264 local arg
265 for arg in $(find "${D}" -name '*.pc' -exec \
266 sed -n -e 's;^Libs:;;p' {} +); do
267 [[ ${arg} == -l* ]] && pc_libs+=(lib${arg#-l}.la)
268 done
269 fi
270
271 local f
272 find "${D}" -type f -name '*.la' -print0 | while read -r -d '' f; do
273 local shouldnotlink=$(sed -ne '/^shouldnotlink=yes$/p' "${f}")
274 local archivefile=${f/%.la/.a}
275 [[ "${f}" != "${archivefile}" ]] || die 'regex sanity check failed'
276
277 # Remove static libs we're not supposed to link against.
278 if [[ ${shouldnotlink} ]]; then
279 einfo "Removing unnecessary ${archivefile#${D%/}}"
280 rm -f "${archivefile}" || die
281 # The .la file may be used by a module loader, so avoid removing it
282 # unless explicitly requested.
283 [[ ${removing_all} ]] || continue
284 fi
285
286 # Remove .la files when:
287 # - user explicitly wants us to remove all .la files,
288 # - respective static archive doesn't exist,
289 # - they are covered by a .pc file already,
290 # - they don't provide any new information (no libs & no flags).
291 local removing
292 if [[ ${removing_all} ]]; then removing='forced'
293 elif [[ ! -f ${archivefile} ]]; then removing='no static archive'
294 elif has "$(basename "${f}")" "${pc_libs[@]}"; then
295 removing='covered by .pc'
296 elif [[ ! $(sed -n -e \
297 "s/^\(dependency_libs\|inherited_linker_flags\)='\(.*\)'$/\2/p" \
298 "${f}") ]]; then removing='no libs & flags'
299 fi
300
301 if [[ ${removing} ]]; then
302 einfo "Removing unnecessary ${f#${D%/}} (${removing})"
303 rm -f "${f}" || die
304 fi
305 done
306 }
307
308 # @FUNCTION: autotools-utils_autoreconf
309 # @DESCRIPTION:
310 # Reconfigure the sources (like gnome-autogen.sh or eautoreconf).
311 autotools-utils_autoreconf() {
312 debug-print-function ${FUNCNAME} "$@"
313
314 eqawarn "The autotools-utils_autoreconf() function was deprecated."
315 eqawarn "Please call autotools-utils_src_prepare()"
316 eqawarn "with AUTOTOOLS_AUTORECONF set instead."
317
318 # Override this func to not require unnecessary eaclocal calls.
319 autotools_check_macro() {
320 local x
321
322 # Add a few additional variants as we don't get expansions.
323 [[ ${1} = AC_CONFIG_HEADERS ]] && set -- "${@}" \
324 AC_CONFIG_HEADER AM_CONFIG_HEADER
325
326 for x; do
327 grep -h "^${x}" configure.{ac,in} 2>/dev/null
328 done
329 }
330
331 einfo "Autoreconfiguring '${PWD}' ..."
332
333 local auxdir=$(sed -n -e 's/^AC_CONFIG_AUX_DIR(\(.*\))$/\1/p' \
334 configure.{ac,in} 2>/dev/null)
335 if [[ ${auxdir} ]]; then
336 auxdir=${auxdir%%]}
337 mkdir -p ${auxdir##[}
338 fi
339
340 # Support running additional tools like gnome-autogen.sh.
341 # Note: you need to add additional depends to the ebuild.
342
343 # gettext
344 if [[ $(autotools_check_macro AM_GLIB_GNU_GETTEXT) ]]; then
345 echo 'no' | autotools_run_tool glib-gettextize --copy --force
346 elif [[ $(autotools_check_macro AM_GNU_GETTEXT) ]]; then
347 eautopoint --force
348 fi
349
350 # intltool
351 if [[ $(autotools_check_macro AC_PROG_INTLTOOL IT_PROG_INTLTOOL) ]]
352 then
353 autotools_run_tool intltoolize --copy --automake --force
354 fi
355
356 # gtk-doc
357 if [[ $(autotools_check_macro GTK_DOC_CHECK) ]]; then
358 autotools_run_tool gtkdocize --copy
359 fi
360
361 # gnome-doc
362 if [[ $(autotools_check_macro GNOME_DOC_INIT) ]]; then
363 autotools_run_tool gnome-doc-prepare --copy --force
364 fi
365
366 if [[ $(autotools_check_macro AC_PROG_LIBTOOL AM_PROG_LIBTOOL LT_INIT) ]]
367 then
368 _elibtoolize --copy --force --install
369 fi
370
371 eaclocal
372 eautoconf
373 eautoheader
374 FROM_EAUTORECONF=sure eautomake
375
376 local x
377 for x in $(autotools_check_macro_val AC_CONFIG_SUBDIRS); do
378 if [[ -d ${x} ]] ; then
379 pushd "${x}" >/dev/null || die
380 autotools-utils_autoreconf
381 popd >/dev/null || die
382 fi
383 done
384 }
385
386 # @FUNCTION: autotools-utils_src_prepare
387 # @DESCRIPTION:
388 # The src_prepare function.
389 #
390 # Supporting PATCHES array and user patches. See base.eclass(5) for reference.
391 autotools-utils_src_prepare() {
392 debug-print-function ${FUNCNAME} "$@"
393
394 local want_autoreconf=${AUTOTOOLS_AUTORECONF}
395
396 [[ ${PATCHES} ]] && epatch "${PATCHES[@]}"
397
398 at_checksum() {
399 find '(' -name 'Makefile.am' \
400 -o -name 'configure.ac' \
401 -o -name 'configure.in' ')' \
402 -exec cksum {} + | sort -k2
403 }
404
405 [[ ! ${want_autoreconf} ]] && local checksum=$(at_checksum)
406 epatch_user
407 if [[ ! ${want_autoreconf} ]]; then
408 if [[ ${checksum} != $(at_checksum) ]]; then
409 einfo 'Will autoreconfigure due to user patches applied.'
410 want_autoreconf=yep
411 fi
412 fi
413
414 [[ ${want_autoreconf} ]] && eautoreconf
415 elibtoolize --patch-only
416 }
417
418 # @FUNCTION: autotools-utils_src_configure
419 # @DESCRIPTION:
420 # The src_configure function. For out of source build it creates build
421 # directory and runs econf there. Configuration parameters defined
422 # in myeconfargs are passed here to econf. Additionally following USE
423 # flags are known:
424 #
425 # IUSE="static-libs" passes --enable-shared and either --disable-static/--enable-static
426 # to econf respectively.
427 autotools-utils_src_configure() {
428 debug-print-function ${FUNCNAME} "$@"
429
430 [[ -z ${myeconfargs+1} || $(declare -p myeconfargs) == 'declare -a'* ]] \
431 || die 'autotools-utils.eclass: myeconfargs has to be an array.'
432
433 [[ ${EAPI} == 2 ]] && ! use prefix && EPREFIX=
434
435 # Common args
436 local econfargs=()
437
438 _check_build_dir
439 if "${ECONF_SOURCE}"/configure --help 2>&1 | grep -q '^ *--docdir='; then
440 econfargs+=(
441 --docdir="${EPREFIX}"/usr/share/doc/${PF}
442 )
443 fi
444
445 # Handle static-libs found in IUSE, disable them by default
446 if in_iuse static-libs; then
447 econfargs+=(
448 --enable-shared
449 $(use_enable static-libs static)
450 )
451 fi
452
453 # Append user args
454 econfargs+=("${myeconfargs[@]}")
455
456 mkdir -p "${BUILD_DIR}" || die
457 pushd "${BUILD_DIR}" > /dev/null || die
458 econf "${econfargs[@]}" "$@"
459 popd > /dev/null || die
460 }
461
462 # @FUNCTION: autotools-utils_src_compile
463 # @DESCRIPTION:
464 # The autotools src_compile function, invokes emake in specified BUILD_DIR.
465 autotools-utils_src_compile() {
466 debug-print-function ${FUNCNAME} "$@"
467
468 _check_build_dir
469 pushd "${BUILD_DIR}" > /dev/null || die
470 emake "$@" || die 'emake failed'
471 popd > /dev/null || die
472 }
473
474 # @FUNCTION: autotools-utils_src_install
475 # @DESCRIPTION:
476 # The autotools src_install function. Runs emake install, unconditionally
477 # removes unnecessary static libs (based on shouldnotlink libtool property)
478 # and removes unnecessary libtool files when static-libs USE flag is defined
479 # and unset.
480 #
481 # DOCS and HTML_DOCS arrays are supported. See base.eclass(5) for reference.
482 autotools-utils_src_install() {
483 debug-print-function ${FUNCNAME} "$@"
484
485 _check_build_dir
486 pushd "${BUILD_DIR}" > /dev/null || die
487 emake DESTDIR="${D}" "$@" install || die "emake install failed"
488 popd > /dev/null || die
489
490 # Move docs installed by autotools (in EAPI < 4).
491 if [[ ${EAPI} == [23] ]] \
492 && path_exists "${D}${EPREFIX}"/usr/share/doc/${PF}/*; then
493 if [[ $(find "${D}${EPREFIX}"/usr/share/doc/${PF}/* -type d) ]]; then
494 eqawarn "autotools-utils: directories in docdir require at least EAPI 4"
495 else
496 mkdir "${T}"/temp-docdir
497 mv "${D}${EPREFIX}"/usr/share/doc/${PF}/* "${T}"/temp-docdir/ \
498 || die "moving docs to tempdir failed"
499
500 dodoc "${T}"/temp-docdir/* || die "docdir dodoc failed"
501 rm -r "${T}"/temp-docdir || die
502 fi
503 fi
504
505 # XXX: support installing them from builddir as well?
506 if declare -p DOCS &>/dev/null; then
507 # an empty list == don't install anything
508 if [[ ${DOCS[@]} ]]; then
509 if [[ ${EAPI} == [23] ]]; then
510 dodoc "${DOCS[@]}" || die
511 else
512 # dies by itself
513 dodoc -r "${DOCS[@]}"
514 fi
515 fi
516 else
517 local f
518 # same list as in PMS
519 for f in README* ChangeLog AUTHORS NEWS TODO CHANGES \
520 THANKS BUGS FAQ CREDITS CHANGELOG; do
521 if [[ -s ${f} ]]; then
522 dodoc "${f}" || die "(default) dodoc ${f} failed"
523 fi
524 done
525 fi
526 if [[ ${HTML_DOCS} ]]; then
527 dohtml -r "${HTML_DOCS[@]}" || die "dohtml failed"
528 fi
529
530 # Remove libtool files and unnecessary static libs
531 local prune_ltfiles=${AUTOTOOLS_PRUNE_LIBTOOL_FILES}
532 prune_libtool_files ${prune_ltfiles:+--${prune_ltfiles}}
533 }
534
535 # @FUNCTION: autotools-utils_src_test
536 # @DESCRIPTION:
537 # The autotools src_test function. Runs emake check in build directory.
538 autotools-utils_src_test() {
539 debug-print-function ${FUNCNAME} "$@"
540
541 _check_build_dir
542 pushd "${BUILD_DIR}" > /dev/null || die
543 # Run default src_test as defined in ebuild.sh
544 default_src_test
545 popd > /dev/null || die
546 }

  ViewVC Help
Powered by ViewVC 1.1.20