Register.hs 23.4 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.BuildTarget
57
import Distribution.Simple.Compiler
Duncan Coutts's avatar
Duncan Coutts committed
58 59 60
import Distribution.Simple.Program
import Distribution.Simple.Program.Script
import qualified Distribution.Simple.Program.HcPkg as HcPkg
61
import Distribution.Simple.Setup
Duncan Coutts's avatar
Duncan Coutts committed
62
import Distribution.PackageDescription
63
import Distribution.Package
64
import qualified Distribution.InstalledPackageInfo as IPI
65
import Distribution.InstalledPackageInfo (InstalledPackageInfo)
66
import Distribution.Simple.Utils
67
import Distribution.System
68
import Distribution.Text
Duncan Coutts's avatar
Duncan Coutts committed
69
import Distribution.Verbosity as Verbosity
70

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

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

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

ijones's avatar
ijones committed
83
register :: PackageDescription -> LocalBuildInfo
ijones's avatar
ijones committed
84
         -> RegisterFlags -- ^Install in the user's database?; verbose
ijones's avatar
ijones committed
85
         -> IO ()
86 87 88 89 90 91 92 93
register pkg_descr lbi flags = when (hasPublicLib pkg_descr) doRegister
 where
  -- 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.
  doRegister = do
    targets <- readBuildTargets pkg_descr (regArgs flags)
94
    targets' <- checkBuildTargets verbosity pkg_descr lbi targets
95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120

    -- 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_descr clbi
            = fmap Just (generateOne pkg_descr lib lbi clbi flags)
            | otherwise = return Nothing

    ipis <-
      if fromFlag (regAssumeDepsUpToDate flags)
        then
          case targets' of
            [(cname, _)] -> do
                mb_ipi <- maybeGenerateOne (getComponentLocalBuildInfo lbi cname)
                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
           . mapM maybeGenerateOne
           $ componentsInBuildOrder lbi (map fst targets')
    registerAll pkg_descr lbi flags ipis
    return ()
   where
    verbosity = fromFlag (regVerbosity flags)
121 122 123 124 125

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

144 145 146 147 148
registerAll :: PackageDescription -> LocalBuildInfo -> RegisterFlags
            -> [InstalledPackageInfo]
            -> IO ()
registerAll pkg lbi regFlags ipis
  = do
149
    when (fromFlag (regPrintId regFlags)) $ do
150 151 152 153
      forM_ ipis $ \installedPkgInfo ->
        -- Only print the public library's IPI
        when (IPI.sourcePackageId installedPkgInfo == packageId pkg) $
          putStrLn (display (IPI.installedUnitId installedPkgInfo))
154

155 156
     -- Three different modes:
    case () of
157 158
     _ | modeGenerateRegFile   -> writeRegistrationFileOrDirectory
       | modeGenerateRegScript -> writeRegisterScript
159 160
       | otherwise             -> do
           setupMessage verbosity "Registering" (packageId pkg)
161 162 163
           forM_ ipis $ \installedPkgInfo ->
               registerPackage verbosity (compiler lbi) (withPrograms lbi)
                               HcPkg.NoMultiInstance packageDbs installedPkgInfo
Duncan Coutts's avatar
Duncan Coutts committed
164 165 166 167 168 169 170 171

  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
172 173 174 175 176
    -- 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
177 178
    verbosity = fromFlag (regVerbosity regFlags)

179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198
    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
199
      case compilerFlavor (compiler lbi) of
200 201 202 203 204
        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)
205
               (writeHcPkgRegisterScript verbosity ipis packageDbs)
Duncan Coutts's avatar
Duncan Coutts committed
206 207


208 209
generateRegistrationInfo :: Verbosity
                         -> PackageDescription
Duncan Coutts's avatar
Duncan Coutts committed
210 211 212 213
                         -> Library
                         -> LocalBuildInfo
                         -> ComponentLocalBuildInfo
                         -> Bool
214
                         -> Bool
