Register.hs 23.5 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 48 49
import Prelude ()
import Distribution.Compat.Prelude

50 51 52
import Distribution.Types.TargetInfo
import Distribution.Types.LocalBuildInfo

53
import Distribution.Simple.LocalBuildInfo
54
import Distribution.Simple.BuildPaths
55 56 57 58 59

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
60
import qualified Distribution.Simple.HaskellSuite as HaskellSuite
61

62
import Distribution.Simple.BuildTarget
63
import Distribution.Simple.Compiler
Duncan Coutts's avatar
Duncan Coutts committed
64 65 66
import Distribution.Simple.Program
import Distribution.Simple.Program.Script
import qualified Distribution.Simple.Program.HcPkg as HcPkg
67
import Distribution.Simple.Setup
Duncan Coutts's avatar
Duncan Coutts committed
68
import Distribution.PackageDescription
69
import Distribution.Package
70
import qualified Distribution.InstalledPackageInfo as IPI
71
import Distribution.InstalledPackageInfo (InstalledPackageInfo)
72
import Distribution.Simple.Utils
73
import Distribution.System
74
import Distribution.Text
Duncan Coutts's avatar
Duncan Coutts committed
75
import Distribution.Verbosity as Verbosity
76
import Distribution.Compat.Graph (IsNode(nodeKey))
77

78
import System.FilePath ((</>), (<.>), isAbsolute)
Duncan Coutts's avatar
Duncan Coutts committed
79
import System.Directory
ijones's avatar
ijones committed
80

81
import Data.Version
82
import Data.List (partition)
83
import qualified Data.ByteString.Lazy.Char8 as BS.Char8
84

simonmar's avatar
simonmar committed
85 86 87
-- -----------------------------------------------------------------------------
-- Registration

ijones's avatar
ijones committed
88
register :: PackageDescription -> LocalBuildInfo
ijones's avatar
ijones committed
89
         -> RegisterFlags -- ^Install in the user's database?; verbose
ijones's avatar
ijones committed
90
         -> IO ()
91 92 93 94 95 96
register pkg_descr lbi flags =
   -- Duncan originally asked for us to not register/install files
   -- when there was no public library.  But with per-component
   -- configure, we legitimately need to install internal libraries
   -- so that we can get them.  So just unconditionally install.
   doRegister
97 98
 where
  doRegister = do
99
    targets <- readTargetInfos verbosity pkg_descr lbi (regArgs flags)
100 101 102

    -- It's important to register in build order, because ghc-pkg
    -- will complain if a dependency is not registered.
103 104
    let maybeGenerateOne target
            | CLib lib <- targetComponent target
105 106
            = fmap Just (generateOne pkg_descr lib lbi clbi flags)
            | otherwise = return Nothing
107
          where clbi = targetCLBI target
108 109 110 111

    ipis <-
      if fromFlag (regAssumeDepsUpToDate flags)
        then
112 113 114
          case targets of
            [target] -> do
                mb_ipi <- maybeGenerateOne target
115 116 117 118 119 120
                case mb_ipi of
                    Nothing -> die "Cannot --assume-deps-up-to-date register non-library target"
                    Just ipi -> return [ipi]
            [] -> die "In --assume-deps-up-to-date mode you must specify a target"
            _ -> die "In --assume-deps-up-to-date mode you can only register a single target"
        else fmap catMaybes
121
           . traverse maybeGenerateOne
122
           $ neededTargetsInBuildOrder' pkg_descr lbi (map nodeKey targets)
123 124 125 126
    registerAll pkg_descr lbi flags ipis
    return ()
   where
    verbosity = fromFlag (regVerbosity flags)
127 128 129 130 131

generateOne :: PackageDescription -> Library -> LocalBuildInfo -> ComponentLocalBuildInfo
            -> RegisterFlags
            -> IO InstalledPackageInfo
generateOne pkg lib lbi clbi regFlags
132
  = do
133
    absPackageDBs    <- absolutePackageDBPaths packageDbs
134
    installedPkgInfo <- generateRegistrationInfo
135
                           verbosity pkg lib lbi clbi inplace reloc distPref
136
                           (registrationPackageDB absPackageDBs)
