Register.hs 22.6 KB
Newer Older
1
{-# LANGUAGE PatternGuards #-}
2 3
-----------------------------------------------------------------------------
-- |
ijones's avatar
ijones committed
4
-- Module      :  Distribution.Simple.Register
5
-- Copyright   :  Isaac Jones 2003-2004
6
-- License     :  BSD3
7
--
Duncan Coutts's avatar
Duncan Coutts committed
8
-- Maintainer  :  cabal-devel@haskell.org
ijones's avatar
ijones committed
9
-- Portability :  portable
10
--
Duncan Coutts's avatar
Duncan Coutts committed
11 12 13 14 15 16 17 18
-- 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
19
-- or alternatively to register the package in place in the build tree. The
Duncan Coutts's avatar
Duncan Coutts committed
20 21 22 23 24 25
-- 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.
26

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

31
    internalPackageDBPath,
32
    createInternalPackageDB,
33

34
    initPackageDB,
35 36 37 38
    doesPackageDBExist,
    createPackageDB,
    deletePackageDB,

refold's avatar
refold committed
39
    invokeHcPkg,
Duncan Coutts's avatar
Duncan Coutts committed
40
    registerPackage,
41
    generateRegistrationInfo,
Duncan Coutts's avatar
Duncan Coutts committed
42 43 44
    inplaceInstalledPackageInfo,
    absoluteInstalledPackageInfo,
    generalInstalledPackageInfo,
45
  ) where
46

47
import Distribution.Simple.LocalBuildInfo
48
import Distribution.Simple.BuildPaths
49 50 51 52 53

import qualified Distribution.Simple.GHC   as GHC
import qualified Distribution.Simple.GHCJS as GHCJS
import qualified Distribution.Simple.LHC   as LHC
import qualified Distribution.Simple.UHC   as UHC
54
import qualified Distribution.Simple.HaskellSuite as HaskellSuite
55

56
import Distribution.Simple.Compiler
Duncan Coutts's avatar
Duncan Coutts committed
57 58 59
import Distribution.Simple.Program
import Distribution.Simple.Program.Script
import qualified Distribution.Simple.Program.HcPkg as HcPkg
60
import Distribution.Simple.Setup
Duncan Coutts's avatar
Duncan Coutts committed
61
import Distribution.PackageDescription
62
import Distribution.Package
63
import qualified Distribution.InstalledPackageInfo as IPI
64
import Distribution.InstalledPackageInfo (InstalledPackageInfo)
65
import Distribution.Simple.Utils
66
import Distribution.System
67
import Distribution.Text
Duncan Coutts's avatar
Duncan Coutts committed
68
import Distribution.Verbosity as Verbosity
69

70
import System.FilePath ((</>), (<.>), isAbsolute)
Duncan Coutts's avatar
Duncan Coutts committed
71
import System.Directory
ijones's avatar
ijones committed
72

73
import Data.Version
74
import Control.Monad
Duncan Coutts's avatar
Duncan Coutts committed
75
import Data.Maybe
Duncan Coutts's avatar
Duncan Coutts committed
76
import Data.List
77
import qualified Data.ByteString.Lazy.Char8 as BS.Char8
78

simonmar's avatar
simonmar committed
79 80 81
-- -----------------------------------------------------------------------------
-- Registration

ijones's avatar
ijones committed
82
register :: PackageDescription -> LocalBuildInfo
ijones's avatar
ijones committed
83
         -> RegisterFlags -- ^Install in the user's database?; verbose
ijones's avatar
ijones committed
84
         -> IO ()
