utils/ghc-pkg/Main.hs

   1 {-# OPTIONS -fglasgow-exts -cpp #-}
   2 -----------------------------------------------------------------------------
   3 --
   4 -- (c) The University of Glasgow 2004.
   5 --
   6 -- Package management tool
   7 --
   8 -----------------------------------------------------------------------------
   9
  10 -- TODO:
  11 -- * validate modules
  12 -- * expanding of variables in new-style package conf
  13 -- * version manipulation (checking whether old version exists,
  14 --   hiding old version?)
  15
  16 module Main (main) where
  17
  18 import Version ( version, targetOS, targetARCH )
  19 import Distribution.InstalledPackageInfo hiding (depends)
  20 import Distribution.Compat.ReadP
  21 import Distribution.ParseUtils
  22 import Distribution.Package
  23 import Distribution.Text
  24 import Distribution.Version
  25 import System.FilePath
  26 import System.Cmd       ( rawSystem )
  27 import System.Directory ( getAppUserDataDirectory, createDirectoryIfMissing )
  28
  29 import Prelude
  30
  31 #include "../../includes/ghcconfig.h"
  32
  33 import System.Console.GetOpt
  34 import Text.PrettyPrint
  35 #if __GLASGOW_HASKELL__ >= 609
  36 import qualified Control.Exception as Exception
  37 #else
  38 import qualified Control.Exception.Extensible as Exception
  39 #endif
  40 import Data.Maybe
  41
  42 import Data.Char ( isSpace, toLower )
  43 import Control.Monad
  44 import System.Directory ( doesDirectoryExist, getDirectoryContents,
  45                           doesFileExist, renameFile, removeFile )
  46 import System.Exit ( exitWith, ExitCode(..) )
  47 import System.Environment ( getArgs, getProgName, getEnv )
  48 import System.IO
  49 import System.IO.Error (try)
  50 import Data.List
  51 import Control.Concurrent
  52
  53 import Foreign
  54 import Foreign.C
  55 #ifdef mingw32_HOST_OS
  56 import GHC.ConsoleHandler
  57 #else
  58 import System.Posix hiding (fdToHandle)
  59 #endif
  60
  61 import IO ( isPermissionError )
  62 import System.Posix.Internals
  63 import GHC.Handle (fdToHandle)
  64
  65 #if defined(GLOB)
  66 import System.Process(runInteractiveCommand)
  67 import qualified System.Info(os)
  68 #endif
  69
  70 -- -----------------------------------------------------------------------------
  71 -- Entry point
  72
  73 main :: IO ()
  74 main = do
  75   args <- getArgs
  76
  77   case getOpt Permute (flags ++ deprecFlags) args of
  78         (cli,_,[]) | FlagHelp `elem` cli -> do
  79            prog <- getProgramName
  80            bye (usageInfo (usageHeader prog) flags)
  81         (cli,_,[]) | FlagVersion `elem` cli ->
  82            bye ourCopyright
  83         (cli,nonopts,[]) ->
  84            runit cli nonopts
  85         (_,_,errors) -> do
  86            prog <- getProgramName
  87            die (concat errors ++ usageInfo (usageHeader prog) flags)
  88
  89 -- -----------------------------------------------------------------------------
  90 -- Command-line syntax
  91
  92 data Flag
  93   = FlagUser
  94   | FlagGlobal
  95   | FlagHelp
  96   | FlagVersion
  97   | FlagConfig FilePath
  98   | FlagGlobalConfig FilePath
  99   | FlagForce
 100   | FlagForceFiles
 101   | FlagAutoGHCiLibs
 102   | FlagSimpleOutput
 103   | FlagNamesOnly
 104   | FlagIgnoreCase
 105   | FlagNoUserDb
 106   deriving Eq
 107
 108 flags :: [OptDescr Flag]
 109 flags = [
 110   Option [] ["user"] (NoArg FlagUser)
 111         "use the current user's package database",
 112   Option [] ["global"] (NoArg FlagGlobal)
 113         "use the global package database",
 114   Option ['f'] ["package-conf"] (ReqArg FlagConfig "FILE")
 115         "use the specified package config file",
 116   Option [] ["global-conf"] (ReqArg FlagGlobalConfig "FILE")
 117         "location of the global package config",
 118   Option [] ["no-user-package-conf"] (NoArg FlagNoUserDb)
 119         "never read the user package database",
 120   Option [] ["force"] (NoArg FlagForce)
 121          "ignore missing dependencies, directories, and libraries",
 122   Option [] ["force-files"] (NoArg FlagForceFiles)
 123          "ignore missing directories and libraries only",
 124   Option ['g'] ["auto-ghci-libs"] (NoArg FlagAutoGHCiLibs)
 125         "automatically build libs for GHCi (with register)",
 126   Option ['?'] ["help"] (NoArg FlagHelp)
 127         "display this help and exit",
 128   Option ['V'] ["version"] (NoArg FlagVersion)
 129         "output version information and exit",
 130   Option [] ["simple-output"] (NoArg FlagSimpleOutput)
 131         "print output in easy-to-parse format for some commands",
 132   Option [] ["names-only"] (NoArg FlagNamesOnly)
 133         "only print package names, not versions; can only be used with list --simple-output",
 134   Option [] ["ignore-case"] (NoArg FlagIgnoreCase)
 135         "ignore case for substring matching"
 136   ]
 137
 138 deprecFlags :: [OptDescr Flag]
 139 deprecFlags = [
 140         -- put deprecated flags here
 141   ]
 142
 143 ourCopyright :: String
 144 ourCopyright = "GHC package manager version " ++ Version.version ++ "\n"
 145
 146 usageHeader :: String -> String
 147 usageHeader prog = substProg prog $
 148   "Usage:\n" ++
 149   "  $p register {filename | -}\n" ++
 150   "    Register the package using the specified installed package\n" ++
 151   "    description. The syntax for the latter is given in the $p\n" ++
 152   "    documentation.\n" ++
 153   "\n" ++
 154   "  $p update {filename | -}\n" ++
 155   "    Register the package, overwriting any other package with the\n" ++
 156   "    same name.\n" ++
 157   "\n" ++
 158   "  $p unregister {pkg-id}\n" ++
 159   "    Unregister the specified package.\n" ++
 160   "\n" ++
 161   "  $p expose {pkg-id}\n" ++
 162   "    Expose the specified package.\n" ++
 163   "\n" ++
 164   "  $p hide {pkg-id}\n" ++
 165   "    Hide the specified package.\n" ++
 166   "\n" ++
 167   "  $p list [pkg]\n" ++
 168   "    List registered packages in the global database, and also the\n" ++
 169   "    user database if --user is given. If a package name is given\n" ++
 170   "    all the registered versions will be listed in ascending order.\n" ++
 171   "    Accepts the --simple-output flag.\n" ++
 172   "\n" ++
 173   "  $p find-module {module}\n" ++
 174   "    List registered packages exposing module {module} in the global\n" ++
 175   "    database, and also the user database if --user is given.\n" ++
 176   "    All the registered versions will be listed in ascending order.\n" ++
 177   "    Accepts the --simple-output flag.\n" ++
 178   "\n" ++
 179   "  $p latest {pkg-id}\n" ++
 180   "    Prints the highest registered version of a package.\n" ++
 181   "\n" ++
 182   "  $p check\n" ++
 183   "    Check the consistency of package depenencies and list broken packages.\n" ++
 184   "    Accepts the --simple-output flag.\n" ++
 185   "\n" ++
 186   "  $p describe {pkg}\n" ++
 187   "    Give the registered description for the specified package. The\n" ++
 188   "    description is returned in precisely the syntax required by $p\n" ++
 189   "    register.\n" ++
 190   "\n" ++
 191   "  $p field {pkg} {field}\n" ++
 192   "    Extract the specified field of the package description for the\n" ++
 193   "    specified package. Accepts comma-separated multiple fields.\n" ++
 194   "\n" ++
 195   "  $p dump\n" ++
 196   "    Dump the registered description for every package.  This is like\n" ++
 197   "    \"ghc-pkg describe '*'\", except that it is intended to be used\n" ++
 198   "    by tools that parse the results, rather than humans.\n" ++
 199   "\n" ++
 200   " Substring matching is supported for {module} in find-module and\n" ++
 201   " for {pkg} in list, describe, and field, where a '*' indicates\n" ++
 202   " open substring ends (prefix*, *suffix, *infix*).\n" ++
 203   "\n" ++
 204   "  When asked to modify a database (register, unregister, update,\n"++
 205   "  hide, expose, and also check), ghc-pkg modifies the global database by\n"++
 206   "  default.  Specifying --user causes it to act on the user database,\n"++
 207   "  or --package-conf can be used to act on another database\n"++
 208   "  entirely. When multiple of these options are given, the rightmost\n"++
 209   "  one is used as the database to act upon.\n"++
 210   "\n"++
 211   "  Commands that query the package database (list, latest, describe,\n"++
 212   "  field) operate on the list of databases specified by the flags\n"++
 213   "  --user, --global, and --package-conf.  If none of these flags are\n"++
 214   "  given, the default is --global --user.\n"++
 215   "\n" ++
 216   " The following optional flags are also accepted:\n"
 217
 218 substProg :: String -> String -> String
 219 substProg _ [] = []
 220 substProg prog ('$':'p':xs) = prog ++ substProg prog xs
 221 substProg prog (c:xs) = c : substProg prog xs
 222
 223 -- -----------------------------------------------------------------------------
 224 -- Do the business
 225
 226 data Force = ForceAll | ForceFiles | NoForce
 227
 228 data PackageArg = Id PackageIdentifier | Substring String (String->Bool)
 229
 230 runit :: [Flag] -> [String] -> IO ()
 231 runit cli nonopts = do
 232   installSignalHandlers -- catch ^C and clean up
 233   prog <- getProgramName
 234   let
 235         force
 236           | FlagForce `elem` cli        = ForceAll
 237           | FlagForceFiles `elem` cli   = ForceFiles
 238           | otherwise                   = NoForce
 239         auto_ghci_libs = FlagAutoGHCiLibs `elem` cli
 240         splitFields fields = unfoldr splitComma (',':fields)
 241           where splitComma "" = Nothing
 242                 splitComma fs = Just $ break (==',') (tail fs)
 243
 244         substringCheck :: String -> Maybe (String -> Bool)
 245         substringCheck ""    = Nothing
 246         substringCheck "*"   = Just (const True)
 247         substringCheck [_]   = Nothing
 248         substringCheck (h:t) =
 249           case (h, init t, last t) of
 250             ('*',s,'*') -> Just (isInfixOf (f s) . f)
 251             ('*',_, _ ) -> Just (isSuffixOf (f t) . f)
 252             ( _ ,s,'*') -> Just (isPrefixOf (f (h:s)) . f)
 253             _           -> Nothing
 254           where f | FlagIgnoreCase `elem` cli = map toLower
 255                   | otherwise                 = id
 256 #if defined(GLOB)
 257         glob x | System.Info.os=="mingw32" = do
 258           -- glob echoes its argument, after win32 filename globbing
 259           (_,o,_,_) <- runInteractiveCommand ("glob "++x)
 260           txt <- hGetContents o
 261           return (read txt)
 262         glob x | otherwise = return [x]
 263 #endif
 264   --
 265   -- first, parse the command
 266   case nonopts of
 267 #if defined(GLOB)
 268     -- dummy command to demonstrate usage and permit testing
 269     -- without messing things up; use glob to selectively enable
 270     -- windows filename globbing for file parameters
 271     -- register, update, FlagGlobalConfig, FlagConfig; others?
 272     ["glob", filename] -> do
 273         print filename
 274         glob filename >>= print
 275 #endif
 276     ["register", filename] ->
 277         registerPackage filename cli auto_ghci_libs False force
 278     ["update", filename] ->
 279         registerPackage filename cli auto_ghci_libs True force
 280     ["unregister", pkgid_str] -> do
 281         pkgid <- readGlobPkgId pkgid_str
 282         unregisterPackage pkgid cli force
 283     ["expose", pkgid_str] -> do
 284         pkgid <- readGlobPkgId pkgid_str
 285         exposePackage pkgid cli force
 286     ["hide",   pkgid_str] -> do
 287         pkgid <- readGlobPkgId pkgid_str
 288         hidePackage pkgid cli force
 289     ["list"] -> do
 290         listPackages cli Nothing Nothing
 291     ["list", pkgid_str] ->
 292         case substringCheck pkgid_str of
 293           Nothing -> do pkgid <- readGlobPkgId pkgid_str
 294                         listPackages cli (Just (Id pkgid)) Nothing
 295           Just m -> listPackages cli (Just (Substring pkgid_str m)) Nothing
 296     ["find-module", moduleName] -> do
 297         let match = maybe (==moduleName) id (substringCheck moduleName)
 298         listPackages cli Nothing (Just match)
 299     ["latest", pkgid_str] -> do
 300         pkgid <- readGlobPkgId pkgid_str
 301         latestPackage cli pkgid
 302     ["describe", pkgid_str] ->
 303         case substringCheck pkgid_str of
 304           Nothing -> do pkgid <- readGlobPkgId pkgid_str
 305                         describePackage cli (Id pkgid)
 306           Just m -> describePackage cli (Substring pkgid_str m)
 307     ["field", pkgid_str, fields] ->
 308         case substringCheck pkgid_str of
 309           Nothing -> do pkgid <- readGlobPkgId pkgid_str
 310                         describeField cli (Id pkgid) (splitFields fields)
 311           Just m -> describeField cli (Substring pkgid_str m)
 312                                       (splitFields fields)
 313     ["check"] -> do
 314         checkConsistency cli
 315
 316     ["dump"] -> do
 317         dumpPackages cli
 318
 319     [] -> do
 320         die ("missing command\n" ++
 321                 usageInfo (usageHeader prog) flags)
 322     (_cmd:_) -> do
 323         die ("command-line syntax error\n" ++
 324                 usageInfo (usageHeader prog) flags)
 325
 326 parseCheck :: ReadP a a -> String -> String -> IO a
 327 parseCheck parser str what =
 328   case [ x | (x,ys) <- readP_to_S parser str, all isSpace ys ] of
 329     [x] -> return x
 330     _ -> die ("cannot parse \'" ++ str ++ "\' as a " ++ what)
 331
 332 readGlobPkgId :: String -> IO PackageIdentifier
 333 readGlobPkgId str = parseCheck parseGlobPackageId str "package identifier"
 334
 335 parseGlobPackageId :: ReadP r PackageIdentifier
 336 parseGlobPackageId =
 337   parse
 338      +++
 339   (do n <- parse
 340       string "-*"
 341       return (PackageIdentifier{ pkgName = n, pkgVersion = globVersion }))
 342
 343 -- globVersion means "all versions"
 344 globVersion :: Version
 345 globVersion = Version{ versionBranch=[], versionTags=["*"] }
 346
 347 -- -----------------------------------------------------------------------------
 348 -- Package databases
 349
 350 -- Some commands operate on a single database:
 351 --      register, unregister, expose, hide
 352 -- however these commands also check the union of the available databases
 353 -- in order to check consistency.  For example, register will check that
 354 -- dependencies exist before registering a package.
 355 --
 356 -- Some commands operate  on multiple databases, with overlapping semantics:
 357 --      list, describe, field
 358
 359 type PackageDBName  = FilePath
 360 type PackageDB      = [InstalledPackageInfo]
 361
 362 type NamedPackageDB = (PackageDBName, PackageDB)
 363 type PackageDBStack = [NamedPackageDB]
 364         -- A stack of package databases.  Convention: head is the topmost
 365         -- in the stack.  Earlier entries override later one.
 366
 367 allPackagesInStack :: PackageDBStack -> [InstalledPackageInfo]
 368 allPackagesInStack = concatMap snd
 369
 370 getPkgDatabases :: Bool -> [Flag] -> IO (PackageDBStack, Maybe PackageDBName)
 371 getPkgDatabases modify my_flags = do
 372   -- first we determine the location of the global package config.  On Windows,
 373   -- this is found relative to the ghc-pkg.exe binary, whereas on Unix the
 374   -- location is passed to the binary using the --global-config flag by the
 375   -- wrapper script.
 376   let err_msg = "missing --global-conf option, location of global package.conf unknown\n"
 377   global_conf <-
 378      case [ f | FlagGlobalConfig f <- my_flags ] of
 379         [] -> do mb_dir <- getExecDir "/bin/ghc-pkg.exe"
 380                  case mb_dir of
 381                         Nothing  -> die err_msg
 382                         Just dir ->
 383                             do let path1 = dir </> "package.conf"
 384                                    path2 = dir </> ".." </> ".." </> ".."
 385                                                </> "inplace-datadir"
 386                                                </> "package.conf"
 387                                exists1 <- doesFileExist path1
 388                                exists2 <- doesFileExist path2
 389                                if exists1 then return path1
 390                                    else if exists2 then return path2
 391                                    else die "Can't find package.conf"
 392         fs -> return (last fs)
 393
 394   let global_conf_dir = global_conf ++ ".d"
 395   global_conf_dir_exists <- doesDirectoryExist global_conf_dir
 396   global_confs <-
 397     if global_conf_dir_exists
 398       then do files <- getDirectoryContents global_conf_dir
 399               return [ global_conf_dir ++ '/' : file
 400                      | file <- files
 401                      , isSuffixOf ".conf" file]
 402       else return []
 403
 404   let no_user_db = FlagNoUserDb `elem` my_flags
 405
 406   -- get the location of the user package database, and create it if necessary
 407   -- getAppUserDataDirectory can fail (e.g. if $HOME isn't set)
 408   appdir <- try $ getAppUserDataDirectory "ghc"
 409
 410   mb_user_conf <-
 411      if no_user_db then return Nothing else
 412      case appdir of
 413        Right dir -> do
 414                let subdir = targetARCH ++ '-':targetOS ++ '-':Version.version
 415                    user_conf = dir </> subdir </> "package.conf"
 416                user_exists <- doesFileExist user_conf
 417                return (Just (user_conf,user_exists))
 418        Left _ ->
 419                return Nothing
 420
 421   -- If the user database doesn't exist, and this command isn't a
 422   -- "modify" command, then we won't attempt to create or use it.
 423   let sys_databases
 424         | Just (user_conf,user_exists) <- mb_user_conf,
 425           modify || user_exists = user_conf : global_confs ++ [global_conf]
 426         | otherwise             = global_confs ++ [global_conf]
 427
 428   e_pkg_path <- try (System.Environment.getEnv "GHC_PACKAGE_PATH")
 429   let env_stack =
 430         case e_pkg_path of
 431                 Left  _ -> sys_databases
 432                 Right path
 433                   | last cs == ""  -> init cs ++ sys_databases
 434                   | otherwise      -> cs
 435                   where cs = parseSearchPath path
 436
 437         -- The "global" database is always the one at the bottom of the stack.
 438         -- This is the database we modify by default.
 439       virt_global_conf = last env_stack
 440
 441   let db_flags = [ f | Just f <- map is_db_flag my_flags ]
 442          where is_db_flag FlagUser
 443                       | Just (user_conf, _user_exists) <- mb_user_conf
 444                       = Just user_conf
 445                is_db_flag FlagGlobal     = Just virt_global_conf
 446                is_db_flag (FlagConfig f) = Just f
 447                is_db_flag _              = Nothing
 448
 449   (final_stack, to_modify) <-
 450      if not modify
 451         then    -- For a "read" command, we use all the databases
 452                 -- specified on the command line.  If there are no
 453                 -- command-line flags specifying databases, the default
 454                 -- is to use all the ones we know about.
 455              if null db_flags then return (env_stack, Nothing)
 456                               else return (reverse (nub db_flags), Nothing)
 457         else let
 458                 -- For a "modify" command, treat all the databases as
 459                 -- a stack, where we are modifying the top one, but it
 460                 -- can refer to packages in databases further down the
 461                 -- stack.
 462
 463                 -- -f flags on the command line add to the database
 464                 -- stack, unless any of them are present in the stack
 465                 -- already.
 466                 flag_stack = filter (`notElem` env_stack)
 467                                 [ f | FlagConfig f <- reverse my_flags ]
 468                                 ++ env_stack
 469
 470                 -- the database we actually modify is the one mentioned
 471                 -- rightmost on the command-line.
 472                 to_modify = if null db_flags
 473                                 then Just virt_global_conf
 474                                 else Just (last db_flags)
 475              in
 476                 return (flag_stack, to_modify)
 477
 478   db_stack <- mapM readParseDatabase final_stack
 479   return (db_stack, to_modify)
 480
 481 readParseDatabase :: PackageDBName -> IO (PackageDBName,PackageDB)
 482 readParseDatabase filename = do
 483   str <- readFile filename `catchIO` \_ -> return emptyPackageConfig
 484   let packages = map convertPackageInfoIn $ read str
 485   Exception.evaluate packages
 486     `catchError` \e->
 487         die ("error while parsing " ++ filename ++ ": " ++ show e)
 488   return (filename,packages)
 489
 490 emptyPackageConfig :: String
 491 emptyPackageConfig = "[]"
 492
 493 -- -----------------------------------------------------------------------------
 494 -- Registering
 495
 496 registerPackage :: FilePath
 497                 -> [Flag]
 498                 -> Bool              -- auto_ghci_libs
 499                 -> Bool              -- update
 500                 -> Force
 501                 -> IO ()
 502 registerPackage input my_flags auto_ghci_libs update force = do
 503   (db_stack, Just to_modify) <- getPkgDatabases True my_flags
 504   let
 505         db_to_operate_on = my_head "register" $
 506                            filter ((== to_modify).fst) db_stack
 507   --
 508   s <-
 509     case input of
 510       "-" -> do
 511         putStr "Reading package info from stdin ... "
 512         getContents
 513       f   -> do
 514         putStr ("Reading package info from " ++ show f ++ " ... ")
 515         readFile f
 516
 517   expanded <- expandEnvVars s force
 518
 519   pkg <- parsePackageInfo expanded
 520   putStrLn "done."
 521
 522   let truncated_stack = dropWhile ((/= to_modify).fst) db_stack
 523   -- truncate the stack for validation, because we don't allow
 524   -- packages lower in the stack to refer to those higher up.
 525   validatePackageConfig pkg truncated_stack auto_ghci_libs update force
 526   let new_details = filter not_this (snd db_to_operate_on) ++ [pkg]
 527       not_this p = package p /= package pkg
 528   writeNewConfig to_modify new_details
 529
 530 parsePackageInfo
 531         :: String
 532         -> IO InstalledPackageInfo
 533 parsePackageInfo str =
 534   case parseInstalledPackageInfo str of
 535     ParseOk _warns ok -> return ok
 536     ParseFailed err -> case locatedErrorMsg err of
 537                            (Nothing, s) -> die s
 538                            (Just l, s) -> die (show l ++ ": " ++ s)
 539
 540 -- -----------------------------------------------------------------------------
 541 -- Exposing, Hiding, Unregistering are all similar
 542
 543 exposePackage :: PackageIdentifier ->  [Flag] -> Force -> IO ()
 544 exposePackage = modifyPackage (\p -> [p{exposed=True}])
 545
 546 hidePackage :: PackageIdentifier ->  [Flag] -> Force -> IO ()
 547 hidePackage = modifyPackage (\p -> [p{exposed=False}])
 548
 549 unregisterPackage :: PackageIdentifier ->  [Flag] -> Force -> IO ()
 550 unregisterPackage = modifyPackage (\_ -> [])
 551
 552 modifyPackage
 553   :: (InstalledPackageInfo -> [InstalledPackageInfo])
 554   -> PackageIdentifier
 555   -> [Flag]
 556   -> Force
 557   -> IO ()
 558 modifyPackage fn pkgid my_flags force = do
 559   (db_stack, Just _to_modify) <- getPkgDatabases True{-modify-} my_flags
 560   ((db_name, pkgs), ps) <- fmap head $ findPackagesByDB db_stack (Id pkgid)
 561 --  let ((db_name, pkgs) : rest_of_stack) = db_stack
 562 --  ps <- findPackages [(db_name,pkgs)] (Id pkgid)
 563   let
 564       pids = map package ps
 565       modify pkg
 566           | package pkg `elem` pids = fn pkg
 567           | otherwise               = [pkg]
 568       new_config = concat (map modify pkgs)
 569
 570   let
 571       old_broken = brokenPackages (allPackagesInStack db_stack)
 572       rest_of_stack = [ (nm, mypkgs)
 573                       | (nm, mypkgs) <- db_stack, nm /= db_name ]
 574       new_stack = (db_name,new_config) : rest_of_stack
 575       new_broken = map package (brokenPackages (allPackagesInStack new_stack))
 576       newly_broken = filter (`notElem` map package old_broken) new_broken
 577   --
 578   when (not (null newly_broken)) $
 579       dieOrForceAll force ("unregistering " ++ display pkgid ++
 580            " would break the following packages: "
 581               ++ unwords (map display newly_broken))
 582
 583   writeNewConfig db_name new_config
 584
 585 -- -----------------------------------------------------------------------------
 586 -- Listing packages
 587
 588 listPackages ::  [Flag] -> Maybe PackageArg -> Maybe (String->Bool) -> IO ()
 589 listPackages my_flags mPackageName mModuleName = do
 590   let simple_output = FlagSimpleOutput `elem` my_flags
 591   (db_stack, _) <- getPkgDatabases False my_flags
 592   let db_stack_filtered -- if a package is given, filter out all other packages
 593         | Just this <- mPackageName =
 594             map (\(conf,pkgs) -> (conf, filter (this `matchesPkg`) pkgs))
 595                 db_stack
 596         | Just match <- mModuleName = -- packages which expose mModuleName
 597             map (\(conf,pkgs) -> (conf, filter (match `exposedInPkg`) pkgs))
 598                 db_stack
 599         | otherwise = db_stack
 600
 601       db_stack_sorted
 602           = [ (db, sort_pkgs pkgs) | (db,pkgs) <- db_stack_filtered ]
 603           where sort_pkgs = sortBy cmpPkgIds
 604                 cmpPkgIds pkg1 pkg2 =
 605                    case pkgName p1 `compare` pkgName p2 of
 606                         LT -> LT
 607                         GT -> GT
 608                         EQ -> pkgVersion p1 `compare` pkgVersion p2
 609                    where (p1,p2) = (package pkg1, package pkg2)
 610
 611       match `exposedInPkg` pkg = any match (map display $ exposedModules pkg)
 612
 613       pkg_map = allPackagesInStack db_stack
 614       show_func = if simple_output then show_simple else mapM_ (show_normal pkg_map)
 615
 616   show_func (reverse db_stack_sorted)
 617
 618   where show_normal pkg_map (db_name,pkg_confs) =
 619           hPutStrLn stdout (render $
 620                 text db_name <> colon $$ nest 4 packages
 621                 )
 622            where packages = fsep (punctuate comma (map pp_pkg pkg_confs))
 623                  broken = map package (brokenPackages pkg_map)
 624                  pp_pkg p
 625                    | package p `elem` broken = braces doc
 626                    | exposed p = doc
 627                    | otherwise = parens doc
 628                    where doc = text (display (package p))
 629
 630         show_simple db_stack = do
 631           let showPkg = if FlagNamesOnly `elem` my_flags then display . pkgName
 632                                                          else display
 633               pkgs = map showPkg $ sortBy compPkgIdVer $
 634                           map package (allPackagesInStack db_stack)
 635           when (not (null pkgs)) $
 636              hPutStrLn stdout $ concat $ intersperse " " pkgs
 637
 638 -- -----------------------------------------------------------------------------
 639 -- Prints the highest (hidden or exposed) version of a package
 640
 641 latestPackage ::  [Flag] -> PackageIdentifier -> IO ()
 642 latestPackage my_flags pkgid = do
 643   (db_stack, _) <- getPkgDatabases False my_flags
 644   ps <- findPackages db_stack (Id pkgid)
 645   show_pkg (sortBy compPkgIdVer (map package ps))
 646   where
 647     show_pkg [] = die "no matches"
 648     show_pkg pids = hPutStrLn stdout (display (last pids))
 649
 650 -- -----------------------------------------------------------------------------
 651 -- Describe
 652
 653 describePackage :: [Flag] -> PackageArg -> IO ()
 654 describePackage my_flags pkgarg = do
 655   (db_stack, _) <- getPkgDatabases False my_flags
 656   ps <- findPackages db_stack pkgarg
 657   doDump ps
 658
 659 dumpPackages :: [Flag] -> IO ()
 660 dumpPackages my_flags = do
 661   (db_stack, _) <- getPkgDatabases False my_flags
 662   doDump (allPackagesInStack db_stack)
 663
 664 doDump :: [InstalledPackageInfo] -> IO ()
 665 doDump = mapM_ putStrLn . intersperse "---" . map showInstalledPackageInfo
 666
 667 -- PackageId is can have globVersion for the version
 668 findPackages :: PackageDBStack -> PackageArg -> IO [InstalledPackageInfo]
 669 findPackages db_stack pkgarg
 670   = fmap (concatMap snd) $ findPackagesByDB db_stack pkgarg
 671
 672 findPackagesByDB :: PackageDBStack -> PackageArg
 673                  -> IO [(NamedPackageDB, [InstalledPackageInfo])]
 674 findPackagesByDB db_stack pkgarg
 675   = case [ (db, matched)
 676          | db@(_, pkgs) <- db_stack,
 677            let matched = filter (pkgarg `matchesPkg`) pkgs,
 678            not (null matched) ] of
 679         [] -> die ("cannot find package " ++ pkg_msg pkgarg)
 680         ps -> return ps
 681   where
 682         pkg_msg (Id pkgid)           = display pkgid
 683         pkg_msg (Substring pkgpat _) = "matching " ++ pkgpat
 684
 685 matches :: PackageIdentifier -> PackageIdentifier -> Bool
 686 pid `matches` pid'
 687   = (pkgName pid == pkgName pid')
 688     && (pkgVersion pid == pkgVersion pid' || not (realVersion pid))
 689
 690 matchesPkg :: PackageArg -> InstalledPackageInfo -> Bool
 691 (Id pid)        `matchesPkg` pkg = pid `matches` package pkg
 692 (Substring _ m) `matchesPkg` pkg = m (display (package pkg))
 693
 694 compPkgIdVer :: PackageIdentifier -> PackageIdentifier -> Ordering
 695 compPkgIdVer p1 p2 = pkgVersion p1 `compare` pkgVersion p2
 696
 697 -- -----------------------------------------------------------------------------
 698 -- Field
 699
 700 describeField :: [Flag] -> PackageArg -> [String] -> IO ()
 701 describeField my_flags pkgarg fields = do
 702   (db_stack, _) <- getPkgDatabases False my_flags
 703   fns <- toFields fields
 704   ps <- findPackages db_stack pkgarg
 705   let top_dir = takeDirectory (fst (last db_stack))
 706   mapM_ (selectFields fns) (mungePackagePaths top_dir ps)
 707   where toFields [] = return []
 708         toFields (f:fs) = case toField f of
 709             Nothing -> die ("unknown field: " ++ f)
 710             Just fn -> do fns <- toFields fs
 711                           return (fn:fns)
 712         selectFields fns info = mapM_ (\fn->putStrLn (fn info)) fns
 713
 714 mungePackagePaths :: String -> [InstalledPackageInfo] -> [InstalledPackageInfo]
 715 -- Replace the strings "$topdir" and "$httptopdir" at the beginning of a path
 716 -- with the current topdir (obtained from the -B option).
 717 mungePackagePaths top_dir ps = map munge_pkg ps
 718   where
 719   munge_pkg p = p{ importDirs        = munge_paths (importDirs p),
 720                    includeDirs       = munge_paths (includeDirs p),
 721                    libraryDirs       = munge_paths (libraryDirs p),
 722                    frameworkDirs     = munge_paths (frameworkDirs p),
 723                    haddockInterfaces = munge_paths (haddockInterfaces p),
 724                    haddockHTMLs      = munge_paths (haddockHTMLs p)
 725                  }
 726
 727   munge_paths = map munge_path
 728
 729   munge_path p
 730    | Just p' <- maybePrefixMatch "$topdir"     p =            top_dir ++ p'
 731    | Just p' <- maybePrefixMatch "$httptopdir" p = toHttpPath top_dir ++ p'
 732    | otherwise                               = p
 733
 734   toHttpPath p = "file:///" ++ p
 735
 736 maybePrefixMatch :: String -> String -> Maybe String
 737 maybePrefixMatch []    rest = Just rest
 738 maybePrefixMatch (_:_) []   = Nothing
 739 maybePrefixMatch (p:pat) (r:rest)
 740   | p == r    = maybePrefixMatch pat rest
 741   | otherwise = Nothing
 742
 743 toField :: String -> Maybe (InstalledPackageInfo -> String)
 744 -- backwards compatibility:
 745 toField "import_dirs"     = Just $ strList . importDirs
 746 toField "source_dirs"     = Just $ strList . importDirs
 747 toField "library_dirs"    = Just $ strList . libraryDirs
 748 toField "hs_libraries"    = Just $ strList . hsLibraries
 749 toField "extra_libraries" = Just $ strList . extraLibraries
 750 toField "include_dirs"    = Just $ strList . includeDirs
 751 toField "c_includes"      = Just $ strList . includes
 752 toField "package_deps"    = Just $ strList . map display. depends
 753 toField "extra_cc_opts"   = Just $ strList . ccOptions
 754 toField "extra_ld_opts"   = Just $ strList . ldOptions
 755 toField "framework_dirs"  = Just $ strList . frameworkDirs
 756 toField "extra_frameworks"= Just $ strList . frameworks
 757 toField s                 = showInstalledPackageInfoField s
 758
 759 strList :: [String] -> String
 760 strList = show
 761
 762
 763 -- -----------------------------------------------------------------------------
 764 -- Check: Check consistency of installed packages
 765
 766 checkConsistency :: [Flag] -> IO ()
 767 checkConsistency my_flags = do
 768   (db_stack, _) <- getPkgDatabases True my_flags
 769          -- check behaves like modify for the purposes of deciding which
 770          -- databases to use, because ordering is important.
 771   let pkgs = allPackagesInStack db_stack
 772       broken_pkgs = brokenPackages pkgs
 773       broken_ids = map package broken_pkgs
 774       broken_why = [ (package p, filter (`elem` broken_ids) (depends p))
 775                    | p <- broken_pkgs ]
 776   mapM_ (putStrLn . render . show_func) broken_why
 777   where
 778   show_func | FlagSimpleOutput `elem` my_flags = show_simple
 779             | otherwise = show_normal
 780   show_simple (pid,deps) =
 781     text (display pid) <> colon
 782       <+> fsep (punctuate comma (map (text . display) deps))
 783   show_normal (pid,deps) =
 784     text "package" <+> text (display pid) <+> text "has missing dependencies:"
 785       $$ nest 4 (fsep (punctuate comma (map (text . display) deps)))
 786
 787
 788 brokenPackages :: [InstalledPackageInfo] -> [InstalledPackageInfo]
 789 brokenPackages pkgs = go [] pkgs
 790  where
 791    go avail not_avail =
 792      case partition (depsAvailable avail) not_avail of
 793         ([],        not_avail') -> not_avail'
 794         (new_avail, not_avail') -> go (new_avail ++ avail) not_avail'
 795
 796    depsAvailable :: [InstalledPackageInfo] -> InstalledPackageInfo
 797                  -> Bool
 798    depsAvailable pkgs_ok pkg = null dangling
 799         where dangling = filter (`notElem` pids) (depends pkg)
 800               pids = map package pkgs_ok
 801
 802         -- we want mutually recursive groups of package to show up
 803         -- as broken. (#1750)
 804
 805 -- -----------------------------------------------------------------------------
 806 -- Manipulating package.conf files
 807
 808 type InstalledPackageInfoString = InstalledPackageInfo_ String
 809
 810 convertPackageInfoOut :: InstalledPackageInfo -> InstalledPackageInfoString
 811 convertPackageInfoOut
 812     (pkgconf@(InstalledPackageInfo { exposedModules = e,
 813                                      hiddenModules = h })) =
 814         pkgconf{ exposedModules = map display e,
 815                  hiddenModules  = map display h }
 816
 817 convertPackageInfoIn :: InstalledPackageInfoString -> InstalledPackageInfo
 818 convertPackageInfoIn
 819     (pkgconf@(InstalledPackageInfo { exposedModules = e,
 820                                      hiddenModules = h })) =
 821         pkgconf{ exposedModules = map convert e,
 822                  hiddenModules  = map convert h }
 823     where convert = fromJust . simpleParse
 824
 825 writeNewConfig :: FilePath -> [InstalledPackageInfo] -> IO ()
 826 writeNewConfig filename packages = do
 827   hPutStr stdout "Writing new package config file... "
 828   createDirectoryIfMissing True $ takeDirectory filename
 829   let shown = concat $ intersperse ",\n "
 830                      $ map (show . convertPackageInfoOut) packages
 831       fileContents = "[" ++ shown ++ "\n]"
 832   writeFileAtomic filename fileContents
 833     `catch` \e ->
 834       if isPermissionError e
 835       then die (filename ++ ": you don't have permission to modify this file")
 836       else ioError e
 837   hPutStrLn stdout "done."
 838
 839 -----------------------------------------------------------------------------
 840 -- Sanity-check a new package config, and automatically build GHCi libs
 841 -- if requested.
 842
 843 validatePackageConfig :: InstalledPackageInfo
 844                       -> PackageDBStack
 845                       -> Bool   -- auto-ghc-libs
 846                       -> Bool   -- update
 847                       -> Force
 848                       -> IO ()
 849 validatePackageConfig pkg db_stack auto_ghci_libs update force = do
 850   checkPackageId pkg
 851   checkDuplicates db_stack pkg update force
 852   mapM_ (checkDep db_stack force) (depends pkg)
 853   checkDuplicateDepends force (depends pkg)
 854   mapM_ (checkDir force) (importDirs pkg)
 855   mapM_ (checkDir force) (libraryDirs pkg)
 856   mapM_ (checkDir force) (includeDirs pkg)
 857   mapM_ (checkHSLib (libraryDirs pkg) auto_ghci_libs force) (hsLibraries pkg)
 858   -- ToDo: check these somehow?
 859   --    extra_libraries :: [String],
 860   --    c_includes      :: [String],
 861
 862 -- When the package name and version are put together, sometimes we can
 863 -- end up with a package id that cannot be parsed.  This will lead to
 864 -- difficulties when the user wants to refer to the package later, so
 865 -- we check that the package id can be parsed properly here.
 866 checkPackageId :: InstalledPackageInfo -> IO ()
 867 checkPackageId ipi =
 868   let str = display (package ipi) in
 869   case [ x :: PackageIdentifier | (x,ys) <- readP_to_S parse str, all isSpace ys ] of
 870     [_] -> return ()
 871     []  -> die ("invalid package identifier: " ++ str)
 872     _   -> die ("ambiguous package identifier: " ++ str)
 873
 874 checkDuplicates :: PackageDBStack -> InstalledPackageInfo -> Bool -> Force -> IO ()
 875 checkDuplicates db_stack pkg update force = do
 876   let
 877         pkgid = package pkg
 878         (_top_db_name, pkgs) : _  = db_stack
 879   --
 880   -- Check whether this package id already exists in this DB
 881   --
 882   when (not update && (pkgid `elem` map package pkgs)) $
 883        die ("package " ++ display pkgid ++ " is already installed")
 884
 885   let
 886         uncasep = map toLower . display
 887         dups = filter ((== uncasep pkgid) . uncasep) (map package pkgs)
 888
 889   when (not update && not (null dups)) $ dieOrForceAll force $
 890         "Package names may be treated case-insensitively in the future.\n"++
 891         "Package " ++ display pkgid ++
 892         " overlaps with: " ++ unwords (map display dups)
 893
 894
 895 checkDir :: Force -> String -> IO ()
 896 checkDir force d
 897  | "$topdir"     `isPrefixOf` d = return ()
 898  | "$httptopdir" `isPrefixOf` d = return ()
 899         -- can't check these, because we don't know what $(http)topdir is
 900  | otherwise = do
 901    there <- doesDirectoryExist d
 902    when (not there)
 903        (dieOrForceFile force (d ++ " doesn't exist or isn't a directory"))
 904
 905 checkDep :: PackageDBStack -> Force -> PackageIdentifier -> IO ()
 906 checkDep db_stack force pkgid
 907   | pkgid `elem` pkgids || (not real_version && name_exists) = return ()
 908   | otherwise = dieOrForceAll force ("dependency " ++ display pkgid
 909                                         ++ " doesn't exist")
 910   where
 911         -- for backwards compat, we treat 0.0 as a special version,
 912         -- and don't check that it actually exists.
 913         real_version = realVersion pkgid
 914
 915         name_exists = any (\p -> pkgName (package p) == name) all_pkgs
 916         name = pkgName pkgid
 917
 918         all_pkgs = allPackagesInStack db_stack
 919         pkgids = map package all_pkgs
 920
 921 checkDuplicateDepends :: Force -> [PackageIdentifier] -> IO ()
 922 checkDuplicateDepends force deps
 923   | null dups = return ()
 924   | otherwise = dieOrForceAll force ("package has duplicate dependencies: " ++
 925                                      unwords (map display dups))
 926   where
 927        dups = [ p | (p:_:_) <- group (sort deps) ]
 928
 929 realVersion :: PackageIdentifier -> Bool
 930 realVersion pkgid = versionBranch (pkgVersion pkgid) /= []
 931
 932 checkHSLib :: [String] -> Bool -> Force -> String -> IO ()
 933 checkHSLib dirs auto_ghci_libs force lib = do
 934   let batch_lib_file = "lib" ++ lib ++ ".a"
 935   bs <- mapM (doesLibExistIn batch_lib_file) dirs
 936   case [ dir | (exists,dir) <- zip bs dirs, exists ] of
 937         [] -> dieOrForceFile force ("cannot find " ++ batch_lib_file ++
 938                                     " on library path")
 939         (dir:_) -> checkGHCiLib dirs dir batch_lib_file lib auto_ghci_libs
 940
 941 doesLibExistIn :: String -> String -> IO Bool
 942 doesLibExistIn lib d
 943  | "$topdir"     `isPrefixOf` d = return True
 944  | "$httptopdir" `isPrefixOf` d = return True
 945  | otherwise                = doesFileExist (d ++ '/':lib)
 946
 947 checkGHCiLib :: [String] -> String -> String -> String -> Bool -> IO ()
 948 checkGHCiLib dirs batch_lib_dir batch_lib_file lib auto_build
 949   | auto_build = autoBuildGHCiLib batch_lib_dir batch_lib_file ghci_lib_file
 950   | otherwise  = do
 951       bs <- mapM (doesLibExistIn ghci_lib_file) dirs
 952       case [dir | (exists,dir) <- zip bs dirs, exists] of
 953         []    -> hPutStrLn stderr ("warning: can't find GHCi lib " ++ ghci_lib_file)
 954         (_:_) -> return ()
 955   where
 956     ghci_lib_file = lib ++ ".o"
 957
 958 -- automatically build the GHCi version of a batch lib,
 959 -- using ld --whole-archive.
 960
 961 autoBuildGHCiLib :: String -> String -> String -> IO ()
 962 autoBuildGHCiLib dir batch_file ghci_file = do
 963   let ghci_lib_file  = dir ++ '/':ghci_file
 964       batch_lib_file = dir ++ '/':batch_file
 965   hPutStr stderr ("building GHCi library " ++ ghci_lib_file ++ "...")
 966 #if defined(darwin_HOST_OS)
 967   r <- rawSystem "ld" ["-r","-x","-o",ghci_lib_file,"-all_load",batch_lib_file]
 968 #elif defined(mingw32_HOST_OS)
 969   execDir <- getExecDir "/bin/ghc-pkg.exe"
 970   r <- rawSystem (maybe "" (++"/gcc-lib/") execDir++"ld") ["-r","-x","-o",ghci_lib_file,"--whole-archive",batch_lib_file]
 971 #else
 972   r <- rawSystem "ld" ["-r","-x","-o",ghci_lib_file,"--whole-archive",batch_lib_file]
 973 #endif
 974   when (r /= ExitSuccess) $ exitWith r
 975   hPutStrLn stderr (" done.")
 976
 977 -- -----------------------------------------------------------------------------
 978 -- Searching for modules
 979
 980 #if not_yet
 981
 982 findModules :: [FilePath] -> IO [String]
 983 findModules paths =
 984   mms <- mapM searchDir paths
 985   return (concat mms)
 986
 987 searchDir path prefix = do
 988   fs <- getDirectoryEntries path `catch` \_ -> return []
 989   searchEntries path prefix fs
 990
 991 searchEntries path prefix [] = return []
 992 searchEntries path prefix (f:fs)
 993   | looks_like_a_module  =  do
 994         ms <- searchEntries path prefix fs
 995         return (prefix `joinModule` f : ms)
 996   | looks_like_a_component  =  do
 997         ms <- searchDir (path </> f) (prefix `joinModule` f)
 998         ms' <- searchEntries path prefix fs
 999         return (ms ++ ms')
1000   | otherwise
1001         searchEntries path prefix fs
1002
1003   where
1004         (base,suffix) = splitFileExt f
1005         looks_like_a_module =
1006                 suffix `elem` haskell_suffixes &&
1007                 all okInModuleName base
1008         looks_like_a_component =
1009                 null suffix && all okInModuleName base
1010
1011 okInModuleName c
1012
1013 #endif
1014
1015 -- ---------------------------------------------------------------------------
1016 -- expanding environment variables in the package configuration
1017
1018 expandEnvVars :: String -> Force -> IO String
1019 expandEnvVars str0 force = go str0 ""
1020  where
1021    go "" acc = return $! reverse acc
1022    go ('$':'{':str) acc | (var, '}':rest) <- break close str
1023         = do value <- lookupEnvVar var
1024              go rest (reverse value ++ acc)
1025         where close c = c == '}' || c == '\n' -- don't span newlines
1026    go (c:str) acc
1027         = go str (c:acc)
1028
1029    lookupEnvVar :: String -> IO String
1030    lookupEnvVar nm =
1031         catch (System.Environment.getEnv nm)
1032            (\ _ -> do dieOrForceAll force ("Unable to expand variable " ++
1033                                         show nm)
1034                       return "")
1035
1036 -----------------------------------------------------------------------------
1037
1038 getProgramName :: IO String
1039 getProgramName = liftM (`withoutSuffix` ".bin") getProgName
1040    where str `withoutSuffix` suff
1041             | suff `isSuffixOf` str = take (length str - length suff) str
1042             | otherwise             = str
1043
1044 bye :: String -> IO a
1045 bye s = putStr s >> exitWith ExitSuccess
1046
1047 die :: String -> IO a
1048 die = dieWith 1
1049
1050 dieWith :: Int -> String -> IO a
1051 dieWith ec s = do
1052   hFlush stdout
1053   prog <- getProgramName
1054   hPutStrLn stderr (prog ++ ": " ++ s)
1055   exitWith (ExitFailure ec)
1056
1057 dieOrForceAll :: Force -> String -> IO ()
1058 dieOrForceAll ForceAll s = ignoreError s
1059 dieOrForceAll _other s   = dieForcible s
1060
1061 dieOrForceFile :: Force -> String -> IO ()
1062 dieOrForceFile ForceAll   s = ignoreError s
1063 dieOrForceFile ForceFiles s = ignoreError s
1064 dieOrForceFile _other     s = dieForcible s
1065
1066 ignoreError :: String -> IO ()
1067 ignoreError s = do hFlush stdout; hPutStrLn stderr (s ++ " (ignoring)")
1068
1069 dieForcible :: String -> IO ()
1070 dieForcible s = die (s ++ " (use --force to override)")
1071
1072 my_head :: String -> [a] -> a
1073 my_head s []      = error s
1074 my_head _ (x : _) = x
1075
1076 -----------------------------------------
1077 -- Cut and pasted from ghc/compiler/main/SysTools
1078
1079 #if defined(mingw32_HOST_OS)
1080 subst :: Char -> Char -> String -> String
1081 subst a b ls = map (\ x -> if x == a then b else x) ls
1082
1083 unDosifyPath :: FilePath -> FilePath
1084 unDosifyPath xs = subst '\\' '/' xs
1085
1086 getExecDir :: String -> IO (Maybe String)
1087 -- (getExecDir cmd) returns the directory in which the current
1088 --                  executable, which should be called 'cmd', is running
1089 -- So if the full path is /a/b/c/d/e, and you pass "d/e" as cmd,
1090 -- you'll get "/a/b/c" back as the result
1091 getExecDir cmd
1092   = allocaArray len $ \buf -> do
1093         ret <- getModuleFileName nullPtr buf len
1094         if ret == 0 then return Nothing
1095                     else do s <- peekCString buf
1096                             return (Just (reverse (drop (length cmd)
1097                                                         (reverse (unDosifyPath s)))))
1098   where
1099     len = 2048::Int -- Plenty, PATH_MAX is 512 under Win32.
1100
1101 foreign import stdcall unsafe  "GetModuleFileNameA"
1102   getModuleFileName :: Ptr () -> CString -> Int -> IO Int32
1103 #else
1104 getExecDir :: String -> IO (Maybe String)
1105 getExecDir _ = return Nothing
1106 #endif
1107
1108 -----------------------------------------
1109 -- Adapted from ghc/compiler/utils/Panic
1110
1111 installSignalHandlers :: IO ()
1112 installSignalHandlers = do
1113   threadid <- myThreadId
1114   let
1115       interrupt = Exception.throwTo threadid
1116                                     (Exception.ErrorCall "interrupted")
1117   --
1118 #if !defined(mingw32_HOST_OS)
1119   installHandler sigQUIT (Catch interrupt) Nothing
1120   installHandler sigINT  (Catch interrupt) Nothing
1121   return ()
1122 #elif __GLASGOW_HASKELL__ >= 603
1123   -- GHC 6.3+ has support for console events on Windows
1124   -- NOTE: running GHCi under a bash shell for some reason requires
1125   -- you to press Ctrl-Break rather than Ctrl-C to provoke
1126   -- an interrupt.  Ctrl-C is getting blocked somewhere, I don't know
1127   -- why --SDM 17/12/2004
1128   let sig_handler ControlC = interrupt
1129       sig_handler Break    = interrupt
1130       sig_handler _        = return ()
1131
1132   installHandler (Catch sig_handler)
1133   return ()
1134 #else
1135   return () -- nothing
1136 #endif
1137
1138 #if __GLASGOW_HASKELL__ <= 604
1139 isInfixOf               :: (Eq a) => [a] -> [a] -> Bool
1140 isInfixOf needle haystack = any (isPrefixOf needle) (tails haystack)
1141 #endif
1142
1143 catchIO :: IO a -> (Exception.IOException -> IO a) -> IO a
1144 catchIO = Exception.catch
1145
1146 #if mingw32_HOST_OS || mingw32_TARGET_OS
1147 throwIOIO :: Exception.IOException -> IO a
1148 throwIOIO = Exception.throwIO
1149 #endif
1150
1151 catchError :: IO a -> (String -> IO a) -> IO a
1152 catchError io handler = io `Exception.catch` handler'
1153     where handler' (Exception.ErrorCall err) = handler err
1154
1155
1156 -- copied from Cabal's Distribution.Simple.Utils, except that we want
1157 -- to use text files here, rather than binary files.
1158 writeFileAtomic :: FilePath -> String -> IO ()
1159 writeFileAtomic targetFile content = do
1160   (newFile, newHandle) <- openNewFile targetDir template
1161   do  hPutStr newHandle content
1162       hClose newHandle
1163 #if mingw32_HOST_OS || mingw32_TARGET_OS
1164       renameFile newFile targetFile
1165         -- If the targetFile exists then renameFile will fail
1166         `catchIO` \err -> do
1167           exists <- doesFileExist targetFile
1168           if exists
1169             then do removeFile targetFile
1170                     -- Big fat hairy race condition
1171                     renameFile newFile targetFile
1172                     -- If the removeFile succeeds and the renameFile fails
1173                     -- then we've lost the atomic property.
1174             else throwIOIO err
1175 #else
1176       renameFile newFile targetFile
1177 #endif
1178    `Exception.onException` do hClose newHandle
1179                               removeFile newFile
1180   where
1181     template = targetName <.> "tmp"
1182     targetDir | null targetDir_ = "."
1183               | otherwise       = targetDir_
1184     --TODO: remove this when takeDirectory/splitFileName is fixed
1185     --      to always return a valid dir
1186     (targetDir_,targetName) = splitFileName targetFile
1187
1188 -- Ugh, this is a copy/paste of code from the base library, but
1189 -- if uses 666 rather than 600 for the permissions.
1190 openNewFile :: FilePath -> String -> IO (FilePath, Handle)
1191 openNewFile dir template = do
1192   pid <- c_getpid
1193   findTempName pid
1194   where
1195     -- We split off the last extension, so we can use .foo.ext files
1196     -- for temporary files (hidden on Unix OSes). Unfortunately we're
1197     -- below filepath in the hierarchy here.
1198     (prefix,suffix) =
1199        case break (== '.') $ reverse template of
1200          -- First case: template contains no '.'s. Just re-reverse it.
1201          (rev_suffix, "")       -> (reverse rev_suffix, "")
1202          -- Second case: template contains at least one '.'. Strip the
1203          -- dot from the prefix and prepend it to the suffix (if we don't
1204          -- do this, the unique number will get added after the '.' and
1205          -- thus be part of the extension, which is wrong.)
1206          (rev_suffix, '.':rest) -> (reverse rest, '.':reverse rev_suffix)
1207          -- Otherwise, something is wrong, because (break (== '.')) should
1208          -- always return a pair with either the empty string or a string
1209          -- beginning with '.' as the second component.
1210          _                      -> error "bug in System.IO.openTempFile"
1211
1212     oflags = rw_flags .|. o_EXCL
1213
1214     findTempName x = do
1215       fd <- withCString filepath $ \ f ->
1216               c_open f oflags 0o666
1217       if fd < 0
1218        then do
1219          errno <- getErrno
1220          if errno == eEXIST
1221            then findTempName (x+1)
1222            else ioError (errnoToIOError "openNewBinaryFile" errno Nothing (Just dir))
1223        else do
1224          -- XXX We want to tell fdToHandle what the filepath is,
1225          -- as any exceptions etc will only be able to report the
1226          -- fd currently
1227          h <-
1228 #if __GLASGOW_HASKELL__ >= 609
1229               fdToHandle fd
1230 #else
1231               fdToHandle (fromIntegral fd)
1232 #endif
1233               `Exception.onException` c_close fd
1234          return (filepath, h)
1235       where
1236         filename        = prefix ++ show x ++ suffix
1237         filepath        = dir `combine` filename
1238
1239 -- XXX Copied from GHC.Handle
1240 std_flags, output_flags, rw_flags :: CInt
1241 std_flags    = o_NONBLOCK   .|. o_NOCTTY
1242 output_flags = std_flags    .|. o_CREAT
1243 rw_flags     = output_flags .|. o_RDWR
1244
1245 -- | The function splits the given string to substrings
1246 -- using 'isSearchPathSeparator'.
1247 parseSearchPath :: String -> [FilePath]
1248 parseSearchPath path = split path
1249   where
1250     split :: String -> [String]
1251     split s =
1252       case rest' of
1253         []     -> [chunk]
1254         _:rest -> chunk : split rest
1255       where
1256         chunk =
1257           case chunk' of
1258 #ifdef mingw32_HOST_OS
1259             ('\"':xs@(_:_)) | last xs == '\"' -> init xs
1260 #endif
1261             _                                 -> chunk'
1262
1263         (chunk', rest') = break isSearchPathSeparator s