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

Contents of /eclass/haskell-cabal.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.31 - (show annotations) (download)
Sat Apr 14 20:22:23 2012 UTC (2 years ago) by slyfox
Branch: MAIN
Changes since 1.30: +8 -7 lines
move 'dev-haskell/cabal' santy check out from 'pkg_*' to 'src_*' function to allow binary installation. Reported by tamiko.

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

  ViewVC Help
Powered by ViewVC 1.1.20