1 -----------------------------------------------------------------------------
2 -- $Id: DriverMkDepend.hs,v 1.31 2003/11/17 14:23:38 simonmar Exp $
6 -- (c) Simon Marlow 2000
8 -----------------------------------------------------------------------------
10 module DriverMkDepend (
11 doMkDependHSPhase, beginMkDependHS, endMkDependHS
14 #include "HsVersions.h"
16 import GetImports ( getImports )
20 import SysTools ( newTempName )
21 import qualified SysTools
22 import Module ( ModuleName, ModLocation(..),
23 moduleNameUserString, isHomeModule )
24 import Finder ( findModule, hiBootExt, hiBootVerExt,
26 import Util ( global )
29 import DATA_IOREF ( IORef, readIORef, writeIORef )
35 import Maybe ( isJust )
37 #if __GLASGOW_HASKELL__ <= 408
38 import Panic ( catchJust, ioErrors )
41 -------------------------------------------------------------------------------
45 GLOBAL_VAR(v_Dep_makefile, "Makefile", String);
46 GLOBAL_VAR(v_Dep_include_prelude, False, Bool);
47 GLOBAL_VAR(v_Dep_exclude_mods, ["GHC.Prim"], [String]);
48 GLOBAL_VAR(v_Dep_suffixes, [], [String]);
49 GLOBAL_VAR(v_Dep_warnings, True, Bool);
52 GLOBAL_VAR(v_Dep_makefile_hdl, error "dep_makefile_hdl", Maybe Handle);
53 GLOBAL_VAR(v_Dep_tmp_file, error "dep_tmp_file", String);
54 GLOBAL_VAR(v_Dep_tmp_hdl, error "dep_tmp_hdl", Handle);
55 GLOBAL_VAR(v_Dep_dir_contents, error "dep_dir_contents", [(String,[String])]);
57 depStartMarker = "# DO NOT DELETE: Beginning of Haskell dependencies"
58 depEndMarker = "# DO NOT DELETE: End of Haskell dependencies"
60 -- for compatibility with the old mkDependHS, we accept options of the form
61 -- -optdep-f -optdep.depend, etc.
63 [ ( "s", SepArg (add v_Dep_suffixes) )
64 , ( "f", SepArg (writeIORef v_Dep_makefile) )
65 , ( "w", NoArg (writeIORef v_Dep_warnings False) )
66 , ( "-include-prelude", NoArg (writeIORef v_Dep_include_prelude True) )
67 , ( "-exclude-module=", Prefix (add v_Dep_exclude_mods) )
68 , ( "x", Prefix (add v_Dep_exclude_mods) )
71 beginMkDependHS :: IO ()
74 -- slurp in the mkdependHS-style options
75 flags <- getStaticOpts v_Opt_dep
76 _ <- processArgs dep_opts flags []
78 -- open a new temp file in which to stuff the dependency info
80 dep_file <- newTempName "dep"
81 writeIORef v_Dep_tmp_file dep_file
82 tmp_hdl <- openFile dep_file WriteMode
83 writeIORef v_Dep_tmp_hdl tmp_hdl
86 makefile <- readIORef v_Dep_makefile
87 exists <- doesFileExist makefile
90 writeIORef v_Dep_makefile_hdl Nothing
94 makefile_hdl <- openFile makefile ReadMode
95 writeIORef v_Dep_makefile_hdl (Just makefile_hdl)
97 -- slurp through until we get the magic start string,
98 -- copying the contents into dep_makefile
100 l <- hGetLine makefile_hdl
101 if (l == depStartMarker)
103 else do hPutStrLn tmp_hdl l; slurp
105 -- slurp through until we get the magic end marker,
106 -- throwing away the contents
108 l <- hGetLine makefile_hdl
109 if (l == depEndMarker)
113 catchJust ioErrors slurp
114 (\e -> if isEOFError e then return () else ioError e)
115 catchJust ioErrors chuck
116 (\e -> if isEOFError e then return () else ioError e)
119 -- write the magic marker into the tmp file
120 hPutStrLn tmp_hdl depStartMarker
122 -- cache the contents of all the import directories, for future
124 import_dirs <- readIORef v_Import_paths
125 pkg_import_dirs <- getPackageImportPath
126 import_dir_contents <- mapM softGetDirectoryContents import_dirs
127 pkg_import_dir_contents <- mapM softGetDirectoryContents pkg_import_dirs
128 writeIORef v_Dep_dir_contents
129 (zip import_dirs import_dir_contents ++
130 zip pkg_import_dirs pkg_import_dir_contents)
135 doMkDependHSPhase basename suff input_fn
136 = do src <- readFile input_fn
137 let (import_sources, import_normals, mod_name) = getImports src
138 let orig_fn = basename ++ '.':suff
139 (_, location') <- mkHomeModLocation mod_name orig_fn
141 -- take -ohi into account if present
142 ohi <- readIORef v_Output_hi
143 let location | Just fn <- ohi = location'{ ml_hi_file = fn }
144 | otherwise = location'
146 deps_sources <- mapM (findDependency True orig_fn) import_sources
147 deps_normals <- mapM (findDependency False orig_fn) import_normals
148 let deps = deps_sources ++ deps_normals
150 osuf <- readIORef v_Object_suf
151 extra_suffixes <- readIORef v_Dep_suffixes
152 let suffixes = map (++ ('_':osuf)) extra_suffixes
153 obj_file = ml_obj_file location
154 objs = obj_file : map (replaceFilenameSuffix obj_file) suffixes
156 -- Handle for file that accumulates dependencies
157 hdl <- readIORef v_Dep_tmp_hdl
159 -- std dependency of the object(s) on the source file
160 hPutStrLn hdl (unwords (map escapeSpaces objs) ++ " : " ++
161 escapeSpaces (basename ++ '.':suff))
163 let genDep (dep, False {- not an hi file -}) =
164 hPutStrLn hdl (unwords (map escapeSpaces objs) ++ " : " ++
166 genDep (dep, True {- is an hi file -}) = do
167 hisuf <- readIORef v_Hi_suf
168 let dep_base = remove_suffix '.' dep
169 deps = (dep_base ++ hisuf)
170 : map (\suf -> dep_base ++ suf ++ '_':hisuf) extra_suffixes
171 -- length objs should be == length deps
172 sequence_ (zipWith (\o d -> hPutStrLn hdl (escapeSpaces o ++ " : " ++ escapeSpaces d)) objs deps)
174 sequence_ (map genDep [ d | Just d <- deps ])
177 -- add the lines to dep_makefile:
181 -- if the dependency is on something other than a .hi file:
182 -- this.o this.p_o ... : dep
184 -- if the import is {-# SOURCE #-}
185 -- this.o this.p_o ... : dep.hi-boot[-$vers]
188 -- this.o ... : dep.hi
189 -- this.p_o ... : dep.p_hi
192 -- (where .o is $osuf, and the other suffixes come from
193 -- the cmdline -s options).
197 endMkDependHS :: IO ()
199 makefile <- readIORef v_Dep_makefile
200 makefile_hdl <- readIORef v_Dep_makefile_hdl
201 tmp_file <- readIORef v_Dep_tmp_file
202 tmp_hdl <- readIORef v_Dep_tmp_hdl
204 -- write the magic marker into the tmp file
205 hPutStrLn tmp_hdl depEndMarker
211 -- slurp the rest of the original makefile and copy it into the output
217 catchJust ioErrors slurp
218 (\e -> if isEOFError e then return () else ioError e)
222 hClose tmp_hdl -- make sure it's flushed
224 -- Create a backup of the original makefile
225 when (isJust makefile_hdl)
226 (SysTools.copy ("Backing up " ++ makefile) makefile (makefile++".bak"))
228 -- Copy the new makefile in place
229 SysTools.copy "Installing new makefile" tmp_file makefile
232 findDependency :: Bool -> FilePath -> ModuleName -> IO (Maybe (String, Bool))
233 findDependency is_source src imp = do
234 excl_mods <- readIORef v_Dep_exclude_mods
235 include_prelude <- readIORef v_Dep_include_prelude
236 let imp_mod = moduleNameUserString imp
237 if imp_mod `elem` excl_mods
243 -- not in this package: we don't need a dependency
244 | not (isHomeModule mod) && not include_prelude
247 -- normal import: just depend on the .hi file
249 -> return (Just (ml_hi_file loc, not is_source))
251 -- if it's a source import, we want to generate a dependency
252 -- on the .hi-boot file, not the .hi file
254 -> let hi_file = ml_hi_file loc
255 boot_hi_file = replaceFilenameSuffix hi_file hiBootExt
256 boot_ver_hi_file = replaceFilenameSuffix hi_file hiBootVerExt
258 b <- doesFileExist boot_ver_hi_file
260 then return (Just (boot_ver_hi_file, not is_source))
262 b <- doesFileExist boot_hi_file
264 then return (Just (boot_hi_file, not is_source))
265 else return (Just (hi_file, not is_source))
267 Left _ -> throwDyn (ProgramError
268 (src ++ ": " ++ "can't locate import `" ++ imp_mod ++ "'" ++
269 if is_source then " (SOURCE import)" else ""))