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

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

  ViewVC Help
Powered by ViewVC 1.1.20