2 % (c) The GRASP Project, Glasgow University, 1992-1998
4 \section[Rename]{Renaming and dependency analysis passes}
7 module Rename ( renameModule ) where
9 #include "HsVersions.h"
12 import RdrHsSyn ( RdrNameHsModule )
13 import RnHsSyn ( RenamedHsModule, RenamedHsDecl,
14 extractHsTyNames, extractHsCtxtTyNames
17 import CmdLineOpts ( opt_HiMap, opt_D_dump_rn_trace,
18 opt_D_dump_rn, opt_D_dump_rn_stats,
19 opt_WarnUnusedBinds, opt_WarnUnusedImports
22 import RnNames ( getGlobalNames )
23 import RnSource ( rnSourceDecls, rnDecl )
24 import RnIfaces ( getImportedInstDecls, importDecl, getImportVersions,
25 getImportedRules, loadHomeInterface, getSlurped, removeContext
27 import RnEnv ( availName, availNames, availsToNameSet,
28 warnUnusedImports, warnUnusedLocalBinds, mapFvRn, lookupImplicitOccRn,
29 FreeVars, plusFVs, plusFV, unitFV, emptyFVs, isEmptyFVs
31 import Module ( Module, ModuleName, pprModule, mkSearchPath, mkThisModule )
32 import Name ( Name, isLocallyDefined,
33 NamedThing(..), ImportReason(..), Provenance(..),
34 pprOccName, nameOccName, nameUnique,
35 getNameProvenance, isUserImportedExplicitlyName,
36 maybeWiredInTyConName, maybeWiredInIdName, isWiredInName
39 import DataCon ( dataConTyCon, dataConType )
40 import TyCon ( TyCon, tyConDataCons, isSynTyCon, getSynTyConDefn )
41 import RdrName ( RdrName )
43 import PrelMods ( mAIN_Name, pREL_MAIN_Name )
44 import TysWiredIn ( unitTyCon, intTyCon, doubleTyCon, boolTyCon )
45 import PrelInfo ( ioTyCon_NAME, thinAirIdNames, fractionalClassKeys, derivingOccurrences )
46 import Type ( namesOfType, funTyCon )
47 import ErrUtils ( printErrorsAndWarnings, dumpIfSet, ghcExit )
48 import BasicTypes ( NewOrData(..) )
49 import Bag ( isEmptyBag, bagToList )
50 import FiniteMap ( fmToList, delListFromFM, addToFM, sizeFM, eltsFM )
51 import UniqSupply ( UniqSupply )
52 import UniqFM ( lookupUFM )
53 import Util ( equivClasses )
54 import Maybes ( maybeToBool )
55 import SrcLoc ( mkBuiltinSrcLoc )
62 renameModule :: UniqSupply
66 , RenamedHsModule -- Output, after renaming
67 , InterfaceDetails -- Interface; for interface file generation
68 , RnNameSupply -- Final env; for renaming derivings
69 , [ModuleName] -- Imported modules; for profiling
72 renameModule us this_mod@(HsModule mod_name vers exports imports local_decls loc)
73 = -- Initialise the renamer monad
74 initRn mod_name us (mkSearchPath opt_HiMap) loc
76 \ ((maybe_rn_stuff, dump_action), rn_errs_bag, rn_warns_bag) ->
79 printErrorsAndWarnings rn_errs_bag rn_warns_bag >>
81 -- Dump any debugging output
85 if not (isEmptyBag rn_errs_bag) then
86 ghcExit 1 >> return Nothing
93 rename this_mod@(HsModule mod_name vers _ imports local_decls loc)
94 = -- FIND THE GLOBAL NAME ENVIRONMENT
95 getGlobalNames this_mod `thenRn` \ maybe_stuff ->
97 -- CHECK FOR EARLY EXIT
98 if not (maybeToBool maybe_stuff) then
99 -- Everything is up to date; no need to recompile further
100 rnDump [] [] `thenRn` \ dump_action ->
101 returnRn (Nothing, dump_action)
104 Just (export_env, gbl_env, fixity_env, global_avail_env) = maybe_stuff
108 initRnMS gbl_env fixity_env SourceMode (
109 rnSourceDecls local_decls
110 ) `thenRn` \ (rn_local_decls, source_fvs) ->
112 -- SLURP IN ALL THE NEEDED DECLARATIONS
113 implicitFVs mod_name rn_local_decls `thenRn` \ implicit_fvs ->
115 real_source_fvs = implicit_fvs `plusFV` source_fvs
116 -- It's important to do the "plus" this way round, so that
117 -- when compiling the prelude, locally-defined (), Bool, etc
118 -- override the implicit ones.
120 slurpImpDecls real_source_fvs `thenRn` \ rn_imp_decls ->
122 rn_all_decls = rn_local_decls ++ rn_imp_decls
125 -- EXIT IF ERRORS FOUND
126 checkErrsRn `thenRn` \ no_errs_so_far ->
127 if not no_errs_so_far then
128 -- Found errors already, so exit now
129 rnDump rn_imp_decls rn_all_decls `thenRn` \ dump_action ->
130 returnRn (Nothing, dump_action)
133 -- GENERATE THE VERSION/USAGE INFO
134 getImportVersions mod_name export_env `thenRn` \ my_usages ->
135 getNameSupplyRn `thenRn` \ name_supply ->
137 -- REPORT UNUSED NAMES
138 reportUnusedNames gbl_env global_avail_env
142 -- RETURN THE RENAMED MODULE
144 has_orphans = any isOrphanDecl rn_local_decls
145 direct_import_mods = [mod | ImportDecl mod _ _ _ _ _ <- imports]
146 renamed_module = HsModule mod_name vers
147 trashed_exports trashed_imports
151 rnDump rn_imp_decls rn_all_decls `thenRn` \ dump_action ->
152 returnRn (Just (mkThisModule mod_name,
154 (has_orphans, my_usages, export_env),
156 direct_import_mods), dump_action)
158 trashed_exports = {-trace "rnSource:trashed_exports"-} Nothing
159 trashed_imports = {-trace "rnSource:trashed_imports"-} []
162 @implicitFVs@ forces the renamer to slurp in some things which aren't
163 mentioned explicitly, but which might be needed by the type checker.
166 implicitFVs mod_name decls
167 = mapRn lookupImplicitOccRn implicit_occs `thenRn` \ implicit_names ->
168 returnRn (implicit_main `plusFV`
169 mkNameSet (map getName default_tycons) `plusFV`
170 mkNameSet thinAirIdNames `plusFV`
171 mkNameSet implicit_names)
173 -- Add occurrences for Int, and (), because they
174 -- are the types to which ambigious type variables may be defaulted by
175 -- the type checker; so they won't always appear explicitly.
176 -- [The () one is a GHC extension for defaulting CCall results.]
177 -- ALSO: funTyCon, since it occurs implicitly everywhere!
178 -- (we don't want to be bothered with making funTyCon a
179 -- free var at every function application!)
180 -- Double is dealt with separately in getGates
181 default_tycons = [unitTyCon, funTyCon, boolTyCon, intTyCon]
183 -- Add occurrences for IO or PrimIO
184 implicit_main | mod_name == mAIN_Name
185 || mod_name == pREL_MAIN_Name = unitFV ioTyCon_NAME
186 | otherwise = emptyFVs
188 -- Now add extra "occurrences" for things that
189 -- the deriving mechanism, or defaulting, will later need in order to
191 implicit_occs = foldr ((++) . get) [] decls
193 get (TyClD (TyData _ _ _ _ _ (Just deriv_classes) _ _))
194 = concat (map get_deriv deriv_classes)
197 get_deriv cls = case lookupUFM derivingOccurrences cls of
203 isOrphanDecl (InstD (InstDecl inst_ty _ _ _ _))
204 = not (foldNameSet ((||) . isLocallyDefined) False (extractHsTyNames (removeContext inst_ty)))
205 -- The 'removeContext' is because of
206 -- instance Foo a => Baz T where ...
207 -- The decl is an orphan if Baz and T are both not locally defined,
208 -- even if Foo *is* locally defined
210 isOrphanDecl (RuleD (RuleDecl _ _ _ lhs _ _))
213 -- At the moment we just check for common LHS forms
214 -- Expand as necessary. Getting it wrong just means
215 -- more orphans than necessary
216 check (HsVar v) = not (isLocallyDefined v)
217 check (HsApp f a) = check f && check a
218 check (HsLit _) = False
219 check (OpApp l o _ r) = check l && check o && check r
220 check (NegApp e _) = check e
221 check (HsPar e) = check e
222 check (SectionL e o) = check e && check o
223 check (SectionR o e) = check e && check o
225 check other = True -- Safe fall through
227 isOrphanDecl other = False
232 dupDefaultDeclErrRn (DefaultDecl _ locn1 : dup_things)
233 = pushSrcLocRn locn1 $
236 msg = hang (ptext SLIT("Multiple default declarations"))
237 4 (vcat (map pp dup_things))
238 pp (DefaultDecl _ locn) = ptext SLIT("here was another default declaration") <+> ppr locn
242 %*********************************************************
244 \subsection{Slurping declarations}
246 %*********************************************************
249 -------------------------------------------------------
250 slurpImpDecls source_fvs
251 = traceRn (text "slurpImp" <+> fsep (map ppr (nameSetToList source_fvs))) `thenRn_`
253 -- The current slurped-set records all local things
254 getSlurped `thenRn` \ source_binders ->
255 slurpSourceRefs source_binders source_fvs `thenRn` \ (decls, needed) ->
257 -- And finally get everything else
258 closeDecls decls needed
260 -------------------------------------------------------
261 slurpSourceRefs :: NameSet -- Variables defined in source
262 -> FreeVars -- Variables referenced in source
263 -> RnMG ([RenamedHsDecl],
264 FreeVars) -- Un-satisfied needs
265 -- The declaration (and hence home module) of each gate has
266 -- already been loaded
268 slurpSourceRefs source_binders source_fvs
269 = go_outer [] -- Accumulating decls
270 emptyFVs -- Unsatisfied needs
271 emptyFVs -- Accumulating gates
272 (nameSetToList source_fvs) -- Things whose defn hasn't been loaded yet
274 -- The outer loop repeatedly slurps the decls for the current gates
275 -- and the instance decls
277 -- The outer loop is needed because consider
278 -- instance Foo a => Baz (Maybe a) where ...
279 -- It may be that @Baz@ and @Maybe@ are used in the source module,
280 -- but not @Foo@; so we need to chase @Foo@ too.
282 -- We also need to follow superclass refs. In particular, 'chasing @Foo@' must
283 -- include actually getting in Foo's class decl
284 -- class Wib a => Foo a where ..
285 -- so that its superclasses are discovered. The point is that Wib is a gate too.
286 -- We do this for tycons too, so that we look through type synonyms.
288 go_outer decls fvs all_gates []
289 = returnRn (decls, fvs)
291 go_outer decls fvs all_gates refs -- refs are not necessarily slurped yet
292 = traceRn (text "go_outer" <+> ppr refs) `thenRn_`
293 go_inner decls fvs emptyFVs refs `thenRn` \ (decls1, fvs1, gates1) ->
294 getImportedInstDecls (all_gates `plusFV` gates1) `thenRn` \ inst_decls ->
295 rnInstDecls decls1 fvs1 gates1 inst_decls `thenRn` \ (decls2, fvs2, gates2) ->
296 go_outer decls2 fvs2 (all_gates `plusFV` gates2)
297 (nameSetToList (gates2 `minusNameSet` all_gates))
298 -- Knock out the all_gates because even if we don't slurp any new
299 -- decls we can get some apparently-new gates from wired-in names
301 go_inner decls fvs gates []
302 = returnRn (decls, fvs, gates)
304 go_inner decls fvs gates (wanted_name:refs)
305 | isWiredInName wanted_name
306 = load_home wanted_name `thenRn_`
307 go_inner decls fvs (gates `plusFV` getWiredInGates wanted_name) refs
310 = importDecl wanted_name `thenRn` \ maybe_decl ->
312 Nothing -> go_inner decls fvs gates refs -- No declaration... (already slurped, or local)
313 Just decl -> rnIfaceDecl decl `thenRn` \ (new_decl, fvs1) ->
314 go_inner (new_decl : decls)
316 (gates `plusFV` getGates source_fvs new_decl)
319 -- When we find a wired-in name we must load its
320 -- home module so that we find any instance decls therein
322 | name `elemNameSet` source_binders = returnRn ()
323 -- When compiling the prelude, a wired-in thing may
324 -- be defined in this module, in which case we don't
325 -- want to load its home module!
326 -- Using 'isLocallyDefined' doesn't work because some of
327 -- the free variables returned are simply 'listTyCon_Name',
328 -- with a system provenance. We could look them up every time
329 -- but that seems a waste.
330 | otherwise = loadHomeInterface doc name `thenRn_`
333 doc = ptext SLIT("need home module for wired in thing") <+> ppr name
335 rnInstDecls decls fvs gates []
336 = returnRn (decls, fvs, gates)
337 rnInstDecls decls fvs gates (d:ds)
338 = rnIfaceDecl d `thenRn` \ (new_decl, fvs1) ->
339 rnInstDecls (new_decl:decls)
341 (gates `plusFV` getInstDeclGates new_decl)
347 -------------------------------------------------------
348 -- closeDecls keeps going until the free-var set is empty
349 closeDecls decls needed
350 | not (isEmptyFVs needed)
351 = slurpDecls decls needed `thenRn` \ (decls1, needed1) ->
352 closeDecls decls1 needed1
355 = getImportedRules `thenRn` \ rule_decls ->
357 [] -> returnRn decls -- No new rules, so we are done
358 other -> rnIfaceDecls decls emptyFVs rule_decls `thenRn` \ (decls1, needed1) ->
359 closeDecls decls1 needed1
362 -------------------------------------------------------
363 rnIfaceDecls :: [RenamedHsDecl] -> FreeVars
364 -> [(Module, RdrNameHsDecl)]
365 -> RnM d ([RenamedHsDecl], FreeVars)
366 rnIfaceDecls decls fvs [] = returnRn (decls, fvs)
367 rnIfaceDecls decls fvs (d:ds) = rnIfaceDecl d `thenRn` \ (new_decl, fvs1) ->
368 rnIfaceDecls (new_decl:decls) (fvs1 `plusFV` fvs) ds
370 rnIfaceDecl (mod, decl) = initIfaceRnMS mod (rnDecl decl)
373 -------------------------------------------------------
374 -- Augment decls with any decls needed by needed.
375 -- Return also free vars of the new decls (only)
376 slurpDecls decls needed
377 = go decls emptyFVs (nameSetToList needed)
379 go decls fvs [] = returnRn (decls, fvs)
380 go decls fvs (ref:refs) = slurpDecl decls fvs ref `thenRn` \ (decls1, fvs1) ->
383 -------------------------------------------------------
384 slurpDecl decls fvs wanted_name
385 = importDecl wanted_name `thenRn` \ maybe_decl ->
387 -- No declaration... (wired in thing)
388 Nothing -> returnRn (decls, fvs)
390 -- Found a declaration... rename it
391 Just decl -> rnIfaceDecl decl `thenRn` \ (new_decl, fvs1) ->
392 returnRn (new_decl:decls, fvs1 `plusFV` fvs)
396 %*********************************************************
398 \subsection{Extracting the `gates'}
400 %*********************************************************
402 When we import a declaration like
404 data T = T1 Wibble | T2 Wobble
406 we don't want to treat @Wibble@ and @Wobble@ as gates
407 {\em unless} @T1@, @T2@ respectively are mentioned by the user program.
408 If only @T@ is mentioned
409 we want only @T@ to be a gate;
410 that way we don't suck in useless instance
411 decls for (say) @Eq Wibble@, when they can't possibly be useful.
413 @getGates@ takes a newly imported (and renamed) decl, and the free
414 vars of the source program, and extracts from the decl the gate names.
417 getGates source_fvs (SigD (IfaceSig _ ty _ _))
418 = extractHsTyNames ty
420 getGates source_fvs (TyClD (ClassDecl ctxt cls tvs _ sigs _ _ _ _ _ _))
421 = (delListFromNameSet (foldr (plusFV . get) (extractHsCtxtTyNames ctxt) sigs)
422 (map getTyVarName tvs)
423 `addOneToNameSet` cls)
424 `plusFV` maybe_double
426 get (ClassOpSig n _ _ ty _)
427 | n `elemNameSet` source_fvs = extractHsTyNames ty
428 | otherwise = emptyFVs
430 -- If we load any numeric class that doesn't have
431 -- Int as an instance, add Double to the gates.
432 -- This takes account of the fact that Double might be needed for
433 -- defaulting, but we don't want to load Double (and all its baggage)
434 -- if the more exotic classes aren't used at all.
435 maybe_double | nameUnique cls `elem` fractionalClassKeys
436 = unitFV (getName doubleTyCon)
440 getGates source_fvs (TyClD (TySynonym tycon tvs ty _))
441 = delListFromNameSet (extractHsTyNames ty)
442 (map getTyVarName tvs)
443 -- A type synonym type constructor isn't a "gate" for instance decls
445 getGates source_fvs (TyClD (TyData _ ctxt tycon tvs cons _ _ _))
446 = delListFromNameSet (foldr (plusFV . get) (extractHsCtxtTyNames ctxt) cons)
447 (map getTyVarName tvs)
448 `addOneToNameSet` tycon
450 get (ConDecl n tvs ctxt details _)
451 | n `elemNameSet` source_fvs
452 -- If the constructor is method, get fvs from all its fields
453 = delListFromNameSet (get_details details `plusFV`
454 extractHsCtxtTyNames ctxt)
455 (map getTyVarName tvs)
456 get (ConDecl n tvs ctxt (RecCon fields) _)
457 -- Even if the constructor isn't mentioned, the fields
458 -- might be, as selectors. They can't mention existentially
459 -- bound tyvars (typechecker checks for that) so no need for
460 -- the deleteListFromNameSet part
461 = foldr (plusFV . get_field) emptyFVs fields
463 get other_con = emptyFVs
465 get_details (VanillaCon tys) = plusFVs (map get_bang tys)
466 get_details (InfixCon t1 t2) = get_bang t1 `plusFV` get_bang t2
467 get_details (RecCon fields) = plusFVs [get_bang t | (_, t) <- fields]
468 get_details (NewCon t _) = extractHsTyNames t
470 get_field (fs,t) | any (`elemNameSet` source_fvs) fs = get_bang t
471 | otherwise = emptyFVs
473 get_bang (Banged t) = extractHsTyNames t
474 get_bang (Unbanged t) = extractHsTyNames t
475 get_bang (Unpacked t) = extractHsTyNames t
477 getGates source_fvs other_decl = emptyFVs
480 @getWiredInGates@ is just like @getGates@, but it sees a wired-in @Name@
481 rather than a declaration.
484 getWiredInGates :: Name -> FreeVars
485 getWiredInGates name -- No classes are wired in
486 | is_id = getWiredInGates_s (namesOfType (idType the_id))
487 | isSynTyCon the_tycon = getWiredInGates_s
488 (delListFromNameSet (namesOfType ty) (map getName tyvars))
489 | otherwise = unitFV name
491 maybe_wired_in_id = maybeWiredInIdName name
492 is_id = maybeToBool maybe_wired_in_id
493 maybe_wired_in_tycon = maybeWiredInTyConName name
494 Just the_id = maybe_wired_in_id
495 Just the_tycon = maybe_wired_in_tycon
496 (tyvars,ty) = getSynTyConDefn the_tycon
498 getWiredInGates_s names = foldr (plusFV . getWiredInGates) emptyFVs (nameSetToList names)
502 getInstDeclGates (InstD (InstDecl inst_ty _ _ _ _)) = extractHsTyNames inst_ty
503 getInstDeclGates other = emptyFVs
507 %*********************************************************
509 \subsection{Unused names}
511 %*********************************************************
514 reportUnusedNames gbl_env avail_env (ExportEnv export_avails _ _) mentioned_names
516 used_names = mentioned_names `unionNameSets` availsToNameSet export_avails
518 -- Now, a use of C implies a use of T,
519 -- if C was brought into scope by T(..) or T(C)
520 really_used_names = used_names `unionNameSets`
521 mkNameSet [ availName avail
522 | sub_name <- nameSetToList used_names,
523 let avail = case lookupNameEnv avail_env sub_name of
525 Nothing -> WARN( True, text "reportUnusedName: not in avail_env" <+> ppr sub_name )
529 defined_names = mkNameSet (concat (rdrEnvElts gbl_env))
530 defined_but_not_used =
531 nameSetToList (defined_names `minusNameSet` really_used_names)
533 -- Filter out the ones only defined implicitly
534 bad_locals = [n | n <- defined_but_not_used, isLocallyDefined n]
535 bad_imps = [n | n <- defined_but_not_used, isUserImportedExplicitlyName n]
537 warnUnusedLocalBinds bad_locals `thenRn_`
538 warnUnusedImports bad_imps
540 rnDump :: [RenamedHsDecl] -- Renamed imported decls
541 -> [RenamedHsDecl] -- Renamed local decls
543 rnDump imp_decls decls
544 | opt_D_dump_rn_trace ||
545 opt_D_dump_rn_stats ||
547 = getRnStats imp_decls `thenRn` \ stats_msg ->
549 returnRn (printErrs stats_msg >>
550 dumpIfSet opt_D_dump_rn "Renamer:" (vcat (map ppr decls)))
552 | otherwise = returnRn (return ())
556 %*********************************************************
558 \subsection{Statistics}
560 %*********************************************************
563 getRnStats :: [RenamedHsDecl] -> RnMG SDoc
564 getRnStats imported_decls
565 = getIfacesRn `thenRn` \ ifaces ->
567 n_mods = length [() | (_, _, Just _) <- eltsFM (iImpModInfo ifaces)]
569 decls_read = [decl | (_, avail, True, (_,decl)) <- nameEnvElts (iDecls ifaces),
570 -- Data, newtype, and class decls are in the decls_fm
571 -- under multiple names; the tycon/class, and each
572 -- constructor/class op too.
573 -- The 'True' selects just the 'main' decl
574 not (isLocallyDefined (availName avail))
577 (cd_rd, dd_rd, nd_rd, sd_rd, vd_rd, _) = count_decls decls_read
578 (cd_sp, dd_sp, nd_sp, sd_sp, vd_sp, id_sp) = count_decls imported_decls
580 unslurped_insts = iInsts ifaces
581 inst_decls_unslurped = length (bagToList unslurped_insts)
582 inst_decls_read = id_sp + inst_decls_unslurped
585 [int n_mods <+> text "interfaces read",
586 hsep [ int cd_sp, text "class decls imported, out of",
587 int cd_rd, text "read"],
588 hsep [ int dd_sp, text "data decls imported, out of",
589 int dd_rd, text "read"],
590 hsep [ int nd_sp, text "newtype decls imported, out of",
591 int nd_rd, text "read"],
592 hsep [int sd_sp, text "type synonym decls imported, out of",
593 int sd_rd, text "read"],
594 hsep [int vd_sp, text "value signatures imported, out of",
595 int vd_rd, text "read"],
596 hsep [int id_sp, text "instance decls imported, out of",
597 int inst_decls_read, text "read"],
598 text "cls dcls slurp" <+> fsep (map (ppr . tyClDeclName)
599 [d | TyClD d <- imported_decls, isClassDecl d]),
600 text "cls dcls read" <+> fsep (map (ppr . tyClDeclName)
601 [d | TyClD d <- decls_read, isClassDecl d])]
603 returnRn (hcat [text "Renamer stats: ", stats])
613 tycl_decls = [d | TyClD d <- decls]
614 (class_decls, data_decls, newtype_decls, syn_decls) = countTyClDecls tycl_decls
616 val_decls = length [() | SigD _ <- decls]
617 inst_decls = length [() | InstD _ <- decls]