/[gentoo-x86]/eclass/haskell-cabal.eclass
Gentoo

Contents of /eclass/haskell-cabal.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.28 - (show annotations) (download)
Fri Mar 9 22:01:11 2012 UTC (2 years, 1 month ago) by slyfox
Branch: MAIN
Changes since 1.27: +4 -2 lines
Drop haddock from DEPENDS when USE=doc haddock. haddock-2.9.2+ can be used right in the ebuild phase to build it's docs.

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/haskell-cabal.eclass,v 1.27 2012/02/07 12:47:54 slyfox Exp $
4
5 # @ECLASS: haskell-cabal.eclass
6 # @MAINTAINER:
7 # Haskell herd <haskell@gentoo.org>
8 # @AUTHOR:
9 # Original author: Andres Loeh <kosmikus@gentoo.org>
10 # Original author: Duncan Coutts <dcoutts@gentoo.org>
11 # @BLURB: for packages that make use of the Haskell Common Architecture for Building Applications and Libraries (cabal)
12 # @DESCRIPTION:
13 # Basic instructions:
14 #
15 # Before inheriting the eclass, set CABAL_FEATURES to
16 # reflect the tools and features that the package makes
17 # use of.
18 #
19 # Currently supported features:
20 # haddock -- for documentation generation
21 # hscolour -- generation of colourised sources
22 # alex -- lexer/scanner generator
23 # happy -- parser generator
24 # c2hs -- C interface generator
25 # cpphs -- C preprocessor clone written in Haskell
26 # profile -- if package supports to build profiling-enabled libraries
27 # bootstrap -- only used for the cabal package itself
28 # bin -- the package installs binaries
29 # lib -- the package installs libraries
30 # nocabaldep -- don't add dependency on cabal.
31 # only used for packages that _must_ not pull the dependency
32 # on cabal, but still use this eclass (e.g. haskell-updater).
33 #
34 # Dependencies on other cabal packages have to be specified
35 # correctly.
36 #
37 # Cabal libraries should usually be SLOTted with "${PV}".
38 #
39 # Many Cabal packages require S to be manually set.
40 #
41 # Conforming Cabal packages don't require any function definitions
42 # in the ebuild.
43 #
44 # Special flags to Cabal Configure can now be set by using
45 # CABAL_CONFIGURE_FLAGS
46
47 inherit ghc-package multilib
48
49 # @ECLASS-VARIABLE: CABAL_EXTRA_CONFIGURE_FLAGS
50 # @DESCRIPTION:
51 # User-specified additional parameters passed to 'setup configure'.
52 # example: /etc/make.conf: CABAL_EXTRA_CONFIGURE_FLAGS=--enable-shared
53 : ${CABAL_EXTRA_CONFIGURE_FLAGS:=}
54
55 # @ECLASS-VARIABLE: CABAL_EXTRA_BUILD_FLAGS
56 # @DESCRIPTION:
57 # User-specified additional parameters passed to 'setup build'.
58 # example: /etc/make.conf: CABAL_EXTRA_BUILD_FLAGS=-v
59 : ${CABAL_EXTRA_BUILD_FLAGS:=}
60
61 # @ECLASS-VARIABLE: GHC_BOOTSTRAP_FLAGS
62 # @DESCRIPTION:
63 # User-specified additional parameters for ghc when building
64 # _only_ 'setup' binary bootstrap.
65 # example: /etc/make.conf: GHC_BOOTSTRAP_FLAGS=-dynamic to make
66 # linking 'setup' faster.
67 : ${GHC_BOOTSTRAP_FLAGS:=}
68
69 HASKELL_CABAL_EXPF="pkg_setup src_compile src_test src_install"
70
71 case "${EAPI:-0}" in
72 2|3|4) HASKELL_CABAL_EXPF+=" src_configure" ;;
73 *) ;;
74 esac
75
76 EXPORT_FUNCTIONS ${HASKELL_CABAL_EXPF}
77
78 for feature in ${CABAL_FEATURES}; do
79 case ${feature} in
80 haddock) CABAL_USE_HADDOCK=yes;;
81 hscolour) CABAL_USE_HSCOLOUR=yes;;
82 hoogle) CABAL_USE_HOOGLE=yes;;
83 alex) CABAL_USE_ALEX=yes;;
84 happy) CABAL_USE_HAPPY=yes;;
85 c2hs) CABAL_USE_C2HS=yes;;
86 cpphs) CABAL_USE_CPPHS=yes;;
87 profile) CABAL_USE_PROFILE=yes;;
88 bootstrap) CABAL_BOOTSTRAP=yes;;
89 bin) CABAL_HAS_BINARIES=yes;;
90 lib) CABAL_HAS_LIBRARIES=yes;;
91 nocabaldep) CABAL_FROM_GHC=yes;;
92 *) CABAL_UNKNOWN="${CABAL_UNKNOWN} ${feature}";;
93 esac
94 done
95
96 if [[ -n "${CABAL_USE_HADDOCK}" ]]; then
97 IUSE="${IUSE} doc"
98 # don't require depend on itself to build docs.
99 # ebuild bootstraps docs from just built binary
100 [[ ${CATEGORY}/${PN} = "dev-haskell/haddock" ]] || DEPEND="${DEPEND} doc? ( dev-haskell/haddock )"
101 fi
102
103 if [[ -n "${CABAL_USE_HSCOLOUR}" ]]; then
104 IUSE="${IUSE} hscolour"
105 DEPEND="${DEPEND} hscolour? ( dev-haskell/hscolour )"
106 fi
107
108 if [[ -n "${CABAL_USE_ALEX}" ]]; then
109 DEPEND="${DEPEND} dev-haskell/alex"
110 fi
111
112 if [[ -n "${CABAL_USE_HAPPY}" ]]; then
113 DEPEND="${DEPEND} dev-haskell/happy"
114 fi
115
116 if [[ -n "${CABAL_USE_C2HS}" ]]; then
117 DEPEND="${DEPEND} dev-haskell/c2hs"
118 fi
119
120 if [[ -n "${CABAL_USE_CPPHS}" ]]; then
121 DEPEND="${DEPEND} dev-haskell/cpphs"
122 fi
123
124 if [[ -n "${CABAL_USE_PROFILE}" ]]; then
125 IUSE="${IUSE} profile"
126 fi
127
128 # We always use a standalone version of Cabal, rather than the one that comes
129 # with GHC. But of course we can't depend on cabal when building cabal itself.
130 if [[ -z ${CABAL_MIN_VERSION} ]]; then
131 CABAL_MIN_VERSION=1.1.4
132 fi
133 if [[ -z "${CABAL_BOOTSTRAP}" && -z "${CABAL_FROM_GHC}" ]]; then
134 DEPEND="${DEPEND} >=dev-haskell/cabal-${CABAL_MIN_VERSION}"
135 fi
136
137 # Libraries require GHC to be installed.
138 if [[ -n "${CABAL_HAS_LIBRARIES}" ]]; then
139 RDEPEND="${RDEPEND} dev-lang/ghc"
140 fi
141
142 # returns the version of cabal currently in use
143 _CABAL_VERSION_CACHE=""
144 cabal-version() {
145 if [[ -z "${_CABAL_VERSION_CACHE}" ]]; then
146 if [[ "${CABAL_BOOTSTRAP}" ]]; then
147 # We're bootstrapping cabal, so the cabal version is the version
148 # of this package itself.
149 _CABAL_VERSION_CACHE="${PV}"
150 elif [[ "${CABAL_FROM_GHC}" ]]; then
151 local cabal_package=$(echo "$(ghc-libdir)"/Cabal-*)
152 # /path/to/ghc/Cabal-${VER} -> ${VER}
153 _CABAL_VERSION_CACHE="${cabal_package/*Cabal-/}"
154 else
155 # We ask portage, not ghc, so that we only pick up
156 # portage-installed cabal versions.
157 _CABAL_VERSION_CACHE="$(ghc-extractportageversion dev-haskell/cabal)"
158 fi
159 fi
160 echo "${_CABAL_VERSION_CACHE}"
161 }
162
163 cabal-bootstrap() {
164 local setupmodule
165 local cabalpackage
166 if [[ -f "${S}/Setup.lhs" ]]; then
167 setupmodule="${S}/Setup.lhs"
168 else
169 if [[ -f "${S}/Setup.hs" ]]; then
170 setupmodule="${S}/Setup.hs"
171 else
172 die "No Setup.lhs or Setup.hs found"
173 fi
174 fi
175
176 # We build the setup program using the latest version of
177 # cabal that we have installed
178 if version_is_at_least "6.4" "$(ghc-version)"; then
179 cabalpackage=Cabal-$(cabal-version)
180 else
181 # older ghc's don't support package versioning
182 cabalpackage=Cabal
183 fi
184 einfo "Using cabal-$(cabal-version)."
185
186 make_setup() {
187 set -- -package "${cabalpackage}" --make "${setupmodule}" \
188 ${GHC_BOOTSTRAP_FLAGS} \
189 "$@" \
190 -o setup
191 echo $(ghc-getghc) ${HCFLAGS} "$@"
192 $(ghc-getghc) "$@"
193 }
194 if $(ghc-supports-shared-libraries); then
195 # some custom build systems might use external libraries,
196 # for which we don't have shared libs, so keep static fallback
197 make_setup -dynamic "$@" || make_setup "$@" || die "compiling ${setupmodule} failed"
198 else
199 make_setup "$@" || die "compiling ${setupmodule} failed"
200 fi
201 }
202
203 cabal-mksetup() {
204 local setupdir
205
206 if [[ -n $1 ]]; then
207 setupdir=$1
208 else
209 setupdir=${S}
210 fi
211
212 rm -f "${setupdir}"/Setup.{lhs,hs}
213
214 echo 'import Distribution.Simple; main = defaultMainWithHooks defaultUserHooks' \
215 > $setupdir/Setup.hs
216 }
217
218 cabal-hscolour() {
219 set -- hscolour "$@"
220 echo ./setup "$@"
221 ./setup "$@" || die "setup hscolour failed"
222 }
223
224 cabal-haddock() {
225 set -- haddock "$@"
226 echo ./setup "$@"
227 ./setup "$@" || die "setup haddock failed"
228 }
229
230 cabal-hscolour-haddock() {
231 # --hyperlink-source implies calling 'setup hscolour'
232 set -- haddock --hyperlink-source
233 echo ./setup "$@"
234 ./setup "$@" --hyperlink-source || die "setup haddock --hyperlink-source failed"
235 }
236
237 cabal-configure() {
238 has "${EAPI:-0}" 0 1 2 && ! use prefix && EPREFIX=
239
240 if [[ -n "${CABAL_USE_HADDOCK}" ]] && use doc; then
241 cabalconf="${cabalconf} --with-haddock=${EPREFIX}/usr/bin/haddock"
242 fi
243 if [[ -n "${CABAL_USE_PROFILE}" ]] && use profile; then
244 cabalconf="${cabalconf} --enable-library-profiling"
245 fi
246 if [[ -n "${CABAL_USE_ALEX}" ]]; then
247 cabalconf="${cabalconf} --with-alex=${EPREFIX}/usr/bin/alex"
248 fi
249
250 if [[ -n "${CABAL_USE_HAPPY}" ]]; then
251 cabalconf="${cabalconf} --with-happy=${EPREFIX}/usr/bin/happy"
252 fi
253
254 if [[ -n "${CABAL_USE_C2HS}" ]]; then
255 cabalconf="${cabalconf} --with-c2hs=${EPREFIX}/usr/bin/c2hs"
256 fi
257 if [[ -n "${CABAL_USE_CPPHS}" ]]; then
258 cabalconf="${cabalconf} --with-cpphs=${EPREFIX}/usr/bin/cpphs"
259 fi
260
261 local option
262 for option in ${HCFLAGS}
263 do
264 cabalconf+=" --ghc-option=$option"
265 done
266
267 # Building GHCi libs on ppc64 causes "TOC overflow".
268 if use ppc64; then
269 cabalconf="${cabalconf} --disable-library-for-ghci"
270 fi
271
272 # currently cabal does not respect CFLAGS and LDFLAGS on it's own (bug #333217)
273 # so translate LDFLAGS to ghc parameters (without filtering)
274 local flag
275 for flag in $LDFLAGS; do cabalconf="${cabalconf} --ghc-option=-optl$flag"; done
276
277 if version_is_at_least "1.4" "$(cabal-version)"; then
278 # disable executable stripping for the executables, as portage will
279 # strip by itself, and pre-stripping gives a QA warning.
280 # cabal versions previous to 1.4 does not strip executables, and does
281 # not accept the flag.
282 # this fixes numerous bugs, amongst them;
283 # bug #251881, bug #251882, bug #251884, bug #251886, bug #299494
284 cabalconf="${cabalconf} --disable-executable-stripping"
285 fi
286
287 if version_is_at_least "1.2.0" "$(cabal-version)"; then
288 cabalconf="${cabalconf} --docdir=${EPREFIX}/usr/share/doc/${PF}"
289 # As of Cabal 1.2, configure is quite quiet. For diagnostic purposes
290 # it's better if the configure chatter is in the build logs:
291 cabalconf="${cabalconf} --verbose"
292 fi
293 # Note: with Cabal-1.1.6.x we do not have enough control
294 # to put the docs into the right place. They're currently going
295 # into /usr/share/${P}/ghc-x.y/doc/
296 # rather than /usr/share/doc/${PF}/
297 # Because we can only set the datadir, not the docdir.
298
299 # We build shared version of our Cabal where ghc ships it's shared
300 # version of it. We will link ./setup as dynamic binary againt Cabal later.
301 [[ ${CATEGORY}/${PN} == "dev-haskell/cabal" ]] && \
302 $(ghc-supports-shared-libraries) && \
303 cabalconf="${cabalconf} --enable-shared"
304
305 set -- configure \
306 --ghc --prefix="${EPREFIX}"/usr \
307 --with-compiler="$(ghc-getghc)" \
308 --with-hc-pkg="$(ghc-getghcpkg)" \
309 --prefix="${EPREFIX}"/usr \
310 --libdir="${EPREFIX}"/usr/$(get_libdir) \
311 --libsubdir=${P}/ghc-$(ghc-version) \
312 --datadir="${EPREFIX}"/usr/share/ \
313 --datasubdir=${P}/ghc-$(ghc-version) \
314 ${cabalconf} \
315 ${CABAL_CONFIGURE_FLAGS} \
316 ${CABAL_EXTRA_CONFIGURE_FLAGS} \
317 "$@"
318 echo ./setup "$@"
319 ./setup "$@" || die "setup configure failed"
320 }
321
322 cabal-build() {
323 unset LANG LC_ALL LC_MESSAGES
324 set -- build ${CABAL_EXTRA_BUILD_FLAGS} "$@"
325 echo ./setup "$@"
326 ./setup "$@" \
327 || die "setup build failed"
328 }
329
330 cabal-copy() {
331 has "${EAPI:-0}" 0 1 2 && ! use prefix && ED=${D}
332
333 set -- copy --destdir="${D}" "$@"
334 echo ./setup "$@"
335 ./setup "$@" || die "setup copy failed"
336
337 # cabal is a bit eager about creating dirs,
338 # so remove them if they are empty
339 rmdir "${ED}/usr/bin" 2> /dev/null
340
341 # GHC 6.4 has a bug in get/setPermission and Cabal 1.1.1 has
342 # no workaround.
343 # set the +x permission on executables
344 if [[ -d "${ED}/usr/bin" ]] ; then
345 chmod +x "${ED}/usr/bin/"*
346 fi
347 # TODO: do we still need this?
348 }
349
350 cabal-pkg() {
351 # This does not actually register since we're using true instead
352 # of ghc-pkg. So it just leaves the .installed-pkg-config and we can
353 # register that ourselves (if it exists).
354 local result
355 local err
356
357 if [[ -n ${CABAL_HAS_LIBRARIES} ]]; then
358 if version_is_at_least "1.2.0" "$(cabal-version)"; then
359 # Newer cabal can generate a package conf for us:
360 ./setup register --gen-pkg-config="${T}/${P}.conf"
361 ghc-setup-pkg "${T}/${P}.conf"
362 ghc-install-pkg
363 else
364 # With older cabal we have to hack it by replacing its ghc-pkg
365 # with true and then just picking up the .installed-pkg-config
366 # file and registering that ourselves (if it exists).
367 sed -i "s|$(ghc-getghcpkg)|$(type -P true)|" .setup-config
368 ./setup register || die "setup register failed"
369 if [[ -f .installed-pkg-config ]]; then
370 ghc-setup-pkg .installed-pkg-config
371 ghc-install-pkg
372 else
373 die "setup register has not generated a package configuration file"
374 fi
375 fi
376 fi
377 }
378
379 # Some cabal libs are bundled along with some versions of ghc
380 # eg filepath-1.0 comes with ghc-6.6.1
381 # by putting CABAL_CORE_LIB_GHC_PV="6.6.1" in an ebuild we are declaring that
382 # when building with this version of ghc, the ebuild is a dummy that is it will
383 # install no files since the package is already included with ghc.
384 # However portage still records the dependency and we can upgrade the package
385 # to a later one that's not included with ghc.
386 # You can also put a space separated list, eg CABAL_CORE_LIB_GHC_PV="6.6 6.6.1".
387 cabal-is-dummy-lib() {
388 for version in ${CABAL_CORE_LIB_GHC_PV[*]}; do
389 [[ "$(ghc-version)" == "$version" ]] && return 0
390 done
391 return 1
392 }
393
394 # exported function: check if cabal is correctly installed for
395 # the currently active ghc (we cannot guarantee this with portage)
396 haskell-cabal_pkg_setup() {
397 ghc-package_pkg_setup
398 if [[ -z "${CABAL_BOOTSTRAP}" && -z "${CABAL_FROM_GHC}" ]] && ! ghc-sanecabal "${CABAL_MIN_VERSION}"; then
399 eerror "The package dev-haskell/cabal is not correctly installed for"
400 eerror "the currently active version of ghc ($(ghc-version)). Please"
401 eerror "run ghc-updater or haskell-updater or re-build dev-haskell/cabal."
402 die "cabal is not correctly installed"
403 fi
404 if [[ -z "${CABAL_HAS_BINARIES}" ]] && [[ -z "${CABAL_HAS_LIBRARIES}" ]]; then
405 eerror "QA: Neither bin nor lib are in CABAL_FEATURES."
406 fi
407 if [[ -n "${CABAL_UNKNOWN}" ]]; then
408 ewarn "Unknown entry in CABAL_FEATURES: ${CABAL_UNKNOWN}"
409 fi
410 if cabal-is-dummy-lib; then
411 einfo "${P} is included in ghc-${CABAL_CORE_LIB_GHC_PV}, nothing to install."
412 fi
413 }
414
415 haskell-cabal_src_configure() {
416 if ! cabal-is-dummy-lib; then
417 pushd "${S}" > /dev/null
418
419 cabal-bootstrap
420
421 cabal-configure "$@"
422
423 popd > /dev/null
424 fi
425 }
426
427 # exported function: nice alias
428 cabal_src_configure() {
429 haskell-cabal_src_configure "$@"
430 }
431
432 # exported function: cabal-style bootstrap configure and compile
433 cabal_src_compile() {
434 # it's a common mistake when one bumps ebuild to EAPI="2" (and upper)
435 # and forgets to separate src_compile() to src_configure()/src_compile().
436 # Such error leads to default src_configure and we lose all passed flags.
437 if ! has "${EAPI:-0}" 0 1; then
438 local passed_flag
439 for passed_flag in "$@"; do
440 [[ ${passed_flag} == --flags=* ]] && \
441 eqawarn "Cabal option '${passed_flag}' has effect only in src_configure()"
442 done
443 fi
444
445 if ! cabal-is-dummy-lib; then
446 has src_configure ${HASKELL_CABAL_EXPF} || haskell-cabal_src_configure "$@"
447 cabal-build
448
449 if [[ -n "${CABAL_USE_HADDOCK}" ]] && use doc; then
450 if [[ -n "${CABAL_USE_HSCOLOUR}" ]] && use hscolour; then
451 # hscolour and haddock
452 cabal-hscolour-haddock
453 else
454 # just haddock
455 cabal-haddock
456 fi
457 else
458 if [[ -n "${CABAL_USE_HSCOLOUR}" ]] && use hscolour; then
459 # just hscolour
460 cabal-hscolour
461 fi
462 fi
463 fi
464 }
465
466 haskell-cabal_src_compile() {
467 pushd "${S}" > /dev/null
468
469 cabal_src_compile "$@"
470
471 popd > /dev/null
472 }
473
474 haskell-cabal_src_test() {
475 pushd "${S}" > /dev/null
476
477 if cabal-is-dummy-lib; then
478 einfo ">>> No tests for dummy library: ${CATEGORY}/${PF}"
479 else
480 einfo ">>> Test phase [cabal test]: ${CATEGORY}/${PF}"
481 set -- test "$@"
482 echo ./setup "$@"
483 ./setup "$@" || die "cabal test failed"
484 fi
485
486 popd > /dev/null
487 }
488
489 # exported function: cabal-style copy and register
490 cabal_src_install() {
491 has "${EAPI:-0}" 0 1 2 && ! use prefix && EPREFIX=
492
493 if cabal-is-dummy-lib; then
494 # create a dummy local package conf file for the sake of ghc-updater
495 local ghc_confdir_with_prefix="$(ghc-confdir)"
496 # remove EPREFIX
497 dodir ${ghc_confdir_with_prefix#${EPREFIX}}
498 echo '[]' > "${D}/$(ghc-confdir)/$(ghc-localpkgconf)"
499 else
500 cabal-copy
501 cabal-pkg
502
503 if [[ -n "${CABAL_USE_HADDOCK}" ]] && use doc; then
504 if ! version_is_at_least "1.1.6" "$(cabal-version)"; then
505 dohtml -r dist/doc/html/*
506 fi
507 fi
508 fi
509 }
510
511 haskell-cabal_src_install() {
512 pushd "${S}" > /dev/null
513
514 cabal_src_install
515
516 popd > /dev/null
517 }
518
519 # ebuild.sh:use_enable() taken as base
520 #
521 # Usage examples:
522 #
523 # CABAL_CONFIGURE_FLAGS=$(cabal_flag gui)
524 # leads to "--flags=gui" or "--flags=-gui" (useflag 'gui')
525 #
526 # CABAL_CONFIGURE_FLAGS=$(cabal_flag gtk gui)
527 # also leads to "--flags=gui" or " --flags=-gui" (useflag 'gtk')
528 #
529 cabal_flag() {
530 if [[ -z "$1" ]]; then
531 echo "!!! cabal_flag() called without a parameter." >&2
532 echo "!!! cabal_flag() <USEFLAG> [<cabal_flagname>]" >&2
533 return 1
534 fi
535
536 local UWORD=${2:-$1}
537
538 if use "$1"; then
539 echo "--flags=${UWORD}"
540 else
541 echo "--flags=-${UWORD}"
542 fi
543
544 return 0
545 }

  ViewVC Help
Powered by ViewVC 1.1.20