Register.hs 24.9 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,

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

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

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

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

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
64
import qualified Distribution.Simple.HaskellSuite as HaskellSuite
65
import qualified Distribution.Simple.PackageIndex as Index
66

67
import Distribution.Backpack.DescribeUnitId
68
import Distribution.Simple.Compiler
Duncan Coutts's avatar
Duncan Coutts committed
69 70 71
import Distribution.Simple.Program
import Distribution.Simple.Program.Script
import qualified Distribution.Simple.Program.HcPkg as HcPkg
72
import Distribution.Simple.Setup
Duncan Coutts's avatar
Duncan Coutts committed
73
import Distribution.PackageDescription
74
import Distribution.Package
75
import qualified Distribution.InstalledPackageInfo as IPI
76
import Distribution.InstalledPackageInfo (InstalledPackageInfo)
77
import Distribution.Simple.Utils
78
import Distribution.Utils.MapAccum
79
import Distribution.System
80
import Distribution.Text
81
import Distribution.Types.ComponentName
Duncan Coutts's avatar
Duncan Coutts committed
82
import Distribution.Verbosity as Verbosity
83
import Distribution.Version
84
import Distribution.Compat.Graph (IsNode(nodeKey))
85

86
import System.FilePath ((</>), (<.>), isAbsolute)
Duncan Coutts's avatar
Duncan Coutts committed
87
import System.Directory
ijones's avatar
ijones committed
88

89
import Data.List (partition)
90
import qualified Data.ByteString.Lazy.Char8 as BS.Char8
91

simonmar's avatar
simonmar committed
92 93 94
-- -----------------------------------------------------------------------------
-- Registration

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

    -- It's important to register in build order, because ghc-pkg
    -- will complain if a dependency is not registered.
110 111 112 113 114 115 116 117 118 119 120 121 122 123
    let componentsToRegister
            = neededTargetsInBuildOrder' pkg_descr lbi0 (map nodeKey targets)

    (_, ipi_mbs) <-
        mapAccumM `flip` installedPkgs lbi0 `flip` componentsToRegister $ \index tgt ->
            case targetComponent tgt of
                CLib lib -> do
                    let clbi = targetCLBI tgt
                        lbi = lbi0 { installedPkgs = index }
                    ipi <- generateOne pkg_descr lib lbi clbi flags
                    return (Index.insert ipi index, Just ipi)
                _   -> return (index, Nothing)

    registerAll pkg_descr lbi0 flags (catMaybes ipi_mbs)
124 125
   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
        -- Only print the public library's IPI
157
        when (IPI.sourcePackageId installedPkgInfo == packageId pkg) $
158
          putStrLn (display (IPI.installedUnitId installedPkgInfo))
159

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

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

186 187 188 189 190
    writeRegistrationFileOrDirectory = do
      -- Handles overwriting both directory and file
      deletePackageDB regFile
      case ipis of
        [installedPkgInfo] -> do
191
          info verbosity ("Creating package registration file: " ++ regFile)
192 193
          writeUTF8File regFile (IPI.showInstalledPackageInfo installedPkgInfo)
        _ -> do
194
          info verbosity ("Creating package registration directory: " ++ regFile)
195 196 197 198 199
          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)
200
          for_ (zip ([1..] :: [Int]) ipis) $ \(i, installedPkgInfo) ->
201 202 203 204
            writeUTF8File (regFile </> (number i ++ "-" ++ display (IPI.installedUnitId installedPkgInfo)))
                          (IPI.showInstalledPackageInfo installedPkgInfo)

    writeRegisterScript =
Duncan Coutts's avatar
Duncan Coutts committed
205
      case compilerFlavor (compiler lbi) of
206 207
        JHC -> notice verbosity "Registration scripts not needed for jhc"
        UHC -> notice verbosity "Registration scripts not needed for uhc"
208
        _   -> withHcPkg verbosity
209 210
               "Registration scripts are not implemented for this compiler"
               (compiler lbi) (withPrograms lbi)
