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

26
module Distribution.Simple.Register (
Duncan Coutts's avatar
Duncan Coutts committed
27 28 29
    register,
    unregister,

30
    initPackageDB,
31 32 33 34
    doesPackageDBExist,
    createPackageDB,
    deletePackageDB,

refold's avatar
refold committed
35
    invokeHcPkg,
Duncan Coutts's avatar
Duncan Coutts committed
36
    registerPackage,
37
    generateRegistrationInfo,
Duncan Coutts's avatar
Duncan Coutts committed
38 39 40
    inplaceInstalledPackageInfo,
    absoluteInstalledPackageInfo,
    generalInstalledPackageInfo,
41
  ) where
42

43
import Distribution.Simple.LocalBuildInfo
44
import Distribution.Simple.BuildPaths
45 46 47 48 49

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
50
import qualified Distribution.Simple.HaskellSuite as HaskellSuite
51

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

66
import System.FilePath ((</>), (<.>), isAbsolute)
Duncan Coutts's avatar
Duncan Coutts committed
67
import System.Directory
68 69
         ( getCurrentDirectory, removeDirectoryRecursive, removeFile
         , doesDirectoryExist, doesFileExist )
ijones's avatar
ijones committed
70

71
import Data.Version
72
import Control.Monad (when)
Duncan Coutts's avatar
Duncan Coutts committed
73
import Data.Maybe
74
         ( isJust, fromMaybe, maybeToList )
Duncan Coutts's avatar
Duncan Coutts committed
75 76
import Data.List
         ( partition, nub )
77
import qualified Data.ByteString.Lazy.Char8 as BS.Char8
78

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

ijones's avatar
ijones committed
82
register :: PackageDescription -> LocalBuildInfo
ijones's avatar
ijones committed
83
         -> RegisterFlags -- ^Install in the user's database?; verbose
ijones's avatar
ijones committed
84
         -> IO ()
85 86 87 88 89 90
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.
    when (hasPublicLib pkg) $
91 92 93 94
        let maybeRegister (CLib lib) _clbi =
                registerOne pkg lbi regFlags lib
            maybeRegister _comp _clbi = return ()
        in withAllComponentsInBuildOrder pkg lbi maybeRegister
95 96 97 98 99

registerOne :: PackageDescription -> LocalBuildInfo -> RegisterFlags
            -> Library
            -> IO ()
registerOne pkg lbi regFlags lib
100
  = do
101
    let clbi = getComponentLocalBuildInfo lbi (CLibName (libName lib))
102

103
    absPackageDBs    <- absolutePackageDBPaths packageDbs
104
    -- TODO: registration info named base on LIBNAME!!!
105
    installedPkgInfo <- generateRegistrationInfo
106
                           verbosity pkg lib lbi clbi inplace reloc distPref
107
                           (registrationPackageDB absPackageDBs)
108

109 110
    info verbosity (IPI.showInstalledPackageInfo installedPkgInfo)

111
    when (fromFlag (regPrintId regFlags)) $ do
112
      putStrLn (display (IPI.installedUnitId installedPkgInfo))
113

114 115 116 117
     -- Three different modes:
    case () of
     _ | modeGenerateRegFile   -> writeRegistrationFile installedPkgInfo
       | modeGenerateRegScript -> writeRegisterScript   installedPkgInfo
118 119
       | otherwise             -> do
           setupMessage verbosity "Registering" (packageId pkg)
120
           registerPackage verbosity (compiler lbi) (withPrograms lbi) HcPkg.NoMultiInstance
121
                           packageDbs installedPkgInfo
Duncan Coutts's avatar
Duncan Coutts committed
122 123 124 125 126 127 128 129 130

  where
    modeGenerateRegFile = isJust (flagToMaybe (regGenPkgConf regFlags))
    regFile             = fromMaybe (display (packageId pkg) <.> "conf")
                                    (fromFlag (regGenPkgConf regFlags))

    modeGenerateRegScript = fromFlag (regGenScript regFlags)

    inplace   = fromFlag (regInPlace regFlags)
131
    reloc     = relocatable lbi
Duncan Coutts's avatar
Duncan Coutts committed
132 133 134 135 136
    -- 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
137 138 139
    distPref  = fromFlag (regDistPref regFlags)
    verbosity = fromFlag (regVerbosity regFlags)

140
    writeRegistrationFile installedPkgInfo = do
Duncan Coutts's avatar
Duncan Coutts committed
141
      notice verbosity ("Creating package registration file: " ++ regFile)
142
      writeUTF8File regFile (IPI.showInstalledPackageInfo installedPkgInfo)
Duncan Coutts's avatar
Duncan Coutts committed
143

144
    writeRegisterScript installedPkgInfo =
Duncan Coutts's avatar
Duncan Coutts committed
145
      case compilerFlavor (compiler lbi) of
