Register.hs 16.8 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 18 19 20 21 22 23 24
-- 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,
-- or alternatively to register the package inplace in the build tree. The
-- 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,
refold's avatar
refold committed
31
    invokeHcPkg,
Duncan Coutts's avatar
Duncan Coutts committed
32
    registerPackage,
33
    generateRegistrationInfo,
Duncan Coutts's avatar
Duncan Coutts committed
34 35 36
    inplaceInstalledPackageInfo,
    absoluteInstalledPackageInfo,
    generalInstalledPackageInfo,
37
  ) where
38

39 40
import Distribution.Simple.LocalBuildInfo
         ( LocalBuildInfo(..), ComponentLocalBuildInfo(..)
41
         , ComponentName(..), getComponentLocalBuildInfo
42
         , LibraryName(..)
43
         , InstallDirs(..), absoluteInstallDirs )
44
import Distribution.Simple.BuildPaths (haddockName)
45 46 47
import qualified Distribution.Simple.GHC  as GHC
import qualified Distribution.Simple.LHC  as LHC
import qualified Distribution.Simple.Hugs as Hugs
48
import qualified Distribution.Simple.UHC  as UHC
49
import qualified Distribution.Simple.HaskellSuite as HaskellSuite
50
import Distribution.Simple.Compiler
51
         ( compilerVersion, Compiler, CompilerFlavor(..), compilerFlavor
52
         , PackageDBStack, registrationPackageDB )
Duncan Coutts's avatar
Duncan Coutts committed
53
import Distribution.Simple.Program
54 55 56
         ( ProgramConfiguration, ConfiguredProgram
         , runProgramInvocation, requireProgram, lookupProgram
         , ghcPkgProgram, lhcPkgProgram )
Duncan Coutts's avatar
Duncan Coutts committed
57 58 59
import Distribution.Simple.Program.Script
         ( invocationAsSystemScript )
import qualified Distribution.Simple.Program.HcPkg as HcPkg
60 61 62
import Distribution.Simple.Setup
         ( RegisterFlags(..), CopyDest(..)
         , fromFlag, fromFlagOrDefault, flagToMaybe )
Duncan Coutts's avatar
Duncan Coutts committed
63 64
import Distribution.PackageDescription
         ( PackageDescription(..), Library(..), BuildInfo(..), hcOptions )
65
import Distribution.Package
66
         ( Package(..), packageName, InstalledPackageId(..) )
67
import Distribution.InstalledPackageInfo
68 69
         ( InstalledPackageInfo, InstalledPackageInfo_(InstalledPackageInfo)
         , showInstalledPackageInfo )
70
import qualified Distribution.InstalledPackageInfo as IPI
71
import Distribution.Simple.Utils
72
         ( writeUTF8File, writeFileAtomic, setFileExecutable
Duncan Coutts's avatar
Duncan Coutts committed
73
         , die, notice, setupMessage )
74
import Distribution.System
75
         ( OS(..), buildOS )
76 77
import Distribution.Text
         ( display )
78
import Distribution.Version ( Version(..) )
Duncan Coutts's avatar
Duncan Coutts committed
79 80
import Distribution.Verbosity as Verbosity
         ( Verbosity, normal )
81 82
import Distribution.Compat.Exception
         ( tryIO )
83

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

Duncan Coutts's avatar
Duncan Coutts committed
88
import Data.Maybe
89
         ( isJust, fromMaybe, maybeToList )
Duncan Coutts's avatar
Duncan Coutts committed
90 91
import Data.List
         ( partition, nub )
92
import qualified Data.ByteString.Lazy.Char8 as BS.Char8
93

simonmar's avatar
simonmar committed
94 95 96
-- -----------------------------------------------------------------------------
-- Registration

ijones's avatar
ijones committed
97
register :: PackageDescription -> LocalBuildInfo
ijones's avatar
ijones committed
98
         -> RegisterFlags -- ^Install in the user's database?; verbose
ijones's avatar
ijones committed
99
         -> IO ()
100
register pkg@PackageDescription { library       = Just lib  } lbi regFlags
101
  = do
102
    let clbi = getComponentLocalBuildInfo lbi CLibName
103 104 105 106 107 108 109 110
    installedPkgInfo <- generateRegistrationInfo
                           verbosity pkg lib lbi clbi inplace distPref

     -- Three different modes:
    case () of
     _ | modeGenerateRegFile   -> writeRegistrationFile installedPkgInfo
       | modeGenerateRegScript -> writeRegisterScript   installedPkgInfo
       | otherwise             -> registerPackage verbosity
111
                                    installedPkgInfo pkg lbi inplace packageDbs