211
               (writeHcPkgRegisterScript verbosity ipis packageDbs)
Duncan Coutts's avatar
Duncan Coutts committed
212 213


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

Christiaan Baaij's avatar
Christiaan Baaij committed
228 229
  installedPkgInfo <-
    if inplace
230 231 232
      -- NB: With an inplace installation, the user may run './Setup
      -- build' to update the library files, without reregistering.
      -- In this case, it is critical that the ABI hash not flip.
Christiaan Baaij's avatar
Christiaan Baaij committed
233
      then return (inplaceInstalledPackageInfo pwd distPref
234 235 236 237 238 239 240 241
                     pkg (mkAbiHash "inplace") lib lbi clbi)
    else do
        abi_hash <- abiHash verbosity pkg distPref lbi lib clbi
        if reloc
          then relocRegistrationInfo verbosity
                         pkg lib lbi clbi abi_hash packageDb
          else return (absoluteInstalledPackageInfo
                         pkg abi_hash lib lbi clbi)
242

243

244
  return installedPkgInfo
245

246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267
-- | Compute the 'AbiHash' of a library that we built inplace.
abiHash :: Verbosity
        -> PackageDescription
        -> FilePath
        -> LocalBuildInfo
        -> Library
        -> ComponentLocalBuildInfo
        -> IO AbiHash
abiHash verbosity pkg distPref lbi lib clbi =
    case compilerFlavor comp of
     GHC | compilerVersion comp >= mkVersion [6,11] -> do
            fmap mkAbiHash $ GHC.libAbiHash verbosity pkg lbi' lib clbi
     GHCJS -> do
            fmap mkAbiHash $ GHCJS.libAbiHash verbosity pkg lbi' lib clbi
     _ -> return (mkAbiHash "")
  where
    comp = compiler lbi
    lbi' = lbi {
              withPackageDB = withPackageDB lbi
                  ++ [SpecificPackageDB (internalPackageDBPath lbi distPref)]
           }

268 269 270 271 272
relocRegistrationInfo :: Verbosity
                      -> PackageDescription
                      -> Library
                      -> LocalBuildInfo
                      -> ComponentLocalBuildInfo
273
                      -> AbiHash
274 275
                      -> PackageDB
                      -> IO InstalledPackageInfo
276
relocRegistrationInfo verbosity pkg lib lbi clbi abi_hash packageDb =
277
  case (compilerFlavor (compiler lbi)) of
278 279
    GHC -> do fs <- GHC.pkgRoot verbosity lbi packageDb
              return (relocatableInstalledPackageInfo
280
                        pkg abi_hash lib lbi clbi fs)
281 282
    _   -> die' verbosity
              "Distribution.Simple.Register.relocRegistrationInfo: \
283
               \not implemented for this compiler"
284

285
initPackageDB :: Verbosity -> Compiler -> ProgramDb -> FilePath -> IO ()
286
initPackageDB verbosity comp progdb dbPath =
287
    createPackageDB verbosity comp progdb False dbPath
288

289
-- | Create an empty package DB at the specified location.
290
createPackageDB :: Verbosity -> Compiler -> ProgramDb -> Bool
291 292 293 294 295 296 297 298
                -> 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
299 300
      _              -> die' verbosity $
                              "Distribution.Simple.Register.createPackageDB: "
301 302
                           ++ "not implemented for this compiler"

303
doesPackageDBExist :: FilePath -> NoCallStackIO Bool
304 305 306 307 308 309 310
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

311
deletePackageDB :: FilePath -> NoCallStackIO ()
312 313 314 315 316 317 318
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
319 320 321

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

328
withHcPkg :: Verbosity -> String -> Compiler -> ProgramDb
329
          -> (HcPkg.HcPkgInfo -> IO a) -> IO a
330
withHcPkg verbosity name comp progdb f =
331
  case compilerFlavor comp of
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
332 333 334
    GHC   -> f (GHC.hcPkgInfo progdb)
    GHCJS -> f (GHCJS.hcPkgInfo progdb)
    LHC   -> f (LHC.hcPkgInfo progdb)
