Register.hs 17.2 KB
Newer Older
1
2
-----------------------------------------------------------------------------
-- |
ijones's avatar
ijones committed
3
-- Module      :  Distribution.Simple.Register
4
-- Copyright   :  Isaac Jones 2003-2004
5
-- License     :  BSD3
6
--
Duncan Coutts's avatar
Duncan Coutts committed
7
-- Maintainer  :  cabal-devel@haskell.org
ijones's avatar
ijones committed
8
-- Portability :  portable
9
--
Duncan Coutts's avatar
Duncan Coutts committed
10
11
12
13
14
15
16
17
-- This module deals with registering and unregistering packages. There are a
-- couple ways it can do this, one is to do it directly. Another is to generate
-- a script that can be run later to do it. The idea here being that the user
-- is shielded from the details of what command to use for package registration
-- for a particular compiler. In practice this aspect was not especially
-- popular so we also provide a way to simply generate the package registration
-- file which then must be manually passed to @ghc-pkg@. It is possible to
-- generate registration information for where the package is to be installed,
Ian D. Bollinger's avatar
Ian D. Bollinger committed
18
-- or alternatively to register the package in place in the build tree. The
Duncan Coutts's avatar
Duncan Coutts committed
19
20
21
22
23
24
-- latter is occasionally handy, and will become more important when we try to
-- build multi-package systems.
--
-- This module does not delegate anything to the per-compiler modules but just
-- mixes it all in in this module, which is rather unsatisfactory. The script
-- generation and the unregister feature are not well used or tested.
25

26
module Distribution.Simple.Register (
Duncan Coutts's avatar
Duncan Coutts committed
27
28
29
    register,
    unregister,

30
    initPackageDB,
refold's avatar
refold committed
31
    invokeHcPkg,
Duncan Coutts's avatar
Duncan Coutts committed
32
    registerPackage,
33
    generateRegistrationInfo,
Duncan Coutts's avatar
Duncan Coutts committed
34
35
36
    inplaceInstalledPackageInfo,
    absoluteInstalledPackageInfo,
    generalInstalledPackageInfo,
37
  ) where
38

39
40
import Distribution.Simple.LocalBuildInfo
         ( LocalBuildInfo(..), ComponentLocalBuildInfo(..)
41
         , ComponentName(..), getComponentLocalBuildInfo
42
         , LibraryName(..)
43
         , InstallDirs(..), absoluteInstallDirs )
44
import Distribution.Simple.BuildPaths (haddockName)
45
46
import qualified Distribution.Simple.GHC  as GHC
import qualified Distribution.Simple.LHC  as LHC
47
import qualified Distribution.Simple.UHC  as UHC
48
import qualified Distribution.Simple.HaskellSuite as HaskellSuite
49
import Distribution.Simple.Compiler
50
         ( compilerVersion, Compiler, CompilerFlavor(..), compilerFlavor
51
         , PackageDBStack, registrationPackageDB )
Duncan Coutts's avatar
Duncan Coutts committed
52
import Distribution.Simple.Program
53
54
55
         ( ProgramConfiguration, ConfiguredProgram
         , runProgramInvocation, requireProgram, lookupProgram
         , ghcPkgProgram, lhcPkgProgram )
Duncan Coutts's avatar
Duncan Coutts committed
56
57
58
import Distribution.Simple.Program.Script
         ( invocationAsSystemScript )
import qualified Distribution.Simple.Program.HcPkg as HcPkg
59
60
61
import Distribution.Simple.Setup
         ( RegisterFlags(..), CopyDest(..)
         , fromFlag, fromFlagOrDefault, flagToMaybe )
Duncan Coutts's avatar
Duncan Coutts committed
62
import Distribution.PackageDescription
63
         ( PackageDescription(..), Library(..), BuildInfo(..) )
64
import Distribution.Package
65
         ( Package(..), packageName, InstalledPackageId(..) )
66
import Distribution.InstalledPackageInfo
67
         ( InstalledPackageInfo, InstalledPackageInfo_(InstalledPackageInfo)
68
         , showInstalledPackageInfo )