146 147 148 149 150 151
        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)
               (writeHcPkgRegisterScript verbosity installedPkgInfo packageDbs)
Duncan Coutts's avatar
Duncan Coutts committed
152 153


154 155
generateRegistrationInfo :: Verbosity
                         -> PackageDescription
Duncan Coutts's avatar
Duncan Coutts committed
156 157 158 159
                         -> Library
                         -> LocalBuildInfo
                         -> ComponentLocalBuildInfo
                         -> Bool
160
                         -> Bool
Duncan Coutts's avatar
Duncan Coutts committed
161
                         -> FilePath
162
                         -> PackageDB
Duncan Coutts's avatar
Duncan Coutts committed
163
                         -> IO InstalledPackageInfo
164
generateRegistrationInfo verbosity pkg lib lbi clbi inplace reloc distPref packageDb = do
Duncan Coutts's avatar
Duncan Coutts committed
165 166
  --TODO: eliminate pwd!
  pwd <- getCurrentDirectory
167

168
  --TODO: the method of setting the UnitId is compiler specific
169
  --      this aspect should be delegated to a per-compiler helper.
170
  let comp = compiler lbi
171
  abi_hash <-
172 173
    case compilerFlavor comp of
     GHC | compilerVersion comp >= Version [6,11] [] -> do
174
            fmap AbiHash $ GHC.libAbiHash verbosity pkg lbi lib clbi
175
     GHCJS -> do
176 177
            fmap AbiHash $ GHCJS.libAbiHash verbosity pkg lbi lib clbi
     _ -> return (AbiHash "")
178

Christiaan Baaij's avatar
Christiaan Baaij committed
179 180 181
  installedPkgInfo <-
    if inplace
      then return (inplaceInstalledPackageInfo pwd distPref
182
                     pkg abi_hash lib lbi clbi)
Christiaan Baaij's avatar
Christiaan Baaij committed
183 184
    else if reloc
      then relocRegistrationInfo verbosity
185
                     pkg lib lbi clbi abi_hash packageDb
Christiaan Baaij's avatar
Christiaan Baaij committed
186
      else return (absoluteInstalledPackageInfo
187
                     pkg abi_hash lib lbi clbi)
188

189

190
  return installedPkgInfo{ IPI.abiHash = abi_hash }
191

192 193 194 195 196
relocRegistrationInfo :: Verbosity
                      -> PackageDescription
                      -> Library
                      -> LocalBuildInfo
                      -> ComponentLocalBuildInfo
197
                      -> AbiHash
198 199
                      -> PackageDB
                      -> IO InstalledPackageInfo
200
relocRegistrationInfo verbosity pkg lib lbi clbi abi_hash packageDb =
201
  case (compilerFlavor (compiler lbi)) of
202 203
    GHC -> do fs <- GHC.pkgRoot verbosity lbi packageDb
              return (relocatableInstalledPackageInfo
204
                        pkg abi_hash lib lbi clbi fs)
205 206
    _   -> die "Distribution.Simple.Register.relocRegistrationInfo: \
               \not implemented for this compiler"
207

208 209
initPackageDB :: Verbosity -> Compiler -> ProgramConfiguration -> FilePath -> IO ()
initPackageDB verbosity comp progdb dbPath =
210
    createPackageDB verbosity comp progdb False dbPath
211

212
-- | Create an empty package DB at the specified location.
213 214 215 216 217 218 219 220 221 222 223 224
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"

225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240
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
241 242 243 244 245 246

-- | 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 =
247 248 249 250
  withHcPkg "invokeHcPkg" comp conf
    (\hpi -> HcPkg.invoke hpi verbosity dbStack extraArgs)

withHcPkg :: String -> Compiler -> ProgramConfiguration
251
          -> (HcPkg.HcPkgInfo -> IO a) -> IO a
252 253 254 255 256 257 258
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")
259

Duncan Coutts's avatar
Duncan Coutts committed
260
registerPackage :: Verbosity
261 262
                -> Compiler
                -> ProgramConfiguration
263
                -> HcPkg.MultiInstance
264
                -> PackageDBStack
265
                -> InstalledPackageInfo
Duncan Coutts's avatar
Duncan Coutts committed
266
                -> IO ()
267
registerPackage verbosity comp progdb multiInstance packageDbs installedPkgInfo =
268
  case compilerFlavor comp of
269 270
    GHC   -> GHC.registerPackage   verbosity progdb multiInstance packageDbs installedPkgInfo
    GHCJS -> GHCJS.registerPackage verbosity progdb multiInstance packageDbs installedPkgInfo
271
    _ | HcPkg.MultiInstance == multiInstance
272
          -> die "Registering multiple package instances is not yet supported for this compiler"
