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

Contents of /eclass/haskell-cabal.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.33 - (show annotations) (download)
Sun Jul 8 19:16:46 2012 UTC (2 years, 4 months ago) by slyfox
Branch: MAIN
Changes since 1.32: +21 -2 lines
Allow wildcards in CABAL_CORE_LIB_GHC_PV. Guard against breakage of ghc-shipped libraries.

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

  ViewVC Help
Powered by ViewVC 1.1.20