2 % (c) The GRASP Project, Glasgow University, 1992-1996
4 \section[Rename]{Renaming and dependency analysis passes}
7 #include "HsVersions.h"
9 module Rename ( renameModule ) where
11 import PreludeGlaST ( thenPrimIO, newVar, MutableVar(..) )
16 import RdrHsSyn ( RdrNameHsModule(..), RdrNameImportDecl(..) )
17 import RnHsSyn ( RnName(..){-.. is for Ix hack only-}, RenamedHsModule(..), isRnTyConOrClass, isRnWired )
19 --ToDo:rm: all for debugging only
27 import Util (pprPanic, pprTrace)
29 import ParseUtils ( ParsedIface(..), RdrIfaceDecl(..), RdrIfaceInst(..),
30 UsagesMap(..), VersionsMap(..)
33 import RnNames ( getGlobalNames, GlobalNameInfo(..) )
34 import RnSource ( rnSource )
35 import RnIfaces ( rnIfaces )
36 import RnUtils ( RnEnv(..), extendGlobalRnEnv, emptyRnEnv )
38 import Bag ( isEmptyBag, unionBags, unionManyBags, bagToList, listToBag )
39 import CmdLineOpts ( opt_HiMap, opt_NoImplicitPrelude )
40 import ErrUtils ( Error(..), Warning(..) )
41 import FiniteMap ( emptyFM, eltsFM, fmToList, lookupFM{-ToDo:rm-} )
42 import Maybes ( catMaybes )
43 import Name ( isLocallyDefined, mkBuiltinName, Name, RdrName(..) )
44 import PrelInfo ( builtinNameInfo, BuiltinNames(..), BuiltinKeys(..) )
45 import PrelMods ( pRELUDE )
46 import Unique ( ixClassKey )
47 import UniqFM ( emptyUFM, lookupUFM, addListToUFM_C, eltsUFM )
48 import UniqSupply ( splitUniqSupply )
49 import Util ( panic, assertPanic )
53 renameModule :: UniqSupply
56 -> IO (RenamedHsModule, -- output, after renaming
57 RnEnv, -- final env (for renaming derivings)
58 [Module], -- imported modules; for profiling
61 VersionsMap, -- version info; for usage
62 [Module]), -- instance modules; for iface
68 ToDo: May want to arrange to return old interface for this module!
69 ToDo: Deal with instances (instance version, this module on instance list ???)
72 renameModule us input@(HsModule mod _ _ imports _ _ _ _ _ _ _ _ _ _)
75 (b_names, b_keys, _) = builtinNameInfo
76 pp_pair (n,m) = ppBesides [ppPStr m,ppChar '.',ppPStr n]
79 pprTrace "builtins:\n" (case b_names of { (builtin_ids, builtin_tcs) ->
80 ppAboves [ ppCat (map pp_pair (keysFM builtin_ids))
81 , ppCat (map pp_pair (keysFM builtin_tcs))
82 , ppCat (map pp_pair (keysFM b_keys))
85 makeHiMap opt_HiMap >>= \ hi_files ->
86 -- pprTrace "HiMap:\n" (ppAboves [ ppCat [ppPStr m, ppStr p] | (m,p) <- fmToList hi_files])
87 newVar (emptyFM,emptyFM,hi_files){-init iface cache-} `thenPrimIO` \ iface_cache ->
89 fixIO ( \ ~(_, _, _, _, rec_occ_fm, rec_export_fn) ->
91 rec_occ_fn :: Name -> [RdrName]
92 rec_occ_fn n = case lookupUFM rec_occ_fm n of
94 Just (rn,occs) -> occs
96 global_name_info = (b_names, b_keys, rec_export_fn, rec_occ_fn)
98 getGlobalNames iface_cache global_name_info us1 input >>=
99 \ (occ_env, imp_mods, unqual_imps, imp_fixes, top_errs, top_warns) ->
101 if not (isEmptyBag top_errs) then
102 return (rn_panic, rn_panic, top_errs, top_warns, emptyUFM, rn_panic)
105 -- No top-level name errors so rename source ...
106 case initRn True mod occ_env us2
107 (rnSource imp_mods unqual_imps imp_fixes input) of {
108 ((rn_module, export_fn, src_occs), src_errs, src_warns) ->
110 --pprTrace "renameModule:" (ppCat (map (ppr PprDebug . fst) (bagToList src_occs))) $
113 occ_fm :: UniqFM (RnName, [RdrName])
115 occ_list = [ (rn,(rn,[occ])) | (rn,occ) <- bagToList src_occs]
116 occ_fm = addListToUFM_C insert_occ emptyUFM occ_list
118 insert_occ (rn,olds) (rn',[new]) = (rn, insert new olds)
120 insert new [] = [new]
121 insert new xxs@(x:xs) = case cmp new x of LT_ -> new : xxs
123 GT__ -> x : insert new xs
125 occ_warns = map multipleOccWarn (filter multiple_occs (eltsUFM occ_fm))
126 multiple_occs (rn, (o1:o2:_)) = True
127 multiple_occs _ = False
129 return (rn_module, imp_mods,
130 top_errs `unionBags` src_errs,
131 top_warns `unionBags` src_warns `unionBags` listToBag occ_warns,
134 }) >>= \ (rn_module, imp_mods, errs_so_far, warns_so_far, occ_fm, _) ->
136 if not (isEmptyBag errs_so_far) then
137 return (rn_panic, rn_panic, rn_panic, rn_panic, errs_so_far, warns_so_far)
140 -- No errors renaming source so rename the interfaces ...
142 -- split up all names that occurred in the source; between
143 -- those that are defined therein and those merely mentioned.
144 -- We also divide by tycon/class and value names (as usual).
146 occ_rns = [ rn | (rn,_) <- eltsUFM occ_fm ]
147 -- all occurrence names, from this module and imported
149 (defined_here, defined_elsewhere)
150 = partition isLocallyDefined occ_rns
153 = partition isRnWired defined_elsewhere
155 (def_tcs, def_vals) = partition isRnTyConOrClass defined_here
156 (occ_tcs, occ_vals) = partition isRnTyConOrClass occ_rns
157 -- the occ stuff includes *all* occurrences,
158 -- including those for which we have definitions
160 (orig_def_env, orig_def_dups)
161 = extendGlobalRnEnv emptyRnEnv (map pair_orig def_vals)
162 (map pair_orig def_tcs)
163 (orig_occ_env, orig_occ_dups)
164 = extendGlobalRnEnv emptyRnEnv (map pair_orig occ_vals)
165 (map pair_orig occ_tcs)
167 pair_orig rn = (origName rn, rn)
170 | opt_NoImplicitPrelude
171 = [{-no Prelude.hi, no point looking-}]
173 = [ name_fn (mkBuiltinName u mod str)
174 | ((str, mod), (u, name_fn)) <- fmToList b_keys,
175 str `notElem` [ SLIT("main"), SLIT("mainPrimIO")] ]
177 -- ASSERT (isEmptyBag orig_occ_dups)
178 (if (isEmptyBag orig_occ_dups) then \x->x
179 else pprTrace "orig_occ_dups:" (ppAboves [ ppCat [ppr PprDebug m, ppr PprDebug n, ppr PprDebug o] | (m,n,o) <- bagToList orig_occ_dups])) $
180 ASSERT (isEmptyBag orig_def_dups)
182 rnIfaces iface_cache imp_mods us3 orig_def_env orig_occ_env
183 rn_module (must_haves ++ imports_used) >>=
184 \ (rn_module_with_imports, final_env,
185 (implicit_val_fm, implicit_tc_fm),
187 (iface_errs, iface_warns)) ->
189 return (rn_module_with_imports,
193 errs_so_far `unionBags` iface_errs,
194 warns_so_far `unionBags` iface_warns)
196 rn_panic = panic "renameModule: aborted with errors"
198 (us1, us') = splitUniqSupply us
199 (us2, us3) = splitUniqSupply us'
203 makeHiMap :: Maybe String -> IO (FiniteMap Module FilePath)
205 makeHiMap Nothing = error "Rename.makeHiMap:no .hi map given by the GHC driver (?)"
207 = readFile f >>= \ cts ->
208 return (snag_mod emptyFM cts [])
210 -- we alternate between "snag"ging mod(ule names) and path(names),
211 -- accumulating names (reversed) and the final resulting map
214 snag_mod map [] [] = map
215 snag_mod map (' ':cs) rmod = snag_path map (_PK_ (reverse rmod)) cs []
216 snag_mod map (c:cs) rmod = snag_mod map cs (c:rmod)
218 snag_path map mod [] rpath = addToFM map mod (reverse rpath)
219 snag_path map mod ('\n':cs) rpath = snag_mod (addToFM map mod (reverse rpath)) cs []
220 snag_path map mod (c:cs) rpath = snag_path map mod cs (c:rpath)
223 Warning message used herein:
225 multipleOccWarn (name, occs) sty
226 = ppBesides [ppStr "warning:multiple names used to refer to `", ppr sty name, ppStr "': ",
227 ppInterleave ppComma (map (ppr sty) occs)]
232 pprPIface (ParsedIface m ms v mv usgs lcm exm ims lfx ltdm lvdm lids ldp)
234 ppCat [ppPStr SLIT("interface"), ppPStr m, ppInt v,
235 case mv of { Nothing -> ppNil; Just n -> ppInt n }],
237 ppPStr SLIT("__versions__"),
238 ppAboves [ ppCat[ppPStr n, ppInt v] | (n,v) <- fmToList lcm ],
240 ppPStr SLIT("__exports__"),
241 ppAboves [ ppBesides[ppPStr n, ppSP, ppr PprDebug rn,
242 case ex of {ExportAll -> ppStr "(..)"; _ -> ppNil}]
243 | (n,(rn,ex)) <- fmToList exm ],
245 pp_ims (bagToList ims),
248 pp_insts (bagToList lids),
253 pp_ims ms = ppAbove (ppPStr SLIT("__instance_modules__"))
254 (ppCat (map ppPStr ms))
257 | isEmptyFM fx = ppNil
258 | otherwise = ppAboves (ppPStr SLIT("__fixities__")
259 : [ ppr PprDebug fix | (n, fix) <- fmToList fx])
261 pp_decls tds vds = ppAboves (ppPStr SLIT("__declarations__")
262 : [ pprRdrIfaceDecl d | (n, d) <- fmToList tds ++ fmToList vds])
265 pp_insts is = ppAboves (ppPStr SLIT("__instances__")
266 : [ pprRdrInstDecl i | i <- is])
268 pp_pragmas ps | isEmptyFM ps = ppNil
269 | otherwise = panic "Rename.pp_pragmas"
271 pprRdrIfaceDecl (TypeSig tc _ decl)
272 = ppBesides [ppStr "tycon=", ppr PprDebug tc, ppStr "; ", ppr PprDebug decl]
274 pprRdrIfaceDecl (NewTypeSig tc dc _ decl)
275 = ppBesides [ppStr "tycon=", ppr PprDebug tc, ppStr "; datacon=", ppr PprDebug dc,
276 ppStr "; ", ppr PprDebug decl]
278 pprRdrIfaceDecl (DataSig tc dcs dfs _ decl)
279 = ppBesides [ppStr "tycon=", ppr PprDebug tc, ppStr "; datacons=", ppr PprDebug dcs,
280 ppStr "; fields=", ppr PprDebug dfs, ppStr "; ", ppr PprDebug decl]
282 pprRdrIfaceDecl (ClassSig c ops _ decl)
283 = ppBesides [ppStr "class=", ppr PprDebug c, ppStr "; ops=", ppr PprDebug ops,
284 ppStr "; ", ppr PprDebug decl]
286 pprRdrIfaceDecl (ValSig f _ ty)
287 = ppBesides [ppr PprDebug f, ppStr " :: ", ppr PprDebug ty]
289 pprRdrInstDecl (InstSig c t _ decl)
290 = ppBesides [ppStr "class=", ppr PprDebug c, ppStr " type=", ppr PprDebug t, ppStr "; ",