69
import qualified Distribution.InstalledPackageInfo as IPI
70
import Distribution.Simple.Utils
71
         ( writeUTF8File, writeFileAtomic, setFileExecutable
Duncan Coutts's avatar
Duncan Coutts committed
72
         , die, notice, setupMessage )
73
import Distribution.System
74
         ( OS(..), buildOS )
75
76
import Distribution.Text
         ( display )
77
import Distribution.Version ( Version(..) )
Duncan Coutts's avatar
Duncan Coutts committed
78
79
import Distribution.Verbosity as Verbosity
         ( Verbosity, normal )
80

81
import System.FilePath ((</>), (<.>), isAbsolute)
Duncan Coutts's avatar
Duncan Coutts committed
82
import System.Directory
83
         ( getCurrentDirectory )
ijones's avatar
ijones committed
84

85
import Control.Monad (when)
Duncan Coutts's avatar
Duncan Coutts committed
86
import Data.Maybe
87
         ( isJust, fromMaybe, maybeToList )
Duncan Coutts's avatar
Duncan Coutts committed
88
89
import Data.List
         ( partition, nub )
90
import qualified Data.ByteString.Lazy.Char8 as BS.Char8
91

simonmar's avatar
simonmar committed
92
93
94
-- -----------------------------------------------------------------------------
-- Registration

ijones's avatar
ijones committed
95
register :: PackageDescription -> LocalBuildInfo
ijones's avatar
ijones committed
96
         -> RegisterFlags -- ^Install in the user's database?; verbose
ijones's avatar
ijones committed
97
         -> IO ()
98
register pkg@PackageDescription { library       = Just lib  } lbi regFlags
99
  = do
100
    let clbi = getComponentLocalBuildInfo lbi CLibName
101
102
103
    installedPkgInfo <- generateRegistrationInfo
                           verbosity pkg lib lbi clbi inplace distPref

104
105
106
    when (fromFlag (regPrintId regFlags)) $ do
      putStrLn (display (IPI.installedPackageId installedPkgInfo))

107
108
109
110
111
     -- Three different modes:
    case () of
     _ | modeGenerateRegFile   -> writeRegistrationFile installedPkgInfo
       | modeGenerateRegScript -> writeRegisterScript   installedPkgInfo
       | otherwise             -> registerPackage verbosity
112
                                    installedPkgInfo pkg lbi inplace packageDbs
Duncan Coutts's avatar
Duncan Coutts committed
113
114
115
116
117
118
119
120
121

  where
    modeGenerateRegFile = isJust (flagToMaybe (regGenPkgConf regFlags))
    regFile             = fromMaybe (display (packageId pkg) <.> "conf")
                                    (fromFlag (regGenPkgConf regFlags))

    modeGenerateRegScript = fromFlag (regGenScript regFlags)

    inplace   = fromFlag (regInPlace regFlags)
Duncan Coutts's avatar
Duncan Coutts committed
122
123
124
125
126
    -- FIXME: there's really no guarantee this will work.
    -- registering into a totally different db stack can
    -- fail if dependencies cannot be satisfied.
    packageDbs = nub $ withPackageDB lbi
                    ++ maybeToList (flagToMaybe  (regPackageDB regFlags))
Duncan Coutts's avatar
Duncan Coutts committed
127
128
129
    distPref  = fromFlag (regDistPref regFlags)
    verbosity = fromFlag (regVerbosity regFlags)

130
    writeRegistrationFile installedPkgInfo = do
Duncan Coutts's avatar
Duncan Coutts committed
131
      notice verbosity ("Creating package registration file: " ++ regFile)
132
      writeUTF8File regFile (showInstalledPackageInfo installedPkgInfo)
Duncan Coutts's avatar
Duncan Coutts committed
133

134
    writeRegisterScript installedPkgInfo =
Duncan Coutts's avatar
Duncan Coutts committed
135
136
      case compilerFlavor (compiler lbi) of
        GHC  -> do (ghcPkg, _) <- requireProgram verbosity ghcPkgProgram (withPrograms lbi)
137
                   writeHcPkgRegisterScript verbosity installedPkgInfo ghcPkg packageDbs
