Register.hs 22.1 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 32
    internalPackageDBPath,

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

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

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

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
53
import qualified Distribution.Simple.HaskellSuite as HaskellSuite
54

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

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

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

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

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

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

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

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

  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
151 152 153 154 155
    -- 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
156 157
    verbosity = fromFlag (regVerbosity regFlags)

158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177
    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
178
      case compilerFlavor (compiler lbi) of
179 180 181 182 183
        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)
184
               (writeHcPkgRegisterScript verbosity ipis packageDbs)
Duncan Coutts's avatar
Duncan Coutts committed
185 186


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

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

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

226

227
  return installedPkgInfo{ IPI.abiHash = abi_hash }
228

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

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

249
-- | Create an empty package DB at the specified location.
250 251 252 253 254 255 256 257 258 259 260 261
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"

262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277
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
278 279 280 281 282 283

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

withHcPkg :: String -> Compiler -> ProgramConfiguration
288
          -> (HcPkg.HcPkgInfo -> IO a) -> IO a
289 290 291 292 293 294 295
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")
296

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

writeHcPkgRegisterScript :: Verbosity
318
                         -> [InstalledPackageInfo]
319
                         -> PackageDBStack
320
                         -> HcPkg.HcPkgInfo
Duncan Coutts's avatar
Duncan Coutts committed
321
                         -> IO ()
322 323 324 325 326 327 328 329
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
330 331

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

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

340

341 342 343
-- -----------------------------------------------------------------------------
-- Making the InstalledPackageInfo

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

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

466 467

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

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

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

ijones's avatar
ijones committed
491
unregister :: PackageDescription -> LocalBuildInfo -> RegisterFlags -> IO ()
Duncan Coutts's avatar
Duncan Coutts committed
492 493 494
unregister pkg lbi regFlags = do
  let pkgid     = packageId pkg
      genScript = fromFlag (regGenScript regFlags)
495
      verbosity = fromFlag (regVerbosity regFlags)
Duncan Coutts's avatar
Duncan Coutts committed
496
      packageDb = fromFlagOrDefault (registrationPackageDB (withPackageDB lbi))
497
                                    (regPackageDB regFlags)
498 499 500 501 502 503 504
      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
505
  setupMessage verbosity "Unregistering" pkgid
506 507
  withHcPkg "unregistering is only implemented for GHC and GHCJS"
    (compiler lbi) (withPrograms lbi) unreg
ijones's avatar
ijones committed
508

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

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