Duncan Coutts's avatar
Duncan Coutts committed
112 113 114 115 116 117 118 119 120

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

    modeGenerateRegScript = fromFlag (regGenScript regFlags)

    inplace   = fromFlag (regInPlace regFlags)
Duncan Coutts's avatar
Duncan Coutts committed
121 122 123 124 125
    -- 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
126 127 128
    distPref  = fromFlag (regDistPref regFlags)
    verbosity = fromFlag (regVerbosity regFlags)

129
    writeRegistrationFile installedPkgInfo = do
Duncan Coutts's avatar
Duncan Coutts committed
130
      notice verbosity ("Creating package registration file: " ++ regFile)
131
      writeUTF8File regFile (showInstalledPackageInfo installedPkgInfo)
Duncan Coutts's avatar
Duncan Coutts committed
132

133
    writeRegisterScript installedPkgInfo =
Duncan Coutts's avatar
Duncan Coutts committed
134 135
      case compilerFlavor (compiler lbi) of
        GHC  -> do (ghcPkg, _) <- requireProgram verbosity ghcPkgProgram (withPrograms lbi)
136
                   writeHcPkgRegisterScript verbosity installedPkgInfo ghcPkg packageDbs
Duncan Coutts's avatar
Duncan Coutts committed
137
        LHC  -> do (lhcPkg, _) <- requireProgram verbosity lhcPkgProgram (withPrograms lbi)
138
                   writeHcPkgRegisterScript verbosity installedPkgInfo lhcPkg packageDbs
Duncan Coutts's avatar
Duncan Coutts committed
139 140 141
        Hugs -> notice verbosity "Registration scripts not needed for hugs"
        JHC  -> notice verbosity "Registration scripts not needed for jhc"
        NHC  -> notice verbosity "Registration scripts not needed for nhc98"
142
        UHC  -> notice verbosity "Registration scripts not needed for uhc"
Duncan Coutts's avatar
Duncan Coutts committed
143 144 145 146 147 148 149
        _    -> die "Registration scripts are not implemented for this compiler"

register _ _ regFlags = notice verbosity "No package to register"
  where
    verbosity = fromFlag (regVerbosity regFlags)


150 151
generateRegistrationInfo :: Verbosity
                         -> PackageDescription
Duncan Coutts's avatar
Duncan Coutts committed
152 153 154 155 156 157
                         -> Library
                         -> LocalBuildInfo
                         -> ComponentLocalBuildInfo
                         -> Bool
                         -> FilePath
                         -> IO InstalledPackageInfo
158
generateRegistrationInfo verbosity pkg lib lbi clbi inplace distPref = do
Duncan Coutts's avatar
Duncan Coutts committed
159 160
  --TODO: eliminate pwd!
  pwd <- getCurrentDirectory
161

162 163
  --TODO: the method of setting the InstalledPackageId is compiler specific
  --      this aspect should be delegated to a per-compiler helper.
164
  let comp = compiler lbi
165 166 167 168 169 170 171
  ipid <-
    case compilerFlavor comp of
     GHC | compilerVersion comp >= Version [6,11] [] -> do
            s <- GHC.libAbiHash verbosity pkg lbi lib clbi
            return (InstalledPackageId (display (packageId pkg) ++ '-':s))
     _other -> do
            return (InstalledPackageId (display (packageId pkg)))
172

Duncan Coutts's avatar
Duncan Coutts committed
173 174 175 176 177
  let installedPkgInfo
        | inplace   = inplaceInstalledPackageInfo pwd distPref
                        pkg lib lbi clbi
        | otherwise = absoluteInstalledPackageInfo
                        pkg lib lbi clbi
178

179 180 181
  return installedPkgInfo{ IPI.installedPackageId = ipid }


182 183 184 185 186 187
-- | Create an empty package DB at the specified location.
initPackageDB :: Verbosity -> Compiler -> ProgramConfiguration -> FilePath
                 -> IO ()
initPackageDB verbosity comp conf dbPath =
  case (compilerFlavor comp) of
    GHC -> GHC.initPackageDB verbosity conf dbPath
188
    HaskellSuite {} -> HaskellSuite.initPackageDB verbosity conf dbPath
refold's avatar
refold committed
189 190 191 192 193 194 195 196 197 198 199 200
    _   -> die "Distribution.Simple.Register.initPackageDB: \
               \not implemented for this compiler"

-- | 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 =
    case (compilerFlavor comp) of
      GHC -> GHC.invokeHcPkg verbosity conf dbStack extraArgs
      _   -> die "Distribution.Simple.Register.invokeHcPkg: \
                 \not implemented for this compiler"
201

Duncan Coutts's avatar
Duncan Coutts committed
202
registerPackage :: Verbosity
203
                -> InstalledPackageInfo