137
    info verbosity (IPI.showInstalledPackageInfo installedPkgInfo)
138 139 140 141 142 143 144 145 146 147 148
    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)
149

150 151 152 153 154
registerAll :: PackageDescription -> LocalBuildInfo -> RegisterFlags
            -> [InstalledPackageInfo]
            -> IO ()
registerAll pkg lbi regFlags ipis
  = do
155
    when (fromFlag (regPrintId regFlags)) $ do
156
      for_ ipis $ \installedPkgInfo ->
157 158 159
        -- Only print the public library's IPI
        when (IPI.sourcePackageId installedPkgInfo == packageId pkg) $
          putStrLn (display (IPI.installedUnitId installedPkgInfo))
160

161 162
     -- Three different modes:
    case () of
163 164
     _ | modeGenerateRegFile   -> writeRegistrationFileOrDirectory
       | modeGenerateRegScript -> writeRegisterScript
165 166
       | otherwise             -> do
           setupMessage verbosity "Registering" (packageId pkg)
167
           for_ ipis $ \installedPkgInfo ->
168 169
               registerPackage verbosity (compiler lbi) (withPrograms lbi)
                               HcPkg.NoMultiInstance packageDbs installedPkgInfo
Duncan Coutts's avatar
Duncan Coutts committed
170 171 172 173 174 175 176 177

  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
178 179 180 181 182
    -- 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
183 184
    verbosity = fromFlag (regVerbosity regFlags)

185 186 187 188 189
    writeRegistrationFileOrDirectory = do
      -- Handles overwriting both directory and file
      deletePackageDB regFile
      case ipis of
        [installedPkgInfo] -> do
190
          info verbosity ("Creating package registration file: " ++ regFile)
191 192
          writeUTF8File regFile (IPI.showInstalledPackageInfo installedPkgInfo)
        _ -> do
193
          info verbosity ("Creating package registration directory: " ++ regFile)
194 195 196 197 198
          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)
199
          for_ (zip ([1..] :: [Int]) ipis) $ \(i, installedPkgInfo) ->
200 201 202 203 204
            -- 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
205
      case compilerFlavor (compiler lbi) of
206 207 208 209 210
        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)
211
               (writeHcPkgRegisterScript verbosity ipis packageDbs)
Duncan Coutts's avatar
Duncan Coutts committed
212 213


214 215
generateRegistrationInfo :: Verbosity
                         -> PackageDescription
Duncan Coutts's avatar
Duncan Coutts committed
216 217 218 219
                         -> Library
                         -> LocalBuildInfo
                         -> ComponentLocalBuildInfo
                         -> Bool
220
                         -> Bool
Duncan Coutts's avatar
Duncan Coutts committed
221
                         -> FilePath
222
                         -> PackageDB
Duncan Coutts's avatar
Duncan Coutts committed
223
                         -> IO InstalledPackageInfo
224
generateRegistrationInfo verbosity pkg lib lbi clbi inplace reloc distPref packageDb = do
Duncan Coutts's avatar
Duncan Coutts committed
225 226
  --TODO: eliminate pwd!
  pwd <- getCurrentDirectory
227

228
  --TODO: the method of setting the UnitId is compiler specific
229
  --      this aspect should be delegated to a per-compiler helper.
230
  let comp = compiler lbi
231 232 233 234
      lbi' = lbi {
                withPackageDB = withPackageDB lbi
                    ++ [SpecificPackageDB (internalPackageDBPath lbi distPref)]
             }
235
  abi_hash <-
236 237
    case compilerFlavor comp of
     GHC | compilerVersion comp >= Version [6,11] [] -> do
238
            fmap AbiHash $ GHC.libAbiHash verbosity pkg lbi' lib clbi
239
     GHCJS -> do
240
            fmap AbiHash $ GHCJS.libAbiHash verbosity pkg lbi' lib clbi
241
     _ -> return (AbiHash "")
242

Christiaan Baaij's avatar
Christiaan Baaij committed
243 244 245
  installedPkgInfo <-
    if inplace
      then return (inplaceInstalledPackageInfo pwd distPref
246
                     pkg abi_hash lib lbi clbi)
Christiaan Baaij's avatar
Christiaan Baaij committed
247 248
    else if reloc
      then relocRegistrationInfo verbosity