85 86 87 88 89
register pkg lbi regFlags =
    -- We do NOT register libraries outside of the inplace database
    -- if there is no public library, since no one else can use it
    -- usefully (they're not public.)  If we start supporting scoped
    -- packages, we'll have to relax this.
90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105
    when (hasPublicLib pkg) $ do
        -- It's important to register in build order, because ghc-pkg
        -- will complain if a dependency is not registered.
        let maybeGenerateOne clbi
                | CLib lib <- getLocalComponent pkg clbi
                = fmap Just (generateOne pkg lib lbi clbi regFlags)
                | otherwise = return Nothing
        ipis <- fmap catMaybes
              $ mapM maybeGenerateOne (allComponentsInBuildOrder lbi)
        registerAll pkg lbi regFlags ipis
        return ()

generateOne :: PackageDescription -> Library -> LocalBuildInfo -> ComponentLocalBuildInfo
            -> RegisterFlags
            -> IO InstalledPackageInfo
generateOne pkg lib lbi clbi regFlags
106
  = do
107
    absPackageDBs    <- absolutePackageDBPaths packageDbs
108
    installedPkgInfo <- generateRegistrationInfo
109
                           verbosity pkg lib lbi clbi inplace reloc distPref
110
                           (registrationPackageDB absPackageDBs)
111
    info verbosity (IPI.showInstalledPackageInfo installedPkgInfo)
112 113 114 115 116 117 118 119 120 121 122
    return installedPkgInfo
  where
    inplace   = fromFlag (regInPlace regFlags)
    reloc     = relocatable lbi
    -- 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))
    distPref  = fromFlag (regDistPref regFlags)
    verbosity = fromFlag (regVerbosity regFlags)
123

124 125 126 127 128
registerAll :: PackageDescription -> LocalBuildInfo -> RegisterFlags
            -> [InstalledPackageInfo]
            -> IO ()
registerAll pkg lbi regFlags ipis
  = do
129
    when (fromFlag (regPrintId regFlags)) $ do
130 131 132 133
      forM_ ipis $ \installedPkgInfo ->
        -- Only print the public library's IPI
        when (IPI.sourcePackageId installedPkgInfo == packageId pkg) $
          putStrLn (display (IPI.installedUnitId installedPkgInfo))
134

135 136
     -- Three different modes:
    case () of
137 138
     _ | modeGenerateRegFile   -> writeRegistrationFileOrDirectory
       | modeGenerateRegScript -> writeRegisterScript
139 140
       | otherwise             -> do
           setupMessage verbosity "Registering" (packageId pkg)
141 142 143
           forM_ ipis $ \installedPkgInfo ->
               registerPackage verbosity (compiler lbi) (withPrograms lbi)
                               HcPkg.NoMultiInstance packageDbs installedPkgInfo
Duncan Coutts's avatar
Duncan Coutts committed
144 145 146 147 148 149 150 151

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

    modeGenerateRegScript = fromFlag (regGenScript regFlags)

Duncan Coutts's avatar
Duncan Coutts committed
152 153 154 155 156
    -- 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
157 158
    verbosity = fromFlag (regVerbosity regFlags)

159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178
    writeRegistrationFileOrDirectory = do
      -- Handles overwriting both directory and file
      deletePackageDB regFile
      case ipis of
        [installedPkgInfo] -> do
          notice verbosity ("Creating package registration file: " ++ regFile)
          writeUTF8File regFile (IPI.showInstalledPackageInfo installedPkgInfo)
        _ -> do
          notice verbosity ("Creating package registration directory: " ++ regFile)
          createDirectory regFile
          let num_ipis = length ipis
              lpad m xs = replicate (m - length ys) '0' ++ ys
                  where ys = take m xs
              number i = lpad (length (show num_ipis)) (show i)
          forM_ (zip ([1..] :: [Int]) ipis) $ \(i, installedPkgInfo) ->
            -- TODO: This will need a hashUnitId when Backpack comes.
            writeUTF8File (regFile </> (number i ++ "-" ++ display (IPI.installedUnitId installedPkgInfo)))
                          (IPI.showInstalledPackageInfo installedPkgInfo)

    writeRegisterScript =
Duncan Coutts's avatar
Duncan Coutts committed
179
      case compilerFlavor (compiler lbi) of
180 181 182 183 184
        JHC -> notice verbosity "Registration scripts not needed for jhc"
        UHC -> notice verbosity "Registration scripts not needed for uhc"
        _   -> withHcPkg
               "Registration scripts are not implemented for this compiler"
               (compiler lbi) (withPrograms lbi)
185
               (writeHcPkgRegisterScript verbosity ipis packageDbs)
Duncan Coutts's avatar
Duncan Coutts committed
186 187


188 189
generateRegistrationInfo :: Verbosity
                         -> PackageDescription
Duncan Coutts's avatar
Duncan Coutts committed
190 191 192 193
                         -> Library
                         -> LocalBuildInfo
                         -> ComponentLocalBuildInfo
                         -> Bool
194
                         -> Bool
Duncan Coutts's avatar
Duncan Coutts committed
195
                         -> FilePath
196
                         -> PackageDB
