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

Contents of /eclass/haskell-cabal.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.27 - (show annotations) (download)
Tue Feb 7 12:47:54 2012 UTC (2 years, 10 months ago) by slyfox
Branch: MAIN
Changes since 1.26: +16 -4 lines
Added support for CABAL_EXTRA_BUILD_FLAGS and HCFLAGS magic variables

CABAL_EXTRA_BUILD_FLAGS allows user to pass arguments to ./setup build phase.
For example you can get detailed build log this way:

    CABAL_EXTRA_BUILD_FLAGS=-v emerge something

HCFLAGS is similar to CFLAGS / CXXFLAGS / FFLAGS in spirit.
You can use it in make.conf or in one-shot merges to enable
random ghc features:

    HCFLAGS="-O0 -Wall" emerge something-else

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

  ViewVC Help
Powered by ViewVC 1.1.20