/[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.3 Revision 1.21
1# Copyright 1999-2005 Gentoo Foundation 1# Copyright 1999-2006 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.3 2006/02/16 12:32:53 dcoutts Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/haskell-cabal.eclass,v 1.21 2010/08/07 12:06:27 kolmodin Exp $
4# 4#
5# Original authors: Andres Loeh <kosmikus@gentoo.org> 5# Original authors: Andres Loeh <kosmikus@gentoo.org>
6# Duncan Coutts <dcoutts@gentoo.org> 6# Duncan Coutts <dcoutts@gentoo.org>
7# Maintained by: Haskell herd <haskell@gentoo.org> 7# Maintained by: Haskell herd <haskell@gentoo.org>
8# 8#
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
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).
29# 33#
30# Dependencies on other cabal packages have to be specified 34# Dependencies on other cabal packages have to be specified
31# correctly. 35# correctly.
32# 36#
33# Cabal libraries should usually be SLOTted with "${PV}". 37# Cabal libraries should usually be SLOTted with "${PV}".
34# 38#
35# Many Cabal packages require S to be manually set. 39# Many Cabal packages require S to be manually set.
36# 40#
37# Conforming Cabal packages don't require any function definitions 41# Conforming Cabal packages don't require any function definitions
38# in the ebuild. 42# in the ebuild.
43#
44# Special flags to Cabal Configure can now be set by using
45# CABAL_CONFIGURE_FLAGS
39 46
40inherit ghc-package 47inherit ghc-package multilib
41 48
49HASKELL_CABAL_EXPF="pkg_setup src_compile src_test src_install"
50
51case "${EAPI:-0}" in
52 2|3|4) HASKELL_CABAL_EXPF+=" src_configure" ;;
53 *) ;;
54esac
55
56EXPORT_FUNCTIONS ${HASKELL_CABAL_EXPF}
42 57
43for feature in ${CABAL_FEATURES}; do 58for feature in ${CABAL_FEATURES}; do
44 case ${feature} in 59 case ${feature} in
45 haddock) CABAL_USE_HADDOCK=yes;; 60 haddock) CABAL_USE_HADDOCK=yes;;
61 hscolour) CABAL_USE_HSCOLOUR=yes;;
46 alex) CABAL_USE_ALEX=yes;; 62 alex) CABAL_USE_ALEX=yes;;
47 happy) CABAL_USE_HAPPY=yes;; 63 happy) CABAL_USE_HAPPY=yes;;
48 c2hs) CABAL_USE_C2HS=yes;; 64 c2hs) CABAL_USE_C2HS=yes;;
49 cpphs) CABAL_USE_CPPHS=yes;; 65 cpphs) CABAL_USE_CPPHS=yes;;
50 profile) CABAL_USE_PROFILE=yes;; 66 profile) CABAL_USE_PROFILE=yes;;
51 bootstrap) CABAL_BOOTSTRAP=yes;; 67 bootstrap) CABAL_BOOTSTRAP=yes;;
52 bin) CABAL_HAS_BINARIES=yes;; 68 bin) CABAL_HAS_BINARIES=yes;;
53 lib) CABAL_HAS_LIBRARIES=yes;; 69 lib) CABAL_HAS_LIBRARIES=yes;;
70 nocabaldep) CABAL_FROM_GHC=yes;;
54 *) CABAL_UNKNOWN="${CABAL_UNKNOWN} ${feature}";; 71 *) CABAL_UNKNOWN="${CABAL_UNKNOWN} ${feature}";;
55 esac 72 esac
56done 73done
57 74
58if [[ -n "${CABAL_USE_HADDOCK}" ]]; then 75if [[ -n "${CABAL_USE_HADDOCK}" ]]; then
59 IUSE="${IUSE} doc" 76 IUSE="${IUSE} doc"
60 DEPEND="${DEPEND} doc? ( dev-haskell/haddock )" 77 DEPEND="${DEPEND} doc? ( dev-haskell/haddock )"
61 cabalconf="${cabalconf} --with-haddock=/usr/bin/haddock" 78fi
79
80if [[ -n "${CABAL_USE_HSCOLOUR}" ]]; then
81 IUSE="${IUSE} hscolour"
82 DEPEND="${DEPEND} hscolour? ( dev-haskell/hscolour )"
62fi 83fi
63 84
64if [[ -n "${CABAL_USE_ALEX}" ]]; then 85if [[ -n "${CABAL_USE_ALEX}" ]]; then
65 DEPEND="${DEPEND} dev-haskell/alex" 86 DEPEND="${DEPEND} dev-haskell/alex"
66 cabalconf="${cabalconf} --with-alex=/usr/bin/alex" 87 cabalconf="${cabalconf} --with-alex=/usr/bin/alex"
85 IUSE="${IUSE} profile" 106 IUSE="${IUSE} profile"
86fi 107fi
87 108
88# We always use a standalone version of Cabal, rather than the one that comes 109# We always use a standalone version of Cabal, rather than the one that comes
89# with GHC. But of course we can't depend on cabal when building cabal itself. 110# with GHC. But of course we can't depend on cabal when building cabal itself.
90if [[ -z "${CABAL_BOOTSTRAP}" ]]; then 111if [[ -z ${CABAL_MIN_VERSION} ]]; then
112 CABAL_MIN_VERSION=1.1.4
113fi
114if [[ -z "${CABAL_BOOTSTRAP}" && -z "${CABAL_FROM_GHC}" ]]; then
91 DEPEND="${DEPEND} >=dev-haskell/cabal-1.1.3" 115 DEPEND="${DEPEND} >=dev-haskell/cabal-${CABAL_MIN_VERSION}"
92fi 116fi
93 117
94# Libraries require GHC to be installed. 118# Libraries require GHC to be installed.
95if [[ -n "${CABAL_HAS_LIBRARIES}" ]]; then 119if [[ -n "${CABAL_HAS_LIBRARIES}" ]]; then
96 RDEPEND="${RDEPEND} virtual/ghc" 120 RDEPEND="${RDEPEND} dev-lang/ghc"
121fi
122
123# returns the version of cabal currently in use
124_CABAL_VERSION_CACHE=""
125cabal-version() {
126 if [[ -z "${_CABAL_VERSION_CACHE}" ]]; then
127 if [[ "${CABAL_BOOTSTRAP}" ]]; then
128 # We're bootstrapping cabal, so the cabal version is the version
129 # of this package itself.
130 _CABAL_VERSION_CACHE="${PV}"
131 elif [[ "${CABAL_FROM_GHC}" ]]; then
132 # We can't assume there's a version of Cabal installed by ebuild as
133 # this might be a first time install of GHC (for packages that
134 # use the shipped Cabal like haskell-updater).
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
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
97fi 152 fi
153 echo "${_CABAL_VERSION_CACHE}"
154}
98 155
99cabal-bootstrap() { 156cabal-bootstrap() {
100 local setupmodule 157 local setupmodule
101 local cabalversion 158 local cabalpackage
102 if [[ -f "${S}/Setup.lhs" ]]; then 159 if [[ -f "${S}/Setup.lhs" ]]; then
103 setupmodule="${S}/Setup.lhs" 160 setupmodule="${S}/Setup.lhs"
104 else 161 else
105 if [[ -f "${S}/Setup.hs" ]]; then 162 if [[ -f "${S}/Setup.hs" ]]; then
106 setupmodule="${S}/Setup.hs" 163 setupmodule="${S}/Setup.hs"
109 fi 166 fi
110 fi 167 fi
111 168
112 # We build the setup program using the latest version of 169 # We build the setup program using the latest version of
113 # cabal that we have installed 170 # cabal that we have installed
114 cabalversion=$(ghc-bestcabalversion) 171 if version_is_at_least "6.4" "$(ghc-version)"; then
172 cabalpackage=Cabal-$(cabal-version)
173 else
174 # older ghc's don't support package versioning
175 cabalpackage=Cabal
176 fi
115 einfo "Using ${cabalversion}." 177 einfo "Using cabal-$(cabal-version)."
116 $(ghc-getghc) -package "${cabalversion}" --make "${setupmodule}" -o setup \ 178 $(ghc-getghc) -package "${cabalpackage}" --make "${setupmodule}" -o setup \
117 || die "compiling ${setupmodule} failed" 179 || die "compiling ${setupmodule} failed"
180}
181
182cabal-mksetup() {
183 local setupdir
184
185 if [[ -n $1 ]]; then
186 setupdir=$1
187 else
188 setupdir=${S}
189 fi
190
191 rm -f "${setupdir}"/Setup.{lhs,hs}
192
193 echo 'import Distribution.Simple; main = defaultMainWithHooks defaultUserHooks' \
194 > $setupdir/Setup.hs
195}
196
197cabal-hscolour() {
198 ./setup hscolour || die "setup hscolour failed"
118} 199}
119 200
120cabal-haddock() { 201cabal-haddock() {
121 ./setup haddock || die "setup haddock failed" 202 ./setup haddock || die "setup haddock failed"
122} 203}
123 204
205cabal-hscolour-haddock() {
206 # --hyperlink-source implies calling 'setup hscolour'
207 ./setup haddock --hyperlink-source || die "setup haddock failed"
208}
209
124cabal-configure() { 210cabal-configure() {
211 if [[ -n "${CABAL_USE_HADDOCK}" ]] && use doc; then
212 cabalconf="${cabalconf} --with-haddock=/usr/bin/haddock"
213 fi
125 if [[ -n "${CABAL_USE_PROFILE}" ]] && use profile; then 214 if [[ -n "${CABAL_USE_PROFILE}" ]] && use profile; then
126 cabalconf="${cabalconf} --enable-executable-profiling";
127 cabalconf="${cabalconf} --enable-library-profiling" 215 cabalconf="${cabalconf} --enable-library-profiling"
128 fi 216 fi
217 # Building GHCi libs on ppc64 causes "TOC overflow".
218 if use ppc64; then
219 cabalconf="${cabalconf} --disable-library-for-ghci"
220 fi
221
222 if version_is_at_least "1.4" "$(cabal-version)"; then
223 # disable executable stripping for the executables, as portage will
224 # strip by itself, and pre-stripping gives a QA warning.
225 # cabal versions previous to 1.4 does not strip executables, and does
226 # not accept the flag.
227 # this fixes numerous bugs, amongst them;
228 # bug #251881, bug #251882, bug #251884, bug #251886, bug #299494
229 cabalconf="${cabalconf} --disable-executable-stripping"
230 fi
231
232 if version_is_at_least "1.2.0" "$(cabal-version)"; then
233 cabalconf="${cabalconf} --docdir=/usr/share/doc/${PF}"
234 # 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:
236 cabalconf="${cabalconf} --verbose"
237 fi
238 # 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
240 # into /usr/share/${P}/ghc-x.y/doc/
241 # rather than /usr/share/doc/${PF}/
242 # Because we can only set the datadir, not the docdir.
129 243
130 ./setup configure \ 244 ./setup configure \
131 --ghc --prefix=/usr \ 245 --ghc --prefix=/usr \
132 --with-compiler="$(ghc-getghc)" \ 246 --with-compiler="$(ghc-getghc)" \
133 --with-hc-pkg="$(ghc-getghcpkg)" \ 247 --with-hc-pkg="$(ghc-getghcpkg)" \
248 --prefix=/usr \
249 --libdir=/usr/$(get_libdir) \
250 --libsubdir=${P}/ghc-$(ghc-version) \
251 --datadir=/usr/share/ \
252 --datasubdir=${P}/ghc-$(ghc-version) \
134 ${cabalconf} \ 253 ${cabalconf} \
254 ${CABAL_CONFIGURE_FLAGS} \
135 "$@" || die "setup configure failed" 255 "$@" || die "setup configure failed"
136} 256}
137 257
138cabal-build() { 258cabal-build() {
259 unset LANG LC_ALL LC_MESSAGES
139 ./setup build \ 260 ./setup build \
140 || die "setup build failed" 261 || die "setup build failed"
141} 262}
142 263
143cabal-copy() { 264cabal-copy() {
144 ./setup copy \ 265 ./setup copy \
145 --copy-prefix="${D}/usr" \ 266 --destdir="${D}" \
146 || die "setup copy failed" 267 || die "setup copy failed"
147 268
148 # cabal is a bit eager about creating dirs, 269 # cabal is a bit eager about creating dirs,
149 # so remove them if they are empty 270 # so remove them if they are empty
150 rmdir "${D}/usr/bin" 2> /dev/null 271 rmdir "${D}/usr/bin" 2> /dev/null
153 # no workaround. 274 # no workaround.
154 # set the +x permission on executables 275 # set the +x permission on executables
155 if [[ -d "${D}/usr/bin" ]] ; then 276 if [[ -d "${D}/usr/bin" ]] ; then
156 chmod +x "${D}/usr/bin/"* 277 chmod +x "${D}/usr/bin/"*
157 fi 278 fi
279 # TODO: do we still need this?
158} 280}
159 281
160cabal-pkg() { 282cabal-pkg() {
161 # This does not actually register since we're using /usr/bin/true instead 283 # This does not actually register since we're using true instead
162 # of ghc-pkg. So it just leaves the .installed-pkg-config and we can 284 # of ghc-pkg. So it just leaves the .installed-pkg-config and we can
163 # register that ourselves (if it exists). 285 # register that ourselves (if it exists).
164 local result 286 local result
165 local err 287 local err
166 288
167 sed -i 's:ghc-pkg:/usr/bin/true:' .setup-config 289 if [[ -n ${CABAL_HAS_LIBRARIES} ]]; then
168 result="$(./setup register 2>&1)" 290 if version_is_at_least "1.2.0" "$(cabal-version)"; then
169 err="$?" 291 # Newer cabal can generate a package conf for us:
170 if ! echo ${result} | grep -q "no library to register"; then 292 ./setup register --gen-pkg-config="${T}/${P}.conf"
171 $(exit "${err}") || die "setup register failed" 293 ghc-setup-pkg "${T}/${P}.conf"
172 fi 294 ghc-install-pkg
295 else
296 # With older cabal we have to hack it by replacing its ghc-pkg
297 # with true and then just picking up the .installed-pkg-config
298 # file and registering that ourselves (if it exists).
299 sed -i "s|$(ghc-getghcpkg)|$(type -P true)|" .setup-config
300 ./setup register || die "setup register failed"
173 if [[ -f .installed-pkg-config ]]; then 301 if [[ -f .installed-pkg-config ]]; then
174 ghc-setup-pkg .installed-pkg-config 302 ghc-setup-pkg .installed-pkg-config
175 ghc-install-pkg 303 ghc-install-pkg
304 else
305 die "setup register has not generated a package configuration file"
306 fi
176 fi 307 fi
308 fi
309}
310
311# Some cabal libs are bundled along with some versions of ghc
312# eg filepath-1.0 comes with ghc-6.6.1
313# by putting CABAL_CORE_LIB_GHC_PV="6.6.1" in an ebuild we are declaring that
314# when building with this version of ghc, the ebuild is a dummy that is it will
315# install no files since the package is already included with ghc.
316# However portage still records the dependency and we can upgrade the package
317# to a later one that's not included with ghc.
318# You can also put a space separated list, eg CABAL_CORE_LIB_GHC_PV="6.6 6.6.1".
319cabal-is-dummy-lib() {
320 for version in ${CABAL_CORE_LIB_GHC_PV[*]}; do
321 [[ "$(ghc-version)" == "$version" ]] && return 0
322 done
323 return 1
177} 324}
178 325
179# exported function: check if cabal is correctly installed for 326# exported function: check if cabal is correctly installed for
180# the currently active ghc (we cannot guarantee this with portage) 327# the currently active ghc (we cannot guarantee this with portage)
181haskell-cabal_pkg_setup() { 328haskell-cabal_pkg_setup() {
182 if [[ -z "${CABAL_BOOTSTRAP}" ]] && ! ghc-sanecabal "1.1.3"; then 329 ghc-package_pkg_setup
330 if [[ -z "${CABAL_BOOTSTRAP}" && -z "${CABAL_FROM_GHC}" ]] && ! ghc-sanecabal "${CABAL_MIN_VERSION}"; then
183 eerror "The package dev-haskell/cabal is not correctly installed for" 331 eerror "The package dev-haskell/cabal is not correctly installed for"
184 eerror "the currently active version of ghc ($(ghc-version)). Please" 332 eerror "the currently active version of ghc ($(ghc-version)). Please"
185 eerror "run ghc-updater or re-emerge dev-haskell/cabal." 333 eerror "run ghc-updater or haskell-updater or re-build dev-haskell/cabal."
186 die "cabal is not correctly installed" 334 die "cabal is not correctly installed"
187 fi 335 fi
336 if [[ -z "${CABAL_HAS_BINARIES}" ]] && [[ -z "${CABAL_HAS_LIBRARIES}" ]]; then
337 eerror "QA: Neither bin nor lib are in CABAL_FEATURES."
338 fi
188 if [[ -n "${CABAL_UNKNOWN}" ]]; then 339 if [[ -n "${CABAL_UNKNOWN}" ]]; then
189 ewarn "Unknown entry in CABAL_FEATURES: ${CABAL_UNKNONW}" 340 ewarn "Unknown entry in CABAL_FEATURES: ${CABAL_UNKNOWN}"
190 fi 341 fi
342 if cabal-is-dummy-lib; then
343 einfo "${P} is included in ghc-${CABAL_CORE_LIB_GHC_PV}, nothing to install."
344 fi
345}
346
347haskell-cabal_src_configure() {
348 pushd "${S}" > /dev/null
349
350 cabal-bootstrap
351 cabal-configure "$@"
352
353 popd > /dev/null
354}
355
356# exported function: nice alias
357cabal_src_configure() {
358 haskell-cabal_src_configure "$@"
191} 359}
192 360
193# exported function: cabal-style bootstrap configure and compile 361# exported function: cabal-style bootstrap configure and compile
194cabal_src_compile() { 362cabal_src_compile() {
195 cabal-bootstrap 363 if ! cabal-is-dummy-lib; then
196 cabal-configure 364 has src_configure ${HASKELL_CABAL_EXPF} || haskell-cabal_src_configure "$@"
197 cabal-build 365 cabal-build
198 366
199 if [[ -n "${CABAL_USE_HADDOCK}" ]] && use doc; then 367 if [[ -n "${CABAL_USE_HADDOCK}" ]] && use doc; then
368 if [[ -n "${CABAL_USE_HSCOLOUR}" ]] && use hscolour; then
369 # hscolour and haddock
370 cabal-hscolour-haddock
371 else
372 # just haddock
200 cabal-haddock 373 cabal-haddock
374 fi
375 else
376 if [[ -n "${CABAL_USE_HSCOLOUR}" ]] && use hscolour; then
377 # just hscolour
378 cabal-hscolour
379 fi
201 fi 380 fi
381 fi
202} 382}
383
203haskell-cabal_src_compile() { 384haskell-cabal_src_compile() {
385 pushd "${S}" > /dev/null
386
204 cabal_src_compile 387 cabal_src_compile "$@"
388
389 popd > /dev/null
390}
391
392haskell-cabal_src_test() {
393 pushd "${S}" > /dev/null
394
395 if cabal-is-dummy-lib; then
396 einfo ">>> No tests for dummy library: ${CATEGORY}/${PF}"
397 else
398 einfo ">>> Test phase [cabal test]: ${CATEGORY}/${PF}"
399 ./setup test || die "cabal test failed"
400 fi
401
402 popd > /dev/null
205} 403}
206 404
207# exported function: cabal-style copy and register 405# exported function: cabal-style copy and register
208cabal_src_install() { 406cabal_src_install() {
407 if cabal-is-dummy-lib; then
408 # create a dummy local package conf file for the sake of ghc-updater
409 dodir "$(ghc-confdir)"
410 echo '[]' > "${D}/$(ghc-confdir)/$(ghc-localpkgconf)"
411 else
209 cabal-copy 412 cabal-copy
210 cabal-pkg 413 cabal-pkg
211 414
212 if [[ -n "${CABAL_USE_HADDOCK}" ]] && use doc; then 415 if [[ -n "${CABAL_USE_HADDOCK}" ]] && use doc; then
416 if ! version_is_at_least "1.1.6" "$(cabal-version)"; then
213 dohtml dist/doc/html/* 417 dohtml -r dist/doc/html/*
418 fi
214 fi 419 fi
420 fi
215} 421}
422
216haskell-cabal_src_install() { 423haskell-cabal_src_install() {
424 pushd "${S}" > /dev/null
425
217 cabal_src_install 426 cabal_src_install
218}
219 427
220EXPORT_FUNCTIONS pkg_setup src_compile src_install 428 popd > /dev/null
429}
430
431# ebuild.sh:use_enable() taken as base
432#
433# Usage examples:
434#
435# CABAL_CONFIGURE_FLAGS=$(cabal_flag gui)
436# leads to "--flags=gui" or "--flags=-gui" (useflag 'gui')
437#
438# CABAL_CONFIGURE_FLAGS=$(cabal_flag gtk gui)
439# also leads to "--flags=gui" or " --flags=-gui" (useflag 'gtk')
440#
441cabal_flag() {
442 if [[ -z "$1" ]]; then
443 echo "!!! cabal_flag() called without a parameter." >&2
444 echo "!!! cabal_flag() <USEFLAG> [<cabal_flagname>]" >&2
445 return 1
446 fi
447
448 local UWORD=${2:-$1}
449
450 if use "$1"; then
451 echo "--flags=${UWORD}"
452 else
453 echo "--flags=-${UWORD}"
454 fi
455
456 return 0
457}

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

  ViewVC Help
Powered by ViewVC 1.1.20