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

Contents of /eclass/autotools-utils.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.51 - (show annotations) (download)
Mon May 28 07:34:43 2012 UTC (2 years, 1 month ago) by mgorny
Branch: MAIN
Changes since 1.50: +2 -5 lines
autotools.eclass no longer supports re-inheriting so we need to override AUTOTOOLS_AUTO_DEPEND for good...

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

  ViewVC Help
Powered by ViewVC 1.1.20