335
    _     -> die' verbosity ("Distribution.Simple.Register." ++ name ++ ":\
336
                  \not implemented for this compiler")
337

Duncan Coutts's avatar
Duncan Coutts committed
338
registerPackage :: Verbosity
339
                -> Compiler
340
                -> ProgramDb
341
                -> HcPkg.MultiInstance
342
                -> PackageDBStack
343
                -> InstalledPackageInfo
Duncan Coutts's avatar
Duncan Coutts committed
344
                -> IO ()
345
registerPackage verbosity comp progdb multiInstance packageDbs installedPkgInfo =
346
  case compilerFlavor comp of
347 348
    GHC   -> GHC.registerPackage   verbosity progdb multiInstance packageDbs installedPkgInfo
    GHCJS -> GHCJS.registerPackage verbosity progdb multiInstance packageDbs installedPkgInfo
349
    _ | HcPkg.MultiInstance == multiInstance
350
          -> die' verbosity "Registering multiple package instances is not yet supported for this compiler"
351 352
    LHC   -> LHC.registerPackage   verbosity      progdb packageDbs installedPkgInfo
    UHC   -> UHC.registerPackage   verbosity comp progdb packageDbs installedPkgInfo
353
    JHC   -> notice verbosity "Registering for jhc (nothing to do)"
354
    HaskellSuite {} ->
355
      HaskellSuite.registerPackage verbosity      progdb packageDbs installedPkgInfo
356
    _    -> die' verbosity "Registering is not implemented for this compiler"
Duncan Coutts's avatar
Duncan Coutts committed
357 358

writeHcPkgRegisterScript :: Verbosity
359
                         -> [InstalledPackageInfo]
360
                         -> PackageDBStack
361
                         -> HcPkg.HcPkgInfo
Duncan Coutts's avatar
Duncan Coutts committed
362
                         -> IO ()
363 364 365 366 367 368 369 370
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
371

372
  info verbosity ("Creating package registration script: " ++ regScriptFileName)
373
  writeUTF8File regScriptFileName regScript
Duncan Coutts's avatar
Duncan Coutts committed
374 375 376 377 378 379
  setFileExecutable regScriptFileName

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

381

382 383 384
-- -----------------------------------------------------------------------------
-- Making the InstalledPackageInfo

Duncan Coutts's avatar
Duncan Coutts committed
385 386 387 388 389 390 391
-- | 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
392
  -> AbiHash
Duncan Coutts's avatar
Duncan Coutts committed
393
  -> Library
394
  -> LocalBuildInfo
Duncan Coutts's avatar
Duncan Coutts committed
395 396 397
  -> ComponentLocalBuildInfo
  -> InstallDirs FilePath
  -> InstalledPackageInfo