249
                     pkg lib lbi clbi abi_hash packageDb
Christiaan Baaij's avatar
Christiaan Baaij committed
250
      else return (absoluteInstalledPackageInfo
251
                     pkg abi_hash lib lbi clbi)
252

253

254
  return installedPkgInfo{ IPI.abiHash = abi_hash }
255

256 257 258 259 260
relocRegistrationInfo :: Verbosity
                      -> PackageDescription
                      -> Library
                      -> LocalBuildInfo
                      -> ComponentLocalBuildInfo
261
                      -> AbiHash
262 263
                      -> PackageDB
                      -> IO InstalledPackageInfo
264
relocRegistrationInfo verbosity pkg lib lbi clbi abi_hash packageDb =
265
  case (compilerFlavor (compiler lbi)) of
266 267
    GHC -> do fs <- GHC.pkgRoot verbosity lbi packageDb
              return (relocatableInstalledPackageInfo
268
                        pkg abi_hash lib lbi clbi fs)
269 270
    _   -> die "Distribution.Simple.Register.relocRegistrationInfo: \
               \not implemented for this compiler"
271

272 273
initPackageDB :: Verbosity -> Compiler -> ProgramConfiguration -> FilePath -> IO ()
initPackageDB verbosity comp progdb dbPath =
274
    createPackageDB verbosity comp progdb False dbPath
275

276
-- | Create an empty package DB at the specified location.
277 278 279 280 281 282 283 284 285 286 287 288
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"

289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304
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
305 306 307 308 309 310

-- | 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 =
311 312 313 314
  withHcPkg "invokeHcPkg" comp conf
    (\hpi -> HcPkg.invoke hpi verbosity dbStack extraArgs)

withHcPkg :: String -> Compiler -> ProgramConfiguration
315
          -> (HcPkg.HcPkgInfo -> IO a) -> IO a
316 317 318 319 320 321 322
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")
323

Duncan Coutts's avatar
Duncan Coutts committed
324
registerPackage :: Verbosity
325 326
                -> Compiler
                -> ProgramConfiguration
327
                -> HcPkg.MultiInstance
328
                -> PackageDBStack
329
                -> InstalledPackageInfo
Duncan Coutts's avatar
Duncan Coutts committed
330
                -> IO ()
331
registerPackage verbosity comp progdb multiInstance packageDbs installedPkgInfo =
332
  case compilerFlavor comp of
333 334
    GHC   -> GHC.registerPackage   verbosity progdb multiInstance packageDbs installedPkgInfo
    GHCJS -> GHCJS.registerPackage verbosity progdb multiInstance packageDbs installedPkgInfo
335
    _ | HcPkg.MultiInstance == multiInstance
336
          -> die "Registering multiple package instances is not yet supported for this compiler"
337 338
    LHC   -> LHC.registerPackage   verbosity      progdb packageDbs installedPkgInfo
    UHC   -> UHC.registerPackage   verbosity comp progdb packageDbs installedPkgInfo
339
    JHC   -> notice verbosity "Registering for jhc (nothing to do)"
340
    HaskellSuite {} ->
341
      HaskellSuite.registerPackage verbosity      progdb packageDbs installedPkgInfo
Duncan Coutts's avatar
Duncan Coutts committed
342 343 344
    _    -> die "Registering is not implemented for this compiler"

writeHcPkgRegisterScript :: Verbosity
345
                         -> [InstalledPackageInfo]
346
                         -> PackageDBStack
347
                         -> HcPkg.HcPkgInfo
Duncan Coutts's avatar
Duncan Coutts committed
348
                         -> IO ()
349 350 351 352 353 354 355 356
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
357

358
  info verbosity ("Creating package registration script: " ++ regScriptFileName)
359
  writeUTF8File regScriptFileName regScript
Duncan Coutts's avatar
Duncan Coutts committed
360 361 362 363 364 365
  setFileExecutable regScriptFileName

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

367

368 369 370
-- -----------------------------------------------------------------------------
-- Making the InstalledPackageInfo

Duncan Coutts's avatar
Duncan Coutts committed
371 372 373 374 375 376 377
-- | 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
378
  -> AbiHash