Duncan Coutts's avatar
Duncan Coutts committed
197
                         -> IO InstalledPackageInfo
198
generateRegistrationInfo verbosity pkg lib lbi clbi inplace reloc distPref packageDb = do
Duncan Coutts's avatar
Duncan Coutts committed
199 200
  --TODO: eliminate pwd!
  pwd <- getCurrentDirectory
201

202
  --TODO: the method of setting the UnitId is compiler specific
203
  --      this aspect should be delegated to a per-compiler helper.
204
  let comp = compiler lbi
205 206 207 208
      lbi' = lbi {
                withPackageDB = withPackageDB lbi
                    ++ [SpecificPackageDB (internalPackageDBPath lbi distPref)]
             }
209
  abi_hash <-
210 211
    case compilerFlavor comp of
     GHC | compilerVersion comp >= Version [6,11] [] -> do
212
            fmap AbiHash $ GHC.libAbiHash verbosity pkg lbi' lib clbi
213
     GHCJS -> do
214
            fmap AbiHash $ GHCJS.libAbiHash verbosity pkg lbi' lib clbi
215
     _ -> return (AbiHash "")
216

Christiaan Baaij's avatar
Christiaan Baaij committed
217 218 219
  installedPkgInfo <-
    if inplace
      then return (inplaceInstalledPackageInfo pwd distPref
220
                     pkg abi_hash lib lbi clbi)
Christiaan Baaij's avatar
Christiaan Baaij committed
221 222
    else if reloc
      then relocRegistrationInfo verbosity
223
                     pkg lib lbi clbi abi_hash packageDb
Christiaan Baaij's avatar
Christiaan Baaij committed
224
      else return (absoluteInstalledPackageInfo
225
                     pkg abi_hash lib lbi clbi)
226

227

228
  return installedPkgInfo{ IPI.abiHash = abi_hash }
229

230 231 232 233 234
relocRegistrationInfo :: Verbosity
                      -> PackageDescription
                      -> Library
                      -> LocalBuildInfo
                      -> ComponentLocalBuildInfo
235
                      -> AbiHash
236 237
                      -> PackageDB
                      -> IO InstalledPackageInfo
238
relocRegistrationInfo verbosity pkg lib lbi clbi abi_hash packageDb =
239
  case (compilerFlavor (compiler lbi)) of
240 241
    GHC -> do fs <- GHC.pkgRoot verbosity lbi packageDb
              return (relocatableInstalledPackageInfo
242
                        pkg abi_hash lib lbi clbi fs)
243 244
    _   -> die "Distribution.Simple.Register.relocRegistrationInfo: \
               \not implemented for this compiler"
245

246 247
initPackageDB :: Verbosity -> Compiler -> ProgramConfiguration -> FilePath -> IO ()
initPackageDB verbosity comp progdb dbPath =
248
    createPackageDB verbosity comp progdb False dbPath
249

250
-- | Create an empty package DB at the specified location.
251 252 253 254 255 256 257 258 259 260 261 262
createPackageDB :: Verbosity -> Compiler -> ProgramConfiguration -> Bool
                -> FilePath -> IO ()
createPackageDB verbosity comp progdb preferCompat dbPath =
    case compilerFlavor comp of
      GHC   -> HcPkg.init (GHC.hcPkgInfo   progdb) verbosity preferCompat dbPath
      GHCJS -> HcPkg.init (GHCJS.hcPkgInfo progdb) verbosity False dbPath
      LHC   -> HcPkg.init (LHC.hcPkgInfo   progdb) verbosity False dbPath
      UHC   -> return ()
      HaskellSuite _ -> HaskellSuite.initPackageDB verbosity progdb dbPath
      _              -> die $ "Distribution.Simple.Register.createPackageDB: "
                           ++ "not implemented for this compiler"

263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278
doesPackageDBExist :: FilePath -> IO Bool
doesPackageDBExist dbPath = do
    -- currently one impl for all compiler flavours, but could change if needed
    dir_exists <- doesDirectoryExist dbPath
    if dir_exists
        then return True
        else doesFileExist dbPath

deletePackageDB :: FilePath -> IO ()
deletePackageDB dbPath = do
    -- currently one impl for all compiler flavours, but could change if needed
    dir_exists <- doesDirectoryExist dbPath
    if dir_exists
        then removeDirectoryRecursive dbPath
        else do file_exists <- doesFileExist dbPath
                when file_exists $ removeFile dbPath
