/[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.21 Revision 1.27
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.21 2010/08/07 12:06:27 kolmodin Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/haskell-cabal.eclass,v 1.27 2012/02/07 12:47:54 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.
26# profile -- if package supports to build profiling-enabled libraries 26# profile -- if package supports to build profiling-enabled libraries
27# bootstrap -- only used for the cabal package itself 27# bootstrap -- only used for the cabal package itself
28# bin -- the package installs binaries 28# bin -- the package installs binaries
29# lib -- the package installs libraries 29# lib -- the package installs libraries
30# nocabaldep -- don't add dependency on cabal. 30# nocabaldep -- don't add dependency on cabal.
31# only used for packages that _must_ not pull the dependency 31# only used for packages that _must_ not pull the dependency
32# on cabal, but still use this eclass (e.g. haskell-updater). 32# on cabal, but still use this eclass (e.g. haskell-updater).
33# 33#
34# Dependencies on other cabal packages have to be specified 34# Dependencies on other cabal packages have to be specified
35# correctly. 35# correctly.
36# 36#
37# Cabal libraries should usually be SLOTted with "${PV}". 37# Cabal libraries should usually be SLOTted with "${PV}".
43# 43#
44# Special flags to Cabal Configure can now be set by using 44# Special flags to Cabal Configure can now be set by using
45# CABAL_CONFIGURE_FLAGS 45# CABAL_CONFIGURE_FLAGS
46 46
47inherit ghc-package multilib 47inherit 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:=}
48 68
49HASKELL_CABAL_EXPF="pkg_setup src_compile src_test src_install" 69HASKELL_CABAL_EXPF="pkg_setup src_compile src_test src_install"
50 70
51case "${EAPI:-0}" in 71case "${EAPI:-0}" in
52 2|3|4) HASKELL_CABAL_EXPF+=" src_configure" ;; 72 2|3|4) HASKELL_CABAL_EXPF+=" src_configure" ;;
57 77
58for feature in ${CABAL_FEATURES}; do 78for feature in ${CABAL_FEATURES}; do
59 case ${feature} in 79 case ${feature} in
60 haddock) CABAL_USE_HADDOCK=yes;; 80 haddock) CABAL_USE_HADDOCK=yes;;
61 hscolour) CABAL_USE_HSCOLOUR=yes;; 81 hscolour) CABAL_USE_HSCOLOUR=yes;;
82 hoogle) CABAL_USE_HOOGLE=yes;;
62 alex) CABAL_USE_ALEX=yes;; 83 alex) CABAL_USE_ALEX=yes;;
63 happy) CABAL_USE_HAPPY=yes;; 84 happy) CABAL_USE_HAPPY=yes;;
64 c2hs) CABAL_USE_C2HS=yes;; 85 c2hs) CABAL_USE_C2HS=yes;;
65 cpphs) CABAL_USE_CPPHS=yes;; 86 cpphs) CABAL_USE_CPPHS=yes;;
66 profile) CABAL_USE_PROFILE=yes;; 87 profile) CABAL_USE_PROFILE=yes;;
82 DEPEND="${DEPEND} hscolour? ( dev-haskell/hscolour )" 103 DEPEND="${DEPEND} hscolour? ( dev-haskell/hscolour )"
83fi 104fi
84 105
85if [[ -n "${CABAL_USE_ALEX}" ]]; then 106if [[ -n "${CABAL_USE_ALEX}" ]]; then
86 DEPEND="${DEPEND} dev-haskell/alex" 107 DEPEND="${DEPEND} dev-haskell/alex"
87 cabalconf="${cabalconf} --with-alex=/usr/bin/alex"
88fi 108fi
89 109
90if [[ -n "${CABAL_USE_HAPPY}" ]]; then 110if [[ -n "${CABAL_USE_HAPPY}" ]]; then
91 DEPEND="${DEPEND} dev-haskell/happy" 111 DEPEND="${DEPEND} dev-haskell/happy"
92 cabalconf="${cabalconf} --with-happy=/usr/bin/happy"
93fi 112fi
94 113
95if [[ -n "${CABAL_USE_C2HS}" ]]; then 114if [[ -n "${CABAL_USE_C2HS}" ]]; then
96 DEPEND="${DEPEND} dev-haskell/c2hs" 115 DEPEND="${DEPEND} dev-haskell/c2hs"
97 cabalconf="${cabalconf} --with-c2hs=/usr/bin/c2hs"
98fi 116fi
99 117
100if [[ -n "${CABAL_USE_CPPHS}" ]]; then 118if [[ -n "${CABAL_USE_CPPHS}" ]]; then
101 DEPEND="${DEPEND} dev-haskell/cpphs" 119 DEPEND="${DEPEND} dev-haskell/cpphs"
102 cabalconf="${cabalconf} --with-cpphs=/usr/bin/cpphs"
103fi 120fi
104 121
105if [[ -n "${CABAL_USE_PROFILE}" ]]; then 122if [[ -n "${CABAL_USE_PROFILE}" ]]; then
106 IUSE="${IUSE} profile" 123 IUSE="${IUSE} profile"
107fi 124fi
127 if [[ "${CABAL_BOOTSTRAP}" ]]; then 144 if [[ "${CABAL_BOOTSTRAP}" ]]; then
128 # We're bootstrapping cabal, so the cabal version is the version 145 # We're bootstrapping cabal, so the cabal version is the version
129 # of this package itself. 146 # of this package itself.
130 _CABAL_VERSION_CACHE="${PV}" 147 _CABAL_VERSION_CACHE="${PV}"
131 elif [[ "${CABAL_FROM_GHC}" ]]; then 148 elif [[ "${CABAL_FROM_GHC}" ]]; then
132 # We can't assume there's a version of Cabal installed by ebuild as 149 local cabal_package=$(echo "$(ghc-libdir)"/Cabal-*)
133 # this might be a first time install of GHC (for packages that 150 # /path/to/ghc/Cabal-${VER} -> ${VER}
134 # use the shipped Cabal like haskell-updater). 151 _CABAL_VERSION_CACHE="${cabal_package/*Cabal-/}"
135
136 # The user is likely to only have one version of Cabal, provided
137 # by GHC. Note that dev-haskell/cabal can be a dummy package, only
138 # using the version provided by GHC. If the user has another version
139 # of Cabal too (more recent than the one GHC provides through
140 # dev-haskell/cabal, or possibly older if he used an old
141 # Cabal package) the most recent is used (expected to be the last
142 # one in the ghc-pkg output).
143 _CABAL_VERSION_CACHE="$(ghc-pkg field Cabal version | tail -n 1)"
144
145 # Strip out the "version: " prefix
146 _CABAL_VERSION_CACHE="${_CABAL_VERSION_CACHE#"version: "}"
147 else 152 else
148 # We ask portage, not ghc, so that we only pick up 153 # We ask portage, not ghc, so that we only pick up
149 # portage-installed cabal versions. 154 # portage-installed cabal versions.
150 _CABAL_VERSION_CACHE="$(ghc-extractportageversion dev-haskell/cabal)" 155 _CABAL_VERSION_CACHE="$(ghc-extractportageversion dev-haskell/cabal)"
151 fi 156 fi
173 else 178 else
174 # older ghc's don't support package versioning 179 # older ghc's don't support package versioning
175 cabalpackage=Cabal 180 cabalpackage=Cabal
176 fi 181 fi
177 einfo "Using cabal-$(cabal-version)." 182 einfo "Using cabal-$(cabal-version)."
183
184 make_setup() {
178 $(ghc-getghc) -package "${cabalpackage}" --make "${setupmodule}" -o 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
179 || die "compiling ${setupmodule} failed" 197 make_setup "$@" || die "compiling ${setupmodule} failed"
198 fi
180} 199}
181 200
182cabal-mksetup() { 201cabal-mksetup() {
183 local setupdir 202 local setupdir
184 203
193 echo 'import Distribution.Simple; main = defaultMainWithHooks defaultUserHooks' \ 212 echo 'import Distribution.Simple; main = defaultMainWithHooks defaultUserHooks' \
194 > $setupdir/Setup.hs 213 > $setupdir/Setup.hs
195} 214}
196 215
197cabal-hscolour() { 216cabal-hscolour() {
198 ./setup hscolour || die "setup hscolour failed" 217 set -- hscolour "$@"
218 echo ./setup "$@"
219 ./setup "$@" || die "setup hscolour failed"
199} 220}
200 221
201cabal-haddock() { 222cabal-haddock() {
202 ./setup haddock || die "setup haddock failed" 223 set -- haddock "$@"
224 echo ./setup "$@"
225 ./setup "$@" || die "setup haddock failed"
203} 226}
204 227
205cabal-hscolour-haddock() { 228cabal-hscolour-haddock() {
206 # --hyperlink-source implies calling 'setup hscolour' 229 # --hyperlink-source implies calling 'setup hscolour'
230 set -- haddock --hyperlink-source
231 echo ./setup "$@"
207 ./setup haddock --hyperlink-source || die "setup haddock failed" 232 ./setup "$@" --hyperlink-source || die "setup haddock --hyperlink-source failed"
208} 233}
209 234
210cabal-configure() { 235cabal-configure() {
236 has "${EAPI:-0}" 0 1 2 && ! use prefix && EPREFIX=
237
211 if [[ -n "${CABAL_USE_HADDOCK}" ]] && use doc; then 238 if [[ -n "${CABAL_USE_HADDOCK}" ]] && use doc; then
212 cabalconf="${cabalconf} --with-haddock=/usr/bin/haddock" 239 cabalconf="${cabalconf} --with-haddock=${EPREFIX}/usr/bin/haddock"
213 fi 240 fi
214 if [[ -n "${CABAL_USE_PROFILE}" ]] && use profile; then 241 if [[ -n "${CABAL_USE_PROFILE}" ]] && use profile; then
215 cabalconf="${cabalconf} --enable-library-profiling" 242 cabalconf="${cabalconf} --enable-library-profiling"
216 fi 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
217 # Building GHCi libs on ppc64 causes "TOC overflow". 265 # Building GHCi libs on ppc64 causes "TOC overflow".
218 if use ppc64; then 266 if use ppc64; then
219 cabalconf="${cabalconf} --disable-library-for-ghci" 267 cabalconf="${cabalconf} --disable-library-for-ghci"
220 fi 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
221 274
222 if version_is_at_least "1.4" "$(cabal-version)"; then 275 if version_is_at_least "1.4" "$(cabal-version)"; then
223 # disable executable stripping for the executables, as portage will 276 # disable executable stripping for the executables, as portage will
224 # strip by itself, and pre-stripping gives a QA warning. 277 # strip by itself, and pre-stripping gives a QA warning.
225 # cabal versions previous to 1.4 does not strip executables, and does 278 # cabal versions previous to 1.4 does not strip executables, and does
228 # bug #251881, bug #251882, bug #251884, bug #251886, bug #299494 281 # bug #251881, bug #251882, bug #251884, bug #251886, bug #299494
229 cabalconf="${cabalconf} --disable-executable-stripping" 282 cabalconf="${cabalconf} --disable-executable-stripping"
230 fi 283 fi
231 284
232 if version_is_at_least "1.2.0" "$(cabal-version)"; then 285 if version_is_at_least "1.2.0" "$(cabal-version)"; then
233 cabalconf="${cabalconf} --docdir=/usr/share/doc/${PF}" 286 cabalconf="${cabalconf} --docdir=${EPREFIX}/usr/share/doc/${PF}"
234 # As of Cabal 1.2, configure is quite quiet. For diagnostic purposes 287 # As of Cabal 1.2, configure is quite quiet. For diagnostic purposes
235 # it's better if the configure chatter is in the build logs: 288 # it's better if the configure chatter is in the build logs:
236 cabalconf="${cabalconf} --verbose" 289 cabalconf="${cabalconf} --verbose"
237 fi 290 fi
238 # Note: with Cabal-1.1.6.x we do not have enough control 291 # Note: with Cabal-1.1.6.x we do not have enough control
239 # to put the docs into the right place. They're currently going 292 # to put the docs into the right place. They're currently going
240 # into /usr/share/${P}/ghc-x.y/doc/ 293 # into /usr/share/${P}/ghc-x.y/doc/
241 # rather than /usr/share/doc/${PF}/ 294 # rather than /usr/share/doc/${PF}/
242 # Because we can only set the datadir, not the docdir. 295 # Because we can only set the datadir, not the docdir.
243 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
244 ./setup configure \ 303 set -- configure \
245 --ghc --prefix=/usr \ 304 --ghc --prefix="${EPREFIX}"/usr \
246 --with-compiler="$(ghc-getghc)" \ 305 --with-compiler="$(ghc-getghc)" \
247 --with-hc-pkg="$(ghc-getghcpkg)" \ 306 --with-hc-pkg="$(ghc-getghcpkg)" \
248 --prefix=/usr \ 307 --prefix="${EPREFIX}"/usr \
249 --libdir=/usr/$(get_libdir) \ 308 --libdir="${EPREFIX}"/usr/$(get_libdir) \
250 --libsubdir=${P}/ghc-$(ghc-version) \ 309 --libsubdir=${P}/ghc-$(ghc-version) \
251 --datadir=/usr/share/ \ 310 --datadir="${EPREFIX}"/usr/share/ \
252 --datasubdir=${P}/ghc-$(ghc-version) \ 311 --datasubdir=${P}/ghc-$(ghc-version) \
253 ${cabalconf} \ 312 ${cabalconf} \
254 ${CABAL_CONFIGURE_FLAGS} \ 313 ${CABAL_CONFIGURE_FLAGS} \
314 ${CABAL_EXTRA_CONFIGURE_FLAGS} \
315 "$@"
316 echo ./setup "$@"
255 "$@" || die "setup configure failed" 317 ./setup "$@" || die "setup configure failed"
256} 318}
257 319
258cabal-build() { 320cabal-build() {
259 unset LANG LC_ALL LC_MESSAGES 321 unset LANG LC_ALL LC_MESSAGES
260 ./setup build \ 322 set -- build ${CABAL_EXTRA_BUILD_FLAGS} "$@"
323 echo ./setup "$@"
324 ./setup "$@" \
261 || die "setup build failed" 325 || die "setup build failed"
262} 326}
263 327
264cabal-copy() { 328cabal-copy() {
265 ./setup copy \ 329 has "${EAPI:-0}" 0 1 2 && ! use prefix && ED=${D}
266 --destdir="${D}" \ 330
331 set -- copy --destdir="${D}" "$@"
332 echo ./setup "$@"
267 || die "setup copy failed" 333 ./setup "$@" || die "setup copy failed"
268 334
269 # cabal is a bit eager about creating dirs, 335 # cabal is a bit eager about creating dirs,
270 # so remove them if they are empty 336 # so remove them if they are empty
271 rmdir "${D}/usr/bin" 2> /dev/null 337 rmdir "${ED}/usr/bin" 2> /dev/null
272 338
273 # GHC 6.4 has a bug in get/setPermission and Cabal 1.1.1 has 339 # GHC 6.4 has a bug in get/setPermission and Cabal 1.1.1 has
274 # no workaround. 340 # no workaround.
275 # set the +x permission on executables 341 # set the +x permission on executables
276 if [[ -d "${D}/usr/bin" ]] ; then 342 if [[ -d "${ED}/usr/bin" ]] ; then
277 chmod +x "${D}/usr/bin/"* 343 chmod +x "${ED}/usr/bin/"*
278 fi 344 fi
279 # TODO: do we still need this? 345 # TODO: do we still need this?
280} 346}
281 347
282cabal-pkg() { 348cabal-pkg() {
343 einfo "${P} is included in ghc-${CABAL_CORE_LIB_GHC_PV}, nothing to install." 409 einfo "${P} is included in ghc-${CABAL_CORE_LIB_GHC_PV}, nothing to install."
344 fi 410 fi
345} 411}
346 412
347haskell-cabal_src_configure() { 413haskell-cabal_src_configure() {
414 if ! cabal-is-dummy-lib; then
348 pushd "${S}" > /dev/null 415 pushd "${S}" > /dev/null
349 416
350 cabal-bootstrap 417 cabal-bootstrap
418
351 cabal-configure "$@" 419 cabal-configure "$@"
352 420
353 popd > /dev/null 421 popd > /dev/null
422 fi
354} 423}
355 424
356# exported function: nice alias 425# exported function: nice alias
357cabal_src_configure() { 426cabal_src_configure() {
358 haskell-cabal_src_configure "$@" 427 haskell-cabal_src_configure "$@"
359} 428}
360 429
361# exported function: cabal-style bootstrap configure and compile 430# exported function: cabal-style bootstrap configure and compile
362cabal_src_compile() { 431cabal_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
363 if ! cabal-is-dummy-lib; then 443 if ! cabal-is-dummy-lib; then
364 has src_configure ${HASKELL_CABAL_EXPF} || haskell-cabal_src_configure "$@" 444 has src_configure ${HASKELL_CABAL_EXPF} || haskell-cabal_src_configure "$@"
365 cabal-build 445 cabal-build
366 446
367 if [[ -n "${CABAL_USE_HADDOCK}" ]] && use doc; then 447 if [[ -n "${CABAL_USE_HADDOCK}" ]] && use doc; then
394 474
395 if cabal-is-dummy-lib; then 475 if cabal-is-dummy-lib; then
396 einfo ">>> No tests for dummy library: ${CATEGORY}/${PF}" 476 einfo ">>> No tests for dummy library: ${CATEGORY}/${PF}"
397 else 477 else
398 einfo ">>> Test phase [cabal test]: ${CATEGORY}/${PF}" 478 einfo ">>> Test phase [cabal test]: ${CATEGORY}/${PF}"
479 set -- test "$@"
480 echo ./setup "$@"
399 ./setup test || die "cabal test failed" 481 ./setup "$@" || die "cabal test failed"
400 fi 482 fi
401 483
402 popd > /dev/null 484 popd > /dev/null
403} 485}
404 486
405# exported function: cabal-style copy and register 487# exported function: cabal-style copy and register
406cabal_src_install() { 488cabal_src_install() {
489 has "${EAPI:-0}" 0 1 2 && ! use prefix && EPREFIX=
490
407 if cabal-is-dummy-lib; then 491 if cabal-is-dummy-lib; then
408 # create a dummy local package conf file for the sake of ghc-updater 492 # create a dummy local package conf file for the sake of ghc-updater
409 dodir "$(ghc-confdir)" 493 local ghc_confdir_with_prefix="$(ghc-confdir)"
494 # remove EPREFIX
495 dodir ${ghc_confdir_with_prefix#${EPREFIX}}
410 echo '[]' > "${D}/$(ghc-confdir)/$(ghc-localpkgconf)" 496 echo '[]' > "${D}/$(ghc-confdir)/$(ghc-localpkgconf)"
411 else 497 else
412 cabal-copy 498 cabal-copy
413 cabal-pkg 499 cabal-pkg
414 500

Legend:
Removed from v.1.21  
changed lines
  Added in v.1.27

  ViewVC Help
Powered by ViewVC 1.1.20