Register.hs 23.3 KB
Newer Older
1 2 3
{-# LANGUAGE FlexibleContexts #-}
{-# LANGUAGE RankNTypes #-}

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

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

33 34
    internalPackageDBPath,

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

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

48 49 50
import Prelude ()
import Distribution.Compat.Prelude

51 52
import Distribution.Types.TargetInfo
import Distribution.Types.LocalBuildInfo
53
import Distribution.Types.ComponentLocalBuildInfo
54

55
import Distribution.Simple.LocalBuildInfo
56
import Distribution.Simple.BuildPaths
57
import Distribution.Simple.BuildTarget
58 59 60 61 62

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
63
import qualified Distribution.Simple.HaskellSuite as HaskellSuite
64

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

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

84
import Data.List (partition)
85
import qualified Data.ByteString.Lazy.Char8 as BS.Char8
86

simonmar's avatar
simonmar committed
87 88 89
-- -----------------------------------------------------------------------------
-- Registration

ijones's avatar
ijones committed
90
register :: PackageDescription -> LocalBuildInfo
ijones's avatar
ijones committed
91
         -> RegisterFlags -- ^Install in the user's database?; verbose
ijones's avatar
ijones committed
92
         -> IO ()
93 94 95 96 97 98
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
99 100
 where
  doRegister = do
101
    targets <- readTargetInfos verbosity pkg_descr lbi (regArgs flags)
102 103 104

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

111 112 113
    ipis <- fmap catMaybes
          . traverse maybeGenerateOne
          $ neededTargetsInBuildOrder' pkg_descr lbi (map nodeKey targets)
114 115 116 117
    registerAll pkg_descr lbi flags ipis
    return ()
   where
    verbosity = fromFlag (regVerbosity flags)
118 119 120 121 122

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

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

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

  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
169 170 171 172 173
    -- 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
174 175
    verbosity = fromFlag (regVerbosity regFlags)

176 177 178 179 180
    writeRegistrationFileOrDirectory = do
      -- Handles overwriting both directory and file
      deletePackageDB regFile
      case ipis of
        [installedPkgInfo] -> do
181
          info verbosity ("Creating package registration file: " ++ regFile)
182 183
          writeUTF8File regFile (IPI.showInstalledPackageInfo installedPkgInfo)
        _ -> do
184
          info verbosity ("Creating package registration directory: " ++ regFile)
185 186 187 188 189
          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)
190
          for_ (zip ([1..] :: [Int]) ipis) $ \(i, installedPkgInfo) ->
191 192 193 194
            writeUTF8File (regFile </> (number i ++ "-" ++ display (IPI.installedUnitId installedPkgInfo)))
                          (IPI.showInstalledPackageInfo installedPkgInfo)

    writeRegisterScript =
Duncan Coutts's avatar
Duncan Coutts committed
195
      case compilerFlavor (compiler lbi) of
196 197 198 199 200
        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)
201
               (writeHcPkgRegisterScript verbosity ipis packageDbs)
Duncan Coutts's avatar
Duncan Coutts committed
202 203


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

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

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

243

244
  return installedPkgInfo{ IPI.abiHash = abi_hash }
245

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

262
initPackageDB :: Verbosity -> Compiler -> ProgramDb -> FilePath -> IO ()
263
initPackageDB verbosity comp progdb dbPath =
264
    createPackageDB verbosity comp progdb False dbPath
265

266
-- | Create an empty package DB at the specified location.
267
createPackageDB :: Verbosity -> Compiler -> ProgramDb -> Bool
268 269 270 271 272 273 274 275 276 277 278
                -> 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"

279
doesPackageDBExist :: FilePath -> NoCallStackIO Bool
280 281 282 283 284 285 286
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

287
deletePackageDB :: FilePath -> NoCallStackIO ()
288 289 290 291 292 293 294
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
295 296 297

-- | Run @hc-pkg@ using a given package DB stack, directly forwarding the
-- provided command-line arguments to it.
298
invokeHcPkg :: Verbosity -> Compiler -> ProgramDb -> PackageDBStack
refold's avatar
refold committed
299
                -> [String] -> IO ()
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
300 301
invokeHcPkg verbosity comp progdb dbStack extraArgs =
  withHcPkg "invokeHcPkg" comp progdb
302 303
    (\hpi -> HcPkg.invoke hpi verbosity dbStack extraArgs)

304
withHcPkg :: String -> Compiler -> ProgramDb
305
          -> (HcPkg.HcPkgInfo -> IO a) -> IO a
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
306
withHcPkg name comp progdb f =
307
  case compilerFlavor comp of
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
308 309 310
    GHC   -> f (GHC.hcPkgInfo progdb)
    GHCJS -> f (GHCJS.hcPkgInfo progdb)
    LHC   -> f (LHC.hcPkgInfo progdb)
311 312
    _     -> die ("Distribution.Simple.Register." ++ name ++ ":\
                  \not implemented for this compiler")
313

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

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

348
  info verbosity ("Creating package registration script: " ++ regScriptFileName)
349
  writeUTF8File regScriptFileName regScript
Duncan Coutts's avatar
Duncan Coutts committed
350 351 352 353 354 355
  setFileExecutable regScriptFileName

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

357

358 359 360
-- -----------------------------------------------------------------------------
-- Making the InstalledPackageInfo

Duncan Coutts's avatar
Duncan Coutts committed
361 362 363 364 365 366 367
-- | 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
368
  -> AbiHash
Duncan Coutts's avatar
Duncan Coutts committed
369
  -> Library
370
  -> LocalBuildInfo
Duncan Coutts's avatar
Duncan Coutts committed
371 372 373
  -> ComponentLocalBuildInfo
  -> InstallDirs FilePath
  -> InstalledPackageInfo