Duncan Coutts's avatar
Duncan Coutts committed
204 205 206
                -> PackageDescription
                -> LocalBuildInfo
                -> Bool
207
                -> PackageDBStack
Duncan Coutts's avatar
Duncan Coutts committed
208
                -> IO ()
209
registerPackage verbosity installedPkgInfo pkg lbi inplace packageDbs = do
refold's avatar
refold committed
210 211 212 213
  let msg = if inplace
            then "In-place registering"
            else "Registering"
  setupMessage verbosity msg (packageId pkg)
Duncan Coutts's avatar
Duncan Coutts committed
214
  case compilerFlavor (compiler lbi) of
215 216 217
    GHC  -> GHC.registerPackage  verbosity installedPkgInfo pkg lbi inplace packageDbs
    LHC  -> LHC.registerPackage  verbosity installedPkgInfo pkg lbi inplace packageDbs
    Hugs -> Hugs.registerPackage verbosity installedPkgInfo pkg lbi inplace packageDbs
218
    UHC  -> UHC.registerPackage  verbosity installedPkgInfo pkg lbi inplace packageDbs
Duncan Coutts's avatar
Duncan Coutts committed
219 220
    JHC  -> notice verbosity "Registering for jhc (nothing to do)"
    NHC  -> notice verbosity "Registering for nhc98 (nothing to do)"
221 222
    HaskellSuite {} ->
      HaskellSuite.registerPackage verbosity installedPkgInfo pkg lbi inplace packageDbs
Duncan Coutts's avatar
Duncan Coutts committed
223 224 225 226
    _    -> die "Registering is not implemented for this compiler"


writeHcPkgRegisterScript :: Verbosity
227
                         -> InstalledPackageInfo
Duncan Coutts's avatar
Duncan Coutts committed
228
                         -> ConfiguredProgram
229
                         -> PackageDBStack
Duncan Coutts's avatar
Duncan Coutts committed
230
                         -> IO ()
231
writeHcPkgRegisterScript verbosity installedPkgInfo hcPkg packageDbs = do
Duncan Coutts's avatar
Duncan Coutts committed
232
  let invocation  = HcPkg.reregisterInvocation hcPkg Verbosity.normal
233
                      packageDbs (Right installedPkgInfo)
Duncan Coutts's avatar
Duncan Coutts committed
234 235 236
      regScript   = invocationAsSystemScript buildOS   invocation

  notice verbosity ("Creating package registration script: " ++ regScriptFileName)
237
  writeUTF8File regScriptFileName regScript
Duncan Coutts's avatar
Duncan Coutts committed
238 239 240 241 242 243
  setFileExecutable regScriptFileName

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

245

246 247 248
-- -----------------------------------------------------------------------------
-- Making the InstalledPackageInfo

Duncan Coutts's avatar
Duncan Coutts committed
249 250 251 252 253 254 255 256 257 258 259 260 261
-- | 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
  -> Library
  -> ComponentLocalBuildInfo
  -> InstallDirs FilePath
  -> InstalledPackageInfo
generalInstalledPackageInfo adjustRelIncDirs pkg lib clbi installDirs =
  InstalledPackageInfo {
262
    --TODO: do not open-code this conversion from PackageId to InstalledPackageId
263
    IPI.installedPackageId = InstalledPackageId (display (packageId pkg)),
264
    IPI.sourcePackageId    = packageId   pkg,
Duncan Coutts's avatar
Duncan Coutts committed
265 266 267 268 269 270 271
    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,
272
    IPI.synopsis           = synopsis    pkg,
Duncan Coutts's avatar
Duncan Coutts committed
273 274 275 276 277
    IPI.description        = description pkg,
    IPI.category           = category    pkg,
    IPI.exposed            = libExposed  lib,
    IPI.exposedModules     = exposedModules lib,
    IPI.hiddenModules      = otherModules bi,
278
    IPI.trusted            = IPI.trusted IPI.emptyInstalledPackageInfo,
Duncan Coutts's avatar
Duncan Coutts committed
279 280 281 282
    IPI.importDirs         = [ libdir installDirs | hasModules ],
    IPI.libraryDirs        = if hasLibrary
                               then libdir installDirs : extraLibDirs bi
                               else                      extraLibDirs bi,
refold's avatar
refold committed
283
    IPI.hsLibraries        = [ libname
284 285
                             | LibraryName libname <- componentLibraries clbi
                             , hasLibrary ],
Duncan Coutts's avatar
Duncan Coutts committed
286 287 288 289
    IPI.extraLibraries     = extraLibs bi,
    IPI.extraGHCiLibraries = [],
    IPI.includeDirs        = absinc ++ adjustRelIncDirs relinc,
    IPI.includes           = includes bi,
290
    IPI.depends            = map fst (componentPackageDeps clbi),
Duncan Coutts's avatar
Duncan Coutts committed
291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321
    IPI.hugsOptions        = hcOptions Hugs bi,
    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.frameworkDirs      = [],
    IPI.frameworks         = frameworks bi,
    IPI.haddockInterfaces  = [haddockdir installDirs </> haddockName pkg],
    IPI.haddockHTMLs       = [htmldir installDirs]
  }
  where
    bi = libBuildInfo lib
    (absinc, relinc) = partition isAbsolute (includeDirs bi)
    hasModules = not $ null (exposedModules lib)
                    && null (otherModules bi)
    hasLibrary = hasModules || not (null (cSources bi))


