2 % (c) The University of Glasgow, 2000
4 \section[Finder]{Module Finder}
8 initFinder, -- :: [PackageConfig] -> IO (),
9 findModule, -- :: ModuleName -> IO (Maybe (Module, ModuleLocation))
10 findModuleDep, -- :: ModuleName -> Bool -> IO (Maybe (Module, ModuleLocation))
11 findPackageModule, -- :: ModuleName -> IO (Maybe (Module, ModuleLocation))
12 mkHomeModuleLocn, -- :: ModuleName -> String -> FilePath
13 -- -> IO ModuleLocation
14 emptyHomeDirCache, -- :: IO ()
15 flushPackageCache -- :: [PackageConfig] -> IO ()
18 #include "HsVersions.h"
20 import HscTypes ( ModuleLocation(..) )
21 import Packages ( PackageConfig(..) )
36 The Finder provides a thin filesystem abstraction to the rest of the
37 compiler. For a given module, it knows (a) which package the module
38 lives in, so it can make a Module from a ModuleName, and (b) where the
39 source, interface, and object files for a module live.
42 initFinder :: [PackageConfig] -> IO ()
43 initFinder pkgs = return ()
45 -- empty, and lazilly fill in the package cache
46 flushPackageCache :: [PackageConfig] -> IO ()
47 flushPackageCache pkgs = return ()
49 emptyHomeDirCache :: IO ()
50 emptyHomeDirCache = return ()
52 findModule :: ModuleName -> IO (Maybe (Module, ModuleLocation))
53 findModule name = findModuleDep name False
55 findModuleDep :: ModuleName -> Bool -> IO (Maybe (Module, ModuleLocation))
56 findModuleDep name is_source
57 = do { j <- maybeHomeModule name is_source
59 Just home_module -> return (Just home_module)
60 Nothing -> findPackageMod name False
63 maybeHomeModule :: ModuleName -> Bool -> IO (Maybe (Module, ModuleLocation))
64 maybeHomeModule mod_name is_source = do
65 home_path <- readIORef v_Import_paths
66 hisuf <- readIORef v_Hi_suf
68 let mod_str = moduleNameUserString mod_name
69 basename = map (\c -> if c == '.' then '/' else c) mod_str
72 [ ("hs", \ _ fName path -> mkHomeModuleLocn mod_name path fName)
73 , ("lhs", \ _ fName path -> mkHomeModuleLocn mod_name path fName)
74 , (hisuf, \ _ fName path -> mkHiOnlyModuleLocn mod_name fName)
76 -- look for the .hi file last, because if there's a source file about
77 -- we want to find it.
79 -- last chance: .hi-boot-<ver> and .hi-boot
80 hi_boot_ver = "hi-boot-" ++ cHscIfaceFileVersion
83 [ (hi_boot_ver, \ _ fName path -> mkHiOnlyModuleLocn mod_name fName)
84 , ("hi-boot", \ _ fName path -> mkHiOnlyModuleLocn mod_name fName)
88 (map ((,) undefined) home_path)
90 (if is_source then (boot_exts++std_exts) else std_exts ++ boot_exts)
91 -- for SOURCE imports, check the hi-boot extensions
92 -- before the source/iface ones, to avoid
93 -- creating circ Makefile deps.
95 mkHiOnlyModuleLocn mod_name hi_file =
97 ( mkHomeModule mod_name
98 , ModuleLocation{ ml_hspp_file = Nothing
99 , ml_hs_file = Nothing
100 , ml_hi_file = hi_file
101 , ml_obj_file = Nothing
105 -- The .hi file always follows the module name, whereas the object
106 -- file may follow the name of the source file in the case where the
107 -- two differ (see summariseFile in compMan/CompManager.lhs).
109 mkHomeModuleLocn mod_name
110 basename -- everything but the extension
111 source_fn -- full path to the source (required)
114 hisuf <- readIORef v_Hi_suf
115 hidir <- readIORef v_Hi_dir
117 -- take the *last* component of the module name (if a hierarchical name),
118 -- and append it to the directory to get the .hi file name.
119 let (_,mod_str) = split_longest_prefix (moduleNameUserString mod_name) (=='.')
120 hi_filename = mod_str ++ '.':hisuf
121 hi_path | Just d <- hidir = d
122 | otherwise = getdir basename
123 hi = hi_path ++ '/':hi_filename
125 -- figure out the .o file name. It also lives in the same dir
126 -- as the source, but can be overriden by a -odir flag.
127 o_file <- odir_ify (basename ++ '.':phaseInputExt Ln) >>= osuf_ify
129 return (mkHomeModule mod_name,
130 ModuleLocation{ ml_hspp_file = Nothing
131 , ml_hs_file = Just source_fn
133 , ml_obj_file = Just o_file
136 findPackageMod :: ModuleName
138 -> IO (Maybe (Module, ModuleLocation))
139 findPackageMod mod_name hiOnly = do
140 pkgs <- getPackageInfo
142 -- hi-suffix for packages depends on the build tag.
144 do tag <- readIORef v_Build_tag
147 else return (tag ++ "_hi")
148 let imp_dirs = concatMap (\ pkg -> map ((,) pkg) (import_dirs pkg)) pkgs
149 mod_str = moduleNameUserString mod_name
150 basename = map (\c -> if c == '.' then '/' else c) mod_str
152 mkPackageModule mod_name pkg mbFName path =
153 return ( mkModule mod_name (mkFastString (name pkg))
154 , ModuleLocation{ ml_hspp_file = Nothing
155 , ml_hs_file = mbFName
156 , ml_hi_file = path ++ '.':package_hisuf
157 , ml_obj_file = Nothing
162 ((package_hisuf,\ pkg fName path -> mkPackageModule mod_name pkg Nothing path) :
163 -- can packages contain hi-boots?
164 (if hiOnly then [] else
165 [ ("hs", \ pkg fName path -> mkPackageModule mod_name pkg (Just fName) path)
166 , ("lhs", \ pkg fName path -> mkPackageModule mod_name pkg (Just fName) path)
170 findPackageModule :: ModuleName -> IO (Maybe (Module, ModuleLocation))
171 findPackageModule mod_name = findPackageMod mod_name True
173 searchPathExts :: [(a, FilePath)]
175 -> [(String, a -> FilePath -> String -> IO (Module, ModuleLocation))]
176 -> IO (Maybe (Module, ModuleLocation))
177 searchPathExts path basename exts = search exts
179 search [] = return Nothing
180 search ((x,f):xs) = do
181 let fName = (basename ++ '.':x)
182 found <- findOnPath path fName
184 -- special case to avoid getting "./foo.<ext>" all the time
185 Just (v,".") -> fmap Just (f v fName basename)
186 Just (v,path) -> fmap Just (f v (path ++ '/':fName)
187 (path ++ '/':basename))
190 findOnPath :: [(a,String)] -> String -> IO (Maybe (a, FilePath))
191 findOnPath path s = loop path
193 loop [] = return Nothing
195 let file = d ++ '/':s
196 b <- doesFileExist file
197 if b then return (Just (a,d)) else loop ds