refold's avatar
refold committed
279 280 281 282 283 284

-- | 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 =
285 286 287 288
  withHcPkg "invokeHcPkg" comp conf
    (\hpi -> HcPkg.invoke hpi verbosity dbStack extraArgs)

withHcPkg :: String -> Compiler -> ProgramConfiguration
289
          -> (HcPkg.HcPkgInfo -> IO a) -> IO a
290 291 292 293 294 295 296
withHcPkg name comp conf f =
  case compilerFlavor comp of
    GHC   -> f (GHC.hcPkgInfo conf)
    GHCJS -> f (GHCJS.hcPkgInfo conf)
    LHC   -> f (LHC.hcPkgInfo conf)
    _     -> die ("Distribution.Simple.Register." ++ name ++ ":\
                  \not implemented for this compiler")
297

Duncan Coutts's avatar
Duncan Coutts committed
298
registerPackage :: Verbosity
299 300
                -> Compiler
                -> ProgramConfiguration
301
                -> HcPkg.MultiInstance
302
                -> PackageDBStack
303
                -> InstalledPackageInfo
Duncan Coutts's avatar
Duncan Coutts committed
304
                -> IO ()
305
registerPackage verbosity comp progdb multiInstance packageDbs installedPkgInfo =
306
  case compilerFlavor comp of
307 308
    GHC   -> GHC.registerPackage   verbosity progdb multiInstance packageDbs installedPkgInfo
    GHCJS -> GHCJS.registerPackage verbosity progdb multiInstance packageDbs installedPkgInfo
309
    _ | HcPkg.MultiInstance == multiInstance
310
          -> die "Registering multiple package instances is not yet supported for this compiler"
311 312
    LHC   -> LHC.registerPackage   verbosity      progdb packageDbs installedPkgInfo
    UHC   -> UHC.registerPackage   verbosity comp progdb packageDbs installedPkgInfo
313
    JHC   -> notice verbosity "Registering for jhc (nothing to do)"
314
    HaskellSuite {} ->
315
      HaskellSuite.registerPackage verbosity      progdb packageDbs installedPkgInfo
Duncan Coutts's avatar
Duncan Coutts committed
316 317 318
    _    -> die "Registering is not implemented for this compiler"

writeHcPkgRegisterScript :: Verbosity
319
                         -> [InstalledPackageInfo]
320
                         -> PackageDBStack
321
                         -> HcPkg.HcPkgInfo
Duncan Coutts's avatar
Duncan Coutts committed
322
                         -> IO ()
323 324 325 326 327 328 329 330
writeHcPkgRegisterScript verbosity ipis packageDbs hpi = do
  let genScript installedPkgInfo =
          let invocation  = HcPkg.reregisterInvocation hpi Verbosity.normal
                              packageDbs (Right installedPkgInfo)
          in invocationAsSystemScript buildOS invocation
      scripts = map genScript ipis
      -- TODO: Do something more robust here
      regScript = unlines scripts
Duncan Coutts's avatar
Duncan Coutts committed
331 332

  notice verbosity ("Creating package registration script: " ++ regScriptFileName)
333
  writeUTF8File regScriptFileName regScript
Duncan Coutts's avatar
Duncan Coutts committed
334 335 336 337 338 339
  setFileExecutable regScriptFileName

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

341

342 343 344
-- -----------------------------------------------------------------------------
-- Making the InstalledPackageInfo

Duncan Coutts's avatar
Duncan Coutts committed
345 346 347 348 349 350 351
-- | 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
352
  -> AbiHash
Duncan Coutts's avatar
Duncan Coutts committed
353
  -> Library
354
  -> LocalBuildInfo
Duncan Coutts's avatar
Duncan Coutts committed
355 356 357
  -> ComponentLocalBuildInfo
  -> InstallDirs FilePath
  -> InstalledPackageInfo