-- | Construct 'InstalledPackageInfo' for a library that is inplace in the
-- build tree.
--
-- This function knows about the layout of inplace packages.
--
inplaceInstalledPackageInfo :: FilePath -- ^ top of the build tree
                            -> FilePath -- ^ location of the dist tree
                            -> PackageDescription
                            -> Library
                            -> LocalBuildInfo
                            -> ComponentLocalBuildInfo
                            -> InstalledPackageInfo
inplaceInstalledPackageInfo inplaceDir distPref pkg lib lbi clbi =
refold's avatar
refold committed
322 323
    generalInstalledPackageInfo adjustRelativeIncludeDirs pkg lib clbi
    installDirs
Duncan Coutts's avatar
Duncan Coutts committed
324
  where
refold's avatar
refold committed
325
    adjustRelativeIncludeDirs = map (inplaceDir </>)
Duncan Coutts's avatar
Duncan Coutts committed
326
    installDirs =
327
      (absoluteInstallDirs pkg lbi NoCopyDest) {
Duncan Coutts's avatar
Duncan Coutts committed
328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357
        libdir     = inplaceDir </> buildDir lbi,
        datadir    = inplaceDir,
        datasubdir = distPref,
        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
                             -> Library
                             -> LocalBuildInfo
                             -> ComponentLocalBuildInfo
                             -> InstalledPackageInfo
absoluteInstalledPackageInfo pkg lib lbi clbi =
    generalInstalledPackageInfo adjustReativeIncludeDirs pkg lib clbi installDirs
  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
358
    installDirs = absoluteInstallDirs pkg lbi NoCopyDest
Duncan Coutts's avatar
Duncan Coutts committed
359

simonmar's avatar
simonmar committed
360 361
-- -----------------------------------------------------------------------------
-- Unregistration
362

ijones's avatar
ijones committed
363
unregister :: PackageDescription -> LocalBuildInfo -> RegisterFlags -> IO ()
Duncan Coutts's avatar
Duncan Coutts committed
364 365 366
unregister pkg lbi regFlags = do
  let pkgid     = packageId pkg
      genScript = fromFlag (regGenScript regFlags)
367
      verbosity = fromFlag (regVerbosity regFlags)
Duncan Coutts's avatar
Duncan Coutts committed
368
      packageDb = fromFlagOrDefault (registrationPackageDB (withPackageDB lbi))
369
                                    (regPackageDB regFlags)
370
      installDirs = absoluteInstallDirs pkg lbi NoCopyDest
Duncan Coutts's avatar
Duncan Coutts committed
371
  setupMessage verbosity "Unregistering" pkgid
372
  case compilerFlavor (compiler lbi) of
Duncan Coutts's avatar
Duncan Coutts committed
373 374 375 376 377 378
    GHC ->
      let Just ghcPkg = lookupProgram ghcPkgProgram (withPrograms lbi)
          invocation = HcPkg.unregisterInvocation ghcPkg Verbosity.normal
                         packageDb pkgid
      in if genScript
           then writeFileAtomic unregScriptFileName
379
                  (BS.Char8.pack $ invocationAsSystemScript buildOS invocation)
Duncan Coutts's avatar
Duncan Coutts committed
380
            else runProgramInvocation verbosity invocation
ijones's avatar
ijones committed
381
    Hugs -> do
382
        _ <- tryIO $ removeDirectoryRecursive (libdir installDirs)
383
        return ()
384
    NHC -> do
385
        _ <- tryIO $ removeDirectoryRecursive (libdir installDirs)
386
        return ()
ijones's avatar
ijones committed
387
    _ ->
388
        die ("only unregistering with GHC and Hugs is implemented")
ijones's avatar
ijones committed
389

Duncan Coutts's avatar
Duncan Coutts committed
390 391 392 393
unregScriptFileName :: FilePath
unregScriptFileName = case buildOS of
                          Windows -> "unregister.bat"
                          _       -> "unregister.sh"