Add LANGUAGE pragmas to compiler/ source files
[ghc.git] / compiler / main / Finder.lhs
1 %
2 % (c) The University of Glasgow, 2000-2006
3 %
4 \section[Finder]{Module Finder}
5
6 \begin{code}
7 {-# LANGUAGE CPP #-}
8
9 module Finder (
10     flushFinderCaches,
11     FindResult(..),
12     findImportedModule,
13     findExactModule,
14     findHomeModule,
15     findExposedPackageModule,
16     mkHomeModLocation,
17     mkHomeModLocation2,
18     mkHiOnlyModLocation,
19     addHomeModuleToFinder,
20     uncacheModule,
21     mkStubPaths,
22
23     findObjectLinkableMaybe,
24     findObjectLinkable,
25
26     cannotFindModule,
27     cannotFindInterface,
28
29   ) where
30
31 #include "HsVersions.h"
32
33 import Module
34 import HscTypes
35 import Packages
36 import FastString
37 import Util
38 import PrelNames        ( gHC_PRIM )
39 import DynFlags
40 import Outputable
41 import UniqFM
42 import Maybes           ( expectJust )
43 import Exception        ( evaluate )
44
45 import Distribution.Text
46 import Distribution.Package hiding (PackageId)
47 import Data.IORef       ( IORef, writeIORef, readIORef, atomicModifyIORef )
48 import System.Directory
49 import System.FilePath
50 import Control.Monad
51 import Data.List        ( partition )
52 import Data.Time
53
54
55 type FileExt = String   -- Filename extension
56 type BaseName = String  -- Basename of file
57
58 -- -----------------------------------------------------------------------------
59 -- The Finder
60
61 -- The Finder provides a thin filesystem abstraction to the rest of
62 -- the compiler.  For a given module, it can tell you where the
63 -- source, interface, and object files for that module live.
64
65 -- It does *not* know which particular package a module lives in.  Use
66 -- Packages.lookupModuleInAllPackages for that.
67
68 -- -----------------------------------------------------------------------------
69 -- The finder's cache
70
71 -- remove all the home modules from the cache; package modules are
72 -- assumed to not move around during a session.
73 flushFinderCaches :: HscEnv -> IO ()
74 flushFinderCaches hsc_env = do
75   -- Ideally the update to both caches be a single atomic operation.
76   writeIORef fc_ref emptyUFM
77   flushModLocationCache this_pkg mlc_ref
78  where
79         this_pkg = thisPackage (hsc_dflags hsc_env)
80         fc_ref = hsc_FC hsc_env
81         mlc_ref = hsc_MLC hsc_env
82
83 flushModLocationCache :: PackageId -> IORef ModLocationCache -> IO ()
84 flushModLocationCache this_pkg ref = do
85   atomicModifyIORef ref $ \fm -> (filterModuleEnv is_ext fm, ())
86   _ <- evaluate =<< readIORef ref
87   return ()
88   where is_ext mod _ | modulePackageId mod /= this_pkg = True
89                      | otherwise = False
90
91 addToFinderCache :: IORef FinderCache -> ModuleName -> FindResult -> IO ()
92 addToFinderCache ref key val =
93   atomicModifyIORef ref $ \c -> (addToUFM c key val, ())
94
95 addToModLocationCache :: IORef ModLocationCache -> Module -> ModLocation -> IO ()
96 addToModLocationCache ref key val =
97   atomicModifyIORef ref $ \c -> (extendModuleEnv c key val, ())
98
99 removeFromFinderCache :: IORef FinderCache -> ModuleName -> IO ()
100 removeFromFinderCache ref key =
101   atomicModifyIORef ref $ \c -> (delFromUFM c key, ())
102
103 removeFromModLocationCache :: IORef ModLocationCache -> Module -> IO ()
104 removeFromModLocationCache ref key =
105   atomicModifyIORef ref $ \c -> (delModuleEnv c key, ())
106
107 lookupFinderCache :: IORef FinderCache -> ModuleName -> IO (Maybe FindResult)
108 lookupFinderCache ref key = do
109    c <- readIORef ref
110    return $! lookupUFM c key
111
112 lookupModLocationCache :: IORef ModLocationCache -> Module
113                        -> IO (Maybe ModLocation)
114 lookupModLocationCache ref key = do
115    c <- readIORef ref
116    return $! lookupModuleEnv c key
117
118 -- -----------------------------------------------------------------------------
119 -- The two external entry points
120
121 -- | Locate a module that was imported by the user.  We have the
122 -- module's name, and possibly a package name.  Without a package
123 -- name, this function will use the search path and the known exposed
124 -- packages to find the module, if a package is specified then only
125 -- that package is searched for the module.
126
127 findImportedModule :: HscEnv -> ModuleName -> Maybe FastString -> IO FindResult
128 findImportedModule hsc_env mod_name mb_pkg =
129   case mb_pkg of
130         Nothing                        -> unqual_import
131         Just pkg | pkg == fsLit "this" -> home_import -- "this" is special
132                  | otherwise           -> pkg_import
133   where
134     home_import   = findHomeModule hsc_env mod_name
135
136     pkg_import    = findExposedPackageModule hsc_env mod_name mb_pkg
137
138     unqual_import = home_import
139                     `orIfNotFound`
140                     findExposedPackageModule hsc_env mod_name Nothing
141
142 -- | Locate a specific 'Module'.  The purpose of this function is to
143 -- create a 'ModLocation' for a given 'Module', that is to find out
144 -- where the files associated with this module live.  It is used when
145 -- reading the interface for a module mentioned by another interface,
146 -- for example (a "system import").
147
148 findExactModule :: HscEnv -> Module -> IO FindResult
149 findExactModule hsc_env mod =
150     let dflags = hsc_dflags hsc_env
151     in if modulePackageId mod == thisPackage dflags
152        then findHomeModule hsc_env (moduleName mod)
153        else findPackageModule hsc_env mod
154
155 -- -----------------------------------------------------------------------------
156 -- Helpers
157
158 orIfNotFound :: IO FindResult -> IO FindResult -> IO FindResult
159 orIfNotFound this or_this = do
160   res <- this
161   case res of
162     NotFound { fr_paths = paths1, fr_mods_hidden = mh1
163              , fr_pkgs_hidden = ph1, fr_suggestions = s1 }
164      -> do res2 <- or_this
165            case res2 of
166              NotFound { fr_paths = paths2, fr_pkg = mb_pkg2, fr_mods_hidden = mh2
167                       , fr_pkgs_hidden = ph2, fr_suggestions = s2 }
168               -> return (NotFound { fr_paths = paths1 ++ paths2
169                                   , fr_pkg = mb_pkg2 -- snd arg is the package search
170                                   , fr_mods_hidden = mh1 ++ mh2
171                                   , fr_pkgs_hidden = ph1 ++ ph2
172                                   , fr_suggestions = s1  ++ s2 })
173              _other -> return res2
174     _other -> return res
175
176
177 homeSearchCache :: HscEnv -> ModuleName -> IO FindResult -> IO FindResult
178 homeSearchCache hsc_env mod_name do_this = do
179   m <- lookupFinderCache (hsc_FC hsc_env) mod_name
180   case m of
181     Just result -> return result
182     Nothing     -> do
183         result <- do_this
184         addToFinderCache (hsc_FC hsc_env) mod_name result
185         case result of
186            Found loc mod -> addToModLocationCache (hsc_MLC hsc_env) mod loc
187            _other        -> return ()
188         return result
189
190 findExposedPackageModule :: HscEnv -> ModuleName -> Maybe FastString
191                          -> IO FindResult
192 findExposedPackageModule hsc_env mod_name mb_pkg
193         -- not found in any package:
194   = case lookupModuleWithSuggestions (hsc_dflags hsc_env) mod_name of
195        Left suggest -> return (NotFound { fr_paths = [], fr_pkg = Nothing
196                                         , fr_pkgs_hidden = []
197                                         , fr_mods_hidden = []
198                                         , fr_suggestions = suggest })
199        Right found
200          | null found_exposed   -- Found, but with no exposed copies
201           -> return (NotFound { fr_paths = [], fr_pkg = Nothing
202                               , fr_pkgs_hidden = pkg_hiddens
203                               , fr_mods_hidden = mod_hiddens
204                               , fr_suggestions = [] })
205
206          | [(pkg_conf,_)] <- found_exposed     -- Found uniquely
207          -> let pkgid = packageConfigId pkg_conf in
208             findPackageModule_ hsc_env (mkModule pkgid mod_name) pkg_conf
209
210          | otherwise           -- Found in more than one place
211          -> return (FoundMultiple (map (packageConfigId.fst) found_exposed))
212          where
213            for_this_pkg  = case mb_pkg of
214                              Nothing -> found
215                              Just p  -> filter ((`matches` p) . fst) found
216            found_exposed = filter is_exposed for_this_pkg
217            is_exposed (pkg_conf,exposed_mod) = exposed pkg_conf && exposed_mod
218
219            mod_hiddens = [ packageConfigId pkg_conf
220                          | (pkg_conf,False) <- found ]
221
222            pkg_hiddens = [ packageConfigId pkg_conf
223                          | (pkg_conf,_) <- found, not (exposed pkg_conf) ]
224
225            pkg_conf  `matches` pkg
226               = case packageName pkg_conf of
227                   PackageName n -> pkg == mkFastString n
228
229 modLocationCache :: HscEnv -> Module -> IO FindResult -> IO FindResult
230 modLocationCache hsc_env mod do_this = do
231   mb_loc <- lookupModLocationCache mlc mod
232   case mb_loc of
233      Just loc -> return (Found loc mod)
234      Nothing  -> do
235         result <- do_this
236         case result of
237             Found loc mod -> addToModLocationCache (hsc_MLC hsc_env) mod loc
238             _other -> return ()
239         return result
240   where
241     mlc = hsc_MLC hsc_env
242
243 addHomeModuleToFinder :: HscEnv -> ModuleName -> ModLocation -> IO Module
244 addHomeModuleToFinder hsc_env mod_name loc = do
245   let mod = mkModule (thisPackage (hsc_dflags hsc_env)) mod_name
246   addToFinderCache (hsc_FC hsc_env) mod_name (Found loc mod)
247   addToModLocationCache (hsc_MLC hsc_env) mod loc
248   return mod
249
250 uncacheModule :: HscEnv -> ModuleName -> IO ()
251 uncacheModule hsc_env mod = do
252   let this_pkg = thisPackage (hsc_dflags hsc_env)
253   removeFromFinderCache (hsc_FC hsc_env) mod
254   removeFromModLocationCache (hsc_MLC hsc_env) (mkModule this_pkg mod)
255
256 -- -----------------------------------------------------------------------------
257 --      The internal workers
258
259 -- | Search for a module in the home package only.
260 findHomeModule :: HscEnv -> ModuleName -> IO FindResult
261 findHomeModule hsc_env mod_name =
262    homeSearchCache hsc_env mod_name $
263    let 
264      dflags = hsc_dflags hsc_env
265      home_path = importPaths dflags
266      hisuf = hiSuf dflags
267      mod = mkModule (thisPackage dflags) mod_name
268
269      source_exts =
270       [ ("hs",   mkHomeModLocationSearched dflags mod_name "hs")
271       , ("lhs",  mkHomeModLocationSearched dflags mod_name "lhs")
272       ]
273
274      hi_exts = [ (hisuf,                mkHiOnlyModLocation dflags hisuf)
275                , (addBootSuffix hisuf,  mkHiOnlyModLocation dflags hisuf)
276                ]
277
278         -- In compilation manager modes, we look for source files in the home
279         -- package because we can compile these automatically.  In one-shot
280         -- compilation mode we look for .hi and .hi-boot files only.
281      exts | isOneShot (ghcMode dflags) = hi_exts
282           | otherwise                  = source_exts
283    in
284
285   -- special case for GHC.Prim; we won't find it in the filesystem.
286   -- This is important only when compiling the base package (where GHC.Prim
287   -- is a home module).
288   if mod == gHC_PRIM
289         then return (Found (error "GHC.Prim ModLocation") mod)
290         else searchPathExts home_path mod exts
291
292
293 -- | Search for a module in external packages only.
294 findPackageModule :: HscEnv -> Module -> IO FindResult
295 findPackageModule hsc_env mod = do
296   let
297         dflags = hsc_dflags hsc_env
298         pkg_id = modulePackageId mod
299         pkg_map = pkgIdMap (pkgState dflags)
300   --
301   case lookupPackage pkg_map pkg_id of
302      Nothing -> return (NoPackage pkg_id)
303      Just pkg_conf -> findPackageModule_ hsc_env mod pkg_conf
304
305 findPackageModule_ :: HscEnv -> Module -> PackageConfig -> IO FindResult
306 findPackageModule_ hsc_env mod pkg_conf =
307   modLocationCache hsc_env mod $
308
309   -- special case for GHC.Prim; we won't find it in the filesystem.
310   if mod == gHC_PRIM
311         then return (Found (error "GHC.Prim ModLocation") mod)
312         else
313
314   let
315      dflags = hsc_dflags hsc_env
316      tag = buildTag dflags
317
318            -- hi-suffix for packages depends on the build tag.
319      package_hisuf | null tag  = "hi"
320                    | otherwise = tag ++ "_hi"
321
322      mk_hi_loc = mkHiOnlyModLocation dflags package_hisuf
323
324      import_dirs = importDirs pkg_conf
325       -- we never look for a .hi-boot file in an external package;
326       -- .hi-boot files only make sense for the home package.
327   in
328   case import_dirs of
329     [one] | MkDepend <- ghcMode dflags -> do
330           -- there's only one place that this .hi file can be, so
331           -- don't bother looking for it.
332           let basename = moduleNameSlashes (moduleName mod)
333           loc <- mk_hi_loc one basename
334           return (Found loc mod)
335     _otherwise ->
336           searchPathExts import_dirs mod [(package_hisuf, mk_hi_loc)]
337
338 -- -----------------------------------------------------------------------------
339 -- General path searching
340
341 searchPathExts
342   :: [FilePath]         -- paths to search
343   -> Module             -- module name
344   -> [ (
345         FileExt,                                -- suffix
346         FilePath -> BaseName -> IO ModLocation  -- action
347        )
348      ]
349   -> IO FindResult
350
351 searchPathExts paths mod exts
352    = do result <- search to_search
353 {-
354         hPutStrLn stderr (showSDoc $
355                 vcat [text "Search" <+> ppr mod <+> sep (map (text. fst) exts)
356                     , nest 2 (vcat (map text paths))
357                     , case result of
358                         Succeeded (loc, p) -> text "Found" <+> ppr loc
359                         Failed fs          -> text "not found"])
360 -}
361         return result
362
363   where
364     basename = moduleNameSlashes (moduleName mod)
365
366     to_search :: [(FilePath, IO ModLocation)]
367     to_search = [ (file, fn path basename)
368                 | path <- paths,
369                   (ext,fn) <- exts,
370                   let base | path == "." = basename
371                            | otherwise   = path </> basename
372                       file = base <.> ext
373                 ]
374
375     search [] = return (NotFound { fr_paths = map fst to_search
376                                  , fr_pkg   = Just (modulePackageId mod)
377                                  , fr_mods_hidden = [], fr_pkgs_hidden = []
378                                  , fr_suggestions = [] })
379
380     search ((file, mk_result) : rest) = do
381       b <- doesFileExist file
382       if b
383         then do { loc <- mk_result; return (Found loc mod) }
384         else search rest
385
386 mkHomeModLocationSearched :: DynFlags -> ModuleName -> FileExt
387                           -> FilePath -> BaseName -> IO ModLocation
388 mkHomeModLocationSearched dflags mod suff path basename = do
389    mkHomeModLocation2 dflags mod (path </> basename) suff
390
391 -- -----------------------------------------------------------------------------
392 -- Constructing a home module location
393
394 -- This is where we construct the ModLocation for a module in the home
395 -- package, for which we have a source file.  It is called from three
396 -- places:
397 --
398 --  (a) Here in the finder, when we are searching for a module to import,
399 --      using the search path (-i option).
400 --
401 --  (b) The compilation manager, when constructing the ModLocation for
402 --      a "root" module (a source file named explicitly on the command line
403 --      or in a :load command in GHCi).
404 --
405 --  (c) The driver in one-shot mode, when we need to construct a
406 --      ModLocation for a source file named on the command-line.
407 --
408 -- Parameters are:
409 --
410 -- mod
411 --      The name of the module
412 --
413 -- path
414 --      (a): The search path component where the source file was found.
415 --      (b) and (c): "."
416 --
417 -- src_basename
418 --      (a): (moduleNameSlashes mod)
419 --      (b) and (c): The filename of the source file, minus its extension
420 --
421 -- ext
422 --      The filename extension of the source file (usually "hs" or "lhs").
423
424 mkHomeModLocation :: DynFlags -> ModuleName -> FilePath -> IO ModLocation
425 mkHomeModLocation dflags mod src_filename = do
426    let (basename,extension) = splitExtension src_filename
427    mkHomeModLocation2 dflags mod basename extension
428
429 mkHomeModLocation2 :: DynFlags
430                    -> ModuleName
431                    -> FilePath  -- Of source module, without suffix
432                    -> String    -- Suffix
433                    -> IO ModLocation
434 mkHomeModLocation2 dflags mod src_basename ext = do
435    let mod_basename = moduleNameSlashes mod
436
437    obj_fn  <- mkObjPath  dflags src_basename mod_basename
438    hi_fn   <- mkHiPath   dflags src_basename mod_basename
439
440    return (ModLocation{ ml_hs_file   = Just (src_basename <.> ext),
441                         ml_hi_file   = hi_fn,
442                         ml_obj_file  = obj_fn })
443
444 mkHiOnlyModLocation :: DynFlags -> Suffix -> FilePath -> String
445                     -> IO ModLocation
446 mkHiOnlyModLocation dflags hisuf path basename
447  = do let full_basename = path </> basename
448       obj_fn  <- mkObjPath  dflags full_basename basename
449       return ModLocation{    ml_hs_file   = Nothing,
450                              ml_hi_file   = full_basename <.> hisuf,
451                                 -- Remove the .hi-boot suffix from
452                                 -- hi_file, if it had one.  We always
453                                 -- want the name of the real .hi file
454                                 -- in the ml_hi_file field.
455                              ml_obj_file  = obj_fn
456                   }
457
458 -- | Constructs the filename of a .o file for a given source file.
459 -- Does /not/ check whether the .o file exists
460 mkObjPath
461   :: DynFlags
462   -> FilePath           -- the filename of the source file, minus the extension
463   -> String             -- the module name with dots replaced by slashes
464   -> IO FilePath
465 mkObjPath dflags basename mod_basename
466   = do  let
467                 odir = objectDir dflags
468                 osuf = objectSuf dflags
469
470                 obj_basename | Just dir <- odir = dir </> mod_basename
471                              | otherwise        = basename
472
473         return (obj_basename <.> osuf)
474
475 -- | Constructs the filename of a .hi file for a given source file.
476 -- Does /not/ check whether the .hi file exists
477 mkHiPath
478   :: DynFlags
479   -> FilePath           -- the filename of the source file, minus the extension
480   -> String             -- the module name with dots replaced by slashes
481   -> IO FilePath
482 mkHiPath dflags basename mod_basename
483   = do  let
484                 hidir = hiDir dflags
485                 hisuf = hiSuf dflags
486
487                 hi_basename | Just dir <- hidir = dir </> mod_basename
488                             | otherwise         = basename
489
490         return (hi_basename <.> hisuf)
491
492
493 -- -----------------------------------------------------------------------------
494 -- Filenames of the stub files
495
496 -- We don't have to store these in ModLocations, because they can be derived
497 -- from other available information, and they're only rarely needed.
498
499 mkStubPaths
500   :: DynFlags
501   -> ModuleName
502   -> ModLocation
503   -> FilePath
504
505 mkStubPaths dflags mod location
506   = let
507         stubdir = stubDir dflags
508
509         mod_basename = moduleNameSlashes mod
510         src_basename = dropExtension $ expectJust "mkStubPaths"
511                                                   (ml_hs_file location)
512
513         stub_basename0
514             | Just dir <- stubdir = dir </> mod_basename
515             | otherwise           = src_basename
516
517         stub_basename = stub_basename0 ++ "_stub"
518      in
519         stub_basename <.> "h"
520
521 -- -----------------------------------------------------------------------------
522 -- findLinkable isn't related to the other stuff in here,
523 -- but there's no other obvious place for it
524
525 findObjectLinkableMaybe :: Module -> ModLocation -> IO (Maybe Linkable)
526 findObjectLinkableMaybe mod locn
527    = do let obj_fn = ml_obj_file locn
528         maybe_obj_time <- modificationTimeIfExists obj_fn
529         case maybe_obj_time of
530           Nothing -> return Nothing
531           Just obj_time -> liftM Just (findObjectLinkable mod obj_fn obj_time)
532
533 -- Make an object linkable when we know the object file exists, and we know
534 -- its modification time.
535 findObjectLinkable :: Module -> FilePath -> UTCTime -> IO Linkable
536 findObjectLinkable mod obj_fn obj_time = return (LM obj_time mod [DotO obj_fn])
537   -- We used to look for _stub.o files here, but that was a bug (#706)
538   -- Now GHC merges the stub.o into the main .o (#3687)
539
540 -- -----------------------------------------------------------------------------
541 -- Error messages
542
543 cannotFindModule :: DynFlags -> ModuleName -> FindResult -> SDoc
544 cannotFindModule = cantFindErr (sLit "Could not find module")
545                                (sLit "Ambiguous module name")
546
547 cannotFindInterface  :: DynFlags -> ModuleName -> FindResult -> SDoc
548 cannotFindInterface = cantFindErr (sLit "Failed to load interface for")
549                                   (sLit "Ambiguous interface for")
550
551 cantFindErr :: LitString -> LitString -> DynFlags -> ModuleName -> FindResult
552             -> SDoc
553 cantFindErr _ multiple_found _ mod_name (FoundMultiple pkgs)
554   = hang (ptext multiple_found <+> quotes (ppr mod_name) <> colon) 2 (
555        sep [ptext (sLit "it was found in multiple packages:"),
556                 hsep (map (text.packageIdString) pkgs)]
557     )
558 cantFindErr cannot_find _ dflags mod_name find_result
559   = ptext cannot_find <+> quotes (ppr mod_name)
560     $$ more_info
561   where
562     pkg_map :: PackageConfigMap
563     pkg_map = pkgIdMap (pkgState dflags)
564
565     more_info
566       = case find_result of
567             NoPackage pkg
568                 -> ptext (sLit "no package matching") <+> quotes (ppr pkg) <+>
569                    ptext (sLit "was found")
570
571             NotFound { fr_paths = files, fr_pkg = mb_pkg
572                      , fr_mods_hidden = mod_hiddens, fr_pkgs_hidden = pkg_hiddens
573                      , fr_suggestions = suggest }
574                 | Just pkg <- mb_pkg, pkg /= thisPackage dflags
575                 -> not_found_in_package pkg files
576
577                 | not (null suggest)
578                 -> pp_suggestions suggest $$ tried_these files
579
580                 | null files && null mod_hiddens && null pkg_hiddens
581                 -> ptext (sLit "It is not a module in the current program, or in any known package.")
582
583                 | otherwise
584                 -> vcat (map pkg_hidden pkg_hiddens) $$
585                    vcat (map mod_hidden mod_hiddens) $$
586                    tried_these files
587
588             _ -> panic "cantFindErr"
589
590     build_tag = buildTag dflags
591
592     not_found_in_package pkg files
593        | build_tag /= ""
594        = let
595             build = if build_tag == "p" then "profiling"
596                                         else "\"" ++ build_tag ++ "\""
597          in
598          ptext (sLit "Perhaps you haven't installed the ") <> text build <>
599          ptext (sLit " libraries for package ") <> quotes (ppr pkg) <> char '?' $$
600          tried_these files
601
602        | otherwise
603        = ptext (sLit "There are files missing in the ") <> quotes (ppr pkg) <>
604          ptext (sLit " package,") $$
605          ptext (sLit "try running 'ghc-pkg check'.") $$
606          tried_these files
607
608     tried_these files
609         | null files = empty
610         | verbosity dflags < 3 =
611               ptext (sLit "Use -v to see a list of the files searched for.")
612         | otherwise =
613                hang (ptext (sLit "Locations searched:")) 2 $ vcat (map text files)
614
615     pkg_hidden pkg =
616         ptext (sLit "It is a member of the hidden package") <+> quotes (ppr pkg)
617         <> dot $$ cabal_pkg_hidden_hint pkg
618     cabal_pkg_hidden_hint pkg
619      | gopt Opt_BuildingCabalPackage dflags
620         = case simpleParse (packageIdString pkg) of
621           Just pid ->
622               ptext (sLit "Perhaps you need to add") <+>
623               quotes (text (display (pkgName pid))) <+>
624               ptext (sLit "to the build-depends in your .cabal file.")
625           Nothing -> empty
626      | otherwise = empty
627
628     mod_hidden pkg =
629         ptext (sLit "it is a hidden module in the package") <+> quotes (ppr pkg)
630
631     pp_suggestions :: [Module] -> SDoc
632     pp_suggestions sugs
633       | null sugs = empty
634       | otherwise = hang (ptext (sLit "Perhaps you meant"))
635                        2 (vcat [ vcat (map pp_exp exposed_sugs)
636                                , vcat (map pp_hid hidden_sugs) ])
637       where
638         (exposed_sugs, hidden_sugs) = partition from_exposed_pkg sugs
639
640     from_exposed_pkg m = case lookupPackage pkg_map (modulePackageId m) of
641                             Just pkg_config -> exposed pkg_config
642                             Nothing         -> WARN( True, ppr m ) -- Should not happen
643                                                False
644
645     pp_exp mod = ppr (moduleName mod)
646                  <+> parens (ptext (sLit "from") <+> ppr (modulePackageId mod))
647     pp_hid mod = ppr (moduleName mod)
648                  <+> parens (ptext (sLit "needs flag -package") <+> ppr (modulePackageId mod))
649 \end{code}