Duncan Coutts's avatar
Duncan Coutts committed
138
        LHC  -> do (lhcPkg, _) <- requireProgram verbosity lhcPkgProgram (withPrograms lbi)
139
                   writeHcPkgRegisterScript verbosity installedPkgInfo lhcPkg packageDbs
Duncan Coutts's avatar
Duncan Coutts committed
140
        JHC  -> notice verbosity "Registration scripts not needed for jhc"
141
        UHC  -> notice verbosity "Registration scripts not needed for uhc"
Duncan Coutts's avatar
Duncan Coutts committed
142
143
144
145
146
147
148
        _    -> die "Registration scripts are not implemented for this compiler"

register _ _ regFlags = notice verbosity "No package to register"
  where
    verbosity = fromFlag (regVerbosity regFlags)


149
150
generateRegistrationInfo :: Verbosity
                         -> PackageDescription
Duncan Coutts's avatar
Duncan Coutts committed
151
152
153
154
155
156
                         -> Library
                         -> LocalBuildInfo
                         -> ComponentLocalBuildInfo
                         -> Bool
                         -> FilePath
                         -> IO InstalledPackageInfo
157
generateRegistrationInfo verbosity pkg lib lbi clbi inplace distPref = do
Duncan Coutts's avatar
Duncan Coutts committed
158
159
  --TODO: eliminate pwd!
  pwd <- getCurrentDirectory
160

161
162
  --TODO: the method of setting the InstalledPackageId is compiler specific
  --      this aspect should be delegated to a per-compiler helper.
163
  let comp = compiler lbi
164
165
166
167
168
169
170
  ipid <-
    case compilerFlavor comp of
     GHC | compilerVersion comp >= Version [6,11] [] -> do
            s <- GHC.libAbiHash verbosity pkg lbi lib clbi
            return (InstalledPackageId (display (packageId pkg) ++ '-':s))
     _other -> do
            return (InstalledPackageId (display (packageId pkg)))
171

Duncan Coutts's avatar
Duncan Coutts committed
172
173
  let installedPkgInfo
        | inplace   = inplaceInstalledPackageInfo pwd distPref
174
                        pkg ipid lib lbi clbi
Duncan Coutts's avatar
Duncan Coutts committed
175
        | otherwise = absoluteInstalledPackageInfo
176
                        pkg ipid lib lbi clbi
177

178
179
180
  return installedPkgInfo{ IPI.installedPackageId = ipid }


181
182
183
184
185
186
-- | Create an empty package DB at the specified location.
initPackageDB :: Verbosity -> Compiler -> ProgramConfiguration -> FilePath
                 -> IO ()
initPackageDB verbosity comp conf dbPath =
  case (compilerFlavor comp) of
    GHC -> GHC.initPackageDB verbosity conf dbPath
187
    HaskellSuite {} -> HaskellSuite.initPackageDB verbosity conf dbPath
refold's avatar
refold committed
188
189
190
191
192
193
194
195
196
197
198
199
    _   -> die "Distribution.Simple.Register.initPackageDB: \
               \not implemented for this compiler"

-- | Run @hc-pkg@ using a given package DB stack, directly forwarding the
-- provided command-line arguments to it.
invokeHcPkg :: Verbosity -> Compiler -> ProgramConfiguration -> PackageDBStack
                -> [String] -> IO ()
invokeHcPkg verbosity comp conf dbStack extraArgs =
    case (compilerFlavor comp) of
      GHC -> GHC.invokeHcPkg verbosity conf dbStack extraArgs
      _   -> die "Distribution.Simple.Register.invokeHcPkg: \
                 \not implemented for this compiler"
200

Duncan Coutts's avatar
Duncan Coutts committed
201
registerPackage :: Verbosity
202
                -> InstalledPackageInfo
Duncan Coutts's avatar
Duncan Coutts committed
203
204
205
                -> PackageDescription
                -> LocalBuildInfo
                -> Bool
206
                -> PackageDBStack
Duncan Coutts's avatar
Duncan Coutts committed
207
                -> IO ()