398
generalInstalledPackageInfo adjustRelIncDirs pkg abi_hash lib lbi clbi installDirs =
399
  IPI.InstalledPackageInfo {
400 401 402
    IPI.sourcePackageId    = (packageId   pkg) {
                                pkgName = componentCompatPackageName clbi
                             },
403
    IPI.installedUnitId    = componentUnitId clbi,
404
    IPI.installedComponentId_ = componentComponentId clbi,
405
    IPI.instantiatedWith   = componentInstantiatedWith clbi,
406
    IPI.sourcePackageName  = if componentCompatPackageName clbi /= pkgName (packageId pkg)
407 408 409
                                then Just (pkgName (packageId pkg))
                                else Nothing,
    IPI.sourceLibName      = libName lib,
410
    IPI.compatPackageKey   = componentCompatPackageKey clbi,
Duncan Coutts's avatar
Duncan Coutts committed
411 412 413 414 415 416 417
    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,
418
    IPI.synopsis           = synopsis    pkg,
Duncan Coutts's avatar
Duncan Coutts committed
419 420
    IPI.description        = description pkg,
    IPI.category           = category    pkg,
421
    IPI.abiHash            = abi_hash,
422
    IPI.indefinite         = componentIsIndefinite clbi,
Duncan Coutts's avatar
Duncan Coutts committed
423
    IPI.exposed            = libExposed  lib,
424
    IPI.exposedModules     = componentExposedModules clbi,
Duncan Coutts's avatar
Duncan Coutts committed
425
    IPI.hiddenModules      = otherModules bi,
426
    IPI.trusted            = IPI.trusted IPI.emptyInstalledPackageInfo,
Duncan Coutts's avatar
Duncan Coutts committed
427
    IPI.importDirs         = [ libdir installDirs | hasModules ],
Christiaan Baaij's avatar
Christiaan Baaij committed
428 429
    IPI.libraryDirs        = libdirs,
    IPI.libraryDynDirs     = dynlibdirs,
430
    IPI.dataDir            = datadir installDirs,
431
    IPI.hsLibraries        = if hasLibrary
432
                               then [getHSLibraryName (componentUnitId clbi)]
433
                               else [],
Duncan Coutts's avatar
Duncan Coutts committed
434
    IPI.extraLibraries     = extraLibs bi,
435
    IPI.extraGHCiLibraries = extraGHCiLibs bi,
Duncan Coutts's avatar
Duncan Coutts committed
436 437
    IPI.includeDirs        = absinc ++ adjustRelIncDirs relinc,
    IPI.includes           = includes bi,
438 439
    IPI.depends            = depends,
    IPI.abiDepends         = abi_depends,
Duncan Coutts's avatar
Duncan Coutts committed
440 441 442 443 444
    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,
445
    IPI.frameworkDirs      = extraFrameworkDirs bi,
Duncan Coutts's avatar
Duncan Coutts committed
446
    IPI.haddockInterfaces  = [haddockdir installDirs </> haddockName pkg],
447 448
    IPI.haddockHTMLs       = [htmldir installDirs],
    IPI.pkgRoot            = Nothing
Duncan Coutts's avatar
Duncan Coutts committed
449 450 451
  }
  where
    bi = libBuildInfo lib
452 453 454 455 456 457 458 459 460 461
    --TODO: unclear what the root cause of the
    -- duplication is, but we nub it here for now:
    depends = ordNub $ map fst (componentPackageDeps clbi)
    abi_depends = map add_abi depends
    add_abi uid = IPI.AbiDependency uid abi
      where
        abi = case Index.lookupUnitId (installedPkgs lbi) uid of
                Nothing -> error $
                  "generalInstalledPackageInfo: missing IPI for " ++ display uid
                Just ipi -> IPI.abiHash ipi
Duncan Coutts's avatar
Duncan Coutts committed
462
    (absinc, relinc) = partition isAbsolute (includeDirs bi)
463
    hasModules = not $ null (allLibModules lib clbi)
Christiaan Baaij's avatar
Christiaan Baaij committed
464
    comp = compiler lbi
465 466 467 468
    hasLibrary = (hasModules || not (null (cSources bi))
                             || (not (null (jsSources bi)) &&
                                compilerFlavor comp == GHCJS))
               && not (componentIsIndefinite clbi)