358
generalInstalledPackageInfo adjustRelIncDirs pkg abi_hash lib lbi clbi installDirs =
359
  IPI.InstalledPackageInfo {
360 361 362
    IPI.sourcePackageId    = (packageId   pkg) {
                                pkgName = componentCompatPackageName clbi
                             },
363
    IPI.installedUnitId    = componentUnitId clbi,
364
    IPI.compatPackageKey   = componentCompatPackageKey clbi,
Duncan Coutts's avatar
Duncan Coutts committed
365 366 367 368 369 370 371
    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,
372
    IPI.synopsis           = synopsis    pkg,
Duncan Coutts's avatar
Duncan Coutts committed
373 374
    IPI.description        = description pkg,
    IPI.category           = category    pkg,
375
    IPI.abiHash            = abi_hash,
Duncan Coutts's avatar
Duncan Coutts committed
376
    IPI.exposed            = libExposed  lib,
377
    IPI.exposedModules     = componentExposedModules clbi,
Duncan Coutts's avatar
Duncan Coutts committed
378
    IPI.hiddenModules      = otherModules bi,
379
    IPI.trusted            = IPI.trusted IPI.emptyInstalledPackageInfo,
Duncan Coutts's avatar
Duncan Coutts committed
380
    IPI.importDirs         = [ libdir installDirs | hasModules ],
381 382
    -- Note. the libsubdir and datasubdir templates have already been expanded
    -- into libdir and datadir.
Duncan Coutts's avatar
Duncan Coutts committed
383 384 385
    IPI.libraryDirs        = if hasLibrary
                               then libdir installDirs : extraLibDirs bi
                               else                      extraLibDirs bi,
386
    IPI.dataDir            = datadir installDirs,
387
    IPI.hsLibraries        = if hasLibrary
388
                               then [getHSLibraryName (componentUnitId clbi)]
389
                               else [],
Duncan Coutts's avatar
Duncan Coutts committed
390
    IPI.extraLibraries     = extraLibs bi,
391
    IPI.extraGHCiLibraries = extraGHCiLibs bi,
Duncan Coutts's avatar
Duncan Coutts committed
392 393
    IPI.includeDirs        = absinc ++ adjustRelIncDirs relinc,
    IPI.includes           = includes bi,
394
    IPI.depends            = map fst (componentPackageDeps clbi),
Duncan Coutts's avatar
Duncan Coutts committed
395 396 397 398 399
    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.frameworks         = frameworks bi,
400
    IPI.frameworkDirs      = extraFrameworkDirs bi,
Duncan Coutts's avatar
Duncan Coutts committed
401
    IPI.haddockInterfaces  = [haddockdir installDirs </> haddockName pkg],
402 403
    IPI.haddockHTMLs       = [htmldir installDirs],
    IPI.pkgRoot            = Nothing
Duncan Coutts's avatar
Duncan Coutts committed
404 405 406 407
  }
  where
    bi = libBuildInfo lib
    (absinc, relinc) = partition isAbsolute (includeDirs bi)
408
    hasModules = not $ null (libModules lib)
Duncan Coutts's avatar
Duncan Coutts committed
409
    hasLibrary = hasModules || not (null (cSources bi))
410 411 412
                            || (not (null (jsSources bi)) &&
                                compilerFlavor (compiler lbi) == GHCJS)

Ian D. Bollinger's avatar
Ian D. Bollinger committed
413
-- | Construct 'InstalledPackageInfo' for a library that is in place in the
Duncan Coutts's avatar
Duncan Coutts committed
414 415
-- build tree.
--
Ian D. Bollinger's avatar
Ian D. Bollinger committed
416
-- This function knows about the layout of in place packages.
Duncan Coutts's avatar
Duncan Coutts committed
417 418 419 420
--
inplaceInstalledPackageInfo :: FilePath -- ^ top of the build tree
                            -> FilePath -- ^ location of the dist tree
                            -> PackageDescription
421
                            -> AbiHash
Duncan Coutts's avatar
Duncan Coutts committed
422 423 424 425
                            -> Library
                            -> LocalBuildInfo
                            -> ComponentLocalBuildInfo
                            -> InstalledPackageInfo
426
inplaceInstalledPackageInfo inplaceDir distPref pkg abi_hash lib lbi clbi =
427
    generalInstalledPackageInfo adjustRelativeIncludeDirs
428
                                pkg abi_hash lib lbi clbi installDirs
Duncan Coutts's avatar
Duncan Coutts committed
429
  where
refold's avatar
refold committed
430
    adjustRelativeIncludeDirs = map (inplaceDir </>)
431
    libTargetDir = componentBuildDir lbi clbi
Duncan Coutts's avatar
Duncan Coutts committed
432
    installDirs =