208
registerPackage verbosity installedPkgInfo pkg lbi inplace packageDbs = do
refold's avatar
refold committed
209
210
211
212
  let msg = if inplace
            then "In-place registering"
            else "Registering"
  setupMessage verbosity msg (packageId pkg)
Duncan Coutts's avatar
Duncan Coutts committed
213
  case compilerFlavor (compiler lbi) of
214
215
    GHC  -> GHC.registerPackage  verbosity installedPkgInfo pkg lbi inplace packageDbs
    LHC  -> LHC.registerPackage  verbosity installedPkgInfo pkg lbi inplace packageDbs
216
    UHC  -> UHC.registerPackage  verbosity installedPkgInfo pkg lbi inplace packageDbs
Duncan Coutts's avatar
Duncan Coutts committed
217
    JHC  -> notice verbosity "Registering for jhc (nothing to do)"
218
219
    HaskellSuite {} ->
      HaskellSuite.registerPackage verbosity installedPkgInfo pkg lbi inplace packageDbs
Duncan Coutts's avatar
Duncan Coutts committed
220
221
222
223
    _    -> die "Registering is not implemented for this compiler"


writeHcPkgRegisterScript :: Verbosity
224
                         -> InstalledPackageInfo
Duncan Coutts's avatar
Duncan Coutts committed
225
                         -> ConfiguredProgram
226
                         -> PackageDBStack
Duncan Coutts's avatar
Duncan Coutts committed
227
                         -> IO ()
228
writeHcPkgRegisterScript verbosity installedPkgInfo hcPkg packageDbs = do
Duncan Coutts's avatar
Duncan Coutts committed
229
  let invocation  = HcPkg.reregisterInvocation hcPkg Verbosity.normal
230
                      packageDbs (Right installedPkgInfo)
Duncan Coutts's avatar
Duncan Coutts committed
231
232
233
      regScript   = invocationAsSystemScript buildOS   invocation

  notice verbosity ("Creating package registration script: " ++ regScriptFileName)
234
  writeUTF8File regScriptFileName regScript
Duncan Coutts's avatar
Duncan Coutts committed
235
236
237
238
239
240
  setFileExecutable regScriptFileName

regScriptFileName :: FilePath
regScriptFileName = case buildOS of
                        Windows -> "register.bat"
                        _       -> "register.sh"
simonmar's avatar
simonmar committed
241

242

243
244
245
-- -----------------------------------------------------------------------------
-- Making the InstalledPackageInfo

Duncan Coutts's avatar
Duncan Coutts committed
246
247
248
249
250
251
252
-- | Construct 'InstalledPackageInfo' for a library in a package, given a set
-- of installation directories.
--
generalInstalledPackageInfo
  :: ([FilePath] -> [FilePath]) -- ^ Translate relative include dir paths to
                                -- absolute paths.
  -> PackageDescription
253
  -> InstalledPackageId
Duncan Coutts's avatar
Duncan Coutts committed
254
  -> Library
255
  -> LocalBuildInfo
Duncan Coutts's avatar
Duncan Coutts committed
256
257
258
  -> ComponentLocalBuildInfo
  -> InstallDirs FilePath
  -> InstalledPackageInfo
