Register.hs 24.6 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 158
        when (packageId installedPkgInfo == packageId pkg
              && IPI.sourceLibName installedPkgInfo == Nothing) $
159
          putStrLn (display (IPI.installedUnitId installedPkgInfo))
160

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

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

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

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


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

Christiaan Baaij's avatar
Christiaan Baaij committed
229 230
  installedPkgInfo <-
    if inplace
231 232 233
      -- 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
234
      then return (inplaceInstalledPackageInfo pwd distPref
235 236 237 238 239 240 241 242
                     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)
243

244

245
  return installedPkgInfo
246

247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268
-- | 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)]
           }

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

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

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

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

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

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

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

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

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

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

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

382

383 384 385
-- -----------------------------------------------------------------------------
-- Making the InstalledPackageInfo

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

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

535 536

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

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

simonmar's avatar
simonmar committed
557 558
-- -----------------------------------------------------------------------------
-- Unregistration
559

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

Duncan Coutts's avatar
Duncan Coutts committed
578 579 580 581
unregScriptFileName :: FilePath
unregScriptFileName = case buildOS of
                          Windows -> "unregister.bat"
                          _       -> "unregister.sh"
582 583 584 585 586 587

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