433
      (absoluteComponentInstallDirs pkg lbi (componentUnitId clbi) NoCopyDest) {
434
        libdir     = inplaceDir </> libTargetDir,
435
        datadir    = inplaceDir </> dataDir pkg,
Duncan Coutts's avatar
Duncan Coutts committed
436 437 438 439 440 441 442 443 444 445 446 447 448 449
        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
450
                             -> AbiHash
Duncan Coutts's avatar
Duncan Coutts committed
451 452 453 454
                             -> Library
                             -> LocalBuildInfo
                             -> ComponentLocalBuildInfo
                             -> InstalledPackageInfo
455
absoluteInstalledPackageInfo pkg abi_hash lib lbi clbi =
456
    generalInstalledPackageInfo adjustReativeIncludeDirs
457
                                pkg abi_hash lib lbi clbi installDirs
Duncan Coutts's avatar
Duncan Coutts committed
458 459 460 461 462 463 464
  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
465
    installDirs = absoluteComponentInstallDirs pkg lbi (componentUnitId clbi) NoCopyDest
Duncan Coutts's avatar
Duncan Coutts committed
466

467 468

relocatableInstalledPackageInfo :: PackageDescription
469
                                -> AbiHash
470 471 472
                                -> Library
                                -> LocalBuildInfo
                                -> ComponentLocalBuildInfo
473
                                -> FilePath
474
                                -> InstalledPackageInfo
475
relocatableInstalledPackageInfo pkg abi_hash lib lbi clbi pkgroot =
476
    generalInstalledPackageInfo adjustReativeIncludeDirs
477
                                pkg abi_hash lib lbi clbi installDirs
478 479 480 481 482 483 484
  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
485 486

    installDirs = fmap (("${pkgroot}" </>) . shortRelativePath pkgroot)
487
                $ absoluteComponentInstallDirs pkg lbi (componentUnitId clbi) NoCopyDest
488

simonmar's avatar
simonmar committed
489 490
-- -----------------------------------------------------------------------------
-- Unregistration
491

ijones's avatar
ijones committed
492
unregister :: PackageDescription -> LocalBuildInfo -> RegisterFlags -> IO ()
Duncan Coutts's avatar
Duncan Coutts committed
493 494 495
unregister pkg lbi regFlags = do
  let pkgid     = packageId pkg
      genScript = fromFlag (regGenScript regFlags)
496
      verbosity = fromFlag (regVerbosity regFlags)
Duncan Coutts's avatar
Duncan Coutts committed
497
      packageDb = fromFlagOrDefault (registrationPackageDB (withPackageDB lbi))
498
                                    (regPackageDB regFlags)
499 500 501 502 503 504 505
      unreg hpi =
        let invocation = HcPkg.unregisterInvocation
                           hpi Verbosity.normal packageDb pkgid
        in if genScript
             then writeFileAtomic unregScriptFileName
                    (BS.Char8.pack $ invocationAsSystemScript buildOS invocation)
             else runProgramInvocation verbosity invocation
Duncan Coutts's avatar
Duncan Coutts committed
506
  setupMessage verbosity "Unregistering" pkgid
507 508
  withHcPkg "unregistering is only implemented for GHC and GHCJS"
    (compiler lbi) (withPrograms lbi) unreg
ijones's avatar
ijones committed
509

Duncan Coutts's avatar
Duncan Coutts committed
510 511 512 513
unregScriptFileName :: FilePath
unregScriptFileName = case buildOS of
                          Windows -> "unregister.bat"
                          _       -> "unregister.sh"
514 515 516 517 518 519

internalPackageDBPath :: LocalBuildInfo -> FilePath -> FilePath
internalPackageDBPath lbi distPref =
      case compilerFlavor (compiler lbi) of
        UHC -> UHC.inplacePackageDbPath lbi
        _   -> distPref </> "package.conf.inplace"
520 521 522 523 524 525 526 527 528 529 530 531

-- | Initialize a new package db file for libraries defined
-- internally to the package.
createInternalPackageDB :: Verbosity -> LocalBuildInfo -> FilePath
                        -> IO PackageDB
createInternalPackageDB verbosity lbi distPref = do
    existsAlready <- doesPackageDBExist dbPath
    when existsAlready $ deletePackageDB dbPath
    createPackageDB verbosity (compiler lbi) (withPrograms lbi) False dbPath
    return (SpecificPackageDB dbPath)
  where
    dbPath = internalPackageDBPath lbi distPref