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

Contents of /eclass/haskell-cabal.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.17 - (hide annotations) (download)
Wed Oct 28 23:46:16 2009 UTC (4 years, 5 months ago) by kolmodin
Branch: MAIN
Changes since 1.16: +17 -1 lines
Properly support the CABAL_FEATURES="nocabaldep" if user doesn't have dev-haskell/cabal

1 dcoutts 1.4 # Copyright 1999-2006 Gentoo Foundation
2 kosmikus 1.1 # Distributed under the terms of the GNU General Public License v2
3 kolmodin 1.17 # $Header: /var/cvsroot/gentoo-x86/eclass/haskell-cabal.eclass,v 1.16 2009/09/09 18:40:11 kolmodin Exp $
4 kosmikus 1.1 #
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 dcoutts 1.3 # bin -- the package installs binaries
28     # lib -- the package installs libraries
29 kolmodin 1.16 # 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 kosmikus 1.1 #
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 kosmikus 1.8 #
43     # Special flags to Cabal Configure can now be set by using
44     # CABAL_CONFIGURE_FLAGS
45 kosmikus 1.1
46 dcoutts 1.11 inherit ghc-package multilib
47 kosmikus 1.1
48    
49     for feature in ${CABAL_FEATURES}; do
50     case ${feature} in
51 kolmodin 1.16 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 dcoutts 1.3 *) CABAL_UNKNOWN="${CABAL_UNKNOWN} ${feature}";;
62 kosmikus 1.1 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 dcoutts 1.14 if [[ -z ${CABAL_MIN_VERSION} ]]; then
97     CABAL_MIN_VERSION=1.1.4
98     fi
99 kolmodin 1.16 if [[ -z "${CABAL_BOOTSTRAP}" && -z "${CABAL_FROM_GHC}" ]]; then
100 dcoutts 1.11 DEPEND="${DEPEND} >=dev-haskell/cabal-${CABAL_MIN_VERSION}"
101 kosmikus 1.1 fi
102    
103 dcoutts 1.3 # Libraries require GHC to be installed.
104     if [[ -n "${CABAL_HAS_LIBRARIES}" ]]; then
105 dcoutts 1.11 RDEPEND="${RDEPEND} dev-lang/ghc"
106 dcoutts 1.3 fi
107 kosmikus 1.1
108 dcoutts 1.14 # 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 kolmodin 1.17 elif [[ "${CABAL_FROM_GHC}" ]]; then
117     # We can't assume there's a version of Cabal installed by ebuild as
118     # this might be a first time install of GHC (for packages that
119     # use the shipped Cabal like haskell-updater).
120    
121     # The user is likely to only have one version of Cabal, provided
122     # by GHC. Note that dev-haskell/cabal can be a dummy package, only
123     # using the version provided by GHC. If the user has another version
124     # of Cabal too (more recent than the one GHC provides through
125     # dev-haskell/cabal, or possibly older if he used an old
126     # Cabal package) the most recent is used (expected to be the last
127     # one in the ghc-pkg output).
128     _CABAL_VERSION_CACHE="$(ghc-pkg field Cabal version | tail -n 1)"
129    
130     # Strip out the "version: " prefix
131     _CABAL_VERSION_CACHE="${_CABAL_VERSION_CACHE#"version: "}"
132 dcoutts 1.14 else
133     # We ask portage, not ghc, so that we only pick up
134     # portage-installed cabal versions.
135     _CABAL_VERSION_CACHE="$(ghc-extractportageversion dev-haskell/cabal)"
136     fi
137     fi
138     echo "${_CABAL_VERSION_CACHE}"
139     }
140    
141 kosmikus 1.1 cabal-bootstrap() {
142     local setupmodule
143 dcoutts 1.14 local cabalpackage
144 kosmikus 1.1 if [[ -f "${S}/Setup.lhs" ]]; then
145     setupmodule="${S}/Setup.lhs"
146     else
147     if [[ -f "${S}/Setup.hs" ]]; then
148     setupmodule="${S}/Setup.hs"
149     else
150     die "No Setup.lhs or Setup.hs found"
151     fi
152     fi
153    
154     # We build the setup program using the latest version of
155     # cabal that we have installed
156 dcoutts 1.14 if version_is_at_least "6.4" "$(ghc-version)"; then
157     cabalpackage=Cabal-$(cabal-version)
158     else
159     # older ghc's don't support package versioning
160     cabalpackage=Cabal
161     fi
162     einfo "Using cabal-$(cabal-version)."
163     $(ghc-getghc) -package "${cabalpackage}" --make "${setupmodule}" -o setup \
164 kosmikus 1.1 || die "compiling ${setupmodule} failed"
165     }
166    
167 dcoutts 1.14 cabal-mksetup() {
168     local setupdir
169    
170     if [[ -n $1 ]]; then
171     setupdir=$1
172     else
173     setupdir=${S}
174     fi
175    
176     rm -f "${setupdir}"/Setup.{lhs,hs}
177    
178     echo 'import Distribution.Simple; main = defaultMainWithHooks defaultUserHooks' \
179     > $setupdir/Setup.hs
180     }
181    
182 kosmikus 1.1 cabal-haddock() {
183     ./setup haddock || die "setup haddock failed"
184     }
185    
186     cabal-configure() {
187 dcoutts 1.14 if [[ -n "${CABAL_USE_HADDOCK}" ]] && use doc; then
188     cabalconf="${cabalconf} --with-haddock=/usr/bin/haddock"
189     fi
190 kosmikus 1.1 if [[ -n "${CABAL_USE_PROFILE}" ]] && use profile; then
191 dcoutts 1.2 cabalconf="${cabalconf} --enable-library-profiling"
192 kosmikus 1.1 fi
193 dcoutts 1.6 # Building GHCi libs on ppc64 causes "TOC overflow".
194     if use ppc64; then
195 dcoutts 1.5 cabalconf="${cabalconf} --disable-library-for-ghci"
196     fi
197 kosmikus 1.1
198 dcoutts 1.14 if version_is_at_least "1.2.0" "$(cabal-version)"; then
199     cabalconf="${cabalconf} --docdir=/usr/share/doc/${PF}"
200     # As of Cabal 1.2, configure is quite quiet. For diagnostic purposes
201     # it's better if the configure chatter is in the build logs:
202     cabalconf="${cabalconf} --verbose"
203     fi
204     # Note: with Cabal-1.1.6.x we do not have enough control
205 dcoutts 1.11 # to put the docs into the right place. They're currently going
206     # into /usr/share/${P}/ghc-x.y/doc/
207     # rather than /usr/share/doc/${PF}/
208     # Because we can only set the datadir, not the docdir.
209    
210 kosmikus 1.1 ./setup configure \
211     --ghc --prefix=/usr \
212     --with-compiler="$(ghc-getghc)" \
213     --with-hc-pkg="$(ghc-getghcpkg)" \
214 dcoutts 1.11 --prefix=/usr \
215     --libdir=/usr/$(get_libdir) \
216     --libsubdir=${P}/ghc-$(ghc-version) \
217     --datadir=/usr/share/ \
218     --datasubdir=${P}/ghc-$(ghc-version) \
219 kosmikus 1.1 ${cabalconf} \
220 kosmikus 1.8 ${CABAL_CONFIGURE_FLAGS} \
221 kosmikus 1.1 "$@" || die "setup configure failed"
222     }
223    
224     cabal-build() {
225 dcoutts 1.14 unset LANG LC_ALL LC_MESSAGES
226 kosmikus 1.1 ./setup build \
227     || die "setup build failed"
228     }
229    
230     cabal-copy() {
231     ./setup copy \
232 dcoutts 1.11 --destdir="${D}" \
233 kosmikus 1.1 || die "setup copy failed"
234    
235     # cabal is a bit eager about creating dirs,
236     # so remove them if they are empty
237     rmdir "${D}/usr/bin" 2> /dev/null
238    
239     # GHC 6.4 has a bug in get/setPermission and Cabal 1.1.1 has
240     # no workaround.
241     # set the +x permission on executables
242     if [[ -d "${D}/usr/bin" ]] ; then
243     chmod +x "${D}/usr/bin/"*
244     fi
245 dcoutts 1.11 # TODO: do we still need this?
246 kosmikus 1.1 }
247    
248     cabal-pkg() {
249 kosmikus 1.9 # This does not actually register since we're using true instead
250 kosmikus 1.1 # of ghc-pkg. So it just leaves the .installed-pkg-config and we can
251     # register that ourselves (if it exists).
252 dcoutts 1.2 local result
253     local err
254    
255 dcoutts 1.4 if [[ -n ${CABAL_HAS_LIBRARIES} ]]; then
256 dcoutts 1.14 if version_is_at_least "1.2.0" "$(cabal-version)"; then
257     # Newer cabal can generate a package conf for us:
258     ./setup register --gen-pkg-config="${T}/${P}.conf"
259     ghc-setup-pkg "${T}/${P}.conf"
260 dcoutts 1.4 ghc-install-pkg
261     else
262 dcoutts 1.14 # With older cabal we have to hack it by replacing its ghc-pkg
263     # with true and then just picking up the .installed-pkg-config
264     # file and registering that ourselves (if it exists).
265     sed -i "s|$(ghc-getghcpkg)|$(type -P true)|" .setup-config
266     ./setup register || die "setup register failed"
267     if [[ -f .installed-pkg-config ]]; then
268     ghc-setup-pkg .installed-pkg-config
269     ghc-install-pkg
270     else
271     die "setup register has not generated a package configuration file"
272     fi
273 dcoutts 1.4 fi
274 kosmikus 1.1 fi
275     }
276    
277 kolmodin 1.13 # Some cabal libs are bundled along with some versions of ghc
278     # eg filepath-1.0 comes with ghc-6.6.1
279     # by putting CABAL_CORE_LIB_GHC_PV="6.6.1" in an ebuild we are declaring that
280     # when building with this version of ghc, the ebuild is a dummy that is it will
281     # install no files since the package is already included with ghc.
282     # However portage still records the dependency and we can upgrade the package
283     # to a later one that's not included with ghc.
284     # You can also put a space separated list, eg CABAL_CORE_LIB_GHC_PV="6.6 6.6.1".
285     cabal-is-dummy-lib() {
286     for version in ${CABAL_CORE_LIB_GHC_PV[*]}; do
287     [[ "$(ghc-version)" == "$version" ]] && return 0
288     done
289     return 1
290     }
291    
292 kosmikus 1.1 # exported function: check if cabal is correctly installed for
293     # the currently active ghc (we cannot guarantee this with portage)
294     haskell-cabal_pkg_setup() {
295 dcoutts 1.11 ghc-package_pkg_setup
296 kolmodin 1.16 if [[ -z "${CABAL_BOOTSTRAP}" && -z "${CABAL_FROM_GHC}" ]] && ! ghc-sanecabal "${CABAL_MIN_VERSION}"; then
297 kosmikus 1.1 eerror "The package dev-haskell/cabal is not correctly installed for"
298     eerror "the currently active version of ghc ($(ghc-version)). Please"
299 kolmodin 1.16 eerror "run ghc-updater or haskell-updater or re-build dev-haskell/cabal."
300 kosmikus 1.1 die "cabal is not correctly installed"
301     fi
302 dcoutts 1.4 if [[ -z "${CABAL_HAS_BINARIES}" ]] && [[ -z "${CABAL_HAS_LIBRARIES}" ]]; then
303     eerror "QA: Neither bin nor lib are in CABAL_FEATURES."
304     fi
305 dcoutts 1.3 if [[ -n "${CABAL_UNKNOWN}" ]]; then
306 kolmodin 1.15 ewarn "Unknown entry in CABAL_FEATURES: ${CABAL_UNKNOWN}"
307 dcoutts 1.3 fi
308 kolmodin 1.13 if cabal-is-dummy-lib; then
309     einfo "${P} is included in ghc-${CABAL_CORE_LIB_GHC_PV}, nothing to install."
310     fi
311 kosmikus 1.1 }
312    
313     # exported function: cabal-style bootstrap configure and compile
314     cabal_src_compile() {
315 kolmodin 1.13 if ! cabal-is-dummy-lib; then
316     cabal-bootstrap
317     cabal-configure
318     cabal-build
319 kosmikus 1.1
320 kolmodin 1.13 if [[ -n "${CABAL_USE_HADDOCK}" ]] && use doc; then
321     cabal-haddock
322     fi
323 kosmikus 1.1 fi
324     }
325 kolmodin 1.16
326 kosmikus 1.1 haskell-cabal_src_compile() {
327     cabal_src_compile
328     }
329    
330     # exported function: cabal-style copy and register
331     cabal_src_install() {
332 kolmodin 1.13 if cabal-is-dummy-lib; then
333     # create a dummy local package conf file for the sake of ghc-updater
334     dodir "$(ghc-confdir)"
335     echo '[]' > "${D}/$(ghc-confdir)/$(ghc-localpkgconf)"
336     else
337     cabal-copy
338     cabal-pkg
339 kosmikus 1.1
340 kolmodin 1.13 if [[ -n "${CABAL_USE_HADDOCK}" ]] && use doc; then
341 dcoutts 1.14 if ! version_is_at_least "1.1.6" "$(cabal-version)"; then
342 kolmodin 1.13 dohtml -r dist/doc/html/*
343     fi
344 dcoutts 1.11 fi
345 kosmikus 1.1 fi
346     }
347     haskell-cabal_src_install() {
348     cabal_src_install
349     }
350    
351     EXPORT_FUNCTIONS pkg_setup src_compile src_install

  ViewVC Help
Powered by ViewVC 1.1.20