Follow changes in Cabal: package -> sourcePackageId
[ghc-hetmet.git] / compiler / main / Packages.lhs
1 %
2 % (c) The University of Glasgow, 2006
3 %
4 \begin{code}
5 -- | Package manipulation
6 module Packages (
7         module PackageConfig,
8
9         -- * The PackageConfigMap
10         PackageConfigMap, emptyPackageConfigMap, lookupPackage,
11         extendPackageConfigMap, dumpPackages,
12
13         -- * Reading the package config, and processing cmdline args
14         PackageState(..),
15         initPackages,
16         getPackageDetails,
17         lookupModuleInAllPackages,
18
19         -- * Inspecting the set of packages in scope
20         getPackageIncludePath,
21         getPackageLibraryPath,
22         getPackageLinkOpts,
23         getPackageExtraCcOpts,
24         getPackageFrameworkPath,
25         getPackageFrameworks,
26         getPreloadPackagesAnd,
27
28         collectIncludeDirs, collectLibraryPaths, collectLinkOpts,
29         packageHsLibs,
30
31         -- * Utils
32         isDllName
33     )
34 where
35
36 #include "HsVersions.h"
37
38 import PackageConfig    
39 import ParsePkgConf     ( loadPackageConfig )
40 import DynFlags         ( dopt, DynFlag(..), DynFlags(..), PackageFlag(..) )
41 import StaticFlags
42 import Config           ( cProjectVersion )
43 import Name             ( Name, nameModule_maybe )
44 import UniqFM
45 import FiniteMap
46 import Module
47 import Util
48 import Panic
49 import Outputable
50 import Maybes
51
52 import System.Environment ( getEnv )
53 import Distribution.InstalledPackageInfo
54 import Distribution.Package hiding (PackageId,depends)
55 import FastString
56 import ErrUtils         ( debugTraceMsg, putMsg, Message )
57 import Exception
58
59 import System.Directory
60 import System.FilePath
61 import Control.Monad
62 import Data.List as List
63
64 -- ---------------------------------------------------------------------------
65 -- The Package state
66
67 -- | Package state is all stored in 'DynFlag's, including the details of
68 -- all packages, which packages are exposed, and which modules they
69 -- provide.
70 --
71 -- The package state is computed by 'initPackages', and kept in DynFlags.
72 --
73 --   * @-package <pkg>@ causes @<pkg>@ to become exposed, and all other packages 
74 --      with the same name to become hidden.
75 -- 
76 --   * @-hide-package <pkg>@ causes @<pkg>@ to become hidden.
77 -- 
78 --   * Let @exposedPackages@ be the set of packages thus exposed.  
79 --     Let @depExposedPackages@ be the transitive closure from @exposedPackages@ of
80 --     their dependencies.
81 --
82 --   * When searching for a module from an preload import declaration,
83 --     only the exposed modules in @exposedPackages@ are valid.
84 --
85 --   * When searching for a module from an implicit import, all modules
86 --     from @depExposedPackages@ are valid.
87 --
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.
96
97 -- Notes on DLLs
98 -- ~~~~~~~~~~~~~
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.
105
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.
110
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.
115
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.
121
122   installedPackageIdMap :: FiniteMap InstalledPackageId PackageId
123   }
124
125 -- | A PackageConfigMap maps a 'PackageId' to a 'PackageConfig'
126 type PackageConfigMap = UniqFM PackageConfig
127
128 emptyPackageConfigMap :: PackageConfigMap
129 emptyPackageConfigMap = emptyUFM
130
131 -- | Find the package we know about with the given id (e.g. \"foo-1.0\"), if any
132 lookupPackage :: PackageConfigMap -> PackageId -> Maybe PackageConfig
133 lookupPackage = lookupUFM
134
135 extendPackageConfigMap
136    :: PackageConfigMap -> [PackageConfig] -> PackageConfigMap
137 extendPackageConfigMap pkg_map new_pkgs 
138   = foldl add pkg_map new_pkgs
139   where add pkg_map p = addToUFM pkg_map (packageConfigId p) p
140
141 -- | Looks up the package with the given id in the package state, panicing if it is
142 -- not found
143 getPackageDetails :: PackageState -> PackageId -> PackageConfig
144 getPackageDetails ps pid = expectJust "getPackageDetails" (lookupPackage (pkgIdMap ps) pid)
145
146 -- ----------------------------------------------------------------------------
147 -- Loading the package config files and building up the package state
148
149 -- | Call this after 'DynFlags.parseDynFlags'.  It reads the package
150 -- configuration files, and sets up various internal tables of package
151 -- information, according to the package-related flags on the
152 -- command-line (@-package@, @-hide-package@ etc.)
153 --
154 -- Returns a list of packages to link in if we're doing dynamic linking.
155 -- This list contains the packages that the user explicitly mentioned with
156 -- @-package@ flags.
157 --
158 -- 'initPackages' can be called again subsequently after updating the
159 -- 'packageFlags' field of the 'DynFlags', and it will update the
160 -- 'pkgState' in 'DynFlags' and return a list of packages to
161 -- link in.
162 initPackages :: DynFlags -> IO (DynFlags, [PackageId])
163 initPackages dflags = do 
164   pkg_db <- case pkgDatabase dflags of
165                 Nothing -> readPackageConfigs dflags
166                 Just db -> return db
167   (pkg_state, preload, this_pkg)       
168         <- mkPackageState dflags pkg_db [] (thisPackage dflags)
169   return (dflags{ pkgDatabase = Just pkg_db,
170                   pkgState = pkg_state,
171                   thisPackage = this_pkg },
172           preload)
173
174 -- -----------------------------------------------------------------------------
175 -- Reading the package database(s)
176
177 readPackageConfigs :: DynFlags -> IO PackageConfigMap
178 readPackageConfigs dflags = do
179    e_pkg_path <- tryIO (getEnv "GHC_PACKAGE_PATH")
180    system_pkgconfs <- getSystemPackageConfigs dflags
181
182    let pkgconfs = case e_pkg_path of
183                     Left _   -> system_pkgconfs
184                     Right path
185                      | last cs == "" -> init cs ++ system_pkgconfs
186                      | otherwise     -> cs
187                      where cs = parseSearchPath path
188                      -- if the path ends in a separator (eg. "/foo/bar:")
189                      -- the we tack on the system paths.
190
191         -- Read all the ones mentioned in -package-conf flags
192    pkg_map <- foldM (readPackageConfig dflags) emptyPackageConfigMap
193                  (reverse pkgconfs ++ extraPkgConfs dflags)
194
195    return pkg_map
196
197
198 getSystemPackageConfigs :: DynFlags -> IO [FilePath]
199 getSystemPackageConfigs dflags = do
200         -- System one always comes first
201    let system_pkgconf = systemPackageConfig dflags
202
203         -- allow package.conf.d to contain a bunch of .conf files
204         -- containing package specifications.  This is an easier way
205         -- to maintain the package database on systems with a package
206         -- management system, or systems that don't want to run ghc-pkg
207         -- to register or unregister packages.  Undocumented feature for now.
208    let system_pkgconf_dir = system_pkgconf <.> "d"
209    system_pkgconf_dir_exists <- doesDirectoryExist system_pkgconf_dir
210    system_pkgconfs <-
211      if system_pkgconf_dir_exists
212        then do files <- getDirectoryContents system_pkgconf_dir
213                return [ system_pkgconf_dir </> file
214                       | file <- files
215                       , takeExtension file == ".conf" ]
216        else return []
217
218         -- Read user's package conf (eg. ~/.ghc/i386-linux-6.3/package.conf)
219         -- unless the -no-user-package-conf flag was given.
220         -- We only do this when getAppUserDataDirectory is available 
221         -- (GHC >= 6.3).
222    user_pkgconf <- do
223       appdir <- getAppUserDataDirectory "ghc"
224       let 
225          pkgconf = appdir
226                    </> (TARGET_ARCH ++ '-':TARGET_OS ++ '-':cProjectVersion)
227                    </> "package.conf"
228       flg <- doesFileExist pkgconf
229       if (flg && dopt Opt_ReadUserPackageConf dflags)
230         then return [pkgconf]
231         else return []
232     `catchIO` (\_ -> return [])
233
234    return (user_pkgconf ++ system_pkgconfs ++ [system_pkgconf])
235
236
237 readPackageConfig
238    :: DynFlags -> PackageConfigMap -> FilePath -> IO PackageConfigMap
239 readPackageConfig dflags pkg_map conf_file = do
240   debugTraceMsg dflags 2 (text "Using package config file:" <+> text conf_file)
241   proto_pkg_configs <- loadPackageConfig dflags conf_file
242   let top_dir = topDir dflags
243       pkg_configs1 = mungePackagePaths top_dir proto_pkg_configs
244       pkg_configs2 = maybeHidePackages dflags pkg_configs1
245   return (extendPackageConfigMap pkg_map pkg_configs2)
246
247 maybeHidePackages :: DynFlags -> [PackageConfig] -> [PackageConfig]
248 maybeHidePackages dflags pkgs
249   | dopt Opt_HideAllPackages dflags = map hide pkgs
250   | otherwise                       = pkgs
251   where
252     hide pkg = pkg{ exposed = False }
253
254 mungePackagePaths :: String -> [PackageConfig] -> [PackageConfig]
255 -- Replace the string "$topdir" at the beginning of a path
256 -- with the current topdir (obtained from the -B option).
257 mungePackagePaths top_dir ps = map munge_pkg ps
258  where 
259   munge_pkg p = p{ importDirs  = munge_paths (importDirs p),
260                    includeDirs = munge_paths (includeDirs p),
261                    libraryDirs = munge_paths (libraryDirs p),
262                    frameworkDirs = munge_paths (frameworkDirs p),
263                    haddockInterfaces = munge_paths (haddockInterfaces p),
264                    haddockHTMLs = munge_paths (haddockHTMLs p)
265                     }
266
267   munge_paths = map munge_path
268
269   munge_path p 
270           | Just p' <- stripPrefix "$topdir"     p =            top_dir ++ p'
271           | Just p' <- stripPrefix "$httptopdir" p = toHttpPath top_dir ++ p'
272           | otherwise                               = p
273
274   toHttpPath p = "file:///" ++ p
275
276
277 -- -----------------------------------------------------------------------------
278 -- Modify our copy of the package database based on a package flag
279 -- (-package, -hide-package, -ignore-package).
280
281 applyPackageFlag
282    :: [PackageConfig]           -- Initial database
283    -> PackageFlag               -- flag to apply
284    -> IO [PackageConfig]        -- new database
285
286 applyPackageFlag pkgs flag = 
287   case flag of
288         ExposePackage str ->
289            case matchingPackages str pkgs of
290                 Nothing -> missingPackageErr str
291                 Just ([], _) -> panic "applyPackageFlag"
292                 Just (p:ps,qs) -> return (p':ps')
293                   where p' = p {exposed=True}
294                         ps' = hideAll (pkgName (sourcePackageId p)) (ps++qs)
295
296         HidePackage str ->
297            case matchingPackages str pkgs of
298                 Nothing -> missingPackageErr str
299                 Just (ps,qs) -> return (map hide ps ++ qs)
300                   where hide p = p {exposed=False}
301
302         IgnorePackage str ->
303            case matchingPackages str pkgs of
304                 Nothing -> return pkgs
305                 Just (_, qs) -> return qs
306                 -- missing package is not an error for -ignore-package,
307                 -- because a common usage is to -ignore-package P as
308                 -- a preventative measure just in case P exists.
309    where
310         -- When a package is requested to be exposed, we hide all other
311         -- packages with the same name.
312         hideAll name ps = map maybe_hide ps
313           where maybe_hide p
314                    | pkgName (sourcePackageId p) == name = p {exposed=False}
315                    | otherwise                           = p
316
317
318 matchingPackages :: String -> [PackageConfig]
319          -> Maybe ([PackageConfig], [PackageConfig])
320 matchingPackages str pkgs
321   = case partition (packageMatches str) pkgs of
322         ([],_)    -> Nothing
323         (ps,rest) -> Just (sortByVersion ps, rest)
324
325 -- A package named on the command line can either include the
326 -- version, or just the name if it is unambiguous.
327 packageMatches :: String -> PackageConfig -> Bool
328 packageMatches str p
329         =  str == display (sourcePackageId p)
330         || str == display (pkgName (sourcePackageId p))
331
332 pickPackages :: [PackageConfig] -> [String] -> [PackageConfig]
333 pickPackages pkgs strs = 
334   [ p | p <- strs, Just (p:_, _) <- [matchingPackages p pkgs] ]
335
336 sortByVersion :: [InstalledPackageInfo_ m] -> [InstalledPackageInfo_ m]
337 sortByVersion = sortBy (flip (comparing (pkgVersion.sourcePackageId)))
338
339 comparing :: Ord a => (t -> a) -> t -> t -> Ordering
340 comparing f a b = f a `compare` f b
341
342 -- -----------------------------------------------------------------------------
343 -- Hide old versions of packages
344
345 --
346 -- hide all packages for which there is also a later version
347 -- that is already exposed.  This just makes it non-fatal to have two
348 -- versions of a package exposed, which can happen if you install a
349 -- later version of a package in the user database, for example.
350 --
351 hideOldPackages :: DynFlags -> [PackageConfig] -> IO [PackageConfig]
352 hideOldPackages dflags pkgs = mapM maybe_hide pkgs
353   where maybe_hide p
354            | not (exposed p) = return p
355            | (p' : _) <- later_versions = do
356                 debugTraceMsg dflags 2 $
357                    (ptext (sLit "hiding package") <+> 
358                     text (display (sourcePackageId p)) <+>
359                     ptext (sLit "to avoid conflict with later version") <+>
360                     text (display (sourcePackageId p')))
361                 return (p {exposed=False})
362            | otherwise = return p
363           where myname = pkgName (sourcePackageId p)
364                 myversion = pkgVersion (sourcePackageId p)
365                 later_versions = [ p | p <- pkgs, exposed p,
366                                     let pkg = sourcePackageId p,
367                                     pkgName pkg == myname,
368                                     pkgVersion pkg > myversion ]
369
370 -- -----------------------------------------------------------------------------
371 -- Wired-in packages
372
373 findWiredInPackages
374    :: DynFlags
375    -> [PackageConfig]           -- database
376    -> IO [PackageConfig]
377
378 findWiredInPackages dflags pkgs = do
379   --
380   -- Now we must find our wired-in packages, and rename them to
381   -- their canonical names (eg. base-1.0 ==> base).
382   --
383   let
384         wired_in_pkgids :: [String]
385         wired_in_pkgids = map packageIdString
386                           [ primPackageId,
387                             integerPackageId,
388                             basePackageId,
389                             rtsPackageId,
390                             haskell98PackageId,
391                             thPackageId,
392                             dphSeqPackageId,
393                             dphParPackageId ]
394
395         matches :: PackageConfig -> String -> Bool
396         pc `matches` pid = display (pkgName (sourcePackageId pc)) == pid
397
398         -- find which package corresponds to each wired-in package
399         -- delete any other packages with the same name
400         -- update the package and any dependencies to point to the new
401         -- one.
402         --
403         -- When choosing which package to map to a wired-in package
404         -- name, we prefer exposed packages, and pick the latest
405         -- version.  To override the default choice, -hide-package
406         -- could be used to hide newer versions.
407         --
408         findWiredInPackage :: [PackageConfig] -> String
409                            -> IO (Maybe InstalledPackageId)
410         findWiredInPackage pkgs wired_pkg =
411            let all_ps = [ p | p <- pkgs, p `matches` wired_pkg ] in
412            case all_ps of
413                 []   -> notfound
414                 many -> pick (head (sortByVersion many))
415           where
416                 notfound = do
417                           debugTraceMsg dflags 2 $
418                             ptext (sLit "wired-in package ")
419                                  <> text wired_pkg
420                                  <> ptext (sLit " not found.")
421                           return Nothing
422                 pick :: InstalledPackageInfo_ ModuleName
423                      -> IO (Maybe InstalledPackageId)
424                 pick pkg = do
425                         debugTraceMsg dflags 2 $
426                             ptext (sLit "wired-in package ")
427                                  <> text wired_pkg
428                                  <> ptext (sLit " mapped to ")
429                                  <> text (display (sourcePackageId pkg))
430                         return (Just (installedPackageId pkg))
431
432
433   mb_wired_in_ids <- mapM (findWiredInPackage pkgs) wired_in_pkgids
434   let 
435         wired_in_ids = catMaybes mb_wired_in_ids
436
437         -- this is old: we used to assume that if there were
438         -- multiple versions of wired-in packages installed that
439         -- they were mutually exclusive.  Now we're assuming that
440         -- you have one "main" version of each wired-in package
441         -- (the latest version), and the others are backward-compat
442         -- wrappers that depend on this one.  e.g. base-4.0 is the
443         -- latest, base-3.0 is a compat wrapper depending on base-4.0.
444         {-
445         deleteOtherWiredInPackages pkgs = filterOut bad pkgs
446           where bad p = any (p `matches`) wired_in_pkgids
447                       && package p `notElem` map fst wired_in_ids
448         -}
449
450         updateWiredInDependencies pkgs = map upd_pkg pkgs
451           where upd_pkg p
452                   | installedPackageId p `elem` wired_in_ids
453                   = p { sourcePackageId = (sourcePackageId p){ pkgVersion = Version [] [] } }
454                   | otherwise
455                   = p
456
457   return $ updateWiredInDependencies pkgs
458
459 -- ----------------------------------------------------------------------------
460 --
461 -- Detect any packages that have missing dependencies, and also any
462 -- mutually-recursive groups of packages (loops in the package graph
463 -- are not allowed).  We do this by taking the least fixpoint of the
464 -- dependency graph, repeatedly adding packages whose dependencies are
465 -- satisfied until no more can be added.
466 --
467 elimDanglingDeps
468    :: DynFlags
469    -> [PackageConfig]
470    -> [PackageId]       -- ignored packages
471    -> IO [PackageConfig]
472
473 elimDanglingDeps dflags pkgs ignored = go [] pkgs'
474  where
475    pkgs' = filter (\p -> packageConfigId p `notElem` ignored) pkgs
476
477    go avail not_avail =
478      case partitionWith (depsAvailable avail) not_avail of
479         ([],        not_avail) -> do mapM_ reportElim not_avail; return avail
480         (new_avail, not_avail) -> go (new_avail ++ avail) (map fst not_avail)
481
482    depsAvailable :: [PackageConfig] -> PackageConfig
483                  -> Either PackageConfig (PackageConfig, [InstalledPackageId])
484    depsAvailable pkgs_ok pkg 
485         | null dangling = Left pkg
486         | otherwise     = Right (pkg, dangling)
487         where dangling = filter (`notElem` pids) (depends pkg)
488               pids = map installedPackageId pkgs_ok
489
490    reportElim (p, deps) = 
491         debugTraceMsg dflags 2 $
492              (ptext (sLit "package") <+> pprPkg p <+> 
493                   ptext (sLit "will be ignored due to missing or recursive dependencies:") $$ 
494               nest 2 (hsep (map (text.display) deps)))
495
496 -- -----------------------------------------------------------------------------
497 -- When all the command-line options are in, we can process our package
498 -- settings and populate the package state.
499
500 mkPackageState
501     :: DynFlags
502     -> PackageConfigMap         -- initial database
503     -> [PackageId]              -- preloaded packages
504     -> PackageId                -- this package
505     -> IO (PackageState,
506            [PackageId],         -- new packages to preload
507            PackageId) -- this package, might be modified if the current
508
509                       -- package is a wired-in package.
510
511 mkPackageState dflags orig_pkg_db preload0 this_package = do
512   --
513   -- Modify the package database according to the command-line flags
514   -- (-package, -hide-package, -ignore-package, -hide-all-packages).
515   --
516   let flags = reverse (packageFlags dflags)
517   let pkgs0 = eltsUFM orig_pkg_db
518   pkgs1 <- foldM applyPackageFlag pkgs0 flags
519
520   -- Here we build up a set of the packages mentioned in -package
521   -- flags on the command line; these are called the "preload"
522   -- packages.  we link these packages in eagerly.  The preload set
523   -- should contain at least rts & base, which is why we pretend that
524   -- the command line contains -package rts & -package base.
525   --
526   let preload1 = map installedPackageId $ 
527                  pickPackages pkgs0 [ p | ExposePackage p <- flags ]
528
529   -- hide packages that are subsumed by later versions
530   pkgs2 <- hideOldPackages dflags pkgs1
531
532   -- sort out which packages are wired in
533   pkgs3 <- findWiredInPackages dflags pkgs2
534
535   let ignored = map packageConfigId $
536                    pickPackages pkgs0 [ p | IgnorePackage p <- flags ]
537   pkgs <- elimDanglingDeps dflags pkgs3 ignored
538
539   let pkg_db = extendPackageConfigMap emptyPackageConfigMap pkgs
540
541       ipid_map = listToFM [ (installedPackageId p, packageConfigId p)
542                           | p <- pkgs ]
543
544       lookupIPID ipid@(InstalledPackageId str)
545          | Just pid <- lookupFM ipid_map ipid = return pid
546          | otherwise                          = missingPackageErr str
547
548   preload2 <- mapM lookupIPID preload1
549
550   let
551       -- add base & rts to the preload packages
552       basicLinkedPackages
553        | dopt Opt_AutoLinkPackages dflags
554           = filter (flip elemUFM pkg_db) [basePackageId, rtsPackageId]
555        | otherwise = []
556       -- but in any case remove the current package from the set of
557       -- preloaded packages so that base/rts does not end up in the
558       -- set up preloaded package when we are just building it
559       preload3 = nub $ filter (/= this_package)
560                      $ (basicLinkedPackages ++ preload2)
561
562   -- Close the preload packages with their dependencies
563   dep_preload <- closeDeps pkg_db ipid_map (zip preload3 (repeat Nothing))
564   let new_dep_preload = filter (`notElem` preload0) dep_preload
565
566   let pstate = PackageState{ preloadPackages     = dep_preload,
567                              pkgIdMap            = pkg_db,
568                              moduleToPkgConfAll  = mkModuleMap pkg_db,
569                              installedPackageIdMap = ipid_map
570                            }
571
572   return (pstate, new_dep_preload, this_package)
573
574
575 -- -----------------------------------------------------------------------------
576 -- Make the mapping from module to package info
577
578 mkModuleMap
579   :: PackageConfigMap
580   -> UniqFM [(PackageConfig, Bool)]
581 mkModuleMap pkg_db = foldr extend_modmap emptyUFM pkgids
582   where
583         pkgids = map packageConfigId (eltsUFM pkg_db)
584         
585         extend_modmap pkgid modmap =
586                 addListToUFM_C (++) modmap 
587                    ([(m, [(pkg, True)])  | m <- exposed_mods] ++
588                     [(m, [(pkg, False)]) | m <- hidden_mods])
589           where
590                 pkg = expectJust "mkModuleMap" (lookupPackage pkg_db pkgid)
591                 exposed_mods = exposedModules pkg
592                 hidden_mods  = hiddenModules pkg
593
594 pprPkg :: PackageConfig -> SDoc
595 pprPkg p = text (display (sourcePackageId p))
596
597 -- -----------------------------------------------------------------------------
598 -- Extracting information from the packages in scope
599
600 -- Many of these functions take a list of packages: in those cases,
601 -- the list is expected to contain the "dependent packages",
602 -- i.e. those packages that were found to be depended on by the
603 -- current module/program.  These can be auto or non-auto packages, it
604 -- doesn't really matter.  The list is always combined with the list
605 -- of preload (command-line) packages to determine which packages to
606 -- use.
607
608 -- | Find all the include directories in these and the preload packages
609 getPackageIncludePath :: DynFlags -> [PackageId] -> IO [String]
610 getPackageIncludePath dflags pkgs =
611   collectIncludeDirs `fmap` getPreloadPackagesAnd dflags pkgs
612
613 collectIncludeDirs :: [PackageConfig] -> [FilePath] 
614 collectIncludeDirs ps = nub (filter notNull (concatMap includeDirs ps))
615
616 -- | Find all the library paths in these and the preload packages
617 getPackageLibraryPath :: DynFlags -> [PackageId] -> IO [String]
618 getPackageLibraryPath dflags pkgs =
619   collectLibraryPaths `fmap` getPreloadPackagesAnd dflags pkgs
620
621 collectLibraryPaths :: [PackageConfig] -> [FilePath]
622 collectLibraryPaths ps = nub (filter notNull (concatMap libraryDirs ps))
623
624 -- | Find all the link options in these and the preload packages
625 getPackageLinkOpts :: DynFlags -> [PackageId] -> IO [String]
626 getPackageLinkOpts dflags pkgs = 
627   collectLinkOpts dflags `fmap` getPreloadPackagesAnd dflags pkgs
628
629 collectLinkOpts :: DynFlags -> [PackageConfig] -> [String]
630 collectLinkOpts dflags ps = concat (map all_opts ps)
631   where
632         libs p     = packageHsLibs dflags p ++ extraLibraries p
633         all_opts p = map ("-l" ++) (libs p) ++ ldOptions p
634
635 packageHsLibs :: DynFlags -> PackageConfig -> [String]
636 packageHsLibs dflags p = map (mkDynName . addSuffix) (hsLibraries p)
637   where
638         non_dyn_ways = filter ((/= WayDyn) . wayName) (ways dflags)
639         -- the name of a shared library is libHSfoo-ghc<version>.so
640         -- we leave out the _dyn, because it is superfluous
641
642         tag     = mkBuildTag (filter (not . wayRTSOnly) non_dyn_ways)
643         rts_tag = mkBuildTag non_dyn_ways
644
645         mkDynName | opt_Static = id
646                   | otherwise = (++ ("-ghc" ++ cProjectVersion))
647
648         addSuffix rts@"HSrts"    = rts       ++ (expandTag rts_tag)
649         addSuffix other_lib      = other_lib ++ (expandTag tag)
650
651         expandTag t | null t = ""
652                     | otherwise = '_':t
653
654 -- | Find all the C-compiler options in these and the preload packages
655 getPackageExtraCcOpts :: DynFlags -> [PackageId] -> IO [String]
656 getPackageExtraCcOpts dflags pkgs = do
657   ps <- getPreloadPackagesAnd dflags pkgs
658   return (concatMap ccOptions ps)
659
660 -- | Find all the package framework paths in these and the preload packages
661 getPackageFrameworkPath  :: DynFlags -> [PackageId] -> IO [String]
662 getPackageFrameworkPath dflags pkgs = do
663   ps <- getPreloadPackagesAnd dflags pkgs
664   return (nub (filter notNull (concatMap frameworkDirs ps)))
665
666 -- | Find all the package frameworks in these and the preload packages
667 getPackageFrameworks  :: DynFlags -> [PackageId] -> IO [String]
668 getPackageFrameworks dflags pkgs = do
669   ps <- getPreloadPackagesAnd dflags pkgs
670   return (concatMap frameworks ps)
671
672 -- -----------------------------------------------------------------------------
673 -- Package Utils
674
675 -- | Takes a 'Module', and if the module is in a package returns 
676 -- @(pkgconf, exposed)@ where pkgconf is the PackageConfig for that package,
677 -- and exposed is @True@ if the package exposes the module.
678 lookupModuleInAllPackages :: DynFlags -> ModuleName -> [(PackageConfig,Bool)]
679 lookupModuleInAllPackages dflags m =
680   case lookupUFM (moduleToPkgConfAll (pkgState dflags)) m of
681         Nothing -> []
682         Just ps -> ps
683
684 -- | Find all the 'PackageConfig' in both the preload packages from 'DynFlags' and corresponding to the list of
685 -- 'PackageConfig's
686 getPreloadPackagesAnd :: DynFlags -> [PackageId] -> IO [PackageConfig]
687 getPreloadPackagesAnd dflags pkgids =
688   let 
689       state   = pkgState dflags
690       pkg_map = pkgIdMap state
691       ipid_map = installedPackageIdMap state
692       preload = preloadPackages state
693       pairs = zip pkgids (repeat Nothing)
694   in do
695   all_pkgs <- throwErr (foldM (add_package pkg_map ipid_map) preload pairs)
696   return (map (getPackageDetails state) all_pkgs)
697
698 -- Takes a list of packages, and returns the list with dependencies included,
699 -- in reverse dependency order (a package appears before those it depends on).
700 closeDeps :: PackageConfigMap
701           -> FiniteMap InstalledPackageId PackageId
702           -> [(PackageId, Maybe PackageId)]
703           -> IO [PackageId]
704 closeDeps pkg_map ipid_map ps = throwErr (closeDepsErr pkg_map ipid_map ps)
705
706 throwErr :: MaybeErr Message a -> IO a
707 throwErr m = case m of
708                 Failed e    -> ghcError (CmdLineError (showSDoc e))
709                 Succeeded r -> return r
710
711 closeDepsErr :: PackageConfigMap
712              -> FiniteMap InstalledPackageId PackageId
713              -> [(PackageId,Maybe PackageId)]
714              -> MaybeErr Message [PackageId]
715 closeDepsErr pkg_map ipid_map ps = foldM (add_package pkg_map ipid_map) [] ps
716
717 -- internal helper
718 add_package :: PackageConfigMap 
719             -> FiniteMap InstalledPackageId PackageId
720             -> [PackageId]
721             -> (PackageId,Maybe PackageId)
722             -> MaybeErr Message [PackageId]
723 add_package pkg_db ipid_map ps (p, mb_parent)
724   | p `elem` ps = return ps     -- Check if we've already added this package
725   | otherwise =
726       case lookupPackage pkg_db p of
727         Nothing -> Failed (missingPackageMsg (packageIdString p) <> 
728                            missingDependencyMsg mb_parent)
729         Just pkg -> do
730            -- Add the package's dependents also
731            ps' <- foldM add_package_ipid ps (depends pkg)
732            return (p : ps')
733           where
734             add_package_ipid ps ipid@(InstalledPackageId str)
735               | Just pid <- lookupFM ipid_map ipid
736               = add_package pkg_db ipid_map ps (pid, Just p)
737               | otherwise
738               = Failed (missingPackageMsg str <> missingDependencyMsg mb_parent)
739
740 missingPackageErr :: String -> IO a
741 missingPackageErr p = ghcError (CmdLineError (showSDoc (missingPackageMsg p)))
742
743 missingPackageMsg :: String -> SDoc
744 missingPackageMsg p = ptext (sLit "unknown package:") <+> text p
745
746 missingDependencyMsg :: Maybe PackageId -> SDoc
747 missingDependencyMsg Nothing = empty
748 missingDependencyMsg (Just parent)
749   = space <> parens (ptext (sLit "dependency of") <+> ftext (packageIdFS parent))
750
751 -- -----------------------------------------------------------------------------
752
753 -- | Will the 'Name' come from a dynamically linked library?
754 isDllName :: PackageId -> Name -> Bool
755 isDllName this_pkg name
756   | opt_Static = False
757   | Just mod <- nameModule_maybe name = modulePackageId mod /= this_pkg
758   | otherwise = False  -- no, it is not even an external name
759
760 -- -----------------------------------------------------------------------------
761 -- Displaying packages
762
763 -- | Show package info on console, if verbosity is >= 3
764 dumpPackages :: DynFlags -> IO ()
765 dumpPackages dflags
766   = do  let pkg_map = pkgIdMap (pkgState dflags)
767         putMsg dflags $
768               vcat (map (text . showInstalledPackageInfo
769                               . packageConfigToInstalledPackageInfo)
770                         (eltsUFM pkg_map))
771 \end{code}