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 97
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
98
    targets <- readTargetInfos verbosity pkg_descr lbi (regArgs flags)
99 100 101

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

    ipis <-
      if fromFlag (regAssumeDepsUpToDate flags)
        then
111 112 113
          case targets of
            [target] -> do
                mb_ipi <- maybeGenerateOne target
114 115 116 117 118 119
                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
120
           . traverse maybeGenerateOne
121
           $ neededTargetsInBuildOrder' pkg_descr lbi (map nodeKey targets)
122 123 124 125
    registerAll pkg_descr lbi flags ipis
    return ()
   where
    verbosity = fromFlag (regVerbosity flags)
126 127 128 129 130

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

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

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

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

184 185 186 187 188 189 190 191 192 193 194 195 196 197
    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)
198
          for_ (zip ([1..] :: [Int]) ipis) $ \(i, installedPkgInfo) ->
199 200 201 202 203
            -- 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
204
      case compilerFlavor (compiler lbi) of
205 206 207 208 209
        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)
210
               (writeHcPkgRegisterScript verbosity ipis packageDbs)
Duncan Coutts's avatar
Duncan Coutts committed
211 212


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

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

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

252

253
  return installedPkgInfo{ IPI.abiHash = abi_hash }
254

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

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

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

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

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

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

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

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

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

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

366

367 368 369
-- -----------------------------------------------------------------------------
-- Making the InstalledPackageInfo

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

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

492 493

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

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

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

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

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

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

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