module Distribution.Simple.Register (
register,
unregister,
writeInstalledConfig,
removeInstalledConfig,
removeRegScripts,
#ifdef DEBUG
hunitTests, installedPkgConfigFile
#endif
) where
#if __GLASGOW_HASKELL__ && __GLASGOW_HASKELL__ < 604
#if __GLASGOW_HASKELL__ < 603
#include "config.h"
#else
#include "ghcconfig.h"
#endif
#endif
import Distribution.Simple.LocalBuildInfo (LocalBuildInfo(..), distPref,
InstallDirs(..),
haddockinterfacedir, haddockdir,
InstallDirTemplates(..),
absoluteInstallDirs, toPathTemplate)
import Distribution.Simple.Compiler (CompilerFlavor(..), Compiler(..),
compilerVersion, PackageDB(..))
import Distribution.Simple.Program (ConfiguredProgram, programPath,
programArgs, rawSystemProgram,
lookupProgram, ghcPkgProgram)
import Distribution.Simple.Setup (RegisterFlags(..), CopyDest(..))
import Distribution.PackageDescription (setupMessage, PackageDescription(..),
BuildInfo(..), Library(..), haddockName)
import Distribution.Package (PackageIdentifier(..), showPackageId)
import Distribution.Version (Version(..))
import Distribution.Verbosity
import Distribution.InstalledPackageInfo
(InstalledPackageInfo, showInstalledPackageInfo,
emptyInstalledPackageInfo)
import qualified Distribution.InstalledPackageInfo as IPI
import Distribution.Simple.Utils (createDirectoryIfMissingVerbose,
copyFileVerbose, die, info)
import Distribution.Simple.GHC.PackageConfig (mkGHCPackageConfig, showGHCPackageConfig)
import qualified Distribution.Simple.GHC.PackageConfig
as GHC (localPackageConfig, canWriteLocalPackageConfig, maybeCreateLocalPackageConfig)
import Distribution.System
import Distribution.Compat.Directory
(removeDirectoryRecursive,
setPermissions, getPermissions, Permissions(executable)
)
import System.FilePath ((</>), (<.>), isAbsolute)
import System.Directory( removeFile, getCurrentDirectory)
import System.IO.Error (try)
import Control.Monad (when)
import Data.Maybe (isNothing, fromJust, fromMaybe)
import Data.List (partition)
#ifdef DEBUG
import Test.HUnit (Test)
#endif
regScriptLocation :: FilePath
regScriptLocation = case os of
Windows _ -> "register.bat"
_ -> "register.sh"
unregScriptLocation :: FilePath
unregScriptLocation = case os of
Windows _ -> "unregister.bat"
_ -> "unregister.sh"
register :: PackageDescription -> LocalBuildInfo
-> RegisterFlags
-> IO ()
register pkg_descr lbi regFlags
| isNothing (library pkg_descr) = do
setupMessage (regVerbose regFlags) "No package to register" pkg_descr
return ()
| otherwise = do
let ghc_63_plus = compilerVersion (compiler lbi) >= Version [6,3] []
isWindows = case os of Windows _ -> True; _ -> False
genScript = regGenScript regFlags
genPkgConf = regGenPkgConf regFlags
genPkgConfigDefault = showPackageId (package pkg_descr) <.> "conf"
genPkgConfigFile = fromMaybe genPkgConfigDefault
(regPkgConfFile regFlags)
verbosity = regVerbose regFlags
packageDB = fromMaybe (withPackageDB lbi) (regPackageDB regFlags)
inplace = regInPlace regFlags
message | genPkgConf = "Writing package registration file: "
++ genPkgConfigFile ++ " for"
| genScript = "Writing registration script: "
++ regScriptLocation ++ " for"
| otherwise = "Registering"
setupMessage (regVerbose regFlags) message pkg_descr
case compilerFlavor (compiler lbi) of
GHC -> do
config_flags <- case packageDB of
GlobalPackageDB -> return []
UserPackageDB
| ghc_63_plus -> return ["--user"]
| otherwise -> do
GHC.maybeCreateLocalPackageConfig
localConf <- GHC.localPackageConfig
pkgConfWriteable <- GHC.canWriteLocalPackageConfig
when (not pkgConfWriteable && not genScript)
$ userPkgConfErr localConf
return ["--config-file=" ++ localConf]
SpecificPackageDB db
| ghc_63_plus -> return ["-package-conf", db]
| otherwise -> return ["--config-file=" ++ db]
let instConf | genPkgConf = genPkgConfigFile
| inplace = inplacePkgConfigFile
| otherwise = installedPkgConfigFile
when (genPkgConf || not genScript) $ do
info verbosity ("create " ++ instConf)
writeInstalledConfig pkg_descr lbi inplace (Just instConf)
let register_flags
| ghc_63_plus = let conf = if genScript && not isWindows
then ["-"]
else [instConf]
in "update" : conf
| otherwise = let conf = if genScript && not isWindows
then []
else ["--input-file="++instConf]
in "--update-package" : conf
let allFlags = config_flags ++ register_flags
let Just pkgTool = lookupProgram ghcPkgProgram (withPrograms lbi)
case () of
_ | genPkgConf -> return ()
| genScript ->
do cfg <- showInstalledConfig pkg_descr lbi inplace
rawSystemPipe pkgTool regScriptLocation cfg allFlags
_ -> rawSystemProgram verbosity pkgTool allFlags
Hugs -> do
when inplace $ die "--inplace is not supported with Hugs"
let installDirs = absoluteInstallDirs pkg_descr lbi NoCopyDest
createDirectoryIfMissingVerbose verbosity True (libdir installDirs)
copyFileVerbose verbosity installedPkgConfigFile
(libdir installDirs </> "package.conf")
JHC -> when (verbosity >= normal) $ putStrLn "registering for JHC (nothing to do)"
NHC -> when (verbosity >= normal) $ putStrLn "registering nhc98 (nothing to do)"
_ -> die ("only registering with GHC/Hugs/jhc/nhc98 is implemented")
userPkgConfErr :: String -> IO a
userPkgConfErr local_conf =
die ("--user flag passed, but cannot write to local package config: "
++ local_conf )
writeInstalledConfig :: PackageDescription -> LocalBuildInfo -> Bool
-> Maybe FilePath -> IO ()
writeInstalledConfig pkg_descr lbi inplace instConfOverride = do
pkg_config <- showInstalledConfig pkg_descr lbi inplace
let instConfDefault | inplace = inplacePkgConfigFile
| otherwise = installedPkgConfigFile
instConf = fromMaybe instConfDefault instConfOverride
writeFile instConf (pkg_config ++ "\n")
showInstalledConfig :: PackageDescription -> LocalBuildInfo -> Bool
-> IO String
showInstalledConfig pkg_descr lbi inplace
| (case compilerFlavor hc of GHC -> True; _ -> False) &&
compilerVersion hc < Version [6,3] []
= if inplace then
error "--inplace not supported for GHC < 6.3"
else
return (showGHCPackageConfig (mkGHCPackageConfig pkg_descr lbi))
| otherwise
= do cfg <- mkInstalledPackageInfo pkg_descr lbi inplace
return (showInstalledPackageInfo cfg)
where
hc = compiler lbi
removeInstalledConfig :: IO ()
removeInstalledConfig = do
try $ removeFile installedPkgConfigFile
try $ removeFile inplacePkgConfigFile
return ()
removeRegScripts :: IO ()
removeRegScripts = do
try $ removeFile regScriptLocation
try $ removeFile unregScriptLocation
return ()
installedPkgConfigFile :: FilePath
installedPkgConfigFile = distPref </> "installed-pkg-config"
inplacePkgConfigFile :: FilePath
inplacePkgConfigFile = distPref </> "inplace-pkg-config"
mkInstalledPackageInfo
:: PackageDescription
-> LocalBuildInfo
-> Bool
-> IO InstalledPackageInfo
mkInstalledPackageInfo pkg_descr lbi inplace = do
pwd <- getCurrentDirectory
let
lib = fromJust (library pkg_descr)
bi = libBuildInfo lib
build_dir = pwd </> buildDir lbi
installDirs = absoluteInstallDirs pkg_descr lbi NoCopyDest
inplaceDirs = absoluteInstallDirs pkg_descr lbi {
installDirTemplates = (installDirTemplates lbi) {
dataDirTemplate = toPathTemplate pwd,
dataSubdirTemplate = toPathTemplate distPref,
docDirTemplate = toPathTemplate (pwd </> distPref </> "doc"),
htmlDirTemplate = toPathTemplate (pwd </> distPref </> "doc" </> "html" </> pkgName (package pkg_descr)),
interfaceDirTemplate = toPathTemplate (pwd </> distPref </> "doc" </> "html" </> pkgName (package pkg_descr))
}
} NoCopyDest
(absinc,relinc) = partition isAbsolute (includeDirs bi)
installIncludeDir | null (installIncludes bi) = []
| otherwise = [includedir installDirs]
haddockInterfaceDir
| inplace = haddockinterfacedir inplaceDirs pkg_descr
| otherwise = haddockinterfacedir installDirs pkg_descr
haddockDir
| inplace = haddockdir inplaceDirs pkg_descr
| otherwise = haddockdir installDirs pkg_descr
libraryDir
| inplace = build_dir
| otherwise = libdir installDirs
in
return emptyInstalledPackageInfo{
IPI.package = package pkg_descr,
IPI.license = license pkg_descr,
IPI.copyright = copyright pkg_descr,
IPI.maintainer = maintainer pkg_descr,
IPI.author = author pkg_descr,
IPI.stability = stability pkg_descr,
IPI.homepage = homepage pkg_descr,
IPI.pkgUrl = pkgUrl pkg_descr,
IPI.description = description pkg_descr,
IPI.category = category pkg_descr,
IPI.exposed = True,
IPI.exposedModules = exposedModules lib,
IPI.hiddenModules = otherModules bi,
IPI.importDirs = [libraryDir],
IPI.libraryDirs = libraryDir : extraLibDirs bi,
IPI.hsLibraries = ["HS" ++ showPackageId (package pkg_descr)],
IPI.extraLibraries = extraLibs bi,
IPI.includeDirs = absinc ++ if inplace
then map (pwd </>) relinc
else installIncludeDir,
IPI.includes = includes bi,
IPI.depends = packageDeps lbi,
IPI.hugsOptions = concat [opts | (Hugs,opts) <- options bi],
IPI.ccOptions = ccOptions bi,
IPI.ldOptions = ldOptions bi,
IPI.frameworkDirs = [],
IPI.frameworks = frameworks bi,
IPI.haddockInterfaces = [haddockInterfaceDir </> haddockName pkg_descr],
IPI.haddockHTMLs = [haddockDir]
}
unregister :: PackageDescription -> LocalBuildInfo -> RegisterFlags -> IO ()
unregister pkg_descr lbi regFlags = do
setupMessage (regVerbose regFlags) "Unregistering" pkg_descr
let ghc_63_plus = compilerVersion (compiler lbi) >= Version [6,3] []
genScript = regGenScript regFlags
verbosity = regVerbose regFlags
packageDB = fromMaybe (withPackageDB lbi) (regPackageDB regFlags)
installDirs = absoluteInstallDirs pkg_descr lbi NoCopyDest
case compilerFlavor (compiler lbi) of
GHC -> do
config_flags <- case packageDB of
GlobalPackageDB -> return []
UserPackageDB
| ghc_63_plus -> return ["--user"]
| otherwise -> do
GHC.maybeCreateLocalPackageConfig
localConf <- GHC.localPackageConfig
pkgConfWriteable <- GHC.canWriteLocalPackageConfig
when (not pkgConfWriteable && not genScript)
$ userPkgConfErr localConf
return ["--config-file=" ++ localConf]
SpecificPackageDB db
| ghc_63_plus -> return ["-package-conf", db]
| otherwise -> return ["--config-file=" ++ db]
let removeCmd = if ghc_63_plus
then ["unregister",showPackageId (package pkg_descr)]
else ["--remove-package="++(pkgName $ package pkg_descr)]
let Just pkgTool = lookupProgram ghcPkgProgram (withPrograms lbi)
allArgs = removeCmd ++ config_flags
if genScript
then rawSystemEmit pkgTool unregScriptLocation allArgs
else rawSystemProgram verbosity pkgTool allArgs
Hugs -> do
try $ removeDirectoryRecursive (libdir installDirs)
return ()
NHC -> do
try $ removeDirectoryRecursive (libdir installDirs)
return ()
_ ->
die ("only unregistering with GHC and Hugs is implemented")
rawSystemEmit :: ConfiguredProgram
-> FilePath
-> [String]
-> IO ()
rawSystemEmit prog scriptName extraArgs
= case os of
Windows _ ->
writeFile scriptName ("@" ++ path ++ concatMap (' ':) args)
_ -> do writeFile scriptName ("#!/bin/sh\n\n"
++ (path ++ concatMap (' ':) args)
++ "\n")
p <- getPermissions scriptName
setPermissions scriptName p{executable=True}
where args = programArgs prog ++ extraArgs
path = programPath prog
rawSystemPipe :: ConfiguredProgram
-> FilePath
-> String
-> [String]
-> IO ()
rawSystemPipe prog scriptName pipeFrom extraArgs
= case os of
Windows _ ->
writeFile scriptName ("@" ++ path ++ concatMap (' ':) args)
_ -> do writeFile scriptName ("#!/bin/sh\n\n"
++ "echo '" ++ escapeForShell pipeFrom
++ "' | "
++ (path ++ concatMap (' ':) args)
++ "\n")
p <- getPermissions scriptName
setPermissions scriptName p{executable=True}
where escapeForShell [] = []
escapeForShell ('\'':cs) = "'\\''" ++ escapeForShell cs
escapeForShell (c :cs) = c : escapeForShell cs
args = programArgs prog ++ extraArgs
path = programPath prog
#ifdef DEBUG
hunitTests :: [Test]
hunitTests = []
#endif