259
generalInstalledPackageInfo adjustRelIncDirs pkg ipid lib lbi clbi installDirs =
Duncan Coutts's avatar
Duncan Coutts committed
260
  InstalledPackageInfo {
261
    IPI.installedPackageId = ipid,
262
    IPI.sourcePackageId    = packageId   pkg,
263
    IPI.packageKey         = pkgKey lbi,
Duncan Coutts's avatar
Duncan Coutts committed
264
265
266
267
268
269
270
    IPI.license            = license     pkg,
    IPI.copyright          = copyright   pkg,
    IPI.maintainer         = maintainer  pkg,
    IPI.author             = author      pkg,
    IPI.stability          = stability   pkg,
    IPI.homepage           = homepage    pkg,
    IPI.pkgUrl             = pkgUrl      pkg,
271
    IPI.synopsis           = synopsis    pkg,
Duncan Coutts's avatar
Duncan Coutts committed
272
273
274
    IPI.description        = description pkg,
    IPI.category           = category    pkg,
    IPI.exposed            = libExposed  lib,
275
    IPI.exposedModules     = map fixupSelf (componentExposedModules clbi),
Duncan Coutts's avatar
Duncan Coutts committed
276
    IPI.hiddenModules      = otherModules bi,
277
    IPI.trusted            = IPI.trusted IPI.emptyInstalledPackageInfo,
Duncan Coutts's avatar
Duncan Coutts committed
278
    IPI.importDirs         = [ libdir installDirs | hasModules ],
279
280
    -- Note. the libsubdir and datasubdir templates have already been expanded
    -- into libdir and datadir.
Duncan Coutts's avatar
Duncan Coutts committed
281
282
283
    IPI.libraryDirs        = if hasLibrary
                               then libdir installDirs : extraLibDirs bi
                               else                      extraLibDirs bi,
284
    IPI.dataDir            = datadir installDirs,
refold's avatar
refold committed
285
    IPI.hsLibraries        = [ libname
286
287
                             | LibraryName libname <- componentLibraries clbi
                             , hasLibrary ],
Duncan Coutts's avatar
Duncan Coutts committed
288
    IPI.extraLibraries     = extraLibs bi,
289
    IPI.extraGHCiLibraries = extraGHCiLibs bi,
Duncan Coutts's avatar
Duncan Coutts committed
290
291
    IPI.includeDirs        = absinc ++ adjustRelIncDirs relinc,
    IPI.includes           = includes bi,
292
    IPI.depends            = map fst (componentPackageDeps clbi),
Duncan Coutts's avatar
Duncan Coutts committed
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
    IPI.ccOptions          = [], -- Note. NOT ccOptions bi!
                                 -- We don't want cc-options to be propagated
                                 -- to C compilations in other packages.
    IPI.ldOptions          = ldOptions bi,
    IPI.frameworkDirs      = [],
    IPI.frameworks         = frameworks bi,
    IPI.haddockInterfaces  = [haddockdir installDirs </> haddockName pkg],
    IPI.haddockHTMLs       = [htmldir installDirs]
  }
  where
    bi = libBuildInfo lib
    (absinc, relinc) = partition isAbsolute (includeDirs bi)
    hasModules = not $ null (exposedModules lib)
                    && null (otherModules bi)
    hasLibrary = hasModules || not (null (cSources bi))
308
309
    -- Since we currently don't decide the InstalledPackageId of our package
    -- until just before we register, we didn't have one for the re-exports
310
    -- of modules defined within this package, so we used an empty one that
311
312
    -- we fill in here now that we know what it is. It's a bit of a hack,
    -- we ought really to decide the InstalledPackageId ahead of time.
