2 % (c) The University of Glasgow, 2006
5 -- | Package manipulation
9 -- * The PackageConfigMap
10 PackageConfigMap, emptyPackageConfigMap, lookupPackage,
11 extendPackageConfigMap, dumpPackages,
13 -- * Reading the package config, and processing cmdline args
17 lookupModuleInAllPackages,
19 -- * Inspecting the set of packages in scope
20 getPackageIncludePath,
21 getPackageLibraryPath,
23 getPackageExtraCcOpts,
24 getPackageFrameworkPath,
26 getPreloadPackagesAnd,
28 collectIncludeDirs, collectLibraryPaths, collectLinkOpts,
36 #include "HsVersions.h"
39 import DynFlags ( dopt, DynFlag(..), DynFlags(..), PackageFlag(..) )
41 import Config ( cProjectVersion )
42 import Name ( Name, nameModule_maybe )
51 import System.Environment ( getEnv )
52 import Distribution.InstalledPackageInfo
53 import Distribution.InstalledPackageInfo.Binary
54 import Distribution.Package hiding (PackageId,depends)
56 import ErrUtils ( debugTraceMsg, putMsg, Message )
59 import System.Directory
60 import System.FilePath
62 import Data.List as List
64 -- ---------------------------------------------------------------------------
67 -- | Package state is all stored in 'DynFlag's, including the details of
68 -- all packages, which packages are exposed, and which modules they
71 -- The package state is computed by 'initPackages', and kept in DynFlags.
73 -- * @-package <pkg>@ causes @<pkg>@ to become exposed, and all other packages
74 -- with the same name to become hidden.
76 -- * @-hide-package <pkg>@ causes @<pkg>@ to become hidden.
78 -- * Let @exposedPackages@ be the set of packages thus exposed.
79 -- Let @depExposedPackages@ be the transitive closure from @exposedPackages@ of
80 -- their dependencies.
82 -- * When searching for a module from an preload import declaration,
83 -- only the exposed modules in @exposedPackages@ are valid.
85 -- * When searching for a module from an implicit import, all modules
86 -- from @depExposedPackages@ are valid.
88 -- * When linking in a compilation manager mode, we link in packages the
89 -- program depends on (the compiler knows this list by the
90 -- time it gets to the link step). Also, we link in all packages
91 -- which were mentioned with preload @-package@ flags on the command-line,
92 -- or are a transitive dependency of same, or are \"base\"\/\"rts\".
93 -- The reason for this is that we might need packages which don't
94 -- contain any Haskell modules, and therefore won't be discovered
95 -- by the normal mechanism of dependency tracking.
99 -- When compiling module A, which imports module B, we need to
100 -- know whether B will be in the same DLL as A.
101 -- If it's in the same DLL, we refer to B_f_closure
102 -- If it isn't, we refer to _imp__B_f_closure
103 -- When compiling A, we record in B's Module value whether it's
104 -- in a different DLL, by setting the DLL flag.
106 data PackageState = PackageState {
107 pkgIdMap :: PackageConfigMap, -- PackageId -> PackageConfig
108 -- The exposed flags are adjusted according to -package and
109 -- -hide-package flags, and -ignore-package removes packages.
111 preloadPackages :: [PackageId],
112 -- The packages we're going to link in eagerly. This list
113 -- should be in reverse dependency order; that is, a package
114 -- is always mentioned before the packages it depends on.
116 moduleToPkgConfAll :: UniqFM [(PackageConfig,Bool)], -- ModuleEnv mapping
117 -- Derived from pkgIdMap.
118 -- Maps Module to (pkgconf,exposed), where pkgconf is the
119 -- PackageConfig for the package containing the module, and
120 -- exposed is True if the package exposes that module.
122 installedPackageIdMap :: InstalledPackageIdMap
125 -- | A PackageConfigMap maps a 'PackageId' to a 'PackageConfig'
126 type PackageConfigMap = UniqFM PackageConfig
128 type InstalledPackageIdMap = FiniteMap InstalledPackageId PackageId
130 emptyPackageConfigMap :: PackageConfigMap
131 emptyPackageConfigMap = emptyUFM
133 -- | Find the package we know about with the given id (e.g. \"foo-1.0\"), if any
134 lookupPackage :: PackageConfigMap -> PackageId -> Maybe PackageConfig
135 lookupPackage = lookupUFM
137 extendPackageConfigMap
138 :: PackageConfigMap -> [PackageConfig] -> PackageConfigMap
139 extendPackageConfigMap pkg_map new_pkgs
140 = foldl add pkg_map new_pkgs
141 where add pkg_map p = addToUFM pkg_map (packageConfigId p) p
143 -- | Looks up the package with the given id in the package state, panicing if it is
145 getPackageDetails :: PackageState -> PackageId -> PackageConfig
146 getPackageDetails ps pid = expectJust "getPackageDetails" (lookupPackage (pkgIdMap ps) pid)
148 -- ----------------------------------------------------------------------------
149 -- Loading the package config files and building up the package state
151 -- | Call this after 'DynFlags.parseDynFlags'. It reads the package
152 -- configuration files, and sets up various internal tables of package
153 -- information, according to the package-related flags on the
154 -- command-line (@-package@, @-hide-package@ etc.)
156 -- Returns a list of packages to link in if we're doing dynamic linking.
157 -- This list contains the packages that the user explicitly mentioned with
160 -- 'initPackages' can be called again subsequently after updating the
161 -- 'packageFlags' field of the 'DynFlags', and it will update the
162 -- 'pkgState' in 'DynFlags' and return a list of packages to
164 initPackages :: DynFlags -> IO (DynFlags, [PackageId])
165 initPackages dflags = do
166 pkg_db <- case pkgDatabase dflags of
167 Nothing -> readPackageConfigs dflags
169 (pkg_state, preload, this_pkg)
170 <- mkPackageState dflags pkg_db [] (thisPackage dflags)
171 return (dflags{ pkgDatabase = Just pkg_db,
172 pkgState = pkg_state,
173 thisPackage = this_pkg },
176 -- -----------------------------------------------------------------------------
177 -- Reading the package database(s)
179 readPackageConfigs :: DynFlags -> IO [PackageConfig]
180 readPackageConfigs dflags = do
181 e_pkg_path <- tryIO (getEnv "GHC_PACKAGE_PATH")
182 system_pkgconfs <- getSystemPackageConfigs dflags
184 let pkgconfs = case e_pkg_path of
185 Left _ -> system_pkgconfs
187 | last cs == "" -> init cs ++ system_pkgconfs
189 where cs = parseSearchPath path
190 -- if the path ends in a separator (eg. "/foo/bar:")
191 -- the we tack on the system paths.
193 pkgs <- mapM (readPackageConfig dflags)
194 (reverse pkgconfs ++ reverse (extraPkgConfs dflags))
195 -- later packages shadow earlier ones. extraPkgConfs
196 -- is in the opposite order to the flags on the
202 getSystemPackageConfigs :: DynFlags -> IO [FilePath]
203 getSystemPackageConfigs dflags = do
204 -- System one always comes first
205 let system_pkgconf = systemPackageConfig dflags
207 -- Read user's package conf (eg. ~/.ghc/i386-linux-6.3/package.conf)
208 -- unless the -no-user-package-conf flag was given.
210 if not (dopt Opt_ReadUserPackageConf dflags) then return [] else do
211 appdir <- getAppUserDataDirectory "ghc"
213 dir = appdir </> (TARGET_ARCH ++ '-':TARGET_OS ++ '-':cProjectVersion)
214 pkgconf = dir </> "package.conf.d"
216 exist <- doesDirectoryExist pkgconf
217 if exist then return [pkgconf] else return []
218 `catchIO` (\_ -> return [])
220 return (user_pkgconf ++ [system_pkgconf])
222 readPackageConfig :: DynFlags -> FilePath -> IO [PackageConfig]
223 readPackageConfig dflags conf_file = do
224 isdir <- doesDirectoryExist conf_file
228 then do let filename = conf_file </> "package.cache"
229 debugTraceMsg dflags 2 (text "Using binary package database:" <+> text filename)
230 conf <- readBinPackageDB filename
231 return (map installedPackageInfoToPackageConfig conf)
234 isfile <- doesFileExist conf_file
236 ghcError $ InstallationError $
237 "can't find a package database at " ++ conf_file
238 debugTraceMsg dflags 2 (text "Using package config file:" <+> text conf_file)
239 str <- readFile conf_file
240 return (map installedPackageInfoToPackageConfig $ read str)
243 top_dir = topDir dflags
244 pkg_configs1 = mungePackagePaths top_dir proto_pkg_configs
245 pkg_configs2 = maybeHidePackages dflags pkg_configs1
249 maybeHidePackages :: DynFlags -> [PackageConfig] -> [PackageConfig]
250 maybeHidePackages dflags pkgs
251 | dopt Opt_HideAllPackages dflags = map hide pkgs
254 hide pkg = pkg{ exposed = False }
256 mungePackagePaths :: String -> [PackageConfig] -> [PackageConfig]
257 -- Replace the string "$topdir" at the beginning of a path
258 -- with the current topdir (obtained from the -B option).
259 mungePackagePaths top_dir ps = map munge_pkg ps
261 munge_pkg p = p{ importDirs = munge_paths (importDirs p),
262 includeDirs = munge_paths (includeDirs p),
263 libraryDirs = munge_paths (libraryDirs p),
264 frameworkDirs = munge_paths (frameworkDirs p),
265 haddockInterfaces = munge_paths (haddockInterfaces p),
266 haddockHTMLs = munge_paths (haddockHTMLs p)
269 munge_paths = map munge_path
272 | Just p' <- stripPrefix "$topdir" p = top_dir ++ p'
273 | Just p' <- stripPrefix "$httptopdir" p = toHttpPath top_dir ++ p'
276 toHttpPath p = "file:///" ++ p
279 -- -----------------------------------------------------------------------------
280 -- Modify our copy of the package database based on a package flag
281 -- (-package, -hide-package, -ignore-package).
285 -> [PackageConfig] -- Initial database
286 -> PackageFlag -- flag to apply
287 -> IO [PackageConfig] -- new database
289 applyPackageFlag unusable pkgs flag =
292 case selectPackages (matchingStr str) pkgs unusable of
293 Left ps -> packageFlagErr flag ps
294 Right (p:ps,qs) -> return (p':ps')
295 where p' = p {exposed=True}
296 ps' = hideAll (pkgName (sourcePackageId p)) (ps++qs)
297 _ -> panic "applyPackageFlag"
299 ExposePackageId str ->
300 case selectPackages (matchingId str) pkgs unusable of
301 Left ps -> packageFlagErr flag ps
302 Right (p:ps,qs) -> return (p':ps')
303 where p' = p {exposed=True}
304 ps' = hideAll (pkgName (sourcePackageId p)) (ps++qs)
305 _ -> panic "applyPackageFlag"
308 case selectPackages (matchingStr str) pkgs unusable of
309 Left ps -> packageFlagErr flag ps
310 Right (ps,qs) -> return (map hide ps ++ qs)
311 where hide p = p {exposed=False}
313 _ -> panic "applyPackageFlag"
316 -- When a package is requested to be exposed, we hide all other
317 -- packages with the same name.
318 hideAll name ps = map maybe_hide ps
320 | pkgName (sourcePackageId p) == name = p {exposed=False}
324 selectPackages :: (PackageConfig -> Bool) -> [PackageConfig]
326 -> Either [(PackageConfig, UnusablePackageReason)]
327 ([PackageConfig], [PackageConfig])
328 selectPackages matches pkgs unusable
330 (ps,rest) = partition matches pkgs
331 reasons = [ (p, lookupFM unusable (installedPackageId p))
334 if all (isJust.snd) reasons
335 then Left [ (p, reason) | (p,Just reason) <- reasons ]
336 else Right (sortByVersion [ p | (p,Nothing) <- reasons ], rest)
338 -- A package named on the command line can either include the
339 -- version, or just the name if it is unambiguous.
340 matchingStr :: String -> PackageConfig -> Bool
342 = str == display (sourcePackageId p)
343 || str == display (pkgName (sourcePackageId p))
345 matchingId :: String -> PackageConfig -> Bool
346 matchingId str p = InstalledPackageId str == installedPackageId p
348 sortByVersion :: [InstalledPackageInfo_ m] -> [InstalledPackageInfo_ m]
349 sortByVersion = sortBy (flip (comparing (pkgVersion.sourcePackageId)))
351 comparing :: Ord a => (t -> a) -> t -> t -> Ordering
352 comparing f a b = f a `compare` f b
354 packageFlagErr :: PackageFlag
355 -> [(PackageConfig, UnusablePackageReason)]
357 packageFlagErr flag reasons = ghcError (CmdLineError (showSDoc $ err))
358 where err = text "cannot satisfy " <> ppr_flag <>
359 (if null reasons then empty else text ": ") $$
360 nest 4 (ppr_reasons $$
361 text "(use -v for more information)")
362 ppr_flag = case flag of
363 IgnorePackage p -> text "-ignore-package " <> text p
364 HidePackage p -> text "-hide-package " <> text p
365 ExposePackage p -> text "-package " <> text p
366 ExposePackageId p -> text "-package-id " <> text p
367 ppr_reasons = vcat (map ppr_reason reasons)
368 ppr_reason (p, reason) = pprReason (pprIPkg p <+> text "is") reason
370 -- -----------------------------------------------------------------------------
371 -- Hide old versions of packages
374 -- hide all packages for which there is also a later version
375 -- that is already exposed. This just makes it non-fatal to have two
376 -- versions of a package exposed, which can happen if you install a
377 -- later version of a package in the user database, for example.
379 hideOldPackages :: DynFlags -> [PackageConfig] -> IO [PackageConfig]
380 hideOldPackages dflags pkgs = mapM maybe_hide pkgs
382 | not (exposed p) = return p
383 | (p' : _) <- later_versions = do
384 debugTraceMsg dflags 2 $
385 (ptext (sLit "hiding package") <+> pprSPkg p <+>
386 ptext (sLit "to avoid conflict with later version") <+>
388 return (p {exposed=False})
389 | otherwise = return p
390 where myname = pkgName (sourcePackageId p)
391 myversion = pkgVersion (sourcePackageId p)
392 later_versions = [ p | p <- pkgs, exposed p,
393 let pkg = sourcePackageId p,
394 pkgName pkg == myname,
395 pkgVersion pkg > myversion ]
397 -- -----------------------------------------------------------------------------
402 -> [PackageConfig] -- database
403 -> IO [PackageConfig]
405 findWiredInPackages dflags pkgs = do
407 -- Now we must find our wired-in packages, and rename them to
408 -- their canonical names (eg. base-1.0 ==> base).
411 wired_in_pkgids :: [String]
412 wired_in_pkgids = map packageIdString
422 matches :: PackageConfig -> String -> Bool
423 pc `matches` pid = display (pkgName (sourcePackageId pc)) == pid
425 -- find which package corresponds to each wired-in package
426 -- delete any other packages with the same name
427 -- update the package and any dependencies to point to the new
430 -- When choosing which package to map to a wired-in package
431 -- name, we prefer exposed packages, and pick the latest
432 -- version. To override the default choice, -hide-package
433 -- could be used to hide newer versions.
435 findWiredInPackage :: [PackageConfig] -> String
436 -> IO (Maybe InstalledPackageId)
437 findWiredInPackage pkgs wired_pkg =
438 let all_ps = [ p | p <- pkgs, p `matches` wired_pkg ] in
441 many -> pick (head (sortByVersion many))
444 debugTraceMsg dflags 2 $
445 ptext (sLit "wired-in package ")
447 <> ptext (sLit " not found.")
449 pick :: InstalledPackageInfo_ ModuleName
450 -> IO (Maybe InstalledPackageId)
452 debugTraceMsg dflags 2 $
453 ptext (sLit "wired-in package ")
455 <> ptext (sLit " mapped to ")
457 return (Just (installedPackageId pkg))
460 mb_wired_in_ids <- mapM (findWiredInPackage pkgs) wired_in_pkgids
462 wired_in_ids = catMaybes mb_wired_in_ids
464 -- this is old: we used to assume that if there were
465 -- multiple versions of wired-in packages installed that
466 -- they were mutually exclusive. Now we're assuming that
467 -- you have one "main" version of each wired-in package
468 -- (the latest version), and the others are backward-compat
469 -- wrappers that depend on this one. e.g. base-4.0 is the
470 -- latest, base-3.0 is a compat wrapper depending on base-4.0.
472 deleteOtherWiredInPackages pkgs = filterOut bad pkgs
473 where bad p = any (p `matches`) wired_in_pkgids
474 && package p `notElem` map fst wired_in_ids
477 updateWiredInDependencies pkgs = map upd_pkg pkgs
479 | installedPackageId p `elem` wired_in_ids
480 = p { sourcePackageId = (sourcePackageId p){ pkgVersion = Version [] [] } }
484 return $ updateWiredInDependencies pkgs
486 -- ----------------------------------------------------------------------------
488 data UnusablePackageReason
490 | MissingDependencies [InstalledPackageId]
491 | ShadowedBy InstalledPackageId
493 type UnusablePackages = FiniteMap InstalledPackageId UnusablePackageReason
495 pprReason :: SDoc -> UnusablePackageReason -> SDoc
496 pprReason pref reason = case reason of
498 pref <+> ptext (sLit "ignored due to an -ignore-package flag")
499 MissingDependencies deps ->
501 ptext (sLit "unusable due to missing or recursive dependencies:") $$
502 nest 2 (hsep (map (text.display) deps))
504 pref <+> ptext (sLit "shadowed by package ") <> text (display ipid)
506 reportUnusable :: DynFlags -> UnusablePackages -> IO ()
507 reportUnusable dflags pkgs = mapM_ report (fmToList pkgs)
509 report (ipid, reason) =
510 debugTraceMsg dflags 2 $
512 (ptext (sLit "package") <+>
513 text (display ipid) <+> text "is") reason
515 -- ----------------------------------------------------------------------------
517 -- Detect any packages that have missing dependencies, and also any
518 -- mutually-recursive groups of packages (loops in the package graph
519 -- are not allowed). We do this by taking the least fixpoint of the
520 -- dependency graph, repeatedly adding packages whose dependencies are
521 -- satisfied until no more can be added.
523 findBroken :: [PackageConfig] -> UnusablePackages
524 findBroken pkgs = go [] emptyFM pkgs
526 go avail ipids not_avail =
527 case partitionWith (depsAvailable ipids) not_avail of
529 listToFM [ (installedPackageId p, MissingDependencies deps)
530 | (p,deps) <- not_avail ]
531 (new_avail, not_avail) ->
532 go (new_avail ++ avail) new_ipids (map fst not_avail)
533 where new_ipids = addListToFM ipids
534 [ (installedPackageId p, p) | p <- new_avail ]
536 depsAvailable :: FiniteMap InstalledPackageId PackageConfig
538 -> Either PackageConfig (PackageConfig, [InstalledPackageId])
539 depsAvailable ipids pkg
540 | null dangling = Left pkg
541 | otherwise = Right (pkg, dangling)
542 where dangling = filter (not . (`elemFM` ipids)) (depends pkg)
544 -- -----------------------------------------------------------------------------
545 -- Eliminate shadowed packages, giving the user some feedback
547 -- later packages in the list should shadow earlier ones with the same
548 -- package name/version.
549 shadowPackages :: [PackageConfig] -> UnusablePackages
551 = let (_,shadowed) = foldl check (emptyUFM,[]) pkgs
554 check (pkgmap,shadowed) pkg
555 = (addToUFM pkgmap (packageConfigId pkg) pkg, shadowed')
558 | Just oldpkg <- lookupUFM pkgmap (packageConfigId pkg)
559 = (installedPackageId oldpkg, ShadowedBy (installedPackageId pkg))
564 -- -----------------------------------------------------------------------------
566 ignorePackages :: [PackageFlag] -> [PackageConfig] -> UnusablePackages
567 ignorePackages flags pkgs = listToFM (concatMap doit flags)
569 doit (IgnorePackage str) =
570 case partition (matchingStr str) pkgs of
571 (ps, _) -> [ (installedPackageId p, IgnoredWithFlag)
573 -- missing package is not an error for -ignore-package,
574 -- because a common usage is to -ignore-package P as
575 -- a preventative measure just in case P exists.
576 doit _ = panic "ignorePackages"
578 -- -----------------------------------------------------------------------------
579 -- When all the command-line options are in, we can process our package
580 -- settings and populate the package state.
584 -> [PackageConfig] -- initial database
585 -> [PackageId] -- preloaded packages
586 -> PackageId -- this package
588 [PackageId], -- new packages to preload
589 PackageId) -- this package, might be modified if the current
591 -- package is a wired-in package.
593 mkPackageState dflags pkgs0 preload0 this_package = do
596 flags = reverse (packageFlags dflags)
597 (ignore_flags, other_flags) = partition is_ignore flags
598 is_ignore IgnorePackage{} = True
601 shadowed = shadowPackages pkgs0
602 ignored = ignorePackages ignore_flags pkgs0
604 pkgs0' = filter (not . (`elemFM` (plusFM shadowed ignored)) . installedPackageId) pkgs0
605 broken = findBroken pkgs0'
606 unusable = shadowed `plusFM` ignored `plusFM` broken
608 reportUnusable dflags unusable
611 -- Modify the package database according to the command-line flags
612 -- (-package, -hide-package, -ignore-package, -hide-all-packages).
614 pkgs1 <- foldM (applyPackageFlag unusable) pkgs0 other_flags
615 let pkgs2 = filter (not . (`elemFM` unusable) . installedPackageId) pkgs1
617 -- Here we build up a set of the packages mentioned in -package
618 -- flags on the command line; these are called the "preload"
619 -- packages. we link these packages in eagerly. The preload set
620 -- should contain at least rts & base, which is why we pretend that
621 -- the command line contains -package rts & -package base.
623 let preload1 = [ installedPackageId p | f <- flags, p <- get_exposed f ]
625 get_exposed (ExposePackage s) = filter (matchingStr s) pkgs2
626 get_exposed (ExposePackageId s) = filter (matchingId s) pkgs2
629 -- hide packages that are subsumed by later versions
630 pkgs3 <- hideOldPackages dflags pkgs2
632 -- sort out which packages are wired in
633 pkgs4 <- findWiredInPackages dflags pkgs3
635 let pkg_db = extendPackageConfigMap emptyPackageConfigMap pkgs4
637 ipid_map = listToFM [ (installedPackageId p, packageConfigId p)
640 lookupIPID ipid@(InstalledPackageId str)
641 | Just pid <- lookupFM ipid_map ipid = return pid
642 | otherwise = missingPackageErr str
644 preload2 <- mapM lookupIPID preload1
647 -- add base & rts to the preload packages
649 | dopt Opt_AutoLinkPackages dflags
650 = filter (flip elemUFM pkg_db) [basePackageId, rtsPackageId]
652 -- but in any case remove the current package from the set of
653 -- preloaded packages so that base/rts does not end up in the
654 -- set up preloaded package when we are just building it
655 preload3 = nub $ filter (/= this_package)
656 $ (basicLinkedPackages ++ preload2)
658 -- Close the preload packages with their dependencies
659 dep_preload <- closeDeps pkg_db ipid_map (zip preload3 (repeat Nothing))
660 let new_dep_preload = filter (`notElem` preload0) dep_preload
662 let pstate = PackageState{ preloadPackages = dep_preload,
664 moduleToPkgConfAll = mkModuleMap pkg_db,
665 installedPackageIdMap = ipid_map
668 return (pstate, new_dep_preload, this_package)
671 -- -----------------------------------------------------------------------------
672 -- Make the mapping from module to package info
676 -> UniqFM [(PackageConfig, Bool)]
677 mkModuleMap pkg_db = foldr extend_modmap emptyUFM pkgids
679 pkgids = map packageConfigId (eltsUFM pkg_db)
681 extend_modmap pkgid modmap =
682 addListToUFM_C (++) modmap
683 ([(m, [(pkg, True)]) | m <- exposed_mods] ++
684 [(m, [(pkg, False)]) | m <- hidden_mods])
686 pkg = expectJust "mkModuleMap" (lookupPackage pkg_db pkgid)
687 exposed_mods = exposedModules pkg
688 hidden_mods = hiddenModules pkg
690 pprSPkg :: PackageConfig -> SDoc
691 pprSPkg p = text (display (sourcePackageId p))
693 pprIPkg :: PackageConfig -> SDoc
694 pprIPkg p = text (display (installedPackageId p))
696 -- -----------------------------------------------------------------------------
697 -- Extracting information from the packages in scope
699 -- Many of these functions take a list of packages: in those cases,
700 -- the list is expected to contain the "dependent packages",
701 -- i.e. those packages that were found to be depended on by the
702 -- current module/program. These can be auto or non-auto packages, it
703 -- doesn't really matter. The list is always combined with the list
704 -- of preload (command-line) packages to determine which packages to
707 -- | Find all the include directories in these and the preload packages
708 getPackageIncludePath :: DynFlags -> [PackageId] -> IO [String]
709 getPackageIncludePath dflags pkgs =
710 collectIncludeDirs `fmap` getPreloadPackagesAnd dflags pkgs
712 collectIncludeDirs :: [PackageConfig] -> [FilePath]
713 collectIncludeDirs ps = nub (filter notNull (concatMap includeDirs ps))
715 -- | Find all the library paths in these and the preload packages
716 getPackageLibraryPath :: DynFlags -> [PackageId] -> IO [String]
717 getPackageLibraryPath dflags pkgs =
718 collectLibraryPaths `fmap` getPreloadPackagesAnd dflags pkgs
720 collectLibraryPaths :: [PackageConfig] -> [FilePath]
721 collectLibraryPaths ps = nub (filter notNull (concatMap libraryDirs ps))
723 -- | Find all the link options in these and the preload packages
724 getPackageLinkOpts :: DynFlags -> [PackageId] -> IO [String]
725 getPackageLinkOpts dflags pkgs =
726 collectLinkOpts dflags `fmap` getPreloadPackagesAnd dflags pkgs
728 collectLinkOpts :: DynFlags -> [PackageConfig] -> [String]
729 collectLinkOpts dflags ps = concat (map all_opts ps)
731 libs p = packageHsLibs dflags p ++ extraLibraries p
732 all_opts p = map ("-l" ++) (libs p) ++ ldOptions p
734 packageHsLibs :: DynFlags -> PackageConfig -> [String]
735 packageHsLibs dflags p = map (mkDynName . addSuffix) (hsLibraries p)
737 non_dyn_ways = filter ((/= WayDyn) . wayName) (ways dflags)
738 -- the name of a shared library is libHSfoo-ghc<version>.so
739 -- we leave out the _dyn, because it is superfluous
741 tag = mkBuildTag (filter (not . wayRTSOnly) non_dyn_ways)
742 rts_tag = mkBuildTag non_dyn_ways
744 mkDynName | opt_Static = id
745 | otherwise = (++ ("-ghc" ++ cProjectVersion))
747 addSuffix rts@"HSrts" = rts ++ (expandTag rts_tag)
748 addSuffix other_lib = other_lib ++ (expandTag tag)
750 expandTag t | null t = ""
753 -- | Find all the C-compiler options in these and the preload packages
754 getPackageExtraCcOpts :: DynFlags -> [PackageId] -> IO [String]
755 getPackageExtraCcOpts dflags pkgs = do
756 ps <- getPreloadPackagesAnd dflags pkgs
757 return (concatMap ccOptions ps)
759 -- | Find all the package framework paths in these and the preload packages
760 getPackageFrameworkPath :: DynFlags -> [PackageId] -> IO [String]
761 getPackageFrameworkPath dflags pkgs = do
762 ps <- getPreloadPackagesAnd dflags pkgs
763 return (nub (filter notNull (concatMap frameworkDirs ps)))
765 -- | Find all the package frameworks in these and the preload packages
766 getPackageFrameworks :: DynFlags -> [PackageId] -> IO [String]
767 getPackageFrameworks dflags pkgs = do
768 ps <- getPreloadPackagesAnd dflags pkgs
769 return (concatMap frameworks ps)
771 -- -----------------------------------------------------------------------------
774 -- | Takes a 'Module', and if the module is in a package returns
775 -- @(pkgconf, exposed)@ where pkgconf is the PackageConfig for that package,
776 -- and exposed is @True@ if the package exposes the module.
777 lookupModuleInAllPackages :: DynFlags -> ModuleName -> [(PackageConfig,Bool)]
778 lookupModuleInAllPackages dflags m =
779 case lookupUFM (moduleToPkgConfAll (pkgState dflags)) m of
783 -- | Find all the 'PackageConfig' in both the preload packages from 'DynFlags' and corresponding to the list of
785 getPreloadPackagesAnd :: DynFlags -> [PackageId] -> IO [PackageConfig]
786 getPreloadPackagesAnd dflags pkgids =
788 state = pkgState dflags
789 pkg_map = pkgIdMap state
790 ipid_map = installedPackageIdMap state
791 preload = preloadPackages state
792 pairs = zip pkgids (repeat Nothing)
794 all_pkgs <- throwErr (foldM (add_package pkg_map ipid_map) preload pairs)
795 return (map (getPackageDetails state) all_pkgs)
797 -- Takes a list of packages, and returns the list with dependencies included,
798 -- in reverse dependency order (a package appears before those it depends on).
799 closeDeps :: PackageConfigMap
800 -> FiniteMap InstalledPackageId PackageId
801 -> [(PackageId, Maybe PackageId)]
803 closeDeps pkg_map ipid_map ps = throwErr (closeDepsErr pkg_map ipid_map ps)
805 throwErr :: MaybeErr Message a -> IO a
806 throwErr m = case m of
807 Failed e -> ghcError (CmdLineError (showSDoc e))
808 Succeeded r -> return r
810 closeDepsErr :: PackageConfigMap
811 -> FiniteMap InstalledPackageId PackageId
812 -> [(PackageId,Maybe PackageId)]
813 -> MaybeErr Message [PackageId]
814 closeDepsErr pkg_map ipid_map ps = foldM (add_package pkg_map ipid_map) [] ps
817 add_package :: PackageConfigMap
818 -> FiniteMap InstalledPackageId PackageId
820 -> (PackageId,Maybe PackageId)
821 -> MaybeErr Message [PackageId]
822 add_package pkg_db ipid_map ps (p, mb_parent)
823 | p `elem` ps = return ps -- Check if we've already added this package
825 case lookupPackage pkg_db p of
826 Nothing -> Failed (missingPackageMsg (packageIdString p) <>
827 missingDependencyMsg mb_parent)
829 -- Add the package's dependents also
830 ps' <- foldM add_package_ipid ps (depends pkg)
833 add_package_ipid ps ipid@(InstalledPackageId str)
834 | Just pid <- lookupFM ipid_map ipid
835 = add_package pkg_db ipid_map ps (pid, Just p)
837 = Failed (missingPackageMsg str <> missingDependencyMsg mb_parent)
839 missingPackageErr :: String -> IO a
840 missingPackageErr p = ghcError (CmdLineError (showSDoc (missingPackageMsg p)))
842 missingPackageMsg :: String -> SDoc
843 missingPackageMsg p = ptext (sLit "unknown package:") <+> text p
845 missingDependencyMsg :: Maybe PackageId -> SDoc
846 missingDependencyMsg Nothing = empty
847 missingDependencyMsg (Just parent)
848 = space <> parens (ptext (sLit "dependency of") <+> ftext (packageIdFS parent))
850 -- -----------------------------------------------------------------------------
852 -- | Will the 'Name' come from a dynamically linked library?
853 isDllName :: PackageId -> Name -> Bool
854 isDllName this_pkg name
856 | Just mod <- nameModule_maybe name = modulePackageId mod /= this_pkg
857 | otherwise = False -- no, it is not even an external name
859 -- -----------------------------------------------------------------------------
860 -- Displaying packages
862 -- | Show package info on console, if verbosity is >= 3
863 dumpPackages :: DynFlags -> IO ()
865 = do let pkg_map = pkgIdMap (pkgState dflags)
867 vcat (map (text . showInstalledPackageInfo
868 . packageConfigToInstalledPackageInfo)