273 274
    LHC   -> LHC.registerPackage   verbosity      progdb packageDbs installedPkgInfo
    UHC   -> UHC.registerPackage   verbosity comp progdb packageDbs installedPkgInfo
275
    JHC   -> notice verbosity "Registering for jhc (nothing to do)"
276
    HaskellSuite {} ->
277
      HaskellSuite.registerPackage verbosity      progdb packageDbs installedPkgInfo
Duncan Coutts's avatar
Duncan Coutts committed
278 279 280
    _    -> die "Registering is not implemented for this compiler"

writeHcPkgRegisterScript :: Verbosity
281
                         -> InstalledPackageInfo
282
                         -> PackageDBStack
283
                         -> HcPkg.HcPkgInfo
Duncan Coutts's avatar
Duncan Coutts committed
284
                         -> IO ()
285 286
writeHcPkgRegisterScript verbosity installedPkgInfo packageDbs hpi = do
  let invocation  = HcPkg.reregisterInvocation hpi Verbosity.normal
287
                      packageDbs (Right installedPkgInfo)
288
      regScript   = invocationAsSystemScript buildOS invocation
Duncan Coutts's avatar
Duncan Coutts committed
289 290

  notice verbosity ("Creating package registration script: " ++ regScriptFileName)
291
  writeUTF8File regScriptFileName regScript
Duncan Coutts's avatar
Duncan Coutts committed
292 293 294 295 296 297
  setFileExecutable regScriptFileName

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

299

300 301 302
-- -----------------------------------------------------------------------------
-- Making the InstalledPackageInfo

Duncan Coutts's avatar
Duncan Coutts committed
303 304 305 306 307 308 309
-- | 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
310
  -> AbiHash
Duncan Coutts's avatar
Duncan Coutts committed
311
  -> Library
312
  -> LocalBuildInfo
Duncan Coutts's avatar
Duncan Coutts committed
313 314 315
  -> ComponentLocalBuildInfo
  -> InstallDirs FilePath
  -> InstalledPackageInfo
316
generalInstalledPackageInfo adjustRelIncDirs pkg abi_hash lib lbi clbi installDirs =
317
  IPI.InstalledPackageInfo {
318 319 320
    IPI.sourcePackageId    = (packageId   pkg) {
                                pkgName = componentCompatPackageName clbi
                             },
321
    IPI.installedUnitId    = componentUnitId clbi,
322
    IPI.compatPackageKey   = componentCompatPackageKey clbi,
Duncan Coutts's avatar
Duncan Coutts committed
323 324 325 326 327 328 329
    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,
330
    IPI.synopsis           = synopsis    pkg,
Duncan Coutts's avatar
Duncan Coutts committed
331 332
    IPI.description        = description pkg,
    IPI.category           = category    pkg,
333
    IPI.abiHash            = abi_hash,
Duncan Coutts's avatar
Duncan Coutts committed
334
    IPI.exposed            = libExposed  lib,
335
    IPI.exposedModules     = componentExposedModules clbi,
Duncan Coutts's avatar
Duncan Coutts committed
336
    IPI.hiddenModules      = otherModules bi,
337
    IPI.trusted            = IPI.trusted IPI.emptyInstalledPackageInfo,
Duncan Coutts's avatar
Duncan Coutts committed
338
    IPI.importDirs         = [ libdir installDirs | hasModules ],
339 340
    -- Note. the libsubdir and datasubdir templates have already been expanded
    -- into libdir and datadir.
Duncan Coutts's avatar
Duncan Coutts committed
341 342 343
    IPI.libraryDirs        = if hasLibrary
                               then libdir installDirs : extraLibDirs bi
                               else                      extraLibDirs bi,
344
    IPI.dataDir            = datadir installDirs,
345
    IPI.hsLibraries        = if hasLibrary
346
                               then [getHSLibraryName (componentUnitId clbi)]
347
                               else [],
Duncan Coutts's avatar
Duncan Coutts committed
348
    IPI.extraLibraries     = extraLibs bi,
349
    IPI.extraGHCiLibraries = extraGHCiLibs bi,
Duncan Coutts's avatar
Duncan Coutts committed
350 351
    IPI.includeDirs        = absinc ++ adjustRelIncDirs relinc,
    IPI.includes           = includes bi,
352
    IPI.depends            = map fst (componentPackageDeps clbi),
Duncan Coutts's avatar
Duncan Coutts committed
353 354 355 356 357
    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,
358
    IPI.frameworkDirs      = extraFrameworkDirs bi,
Duncan Coutts's avatar
Duncan Coutts committed
359
    IPI.haddockInterfaces  = [haddockdir installDirs </> haddockName pkg],
360 361
    IPI.haddockHTMLs       = [htmldir installDirs],
    IPI.pkgRoot            = Nothing
Duncan Coutts's avatar
Duncan Coutts committed
362 363 364 365
  }
  where
    bi = libBuildInfo lib
    (absinc, relinc) = partition isAbsolute (includeDirs bi)
