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

Contents of /eclass/haskell-cabal.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.16 - (show annotations) (download)
Wed Sep 9 18:40:11 2009 UTC (5 years ago) by kolmodin
Branch: MAIN
Changes since 1.15: +17 -12 lines
Updating the haskell-cabal eclass to support the CABAL_FEATURES nocabaldep
which is used in the dev-haskell/haskell-updater package. It enables
packages to use the cabal eclass without depending on cabal.

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.14 2007/12/13 04:44:39 dcoutts 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
49 for feature in ${CABAL_FEATURES}; do
50 case ${feature} in
51 haddock) CABAL_USE_HADDOCK=yes;;
52 alex) CABAL_USE_ALEX=yes;;
53 happy) CABAL_USE_HAPPY=yes;;
54 c2hs) CABAL_USE_C2HS=yes;;
55 cpphs) CABAL_USE_CPPHS=yes;;
56 profile) CABAL_USE_PROFILE=yes;;
57 bootstrap) CABAL_BOOTSTRAP=yes;;
58 bin) CABAL_HAS_BINARIES=yes;;
59 lib) CABAL_HAS_LIBRARIES=yes;;
60 nocabaldep) CABAL_FROM_GHC=yes;;
61 *) CABAL_UNKNOWN="${CABAL_UNKNOWN} ${feature}";;
62 esac
63 done
64
65 if [[ -n "${CABAL_USE_HADDOCK}" ]]; then
66 IUSE="${IUSE} doc"
67 DEPEND="${DEPEND} doc? ( dev-haskell/haddock )"
68 fi
69
70 if [[ -n "${CABAL_USE_ALEX}" ]]; then
71 DEPEND="${DEPEND} dev-haskell/alex"
72 cabalconf="${cabalconf} --with-alex=/usr/bin/alex"
73 fi
74
75 if [[ -n "${CABAL_USE_HAPPY}" ]]; then
76 DEPEND="${DEPEND} dev-haskell/happy"
77 cabalconf="${cabalconf} --with-happy=/usr/bin/happy"
78 fi
79
80 if [[ -n "${CABAL_USE_C2HS}" ]]; then
81 DEPEND="${DEPEND} dev-haskell/c2hs"
82 cabalconf="${cabalconf} --with-c2hs=/usr/bin/c2hs"
83 fi
84
85 if [[ -n "${CABAL_USE_CPPHS}" ]]; then
86 DEPEND="${DEPEND} dev-haskell/cpphs"
87 cabalconf="${cabalconf} --with-cpphs=/usr/bin/cpphs"
88 fi
89
90 if [[ -n "${CABAL_USE_PROFILE}" ]]; then
91 IUSE="${IUSE} profile"
92 fi
93
94 # We always use a standalone version of Cabal, rather than the one that comes
95 # with GHC. But of course we can't depend on cabal when building cabal itself.
96 if [[ -z ${CABAL_MIN_VERSION} ]]; then
97 CABAL_MIN_VERSION=1.1.4
98 fi
99 if [[ -z "${CABAL_BOOTSTRAP}" && -z "${CABAL_FROM_GHC}" ]]; then
100 DEPEND="${DEPEND} >=dev-haskell/cabal-${CABAL_MIN_VERSION}"
101 fi
102
103 # Libraries require GHC to be installed.
104 if [[ -n "${CABAL_HAS_LIBRARIES}" ]]; then
105 RDEPEND="${RDEPEND} dev-lang/ghc"
106 fi
107
108 # returns the version of cabal currently in use
109 _CABAL_VERSION_CACHE=""
110 cabal-version() {
111 if [[ -z "${_CABAL_VERSION_CACHE}" ]]; then
112 if [[ "${CABAL_BOOTSTRAP}" ]]; then
113 # We're bootstrapping cabal, so the cabal version is the version
114 # of this package itself.
115 _CABAL_VERSION_CACHE="${PV}"
116 else
117 # We ask portage, not ghc, so that we only pick up
118 # portage-installed cabal versions.
119 _CABAL_VERSION_CACHE="$(ghc-extractportageversion dev-haskell/cabal)"
120 fi
121 fi
122 echo "${_CABAL_VERSION_CACHE}"
123 }
124
125 cabal-bootstrap() {
126 local setupmodule
127 local cabalpackage
128 if [[ -f "${S}/Setup.lhs" ]]; then
129 setupmodule="${S}/Setup.lhs"
130 else
131 if [[ -f "${S}/Setup.hs" ]]; then
132 setupmodule="${S}/Setup.hs"
133 else
134 die "No Setup.lhs or Setup.hs found"
135 fi
136 fi
137
138 # We build the setup program using the latest version of
139 # cabal that we have installed
140 if version_is_at_least "6.4" "$(ghc-version)"; then
141 cabalpackage=Cabal-$(cabal-version)
142 else
143 # older ghc's don't support package versioning
144 cabalpackage=Cabal
145 fi
146 einfo "Using cabal-$(cabal-version)."
147 $(ghc-getghc) -package "${cabalpackage}" --make "${setupmodule}" -o setup \
148 || die "compiling ${setupmodule} failed"
149 }
150
151 cabal-mksetup() {
152 local setupdir
153
154 if [[ -n $1 ]]; then
155 setupdir=$1
156 else
157 setupdir=${S}
158 fi
159
160 rm -f "${setupdir}"/Setup.{lhs,hs}
161
162 echo 'import Distribution.Simple; main = defaultMainWithHooks defaultUserHooks' \
163 > $setupdir/Setup.hs
164 }
165
166 cabal-haddock() {
167 ./setup haddock || die "setup haddock failed"
168 }
169
170 cabal-configure() {
171 if [[ -n "${CABAL_USE_HADDOCK}" ]] && use doc; then
172 cabalconf="${cabalconf} --with-haddock=/usr/bin/haddock"
173 fi
174 if [[ -n "${CABAL_USE_PROFILE}" ]] && use profile; then
175 cabalconf="${cabalconf} --enable-library-profiling"
176 fi
177 # Building GHCi libs on ppc64 causes "TOC overflow".
178 if use ppc64; then
179 cabalconf="${cabalconf} --disable-library-for-ghci"
180 fi
181
182 if version_is_at_least "1.2.0" "$(cabal-version)"; then
183 cabalconf="${cabalconf} --docdir=/usr/share/doc/${PF}"
184 # As of Cabal 1.2, configure is quite quiet. For diagnostic purposes
185 # it's better if the configure chatter is in the build logs:
186 cabalconf="${cabalconf} --verbose"
187 fi
188 # Note: with Cabal-1.1.6.x we do not have enough control
189 # to put the docs into the right place. They're currently going
190 # into /usr/share/${P}/ghc-x.y/doc/
191 # rather than /usr/share/doc/${PF}/
192 # Because we can only set the datadir, not the docdir.
193
194 ./setup configure \
195 --ghc --prefix=/usr \
196 --with-compiler="$(ghc-getghc)" \
197 --with-hc-pkg="$(ghc-getghcpkg)" \
198 --prefix=/usr \
199 --libdir=/usr/$(get_libdir) \
200 --libsubdir=${P}/ghc-$(ghc-version) \
201 --datadir=/usr/share/ \
202 --datasubdir=${P}/ghc-$(ghc-version) \
203 ${cabalconf} \
204 ${CABAL_CONFIGURE_FLAGS} \
205 "$@" || die "setup configure failed"
206 }
207
208 cabal-build() {
209 unset LANG LC_ALL LC_MESSAGES
210 ./setup build \
211 || die "setup build failed"
212 }
213
214 cabal-copy() {
215 ./setup copy \
216 --destdir="${D}" \
217 || die "setup copy failed"
218
219 # cabal is a bit eager about creating dirs,
220 # so remove them if they are empty
221 rmdir "${D}/usr/bin" 2> /dev/null
222
223 # GHC 6.4 has a bug in get/setPermission and Cabal 1.1.1 has
224 # no workaround.
225 # set the +x permission on executables
226 if [[ -d "${D}/usr/bin" ]] ; then
227 chmod +x "${D}/usr/bin/"*
228 fi
229 # TODO: do we still need this?
230 }
231
232 cabal-pkg() {
233 # This does not actually register since we're using true instead
234 # of ghc-pkg. So it just leaves the .installed-pkg-config and we can
235 # register that ourselves (if it exists).
236 local result
237 local err
238
239 if [[ -n ${CABAL_HAS_LIBRARIES} ]]; then
240 if version_is_at_least "1.2.0" "$(cabal-version)"; then
241 # Newer cabal can generate a package conf for us:
242 ./setup register --gen-pkg-config="${T}/${P}.conf"
243 ghc-setup-pkg "${T}/${P}.conf"
244 ghc-install-pkg
245 else
246 # With older cabal we have to hack it by replacing its ghc-pkg
247 # with true and then just picking up the .installed-pkg-config
248 # file and registering that ourselves (if it exists).
249 sed -i "s|$(ghc-getghcpkg)|$(type -P true)|" .setup-config
250 ./setup register || die "setup register failed"
251 if [[ -f .installed-pkg-config ]]; then
252 ghc-setup-pkg .installed-pkg-config
253 ghc-install-pkg
254 else
255 die "setup register has not generated a package configuration file"
256 fi
257 fi
258 fi
259 }
260
261 # Some cabal libs are bundled along with some versions of ghc
262 # eg filepath-1.0 comes with ghc-6.6.1
263 # by putting CABAL_CORE_LIB_GHC_PV="6.6.1" in an ebuild we are declaring that
264 # when building with this version of ghc, the ebuild is a dummy that is it will
265 # install no files since the package is already included with ghc.
266 # However portage still records the dependency and we can upgrade the package
267 # to a later one that's not included with ghc.
268 # You can also put a space separated list, eg CABAL_CORE_LIB_GHC_PV="6.6 6.6.1".
269 cabal-is-dummy-lib() {
270 for version in ${CABAL_CORE_LIB_GHC_PV[*]}; do
271 [[ "$(ghc-version)" == "$version" ]] && return 0
272 done
273 return 1
274 }
275
276 # exported function: check if cabal is correctly installed for
277 # the currently active ghc (we cannot guarantee this with portage)
278 haskell-cabal_pkg_setup() {
279 ghc-package_pkg_setup
280 if [[ -z "${CABAL_BOOTSTRAP}" && -z "${CABAL_FROM_GHC}" ]] && ! ghc-sanecabal "${CABAL_MIN_VERSION}"; then
281 eerror "The package dev-haskell/cabal is not correctly installed for"
282 eerror "the currently active version of ghc ($(ghc-version)). Please"
283 eerror "run ghc-updater or haskell-updater or re-build dev-haskell/cabal."
284 die "cabal is not correctly installed"
285 fi
286 if [[ -z "${CABAL_HAS_BINARIES}" ]] && [[ -z "${CABAL_HAS_LIBRARIES}" ]]; then
287 eerror "QA: Neither bin nor lib are in CABAL_FEATURES."
288 fi
289 if [[ -n "${CABAL_UNKNOWN}" ]]; then
290 ewarn "Unknown entry in CABAL_FEATURES: ${CABAL_UNKNOWN}"
291 fi
292 if cabal-is-dummy-lib; then
293 einfo "${P} is included in ghc-${CABAL_CORE_LIB_GHC_PV}, nothing to install."
294 fi
295 }
296
297 # exported function: cabal-style bootstrap configure and compile
298 cabal_src_compile() {
299 if ! cabal-is-dummy-lib; then
300 cabal-bootstrap
301 cabal-configure
302 cabal-build
303
304 if [[ -n "${CABAL_USE_HADDOCK}" ]] && use doc; then
305 cabal-haddock
306 fi
307 fi
308 }
309
310 haskell-cabal_src_compile() {
311 cabal_src_compile
312 }
313
314 # exported function: cabal-style copy and register
315 cabal_src_install() {
316 if cabal-is-dummy-lib; then
317 # create a dummy local package conf file for the sake of ghc-updater
318 dodir "$(ghc-confdir)"
319 echo '[]' > "${D}/$(ghc-confdir)/$(ghc-localpkgconf)"
320 else
321 cabal-copy
322 cabal-pkg
323
324 if [[ -n "${CABAL_USE_HADDOCK}" ]] && use doc; then
325 if ! version_is_at_least "1.1.6" "$(cabal-version)"; then
326 dohtml -r dist/doc/html/*
327 fi
328 fi
329 fi
330 }
331 haskell-cabal_src_install() {
332 cabal_src_install
333 }
334
335 EXPORT_FUNCTIONS pkg_setup src_compile src_install

  ViewVC Help
Powered by ViewVC 1.1.20