LocalBuildInfo.hs 6.68 KB
Newer Older
ijones's avatar
ijones committed
1
2
3
4
-----------------------------------------------------------------------------
-- |
-- Module      :  Distribution.Simple.LocalBuildInfo
-- Copyright   :  Isaac Jones 2003-2004
5
--
Duncan Coutts's avatar
Duncan Coutts committed
6
-- Maintainer  :  cabal-devel@haskell.org
ijones's avatar
ijones committed
7
-- Portability :  portable
ijones's avatar
ijones committed
8
--
Duncan Coutts's avatar
Duncan Coutts committed
9
10
11
12
13
-- Once a package has been configured we have resolved conditionals and
-- dependencies, configured the compiler and other needed external programs.
-- The 'LocalBuildInfo' is used to hold all this information. It holds the
-- install dirs, the compiler, the exact package dependencies, the configured
-- programs, the package database to use and a bunch of miscellaneous configure
14
-- flags. It gets saved and reloaded from a file (@dist\/setup-config@). It gets
Duncan Coutts's avatar
Duncan Coutts committed
15
-- passed in to very many subsequent build actions.
ijones's avatar
ijones committed
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46

{- All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:

    * Redistributions of source code must retain the above copyright
      notice, this list of conditions and the following disclaimer.

    * Redistributions in binary form must reproduce the above
      copyright notice, this list of conditions and the following
      disclaimer in the documentation and/or other materials provided
      with the distribution.

    * Neither the name of Isaac Jones nor the names of other
      contributors may be used to endorse or promote products derived
      from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. -}

47
48
49
50
module Distribution.Simple.LocalBuildInfo (
        LocalBuildInfo(..),
        -- * Installation directories
        module Distribution.Simple.InstallDirs,
51
        absoluteInstallDirs, prefixRelativeInstallDirs,
52
        substPathTemplate
53
  ) where
ijones's avatar
ijones committed
54

ijones's avatar
ijones committed
55

56
import Distribution.Simple.InstallDirs hiding (absoluteInstallDirs,
57
58
                                               prefixRelativeInstallDirs,
                                               substPathTemplate, )
59
import qualified Distribution.Simple.InstallDirs as InstallDirs
60
61
import Distribution.Simple.Setup (CopyDest(..))
import Distribution.Simple.Program (ProgramConfiguration)
Simon Marlow's avatar
Simon Marlow committed
62
import Distribution.PackageDescription (PackageDescription(..))
63
import Distribution.Package (PackageIdentifier, Package(..))
64
65
import Distribution.Simple.Compiler
         ( Compiler(..), PackageDB, OptimisationLevel )
66
import Distribution.Simple.PackageIndex (PackageIndex)
67
import Distribution.InstalledPackageInfo (InstalledPackageInfo)
ijones's avatar
ijones committed
68

69
70
-- |Data cached after configuration step.  See also
-- 'Distribution.Setup.ConfigFlags'.
ijones's avatar
ijones committed
71
data LocalBuildInfo = LocalBuildInfo {
72
        installDirTemplates :: InstallDirTemplates,
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
                -- ^ The installation directories for the various differnt
                -- kinds of files
        compiler      :: Compiler,
                -- ^ The compiler we're building with
        buildDir      :: FilePath,
                -- ^ Where to build the package.
        scratchDir    :: FilePath,
                -- ^ Where to put the result of the Hugs build.
        packageDeps   :: [PackageIdentifier],
                -- ^ Which packages we depend on, /exactly/.
                -- The 'Distribution.PackageDescription.PackageDescription'
                -- specifies a set of build dependencies
                -- that must be satisfied in terms of version ranges.  This
                -- field fixes those dependencies to the specific versions
                -- available on this machine for this compiler.
88
        installedPkgs :: PackageIndex InstalledPackageInfo,
89
                -- ^ All the info about all installed packages.
90
91
        pkgDescrFile  :: Maybe FilePath,
                -- ^ the filename containing the .cabal file, if available
92
93
94
        localPkgDescr :: PackageDescription,
                -- ^ The resolved package description, that does not contain
                -- any conditionals.
Duncan Coutts's avatar
Duncan Coutts committed
95
96
        withPrograms  :: ProgramConfiguration, -- ^Location and args for all programs
        withPackageDB :: PackageDB,  -- ^What package database to use, global\/user
97
98
        withVanillaLib:: Bool,  -- ^Whether to build normal libs.
        withProfLib   :: Bool,  -- ^Whether to build profiling versions of libs.
99
        withSharedLib :: Bool,  -- ^Whether to build shared versions of libs.
100
        withProfExe   :: Bool,  -- ^Whether to build executables for profiling.
101
        withOptimization :: OptimisationLevel, -- ^Whether to build with optimization (if available).
102
        withGHCiLib   :: Bool,  -- ^Whether to build libs suitable for use with GHCi.
103
        splitObjs     :: Bool,  -- ^Use -split-objs with GHC, if available
104
        stripExes     :: Bool,  -- ^Whether to strip executables during install
105
106
        progPrefix    :: PathTemplate, -- ^Prefix to be prepended to installed executables
        progSuffix    :: PathTemplate -- ^Suffix to be appended to installed executables
107

ijones's avatar
ijones committed
108
  } deriving (Read, Show)
ijones's avatar
ijones committed
109

110
-- -----------------------------------------------------------------------------
111
112
113
114
115
116
117
-- Wrappers for a couple functions from InstallDirs

-- |See 'InstallDirs.absoluteInstallDirs'
absoluteInstallDirs :: PackageDescription -> LocalBuildInfo -> CopyDest
                    -> InstallDirs FilePath
absoluteInstallDirs pkg_descr lbi copydest =
  InstallDirs.absoluteInstallDirs
118
    (packageId pkg_descr)
119
120
121
122
123
124
125
126
127
    (compilerId (compiler lbi))
    copydest
    (installDirTemplates lbi)

-- |See 'InstallDirs.prefixRelativeInstallDirs'
prefixRelativeInstallDirs :: PackageDescription -> LocalBuildInfo
                          -> InstallDirs (Maybe FilePath)
prefixRelativeInstallDirs pkg_descr lbi =
  InstallDirs.prefixRelativeInstallDirs
128
    (packageId pkg_descr)
129
130
    (compilerId (compiler lbi))
    (installDirTemplates lbi)
131

132
133
substPathTemplate :: PackageDescription -> LocalBuildInfo
                  -> PathTemplate -> FilePath
134
substPathTemplate pkg_descr lbi = fromPathTemplate
135
                                . ( InstallDirs.substPathTemplate env )
136
    where env = initialPathTemplateEnv
137
                   (packageId pkg_descr)
138
                   (compilerId (compiler lbi))