374
generalInstalledPackageInfo adjustRelIncDirs pkg abi_hash lib lbi clbi installDirs =
375
  IPI.InstalledPackageInfo {
376 377 378
    IPI.sourcePackageId    = (packageId   pkg) {
                                pkgName = componentCompatPackageName clbi
                             },
379
    IPI.installedUnitId    = componentUnitId clbi,
380
    IPI.installedComponentId_ = componentComponentId clbi,
381
    IPI.instantiatedWith   = componentInstantiatedWith clbi,
382
    IPI.compatPackageKey   = componentCompatPackageKey clbi,
Duncan Coutts's avatar
Duncan Coutts committed
383 384 385 386 387 388 389
    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,
390
    IPI.synopsis           = synopsis    pkg,
Duncan Coutts's avatar
Duncan Coutts committed
391 392
    IPI.description        = description pkg,
    IPI.category           = category    pkg,
393
    IPI.abiHash            = abi_hash,
394
    IPI.indefinite         = componentIsIndefinite clbi,
Duncan Coutts's avatar
Duncan Coutts committed
395
    IPI.exposed            = libExposed  lib,
396
    IPI.exposedModules     = componentExposedModules clbi,
Duncan Coutts's avatar
Duncan Coutts committed
397
    IPI.hiddenModules      = otherModules bi,
398
    IPI.trusted            = IPI.trusted IPI.emptyInstalledPackageInfo,
Duncan Coutts's avatar
Duncan Coutts committed
399
    IPI.importDirs         = [ libdir installDirs | hasModules ],
Christiaan Baaij's avatar
Christiaan Baaij committed
400 401
    IPI.libraryDirs        = libdirs,
    IPI.libraryDynDirs     = dynlibdirs,
402
    IPI.dataDir            = datadir installDirs,
403
    IPI.hsLibraries        = if hasLibrary
404
                               then [getHSLibraryName (componentUnitId clbi)]
405
                               else [],
Duncan Coutts's avatar
Duncan Coutts committed
406
    IPI.extraLibraries     = extraLibs bi,
407
    IPI.extraGHCiLibraries = extraGHCiLibs bi,
Duncan Coutts's avatar
Duncan Coutts committed
408 409
    IPI.includeDirs        = absinc ++ adjustRelIncDirs relinc,
    IPI.includes           = includes bi,
410 411 412
                             --TODO: unclear what the root cause of the
                             -- duplication is, but we nub it here for now:
    IPI.depends            = ordNub $ map fst (componentPackageDeps clbi),
Duncan Coutts's avatar
Duncan Coutts committed
413 414 415 416 417
    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,
418
    IPI.frameworkDirs      = extraFrameworkDirs bi,
Duncan Coutts's avatar
Duncan Coutts committed
419
    IPI.haddockInterfaces  = [haddockdir installDirs </> haddockName pkg],
420 421
    IPI.haddockHTMLs       = [htmldir installDirs],
    IPI.pkgRoot            = Nothing
Duncan Coutts's avatar
Duncan Coutts committed
422 423 424 425
  }
  where
    bi = libBuildInfo lib
    (absinc, relinc) = partition isAbsolute (includeDirs bi)
426
    hasModules = not $ null (allLibModules lib clbi)
Christiaan Baaij's avatar
Christiaan Baaij committed
427
    comp = compiler lbi
Duncan Coutts's avatar
Duncan Coutts committed
428
    hasLibrary = hasModules || not (null (cSources bi))
429
                            || (not (null (jsSources bi)) &&
Christiaan Baaij's avatar
Christiaan Baaij committed
430 431 432 433 434 435 436 437 438 439 440 441 442 443 444
                                compilerFlavor comp == GHCJS)
    (libdirs, dynlibdirs)
      | not hasLibrary
      = (extraLibDirs bi, [])
      -- the dynamic-library-dirs defaults to the library-dirs if not specified,
      -- so this works whether the dynamic-library-dirs field is supported or not

      | libraryDynDirSupported comp
      = (libdir    installDirs : extraLibDirs bi,
         dynlibdir installDirs : extraLibDirs bi)

      | otherwise
      = (libdir installDirs : dynlibdir installDirs : extraLibDirs bi, [])
      -- the compiler doesn't understand the dynamic-library-dirs field so we
      -- add the dyn directory to the "normal" list in the library-dirs field
445

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

501 502

relocatableInstalledPackageInfo :: PackageDescription
503
                                -> AbiHash
504 505 506
                                -> Library
                                -> LocalBuildInfo
                                -> ComponentLocalBuildInfo
507
                                -> FilePath
508
                                -> InstalledPackageInfo
509
relocatableInstalledPackageInfo pkg abi_hash lib lbi clbi pkgroot =
510
    generalInstalledPackageInfo adjustReativeIncludeDirs
511
                                pkg abi_hash lib lbi clbi installDirs
512 513 514 515 516 517 518
  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
519 520

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

simonmar's avatar
simonmar committed
523 524
-- -----------------------------------------------------------------------------
-- Unregistration
525

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

Duncan Coutts's avatar
Duncan Coutts committed
544 545 546 547
unregScriptFileName :: FilePath
unregScriptFileName = case buildOS of
                          Windows -> "unregister.bat"
                          _       -> "unregister.sh"
548 549 550 551 552 553

internalPackageDBPath :: LocalBuildInfo -> FilePath -> FilePath
internalPackageDBPath lbi distPref =
      case compilerFlavor (compiler lbi) of
        UHC -> UHC.inplacePackageDbPath lbi
        _   -> distPref </> "package.conf.inplace"