Duncan Coutts's avatar
Duncan Coutts committed
215
                         -> FilePath
216
                         -> PackageDB
Duncan Coutts's avatar
Duncan Coutts committed
217
                         -> IO InstalledPackageInfo
218
generateRegistrationInfo verbosity pkg lib lbi clbi inplace reloc distPref packageDb = do
Duncan Coutts's avatar
Duncan Coutts committed
219 220
  --TODO: eliminate pwd!
  pwd <- getCurrentDirectory
221

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

Christiaan Baaij's avatar
Christiaan Baaij committed
237 238 239
  installedPkgInfo <-
    if inplace
      then return (inplaceInstalledPackageInfo pwd distPref
240
                     pkg abi_hash lib lbi clbi)
Christiaan Baaij's avatar
Christiaan Baaij committed
241 242
    else if reloc
      then relocRegistrationInfo verbosity
243
                     pkg lib lbi clbi abi_hash packageDb
Christiaan Baaij's avatar
Christiaan Baaij committed
244
      else return (absoluteInstalledPackageInfo
245
                     pkg abi_hash lib lbi clbi)
246

247

248
  return installedPkgInfo{ IPI.abiHash = abi_hash }
249

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

266 267
initPackageDB :: Verbosity -> Compiler -> ProgramConfiguration -> FilePath -> IO ()
initPackageDB verbosity comp progdb dbPath =
268
    createPackageDB verbosity comp progdb False dbPath
269

270
-- | Create an empty package DB at the specified location.
271 272 273 274 275 276 277 278 279 280 281 282
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"

283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298
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
299 300 301 302 303 304

-- | 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 =
305 306 307 308
  withHcPkg "invokeHcPkg" comp conf
    (\hpi -> HcPkg.invoke hpi verbosity dbStack extraArgs)

withHcPkg :: String -> Compiler -> ProgramConfiguration
309
          -> (HcPkg.HcPkgInfo -> IO a) -> IO a
310 311 312 313 314 315 316
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")
317

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

writeHcPkgRegisterScript :: Verbosity
339
                         -> [InstalledPackageInfo]
340
                         -> PackageDBStack
341
                         -> HcPkg.HcPkgInfo
Duncan Coutts's avatar
Duncan Coutts committed
342
                         -> IO ()
343 344 345 346 347 348 349 350
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
351 352

  notice verbosity ("Creating package registration script: " ++ regScriptFileName)
353
  writeUTF8File regScriptFileName regScript
Duncan Coutts's avatar
Duncan Coutts committed
354 355 356 357 358 359
  setFileExecutable regScriptFileName

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

361

362 363 364
-- -----------------------------------------------------------------------------
-- Making the InstalledPackageInfo

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

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

487 488

relocatableInstalledPackageInfo :: PackageDescription
489
                                -> AbiHash
490 491 492
                                -> Library
                                -> LocalBuildInfo
                                -> ComponentLocalBuildInfo
493
                                -> FilePath
494
                                -> InstalledPackageInfo
495
relocatableInstalledPackageInfo pkg abi_hash lib lbi clbi pkgroot =
496
    generalInstalledPackageInfo adjustReativeIncludeDirs
497
                                pkg abi_hash lib lbi clbi installDirs
498 499 500 501 502 503 504
  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
505 506

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

simonmar's avatar
simonmar committed
509 510
-- -----------------------------------------------------------------------------
-- Unregistration
511

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

Duncan Coutts's avatar
Duncan Coutts committed
530 531 532 533
unregScriptFileName :: FilePath
unregScriptFileName = case buildOS of
                          Windows -> "unregister.bat"
                          _       -> "unregister.sh"
534 535 536 537 538 539

internalPackageDBPath :: LocalBuildInfo -> FilePath -> FilePath
internalPackageDBPath lbi distPref =
      case compilerFlavor (compiler lbi) of
        UHC -> UHC.inplacePackageDbPath lbi
        _   -> distPref </> "package.conf.inplace"
540 541 542 543 544 545 546 547 548 549 550 551

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