Duncan Coutts's avatar
Duncan Coutts committed
379
  -> Library
380
  -> LocalBuildInfo
Duncan Coutts's avatar
Duncan Coutts committed
381 382 383
  -> ComponentLocalBuildInfo
  -> InstallDirs FilePath
  -> InstalledPackageInfo
384
generalInstalledPackageInfo adjustRelIncDirs pkg abi_hash lib lbi clbi installDirs =
385
  IPI.InstalledPackageInfo {
386 387 388
    IPI.sourcePackageId    = (packageId   pkg) {
                                pkgName = componentCompatPackageName clbi
                             },
389
    IPI.installedUnitId    = componentUnitId clbi,
390
    IPI.compatPackageKey   = componentCompatPackageKey clbi,
Duncan Coutts's avatar
Duncan Coutts committed
391 392 393 394 395 396 397
    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,
398
    IPI.synopsis           = synopsis    pkg,
Duncan Coutts's avatar
Duncan Coutts committed
399 400
    IPI.description        = description pkg,
    IPI.category           = category    pkg,
401
    IPI.abiHash            = abi_hash,
Duncan Coutts's avatar
Duncan Coutts committed
402
    IPI.exposed            = libExposed  lib,
403
    IPI.exposedModules     = componentExposedModules clbi,
Duncan Coutts's avatar
Duncan Coutts committed
404
    IPI.hiddenModules      = otherModules bi,
405
    IPI.trusted            = IPI.trusted IPI.emptyInstalledPackageInfo,
Duncan Coutts's avatar
Duncan Coutts committed
406
    IPI.importDirs         = [ libdir installDirs | hasModules ],
407 408
    -- Note. the libsubdir and datasubdir templates have already been expanded
    -- into libdir and datadir.
Duncan Coutts's avatar
Duncan Coutts committed
409 410 411
    IPI.libraryDirs        = if hasLibrary
                               then libdir installDirs : extraLibDirs bi
                               else                      extraLibDirs bi,
412
    IPI.dataDir            = datadir installDirs,
413
    IPI.hsLibraries        = if hasLibrary
414
                               then [getHSLibraryName (componentUnitId clbi)]
415
                               else [],
Duncan Coutts's avatar
Duncan Coutts committed
416
    IPI.extraLibraries     = extraLibs bi,
417
    IPI.extraGHCiLibraries = extraGHCiLibs bi,
Duncan Coutts's avatar
Duncan Coutts committed
418 419
    IPI.includeDirs        = absinc ++ adjustRelIncDirs relinc,
    IPI.includes           = includes bi,
420
    IPI.depends            = map fst (componentPackageDeps clbi),
Duncan Coutts's avatar
Duncan Coutts committed
421 422 423 424 425
    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,
426
    IPI.frameworkDirs      = extraFrameworkDirs bi,
Duncan Coutts's avatar
Duncan Coutts committed
427
    IPI.haddockInterfaces  = [haddockdir installDirs </> haddockName pkg],
428 429
    IPI.haddockHTMLs       = [htmldir installDirs],
    IPI.pkgRoot            = Nothing
Duncan Coutts's avatar
Duncan Coutts committed
430 431 432 433
  }
  where
    bi = libBuildInfo lib
    (absinc, relinc) = partition isAbsolute (includeDirs bi)
434
    hasModules = not $ null (libModules lib)
Duncan Coutts's avatar
Duncan Coutts committed
435
    hasLibrary = hasModules || not (null (cSources bi))
436 437 438
                            || (not (null (jsSources bi)) &&
                                compilerFlavor (compiler lbi) == GHCJS)

Ian D. Bollinger's avatar
Ian D. Bollinger committed
439
-- | Construct 'InstalledPackageInfo' for a library that is in place in the
Duncan Coutts's avatar
Duncan Coutts committed
440 441
-- build tree.
--
Ian D. Bollinger's avatar
Ian D. Bollinger committed
442
-- This function knows about the layout of in place packages.
Duncan Coutts's avatar
Duncan Coutts committed
443 444 445 446
--
inplaceInstalledPackageInfo :: FilePath -- ^ top of the build tree
                            -> FilePath -- ^ location of the dist tree
                            -> PackageDescription