313
314
315
316
317
318
    fixupSelf (IPI.ExposedModule n o o') =
        IPI.ExposedModule n (fmap fixupOriginalModule o)
                            (fmap fixupOriginalModule o')
    fixupOriginalModule (IPI.OriginalModule i m) = IPI.OriginalModule (fixupIpid i) m
    fixupIpid (InstalledPackageId []) = ipid
    fixupIpid x = x
Duncan Coutts's avatar
Duncan Coutts committed
319

Ian D. Bollinger's avatar
Ian D. Bollinger committed
320
-- | Construct 'InstalledPackageInfo' for a library that is in place in the
Duncan Coutts's avatar
Duncan Coutts committed
321
322
-- build tree.
--
Ian D. Bollinger's avatar
Ian D. Bollinger committed
323
-- This function knows about the layout of in place packages.
Duncan Coutts's avatar
Duncan Coutts committed
324
325
326
327
--
inplaceInstalledPackageInfo :: FilePath -- ^ top of the build tree
                            -> FilePath -- ^ location of the dist tree
                            -> PackageDescription
328
                            -> InstalledPackageId
Duncan Coutts's avatar
Duncan Coutts committed
329
330
331
332
                            -> Library
                            -> LocalBuildInfo
                            -> ComponentLocalBuildInfo
                            -> InstalledPackageInfo
333
334
335
inplaceInstalledPackageInfo inplaceDir distPref pkg ipid lib lbi clbi =
    generalInstalledPackageInfo adjustRelativeIncludeDirs
                                pkg ipid lib lbi clbi installDirs
Duncan Coutts's avatar
Duncan Coutts committed
336
  where
refold's avatar
refold committed
337
    adjustRelativeIncludeDirs = map (inplaceDir </>)
Duncan Coutts's avatar
Duncan Coutts committed
338
    installDirs =
339
      (absoluteInstallDirs pkg lbi NoCopyDest) {
Duncan Coutts's avatar
Duncan Coutts committed
340
        libdir     = inplaceDir </> buildDir lbi,
341
        datadir    = inplaceDir </> dataDir pkg,
Duncan Coutts's avatar
Duncan Coutts committed
342
343
344
345
346
347
348
349
350
351
352
353
354
355
        docdir     = inplaceDocdir,
        htmldir    = inplaceHtmldir,
        haddockdir = inplaceHtmldir
      }
    inplaceDocdir  = inplaceDir </> distPref </> "doc"
    inplaceHtmldir = inplaceDocdir </> "html" </> display (packageName pkg)


-- | Construct 'InstalledPackageInfo' for the final install location of a
-- library package.
--
-- This function knows about the layout of installed packages.
--
absoluteInstalledPackageInfo :: PackageDescription
356
                             -> InstalledPackageId
Duncan Coutts's avatar
Duncan Coutts committed
357
358
359
360
                             -> Library
                             -> LocalBuildInfo
                             -> ComponentLocalBuildInfo
                             -> InstalledPackageInfo
361
362
363
absoluteInstalledPackageInfo pkg ipid lib lbi clbi =
    generalInstalledPackageInfo adjustReativeIncludeDirs
                                pkg ipid lib lbi clbi installDirs
Duncan Coutts's avatar
Duncan Coutts committed
364
365
366
367
368
369
370
  where
    -- For installed packages we install all include files into one dir,
    -- whereas in the build tree they may live in multiple local dirs.
    adjustReativeIncludeDirs _
      | null (installIncludes bi) = []
      | otherwise                 = [includedir installDirs]
    bi = libBuildInfo lib
371
    installDirs = absoluteInstallDirs pkg lbi NoCopyDest
Duncan Coutts's avatar
Duncan Coutts committed
372

simonmar's avatar
simonmar committed
373
374
-- -----------------------------------------------------------------------------
-- Unregistration
375

ijones's avatar
ijones committed
376
unregister :: PackageDescription -> LocalBuildInfo -> RegisterFlags -> IO ()
Duncan Coutts's avatar
Duncan Coutts committed
377
378
379
unregister pkg lbi regFlags = do
  let pkgid     = packageId pkg
      genScript = fromFlag (regGenScript regFlags)
380
      verbosity = fromFlag (regVerbosity regFlags)
Duncan Coutts's avatar
Duncan Coutts committed
381
      packageDb = fromFlagOrDefault (registrationPackageDB (withPackageDB lbi))
382
                                    (regPackageDB regFlags)
Duncan Coutts's avatar
Duncan Coutts committed
383
  setupMessage verbosity "Unregistering" pkgid
384
  case compilerFlavor (compiler lbi) of
Duncan Coutts's avatar
Duncan Coutts committed
385
386
387
388
389
390
    GHC ->
      let Just ghcPkg = lookupProgram ghcPkgProgram (withPrograms lbi)
          invocation = HcPkg.unregisterInvocation ghcPkg Verbosity.normal
                         packageDb pkgid
      in if genScript
           then writeFileAtomic unregScriptFileName
391
                  (BS.Char8.pack $ invocationAsSystemScript buildOS invocation)
Duncan Coutts's avatar
Duncan Coutts committed
392
            else runProgramInvocation verbosity invocation
ijones's avatar
ijones committed
393
    _ ->
394
        die ("unregistering is only implemented for GHC")
ijones's avatar
ijones committed
395

Duncan Coutts's avatar
Duncan Coutts committed
396
397
398
399
unregScriptFileName :: FilePath
unregScriptFileName = case buildOS of
                          Windows -> "unregister.bat"
                          _       -> "unregister.sh"