\begin{code}
module Finder (
- initFinder, -- :: [PackageConfig] -> IO (),
- findModule, -- :: ModuleName -> IO (Maybe (Module, ModuleLocation))
- findModuleDep, -- :: ModuleName -> Bool -> IO (Maybe (Module, ModuleLocation))
- findPackageModule, -- :: ModuleName -> IO (Maybe (Module, ModuleLocation))
- mkHomeModuleLocn, -- :: ModuleName -> String -> FilePath
- -- -> IO ModuleLocation
- emptyHomeDirCache, -- :: IO ()
- flushPackageCache -- :: [PackageConfig] -> IO ()
+ flushFinderCache, -- :: IO ()
+
+ findModule, -- :: ModuleName
+ -- -> IO (Either [FilePath] (Module, ModLocation))
+
+ findPackageModule, -- :: ModuleName
+ -- -> IO (Either [FilePath] (Module, ModLocation))
+
+ mkHomeModLocation, -- :: ModuleName -> FilePath -> IO ModLocation
+
+ findLinkable, -- :: ModuleName -> ModLocation -> IO (Maybe Linkable)
+
+ hiBootExt, -- :: String
+ hiBootVerExt, -- :: String
+
) where
#include "HsVersions.h"
-import HscTypes ( ModuleLocation(..) )
-import Packages ( PackageConfig(..) )
-import DriverPhases
+import Module
+import UniqFM ( filterUFM )
+import HscTypes ( Linkable(..), Unlinked(..) )
import DriverState
import DriverUtil
-import Module
import FastString
import Config
+import Util
+
+import DATA_IOREF ( IORef, writeIORef, readIORef )
-import IOExts
import List
import Directory
import IO
import Monad
-\end{code}
-The Finder provides a thin filesystem abstraction to the rest of the
-compiler. For a given module, it knows (a) which package the module
-lives in, so it can make a Module from a ModuleName, and (b) where the
-source, interface, and object files for a module live.
+-- -----------------------------------------------------------------------------
+-- The Finder
-\begin{code}
-initFinder :: [PackageConfig] -> IO ()
-initFinder pkgs = return ()
+-- The Finder provides a thin filesystem abstraction to the rest of the
+-- compiler. For a given module, it knows (a) whether the module lives
+-- in the home package or in another package, so it can make a Module
+-- from a ModuleName, and (b) where the source, interface, and object
+-- files for a module live.
+--
+-- It does *not* know which particular package a module lives in, because
+-- that information is only contained in the interface file.
+
+-- -----------------------------------------------------------------------------
+-- The finder's cache
+
+GLOBAL_VAR(finder_cache, emptyModuleEnv, ModuleEnv (Module,ModLocation))
+
+-- remove all the home modules from the cache; package modules are
+-- assumed to not move around during a session.
+flushFinderCache :: IO ()
+flushFinderCache = do
+ fm <- readIORef finder_cache
+ writeIORef finder_cache (filterUFM (not . isHomeModule . fst) fm)
--- empty, and lazilly fill in the package cache
-flushPackageCache :: [PackageConfig] -> IO ()
-flushPackageCache pkgs = return ()
+addToFinderCache :: ModuleName -> (Module,ModLocation) -> IO ()
+addToFinderCache mod_name stuff = do
+ fm <- readIORef finder_cache
+ writeIORef finder_cache (extendModuleEnvByName fm mod_name stuff)
-emptyHomeDirCache :: IO ()
-emptyHomeDirCache = return ()
+lookupFinderCache :: ModuleName -> IO (Maybe (Module,ModLocation))
+lookupFinderCache mod_name = do
+ fm <- readIORef finder_cache
+ return $! lookupModuleEnvByName fm mod_name
-findModule :: ModuleName -> IO (Maybe (Module, ModuleLocation))
-findModule name = findModuleDep name False
+-- -----------------------------------------------------------------------------
+-- Locating modules
-findModuleDep :: ModuleName -> Bool -> IO (Maybe (Module, ModuleLocation))
-findModuleDep name is_source
- = do { j <- maybeHomeModule name is_source
- ; case j of
- Just home_module -> return (Just home_module)
- Nothing -> findPackageMod name False
- }
+-- This is the main interface to the finder, which maps ModuleNames to
+-- Modules and ModLocations.
+--
+-- The Module contains one crucial bit of information about a module:
+-- whether it lives in the current ("home") package or not (see Module
+-- for more details).
+--
+-- The ModLocation contains the names of all the files associated with
+-- that module: its source file, .hi file, object file, etc.
-maybeHomeModule :: ModuleName -> Bool -> IO (Maybe (Module, ModuleLocation))
-maybeHomeModule mod_name is_source = do
+findModule :: ModuleName -> IO (Either [FilePath] (Module, ModLocation))
+findModule name = do
+ r <- lookupFinderCache name
+ case r of
+ Just result -> return (Right result)
+ Nothing -> do
+ j <- maybeHomeModule name
+ case j of
+ Right home_module -> return (Right home_module)
+ Left home_files -> do
+ r <- findPackageMod name
+ case r of
+ Right pkg_module -> return (Right pkg_module)
+ Left pkg_files -> return (Left (home_files ++ pkg_files))
+
+findPackageModule :: ModuleName -> IO (Either [FilePath] (Module, ModLocation))
+findPackageModule name = do
+ r <- lookupFinderCache name
+ case r of
+ Just result -> return (Right result)
+ Nothing -> findPackageMod name
+
+hiBootExt = "hi-boot"
+hiBootVerExt = "hi-boot-" ++ cHscIfaceFileVersion
+
+maybeHomeModule :: ModuleName -> IO (Either [FilePath] (Module, ModLocation))
+maybeHomeModule mod_name = do
home_path <- readIORef v_Import_paths
hisuf <- readIORef v_Hi_suf
mode <- readIORef v_GhcMode
- let mod_str = moduleNameUserString mod_name
- basename = map (\c -> if c == '.' then '/' else c) mod_str
-
- -- In compilation manager modes, we look for source files in the home
- -- package because we can compile these automatically. In one-shot
- -- compilation mode we look for .hi files only.
- std_exts
- | isCompManagerMode mode || mode == DoMkDependHS =
- [ ("hs", \ _ fName path -> mkHomeModuleLocn mod_name path fName)
- , ("lhs", \ _ fName path -> mkHomeModuleLocn mod_name path fName)
- ]
- | otherwise =
- [ (hisuf, \ _ fName path -> mkHiOnlyModuleLocn mod_name fName) ]
-
- -- last chance: .hi-boot-<ver> and .hi-boot
- hi_boot_ver = "hi-boot-" ++ cHscIfaceFileVersion
-
- boot_exts =
- [ (hi_boot_ver, \ _ fName path -> mkHiOnlyModuleLocn mod_name fName)
- , ("hi-boot", \ _ fName path -> mkHiOnlyModuleLocn mod_name fName)
- ]
-
- searchPathExts
- (map ((,) undefined) home_path)
- basename
- (if is_source then (boot_exts++std_exts) else std_exts ++ boot_exts)
- -- for SOURCE imports, check the hi-boot extensions
- -- before the source/iface ones, to avoid
- -- creating circ Makefile deps.
-
-mkHiOnlyModuleLocn mod_name hi_file =
- return
- ( mkHomeModule mod_name
- , ModuleLocation{ ml_hspp_file = Nothing
- , ml_hs_file = Nothing
- , ml_hi_file = hi_file
- , ml_obj_file = Nothing
- }
- )
-
--- The .hi file always follows the module name, whereas the object
--- file may follow the name of the source file in the case where the
--- two differ (see summariseFile in compMan/CompManager.lhs).
-
-mkHomeModuleLocn mod_name
- basename -- everything but the extension
- source_fn -- full path to the source (required)
- = do
+ let
+ source_exts =
+ [ ("hs", mkHomeModLocationSearched mod_name)
+ , ("lhs", mkHomeModLocationSearched mod_name)
+ ]
+
+ hi_exts = [ (hisuf, mkHiOnlyModLocation hisuf mod_name) ]
+
+ boot_exts =
+ [ (hiBootVerExt, mkHiOnlyModLocation hisuf mod_name)
+ , (hiBootExt, mkHiOnlyModLocation hisuf mod_name)
+ ]
- hisuf <- readIORef v_Hi_suf
- hidir <- readIORef v_Hi_dir
+ -- In compilation manager modes, we look for source files in the home
+ -- package because we can compile these automatically. In one-shot
+ -- compilation mode we look for .hi and .hi-boot files only.
+ --
+ -- When generating dependencies, we're interested in either category.
+ --
+ exts
+ | mode == DoMkDependHS = hi_exts ++ source_exts ++ boot_exts
+ | isCompManagerMode mode = source_exts
+ | otherwise {-one-shot-} = hi_exts ++ boot_exts
- -- take the *last* component of the module name (if a hierarchical name),
- -- and append it to the directory to get the .hi file name.
- let (_,mod_str) = split_longest_prefix (moduleNameUserString mod_name) (=='.')
- hi_filename = mod_str ++ '.':hisuf
- hi_path | Just d <- hidir = d
- | otherwise = getdir basename
- hi = hi_path ++ '/':hi_filename
-
- -- figure out the .o file name. It also lives in the same dir
- -- as the source, but can be overriden by a -odir flag.
- o_file <- odir_ify (basename ++ '.':phaseInputExt Ln) >>= osuf_ify
-
- return (mkHomeModule mod_name,
- ModuleLocation{ ml_hspp_file = Nothing
- , ml_hs_file = Just source_fn
- , ml_hi_file = hi
- , ml_obj_file = Just o_file
- })
-
-findPackageMod :: ModuleName
- -> Bool
- -> IO (Maybe (Module, ModuleLocation))
-findPackageMod mod_name hiOnly = do
- pkgs <- getPackageInfo
+ searchPathExts home_path mod_name exts
+
+-- -----------------------------------------------------------------------------
+-- Looking for a package module
+
+findPackageMod :: ModuleName -> IO (Either [FilePath] (Module, ModLocation))
+findPackageMod mod_name = do
+ mode <- readIORef v_GhcMode
+ imp_dirs <- getPackageImportPath -- including the 'auto' ones
-- hi-suffix for packages depends on the build tag.
package_hisuf <-
if null tag
then return "hi"
else return (tag ++ "_hi")
- let imp_dirs = concatMap (\ pkg -> map ((,) pkg) (import_dirs pkg)) pkgs
- mod_str = moduleNameUserString mod_name
- basename = map (\c -> if c == '.' then '/' else c) mod_str
-
- mkPackageModule mod_name pkg mbFName path =
- return ( mkModule mod_name (mkFastString (name pkg))
- , ModuleLocation{ ml_hspp_file = Nothing
- , ml_hs_file = mbFName
- , ml_hi_file = path ++ '.':package_hisuf
- , ml_obj_file = Nothing
- })
-
- searchPathExts
- imp_dirs basename
- ((package_hisuf,\ pkg fName path -> mkPackageModule mod_name pkg Nothing path) :
- -- can packages contain hi-boots?
- (if hiOnly then [] else
- [ ("hs", \ pkg fName path -> mkPackageModule mod_name pkg (Just fName) path)
- , ("lhs", \ pkg fName path -> mkPackageModule mod_name pkg (Just fName) path)
- ]))
- where
-
-findPackageModule :: ModuleName -> IO (Maybe (Module, ModuleLocation))
-findPackageModule mod_name = findPackageMod mod_name True
-
-searchPathExts :: [(a, FilePath)]
- -> String
- -> [(String, a -> FilePath -> String -> IO (Module, ModuleLocation))]
- -> IO (Maybe (Module, ModuleLocation))
-searchPathExts path basename exts = search exts
+
+ let
+ hi_exts =
+ [ (package_hisuf, mkPackageModLocation package_hisuf mod_name) ]
+
+ source_exts =
+ [ ("hs", mkPackageModLocation package_hisuf mod_name)
+ , ("lhs", mkPackageModLocation package_hisuf mod_name)
+ ]
+
+ -- mkdependHS needs to look for source files in packages too, so
+ -- that we can make dependencies between package before they have
+ -- been built.
+ exts
+ | mode == DoMkDependHS = hi_exts ++ source_exts
+ | otherwise = hi_exts
+
+ -- we never look for a .hi-boot file in an external package;
+ -- .hi-boot files only make sense for the home package.
+ searchPathExts imp_dirs mod_name exts
+
+-- -----------------------------------------------------------------------------
+-- General path searching
+
+searchPathExts
+ :: [FilePath] -- paths to search
+ -> ModuleName -- module name
+ -> [ (
+ String, -- suffix
+ String -> String -> String -> IO (Module, ModLocation) -- action
+ )
+ ]
+ -> IO (Either [FilePath] (Module, ModLocation))
+
+searchPathExts path mod_name exts = search to_search
where
- search [] = return Nothing
- search ((x,f):xs) = do
- let fName = (basename ++ '.':x)
- found <- findOnPath path fName
- case found of
- -- special case to avoid getting "./foo.<ext>" all the time
- Just (v,".") -> fmap Just (f v fName basename)
- Just (v,path) -> fmap Just (f v (path ++ '/':fName)
- (path ++ '/':basename))
- Nothing -> search xs
-
-findOnPath :: [(a,String)] -> String -> IO (Maybe (a, FilePath))
-findOnPath path s = loop path
- where
- loop [] = return Nothing
- loop ((a,d):ds) = do
- let file = d ++ '/':s
- b <- doesFileExist file
- if b then return (Just (a,d)) else loop ds
+ basename = dots_to_slashes (moduleNameUserString mod_name)
+
+ to_search :: [(FilePath, IO (Module,ModLocation))]
+ to_search = [ (file, fn p basename ext)
+ | p <- path,
+ (ext,fn) <- exts,
+ let base | p == "." = basename
+ | otherwise = p ++ '/':basename
+ file = base ++ '.':ext
+ ]
+
+ search [] = return (Left (map fst to_search))
+ search ((file, result) : rest) = do
+ b <- doesFileExist file
+ if b
+ then Right `liftM` result
+ else search rest
+
+-- -----------------------------------------------------------------------------
+-- Building ModLocations
+
+mkHiOnlyModLocation hisuf mod_name path basename _ext = do
+ -- basename == dots_to_slashes (moduleNameUserString mod_name)
+ loc <- hiOnlyModLocation path basename hisuf
+ let result = (mkHomeModule mod_name, loc)
+ addToFinderCache mod_name result
+ return result
+
+mkPackageModLocation hisuf mod_name path basename _ext = do
+ -- basename == dots_to_slashes (moduleNameUserString mod_name)
+ loc <- hiOnlyModLocation path basename hisuf
+ let result = (mkPackageModule mod_name, loc)
+ addToFinderCache mod_name result
+ return result
+
+hiOnlyModLocation path basename hisuf
+ = do { obj_fn <- mkObjPath path basename ;
+ return (ModLocation{ ml_hspp_file = Nothing,
+ ml_hs_file = Nothing,
+ ml_hi_file = path ++ '/':basename ++ '.':hisuf,
+ -- Remove the .hi-boot suffix from
+ -- hi_file, if it had one. We always
+ -- want the name of the real .hi file
+ -- in the ml_hi_file field.
+ ml_obj_file = obj_fn
+ })}
+
+-- -----------------------------------------------------------------------------
+-- Constructing a home module location
+
+-- This is where we construct the ModLocation for a module in the home
+-- package, for which we have a source file. It is called from three
+-- places:
+--
+-- (a) Here in the finder, when we are searching for a module to import,
+-- using the search path (-i option).
+--
+-- (b) The compilation manager, when constructing the ModLocation for
+-- a "root" module (a source file named explicitly on the command line
+-- or in a :load command in GHCi).
+--
+-- (c) The driver in one-shot mode, when we need to construct a
+-- ModLocation for a source file named on the command-line.
+--
+-- Parameters are:
+--
+-- mod_name
+-- The name of the module
+--
+-- path
+-- (a): The search path component where the source file was found.
+-- (b) and (c): "."
+--
+-- src_basename
+-- (a): dots_to_slashes (moduleNameUserString mod_name)
+-- (b) and (c): The filename of the source file, minus its extension
+--
+-- ext
+-- The filename extension of the source file (usually "hs" or "lhs").
+
+mkHomeModLocation mod_name src_filename = do
+ let mod_basename = dots_to_slashes (moduleNameUserString mod_name)
+ (basename,extension) = splitFilename src_filename
+
+ case my_prefix_match (reverse mod_basename) (reverse basename) of
+ Just "" ->
+ mkHomeModLocationSearched mod_name "." mod_basename extension
+ Just rest -> do
+ let path = reverse (dropWhile (=='/') rest)
+ mkHomeModLocationSearched mod_name path mod_basename extension
+ Nothing -> do
+ -- hPutStrLn stderr ("Warning: " ++ src_filename ++
+ -- ": filename and module name do not match")
+ let (dir,basename,ext) = splitFilename3 src_filename
+ mkHomeModLocationSearched mod_name dir basename ext
+
+mkHomeModLocationSearched mod_name path src_basename ext = do
+ hisuf <- readIORef v_Hi_suf
+ hidir <- readIORef v_Hi_dir
+
+ let mod_basename = dots_to_slashes (moduleNameUserString mod_name)
+
+ obj_fn <- mkObjPath path mod_basename
+
+ let -- hi filename, always follows the module name
+ hi_path | Just d <- hidir = d
+ | otherwise = path
+
+ hi_fn = hi_path ++ '/':mod_basename ++ '.':hisuf
+
+ -- source filename
+ source_fn = path ++ '/':src_basename ++ '.':ext
+
+ result = ( mkHomeModule mod_name,
+ ModLocation{ ml_hspp_file = Nothing,
+ ml_hs_file = Just source_fn,
+ ml_hi_file = hi_fn,
+ ml_obj_file = obj_fn,
+ })
+
+ addToFinderCache mod_name result
+ return result
+
+mkObjPath :: FilePath -> String -> IO FilePath
+-- Construct the filename of a .o file.
+-- Does *not* check whether the .o file exists
+mkObjPath path basename
+ = do odir <- readIORef v_Output_dir
+ osuf <- readIORef v_Object_suf
+
+ let obj_path | Just d <- odir = d
+ | otherwise = path
+
+ return (obj_path ++ '/':basename ++ '.':osuf)
+
+-- -----------------------------------------------------------------------------
+-- findLinkable isn't related to the other stuff in here,
+-- but there's no other obvious place for it
+
+findLinkable :: ModuleName -> ModLocation -> IO (Maybe Linkable)
+findLinkable mod locn
+ = do let obj_fn = ml_obj_file locn
+ obj_exist <- doesFileExist obj_fn
+ if not obj_exist
+ then return Nothing
+ else
+ do let stub_fn = case splitFilename3 obj_fn of
+ (dir, base, ext) -> dir ++ "/" ++ base ++ "_stub.o"
+ stub_exist <- doesFileExist stub_fn
+ obj_time <- getModificationTime obj_fn
+ if stub_exist
+ then return (Just (LM obj_time mod [DotO obj_fn, DotO stub_fn]))
+ else return (Just (LM obj_time mod [DotO obj_fn]))
+
+-- -----------------------------------------------------------------------------
+-- Utils
+
+dots_to_slashes = map (\c -> if c == '.' then '/' else c)
+
\end{code}
projects / ghc-hetmet.git / blobdiff