447
                            -> AbiHash
Duncan Coutts's avatar
Duncan Coutts committed
448 449 450 451
                            -> Library
                            -> LocalBuildInfo
                            -> ComponentLocalBuildInfo
                            -> InstalledPackageInfo
452
inplaceInstalledPackageInfo inplaceDir distPref pkg abi_hash lib lbi clbi =
453
    generalInstalledPackageInfo adjustRelativeIncludeDirs
454
                                pkg abi_hash lib lbi clbi installDirs
Duncan Coutts's avatar
Duncan Coutts committed
455
  where
refold's avatar
refold committed
456
    adjustRelativeIncludeDirs = map (inplaceDir </>)
457
    libTargetDir = componentBuildDir lbi clbi
Duncan Coutts's avatar
Duncan Coutts committed
458
    installDirs =
459
      (absoluteComponentInstallDirs pkg lbi (componentUnitId clbi) NoCopyDest) {
460
        libdir     = inplaceDir </> libTargetDir,
461
        datadir    = inplaceDir </> dataDir pkg,
Duncan Coutts's avatar
Duncan Coutts committed
462 463 464 465 466 467 468 469 470 471 472 473 474 475
        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
476
                             -> AbiHash
Duncan Coutts's avatar
Duncan Coutts committed
477 478 479 480
                             -> Library
                             -> LocalBuildInfo
                             -> ComponentLocalBuildInfo
                             -> InstalledPackageInfo
481
absoluteInstalledPackageInfo pkg abi_hash lib lbi clbi =
482
    generalInstalledPackageInfo adjustReativeIncludeDirs
483
                                pkg abi_hash lib lbi clbi installDirs
Duncan Coutts's avatar
Duncan Coutts committed
484 485 486 487 488 489 490
  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
491
    installDirs = absoluteComponentInstallDirs pkg lbi (componentUnitId clbi) NoCopyDest
Duncan Coutts's avatar
Duncan Coutts committed
492

493 494

relocatableInstalledPackageInfo :: PackageDescription
495
                                -> AbiHash
496 497 498
                                -> Library
                                -> LocalBuildInfo
                                -> ComponentLocalBuildInfo
499
                                -> FilePath
500
                                -> InstalledPackageInfo
501
relocatableInstalledPackageInfo pkg abi_hash lib lbi clbi pkgroot =
502
    generalInstalledPackageInfo adjustReativeIncludeDirs
503
                                pkg abi_hash lib lbi clbi installDirs
504 505 506 507 508 509 510
  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
511 512

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

simonmar's avatar
simonmar committed
515 516
-- -----------------------------------------------------------------------------
-- Unregistration
517

ijones's avatar
ijones committed
518
unregister :: PackageDescription -> LocalBuildInfo -> RegisterFlags -> IO ()
Duncan Coutts's avatar
Duncan Coutts committed
519 520 521
unregister pkg lbi regFlags = do
  let pkgid     = packageId pkg
      genScript = fromFlag (regGenScript regFlags)
522
      verbosity = fromFlag (regVerbosity regFlags)
Duncan Coutts's avatar
Duncan Coutts committed
523
      packageDb = fromFlagOrDefault (registrationPackageDB (withPackageDB lbi))
524
                                    (regPackageDB regFlags)
525 526 527 528 529 530 531
      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
532
  setupMessage verbosity "Unregistering" pkgid
533 534
  withHcPkg "unregistering is only implemented for GHC and GHCJS"
    (compiler lbi) (withPrograms lbi) unreg
ijones's avatar
ijones committed
535

Duncan Coutts's avatar
Duncan Coutts committed
536 537 538 539
unregScriptFileName :: FilePath
unregScriptFileName = case buildOS of
                          Windows -> "unregister.bat"
                          _       -> "unregister.sh"
540 541 542 543 544 545

internalPackageDBPath :: LocalBuildInfo -> FilePath -> FilePath
internalPackageDBPath lbi distPref =
      case compilerFlavor (compiler lbi) of
        UHC -> UHC.inplacePackageDbPath lbi
        _   -> distPref </> "package.conf.inplace"
546 547 548 549 550 551 552 553 554 555 556 557

-- | 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