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

Diff of /eclass/haskell-cabal.eclass

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

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

Legend:
Removed from v.1.16  
changed lines
  Added in v.1.26

  ViewVC Help
Powered by ViewVC 1.1.20