1 {-# OPTIONS -fglasgow-exts #-}
2 -----------------------------------------------------------------------------
4 -- (c) The University of Glasgow 2004.
6 -- Package management tool
8 -----------------------------------------------------------------------------
12 -- - expanding of variables in new-style package conf
13 -- - version manipulation (checking whether old version exists,
14 -- hiding old version?)
16 module Main (main) where
18 import Version ( version, targetOS, targetARCH )
19 import Distribution.InstalledPackageInfo
20 import Distribution.Compat.ReadP
21 import Distribution.ParseUtils ( showError, ParseResult(..) )
22 import Distribution.Package
23 import Distribution.Version
24 import Compat.Directory ( getAppUserDataDirectory, createDirectoryIfMissing )
25 import Compat.RawSystem ( rawSystem )
26 import Control.Exception ( evaluate )
27 import qualified Control.Exception as Exception
31 #if __GLASGOW_HASKELL__ < 603
35 #if __GLASGOW_HASKELL__ >= 504
36 import System.Console.GetOpt
37 import Text.PrettyPrint
38 import qualified Control.Exception as Exception
42 import qualified Exception
45 import Data.Char ( isSpace )
48 import System ( getArgs, getProgName,
49 exitWith, ExitCode(..)
52 import Data.List ( isPrefixOf, isSuffixOf, intersperse )
54 #ifdef mingw32_TARGET_OS
57 #if __GLASGOW_HASKELL__ >= 504
58 import Foreign.C.String
64 -- -----------------------------------------------------------------------------
71 case getOpt Permute flags args of
72 (cli,_,[]) | FlagHelp `elem` cli -> do
73 prog <- getProgramName
74 bye (usageInfo (usageHeader prog) flags)
75 (cli,_,[]) | FlagVersion `elem` cli ->
79 (_,_,errors) -> tryOldCmdLine errors args
81 -- If the new command-line syntax fails, then we try the old. If that
82 -- fails too, then we output the original errors and the new syntax
83 -- (so the old syntax is still available, but hidden).
84 tryOldCmdLine :: [String] -> [String] -> IO ()
85 tryOldCmdLine errors args = do
86 case getOpt Permute oldFlags args of
90 prog <- getProgramName
91 die (concat errors ++ usageInfo (usageHeader prog) flags)
93 -- -----------------------------------------------------------------------------
94 -- Command-line syntax
101 | FlagConfig FilePath
102 | FlagGlobalConfig FilePath
107 flags :: [OptDescr Flag]
109 Option [] ["user"] (NoArg FlagUser)
110 "use the current user's package database",
111 Option [] ["global"] (NoArg FlagGlobal)
112 "(default) use the global package database",
113 Option ['f'] ["package-conf"] (ReqArg FlagConfig "FILE")
114 "act upon specified package config file (only)",
115 Option [] ["global-conf"] (ReqArg FlagGlobalConfig "FILE")
116 "location of the global package config",
117 Option [] ["force"] (NoArg FlagForce)
118 "ignore missing dependencies, directories, and libraries",
119 Option ['g'] ["auto-ghci-libs"] (NoArg FlagAutoGHCiLibs)
120 "automatically build libs for GHCi (with register)",
121 Option ['?'] ["help"] (NoArg FlagHelp)
122 "display this help and exit",
123 Option ['V'] ["version"] (NoArg FlagVersion)
124 "output version information and exit"
127 ourCopyright :: String
128 ourCopyright = "GHC package manager version " ++ version ++ "\n"
130 usageHeader :: String -> String
131 usageHeader prog = substProg prog $
133 " $p register {filename | -}\n" ++
134 " Register the package using the specified installed package\n" ++
135 " description. The syntax for the latter is given in the $p\n" ++
136 " documentation.\n" ++
138 " $p update {filename | -}\n" ++
139 " Register the package, overwriting any other package with the\n" ++
142 " $p unregister {pkg-id}\n" ++
143 " Unregister the specified package.\n" ++
145 " $p expose {pkg-id}\n" ++
146 " Expose the specified package.\n" ++
148 " $p hide {pkg-id}\n" ++
149 " Hide the specified package.\n" ++
152 " List all registered packages, both global and user (unless either\n" ++
153 " --global or --user is specified), and both hidden and exposed.\n" ++
155 " $p describe {pkg-id}\n" ++
156 " Give the registered description for the specified package. The\n" ++
157 " description is returned in precisely the syntax required by $p\n" ++
160 " $p field {pkg-id} {field}\n" ++
161 " Extract the specified field of the package description for the\n" ++
162 " specified package.\n" ++
164 " The following optional flags are also accepted:\n"
166 substProg :: String -> String -> String
168 substProg prog ('$':'p':xs) = prog ++ substProg prog xs
169 substProg prog (c:xs) = c : substProg prog xs
171 -- -----------------------------------------------------------------------------
174 runit :: [Flag] -> [String] -> IO ()
175 runit cli nonopts = do
176 prog <- getProgramName
177 dbs <- getPkgDatabases cli
178 db_stack <- mapM readParseDatabase dbs
180 force = FlagForce `elem` cli
181 auto_ghci_libs = FlagAutoGHCiLibs `elem` cli
183 -- first, parse the command
185 ["register", filename] ->
186 registerPackage filename [] db_stack auto_ghci_libs False force
187 ["update", filename] ->
188 registerPackage filename [] db_stack auto_ghci_libs True force
189 ["unregister", pkgid_str] -> do
190 pkgid <- readPkgId pkgid_str
191 unregisterPackage pkgid db_stack
192 ["expose", pkgid_str] -> do
193 pkgid <- readPkgId pkgid_str
194 exposePackage pkgid db_stack
195 ["hide", pkgid_str] -> do
196 pkgid <- readPkgId pkgid_str
197 hidePackage pkgid db_stack
199 listPackages db_stack
200 ["describe", pkgid_str] -> do
201 pkgid <- readPkgId pkgid_str
202 describePackage db_stack pkgid
203 ["field", pkgid_str, field] -> do
204 pkgid <- readPkgId pkgid_str
205 describeField db_stack pkgid field
207 die ("missing command\n" ++
208 usageInfo (usageHeader prog) flags)
210 die ("command-line syntax error\n" ++
211 usageInfo (usageHeader prog) flags)
213 parseCheck :: ReadP a a -> String -> String -> IO a
214 parseCheck parser str what =
215 case [ x | (x,ys) <- readP_to_S parser str, all isSpace ys ] of
217 _ -> die ("cannot parse \'" ++ str ++ "\' as a " ++ what)
219 readPkgId :: String -> IO PackageIdentifier
220 readPkgId str = parseCheck parsePackageId str "package identifier"
222 -- -----------------------------------------------------------------------------
225 -- Some commands operate on a single database:
226 -- register, unregister, expose, hide
227 -- however these commands also check the union of the available databases
228 -- in order to check consistency. For example, register will check that
229 -- dependencies exist before registering a package.
231 -- Some commands operate on multiple databases, with overlapping semantics:
232 -- list, describe, field
234 type PackageDBName = FilePath
235 type PackageDB = [InstalledPackageInfo]
237 type PackageDBStack = [(PackageDBName,PackageDB)]
238 -- A stack of package databases. Convention: head is the topmost
239 -- in the stack. Earlier entries override later one.
241 -- The output of this function is the list of databases to act upon, with
242 -- the "topmost" overlapped database last. The commands which operate on a
243 -- single database will use the last one. Commands which operate on multiple
244 -- databases will interpret the databases as overlapping.
245 getPkgDatabases :: [Flag] -> IO [PackageDBName]
246 getPkgDatabases flags = do
247 -- first we determine the location of the global package config. On Windows,
248 -- this is found relative to the ghc-pkg.exe binary, whereas on Unix the
249 -- location is passed to the binary using the --global-config flag by the
251 let err_msg = "missing --global-conf option, location of global package.conf unknown\n"
253 case [ f | FlagGlobalConfig f <- flags ] of
254 [] -> do mb_dir <- getExecDir "/bin/ghc-pkg.exe"
256 Nothing -> die err_msg
257 Just dir -> return (dir `joinFileName` "package.conf")
258 fs -> return (last fs)
260 -- get the location of the user package database, and create it if necessary
261 appdir <- getAppUserDataDirectory "ghc"
264 subdir = targetARCH ++ '-':targetOS ++ '-':version
265 archdir = appdir `joinFileName` subdir
266 user_conf = archdir `joinFileName` "package.conf"
267 b <- doesFileExist user_conf
269 putStrLn ("Creating user package database in " ++ user_conf)
270 createDirectoryIfMissing True archdir
271 writeFile user_conf emptyPackageConfig
274 databases = foldl addDB [global_conf] flags
276 -- implement the following rules:
277 -- global database is the default
278 -- --user means overlap with the user database
279 -- --global means reset to just the global database
280 -- -f <file> means overlap with <file>
281 addDB dbs FlagUser = user_conf : dbs
282 addDB dbs FlagGlobal = [global_conf]
283 addDB dbs (FlagConfig f) = f : dbs
288 readParseDatabase :: PackageDBName -> IO (PackageDBName,PackageDB)
289 readParseDatabase filename = do
290 str <- readFile filename
291 let packages = read str
293 `Exception.catch` \_ ->
294 die (filename ++ ": parse error in package config file")
295 return (filename,packages)
297 emptyPackageConfig :: String
298 emptyPackageConfig = "[]"
300 -- -----------------------------------------------------------------------------
303 registerPackage :: FilePath
304 -> [(String,String)] -- defines, ToDo: maybe remove?
306 -> Bool -- auto_ghci_libs
310 registerPackage input defines db_stack auto_ghci_libs update force = do
312 db_to_operate_on = head db_stack
313 db_filename = fst db_to_operate_on
315 checkConfigAccess db_filename
320 putStr "Reading package info from stdin... "
323 putStr ("Reading package info from " ++ show f ++ " ")
326 pkg <- parsePackageInfo s defines force
329 validatePackageConfig pkg db_stack auto_ghci_libs update force
330 new_details <- updatePackageDB db_stack (snd db_to_operate_on) pkg
331 savePackageConfig db_filename
332 maybeRestoreOldConfig db_filename $
333 writeNewConfig db_filename new_details
339 -> IO InstalledPackageInfo
340 parsePackageInfo str defines force =
341 case parseInstalledPackageInfo str of
342 ParseOk ok -> return ok
343 ParseFailed err -> die (showError err)
345 -- Used for converting versionless package names to new
346 -- PackageIdentifiers. "Version [] []" is special: it means "no
347 -- version" or "any version"
348 pkgNameToId :: String -> PackageIdentifier
349 pkgNameToId name = PackageIdentifier name (Version [] [])
351 -- -----------------------------------------------------------------------------
352 -- Exposing, Hiding, Unregistering are all similar
354 exposePackage :: PackageIdentifier -> PackageDBStack -> IO ()
355 exposePackage = modifyPackage (\p -> [p{exposed=True}])
357 hidePackage :: PackageIdentifier -> PackageDBStack -> IO ()
358 hidePackage = modifyPackage (\p -> [p{exposed=False}])
360 unregisterPackage :: PackageIdentifier -> PackageDBStack -> IO ()
361 unregisterPackage = modifyPackage (\p -> [])
364 :: (InstalledPackageInfo -> [InstalledPackageInfo])
368 modifyPackage _ _ [] = error "modifyPackage"
369 modifyPackage fn pkgid ((db_name, pkgs) : _) = do
370 checkConfigAccess db_name
371 p <- findPackage [(db_name,pkgs)] pkgid
373 savePackageConfig db_name
374 let new_config = concat (map modify pkgs)
376 | package pkg == pid = fn pkg
378 maybeRestoreOldConfig db_name $
379 writeNewConfig db_name new_config
381 -- -----------------------------------------------------------------------------
384 listPackages :: PackageDBStack -> IO ()
385 listPackages db_confs = do
386 mapM_ show_pkgconf (reverse db_confs)
387 where show_pkgconf (db_name,pkg_confs) =
388 hPutStrLn stdout (render $
389 text (db_name ++ ":") $$ nest 4 packages
391 where packages = fsep (punctuate comma (map pp_pkg pkg_confs))
394 | otherwise = parens doc
395 where doc = text (showPackageId (package p))
397 -- -----------------------------------------------------------------------------
400 describePackage :: PackageDBStack -> PackageIdentifier -> IO ()
401 describePackage db_stack pkgid = do
402 p <- findPackage db_stack pkgid
403 putStrLn (showInstalledPackageInfo p)
405 findPackage :: PackageDBStack -> PackageIdentifier -> IO InstalledPackageInfo
406 findPackage db_stack pkgid
407 = case [ p | p <- all_pkgs, pkgid `matches` p ] of
408 [] -> die ("cannot find package " ++ showPackageId pkgid)
410 ps -> die ("package " ++ showPackageId pkgid ++
411 " matches multiple packages: " ++
412 concat (intersperse ", " (
413 map (showPackageId.package) ps)))
415 all_pkgs = concat (map snd db_stack)
417 matches :: PackageIdentifier -> InstalledPackageInfo -> Bool
420 not (realVersion pid) && pkgName pid == pkgName (package p)
422 -- -----------------------------------------------------------------------------
425 describeField :: PackageDBStack -> PackageIdentifier -> String -> IO ()
426 describeField db_stack pkgid field = do
427 case toField field of
428 Nothing -> die ("unknown field: " ++ field)
430 p <- findPackage db_stack pkgid
433 toField :: String -> Maybe (InstalledPackageInfo -> String)
434 -- backwards compatibility:
435 toField "import_dirs" = Just $ strList . importDirs
436 toField "source_dirs" = Just $ strList . importDirs
437 toField "library_dirs" = Just $ strList . libraryDirs
438 toField "hs_libraries" = Just $ strList . hsLibraries
439 toField "extra_libraries" = Just $ strList . extraLibraries
440 toField "include_dirs" = Just $ strList . includeDirs
441 toField "c_includes" = Just $ strList . includes
442 toField "package_deps" = Just $ strList . map showPackageId. depends
443 toField "extra_cc_opts" = Just $ strList . extraCcOpts
444 toField "extra_ld_opts" = Just $ strList . extraLdOpts
445 toField "framework_dirs" = Just $ strList . frameworkDirs
446 toField "extra_frameworks"= Just $ strList . extraFrameworks
447 toField s = showInstalledPackageInfoField s
449 strList :: [String] -> String
452 -- -----------------------------------------------------------------------------
453 -- Manipulating package.conf files
455 checkConfigAccess :: FilePath -> IO ()
456 checkConfigAccess filename = do
457 access <- getPermissions filename
458 when (not (writable access))
459 (die (filename ++ ": you don't have permission to modify this file"))
461 maybeRestoreOldConfig :: FilePath -> IO () -> IO ()
462 maybeRestoreOldConfig filename io
463 = io `catch` \e -> do
464 hPutStrLn stderr (show e)
465 hPutStr stdout ("\nWARNING: an error was encountered while the new \n"++
466 "configuration was being written. Attempting to \n"++
467 "restore the old configuration... ")
468 renameFile (filename ++ ".old") filename
469 hPutStrLn stdout "done."
472 writeNewConfig :: FilePath -> [InstalledPackageInfo] -> IO ()
473 writeNewConfig filename packages = do
474 hPutStr stdout "Writing new package config file... "
475 h <- openFile filename WriteMode
476 hPutStrLn h (show packages)
478 hPutStrLn stdout "done."
480 savePackageConfig :: FilePath -> IO ()
481 savePackageConfig filename = do
482 hPutStr stdout "Saving old package config file... "
483 -- mv rather than cp because we've already done an hGetContents
484 -- on this file so we won't be able to open it for writing
485 -- unless we move the old one out of the way...
486 let oldFile = filename ++ ".old"
487 doesExist <- doesFileExist oldFile `catch` (\ _ -> return False)
488 when doesExist (removeFile oldFile `catch` (const $ return ()))
489 catch (renameFile filename oldFile)
491 hPutStrLn stderr (unwords [ "Unable to rename "
497 hPutStrLn stdout "done."
499 -----------------------------------------------------------------------------
500 -- Sanity-check a new package config, and automatically build GHCi libs
503 validatePackageConfig :: InstalledPackageInfo
505 -> Bool -- auto-ghc-libs
509 validatePackageConfig pkg db_stack auto_ghci_libs update force = do
510 checkDuplicates db_stack pkg update
511 mapM_ (checkDep db_stack force) (depends pkg)
512 mapM_ (checkDir force) (importDirs pkg)
513 mapM_ (checkDir force) (libraryDirs pkg)
514 mapM_ (checkDir force) (includeDirs pkg)
515 mapM_ (checkHSLib (libraryDirs pkg) auto_ghci_libs force) (hsLibraries pkg)
516 -- ToDo: check these somehow?
517 -- extra_libraries :: [String],
518 -- c_includes :: [String],
521 checkDuplicates :: PackageDBStack -> InstalledPackageInfo -> Bool -> IO ()
522 checkDuplicates db_stack pkg update = do
526 (_top_db_name, pkgs) : _ = db_stack
528 pkgs_with_same_name =
529 [ p | p <- pkgs, pkgName (package p) == pkgName pkgid]
530 exposed_pkgs_with_same_name =
531 filter exposed pkgs_with_same_name
533 -- Check whether this package id already exists in this DB
535 when (not update && (package pkg `elem` map package pkgs)) $
536 die ("package " ++ showPackageId pkgid ++ " is already installed")
538 -- if we are exposing this new package, then check that
539 -- there are no other exposed packages with the same name.
541 when (not update && exposed pkg && not (null exposed_pkgs_with_same_name)) $
542 die ("trying to register " ++ showPackageId pkgid
543 ++ " as exposed, but "
544 ++ showPackageId (package (head exposed_pkgs_with_same_name))
545 ++ " is also exposed.")
548 checkDir :: Bool -> String -> IO ()
550 | "$topdir" `isPrefixOf` d = return ()
551 -- can't check this, because we don't know what $topdir is
553 there <- doesDirectoryExist d
555 (dieOrForce force (d ++ " doesn't exist or isn't a directory"))
557 checkDep :: PackageDBStack -> Bool -> PackageIdentifier -> IO ()
558 checkDep db_stack force pkgid
559 | real_version && pkgid `elem` pkgids = return ()
560 | not real_version && pkgName pkgid `elem` pkg_names = return ()
561 | otherwise = dieOrForce force ("dependency " ++ showPackageId pkgid
564 -- for backwards compat, we treat 0.0 as a special version,
565 -- and don't check that it actually exists.
566 real_version = realVersion pkgid
568 all_pkgs = concat (map snd db_stack)
569 pkgids = map package all_pkgs
570 pkg_names = map pkgName pkgids
572 realVersion :: PackageIdentifier -> Bool
573 realVersion pkgid = versionBranch (pkgVersion pkgid) /= []
575 checkHSLib :: [String] -> Bool -> Bool -> String -> IO ()
576 checkHSLib dirs auto_ghci_libs force lib = do
577 let batch_lib_file = "lib" ++ lib ++ ".a"
578 bs <- mapM (doesLibExistIn batch_lib_file) dirs
579 case [ dir | (exists,dir) <- zip bs dirs, exists ] of
580 [] -> dieOrForce force ("cannot find " ++ batch_lib_file ++
582 (dir:_) -> checkGHCiLib dirs dir batch_lib_file lib auto_ghci_libs
584 doesLibExistIn :: String -> String -> IO Bool
586 | "$topdir" `isPrefixOf` d = return True
587 | otherwise = doesFileExist (d ++ '/':lib)
589 checkGHCiLib :: [String] -> String -> String -> String -> Bool -> IO ()
590 checkGHCiLib dirs batch_lib_dir batch_lib_file lib auto_build
591 | auto_build = autoBuildGHCiLib batch_lib_dir batch_lib_file ghci_lib_file
593 bs <- mapM (doesLibExistIn ghci_lib_file) dirs
594 case [dir | (exists,dir) <- zip bs dirs, exists] of
595 [] -> hPutStrLn stderr ("warning: can't find GHCi lib " ++ ghci_lib_file)
598 ghci_lib_file = lib ++ ".o"
600 -- automatically build the GHCi version of a batch lib,
601 -- using ld --whole-archive.
603 autoBuildGHCiLib :: String -> String -> String -> IO ()
604 autoBuildGHCiLib dir batch_file ghci_file = do
605 let ghci_lib_file = dir ++ '/':ghci_file
606 batch_lib_file = dir ++ '/':batch_file
607 hPutStr stderr ("building GHCi library " ++ ghci_lib_file ++ "...")
608 #if defined(darwin_TARGET_OS)
609 r <- rawSystem "ld" ["-r","-x","-o",ghci_lib_file,"-all_load",batch_lib_file]
610 #elif defined(mingw32_HOST_OS)
611 execDir <- getExecDir "/bin/ghc-pkg.exe"
612 r <- rawSystem (maybe "" (++"/gcc-lib/") execDir++"ld") ["-r","-x","-o",ghci_lib_file,"--whole-archive",batch_lib_file]
614 r <- rawSystem "ld" ["-r","-x","-o",ghci_lib_file,"--whole-archive",batch_lib_file]
616 when (r /= ExitSuccess) $ exitWith r
617 hPutStrLn stderr (" done.")
619 -- -----------------------------------------------------------------------------
620 -- Updating the DB with the new package.
624 -> [InstalledPackageInfo]
625 -> InstalledPackageInfo
626 -> IO [InstalledPackageInfo]
627 updatePackageDB db_stack pkgs new_pkg = do
629 -- we update dependencies without version numbers to
630 -- match the actual versions of the relevant packages instaled.
631 updateDeps p = p{depends = map resolveDep (depends p)}
634 | realVersion pkgid = pkgid
635 | otherwise = lookupDep (pkgName pkgid)
638 = head [ pid | p <- concat (map snd db_stack),
640 pkgName pid == name ]
642 is_exposed = exposed new_pkg
643 pkgid = package new_pkg
646 pkgs' = [ maybe_hide p | p <- pkgs, package p /= pkgid ]
648 -- When update is on, and we're exposing the new package,
649 -- we hide any packages with the same name (different versions)
650 -- in the current DB. Earlier checks will have failed if
653 | is_exposed && pkgName (package p) == name = p{ exposed = False }
656 return (pkgs'++[updateDeps new_pkg])
658 -- -----------------------------------------------------------------------------
659 -- Searching for modules
663 findModules :: [FilePath] -> IO [String]
665 mms <- mapM searchDir paths
668 searchDir path prefix = do
669 fs <- getDirectoryEntries path `catch` \_ -> return []
670 searchEntries path prefix fs
672 searchEntries path prefix [] = return []
673 searchEntries path prefix (f:fs)
674 | looks_like_a_module = do
675 ms <- searchEntries path prefix fs
676 return (prefix `joinModule` f : ms)
677 | looks_like_a_component = do
678 ms <- searchDir (path `joinFilename` f) (prefix `joinModule` f)
679 ms' <- searchEntries path prefix fs
682 searchEntries path prefix fs
685 (base,suffix) = splitFileExt f
686 looks_like_a_module =
687 suffix `elem` haskell_suffixes &&
688 all okInModuleName base
689 looks_like_a_component =
690 null suffix && all okInModuleName base
696 -- -----------------------------------------------------------------------------
697 -- The old command-line syntax, supported for backwards compatibility
704 | OF_Add Bool {- True => replace existing info -}
705 | OF_Remove String | OF_Show String
706 | OF_Field String | OF_AutoGHCiLibs | OF_Force
707 | OF_DefinedName String String
708 | OF_GlobalConfig FilePath
711 isAction :: OldFlag -> Bool
712 isAction OF_Config{} = False
713 isAction OF_Field{} = False
714 isAction OF_Input{} = False
715 isAction OF_AutoGHCiLibs{} = False
716 isAction OF_Force{} = False
717 isAction OF_DefinedName{} = False
718 isAction OF_GlobalConfig{} = False
721 oldFlags :: [OptDescr OldFlag]
723 Option ['f'] ["config-file"] (ReqArg OF_Config "FILE")
724 "use the specified package config file",
725 Option ['l'] ["list-packages"] (NoArg OF_List)
726 "list packages in all config files",
727 Option ['L'] ["list-local-packages"] (NoArg OF_ListLocal)
728 "list packages in the specified config file",
729 Option ['a'] ["add-package"] (NoArg (OF_Add False))
731 Option ['u'] ["update-package"] (NoArg (OF_Add True))
732 "update package with new configuration",
733 Option ['i'] ["input-file"] (ReqArg OF_Input "FILE")
734 "read new package info from specified file",
735 Option ['s'] ["show-package"] (ReqArg OF_Show "NAME")
736 "show the configuration for package NAME",
737 Option [] ["field"] (ReqArg OF_Field "FIELD")
738 "(with --show-package) Show field FIELD only",
739 Option [] ["force"] (NoArg OF_Force)
740 "ignore missing directories/libraries",
741 Option ['r'] ["remove-package"] (ReqArg OF_Remove "NAME")
742 "remove an installed package",
743 Option ['g'] ["auto-ghci-libs"] (NoArg OF_AutoGHCiLibs)
744 "automatically build libs for GHCi (with -a)",
745 Option ['D'] ["define-name"] (ReqArg toDefined "NAME=VALUE")
746 "define NAME as VALUE",
747 Option [] ["global-conf"] (ReqArg OF_GlobalConfig "FILE")
748 "location of the global package config"
752 case break (=='=') str of
753 (nm,[]) -> OF_DefinedName nm []
754 (nm,_:val) -> OF_DefinedName nm val
756 oldRunit :: [OldFlag] -> IO ()
758 let config_flags = [ f | Just f <- map conv clis ]
760 conv (OF_GlobalConfig f) = Just (FlagGlobalConfig f)
761 conv (OF_Config f) = Just (FlagConfig f)
764 db_names <- getPkgDatabases config_flags
765 db_stack <- mapM readParseDatabase db_names
767 let fields = [ f | OF_Field f <- clis ]
769 let auto_ghci_libs = any isAuto clis
770 where isAuto OF_AutoGHCiLibs = True; isAuto _ = False
771 input_file = head ([ f | (OF_Input f) <- clis] ++ ["-"])
773 force = OF_Force `elem` clis
775 defines = [ (nm,val) | OF_DefinedName nm val <- clis ]
777 case [ c | c <- clis, isAction c ] of
778 [ OF_List ] -> listPackages db_stack
779 [ OF_ListLocal ] -> listPackages db_stack
780 [ OF_Add upd ] -> registerPackage input_file defines db_stack
781 auto_ghci_libs upd force
782 [ OF_Remove p ] -> unregisterPackage (pkgNameToId p) db_stack
784 | null fields -> describePackage db_stack (pkgNameToId p)
785 | otherwise -> mapM_ (describeField db_stack (pkgNameToId p)) fields
786 _ -> do prog <- getProgramName
787 die (usageInfo (usageHeader prog) flags)
789 -- ---------------------------------------------------------------------------
793 expandEnvVars :: PackageConfig -> [(String, String)]
794 -> Bool -> IO PackageConfig
795 expandEnvVars pkg defines force = do
796 -- permit _all_ strings to contain ${..} environment variable references,
797 -- arguably too flexible.
798 nm <- expandString (name pkg)
799 imp_dirs <- expandStrings (import_dirs pkg)
800 src_dirs <- expandStrings (source_dirs pkg)
801 lib_dirs <- expandStrings (library_dirs pkg)
802 hs_libs <- expandStrings (hs_libraries pkg)
803 ex_libs <- expandStrings (extra_libraries pkg)
804 inc_dirs <- expandStrings (include_dirs pkg)
805 c_incs <- expandStrings (c_includes pkg)
806 p_deps <- expandStrings (package_deps pkg)
807 e_g_opts <- expandStrings (extra_ghc_opts pkg)
808 e_c_opts <- expandStrings (extra_cc_opts pkg)
809 e_l_opts <- expandStrings (extra_ld_opts pkg)
810 f_dirs <- expandStrings (framework_dirs pkg)
811 e_frames <- expandStrings (extra_frameworks pkg)
812 return (pkg { name = nm
813 , import_dirs = imp_dirs
814 , source_dirs = src_dirs
815 , library_dirs = lib_dirs
816 , hs_libraries = hs_libs
817 , extra_libraries = ex_libs
818 , include_dirs = inc_dirs
819 , c_includes = c_incs
820 , package_deps = p_deps
821 , extra_ghc_opts = e_g_opts
822 , extra_cc_opts = e_c_opts
823 , extra_ld_opts = e_l_opts
824 , framework_dirs = f_dirs
825 , extra_frameworks= e_frames
828 expandStrings :: [String] -> IO [String]
829 expandStrings = liftM concat . mapM expandSpecial
831 -- Permit substitutions for list-valued variables (but only when
832 -- they occur alone), e.g., package_deps["${deps}"] where env var
833 -- (say) 'deps' is "base,haskell98,network"
834 expandSpecial :: String -> IO [String]
836 let expand f = liftM f $ expandString str
837 in case splitString str of
838 [Var _] -> expand (wordsBy (== ','))
839 _ -> expand (\x -> [x])
841 expandString :: String -> IO String
842 expandString = liftM concat . mapM expandElem . splitString
844 expandElem :: Elem -> IO String
845 expandElem (String s) = return s
846 expandElem (Var v) = lookupEnvVar v
848 lookupEnvVar :: String -> IO String
850 case lookup nm defines of
851 Just x | not (null x) -> return x
853 catch (System.getEnv nm)
854 (\ _ -> do dieOrForce force ("Unable to expand variable " ++
858 data Elem = String String | Var String
860 splitString :: String -> [Elem]
863 case break (== '$') str of
865 case span (/= '}') xs of
867 (if null pre then id else (String pre :)) (Var var : splitString suf)
868 _ -> [String str] -- no closing brace
869 _ -> [String str] -- no dollar/opening brace combo
871 -- wordsBy isSpace == words
872 wordsBy :: (Char -> Bool) -> String -> [String]
873 wordsBy p s = case dropWhile p s of
875 s' -> w : wordsBy p s'' where (w,s'') = break p s'
878 -----------------------------------------------------------------------------
880 getProgramName :: IO String
881 getProgramName = liftM (`withoutSuffix` ".bin") getProgName
882 where str `withoutSuffix` suff
883 | suff `isSuffixOf` str = take (length str - length suff) str
886 bye :: String -> IO a
887 bye s = putStr s >> exitWith ExitSuccess
889 die :: String -> IO a
892 prog <- getProgramName
893 hPutStrLn stderr (prog ++ ": " ++ s)
894 exitWith (ExitFailure 1)
896 dieOrForce :: Bool -> String -> IO ()
898 | force = do hFlush stdout; hPutStrLn stderr (s ++ " (ignoring)")
902 -----------------------------------------
903 -- Cut and pasted from ghc/compiler/SysTools
905 #if defined(mingw32_TARGET_OS)
906 subst a b ls = map (\ x -> if x == a then b else x) ls
907 unDosifyPath xs = subst '\\' '/' xs
909 getExecDir :: String -> IO (Maybe String)
910 -- (getExecDir cmd) returns the directory in which the current
911 -- executable, which should be called 'cmd', is running
912 -- So if the full path is /a/b/c/d/e, and you pass "d/e" as cmd,
913 -- you'll get "/a/b/c" back as the result
915 = allocaArray len $ \buf -> do
916 ret <- getModuleFileName nullPtr buf len
917 if ret == 0 then return Nothing
918 else do s <- peekCString buf
919 return (Just (reverse (drop (length cmd)
920 (reverse (unDosifyPath s)))))
922 len = 2048::Int -- Plenty, PATH_MAX is 512 under Win32.
924 foreign import stdcall unsafe "GetModuleFileNameA"
925 getModuleFileName :: Ptr () -> CString -> Int -> IO Int32
927 getExecDir :: String -> IO (Maybe String)
928 getExecDir _ = return Nothing
931 -- -----------------------------------------------------------------------------
934 -- | The 'joinFileName' function is the opposite of 'splitFileName'.
935 -- It joins directory and file names to form a complete file path.
937 -- The general rule is:
939 -- > dir `joinFileName` basename == path
941 -- > (dir,basename) = splitFileName path
943 -- There might be an exceptions to the rule but in any case the
944 -- reconstructed path will refer to the same object (file or directory).
945 -- An example exception is that on Windows some slashes might be converted
947 joinFileName :: String -> String -> FilePath
948 joinFileName "" fname = fname
949 joinFileName "." fname = fname
950 joinFileName dir "" = dir
951 joinFileName dir fname
952 | isPathSeparator (last dir) = dir++fname
953 | otherwise = dir++pathSeparator:fname
955 -- | Checks whether the character is a valid path separator for the host
956 -- platform. The valid character is a 'pathSeparator' but since the Windows
957 -- operating system also accepts a slash (\"\/\") since DOS 2, the function
958 -- checks for it on this platform, too.
959 isPathSeparator :: Char -> Bool
960 isPathSeparator ch = ch == pathSeparator || ch == '/'
962 -- | Provides a platform-specific character used to separate directory levels in
963 -- a path string that reflects a hierarchical file system organization. The
964 -- separator is a slash (@\"\/\"@) on Unix and Macintosh, and a backslash
965 -- (@\"\\\"@) on the Windows operating system.
966 pathSeparator :: Char
967 #ifdef mingw32_TARGET_OS