-----------------------------------------------------------------------------
--- $Id: Main.hs,v 1.13 2001/08/21 09:03:32 rrt Exp $
+-- $Id: Main.hs,v 1.22 2002/04/22 14:20:41 simonmar Exp $
--
-- Package management tool
-----------------------------------------------------------------------------
import Pretty
import Monad
import Directory
-import System
+import System ( getEnv, getArgs,
+ system, exitWith,
+ ExitCode(..)
+ )
import IO
+import List ( isPrefixOf )
-#include "../includes/config.h"
+#include "../../includes/config.h"
#ifdef mingw32_TARGET_OS
import Win32DLL
args <- getArgs
case getOpt Permute flags args of
- (clis,[],[]) -> runit clis
+ (clis@(_:_),[],[]) -> runit clis
(_,_,errors) -> die (concat errors ++
usageInfo usageHeader flags)
-data Flag = Config String | List | Add | Remove String | Show String | Field String
-isConfigOrField (Config _) = True
-isConfigOrField (Field _) = True
-isConfigOrField _ = False
+data Flag
+ = Config FilePath
+ | Input FilePath
+ | List | Add Bool {- True => replace existing info -}
+ | Remove String | Show String
+ | Field String | AutoGHCiLibs | Force
+ deriving (Eq)
+
+isAction (Config _) = False
+isAction (Field _) = False
+isAction (Input _) = False
+isAction (AutoGHCiLibs) = False
+isAction _ = True
usageHeader = "ghc-pkg [OPTION...]"
"Use the specified package config file",
Option ['l'] ["list-packages"] (NoArg List)
"List the currently installed packages",
- Option ['a'] ["add-package"] (NoArg Add)
+ Option ['a'] ["add-package"] (NoArg (Add False))
"Add a new package",
+ Option ['u'] ["update-package"] (NoArg (Add True))
+ "Update package with new configuration",
+ Option ['i'] ["input-file"] (ReqArg Input "FILE")
+ "Read new package info from specified file",
Option ['s'] ["show-package"] (ReqArg Show "NAME")
"Show the configuration for package NAME",
Option [] ["field"] (ReqArg Field "FIELD")
"(with --show-package) Show field FIELD only",
+ Option [] ["force"] (NoArg Force)
+ "ignore missing directories/libraries",
Option ['r'] ["remove-package"] (ReqArg Remove "NAME")
- "Remove an installed package"
+ "Remove an installed package",
+ Option ['g'] ["auto-ghci-libs"] (NoArg AutoGHCiLibs)
+ "Automatically build libs for GHCi (with -a)"
]
#ifdef mingw32_TARGET_OS
#else
[] -> do h <- getModuleHandle Nothing
n <- getModuleFileName h
--- return (reverse (tail (dropWhile (not . isSlash)
return (reverse (drop (length "/bin/ghc-pkg.exe") (reverse (unDosifyPath n))) ++ "/package.conf")
--- (reverse (unDosifyPath n)))) ++ "/package.conf")
#endif
let toField "import_dirs" = return import_dirs
fields <- mapM toField [ f | Field f <- clis ]
s <- readFile conf_file
- let details = read s :: [PackageConfig]
- eval_catch details (\_ -> die "parse error in package config file")
-
- case [ c | c <- clis, not (isConfigOrField c) ] of
- [ List ] -> listPackages details
- [ Add ] -> addPackage details conf_file
- [ Remove p ] -> removePackage details conf_file p
- [ Show p ] -> showPackage details conf_file p fields
+ let packages = read s :: [PackageConfig]
+ eval_catch packages (\_ -> die "parse error in package config file")
+
+ let auto_ghci_libs = any isAuto clis
+ where isAuto AutoGHCiLibs = True; isAuto _ = False
+ input_file = head ([ f | (Input f) <- clis] ++ ["-"])
+
+ force = Force `elem` clis
+
+ case [ c | c <- clis, isAction c ] of
+ [ List ] -> listPackages packages
+ [ Add upd ] -> addPackage packages conf_file input_file
+ auto_ghci_libs upd force
+ [ Remove p ] -> removePackage packages conf_file p
+ [ Show p ] -> showPackage packages conf_file p fields
_ -> die (usageInfo usageHeader flags)
listPackages :: [PackageConfig] -> IO ()
-listPackages details = do
- hPutStr stdout (listPkgs details)
- hPutChar stdout '\n'
-
-showPackage :: [PackageConfig] -> FilePath -> String
- -> [PackageConfig->[String]] -> IO ()
-showPackage details pkgconf pkg_name fields =
- case [ p | p <- details, name p == pkg_name ] of
+listPackages packages = hPutStrLn stdout (listPkgs packages)
+
+showPackage :: [PackageConfig]
+ -> FilePath
+ -> String
+ -> [PackageConfig -> [String]]
+ -> IO ()
+showPackage packages pkgconf pkg_name fields =
+ case [ p | p <- packages, name p == pkg_name ] of
[] -> die ("can't find package `" ++ pkg_name ++ "'")
[pkg] | null fields -> hPutStrLn stdout (render (dumpPkgGuts pkg))
| otherwise -> hPutStrLn stdout (render (vcat
(map (vcat . map text) (map ($pkg) fields))))
_ -> die "showPackage: internal error"
-addPackage :: [PackageConfig] -> FilePath -> IO ()
-addPackage details pkgconf = do
+addPackage :: [PackageConfig] -> FilePath -> FilePath
+ -> Bool -> Bool -> Bool -> IO ()
+addPackage packages pkgconf inputFile auto_ghci_libs updatePkg force = do
checkConfigAccess pkgconf
- hPutStr stdout "Reading package info from stdin... "
- s <- getContents
+ s <-
+ case inputFile of
+ "-" -> do
+ hPutStr stdout "Reading package info from stdin... "
+ getContents
+ f -> do
+ hPutStr stdout ("Reading package info from " ++ show f)
+ readFile f
let new_pkg = read s :: PackageConfig
eval_catch new_pkg (\_ -> die "parse error in package info")
hPutStrLn stdout "done."
- if (name new_pkg `elem` map name details)
- then die ("package `" ++ name new_pkg ++ "' already installed")
- else do
+ hPutStr stdout "Expanding embedded variables..."
+ new_exp_pkg <- expandEnvVars new_pkg force
+ hPutStrLn stdout "done."
+ new_details <- validatePackageConfig new_exp_pkg packages
+ auto_ghci_libs updatePkg force
savePackageConfig pkgconf
maybeRestoreOldConfig pkgconf $
- writeNewConfig pkgconf (details ++ [new_pkg])
+ writeNewConfig pkgconf new_details
removePackage :: [PackageConfig] -> FilePath -> String -> IO ()
-removePackage details pkgconf pkg = do
+removePackage packages pkgconf pkgName = do
checkConfigAccess pkgconf
- if (pkg `notElem` map name details)
- then die ("package `" ++ pkg ++ "' not installed")
- else do
+ when (pkgName `notElem` map name packages)
+ (die ("package `" ++ pkgName ++ "' not installed"))
savePackageConfig pkgconf
maybeRestoreOldConfig pkgconf $
- writeNewConfig pkgconf (filter ((/= pkg) . name) details)
+ writeNewConfig pkgconf (filter ((/= pkgName) . name) packages)
checkConfigAccess :: FilePath -> IO ()
checkConfigAccess pkgconf = do
)
writeNewConfig :: String -> [PackageConfig] -> IO ()
-writeNewConfig conf_file details = do
+writeNewConfig conf_file packages = do
hPutStr stdout "Writing new package config file... "
h <- openFile conf_file WriteMode
- hPutStrLn h (dumpPackages details)
+ hPutStrLn h (dumpPackages packages)
hClose h
hPutStrLn stdout "done."
-- mv rather than cp because we've already done an hGetContents
-- on this file so we won't be able to open it for writing
-- unless we move the old one out of the way...
- renameFile conf_file (conf_file ++ ".old")
+ let oldFile = conf_file ++ ".old"
+ doesExist <- doesFileExist oldFile `catch` (\ _ -> return False)
+ when doesExist (removeFile oldFile `catch` (const $ return ()))
+ catch (renameFile conf_file oldFile)
+ (\ err -> do
+ hPutStrLn stderr (unwords [ "Unable to rename "
+ , show conf_file
+ , " to "
+ , show oldFile
+ ])
+ ioError err)
hPutStrLn stdout "done."
-----------------------------------------------------------------------------
+-- Sanity-check a new package config, and automatically build GHCi libs
+-- if requested.
+
+validatePackageConfig :: PackageConfig
+ -> [PackageConfig]
+ -> Bool
+ -> Bool
+ -> Bool
+ -> IO [PackageConfig]
+validatePackageConfig pkg pkgs auto_ghci_libs updatePkg force = do
+ when (not updatePkg && (name pkg `elem` map name pkgs))
+ (die ("package `" ++ name pkg ++ "' is already installed"))
+ mapM_ (checkDep pkgs force) (package_deps pkg)
+ mapM_ (checkDir force) (import_dirs pkg)
+ mapM_ (checkDir force) (source_dirs pkg)
+ mapM_ (checkDir force) (library_dirs pkg)
+ mapM_ (checkDir force) (include_dirs pkg)
+ mapM_ (checkHSLib (library_dirs pkg) auto_ghci_libs force) (hs_libraries pkg)
+ -- ToDo: check these somehow?
+ -- extra_libraries :: [String],
+ -- c_includes :: [String],
+ let existing_pkgs
+ | updatePkg = filter ((/=(name pkg)).name) pkgs
+ | otherwise = pkgs
+ return (existing_pkgs ++ [pkg])
+
+checkDir force d
+ | "$libdir" `isPrefixOf` d = return ()
+ -- can't check this, because we don't know what $libdir is
+ | otherwise = do
+ there <- doesDirectoryExist d
+ when (not there)
+ (dieOrForce force ("`" ++ d ++ "' doesn't exist or isn't a directory"))
+
+checkDep :: [PackageConfig] -> Bool -> String -> IO ()
+checkDep pkgs force n
+ | n `elem` map name pkgs = return ()
+ | otherwise = dieOrForce force ("dependency `" ++ n ++ "' doesn't exist")
+
+checkHSLib :: [String] -> Bool -> Bool -> String -> IO ()
+checkHSLib dirs auto_ghci_libs force lib = do
+ let batch_lib_file = "lib" ++ lib ++ ".a"
+ bs <- mapM (doesLibExistIn batch_lib_file) dirs
+ case [ dir | (exists,dir) <- zip bs dirs, exists ] of
+ [] -> dieOrForce force ("cannot find `" ++ batch_lib_file ++
+ "' on library path")
+ (dir:_) -> checkGHCiLib dirs dir batch_lib_file lib auto_ghci_libs
+
+doesLibExistIn lib d
+ | "$libdir" `isPrefixOf` d = return True
+ | otherwise = doesFileExist (d ++ '/':lib)
+
+checkGHCiLib :: [String] -> String -> String -> String -> Bool -> IO ()
+checkGHCiLib dirs batch_lib_dir batch_lib_file lib auto_build = do
+ let ghci_lib_file = lib ++ ".o"
+ ghci_lib_path = batch_lib_dir ++ '/':ghci_lib_file
+ bs <- mapM (\d -> doesFileExist (d ++ '/':ghci_lib_file)) dirs
+ case [ dir | (exists,dir) <- zip bs dirs, exists ] of
+ [] | auto_build ->
+ autoBuildGHCiLib batch_lib_dir batch_lib_file ghci_lib_file
+ | otherwise ->
+ hPutStrLn stderr ("warning: can't find GHCi lib `"
+ ++ ghci_lib_file ++ "'")
+ (dir:_) -> return ()
+
+-- automatically build the GHCi version of a batch lib,
+-- using ld --whole-archive.
+
+autoBuildGHCiLib dir batch_file ghci_file = do
+ let ghci_lib_file = dir ++ '/':ghci_file
+ batch_lib_file = dir ++ '/':batch_file
+ hPutStr stderr ("building GHCi library `" ++ ghci_lib_file ++ "'...")
+ system("ld -r -x -o " ++ ghci_lib_file ++
+ " --whole-archive " ++ batch_lib_file)
+ hPutStrLn stderr (" done.")
+
+-----------------------------------------------------------------------------
+expandEnvVars :: PackageConfig -> Bool -> IO PackageConfig
+expandEnvVars pkg force = do
+ -- permit _all_ strings to contain ${..} environment variable references,
+ -- arguably too flexible.
+ nm <- expandString (name pkg)
+ imp_dirs <- expandStrings (import_dirs pkg)
+ src_dirs <- expandStrings (source_dirs pkg)
+ lib_dirs <- expandStrings (library_dirs pkg)
+ hs_libs <- expandStrings (hs_libraries pkg)
+ ex_libs <- expandStrings (extra_libraries pkg)
+ inc_dirs <- expandStrings (include_dirs pkg)
+ c_incs <- expandStrings (c_includes pkg)
+ p_deps <- expandStrings (package_deps pkg)
+ e_g_opts <- expandStrings (extra_ghc_opts pkg)
+ e_c_opts <- expandStrings (extra_cc_opts pkg)
+ e_l_opts <- expandStrings (extra_ld_opts pkg)
+ return (pkg { name = nm
+ , import_dirs = imp_dirs
+ , source_dirs = src_dirs
+ , library_dirs = lib_dirs
+ , hs_libraries = hs_libs
+ , extra_libraries = ex_libs
+ , include_dirs = inc_dirs
+ , c_includes = c_incs
+ , package_deps = p_deps
+ , extra_ghc_opts = e_g_opts
+ , extra_cc_opts = e_c_opts
+ , extra_ld_opts = e_l_opts
+ })
+ where
+ expandStrings = mapM expandString
+
+ -- Just for fun, keep this in the IO monad.
+ expandString :: String -> IO String
+ expandString str =
+ case break (=='$') str of
+ (xs, _:'{':rs) ->
+ case span (/='}') rs of
+ (nm,_:remainder) -> do
+ nm' <- lookupEnvVar nm
+ str' <- expandString remainder
+ return (nm' ++ str')
+ _ -> return str -- no closing '}'
+ _ -> return str
+
+ lookupEnvVar nm =
+ catch (System.getEnv nm)
+ (\ _ -> do dieOrForce force ("Unable to expand variable " ++
+ show nm)
+ return "")
+
+-----------------------------------------------------------------------------
die :: String -> IO a
-die s = do { hPutStrLn stderr s; exitWith (ExitFailure 1) }
+die s = do { hFlush stdout ; hPutStrLn stderr s; exitWith (ExitFailure 1) }
+
+dieOrForce :: Bool -> String -> IO ()
+dieOrForce force s
+ | force = do hFlush stdout; hPutStrLn stderr (s ++ " (ignoring)")
+ | otherwise = die s
-----------------------------------------------------------------------------
-- Exceptions