366
    hasModules = not $ null (libModules lib)
Duncan Coutts's avatar
Duncan Coutts committed
367
    hasLibrary = hasModules || not (null (cSources bi))
368 369 370
                            || (not (null (jsSources bi)) &&
                                compilerFlavor (compiler lbi) == GHCJS)

Ian D. Bollinger's avatar
Ian D. Bollinger committed
371
-- | Construct 'InstalledPackageInfo' for a library that is in place in the
Duncan Coutts's avatar
Duncan Coutts committed
372 373
-- build tree.
--
Ian D. Bollinger's avatar
Ian D. Bollinger committed
374
-- This function knows about the layout of in place packages.
Duncan Coutts's avatar
Duncan Coutts committed
375 376 377 378
--
inplaceInstalledPackageInfo :: FilePath -- ^ top of the build tree
                            -> FilePath -- ^ location of the dist tree
                            -> PackageDescription
379
                            -> AbiHash
Duncan Coutts's avatar
Duncan Coutts committed
380 381 382 383
                            -> Library
                            -> LocalBuildInfo
                            -> ComponentLocalBuildInfo
                            -> InstalledPackageInfo
384
inplaceInstalledPackageInfo inplaceDir distPref pkg abi_hash lib lbi clbi =
385
    generalInstalledPackageInfo adjustRelativeIncludeDirs
386
                                pkg abi_hash lib lbi clbi installDirs
Duncan Coutts's avatar
Duncan Coutts committed
387
  where
refold's avatar
refold committed
388
    adjustRelativeIncludeDirs = map (inplaceDir </>)
389
    libTargetDir = componentBuildDir lbi clbi
Duncan Coutts's avatar
Duncan Coutts committed
390
    installDirs =
391
      (absoluteComponentInstallDirs pkg lbi (componentUnitId clbi) NoCopyDest) {
392
        libdir     = inplaceDir </> libTargetDir,
393
        datadir    = inplaceDir </> dataDir pkg,
Duncan Coutts's avatar
Duncan Coutts committed
394 395 396 397 398 399 400 401 402 403 404 405 406 407
        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
408
                             -> AbiHash
Duncan Coutts's avatar
Duncan Coutts committed
409 410 411 412
                             -> Library
                             -> LocalBuildInfo
                             -> ComponentLocalBuildInfo
                             -> InstalledPackageInfo
413
absoluteInstalledPackageInfo pkg abi_hash lib lbi clbi =
414
    generalInstalledPackageInfo adjustReativeIncludeDirs
415
                                pkg abi_hash lib lbi clbi installDirs
Duncan Coutts's avatar
Duncan Coutts committed
416 417 418 419 420 421 422
  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
423
    installDirs = absoluteComponentInstallDirs pkg lbi (componentUnitId clbi) NoCopyDest
Duncan Coutts's avatar
Duncan Coutts committed
424

425 426

relocatableInstalledPackageInfo :: PackageDescription
427
                                -> AbiHash
428 429 430
                                -> Library
                                -> LocalBuildInfo
                                -> ComponentLocalBuildInfo
431
                                -> FilePath
432
                                -> InstalledPackageInfo
433
relocatableInstalledPackageInfo pkg abi_hash lib lbi clbi pkgroot =
434
    generalInstalledPackageInfo adjustReativeIncludeDirs
435
                                pkg abi_hash lib lbi clbi installDirs
436 437 438 439 440 441 442
  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
443 444

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

simonmar's avatar
simonmar committed
447 448
-- -----------------------------------------------------------------------------
-- Unregistration
449

ijones's avatar
ijones committed
450
unregister :: PackageDescription -> LocalBuildInfo -> RegisterFlags -> IO ()
Duncan Coutts's avatar
Duncan Coutts committed
451 452 453
unregister pkg lbi regFlags = do
  let pkgid     = packageId pkg
      genScript = fromFlag (regGenScript regFlags)
454
      verbosity = fromFlag (regVerbosity regFlags)
Duncan Coutts's avatar
Duncan Coutts committed
455
      packageDb = fromFlagOrDefault (registrationPackageDB (withPackageDB lbi))
456
                                    (regPackageDB regFlags)
457 458 459 460 461 462 463
      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
464
  setupMessage verbosity "Unregistering" pkgid
465 466
  withHcPkg "unregistering is only implemented for GHC and GHCJS"
    (compiler lbi) (withPrograms lbi) unreg
ijones's avatar
ijones committed
467

Duncan Coutts's avatar
Duncan Coutts committed
468 469 470 471
unregScriptFileName :: FilePath
unregScriptFileName = case buildOS of
                          Windows -> "unregister.bat"
                          _       -> "unregister.sh"