Convert more UniqFM's back to LazyUniqFM's
[ghc-hetmet.git] / compiler / main / Finder.lhs
index fd0982d..b76bd97 100644 (file)
@@ -12,6 +12,7 @@ module Finder (
     findHomeModule,
     mkHomeModLocation,
     mkHomeModLocation2,
+    mkHiOnlyModLocation,
     addHomeModuleToFinder,
     uncacheModule,
     mkStubPaths,
@@ -19,7 +20,9 @@ module Finder (
     findObjectLinkableMaybe,
     findObjectLinkable,
 
-    cantFindError,
+    cannotFindModule,
+    cannotFindInterface,
+
   ) where
 
 #include "HsVersions.h"
@@ -33,16 +36,16 @@ import PrelNames        ( gHC_PRIM )
 import DynFlags                ( DynFlags(..), isOneShot, GhcMode(..) )
 import Outputable
 import FiniteMap
-import UniqFM
+import LazyUniqFM
 import Maybes          ( expectJust )
 
-import DATA_IOREF      ( IORef, writeIORef, readIORef, modifyIORef )
-
+import Data.IORef      ( IORef, writeIORef, readIORef, modifyIORef )
 import Data.List
 import System.Directory
+import System.FilePath
 import System.IO
 import Control.Monad
-import Time            ( ClockTime )
+import System.Time     ( ClockTime )
 
 
 type FileExt = String  -- Filename extension
@@ -80,16 +83,25 @@ flushModLocationCache this_pkg ref = do
   where is_ext mod _ | modulePackageId mod /= this_pkg = True
                     | otherwise = False
 
+addToFinderCache :: IORef FinderCache -> ModuleName -> FindResult -> IO ()
 addToFinderCache       ref key val = modifyIORef ref $ \c -> addToUFM c key val
+
+addToModLocationCache :: IORef ModLocationCache -> Module -> ModLocation -> IO ()
 addToModLocationCache  ref key val = modifyIORef ref $ \c -> addToFM c key val
 
+removeFromFinderCache :: IORef FinderCache -> ModuleName -> IO ()
 removeFromFinderCache      ref key = modifyIORef ref $ \c -> delFromUFM c key
+
+removeFromModLocationCache :: IORef ModLocationCache -> Module -> IO ()
 removeFromModLocationCache ref key = modifyIORef ref $ \c -> delFromFM 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
@@ -141,13 +153,14 @@ findExactModule hsc_env mod =
 -- -----------------------------------------------------------------------------
 -- Helpers
 
+orIfNotFound :: IO FindResult -> IO FindResult -> IO FindResult
 this `orIfNotFound` or_this = do
   res <- this
   case res of
-    NotFound here -> do
+    NotFound here _ -> do
        res2 <- or_this
        case res2 of
-          NotFound or_here -> return (NotFound (here ++ or_here))
+          NotFound or_here pkg -> return (NotFound (here ++ or_here) pkg)
           _other -> return res2
     _other -> return res
 
@@ -168,7 +181,7 @@ homeSearchCache hsc_env mod_name do_this = do
 findExposedPackageModule :: HscEnv -> ModuleName -> IO FindResult
 findExposedPackageModule hsc_env mod_name
         -- not found in any package:
-  | null found = return (NotFound [])
+  | null found = return (NotFound [] Nothing)
         -- found in just one exposed package:
   | [(pkg_conf, _)] <- found_exposed
         = let pkgid = mkPackageId (package pkg_conf) in      
@@ -243,6 +256,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 +279,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 $
 
@@ -318,18 +340,18 @@ 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))
+    search [] = return (NotFound (map fst to_search) (Just (modulePackageId mod)))
     search ((file, mk_result) : rest) = do
       b <- doesFileExist file
       if b 
@@ -339,7 +361,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 +390,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 +398,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 +407,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 +442,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 +459,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 +475,39 @@ mkStubPaths
   :: DynFlags
   -> ModuleName
   -> ModLocation
-  -> (FilePath,FilePath)
+  -> (FilePath,FilePath,FilePath)
 
 mkStubPaths dflags mod location
   = let
-               stubdir = stubDir dflags
-
-               mod_basename = dots_to_slashes (moduleNameString mod)
-               src_basename = basenameOf (expectJust "mkStubPaths" 
-                                               (ml_hs_file location))
-
-               stub_basename0
-                       | Just dir <- stubdir = dir `joinFileName` mod_basename
-                       | otherwise           = src_basename
-
-               stub_basename = stub_basename0 ++ "_stub"
+        stubdir = stubDir dflags
+
+        mod_basename = moduleNameSlashes mod
+        src_basename = dropExtension $ expectJust "mkStubPaths" 
+                                                  (ml_hs_file location)
+
+        stub_basename0
+            | Just dir <- stubdir = dir </> mod_basename
+            | otherwise           = src_basename
+
+        stub_basename = stub_basename0 ++ "_stub"
+
+        -- this is the filename we're going to use when
+        -- #including the stub_h file from the .hc file.
+        -- Without -stubdir, we just #include the basename
+        -- (eg. for a module A.B, we #include "B_stub.h"),
+        -- relying on the fact that we add an implicit -I flag
+        -- for the directory in which the source file resides
+        -- (see DriverPipeline.hs).  With -stubdir, we
+        -- #include "A/B.h", assuming that the user has added
+        -- -I<dir> along with -stubdir <dir>.
+        include_basename
+                | Just _ <- stubdir = mod_basename 
+                | otherwise         = takeFileName src_basename
      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",
+         (include_basename ++ "_stub") <.> "h")
+        -- the _stub.o filename is derived from the ml_obj_file.
 
 -- -----------------------------------------------------------------------------
 -- findLinkable isn't related to the other stuff in here, 
@@ -489,30 +525,29 @@ 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
+-- Error messages
 
-dots_to_slashes = map (\c -> if c == '.' then '/' else c)
+cannotFindModule :: DynFlags -> ModuleName -> FindResult -> SDoc
+cannotFindModule = cantFindErr SLIT("Could not find module")
 
+cannotFindInterface  :: DynFlags -> ModuleName -> FindResult -> SDoc
+cannotFindInterface = cantFindErr SLIT("Failed to load interface for")
 
--- -----------------------------------------------------------------------------
--- Error messages
-
-cantFindError :: DynFlags -> ModuleName -> FindResult -> SDoc
-cantFindError dflags mod_name (FoundMultiple pkgs)
-  = hang (ptext SLIT("Cannot import") <+> quotes (ppr mod_name) <> colon) 2 (
+cantFindErr :: LitString -> DynFlags -> ModuleName -> FindResult -> SDoc
+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:"),
                hsep (map (text.packageIdString) pkgs)]
     )
-cantFindError dflags mod_name find_result
-  = hang (ptext SLIT("Could not find module") <+> quotes (ppr mod_name) <> colon)
+cantFindErr cannot_find dflags mod_name find_result
+  = hang (ptext cannot_find <+> quotes (ppr mod_name) <> colon)
        2 more_info
   where
     more_info
@@ -529,17 +564,31 @@ cantFindError dflags mod_name find_result
                -> ptext SLIT("no package matching") <+> ppr pkg <+>
                   ptext SLIT("was found")
 
-           NotFound files
+           NotFound files mb_pkg
                | null files
                -> ptext SLIT("it is not a module in the current program, or in any known package.")
-               | 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))
+               | 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
+
+               | otherwise
+               -> not_found files
 
            NotFoundInPackage pkg
                -> ptext SLIT("it is not in package") <+> ppr pkg
 
            _ -> 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))
 \end{code}