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

Contents of /eclass/haskell-cabal.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.25 - (show annotations) (download)
Mon Aug 22 04:46:32 2011 UTC (3 years, 4 months ago) by vapier
Branch: MAIN
Changes since 1.24: +10 -10 lines
fix random bugs in eclass documentation, and convert to new @AUTHOR tag

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

  ViewVC Help
Powered by ViewVC 1.1.20