2 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
4 \section[RnIfaces]{Cacheing and Renaming of Interfaces}
10 getInterfaceExports, getDeferredDecls,
11 getImportedInstDecls, getImportedRules,
12 lookupFixityRn, loadHomeInterface,
13 importDecl, ImportDeclResult(..), recordLocalSlurps, loadBuiltinRules,
14 mkImportExportInfo, getSlurped,
16 checkModUsage, outOfDate, upToDate,
18 getDeclBinders, getDeclSysBinders,
19 removeContext -- removeContext probably belongs somewhere else
22 #include "HsVersions.h"
24 import CmdLineOpts ( opt_NoPruneDecls, opt_NoPruneTyDecls, opt_IgnoreIfacePragmas )
25 import HsSyn ( HsDecl(..), TyClDecl(..), InstDecl(..), IfaceSig(..),
26 HsType(..), ConDecl(..), IE(..), ConDetails(..), Sig(..),
27 ForeignDecl(..), ForKind(..), isDynamicExtName,
28 FixitySig(..), RuleDecl(..),
29 isClassOpSig, DeprecDecl(..)
31 import HsImpExp ( ieNames )
32 import CoreSyn ( CoreRule )
33 import BasicTypes ( Version, NewOrData(..) )
34 import RdrHsSyn ( RdrNameHsDecl, RdrNameInstDecl, RdrNameRuleDecl,
35 RdrNameDeprecation, RdrNameIE,
40 import ParseIface ( parseIface, IfaceStuff(..) )
42 import Name ( Name {-instance NamedThing-}, nameOccName,
43 nameModule, isLocallyDefined,
44 isWiredInName, NamedThing(..),
45 elemNameEnv, extendNameEnv
47 import Module ( Module, mkVanillaModule, pprModuleName,
48 moduleName, isLocalModule,
49 ModuleName, WhereFrom(..),
51 import RdrName ( RdrName, rdrNameOcc )
53 import SrcLoc ( mkSrcLoc, SrcLoc )
54 import PrelInfo ( cCallishTyKeys )
55 import Maybes ( maybeToBool )
56 import Unique ( Uniquable(..) )
57 import StringBuffer ( hGetStringBuffer )
58 import FastString ( mkFastString )
59 import ErrUtils ( Message )
60 import Util ( sortLt )
70 %*********************************************************
72 \subsection{Loading a new interface file}
74 %*********************************************************
77 loadHomeInterface :: SDoc -> Name -> RnM d Ifaces
78 loadHomeInterface doc_str name
79 = loadInterface doc_str (moduleName (nameModule name)) ImportBySystem
81 loadOrphanModules :: [ModuleName] -> RnM d ()
82 loadOrphanModules mods
83 | null mods = returnRn ()
84 | otherwise = traceRn (text "Loading orphan modules:" <+>
85 fsep (map pprModuleName mods)) `thenRn_`
86 mapRn_ load mods `thenRn_`
89 load mod = loadInterface (mk_doc mod) mod ImportBySystem
90 mk_doc mod = pprModuleName mod <+> ptext SLIT("is a orphan-instance module")
93 loadInterface :: SDoc -> ModuleName -> WhereFrom -> RnM d Ifaces
94 loadInterface doc mod from
95 = tryLoadInterface doc mod from `thenRn` \ (ifaces, maybe_err) ->
97 Nothing -> returnRn ifaces
98 Just err -> failWithRn ifaces err
100 tryLoadInterface :: SDoc -> ModuleName -> WhereFrom -> RnM d (Ifaces, Maybe Message)
101 -- Returns (Just err) if an error happened
102 -- Guarantees to return with iImpModInfo m --> (... Just cts)
103 -- (If the load fails, we plug in a vanilla placeholder
104 tryLoadInterface doc_str mod_name from
105 = getIfacesRn `thenRn` \ ifaces ->
107 mod_map = iImpModInfo ifaces
108 mod_info = lookupFM mod_map mod_name
110 hi_boot_file = case from of {
111 ImportByUser -> False ; -- Not hi-boot
112 ImportByUserSource -> True ; -- hi-boot
115 Just (_, is_boot, _) -> is_boot
118 -- We're importing a module we know absolutely
119 -- nothing about, so we assume it's from
120 -- another package, where we aren't doing
121 -- dependency tracking. So it won't be a hi-boot file.
123 redundant_source_import
124 = case (from, mod_info) of
125 (ImportByUserSource, Just (_,False,_)) -> True
128 -- CHECK WHETHER WE HAVE IT ALREADY
131 -> -- We're read it already so don't re-read it
132 returnRn (ifaces, Nothing) ;
136 -- Issue a warning for a redundant {- SOURCE -} import
137 -- NB that we arrange to read all the ordinary imports before
138 -- any of the {- SOURCE -} imports
139 warnCheckRn (not redundant_source_import)
140 (warnRedundantSourceImport mod_name) `thenRn_`
142 -- READ THE MODULE IN
143 findAndReadIface doc_str mod_name hi_boot_file `thenRn` \ read_result ->
144 case read_result of {
145 Left err -> -- Not found, so add an empty export env to the Ifaces map
146 -- so that we don't look again
148 mod = mkVanillaModule mod_name
149 new_mod_map = addToFM mod_map mod_name (False, False, Just (mod, 0, 0, 0, from, []))
150 new_ifaces = ifaces { iImpModInfo = new_mod_map }
152 setIfacesRn new_ifaces `thenRn_`
153 returnRn (new_ifaces, Just err) ;
158 -- LOAD IT INTO Ifaces
160 -- NB: *first* we do loadDecl, so that the provenance of all the locally-defined
161 --- names is done correctly (notably, whether this is an .hi file or .hi-boot file).
162 -- If we do loadExport first the wrong info gets into the cache (unless we
163 -- explicitly tag each export which seems a bit of a bore)
165 getModuleRn `thenRn` \ this_mod ->
169 -- Sanity check. If we're system-importing a module we know nothing at all
170 -- about, it should be from a different package to this one
171 WARN( not (maybeToBool mod_info) &&
172 case from of { ImportBySystem -> True; other -> False } &&
175 foldlRn (loadDecl mod) (iDecls ifaces) (pi_decls iface) `thenRn` \ new_decls ->
176 foldlRn (loadInstDecl mod) (iInsts ifaces) (pi_insts iface) `thenRn` \ new_insts ->
177 loadRules mod (iRules ifaces) (pi_rules iface) `thenRn` \ new_rules ->
178 loadFixDecls mod_name (iFixes ifaces) (pi_fixity iface) `thenRn` \ new_fixities ->
179 foldlRn (loadDeprec mod) (iDeprecs ifaces) (pi_deprecs iface) `thenRn` \ new_deprecs ->
180 mapRn (loadExport this_mod) (pi_exports iface) `thenRn` \ avails_s ->
182 -- For an explicit user import, add to mod_map info about
183 -- the things the imported module depends on, extracted
184 -- from its usage info.
185 mod_map1 = case from of
186 ImportByUser -> addModDeps mod (pi_usages iface) mod_map
189 -- Now add info about this module
190 mod_map2 = addToFM mod_map1 mod_name mod_details
191 cts = (pi_mod iface, pi_vers iface,
192 fst (pi_fixity iface), fst (pi_rules iface),
193 from, concat avails_s)
194 mod_details = (pi_orphan iface, hi_boot_file, Just cts)
196 new_ifaces = ifaces { iImpModInfo = mod_map2,
198 iFixes = new_fixities,
201 iDeprecs = new_deprecs }
203 setIfacesRn new_ifaces `thenRn_`
204 returnRn (new_ifaces, Nothing)
207 -----------------------------------------------------
208 -- Adding module dependencies from the
209 -- import decls in the interface file
210 -----------------------------------------------------
212 addModDeps :: Module -> [ImportVersion a]
213 -> ImportedModuleInfo -> ImportedModuleInfo
214 -- (addModDeps M ivs deps)
215 -- We are importing module M, and M.hi contains 'import' decls given by ivs
216 addModDeps mod new_deps mod_deps
217 = foldr add mod_deps filtered_new_deps
219 -- Don't record dependencies when importing a module from another package
220 -- Except for its descendents which contain orphans,
221 -- and in that case, forget about the boot indicator
223 | isLocalModule mod = [ (imp_mod, (has_orphans, is_boot, Nothing))
224 | (imp_mod, has_orphans, is_boot, _) <- new_deps
226 | otherwise = [ (imp_mod, (True, False, Nothing))
227 | (imp_mod, has_orphans, _, _) <- new_deps,
230 add (imp_mod, dep) deps = addToFM_C combine deps imp_mod dep
232 combine old@(_, old_is_boot, cts) new
233 | maybeToBool cts || not old_is_boot = old -- Keep the old info if it's already loaded
234 -- or if it's a non-boot pending load
235 | otherwise = new -- Otherwise pick new info
238 -----------------------------------------------------
239 -- Loading the export list
240 -----------------------------------------------------
242 loadExport :: Module -> ExportItem -> RnM d [AvailInfo]
243 loadExport this_mod (mod, entities)
244 | mod == moduleName this_mod = returnRn []
245 -- If the module exports anything defined in this module, just ignore it.
246 -- Reason: otherwise it looks as if there are two local definition sites
247 -- for the thing, and an error gets reported. Easiest thing is just to
248 -- filter them out up front. This situation only arises if a module
249 -- imports itself, or another module that imported it. (Necessarily,
250 -- this invoves a loop.) Consequence: if you say
255 -- module B( AType ) where
256 -- import {-# SOURCE #-} A( AType )
258 -- then you'll get a 'B does not export AType' message. A bit bogus
259 -- but it's a bogus thing to do!
262 = mapRn (load_entity mod) entities
264 new_name mod occ = newGlobalName mod occ
266 load_entity mod (Avail occ)
267 = new_name mod occ `thenRn` \ name ->
268 returnRn (Avail name)
269 load_entity mod (AvailTC occ occs)
270 = new_name mod occ `thenRn` \ name ->
271 mapRn (new_name mod) occs `thenRn` \ names ->
272 returnRn (AvailTC name names)
275 -----------------------------------------------------
276 -- Loading type/class/value decls
277 -----------------------------------------------------
281 -> (Version, RdrNameHsDecl)
284 loadDecl mod decls_map (version, decl)
285 = getDeclBinders new_name decl `thenRn` \ maybe_avail ->
286 case maybe_avail of {
287 Nothing -> returnRn decls_map; -- No bindings
290 getDeclSysBinders new_name decl `thenRn` \ sys_bndrs ->
292 full_avail = addSysAvails avail sys_bndrs
293 -- Add the sys-binders to avail. When we import the decl,
294 -- it's full_avail that will get added to the 'already-slurped' set (iSlurp)
295 -- If we miss out sys-binders, we'll read the decl multiple times!
297 main_name = availName avail
298 new_decls_map = foldl add_decl decls_map
299 [ (name, (version, full_avail, name==main_name, (mod, decl')))
300 | name <- availNames full_avail]
301 add_decl decls_map (name, stuff)
302 = WARN( name `elemNameEnv` decls_map, ppr name )
303 extendNameEnv decls_map name stuff
305 returnRn new_decls_map
308 -- newTopBinder puts into the cache the binder with the
309 -- module information set correctly. When the decl is later renamed,
310 -- the binding site will thereby get the correct module.
311 -- There maybe occurrences that don't have the correct Module, but
312 -- by the typechecker will propagate the binding definition to all
313 -- the occurrences, so that doesn't matter
314 new_name rdr_name loc = newTopBinder mod (rdrNameOcc rdr_name)
317 If a signature decl is being loaded, and optIgnoreIfacePragmas is on,
318 we toss away unfolding information.
320 Also, if the signature is loaded from a module we're importing from source,
321 we do the same. This is to avoid situations when compiling a pair of mutually
322 recursive modules, peering at unfolding info in the interface file of the other,
323 e.g., you compile A, it looks at B's interface file and may as a result change
324 its interface file. Hence, B is recompiled, maybe changing its interface file,
325 which will the unfolding info used in A to become invalid. Simple way out is to
326 just ignore unfolding info.
328 [Jan 99: I junked the second test above. If we're importing from an hi-boot
329 file there isn't going to *be* any pragma info. Maybe the above comment
330 dates from a time where we picked up a .hi file first if it existed?]
333 SigD (IfaceSig name tp ls loc) | opt_IgnoreIfacePragmas
334 -> SigD (IfaceSig name tp [] loc)
337 -----------------------------------------------------
338 -- Loading fixity decls
339 -----------------------------------------------------
341 loadFixDecls mod_name fixity_env (version, decls)
342 | null decls = returnRn fixity_env
345 = mapRn (loadFixDecl mod_name) decls `thenRn` \ to_add ->
346 returnRn (extendNameEnvList fixity_env to_add)
348 loadFixDecl mod_name sig@(FixitySig rdr_name fixity loc)
349 = newGlobalName mod_name (rdrNameOcc rdr_name) `thenRn` \ name ->
350 returnRn (name, FixitySig name fixity loc)
353 -----------------------------------------------------
354 -- Loading instance decls
355 -----------------------------------------------------
357 loadInstDecl :: Module
361 loadInstDecl mod insts decl@(InstDecl inst_ty binds uprags dfun_name src_loc)
363 -- Find out what type constructors and classes are "gates" for the
364 -- instance declaration. If all these "gates" are slurped in then
365 -- we should slurp the instance decl too.
367 -- We *don't* want to count names in the context part as gates, though.
369 -- instance Foo a => Baz (T a) where ...
371 -- Here the gates are Baz and T, but *not* Foo.
373 munged_inst_ty = removeContext inst_ty
374 free_names = extractHsTyRdrNames munged_inst_ty
377 mapRn lookupOrigName free_names `thenRn` \ gate_names ->
378 returnRn ((mkNameSet gate_names, (mod, InstD decl)) `consBag` insts)
381 -- In interface files, the instance decls now look like
382 -- forall a. Foo a -> Baz (T a)
383 -- so we have to strip off function argument types as well
384 -- as the bit before the '=>' (which is always empty in interface files)
385 removeContext (HsForAllTy tvs cxt ty) = HsForAllTy tvs [] (removeFuns ty)
386 removeContext ty = removeFuns ty
388 removeFuns (HsFunTy _ ty) = removeFuns ty
392 -----------------------------------------------------
394 -----------------------------------------------------
396 loadRules :: Module -> IfaceRules
397 -> (Version, [RdrNameRuleDecl])
399 loadRules mod rule_bag (version, rules)
400 | null rules || opt_IgnoreIfacePragmas
404 mapRn (loadRule mod) rules `thenRn` \ new_rules ->
405 returnRn (rule_bag `unionBags` listToBag new_rules)
407 loadRule :: Module -> RdrNameRuleDecl -> RnM d GatedDecl
408 -- "Gate" the rule simply by whether the rule variable is
409 -- needed. We can refine this later.
410 loadRule mod decl@(IfaceRule _ _ var _ _ src_loc)
411 = lookupOrigName var `thenRn` \ var_name ->
412 returnRn (unitNameSet var_name, (mod, RuleD decl))
414 loadBuiltinRules :: [(RdrName, CoreRule)] -> RnMG ()
415 loadBuiltinRules builtin_rules
416 = getIfacesRn `thenRn` \ ifaces ->
417 mapRn loadBuiltinRule builtin_rules `thenRn` \ rule_decls ->
418 setIfacesRn (ifaces { iRules = iRules ifaces `unionBags` listToBag rule_decls })
420 loadBuiltinRule (var, rule)
421 = lookupOrigName var `thenRn` \ var_name ->
422 returnRn (unitNameSet var_name, (nameModule var_name, RuleD (IfaceRuleOut var rule)))
425 -----------------------------------------------------
426 -- Loading Deprecations
427 -----------------------------------------------------
429 loadDeprec :: Module -> DeprecationEnv -> RdrNameDeprecation -> RnM d DeprecationEnv
430 loadDeprec mod deprec_env (Deprecation (IEModuleContents _) txt _)
431 = traceRn (text "module deprecation not yet implemented:" <+> ppr mod <> colon <+> ppr txt) `thenRn_`
432 -- SUP: TEMPORARY HACK, ignoring module deprecations for now
435 loadDeprec mod deprec_env (Deprecation ie txt _)
437 mapRn lookupOrigName (ieNames ie) `thenRn` \ names ->
438 traceRn (text "loaded deprecation(s) for" <+> hcat (punctuate comma (map ppr names)) <> colon <+> ppr txt) `thenRn_`
439 returnRn (extendNameEnvList deprec_env (zip names (repeat txt)))
443 %********************************************************
445 \subsection{Checking usage information}
447 %********************************************************
453 checkModUsage :: [ImportVersion OccName] -> RnMG Bool
454 -- Given the usage information extracted from the old
455 -- M.hi file for the module being compiled, figure out
456 -- whether M needs to be recompiled.
458 checkModUsage [] = returnRn upToDate -- Yes! Everything is up to date!
460 checkModUsage ((mod_name, _, _, NothingAtAll) : rest)
461 -- If CurrentModule.hi contains
463 -- then that simply records that Foo lies below CurrentModule in the
464 -- hierarchy, but CurrentModule doesn't depend in any way on Foo.
465 -- In this case we don't even want to open Foo's interface.
466 = traceRn (ptext SLIT("Nothing used from:") <+> ppr mod_name) `thenRn_`
467 checkModUsage rest -- This one's ok, so check the rest
469 checkModUsage ((mod_name, _, _, whats_imported) : rest)
470 = tryLoadInterface doc_str mod_name ImportBySystem `thenRn` \ (ifaces, maybe_err) ->
472 Just err -> out_of_date (sep [ptext SLIT("Can't find version number for module"),
473 pprModuleName mod_name]) ;
474 -- Couldn't find or parse a module mentioned in the
475 -- old interface file. Don't complain -- it might just be that
476 -- the current module doesn't need that import and it's been deleted
480 (_, new_mod_vers, new_fix_vers, new_rule_vers, _, _)
481 = case lookupFM (iImpModInfo ifaces) mod_name of
482 Just (_, _, Just stuff) -> stuff
484 old_mod_vers = case whats_imported of
486 Specifically v _ _ _ -> v
487 -- NothingAtAll case dealt with by previous eqn for checkModUsage
489 -- If the module version hasn't changed, just move on
490 if new_mod_vers == old_mod_vers then
491 traceRn (sep [ptext SLIT("Module version unchanged:"), pprModuleName mod_name])
492 `thenRn_` checkModUsage rest
494 traceRn (sep [ptext SLIT("Module version has changed:"), pprModuleName mod_name])
496 -- Module version changed, so check entities inside
498 -- If the usage info wants to say "I imported everything from this module"
499 -- it does so by making whats_imported equal to Everything
500 -- In that case, we must recompile
501 case whats_imported of { -- NothingAtAll dealt with earlier
504 -> out_of_date (ptext SLIT("...and I needed the whole module")) ;
506 Specifically _ old_fix_vers old_rule_vers old_local_vers ->
508 if old_fix_vers /= new_fix_vers then
509 out_of_date (ptext SLIT("Fixities changed"))
510 else if old_rule_vers /= new_rule_vers then
511 out_of_date (ptext SLIT("Rules changed"))
513 -- Non-empty usage list, so check item by item
514 checkEntityUsage mod_name (iDecls ifaces) old_local_vers `thenRn` \ up_to_date ->
516 traceRn (ptext SLIT("...but the bits I use haven't.")) `thenRn_`
517 checkModUsage rest -- This one's ok, so check the rest
519 returnRn outOfDate -- This one failed, so just bail out now
522 doc_str = sep [ptext SLIT("need version info for"), pprModuleName mod_name]
525 checkEntityUsage mod decls []
526 = returnRn upToDate -- Yes! All up to date!
528 checkEntityUsage mod decls ((occ_name,old_vers) : rest)
529 = newGlobalName mod occ_name `thenRn` \ name ->
530 case lookupNameEnv decls name of
532 Nothing -> -- We used it before, but it ain't there now
533 out_of_date (sep [ptext SLIT("No longer exported:"), ppr name])
535 Just (new_vers,_,_,_) -- It's there, but is it up to date?
536 | new_vers == old_vers
537 -- Up to date, so check the rest
538 -> checkEntityUsage mod decls rest
541 -- Out of date, so bale out
542 -> out_of_date (sep [ptext SLIT("Out of date:"), ppr name])
544 out_of_date msg = traceRn msg `thenRn_` returnRn outOfDate
548 %*********************************************************
550 \subsection{Getting in a declaration}
552 %*********************************************************
555 importDecl :: Name -> RnMG ImportDeclResult
557 data ImportDeclResult
561 | HereItIs (Module, RdrNameHsDecl)
564 = getSlurped `thenRn` \ already_slurped ->
565 if name `elemNameSet` already_slurped then
566 returnRn AlreadySlurped -- Already dealt with
568 else if isLocallyDefined name then -- Don't bring in decls from
569 -- the renamed module's own interface file
570 addWarnRn (importDeclWarn name) `thenRn_`
571 returnRn AlreadySlurped
573 else if isWiredInName name then
574 -- When we find a wired-in name we must load its
575 -- home module so that we find any instance decls therein
576 loadHomeInterface doc name `thenRn_`
579 else getNonWiredInDecl name
581 doc = ptext SLIT("need home module for wired in thing") <+> ppr name
584 {- I don't think this is necessary any more; SLPJ May 00
586 | name `elemNameSet` source_binders = returnRn ()
587 -- When compiling the prelude, a wired-in thing may
588 -- be defined in this module, in which case we don't
589 -- want to load its home module!
590 -- Using 'isLocallyDefined' doesn't work because some of
591 -- the free variables returned are simply 'listTyCon_Name',
592 -- with a system provenance. We could look them up every time
593 -- but that seems a waste.
594 | otherwise = loadHomeInterface doc name `thenRn_`
598 getNonWiredInDecl :: Name -> RnMG ImportDeclResult
599 getNonWiredInDecl needed_name
600 = traceRn doc_str `thenRn_`
601 loadHomeInterface doc_str needed_name `thenRn` \ ifaces ->
602 case lookupNameEnv (iDecls ifaces) needed_name of
604 Just (version, avail, is_tycon_name, decl@(_, TyClD (TyData DataType _ _ _ _ ncons _ _ _ _ _)))
605 -- This case deals with deferred import of algebraic data types
607 | not opt_NoPruneTyDecls
609 && (opt_IgnoreIfacePragmas || ncons > 1)
610 -- We only defer if imported interface pragmas are ingored
611 -- or if it's not a product type.
612 -- Sole reason: The wrapper for a strict function may need to look
613 -- inside its arg, and hence need to see its arg type's constructors.
615 && not (getUnique tycon_name `elem` cCallishTyKeys)
616 -- Never defer ccall types; we have to unbox them,
617 -- and importing them does no harm
619 -> -- OK, so we're importing a deferrable data type
620 if needed_name == tycon_name then
621 -- The needed_name is the TyCon of a data type decl
622 -- Record that it's slurped, put it in the deferred set
623 -- and don't return a declaration at all
624 setIfacesRn (recordSlurp (ifaces {iDeferred = iDeferred ifaces
625 `addOneToNameSet` tycon_name})
626 version (AvailTC needed_name [needed_name])) `thenRn_`
629 -- The needed name is a constructor of a data type decl,
630 -- getting a constructor, so remove the TyCon from the deferred set
631 -- (if it's there) and return the full declaration
632 setIfacesRn (recordSlurp (ifaces {iDeferred = iDeferred ifaces
633 `delFromNameSet` tycon_name})
634 version avail) `thenRn_`
635 returnRn (HereItIs decl)
637 tycon_name = availName avail
639 Just (version,avail,_,decl)
640 -> setIfacesRn (recordSlurp ifaces version avail) `thenRn_`
641 returnRn (HereItIs decl)
644 -> addErrRn (getDeclErr needed_name) `thenRn_`
645 returnRn AlreadySlurped
647 doc_str = ptext SLIT("need decl for") <+> ppr needed_name
649 getDeferredDecls :: RnMG [(Module, RdrNameHsDecl)]
651 = getIfacesRn `thenRn` \ ifaces ->
653 decls_map = iDecls ifaces
654 deferred_names = nameSetToList (iDeferred ifaces)
655 get_abstract_decl n = case lookupNameEnv decls_map n of
656 Just (_, _, _, decl) -> decl
658 traceRn (sep [text "getDeferredDecls", nest 4 (fsep (map ppr deferred_names))]) `thenRn_`
659 returnRn (map get_abstract_decl deferred_names)
662 @getWiredInDecl@ maps a wired-in @Name@ to what it makes available.
663 It behaves exactly as if the wired in decl were actually in an interface file.
666 \item if the wired-in name is a data type constructor or a data constructor,
667 it brings in the type constructor and all the data constructors; and
668 marks as ``occurrences'' any free vars of the data con.
670 \item similarly for synonum type constructor
672 \item if the wired-in name is another wired-in Id, it marks as ``occurrences''
673 the free vars of the Id's type.
675 \item it loads the interface file for the wired-in thing for the
676 sole purpose of making sure that its instance declarations are available
678 All this is necessary so that we know all types that are ``in play'', so
679 that we know just what instances to bring into scope.
684 %*********************************************************
686 \subsection{Getting what a module exports}
688 %*********************************************************
690 @getInterfaceExports@ is called only for directly-imported modules.
693 getInterfaceExports :: ModuleName -> WhereFrom -> RnMG (Module, Avails)
694 getInterfaceExports mod_name from
695 = loadInterface doc_str mod_name from `thenRn` \ ifaces ->
696 case lookupFM (iImpModInfo ifaces) mod_name of
697 Just (_, _, Just (mod, _, _, _, _, avails)) -> returnRn (mod, avails)
698 -- loadInterface always puts something in the map
699 -- even if it's a fake
701 doc_str = sep [pprModuleName mod_name, ptext SLIT("is directly imported")]
705 %*********************************************************
707 \subsection{Instance declarations are handled specially}
709 %*********************************************************
712 getImportedInstDecls :: NameSet -> RnMG [(Module,RdrNameHsDecl)]
713 getImportedInstDecls gates
714 = -- First, load any orphan-instance modules that aren't aready loaded
715 -- Orphan-instance modules are recorded in the module dependecnies
716 getIfacesRn `thenRn` \ ifaces ->
719 [mod | (mod, (True, _, Nothing)) <- fmToList (iImpModInfo ifaces)]
721 loadOrphanModules orphan_mods `thenRn_`
723 -- Now we're ready to grab the instance declarations
724 -- Find the un-gated ones and return them,
725 -- removing them from the bag kept in Ifaces
726 getIfacesRn `thenRn` \ ifaces ->
728 (decls, new_insts) = selectGated gates (iInsts ifaces)
730 setIfacesRn (ifaces { iInsts = new_insts }) `thenRn_`
732 traceRn (sep [text "getImportedInstDecls:",
733 nest 4 (fsep (map ppr gate_list)),
734 text "Slurped" <+> int (length decls) <+> text "instance declarations",
735 nest 4 (vcat (map ppr_brief_inst_decl decls))]) `thenRn_`
738 gate_list = nameSetToList gates
740 ppr_brief_inst_decl (mod, InstD (InstDecl inst_ty _ _ _ _))
742 HsForAllTy _ _ tau -> ppr tau
745 getImportedRules :: RnMG [(Module,RdrNameHsDecl)]
747 | opt_IgnoreIfacePragmas = returnRn []
749 = getIfacesRn `thenRn` \ ifaces ->
751 gates = iSlurp ifaces -- Anything at all that's been slurped
752 rules = iRules ifaces
753 (decls, new_rules) = selectGated gates rules
758 setIfacesRn (ifaces { iRules = new_rules }) `thenRn_`
759 traceRn (sep [text "getImportedRules:",
760 text "Slurped" <+> int (length decls) <+> text "rules"]) `thenRn_`
763 selectGated gates decl_bag
764 -- Select only those decls whose gates are *all* in 'gates'
766 | opt_NoPruneDecls -- Just to try the effect of not gating at all
767 = (foldrBag (\ (_,d) ds -> d:ds) [] decl_bag, emptyBag) -- Grab them all
771 = foldrBag select ([], emptyBag) decl_bag
773 select (reqd, decl) (yes, no)
774 | isEmptyNameSet (reqd `minusNameSet` gates) = (decl:yes, no)
775 | otherwise = (yes, (reqd,decl) `consBag` no)
777 lookupFixityRn :: Name -> RnMS Fixity
779 | isLocallyDefined name
780 = getFixityEnv `thenRn` \ local_fix_env ->
781 returnRn (lookupFixity local_fix_env name)
783 | otherwise -- Imported
784 -- For imported names, we have to get their fixities by doing a loadHomeInterface,
785 -- and consulting the Ifaces that comes back from that, because the interface
786 -- file for the Name might not have been loaded yet. Why not? Suppose you import module A,
787 -- which exports a function 'f', which is defined in module B. Then B isn't loaded
788 -- right away (after all, it's possible that nothing from B will be used).
789 -- When we come across a use of 'f', we need to know its fixity, and it's then,
790 -- and only then, that we load B.hi. That is what's happening here.
791 = loadHomeInterface doc name `thenRn` \ ifaces ->
792 returnRn (lookupFixity (iFixes ifaces) name)
794 doc = ptext SLIT("Checking fixity for") <+> ppr name
798 %*********************************************************
800 \subsection{Keeping track of what we've slurped, and version numbers}
802 %*********************************************************
804 getImportVersions figures out what the ``usage information'' for this
805 moudule is; that is, what it must record in its interface file as the
806 things it uses. It records:
809 \item (a) anything reachable from its body code
810 \item (b) any module exported with a @module Foo@
811 \item (c) anything reachable from an exported item
814 Why (b)? Because if @Foo@ changes then this module's export list
815 will change, so we must recompile this module at least as far as
816 making a new interface file --- but in practice that means complete
819 Why (c)? Consider this:
821 module A( f, g ) where | module B( f ) where
822 import B( f ) | f = h 3
826 Here, @B.f@ isn't used in A. Should we nevertheless record @B.f@ in
827 @A@'s usages? Our idea is that we aren't going to touch A.hi if it is
828 *identical* to what it was before. If anything about @B.f@ changes
829 than anyone who imports @A@ should be recompiled in case they use
830 @B.f@ (they'll get an early exit if they don't). So, if anything
831 about @B.f@ changes we'd better make sure that something in A.hi
832 changes, and the convenient way to do that is to record the version
833 number @B.f@ in A.hi in the usage list. If B.f changes that'll force a
834 complete recompiation of A, which is overkill but it's the only way to
835 write a new, slightly different, A.hi.
837 But the example is tricker. Even if @B.f@ doesn't change at all,
838 @B.h@ may do so, and this change may not be reflected in @f@'s version
839 number. But with -O, a module that imports A must be recompiled if
840 @B.h@ changes! So A must record a dependency on @B.h@. So we treat
841 the occurrence of @B.f@ in the export list *just as if* it were in the
842 code of A, and thereby haul in all the stuff reachable from it.
844 [NB: If B was compiled with -O, but A isn't, we should really *still*
845 haul in all the unfoldings for B, in case the module that imports A *is*
846 compiled with -O. I think this is the case.]
848 Even if B is used at all we get a usage line for B
849 import B <n> :: ... ;
850 in A.hi, to record the fact that A does import B. This is used to decide
851 to look to look for B.hi rather than B.hi-boot when compiling a module that
852 imports A. This line says that A imports B, but uses nothing in it.
853 So we'll get an early bale-out when compiling A if B's version changes.
856 mkImportExportInfo :: ModuleName -- Name of this module
857 -> Avails -- Info about exports
858 -> Maybe [RdrNameIE] -- The export header
859 -> RnMG ([ExportItem], -- Export info for iface file; sorted
860 [ImportVersion OccName]) -- Import info for iface file; sorted
861 -- Both results are sorted into canonical order to
862 -- reduce needless wobbling of interface files
864 mkImportExportInfo this_mod export_avails exports
865 = getIfacesRn `thenRn` \ ifaces ->
867 export_all_mods = case exports of
869 Just es -> [mod | IEModuleContents mod <- es,
872 mod_map = iImpModInfo ifaces
873 imp_names = iVSlurp ifaces
875 -- mv_map groups together all the things imported from a particular module.
876 mv_map :: FiniteMap ModuleName [(OccName,Version)]
877 mv_map = foldr add_mv emptyFM imp_names
879 add_mv (name, version) mv_map = addItem mv_map (moduleName (nameModule name))
880 (nameOccName name, version)
882 -- Build the result list by adding info for each module.
883 -- For (a) a library module, we don't record it at all unless it contains orphans
884 -- (We must never lose track of orphans.)
886 -- (b) a source-imported module, don't record the dependency at all
888 -- (b) may seem a bit strange. The idea is that the usages in a .hi file records
889 -- *all* the module's dependencies other than the loop-breakers. We use
890 -- this info in findAndReadInterface to decide whether to look for a .hi file or
893 -- This means we won't track version changes, or orphans, from .hi-boot files.
894 -- The former is potentially rather bad news. It could be fixed by recording
895 -- whether something is a boot file along with the usage info for it, but
896 -- I can't be bothered just now.
898 mk_imp_info mod_name (has_orphans, is_boot, contents) so_far
899 | mod_name == this_mod -- Check if M appears in the set of modules 'below' M
900 -- This seems like a convenient place to check
901 = WARN( not is_boot, ptext SLIT("Wierd:") <+> ppr this_mod <+>
902 ptext SLIT("imports itself (perhaps indirectly)") )
907 go_for_it exports = (mod_name, has_orphans, is_boot, exports)
911 Nothing -> -- We didn't even open the interface
912 -- This happens when a module, Foo, that we explicitly imported has
913 -- 'import Baz' in its interface file, recording that Baz is below
914 -- Foo in the module dependency hierarchy. We want to propagate this
915 -- information. The Nothing says that we didn't even open the interface
916 -- file but we must still propagate the dependeny info.
917 -- The module in question must be a local module (in the same package)
918 go_for_it NothingAtAll
920 Just (mod, mod_vers, fix_vers, rule_vers, how_imported, _)
921 | is_sys_import && is_lib_module && not has_orphans
924 | is_lib_module -- Record the module but not detailed
925 || mod_name `elem` export_all_mods -- version information for the imports
926 -> go_for_it (Everything mod_vers)
929 -> case lookupFM mv_map mod_name of
930 Just whats_imported -> go_for_it (Specifically mod_vers fix_vers rule_vers
931 (sortImport whats_imported))
932 Nothing -> go_for_it NothingAtAll
933 -- This happens if you have
935 -- but don't actually *use* anything from Foo
936 -- In which case record an empty dependency list
938 is_lib_module = not (isLocalModule mod)
939 is_sys_import = case how_imported of
940 ImportBySystem -> True
944 import_info = foldFM mk_imp_info [] mod_map
946 -- Sort exports into groups by module
947 export_fm :: FiniteMap ModuleName [RdrAvailInfo]
948 export_fm = foldr insert emptyFM export_avails
950 insert avail efm = addItem efm (moduleName (nameModule (availName avail)))
953 export_info = [(m, sortExport as) | (m,as) <- fmToList export_fm]
955 traceRn (text "Modules in Ifaces: " <+> fsep (map ppr (keysFM mod_map))) `thenRn_`
956 returnRn (export_info, import_info)
959 addItem :: FiniteMap ModuleName [a] -> ModuleName -> a -> FiniteMap ModuleName [a]
960 addItem fm mod x = addToFM_C add_item fm mod [x]
964 sortImport :: [(OccName,Version)] -> [(OccName,Version)]
965 -- Make the usage lists appear in canonical order
966 sortImport vs = sortLt lt vs
968 lt (n1,v1) (n2,v2) = n1 < n2
970 sortExport :: [RdrAvailInfo] -> [RdrAvailInfo]
971 sortExport as = sortLt lt as
973 lt a1 a2 = availName a1 < availName a2
978 = getIfacesRn `thenRn` \ ifaces ->
979 returnRn (iSlurp ifaces)
981 recordSlurp ifaces@(Ifaces { iSlurp = slurped_names, iVSlurp = imp_names })
984 new_slurped_names = addAvailToNameSet slurped_names avail
985 new_imp_names = (availName avail, version) : imp_names
987 ifaces { iSlurp = new_slurped_names, iVSlurp = new_imp_names }
989 recordLocalSlurps local_avails
990 = getIfacesRn `thenRn` \ ifaces ->
992 new_slurped_names = foldl addAvailToNameSet (iSlurp ifaces) local_avails
994 setIfacesRn (ifaces { iSlurp = new_slurped_names })
998 %*********************************************************
1000 \subsection{Getting binders out of a declaration}
1002 %*********************************************************
1004 @getDeclBinders@ returns the names for a @RdrNameHsDecl@.
1005 It's used for both source code (from @availsFromDecl@) and interface files
1008 It doesn't deal with source-code specific things: @ValD@, @DefD@. They
1009 are handled by the sourc-code specific stuff in @RnNames@.
1012 getDeclBinders :: (RdrName -> SrcLoc -> RnM d Name) -- New-name function
1014 -> RnM d (Maybe AvailInfo)
1016 getDeclBinders new_name (TyClD (TyData _ _ tycon _ condecls _ _ _ src_loc _ _))
1017 = new_name tycon src_loc `thenRn` \ tycon_name ->
1018 getConFieldNames new_name condecls `thenRn` \ sub_names ->
1019 returnRn (Just (AvailTC tycon_name (tycon_name : nub sub_names)))
1020 -- The "nub" is because getConFieldNames can legitimately return duplicates,
1021 -- when a record declaration has the same field in multiple constructors
1023 getDeclBinders new_name (TyClD (TySynonym tycon _ _ src_loc))
1024 = new_name tycon src_loc `thenRn` \ tycon_name ->
1025 returnRn (Just (AvailTC tycon_name [tycon_name]))
1027 getDeclBinders new_name (TyClD (ClassDecl _ cname _ _ sigs _ _ _ src_loc))
1028 = new_name cname src_loc `thenRn` \ class_name ->
1030 -- Record the names for the class ops
1032 -- just want class-op sigs
1033 op_sigs = filter isClassOpSig sigs
1035 mapRn (getClassOpNames new_name) op_sigs `thenRn` \ sub_names ->
1037 returnRn (Just (AvailTC class_name (class_name : sub_names)))
1039 getDeclBinders new_name (SigD (IfaceSig var ty prags src_loc))
1040 = new_name var src_loc `thenRn` \ var_name ->
1041 returnRn (Just (Avail var_name))
1043 getDeclBinders new_name (FixD _) = returnRn Nothing
1044 getDeclBinders new_name (DeprecD _) = returnRn Nothing
1046 -- foreign declarations
1047 getDeclBinders new_name (ForD (ForeignDecl nm kind _ dyn _ loc))
1048 | binds_haskell_name kind dyn
1049 = new_name nm loc `thenRn` \ name ->
1050 returnRn (Just (Avail name))
1052 | otherwise -- a foreign export
1053 = lookupOrigName nm `thenRn_`
1056 getDeclBinders new_name (DefD _) = returnRn Nothing
1057 getDeclBinders new_name (InstD _) = returnRn Nothing
1058 getDeclBinders new_name (RuleD _) = returnRn Nothing
1060 binds_haskell_name (FoImport _) _ = True
1061 binds_haskell_name FoLabel _ = True
1062 binds_haskell_name FoExport ext_nm = isDynamicExtName ext_nm
1065 getConFieldNames new_name (ConDecl con _ _ _ (RecCon fielddecls) src_loc : rest)
1066 = mapRn (\n -> new_name n src_loc) (con:fields) `thenRn` \ cfs ->
1067 getConFieldNames new_name rest `thenRn` \ ns ->
1068 returnRn (cfs ++ ns)
1070 fields = concat (map fst fielddecls)
1072 getConFieldNames new_name (ConDecl con _ _ _ condecl src_loc : rest)
1073 = new_name con src_loc `thenRn` \ n ->
1074 getConFieldNames new_name rest `thenRn` \ ns ->
1077 getConFieldNames new_name [] = returnRn []
1079 getClassOpNames new_name (ClassOpSig op _ _ src_loc) = new_name op src_loc
1082 @getDeclSysBinders@ gets the implicit binders introduced by a decl.
1083 A the moment that's just the tycon and datacon that come with a class decl.
1084 They aren't returned by @getDeclBinders@ because they aren't in scope;
1085 but they {\em should} be put into the @DeclsMap@ of this module.
1087 Note that this excludes the default-method names of a class decl,
1088 and the dict fun of an instance decl, because both of these have
1089 bindings of their own elsewhere.
1092 getDeclSysBinders new_name (TyClD (ClassDecl _ cname _ _ sigs _ _ names
1094 = sequenceRn [new_name n src_loc | n <- names]
1096 getDeclSysBinders new_name (TyClD (TyData _ _ _ _ cons _ _ _ _ _ _))
1097 = sequenceRn [new_name wkr_name src_loc | ConDecl _ wkr_name _ _ _ src_loc <- cons]
1099 getDeclSysBinders new_name other_decl
1103 %*********************************************************
1105 \subsection{Reading an interface file}
1107 %*********************************************************
1110 findAndReadIface :: SDoc -> ModuleName
1111 -> IsBootInterface -- True <=> Look for a .hi-boot file
1112 -- False <=> Look for .hi file
1113 -> RnM d (Either Message ParsedIface)
1114 -- Nothing <=> file not found, or unreadable, or illegible
1115 -- Just x <=> successfully found and parsed
1117 findAndReadIface doc_str mod_name hi_boot_file
1118 = traceRn trace_msg `thenRn_`
1119 -- we keep two maps for interface files,
1120 -- one for 'normal' ones, the other for .hi-boot files,
1121 -- hence the need to signal which kind we're interested.
1123 getHiMaps `thenRn` \ (search_path, hi_map, hiboot_map) ->
1125 relevant_map | hi_boot_file = hiboot_map
1126 | otherwise = hi_map
1128 case lookupFM relevant_map mod_name of
1130 Just fpath -> traceRn (ptext SLIT("...reading from") <+> text fpath) `thenRn_`
1131 readIface mod_name fpath
1134 Nothing -> traceRn (ptext SLIT("...not found")) `thenRn_`
1135 returnRn (Left (noIfaceErr mod_name hi_boot_file search_path))
1138 trace_msg = sep [hsep [ptext SLIT("Reading"),
1139 if hi_boot_file then ptext SLIT("[boot]") else empty,
1140 ptext SLIT("interface for"),
1141 pprModuleName mod_name <> semi],
1142 nest 4 (ptext SLIT("reason:") <+> doc_str)]
1145 @readIface@ tries just the one file.
1148 readIface :: ModuleName -> String -> RnM d (Either Message ParsedIface)
1149 -- Nothing <=> file not found, or unreadable, or illegible
1150 -- Just x <=> successfully found and parsed
1151 readIface wanted_mod file_path
1152 = ioToRnM (hGetStringBuffer False file_path) `thenRn` \ read_result ->
1155 case parseIface contents
1156 PState{ bol = 0#, atbol = 1#,
1159 loc = mkSrcLoc (mkFastString file_path) 1 } of
1160 POk _ (PIface iface) ->
1161 warnCheckRn (read_mod == wanted_mod)
1162 (hiModuleNameMismatchWarn wanted_mod read_mod) `thenRn_`
1163 returnRn (Right iface)
1165 read_mod = moduleName (pi_mod iface)
1167 PFailed err -> bale_out err
1168 parse_result -> bale_out empty
1169 -- This last case can happen if the interface file is (say) empty
1170 -- in which case the parser thinks it looks like an IdInfo or
1171 -- something like that. Just an artefact of the fact that the
1172 -- parser is used for several purposes at once.
1174 Left io_err -> bale_out (text (show io_err))
1176 bale_out err = returnRn (Left (badIfaceFile file_path err))
1179 %*********************************************************
1183 %*********************************************************
1186 noIfaceErr mod_name boot_file search_path
1187 = vcat [ptext SLIT("Could not find interface file for") <+> quotes (pprModuleName mod_name),
1188 ptext SLIT("in the directories") <+>
1189 -- \& to avoid cpp interpreting this string as a
1190 -- comment starter with a pre-4.06 mkdependHS --SDM
1191 vcat [ text dir <> text "/\&*" <> pp_suffix suffix
1192 | (dir,suffix) <- search_path]
1195 pp_suffix suffix | boot_file = ptext SLIT(".hi-boot")
1196 | otherwise = text suffix
1198 badIfaceFile file err
1199 = vcat [ptext SLIT("Bad interface file:") <+> text file,
1203 = vcat [ptext SLIT("Failed to find interface decl for") <+> quotes (ppr name),
1204 ptext SLIT("from module") <+> quotes (ppr (nameModule name))
1209 "Compiler tried to import decl from interface file with same name as module."),
1211 "(possible cause: module name clashes with interface file already in scope.)")
1213 hsep [ptext SLIT("name:"), quotes (ppr name)]
1215 warnRedundantSourceImport mod_name
1216 = ptext SLIT("Unnecessary {- SOURCE -} in the import of module")
1217 <+> quotes (pprModuleName mod_name)
1219 hiModuleNameMismatchWarn :: ModuleName -> ModuleName -> Message
1220 hiModuleNameMismatchWarn requested_mod read_mod =
1221 hsep [ ptext SLIT("Something is amiss; requested module name")
1222 , pprModuleName requested_mod
1223 , ptext SLIT("differs from name found in the interface file")
1224 , pprModuleName read_mod