Merge branch 'master' into type-nats
[ghc.git] / compiler / main / Finder.lhs
index df1fa3e..5b1bae4 100644 (file)
@@ -10,8 +10,10 @@ module Finder (
     findImportedModule,
     findExactModule,
     findHomeModule,
+    findExposedPackageModule,
     mkHomeModLocation,
     mkHomeModLocation2,
+    mkHiOnlyModLocation,
     addHomeModuleToFinder,
     uncacheModule,
     mkStubPaths,
@@ -21,6 +23,7 @@ module Finder (
 
     cannotFindModule,
     cannotFindInterface,
+
   ) where
 
 #include "HsVersions.h"
@@ -31,18 +34,20 @@ import Packages
 import FastString
 import Util
 import PrelNames        ( gHC_PRIM )
-import DynFlags                ( DynFlags(..), isOneShot, GhcMode(..) )
+import DynFlags
 import Outputable
-import FiniteMap
 import UniqFM
 import Maybes          ( expectJust )
+import Exception        ( evaluate )
 
-import Data.IORef      ( IORef, writeIORef, readIORef, modifyIORef )
-import Data.List
+import Distribution.Text
+import Distribution.Package hiding (PackageId)
+import Data.IORef      ( IORef, writeIORef, readIORef, atomicModifyIORef )
 import System.Directory
-import System.IO
+import System.FilePath
 import Control.Monad
 import System.Time     ( ClockTime )
+import Data.List        ( partition )
 
 
 type FileExt = String  -- Filename extension
@@ -65,6 +70,7 @@ type BaseName = String        -- Basename of file
 -- assumed to not move around during a session.
 flushFinderCaches :: HscEnv -> IO ()
 flushFinderCaches hsc_env = do
+  -- Ideally the update to both caches be a single atomic operation.
   writeIORef fc_ref emptyUFM
   flushModLocationCache this_pkg mlc_ref
  where
@@ -74,25 +80,38 @@ flushFinderCaches hsc_env = do
 
 flushModLocationCache :: PackageId -> IORef ModLocationCache -> IO ()
 flushModLocationCache this_pkg ref = do
-  fm <- readIORef ref
-  writeIORef ref $! filterFM is_ext fm
+  atomicModifyIORef ref $ \fm -> (filterModuleEnv is_ext fm, ())
+  _ <- evaluate =<< readIORef ref
   return ()
   where is_ext mod _ | modulePackageId mod /= this_pkg = True
                     | otherwise = False
 
-addToFinderCache       ref key val = modifyIORef ref $ \c -> addToUFM c key val
-addToModLocationCache  ref key val = modifyIORef ref $ \c -> addToFM c key val
+addToFinderCache :: IORef FinderCache -> ModuleName -> FindResult -> IO ()
+addToFinderCache ref key val =
+  atomicModifyIORef ref $ \c -> (addToUFM c key val, ())
+
+addToModLocationCache :: IORef ModLocationCache -> Module -> ModLocation -> IO ()
+addToModLocationCache ref key val =
+  atomicModifyIORef ref $ \c -> (extendModuleEnv c key val, ())
 
-removeFromFinderCache      ref key = modifyIORef ref $ \c -> delFromUFM c key
-removeFromModLocationCache ref key = modifyIORef ref $ \c -> delFromFM c key
+removeFromFinderCache :: IORef FinderCache -> ModuleName -> IO ()
+removeFromFinderCache ref key =
+  atomicModifyIORef ref $ \c -> (delFromUFM c key, ())
 
+removeFromModLocationCache :: IORef ModLocationCache -> Module -> IO ()
+removeFromModLocationCache ref key =
+  atomicModifyIORef ref $ \c -> (delModuleEnv c key, ())
+
+lookupFinderCache :: IORef FinderCache -> ModuleName -> IO (Maybe FindResult)
 lookupFinderCache ref key = do 
    c <- readIORef ref
    return $! lookupUFM c key
 
+lookupModLocationCache :: IORef ModLocationCache -> Module
+                       -> IO (Maybe ModLocation)
 lookupModLocationCache ref key = do
    c <- readIORef ref
-   return $! lookupFM c key
+   return $! lookupModuleEnv c key
 
 -- -----------------------------------------------------------------------------
 -- The two external entry points
@@ -103,27 +122,20 @@ lookupModLocationCache ref key = do
 -- packages to find the module, if a package is specified then only
 -- that package is searched for the module.
 
-findImportedModule :: HscEnv -> ModuleName -> Maybe PackageId -> IO FindResult
-findImportedModule hsc_env mod_name mb_pkgid =
-  case mb_pkgid of
-       Nothing                    -> unqual_import
-       Just pkg | pkg == this_pkg -> home_import
-                | otherwise       -> pkg_import pkg
+findImportedModule :: HscEnv -> ModuleName -> Maybe FastString -> IO FindResult
+findImportedModule hsc_env mod_name mb_pkg =
+  case mb_pkg of
+       Nothing                        -> unqual_import
+       Just pkg | pkg == fsLit "this" -> home_import -- "this" is special
+                | otherwise           -> pkg_import
   where
-    dflags = hsc_dflags hsc_env
-    this_pkg = thisPackage dflags
-
-    home_import     = findHomeModule hsc_env mod_name
+    home_import   = findHomeModule hsc_env mod_name
 
-    pkg_import pkg  = findPackageModule hsc_env (mkModule pkg mod_name)
-                       -- ToDo: this isn't quite right, the module we want
-                       -- might actually be in another package, but re-exposed
-                       -- ToDo: should return NotFoundInPackage if
-                       -- the module isn't exposed by the package.
+    pkg_import    = findExposedPackageModule hsc_env mod_name mb_pkg
 
-    unqual_import   = home_import 
-                       `orIfNotFound`
-                     findExposedPackageModule hsc_env mod_name
+    unqual_import = home_import 
+                        `orIfNotFound`
+                     findExposedPackageModule hsc_env mod_name Nothing
 
 -- | Locate a specific 'Module'.  The purpose of this function is to
 -- create a 'ModLocation' for a given 'Module', that is to find out
@@ -141,14 +153,22 @@ findExactModule hsc_env mod =
 -- -----------------------------------------------------------------------------
 -- Helpers
 
-this `orIfNotFound` or_this = do
+orIfNotFound :: IO FindResult -> IO FindResult -> IO FindResult
+orIfNotFound this or_this = do
   res <- this
   case res of
-    NotFound here _ -> do
-       res2 <- or_this
-       case res2 of
-          NotFound or_here pkg -> return (NotFound (here ++ or_here) pkg)
-          _other -> return res2
+    NotFound { fr_paths = paths1, fr_mods_hidden = mh1
+             , fr_pkgs_hidden = ph1, fr_suggestions = s1 }
+     -> do res2 <- or_this
+           case res2 of
+             NotFound { fr_paths = paths2, fr_pkg = mb_pkg2, fr_mods_hidden = mh2
+                      , fr_pkgs_hidden = ph2, fr_suggestions = s2 }
+              -> return (NotFound { fr_paths = paths1 ++ paths2
+                                  , fr_pkg = mb_pkg2 -- snd arg is the package search
+                                  , fr_mods_hidden = mh1 ++ mh2
+                                  , fr_pkgs_hidden = ph1 ++ ph2
+                                  , fr_suggestions = s1  ++ s2 })
+             _other -> return res2
     _other -> return res
 
 
@@ -165,28 +185,42 @@ homeSearchCache hsc_env mod_name do_this = do
           _other        -> return ()
        return result
 
-findExposedPackageModule :: HscEnv -> ModuleName -> IO FindResult
-findExposedPackageModule hsc_env mod_name
+findExposedPackageModule :: HscEnv -> ModuleName -> Maybe FastString
+                         -> IO FindResult
+findExposedPackageModule hsc_env mod_name mb_pkg
         -- not found in any package:
-  | null found = return (NotFound [] Nothing)
-        -- found in just one exposed package:
-  | [(pkg_conf, _)] <- found_exposed
-        = let pkgid = mkPackageId (package pkg_conf) in      
-          findPackageModule_ hsc_env (mkModule pkgid mod_name) pkg_conf
-        -- not found in any exposed package, report how it was hidden:
-  | null found_exposed, ((pkg_conf, exposed_mod):_) <- found
-        = let pkgid = mkPackageId (package pkg_conf) in
-          if not (exposed_mod)
-                then return (ModuleHidden pkgid)
-                else return (PackageHidden pkgid)
-  | otherwise
-        = return (FoundMultiple (map (mkPackageId.package.fst) found_exposed))
-  where
-       dflags = hsc_dflags hsc_env
-        found = lookupModuleInAllPackages dflags mod_name
-        found_exposed = filter is_exposed found
-        is_exposed (pkg_conf,exposed_mod) = exposed pkg_conf && exposed_mod
-
+  = case lookupModuleWithSuggestions (hsc_dflags hsc_env) mod_name of
+       Left suggest -> return (NotFound { fr_paths = [], fr_pkg = Nothing
+                                        , fr_pkgs_hidden = [], fr_mods_hidden = []
+                                        , fr_suggestions = suggest })
+       Right found
+         | null found_exposed   -- Found, but with no exposed copies
+          -> return (NotFound { fr_paths = [], fr_pkg = Nothing
+                              , fr_pkgs_hidden = mod_hiddens, fr_mods_hidden = pkg_hiddens
+                              , fr_suggestions = [] })
+
+         | [(pkg_conf,_)] <- found_exposed     -- Found uniquely
+         -> let pkgid = packageConfigId pkg_conf in
+            findPackageModule_ hsc_env (mkModule pkgid mod_name) pkg_conf
+
+         | otherwise           -- Found in more than one place
+         -> return (FoundMultiple (map (packageConfigId.fst) found_exposed))
+         where
+           for_this_pkg  = case mb_pkg of
+                             Nothing -> found
+                             Just p  -> filter ((`matches` p) . fst) found
+           found_exposed = filter is_exposed for_this_pkg
+           is_exposed (pkg_conf,exposed_mod) = exposed pkg_conf && exposed_mod
+
+           mod_hiddens = [ packageConfigId pkg_conf
+                         | (pkg_conf,False) <- found ]
+
+           pkg_hiddens = [ packageConfigId pkg_conf
+                         | (pkg_conf,_) <- found, not (exposed pkg_conf) ]
+
+           pkg_conf  `matches` pkg
+              = case packageName pkg_conf of
+                  PackageName n -> pkg == mkFastString n
 
 modLocationCache :: HscEnv -> Module -> IO FindResult -> IO FindResult
 modLocationCache hsc_env mod do_this = do
@@ -243,6 +277,14 @@ findHomeModule hsc_env mod_name =
      exts | isOneShot (ghcMode dflags) = hi_exts
           | otherwise                 = source_exts
    in
+
+  -- special case for GHC.Prim; we won't find it in the filesystem.
+  -- This is important only when compiling the base package (where GHC.Prim
+  -- is a home module).
+  if mod == gHC_PRIM 
+        then return (Found (error "GHC.Prim ModLocation") mod)
+        else 
+
    searchPathExts home_path mod exts
 
 
@@ -258,6 +300,7 @@ findPackageModule hsc_env mod = do
      Nothing -> return (NoPackage pkg_id)
      Just pkg_conf -> findPackageModule_ hsc_env mod pkg_conf
       
+findPackageModule_ :: HscEnv -> Module -> PackageConfig -> IO FindResult
 findPackageModule_ hsc_env mod pkg_conf = 
   modLocationCache hsc_env mod $
 
@@ -273,24 +316,22 @@ findPackageModule_ hsc_env mod pkg_conf =
           -- hi-suffix for packages depends on the build tag.
      package_hisuf | null tag  = "hi"
                   | otherwise = tag ++ "_hi"
-     hi_exts =
-        [ (package_hisuf, mkHiOnlyModLocation dflags package_hisuf) ]
 
-     source_exts = 
-       [ ("hs",   mkHiOnlyModLocation dflags package_hisuf)
-       , ("lhs",  mkHiOnlyModLocation dflags package_hisuf)
-       ]
-
-     -- mkdependHS needs to look for source files in packages too, so
-     -- that we can make dependencies between package before they have
-     -- been built.
-     exts 
-      | MkDepend <- ghcMode dflags = hi_exts ++ source_exts
-      | otherwise                 = hi_exts
+     mk_hi_loc = mkHiOnlyModLocation dflags package_hisuf
+
+     import_dirs = importDirs pkg_conf
       -- we never look for a .hi-boot file in an external package;
       -- .hi-boot files only make sense for the home package.
   in
-  searchPathExts (importDirs pkg_conf) mod exts
+  case import_dirs of
+    [one] | MkDepend <- ghcMode dflags -> do
+          -- there's only one place that this .hi file can be, so
+          -- don't bother looking for it.
+          let basename = moduleNameSlashes (moduleName mod)
+          loc <- mk_hi_loc one basename
+          return (Found loc mod)
+    _otherwise ->
+          searchPathExts import_dirs mod [(package_hisuf, mk_hi_loc)]
 
 -- -----------------------------------------------------------------------------
 -- General path searching
@@ -318,18 +359,22 @@ searchPathExts paths mod exts
        return result
 
   where
-    basename = dots_to_slashes (moduleNameString (moduleName mod))
+    basename = moduleNameSlashes (moduleName mod)
 
     to_search :: [(FilePath, IO ModLocation)]
     to_search = [ (file, fn path basename)
                | path <- paths, 
                  (ext,fn) <- exts,
                  let base | path == "." = basename
-                          | otherwise   = path `joinFileName` basename
-                     file = base `joinFileExt` ext
+                          | otherwise   = path </> basename
+                     file = base <.> ext
                ]
 
-    search [] = return (NotFound (map fst to_search) (Just (modulePackageId mod)))
+    search [] = return (NotFound { fr_paths = map fst to_search
+                                 , fr_pkg   = Just (modulePackageId mod)
+                                 , fr_mods_hidden = [], fr_pkgs_hidden = []
+                                 , fr_suggestions = [] })
+
     search ((file, mk_result) : rest) = do
       b <- doesFileExist file
       if b 
@@ -339,7 +384,7 @@ searchPathExts paths mod exts
 mkHomeModLocationSearched :: DynFlags -> ModuleName -> FileExt
                          -> FilePath -> BaseName -> IO ModLocation
 mkHomeModLocationSearched dflags mod suff path basename = do
-   mkHomeModLocation2 dflags mod (path `joinFileName` basename) suff
+   mkHomeModLocation2 dflags mod (path </> basename) suff
 
 -- -----------------------------------------------------------------------------
 -- Constructing a home module location
@@ -368,7 +413,7 @@ mkHomeModLocationSearched dflags mod suff path basename = do
 --      (b) and (c): "."
 --
 -- src_basename
---      (a): dots_to_slashes (moduleNameUserString mod)
+--      (a): (moduleNameSlashes mod)
 --      (b) and (c): The filename of the source file, minus its extension
 --
 -- ext
@@ -376,7 +421,7 @@ mkHomeModLocationSearched dflags mod suff path basename = do
 
 mkHomeModLocation :: DynFlags -> ModuleName -> FilePath -> IO ModLocation
 mkHomeModLocation dflags mod src_filename = do
-   let (basename,extension) = splitFilename src_filename
+   let (basename,extension) = splitExtension src_filename
    mkHomeModLocation2 dflags mod basename extension
 
 mkHomeModLocation2 :: DynFlags
@@ -385,22 +430,22 @@ mkHomeModLocation2 :: DynFlags
                   -> String    -- Suffix
                   -> IO ModLocation
 mkHomeModLocation2 dflags mod src_basename ext = do
-   let mod_basename = dots_to_slashes (moduleNameString mod)
+   let mod_basename = moduleNameSlashes mod
 
    obj_fn  <- mkObjPath  dflags src_basename mod_basename
    hi_fn   <- mkHiPath   dflags src_basename mod_basename
 
-   return (ModLocation{ ml_hs_file   = Just (src_basename `joinFileExt` ext),
+   return (ModLocation{ ml_hs_file   = Just (src_basename <.> ext),
                        ml_hi_file   = hi_fn,
                        ml_obj_file  = obj_fn })
 
 mkHiOnlyModLocation :: DynFlags -> Suffix -> FilePath -> String
                    -> IO ModLocation
 mkHiOnlyModLocation dflags hisuf path basename
- = do let full_basename = path `joinFileName` basename
+ = do let full_basename = path </> basename
       obj_fn  <- mkObjPath  dflags full_basename basename
       return ModLocation{    ml_hs_file   = Nothing,
-                            ml_hi_file   = full_basename  `joinFileExt` hisuf,
+                            ml_hi_file   = full_basename <.> hisuf,
                                -- Remove the .hi-boot suffix from
                                -- hi_file, if it had one.  We always
                                -- want the name of the real .hi file
@@ -420,10 +465,10 @@ mkObjPath dflags basename mod_basename
                odir = objectDir dflags
                osuf = objectSuf dflags
        
-               obj_basename | Just dir <- odir = dir `joinFileName` mod_basename
+               obj_basename | Just dir <- odir = dir </> mod_basename
                             | otherwise        = basename
 
-        return (obj_basename `joinFileExt` osuf)
+        return (obj_basename <.> osuf)
 
 -- | Constructs the filename of a .hi file for a given source file.
 -- Does /not/ check whether the .hi file exists
@@ -437,10 +482,10 @@ mkHiPath dflags basename mod_basename
                hidir = hiDir dflags
                hisuf = hiSuf dflags
 
-               hi_basename | Just dir <- hidir = dir `joinFileName` mod_basename
+               hi_basename | Just dir <- hidir = dir </> mod_basename
                            | otherwise         = basename
 
-        return (hi_basename `joinFileExt` hisuf)
+        return (hi_basename <.> hisuf)
 
 
 -- -----------------------------------------------------------------------------
@@ -453,25 +498,30 @@ mkStubPaths
   :: DynFlags
   -> ModuleName
   -> ModLocation
-  -> (FilePath,FilePath)
+  -> (FilePath,FilePath,FilePath)
 
 mkStubPaths dflags mod location
   = let
-               stubdir = stubDir dflags
+        stubdir = stubDir dflags
 
-               mod_basename = dots_to_slashes (moduleNameString mod)
-               src_basename = basenameOf (expectJust "mkStubPaths" 
-                                               (ml_hs_file location))
+        mod_basename = moduleNameSlashes mod
+        src_basename = dropExtension $ expectJust "mkStubPaths" 
+                                                  (ml_hs_file location)
 
-               stub_basename0
-                       | Just dir <- stubdir = dir `joinFileName` mod_basename
-                       | otherwise           = src_basename
+        stub_basename0
+            | Just dir <- stubdir = dir </> mod_basename
+            | otherwise           = src_basename
 
-               stub_basename = stub_basename0 ++ "_stub"
+        stub_basename = stub_basename0 ++ "_stub"
+
+        obj  = ml_obj_file location
+        osuf = objectSuf dflags
+        stub_obj_base = dropTail (length osuf + 1) obj ++ "_stub"
+                        -- NB. not takeFileName, see #3093
      in
-        (stub_basename `joinFileExt` "c",
-        stub_basename `joinFileExt` "h")
-       -- the _stub.o filename is derived from the ml_obj_file.
+        (stub_basename <.> "c",
+         stub_basename <.> "h",
+         stub_obj_base <.> objectSuf dflags)
 
 -- -----------------------------------------------------------------------------
 -- findLinkable isn't related to the other stuff in here, 
@@ -489,76 +539,119 @@ findObjectLinkableMaybe mod locn
 -- its modification time.
 findObjectLinkable :: Module -> FilePath -> ClockTime -> IO Linkable
 findObjectLinkable mod obj_fn obj_time = do
-  let stub_fn = case splitFilename3 obj_fn of
-                       (dir, base, ext) -> dir ++ "/" ++ base ++ "_stub.o"
+  let stub_fn = (dropExtension obj_fn ++ "_stub") <.> "o"
   stub_exist <- doesFileExist stub_fn
   if stub_exist
        then return (LM obj_time mod [DotO obj_fn, DotO stub_fn])
        else return (LM obj_time mod [DotO obj_fn])
 
 -- -----------------------------------------------------------------------------
--- Utils
-
-dots_to_slashes = map (\c -> if c == '.' then '/' else c)
-
-
--- -----------------------------------------------------------------------------
 -- Error messages
 
 cannotFindModule :: DynFlags -> ModuleName -> FindResult -> SDoc
-cannotFindModule = cantFindErr SLIT("Could not find module")
+cannotFindModule = cantFindErr (sLit "Could not find module")
+                               (sLit "Ambiguous module name")
 
 cannotFindInterface  :: DynFlags -> ModuleName -> FindResult -> SDoc
-cannotFindInterface = cantFindErr SLIT("Failed to load interface for")
-
-cantFindErr cannot_find dflags mod_name (FoundMultiple pkgs)
-  = hang (ptext cannot_find <+> quotes (ppr mod_name) <> colon) 2 (
-       sep [ptext SLIT("it was found in multiple packages:"),
+cannotFindInterface = cantFindErr (sLit "Failed to load interface for")
+                                  (sLit "Ambiguous interface for")
+
+cantFindErr :: LitString -> LitString -> DynFlags -> ModuleName -> FindResult
+            -> SDoc
+cantFindErr _ multiple_found _ mod_name (FoundMultiple pkgs)
+  = hang (ptext multiple_found <+> quotes (ppr mod_name) <> colon) 2 (
+       sep [ptext (sLit "it was found in multiple packages:"),
                hsep (map (text.packageIdString) pkgs)]
     )
-cantFindErr cannot_find dflags mod_name find_result
-  = hang (ptext cannot_find <+> quotes (ppr mod_name) <> colon)
-       2 more_info
+cantFindErr cannot_find dflags mod_name find_result
+  = ptext cannot_find <+> quotes (ppr mod_name)
+    $$ more_info
   where
+    pkg_map :: PackageConfigMap
+    pkg_map = pkgIdMap (pkgState dflags)
+
     more_info
       = case find_result of
-           PackageHidden pkg 
-               -> ptext SLIT("it is a member of package") <+> ppr pkg <> comma
-                  <+> ptext SLIT("which is hidden")
+           NoPackage pkg
+               -> ptext (sLit "no package matching") <+> quotes (ppr pkg) <+>
+                  ptext (sLit "was found")
 
-           ModuleHidden pkg
-               -> ptext SLIT("it is hidden") <+> parens (ptext SLIT("in package")
-                  <+> ppr pkg)
+            NotFound { fr_paths = files, fr_pkg = mb_pkg
+                     , fr_mods_hidden = mod_hiddens, fr_pkgs_hidden = pkg_hiddens
+                     , fr_suggestions = suggest }
+               | Just pkg <- mb_pkg, pkg /= thisPackage dflags
+               -> not_found_in_package pkg files
 
-           NoPackage pkg
-               -> ptext SLIT("no package matching") <+> ppr pkg <+>
-                  ptext SLIT("was found")
-
-           NotFound files mb_pkg
-               | null files
-               -> ptext SLIT("it is not a module in the current program, or in any known package.")
-               | Just pkg <- mb_pkg, pkg /= thisPackage dflags, build_tag /= ""
-               -> let 
-                    build = if build_tag == "p" then "profiling" 
-                                                else "\"" ++ build_tag ++ "\""
-                  in
-                  ptext SLIT("Perhaps you haven't installed the ") <> text build <>
-                  ptext SLIT(" libraries for package ") <> ppr pkg <> char '?' $$
-                  not_found files
+                | not (null suggest)
+                -> pp_suggestions suggest $$ tried_these files
 
-               | otherwise
-               -> not_found files
+                | null files && null mod_hiddens && null pkg_hiddens
+                -> ptext (sLit "It is not a module in the current program, or in any known package.")
 
-           NotFoundInPackage pkg
-               -> ptext SLIT("it is not in package") <+> ppr pkg
+               | otherwise
+               -> vcat (map pkg_hidden pkg_hiddens) $$
+                   vcat (map mod_hidden mod_hiddens) $$
+                   tried_these files
 
-           _ -> panic "cantFindErr"
+            _ -> panic "cantFindErr"
 
     build_tag = buildTag dflags
 
-    not_found files
-       | verbosity dflags < 3
-       = ptext SLIT("Use -v to see a list of the files searched for.")
-       | otherwise 
-       = hang (ptext SLIT("locations searched:")) 2 (vcat (map text files))
+    not_found_in_package pkg files
+       | build_tag /= ""
+       = let
+            build = if build_tag == "p" then "profiling"
+                                        else "\"" ++ build_tag ++ "\""
+         in
+         ptext (sLit "Perhaps you haven't installed the ") <> text build <>
+         ptext (sLit " libraries for package ") <> quotes (ppr pkg) <> char '?' $$
+         tried_these files
+
+       | otherwise
+       = ptext (sLit "There are files missing in the ") <> quotes (ppr pkg) <>
+         ptext (sLit " package,") $$
+         ptext (sLit "try running 'ghc-pkg check'.") $$
+         tried_these files
+
+    tried_these files
+        | null files = empty
+        | verbosity dflags < 3 =
+             ptext (sLit "Use -v to see a list of the files searched for.")
+        | otherwise =
+               hang (ptext (sLit "Locations searched:")) 2 $ vcat (map text files)
+        
+    pkg_hidden pkg =
+        ptext (sLit "It is a member of the hidden package") <+> quotes (ppr pkg)
+        <> dot $$ cabal_pkg_hidden_hint pkg
+    cabal_pkg_hidden_hint pkg
+     | dopt Opt_BuildingCabalPackage dflags
+        = case simpleParse (packageIdString pkg) of
+          Just pid ->
+              ptext (sLit "Perhaps you need to add") <+>
+              quotes (text (display (pkgName pid))) <+>
+              ptext (sLit "to the build-depends in your .cabal file.")
+          Nothing -> empty
+     | otherwise = empty
+
+    mod_hidden pkg =
+        ptext (sLit "it is a hidden module in the package") <+> quotes (ppr pkg)
+
+    pp_suggestions :: [Module] -> SDoc
+    pp_suggestions sugs
+      | null sugs = empty
+      | otherwise = hang (ptext (sLit "Perhaps you meant"))
+                       2 (vcat [ vcat (map pp_exp exposed_sugs)
+                               , vcat (map pp_hid hidden_sugs) ])
+      where
+        (exposed_sugs, hidden_sugs) = partition from_exposed_pkg sugs
+
+    from_exposed_pkg m = case lookupPackage pkg_map (modulePackageId m) of
+                            Just pkg_config -> exposed pkg_config
+                            Nothing         -> WARN( True, ppr m ) -- Should not happen
+                                               False
+
+    pp_exp mod = ppr (moduleName mod)
+                 <+> parens (ptext (sLit "from") <+> ppr (modulePackageId mod))
+    pp_hid mod = ppr (moduleName mod)
+                 <+> parens (ptext (sLit "needs flag -package") <+> ppr (modulePackageId mod))
 \end{code}