| 1 |
# Copyright 1999-2006 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.18 2010/01/26 20:50:40 kolmodin Exp $ |
| 4 |
# |
| 5 |
# Original authors: Andres Loeh <kosmikus@gentoo.org> |
| 6 |
# Duncan Coutts <dcoutts@gentoo.org> |
| 7 |
# Maintained by: Haskell herd <haskell@gentoo.org> |
| 8 |
# |
| 9 |
# This eclass is for packages that make use of the |
| 10 |
# Haskell Common Architecture for Building Applications |
| 11 |
# and Libraries (cabal). |
| 12 |
# |
| 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 |
# alex -- lexer/scanner generator |
| 22 |
# happy -- parser generator |
| 23 |
# c2hs -- C interface generator |
| 24 |
# cpphs -- C preprocessor clone written in Haskell |
| 25 |
# profile -- if package supports to build profiling-enabled libraries |
| 26 |
# bootstrap -- only used for the cabal package itself |
| 27 |
# bin -- the package installs binaries |
| 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). |
| 32 |
# |
| 33 |
# Dependencies on other cabal packages have to be specified |
| 34 |
# correctly. |
| 35 |
# |
| 36 |
# Cabal libraries should usually be SLOTted with "${PV}". |
| 37 |
# |
| 38 |
# Many Cabal packages require S to be manually set. |
| 39 |
# |
| 40 |
# Conforming Cabal packages don't require any function definitions |
| 41 |
# in the ebuild. |
| 42 |
# |
| 43 |
# Special flags to Cabal Configure can now be set by using |
| 44 |
# CABAL_CONFIGURE_FLAGS |
| 45 |
|
| 46 |
inherit ghc-package multilib |
| 47 |
|
| 48 |
HASKELL_CABAL_EXPF="pkg_setup src_compile src_test src_install" |
| 49 |
|
| 50 |
case "${EAPI:-0}" in |
| 51 |
2|3|4) HASKELL_CABAL_EXPF+=" src_configure" ;; |
| 52 |
*) ;; |
| 53 |
esac |
| 54 |
|
| 55 |
EXPORT_FUNCTIONS ${HASKELL_CABAL_EXPF} |
| 56 |
|
| 57 |
for feature in ${CABAL_FEATURES}; do |
| 58 |
case ${feature} in |
| 59 |
haddock) CABAL_USE_HADDOCK=yes;; |
| 60 |
alex) CABAL_USE_ALEX=yes;; |
| 61 |
happy) CABAL_USE_HAPPY=yes;; |
| 62 |
c2hs) CABAL_USE_C2HS=yes;; |
| 63 |
cpphs) CABAL_USE_CPPHS=yes;; |
| 64 |
profile) CABAL_USE_PROFILE=yes;; |
| 65 |
bootstrap) CABAL_BOOTSTRAP=yes;; |
| 66 |
bin) CABAL_HAS_BINARIES=yes;; |
| 67 |
lib) CABAL_HAS_LIBRARIES=yes;; |
| 68 |
nocabaldep) CABAL_FROM_GHC=yes;; |
| 69 |
*) CABAL_UNKNOWN="${CABAL_UNKNOWN} ${feature}";; |
| 70 |
esac |
| 71 |
done |
| 72 |
|
| 73 |
if [[ -n "${CABAL_USE_HADDOCK}" ]]; then |
| 74 |
IUSE="${IUSE} doc" |
| 75 |
DEPEND="${DEPEND} doc? ( dev-haskell/haddock )" |
| 76 |
fi |
| 77 |
|
| 78 |
if [[ -n "${CABAL_USE_ALEX}" ]]; then |
| 79 |
DEPEND="${DEPEND} dev-haskell/alex" |
| 80 |
cabalconf="${cabalconf} --with-alex=/usr/bin/alex" |
| 81 |
fi |
| 82 |
|
| 83 |
if [[ -n "${CABAL_USE_HAPPY}" ]]; then |
| 84 |
DEPEND="${DEPEND} dev-haskell/happy" |
| 85 |
cabalconf="${cabalconf} --with-happy=/usr/bin/happy" |
| 86 |
fi |
| 87 |
|
| 88 |
if [[ -n "${CABAL_USE_C2HS}" ]]; then |
| 89 |
DEPEND="${DEPEND} dev-haskell/c2hs" |
| 90 |
cabalconf="${cabalconf} --with-c2hs=/usr/bin/c2hs" |
| 91 |
fi |
| 92 |
|
| 93 |
if [[ -n "${CABAL_USE_CPPHS}" ]]; then |
| 94 |
DEPEND="${DEPEND} dev-haskell/cpphs" |
| 95 |
cabalconf="${cabalconf} --with-cpphs=/usr/bin/cpphs" |
| 96 |
fi |
| 97 |
|
| 98 |
if [[ -n "${CABAL_USE_PROFILE}" ]]; then |
| 99 |
IUSE="${IUSE} profile" |
| 100 |
fi |
| 101 |
|
| 102 |
# We always use a standalone version of Cabal, rather than the one that comes |
| 103 |
# with GHC. But of course we can't depend on cabal when building cabal itself. |
| 104 |
if [[ -z ${CABAL_MIN_VERSION} ]]; then |
| 105 |
CABAL_MIN_VERSION=1.1.4 |
| 106 |
fi |
| 107 |
if [[ -z "${CABAL_BOOTSTRAP}" && -z "${CABAL_FROM_GHC}" ]]; then |
| 108 |
DEPEND="${DEPEND} >=dev-haskell/cabal-${CABAL_MIN_VERSION}" |
| 109 |
fi |
| 110 |
|
| 111 |
# Libraries require GHC to be installed. |
| 112 |
if [[ -n "${CABAL_HAS_LIBRARIES}" ]]; then |
| 113 |
RDEPEND="${RDEPEND} dev-lang/ghc" |
| 114 |
fi |
| 115 |
|
| 116 |
# returns the version of cabal currently in use |
| 117 |
_CABAL_VERSION_CACHE="" |
| 118 |
cabal-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 |
| 145 |
fi |
| 146 |
echo "${_CABAL_VERSION_CACHE}" |
| 147 |
} |
| 148 |
|
| 149 |
cabal-bootstrap() { |
| 150 |
local setupmodule |
| 151 |
local cabalpackage |
| 152 |
if [[ -f "${S}/Setup.lhs" ]]; then |
| 153 |
setupmodule="${S}/Setup.lhs" |
| 154 |
else |
| 155 |
if [[ -f "${S}/Setup.hs" ]]; then |
| 156 |
setupmodule="${S}/Setup.hs" |
| 157 |
else |
| 158 |
die "No Setup.lhs or Setup.hs found" |
| 159 |
fi |
| 160 |
fi |
| 161 |
|
| 162 |
# We build the setup program using the latest version of |
| 163 |
# cabal that we have installed |
| 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 |
| 170 |
einfo "Using cabal-$(cabal-version)." |
| 171 |
$(ghc-getghc) -package "${cabalpackage}" --make "${setupmodule}" -o setup \ |
| 172 |
|| die "compiling ${setupmodule} failed" |
| 173 |
} |
| 174 |
|
| 175 |
cabal-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 |
| 188 |
} |
| 189 |
|
| 190 |
cabal-haddock() { |
| 191 |
./setup haddock || die "setup haddock failed" |
| 192 |
} |
| 193 |
|
| 194 |
cabal-configure() { |
| 195 |
if [[ -n "${CABAL_USE_HADDOCK}" ]] && use doc; then |
| 196 |
cabalconf="${cabalconf} --with-haddock=/usr/bin/haddock" |
| 197 |
fi |
| 198 |
if [[ -n "${CABAL_USE_PROFILE}" ]] && use profile; then |
| 199 |
cabalconf="${cabalconf} --enable-library-profiling" |
| 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. |
| 227 |
|
| 228 |
./setup configure \ |
| 229 |
--ghc --prefix=/usr \ |
| 230 |
--with-compiler="$(ghc-getghc)" \ |
| 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) \ |
| 237 |
${cabalconf} \ |
| 238 |
${CABAL_CONFIGURE_FLAGS} \ |
| 239 |
"$@" || die "setup configure failed" |
| 240 |
} |
| 241 |
|
| 242 |
cabal-build() { |
| 243 |
unset LANG LC_ALL LC_MESSAGES |
| 244 |
./setup build \ |
| 245 |
|| die "setup build failed" |
| 246 |
} |
| 247 |
|
| 248 |
cabal-copy() { |
| 249 |
./setup copy \ |
| 250 |
--destdir="${D}" \ |
| 251 |
|| die "setup copy failed" |
| 252 |
|
| 253 |
# cabal is a bit eager about creating dirs, |
| 254 |
# so remove them if they are empty |
| 255 |
rmdir "${D}/usr/bin" 2> /dev/null |
| 256 |
|
| 257 |
# GHC 6.4 has a bug in get/setPermission and Cabal 1.1.1 has |
| 258 |
# no workaround. |
| 259 |
# set the +x permission on executables |
| 260 |
if [[ -d "${D}/usr/bin" ]] ; then |
| 261 |
chmod +x "${D}/usr/bin/"* |
| 262 |
fi |
| 263 |
# TODO: do we still need this? |
| 264 |
} |
| 265 |
|
| 266 |
cabal-pkg() { |
| 267 |
# This does not actually register since we're using true instead |
| 268 |
# of ghc-pkg. So it just leaves the .installed-pkg-config and we can |
| 269 |
# register that ourselves (if it exists). |
| 270 |
local result |
| 271 |
local err |
| 272 |
|
| 273 |
if [[ -n ${CABAL_HAS_LIBRARIES} ]]; then |
| 274 |
if version_is_at_least "1.2.0" "$(cabal-version)"; then |
| 275 |
# Newer cabal can generate a package conf for us: |
| 276 |
./setup register --gen-pkg-config="${T}/${P}.conf" |
| 277 |
ghc-setup-pkg "${T}/${P}.conf" |
| 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" |
| 285 |
if [[ -f .installed-pkg-config ]]; then |
| 286 |
ghc-setup-pkg .installed-pkg-config |
| 287 |
ghc-install-pkg |
| 288 |
else |
| 289 |
die "setup register has not generated a package configuration file" |
| 290 |
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". |
| 303 |
cabal-is-dummy-lib() { |
| 304 |
for version in ${CABAL_CORE_LIB_GHC_PV[*]}; do |
| 305 |
[[ "$(ghc-version)" == "$version" ]] && return 0 |
| 306 |
done |
| 307 |
return 1 |
| 308 |
} |
| 309 |
|
| 310 |
# exported function: check if cabal is correctly installed for |
| 311 |
# the currently active ghc (we cannot guarantee this with portage) |
| 312 |
haskell-cabal_pkg_setup() { |
| 313 |
ghc-package_pkg_setup |
| 314 |
if [[ -z "${CABAL_BOOTSTRAP}" && -z "${CABAL_FROM_GHC}" ]] && ! ghc-sanecabal "${CABAL_MIN_VERSION}"; then |
| 315 |
eerror "The package dev-haskell/cabal is not correctly installed for" |
| 316 |
eerror "the currently active version of ghc ($(ghc-version)). Please" |
| 317 |
eerror "run ghc-updater or haskell-updater or re-build dev-haskell/cabal." |
| 318 |
die "cabal is not correctly installed" |
| 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 |
| 323 |
if [[ -n "${CABAL_UNKNOWN}" ]]; then |
| 324 |
ewarn "Unknown entry in CABAL_FEATURES: ${CABAL_UNKNOWN}" |
| 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 |
|
| 331 |
haskell-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 |
| 341 |
cabal_src_configure() { |
| 342 |
haskell-cabal_src_configure "$@" |
| 343 |
} |
| 344 |
|
| 345 |
# exported function: cabal-style bootstrap configure and compile |
| 346 |
cabal_src_compile() { |
| 347 |
if ! cabal-is-dummy-lib; then |
| 348 |
has src_configure ${HASKELL_CABAL_EXPF} || haskell-cabal_src_configure "$@" |
| 349 |
cabal-build |
| 350 |
|
| 351 |
if [[ -n "${CABAL_USE_HADDOCK}" ]] && use doc; then |
| 352 |
cabal-haddock |
| 353 |
fi |
| 354 |
fi |
| 355 |
} |
| 356 |
|
| 357 |
haskell-cabal_src_compile() { |
| 358 |
pushd "${S}" > /dev/null |
| 359 |
|
| 360 |
cabal_src_compile "$@" |
| 361 |
|
| 362 |
popd > /dev/null |
| 363 |
} |
| 364 |
|
| 365 |
haskell-cabal_src_test() { |
| 366 |
pushd "${S}" > /dev/null |
| 367 |
|
| 368 |
einfo ">>> Test phase [cabal test]: ${CATEGORY}/${PF}" |
| 369 |
./setup test || die "cabal test failed" |
| 370 |
|
| 371 |
popd > /dev/null |
| 372 |
} |
| 373 |
|
| 374 |
# exported function: cabal-style copy and register |
| 375 |
cabal_src_install() { |
| 376 |
if cabal-is-dummy-lib; then |
| 377 |
# create a dummy local package conf file for the sake of ghc-updater |
| 378 |
dodir "$(ghc-confdir)" |
| 379 |
echo '[]' > "${D}/$(ghc-confdir)/$(ghc-localpkgconf)" |
| 380 |
else |
| 381 |
cabal-copy |
| 382 |
cabal-pkg |
| 383 |
|
| 384 |
if [[ -n "${CABAL_USE_HADDOCK}" ]] && use doc; then |
| 385 |
if ! version_is_at_least "1.1.6" "$(cabal-version)"; then |
| 386 |
dohtml -r dist/doc/html/* |
| 387 |
fi |
| 388 |
fi |
| 389 |
fi |
| 390 |
} |
| 391 |
|
| 392 |
haskell-cabal_src_install() { |
| 393 |
pushd "${S}" > /dev/null |
| 394 |
|
| 395 |
cabal_src_install |
| 396 |
|
| 397 |
popd > /dev/null |
| 398 |
} |
| 399 |
|
| 400 |
# ebuild.sh:use_enable() taken as base |
| 401 |
# |
| 402 |
# Usage examples: |
| 403 |
# |
| 404 |
# CABAL_CONFIGURE_FLAGS=$(cabal_flag gui) |
| 405 |
# leads to "--flags=gui" or "--flags=-gui" (useflag 'gui') |
| 406 |
# |
| 407 |
# CABAL_CONFIGURE_FLAGS=$(cabal_flag gtk gui) |
| 408 |
# also leads to "--flags=gui" or " --flags=-gui" (useflag 'gtk') |
| 409 |
# |
| 410 |
cabal_flag() { |
| 411 |
if [[ -z "$1" ]]; then |
| 412 |
echo "!!! cabal_flag() called without a parameter." >&2 |
| 413 |
echo "!!! cabal_flag() <USEFLAG> [<cabal_flagname>]" >&2 |
| 414 |
return 1 |
| 415 |
fi |
| 416 |
|
| 417 |
local UWORD=${2:-$1} |
| 418 |
|
| 419 |
if use "$1"; then |
| 420 |
echo "--flags=${UWORD}" |
| 421 |
else |
| 422 |
echo "--flags=-${UWORD}" |
| 423 |
fi |
| 424 |
|
| 425 |
return 0 |
| 426 |
} |
Parent Directory
| 
Revision Log