Christiaan Baaij's avatar
Christiaan Baaij committed
469 470 471 472 473 474 475 476 477 478 479 480 481 482
    (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
483

Ian D. Bollinger's avatar
Ian D. Bollinger committed
484
-- | Construct 'InstalledPackageInfo' for a library that is in place in the
Duncan Coutts's avatar
Duncan Coutts committed
485 486
-- build tree.
--
Ian D. Bollinger's avatar
Ian D. Bollinger committed
487
-- This function knows about the layout of in place packages.
Duncan Coutts's avatar
Duncan Coutts committed
488 489 490 491
--
inplaceInstalledPackageInfo :: FilePath -- ^ top of the build tree
                            -> FilePath -- ^ location of the dist tree
                            -> PackageDescription
492
                            -> AbiHash
Duncan Coutts's avatar
Duncan Coutts committed
493 494 495 496
                            -> Library
                            -> LocalBuildInfo
                            -> ComponentLocalBuildInfo
                            -> InstalledPackageInfo
497
inplaceInstalledPackageInfo inplaceDir distPref pkg abi_hash lib lbi clbi =
498
    generalInstalledPackageInfo adjustRelativeIncludeDirs
499
                                pkg abi_hash lib lbi clbi installDirs
Duncan Coutts's avatar
Duncan Coutts committed
500
  where
refold's avatar
refold committed
501
    adjustRelativeIncludeDirs = map (inplaceDir </>)
502
    libTargetDir = componentBuildDir lbi clbi
Duncan Coutts's avatar
Duncan Coutts committed
503
    installDirs =
504
      (absoluteComponentInstallDirs pkg lbi (componentUnitId clbi) NoCopyDest) {
505
        libdir     = inplaceDir </> libTargetDir,
Christiaan Baaij's avatar
Christiaan Baaij committed
506
        dynlibdir  = inplaceDir </> libTargetDir,
507
        datadir    = inplaceDir </> dataDir pkg,
Duncan Coutts's avatar
Duncan Coutts committed
508 509 510 511 512 513 514 515 516 517 518 519 520 521
        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
522
                             -> AbiHash
Duncan Coutts's avatar
Duncan Coutts committed
523 524 525 526
                             -> Library
                             -> LocalBuildInfo
                             -> ComponentLocalBuildInfo
                             -> InstalledPackageInfo
527
absoluteInstalledPackageInfo pkg abi_hash lib lbi clbi =
528
    generalInstalledPackageInfo adjustReativeIncludeDirs
529
                                pkg abi_hash lib lbi clbi installDirs
Duncan Coutts's avatar
Duncan Coutts committed
530 531 532 533 534 535 536
  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
537
    installDirs = absoluteComponentInstallDirs pkg lbi (componentUnitId clbi) NoCopyDest
Duncan Coutts's avatar
Duncan Coutts committed
538

539 540

relocatableInstalledPackageInfo :: PackageDescription
541
                                -> AbiHash
542 543 544
                                -> Library
                                -> LocalBuildInfo
                                -> ComponentLocalBuildInfo
545
                                -> FilePath
546
                                -> InstalledPackageInfo
547
relocatableInstalledPackageInfo pkg abi_hash lib lbi clbi pkgroot =
548
    generalInstalledPackageInfo adjustReativeIncludeDirs
549
                                pkg abi_hash lib lbi clbi installDirs
550 551 552 553 554 555 556
  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
557 558

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

simonmar's avatar
simonmar committed
561 562
-- -----------------------------------------------------------------------------
-- Unregistration
563

ijones's avatar
ijones committed
564
unregister :: PackageDescription -> LocalBuildInfo -> RegisterFlags -> IO ()
Duncan Coutts's avatar
Duncan Coutts committed
565 566 567
unregister pkg lbi regFlags = do
  let pkgid     = packageId pkg
      genScript = fromFlag (regGenScript regFlags)
568
      verbosity = fromFlag (regVerbosity regFlags)
Duncan Coutts's avatar
Duncan Coutts committed
569
      packageDb = fromFlagOrDefault (registrationPackageDB (withPackageDB lbi))
570
                                    (regPackageDB regFlags)
571 572 573 574 575 576 577
      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
578
  setupMessage verbosity "Unregistering" pkgid
579
  withHcPkg verbosity "unregistering is only implemented for GHC and GHCJS"
580
    (compiler lbi) (withPrograms lbi) unreg
ijones's avatar
ijones committed
581

Duncan Coutts's avatar
Duncan Coutts committed
582 583 584 585
unregScriptFileName :: FilePath
unregScriptFileName = case buildOS of
                          Windows -> "unregister.bat"
                          _       -> "unregister.sh"
586 587 588 589 590 591

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