RnIfaces.lhs 44.8 KB
Newer Older
1
%
2
% (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
3
4
5
6
7
%
\section[RnIfaces]{Cacheing and Renaming of Interfaces}

\begin{code}
module RnIfaces (
8
9
10
11
#if 1
	lookupFixityRn
#else
 	findAndReadIface, 
12
13

	getInterfaceExports, getDeferredDecls,
14
	getImportedInstDecls, getImportedRules,
15
16
17
	lookupFixityRn, loadHomeInterface,
	importDecl, ImportDeclResult(..), recordLocalSlurps, loadBuiltinRules,
	mkImportExportInfo, getSlurped, 
18

19
	checkModUsage, outOfDate, upToDate,
20

21
22
	getDeclBinders, getDeclSysBinders,
	removeContext	 	-- removeContext probably belongs somewhere else
23
#endif
24
25
    ) where

26
#include "HsVersions.h"
27

28
import CmdLineOpts	( opt_NoPruneDecls, opt_NoPruneTyDecls, opt_IgnoreIfacePragmas )
29
import HsSyn		( HsDecl(..), TyClDecl(..), InstDecl(..), IfaceSig(..), 
30
			  HsType(..), ConDecl(..), IE(..), ConDetails(..), Sig(..),
31
			  ForeignDecl(..), ForKind(..), isDynamicExtName,
32
			  FixitySig(..), RuleDecl(..),
33
			  isClassOpSig, DeprecDecl(..)
34
			)
35
36
import HsImpExp		( ieNames )
import CoreSyn		( CoreRule )
37
38
39
import BasicTypes	( Version, NewOrData(..) )
import RdrHsSyn		( RdrNameHsDecl, RdrNameInstDecl, RdrNameRuleDecl,
			  RdrNameDeprecation, RdrNameIE,
40
			  extractHsTyRdrNames 
41
			)
42
import RnEnv
43
import RnMonad
44
import ParseIface	( parseIface, IfaceStuff(..) )
45

46
47
import Name		( Name {-instance NamedThing-}, nameOccName,
			  nameModule, isLocallyDefined, 
48
			  {-isWiredInName, -} NamedThing(..),
49
			  elemNameEnv, extendNameEnv
50
			 )
51
52
import Module		( Module, mkVanillaModule,
			  moduleName, isModuleInThisPackage,
53
			  ModuleName, WhereFrom(..),
54
55
			)
import RdrName		( RdrName, rdrNameOcc )
56
import NameSet
57
import SrcLoc		( mkSrcLoc, SrcLoc )
58
import PrelInfo		( cCallishTyKeys )
59
import Maybes		( maybeToBool )
60
61
import Unique		( Uniquable(..) )
import StringBuffer     ( hGetStringBuffer )
62
import FastString	( mkFastString )
sof's avatar
sof committed
63
import ErrUtils         ( Message )
64
import Util		( sortLt )
65
import Lex
66
import FiniteMap
sof's avatar
sof committed
67
import Outputable
68
import Bag
69
import HscTypes
70
71

import List	( nub )
72
73
74
75
76

#if 1
import Panic ( panic )
lookupFixityRn = panic "lookupFixityRn"
#else
77
78
\end{code}

79

80
81
82
83
84
%*********************************************************
%*							*
\subsection{Loading a new interface file}
%*							*
%*********************************************************
85

86
\begin{code}
87
loadHomeInterface :: SDoc -> Name -> RnM d Ifaces
88
loadHomeInterface doc_str name
89
  = loadInterface doc_str (moduleName (nameModule name)) ImportBySystem
90
91
92
93

loadOrphanModules :: [ModuleName] -> RnM d ()
loadOrphanModules mods
  | null mods = returnRn ()
94
  | otherwise = traceRn (text "Loading orphan modules:" <+> 
95
			 fsep (map mods))			`thenRn_` 
96
		mapRn_ load mods				`thenRn_`
97
98
		returnRn ()
  where
99
    load mod   = loadInterface (mk_doc mod) mod ImportBySystem
100
    mk_doc mod = ppr mod <+> ptext SLIT("is a orphan-instance module")
101
	   
102

103
104
105
106
107
108
109
110
111
112
113
114
loadInterface :: SDoc -> ModuleName -> WhereFrom -> RnM d Ifaces
loadInterface doc mod from 
  = tryLoadInterface doc mod from	`thenRn` \ (ifaces, maybe_err) ->
    case maybe_err of
	Nothing  -> returnRn ifaces
	Just err -> failWithRn ifaces err

tryLoadInterface :: SDoc -> ModuleName -> WhereFrom -> RnM d (Ifaces, Maybe Message)
	-- Returns (Just err) if an error happened
	-- Guarantees to return with iImpModInfo m --> (... Just cts)
	-- (If the load fails, we plug in a vanilla placeholder
tryLoadInterface doc_str mod_name from
115
 = getIfacesRn 			`thenRn` \ ifaces ->
sof's avatar
sof committed
116
   let
117
118
119
	mod_map  = iImpModInfo ifaces
	mod_info = lookupFM mod_map mod_name

120
121
122
123
124
125
126
127
128
129
130
	hi_boot_file 
	  = case (from, mod_info) of
		(ImportByUser,       _)    	       -> False 	-- Not hi-boot
		(ImportByUserSource, _)		       -> True 		-- hi-boot
		(ImportBySystem, Just (_, is_boot, _)) -> is_boot 	-- 
		(ImportBySystem, Nothing)	       -> False
			-- We're importing a module we know absolutely
			-- nothing about, so we assume it's from
			-- another package, where we aren't doing 
			-- dependency tracking. So it won't be a hi-boot file.

131
132
	redundant_source_import 
	  = case (from, mod_info) of 
133
		(ImportByUserSource, Just (_,False,_)) -> True
134
		other				       -> False
135
   in
136
	-- CHECK WHETHER WE HAVE IT ALREADY
137
   case mod_info of {
138
	Just (_, _, True)
139
		-> 	-- We're read it already so don't re-read it
140
		    returnRn (ifaces, Nothing) ;
141

142
143
144
145
146
147
148
	_ ->

	-- Issue a warning for a redundant {- SOURCE -} import
	-- NB that we arrange to read all the ordinary imports before 
	-- any of the {- SOURCE -} imports
   warnCheckRn	(not redundant_source_import)
		(warnRedundantSourceImport mod_name)	`thenRn_`
149
150

	-- READ THE MODULE IN
151
   findAndReadIface doc_str mod_name hi_boot_file   `thenRn` \ read_resultb ->
sof's avatar
sof committed
152
   case read_result of {
153
	Left err -> 	-- Not found, so add an empty export env to the Ifaces map
154
			-- so that we don't look again
155
	   let
156
		new_mod_map = addToFM mod_map mod_name (False, False, True)
157
158
159
		new_ifaces  = ifaces { iImpModInfo = new_mod_map }
	   in
	   setIfacesRn new_ifaces		`thenRn_`
160
	   returnRn (new_ifaces, Just err) ;
161
162

	-- Found and parsed!
163
	Right (mod, iface) ->
164
165

	-- LOAD IT INTO Ifaces
166

sof's avatar
sof committed
167
168
169
170
	-- NB: *first* we do loadDecl, so that the provenance of all the locally-defined
	---    names is done correctly (notably, whether this is an .hi file or .hi-boot file).
	--     If we do loadExport first the wrong info gets into the cache (unless we
	-- 	explicitly tag each export which seems a bit of a bore)
171

172

173
174
175
176
	-- Sanity check.  If we're system-importing a module we know nothing at all
	-- about, it should be from a different package to this one
    WARN( not (maybeToBool mod_info) && 
	  case from of { ImportBySystem -> True; other -> False } &&
177
	  isModuleInThisPackage mod,
178
	  ppr mod )
179
180
181
182
183

    loadDecls mod		(iDecls ifaces)	  (pi_decls iface)	`thenRn` \ (decls_vers, new_decls) ->
    loadRules mod		(iRules ifaces)   (pi_rules iface)	`thenRn` \ (rule_vers, new_rules) ->
    loadFixDecls mod_name	 		  (pi_fixity iface)	`thenRn` \ (fix_vers, fix_env) ->
    foldlRn (loadDeprec mod)	emptyDeprecEnv	  (pi_deprecs iface)	`thenRn` \ deprec_env ->
184
    foldlRn (loadInstDecl mod)	(iInsts ifaces)   (pi_insts iface)	`thenRn` \ new_insts ->
185
    loadExports 			 	  (pi_exports iface)	`thenRn` \ avails ->
186
    let
187
188
189
190
191
	version	= VersionInfo { modVers  = pi_vers iface, 
				fixVers  = fix_vers,
				ruleVers = rule_vers,
				declVers = decl_vers }

192
193
194
195
	-- For an explicit user import, add to mod_map info about
	-- the things the imported module depends on, extracted
	-- from its usage info.
	mod_map1 = case from of
196
			ImportByUser -> addModDeps mod (pi_usages iface) mod_map
197
			other        -> mod_map
198
	mod_map2 = addToFM mod_map1 mod_name (pi_orphan iface, hi_boot_file, True)
199

200
201
202
203
204
	-- Now add info about this module to the PST
	new_pst     = extendModuleEnv pst mod mod_detils
 	mod_details = ModDetails { mdModule = mod, mvVersion = version,
				   mdExports = avails,
				   mdFixEnv = fix_env, mdDeprecEnv = deprec_env }
205

206
	new_ifaces = ifaces { iPST	  = new_pst,
207
			      iDecls      = new_decls,
208
			      iInsts      = new_insts,
209
			      iRules	  = new_rules,
210
			      iImpModInfo = mod_map2  }
211
    in
212
    setIfacesRn new_ifaces		`thenRn_`
213
    returnRn (new_ifaces, Nothing)
sof's avatar
sof committed
214
215
    }}

216
217
218
219
220
-----------------------------------------------------
--	Adding module dependencies from the 
--	import decls in the interface file
-----------------------------------------------------

221
addModDeps :: Module -> PackageSymbolTable -> [ImportVersion a] 
222
223
224
225
226
	   -> ImportedModuleInfo -> ImportedModuleInfo
-- (addModDeps M ivs deps)
-- We are importing module M, and M.hi contains 'import' decls given by ivs
addModDeps mod new_deps mod_deps
  = foldr add mod_deps filtered_new_deps
227
  where
228
229
230
	-- Don't record dependencies when importing a module from another package
	-- Except for its descendents which contain orphans,
	-- and in that case, forget about the boot indicator
231
    filtered_new_deps :: (ModuleName, (WhetherHasOrphans, IsBootInterface))
232
    filtered_new_deps
233
234
	| isModuleInThisPackage mod 
			    = [ (imp_mod, (has_orphans, is_boot, False))
235
			      | (imp_mod, has_orphans, is_boot, _) <- new_deps 
236
			      ]			      
237
	| otherwise	    = [ (imp_mod, (True, False, False))
238
			      | (imp_mod, has_orphans, _, _) <- new_deps, 
239
240
241
				has_orphans
			      ]
    add (imp_mod, dep) deps = addToFM_C combine deps imp_mod dep
242

243
244
    combine old@(_, old_is_boot, old_is_loaded) new
	| old_is_loaded || not old_is_boot = old	-- Keep the old info if it's already loaded
245
							-- or if it's a non-boot pending load
246
	| otherwise			    = new	-- Otherwise pick new info
247

248
249
250
251
252

-----------------------------------------------------
--	Loading the export list
-----------------------------------------------------

253
254
255
256
257
258
259
loadExports :: [ExportItem] -> RnM d Avails
loadExports items
  = getModuleRn 				`thenRn` \ this_mod ->
    mapRn (loadExport this_mod) items		`thenRn` \ avails_s ->
    returnRn (concat avails_s)


260
loadExport :: Module -> ExportItem -> RnM d [AvailInfo]
261
loadExport this_mod (mod, entities)
262
  | mod == moduleName this_mod = returnRn []
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
	-- If the module exports anything defined in this module, just ignore it.
	-- Reason: otherwise it looks as if there are two local definition sites
	-- for the thing, and an error gets reported.  Easiest thing is just to
	-- filter them out up front. This situation only arises if a module
	-- imports itself, or another module that imported it.  (Necessarily,
	-- this invoves a loop.)  Consequence: if you say
	--	module A where
	--	   import B( AType )
	--	   type AType = ...
	--
	--	module B( AType ) where
	--	   import {-# SOURCE #-} A( AType )
	--
	-- then you'll get a 'B does not export AType' message.  A bit bogus
	-- but it's a bogus thing to do!

  | otherwise
280
  = mapRn (load_entity mod) entities
281
  where
282
    new_name mod occ = newGlobalName mod occ
283

sof's avatar
sof committed
284
285
    load_entity mod (Avail occ)
      =	new_name mod occ	`thenRn` \ name ->
sof's avatar
sof committed
286
	returnRn (Avail name)
sof's avatar
sof committed
287
288
289
    load_entity mod (AvailTC occ occs)
      =	new_name mod occ	      `thenRn` \ name ->
        mapRn (new_name mod) occs     `thenRn` \ names ->
sof's avatar
sof committed
290
        returnRn (AvailTC name names)
291

292

293
294
295
-----------------------------------------------------
--	Loading type/class/value decls
-----------------------------------------------------
296

297
298
299
300
301
302
303
loadDecls :: Module 
	  -> DeclsMap
	  -> [(Version, RdrNameHsDecl)]
	  -> RnM d (NameEnv Version, DeclsMap)
loadDecls mod decls_map decls
  = foldlRn (loadDecl mod) (emptyNameEnv, decls_map) decls

304
loadDecl :: Module 
305
	 -> (NameEnv Version, DeclsMap)
306
	 -> (Version, RdrNameHsDecl)
307
308
	 -> RnM d (NameEnv Version, DeclsMap)
loadDecl mod (version_map, decls_map) (version, decl)
309
310
  = getDeclBinders new_name decl	`thenRn` \ maybe_avail ->
    case maybe_avail of {
311
312
	Nothing    -> returnRn (version_map, decls_map);	-- No bindings
	Just avail -> 
313

314
315
    getDeclSysBinders new_name decl	`thenRn` \ sys_bndrs ->
    let
316
317
318
319
320
	full_avail    = addSysAvails avail sys_bndrs
		-- Add the sys-binders to avail.  When we import the decl,
		-- it's full_avail that will get added to the 'already-slurped' set (iSlurp)
		-- If we miss out sys-binders, we'll read the decl multiple times!

321
322
	main_name     = availName avail
	new_decls_map = foldl add_decl decls_map
323
				       [ (name, (full_avail, name==main_name, (mod, decl'))) 
324
				       | name <- availNames full_avail]
325
	add_decl decls_map (name, stuff)
326
	  = WARN( name `elemNameEnv` decls_map, ppr name )
327
	    extendNameEnv decls_map name stuff
328
329

	new_version_map = extendNameEnv version_map main_name version
330
    in
331
    returnRn (new_version_map, new_decls_map)
332
    }
333
  where
334
	-- newTopBinder puts into the cache the binder with the
335
336
	-- module information set correctly.  When the decl is later renamed,
	-- the binding site will thereby get the correct module.
337
338
339
	-- There maybe occurrences that don't have the correct Module, but
	-- by the typechecker will propagate the binding definition to all 
	-- the occurrences, so that doesn't matter
340
    new_name rdr_name loc = newTopBinder mod rdr_name loc
341

sof's avatar
sof committed
342
    {-
343
344
      If a signature decl is being loaded, and optIgnoreIfacePragmas is on,
      we toss away unfolding information.
sof's avatar
sof committed
345
346
347
348
349

      Also, if the signature is loaded from a module we're importing from source,
      we do the same. This is to avoid situations when compiling a pair of mutually
      recursive modules, peering at unfolding info in the interface file of the other, 
      e.g., you compile A, it looks at B's interface file and may as a result change
350
351
      its interface file. Hence, B is recompiled, maybe changing its interface file,
      which will the unfolding info used in A to become invalid. Simple way out is to
sof's avatar
sof committed
352
      just ignore unfolding info.
353
354
355
356

      [Jan 99: I junked the second test above.  If we're importing from an hi-boot
       file there isn't going to *be* any pragma info.  Maybe the above comment
       dates from a time where we picked up a .hi file first if it existed?]
sof's avatar
sof committed
357
    -}
358
    decl' = case decl of
359
360
361
	       SigD (IfaceSig name tp ls loc) | opt_IgnoreIfacePragmas
			 ->  SigD (IfaceSig name tp [] loc)
	       other	 -> decl
sof's avatar
sof committed
362

363
364
365
366
-----------------------------------------------------
--	Loading fixity decls
-----------------------------------------------------

367
368
loadFixDecls mod_name (version, decls)
  | null decls = returnRn (version, emptyNameEnv)
369
370
371

  | otherwise
  = mapRn (loadFixDecl mod_name) decls	`thenRn` \ to_add ->
372
    returnRn (version, mkNameEnv to_add)
373
374

loadFixDecl mod_name sig@(FixitySig rdr_name fixity loc)
375
  = newGlobalName mod_name (rdrNameOcc rdr_name) 	`thenRn` \ name ->
376
377
378
379
380
381
382
    returnRn (name, FixitySig name fixity loc)


-----------------------------------------------------
--	Loading instance decls
-----------------------------------------------------

383
loadInstDecl :: Module
384
	     -> IfaceInsts
385
	     -> RdrNameInstDecl
386
	     -> RnM d IfaceInsts
387
loadInstDecl mod insts decl@(InstDecl inst_ty binds uprags dfun_name src_loc)
388
389
390
391
392
393
394
395
  = 
	-- Find out what type constructors and classes are "gates" for the
	-- instance declaration.  If all these "gates" are slurped in then
	-- we should slurp the instance decl too.
	-- 
	-- We *don't* want to count names in the context part as gates, though.
	-- For example:
	--		instance Foo a => Baz (T a) where ...
396
	--
397
398
	-- Here the gates are Baz and T, but *not* Foo.
    let 
399
400
	munged_inst_ty = removeContext inst_ty
	free_names     = extractHsTyRdrNames munged_inst_ty
401
    in
402
403
    setModuleRn mod $
    mapRn lookupOrigName free_names	`thenRn` \ gate_names ->
404
405
    returnRn ((mkNameSet gate_names, (mod, InstD decl)) `consBag` insts)

406
407
408
409
410
411
412
413

-- In interface files, the instance decls now look like
--	forall a. Foo a -> Baz (T a)
-- so we have to strip off function argument types as well
-- as the bit before the '=>' (which is always empty in interface files)
removeContext (HsForAllTy tvs cxt ty) = HsForAllTy tvs [] (removeFuns ty)
removeContext ty		      = removeFuns ty

414
removeFuns (HsFunTy _ ty) = removeFuns ty
415
416
417
removeFuns ty		    = ty


418
419
420
421
422
423
-----------------------------------------------------
--	Loading Rules
-----------------------------------------------------

loadRules :: Module -> IfaceRules 
	  -> (Version, [RdrNameRuleDecl])
424
	  -> RnM d (Version, IfaceRules)
425
426
loadRules mod rule_bag (version, rules)
  | null rules || opt_IgnoreIfacePragmas 
427
  = returnRn (version, rule_bag)
428
  | otherwise
429
  = setModuleRn mod		 	$
430
    mapRn (loadRule mod) rules		`thenRn` \ new_rules ->
431
    returnRn (version, rule_bag `unionBags` listToBag new_rules)
432
433

loadRule :: Module -> RdrNameRuleDecl -> RnM d GatedDecl
434
435
-- "Gate" the rule simply by whether the rule variable is
-- needed.  We can refine this later.
436
loadRule mod decl@(IfaceRule _ _ var _ _ src_loc)
437
  = lookupOrigName var		`thenRn` \ var_name ->
438
439
440
441
442
443
444
445
446
    returnRn (unitNameSet var_name, (mod, RuleD decl))

loadBuiltinRules :: [(RdrName, CoreRule)] -> RnMG ()
loadBuiltinRules builtin_rules
  = getIfacesRn				`thenRn` \ ifaces ->
    mapRn loadBuiltinRule builtin_rules	`thenRn` \ rule_decls ->
    setIfacesRn (ifaces { iRules = iRules ifaces `unionBags` listToBag rule_decls })

loadBuiltinRule (var, rule)
447
  = lookupOrigName var		`thenRn` \ var_name ->
448
449
450
451
452
453
    returnRn (unitNameSet var_name, (nameModule var_name, RuleD (IfaceRuleOut var rule)))


-----------------------------------------------------
--	Loading Deprecations
-----------------------------------------------------
454
455

loadDeprec :: Module -> DeprecationEnv -> RdrNameDeprecation -> RnM d DeprecationEnv
456
loadDeprec mod deprec_env (Deprecation (IEModuleContents _) txt _)
457
  = traceRn (text "module deprecation not yet implemented:" <+> ppr mod <> colon <+> ppr txt) `thenRn_`
458
	-- SUP: TEMPORARY HACK, ignoring module deprecations for now
459
    returnRn deprec_env
460
461

loadDeprec mod deprec_env (Deprecation ie txt _)
462
463
  = setModuleRn mod					$
    mapRn lookupOrigName (ieNames ie)		`thenRn` \ names ->
464
    traceRn (text "loaded deprecation(s) for" <+> hcat (punctuate comma (map ppr names)) <> colon <+> ppr txt) `thenRn_`
465
    returnRn (extendNameEnvList deprec_env (zip names (repeat txt)))
466
\end{code}
467

468

469
470
%********************************************************
%*							*
471
\subsection{Checking usage information}
472
473
474
475
%*							*
%********************************************************

\begin{code}
476
477
478
upToDate  = True
outOfDate = False

479
480
481
482
checkModUsage :: [ImportVersion OccName] -> RnMG Bool
-- Given the usage information extracted from the old
-- M.hi file for the module being compiled, figure out
-- whether M needs to be recompiled.
483

484
checkModUsage [] = returnRn upToDate		-- Yes!  Everything is up to date!
485

486
checkModUsage ((mod_name, _, _, NothingAtAll) : rest)
487
488
489
490
491
492
493
494
	-- If CurrentModule.hi contains 
	--	import Foo :: ;
	-- then that simply records that Foo lies below CurrentModule in the
	-- hierarchy, but CurrentModule doesn't depend in any way on Foo.
	-- In this case we don't even want to open Foo's interface.
  = traceRn (ptext SLIT("Nothing used from:") <+> ppr mod_name)	`thenRn_`
    checkModUsage rest	-- This one's ok, so check the rest

495
checkModUsage ((mod_name, _, _, whats_imported)  : rest)
496
497
  = tryLoadInterface doc_str mod_name ImportBySystem	`thenRn` \ (ifaces, maybe_err) ->
    case maybe_err of {
498
	Just err -> out_of_date (sep [ptext SLIT("Can't find version number for module"), 
499
				      ppr mod_name]) ;
500
501
502
		-- Couldn't find or parse a module mentioned in the
		-- old interface file.  Don't complain -- it might just be that
		-- the current module doesn't need that import and it's been deleted
503

504
	Nothing -> 
505
    let
506
507
508
509
510
511
512
513
	(_, new_mod_vers, new_fix_vers, new_rule_vers, _, _) 
		= case lookupFM (iImpModInfo ifaces) mod_name of
			   Just (_, _, Just stuff) -> stuff

        old_mod_vers = case whats_imported of
			 Everything v 	     -> v
			 Specifically v _ _ _ -> v
			 -- NothingAtAll case dealt with by previous eqn for checkModUsage
514
    in
515
516
	-- If the module version hasn't changed, just move on
    if new_mod_vers == old_mod_vers then
517
	traceRn (sep [ptext SLIT("Module version unchanged:"), ppr mod_name])
518
	`thenRn_` checkModUsage rest
519
    else
520
    traceRn (sep [ptext SLIT("Module version has changed:"), ppr mod_name])
521
    `thenRn_`
522
523
524
525
526
	-- Module version changed, so check entities inside

	-- If the usage info wants to say "I imported everything from this module"
	--     it does so by making whats_imported equal to Everything
	-- In that case, we must recompile
527
528
529
530
    case whats_imported of {	-- NothingAtAll dealt with earlier
	
      Everything _ 
	-> out_of_date (ptext SLIT("...and I needed the whole module")) ;
531

532
      Specifically _ old_fix_vers old_rule_vers old_local_vers ->
533

534
535
536
537
538
    if old_fix_vers /= new_fix_vers then
	out_of_date (ptext SLIT("Fixities changed"))
    else if old_rule_vers /= new_rule_vers then
	out_of_date (ptext SLIT("Rules changed"))
    else	
539
	-- Non-empty usage list, so check item by item
540
    checkEntityUsage mod_name (iDecls ifaces) old_local_vers	`thenRn` \ up_to_date ->
541
    if up_to_date then
sof's avatar
sof committed
542
	traceRn (ptext SLIT("...but the bits I use haven't."))	`thenRn_`
543
544
	checkModUsage rest	-- This one's ok, so check the rest
    else
545
	returnRn outOfDate	-- This one failed, so just bail out now
546
    }}
547
  where
548
    doc_str = sep [ptext SLIT("need version info for"), ppr mod_name]
549
550


551
checkEntityUsage mod decls [] 
552
  = returnRn upToDate	-- Yes!  All up to date!
553

554
checkEntityUsage mod decls ((occ_name,old_vers) : rest)
555
  = newGlobalName mod occ_name 	`thenRn` \ name ->
556
    case lookupNameEnv decls name of
557
558

	Nothing       -> 	-- We used it before, but it ain't there now
559
			  out_of_date (sep [ptext SLIT("No longer exported:"), ppr name])
560

561
	Just (new_vers,_,_,_) 	-- It's there, but is it up to date?
562
563
564
565
566
567
		| new_vers == old_vers
			-- Up to date, so check the rest
		-> checkEntityUsage mod decls rest

		| otherwise
			-- Out of date, so bale out
568
569
570
		-> out_of_date (sep [ptext SLIT("Out of date:"), ppr name])

out_of_date msg = traceRn msg `thenRn_` returnRn outOfDate
571
572
573
\end{code}


574
575
576
577
578
%*********************************************************
%*							*
\subsection{Getting in a declaration}
%*							*
%*********************************************************
579

580
\begin{code}
581
582
583
584
585
586
587
importDecl :: Name -> RnMG ImportDeclResult

data ImportDeclResult
  = AlreadySlurped
  | WiredIn	
  | Deferred
  | HereItIs (Module, RdrNameHsDecl)
588
589

importDecl name
590
591
592
593
594
595
596
  = getIfacesRn				`thenRn` \ ifaces ->
    getHomeSymbolTableRn		`thenRn` \ hst ->
    if name `elemNameSet` iSlurp ifaces
    || inTypeEnv (iPST ifaces) name
    || inTypeEnv hst	       name
    then	-- Already dealt with
	returnRn AlreadySlurped	
597
598

    else if isLocallyDefined name then	-- Don't bring in decls from
599
					-- the renamed module's own interface file
600
601
	addWarnRn (importDeclWarn name) `thenRn_`
	returnRn AlreadySlurped
602

603
604
605
606
607
608
609
610
611
612
613
    else if isWiredInName name then
	-- When we find a wired-in name we must load its
	-- home module so that we find any instance decls therein
	loadHomeInterface doc name	`thenRn_`
	returnRn WiredIn

    else getNonWiredInDecl name
  where
    doc = ptext SLIT("need home module for wired in thing") <+> ppr name

getNonWiredInDecl :: Name -> RnMG ImportDeclResult
614
getNonWiredInDecl needed_name 
615
  = traceRn doc_str				`thenRn_`
616
    loadHomeInterface doc_str needed_name	`thenRn` \ ifaces ->
617
    case lookupNameEnv (iDecls ifaces) needed_name of
sof's avatar
sof committed
618

619
      Just (version, avail, is_tycon_name, decl@(_, TyClD (TyData DataType _ _ _ _ ncons _ _ _ _ _)))
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
	-- This case deals with deferred import of algebraic data types

	|  not opt_NoPruneTyDecls

	&& (opt_IgnoreIfacePragmas || ncons > 1)
		-- We only defer if imported interface pragmas are ingored
		-- or if it's not a product type.
		-- Sole reason: The wrapper for a strict function may need to look
		-- inside its arg, and hence need to see its arg type's constructors.

	&& not (getUnique tycon_name `elem` cCallishTyKeys)
		-- Never defer ccall types; we have to unbox them, 
		-- and importing them does no harm

	-> 	-- OK, so we're importing a deferrable data type
	    if needed_name == tycon_name then	
		-- The needed_name is the TyCon of a data type decl
		-- Record that it's slurped, put it in the deferred set
		-- and don't return a declaration at all
		setIfacesRn (recordSlurp (ifaces {iDeferred = iDeferred ifaces 
							      `addOneToNameSet` tycon_name})
				    	 version (AvailTC needed_name [needed_name]))	`thenRn_`
		returnRn Deferred
	    else
	 	-- The needed name is a constructor of a data type decl,
		-- getting a constructor, so remove the TyCon from the deferred set
		-- (if it's there) and return the full declaration
		 setIfacesRn (recordSlurp (ifaces {iDeferred = iDeferred ifaces 
							       `delFromNameSet` tycon_name})
				    version avail)	`thenRn_`
		 returnRn (HereItIs decl)
	where
	   tycon_name = availName avail

654
      Just (version,avail,_,decl)
655
656
	-> setIfacesRn (recordSlurp ifaces version avail)	`thenRn_`
	   returnRn (HereItIs decl)
657

658
      Nothing 
659
	-> addErrRn (getDeclErr needed_name)	`thenRn_` 
660
	   returnRn AlreadySlurped
661
  where
662
     doc_str = ptext SLIT("need decl for") <+> ppr needed_name
663
664
665
666
667
668
669
670
671
672
673
674

getDeferredDecls :: RnMG [(Module, RdrNameHsDecl)]
getDeferredDecls 
  = getIfacesRn		`thenRn` \ ifaces ->
    let
	decls_map   	    = iDecls ifaces
	deferred_names	    = nameSetToList (iDeferred ifaces)
        get_abstract_decl n = case lookupNameEnv decls_map n of
				 Just (_, _, _, decl) -> decl
    in
    traceRn (sep [text "getDeferredDecls", nest 4 (fsep (map ppr deferred_names))])	`thenRn_`
    returnRn (map get_abstract_decl deferred_names)
675
676
\end{code}

677
678
679
@getWiredInDecl@ maps a wired-in @Name@ to what it makes available.
It behaves exactly as if the wired in decl were actually in an interface file.
Specifically,
680
681
\begin{itemize}
\item	if the wired-in name is a data type constructor or a data constructor, 
682
	it brings in the type constructor and all the data constructors; and
683
	marks as ``occurrences'' any free vars of the data con.
684

685
\item 	similarly for synonum type constructor
686

687
\item 	if the wired-in name is another wired-in Id, it marks as ``occurrences''
688
	the free vars of the Id's type.
689

690
\item	it loads the interface file for the wired-in thing for the
691
	sole purpose of making sure that its instance declarations are available
692
693
\end{itemize}
All this is necessary so that we know all types that are ``in play'', so
694
695
that we know just what instances to bring into scope.
	
696
697


698
    
699
700
%*********************************************************
%*							*
sof's avatar
sof committed
701
\subsection{Getting what a module exports}
702
703
%*							*
%*********************************************************
704

705
@getInterfaceExports@ is called only for directly-imported modules.
706

707
\begin{code}
708
709
getInterfaceExports :: ModuleName -> WhereFrom -> RnMG (Module, Avails)
getInterfaceExports mod_name from
710
711
712
  = getHomeSymbolTableRn 		`thenRn` \ hst ->
    case lookupModuleEnvByName hst mod_name of {
	Just mds -> returnRn (mdModule mds, mdExports mds) ;
713
714
715
716
717
718
719
720
721
        Nothing  -> pprPanic "getInterfaceExports" (ppr mod_name)

-- I think this is what it _used_ to say.  JRS, 001017 
--    loadInterface doc_str mod_name from	`thenRn` \ ifaces ->
--    case lookupModuleEnv (iPST ifaces) mod_name of
--	Just mds -> returnRn (mdModule mod, mdExports mds)
--	-- loadInterface always puts something in the map
--	-- even if it's a fake

722
723
    }
    where
724
      doc_str = sep [ppr mod_name, ptext SLIT("is directly imported")]
sof's avatar
sof committed
725
726
727
728
729
\end{code}


%*********************************************************
%*							*
730
\subsection{Instance declarations are handled specially}
sof's avatar
sof committed
731
732
733
734
%*							*
%*********************************************************

\begin{code}
735
736
getImportedInstDecls :: NameSet -> RnMG [(Module,RdrNameHsDecl)]
getImportedInstDecls gates
737
  =    	-- First, load any orphan-instance modules that aren't aready loaded
738
	-- Orphan-instance modules are recorded in the module dependecnies
739
    getIfacesRn 					`thenRn` \ ifaces ->
sof's avatar
sof committed
740
    let
741
	orphan_mods =
742
	  [mod | (mod, (True, _, Nothing)) <- fmToList (iImpModInfo ifaces)]
sof's avatar
sof committed
743
    in
744
    loadOrphanModules orphan_mods			`thenRn_` 
745

746
	-- Now we're ready to grab the instance declarations
747
748
	-- Find the un-gated ones and return them, 
	-- removing them from the bag kept in Ifaces
749
    getIfacesRn 					`thenRn` \ ifaces ->
750
    let
751
752
753
	(decls, new_insts) = selectGated gates (iInsts ifaces)
    in
    setIfacesRn (ifaces { iInsts = new_insts })		`thenRn_`
754

755
    traceRn (sep [text "getImportedInstDecls:", 
756
		  nest 4 (fsep (map ppr gate_list)),
757
758
		  text "Slurped" <+> int (length decls) <+> text "instance declarations",
		  nest 4 (vcat (map ppr_brief_inst_decl decls))])	`thenRn_`
759
760
    returnRn decls
  where
761
762
    gate_list      = nameSetToList gates

763
764
765
766
767
ppr_brief_inst_decl (mod, InstD (InstDecl inst_ty _ _ _ _))
  = case inst_ty of
	HsForAllTy _ _ tau -> ppr tau
	other		   -> ppr inst_ty

768
getImportedRules :: RnMG [(Module,RdrNameHsDecl)]
769
770
771
getImportedRules 
  | opt_IgnoreIfacePragmas = returnRn []
  | otherwise
772
773
774
  = getIfacesRn 	`thenRn` \ ifaces ->
    let
	gates		   = iSlurp ifaces	-- Anything at all that's been slurped
775
776
	rules		   = iRules ifaces
	(decls, new_rules) = selectGated gates rules
777
    in
778
779
780
781
    if null decls then
	returnRn []
    else
    setIfacesRn (ifaces { iRules = new_rules })		     `thenRn_`
782
    traceRn (sep [text "getImportedRules:", 
783
		  text "Slurped" <+> int (length decls) <+> text "rules"])   `thenRn_`
784
    returnRn decls
785

786
selectGated gates decl_bag
787
	-- Select only those decls whose gates are *all* in 'gates'
788
789
790
#ifdef DEBUG
  | opt_NoPruneDecls	-- Just to try the effect of not gating at all
  = (foldrBag (\ (_,d) ds -> d:ds) [] decl_bag, emptyBag)	-- Grab them all
791

792
793
794
  | otherwise
#endif
  = foldrBag select ([], emptyBag) decl_bag
795
  where
796
797
798
799
    select (reqd, decl) (yes, no)
	| isEmptyNameSet (reqd `minusNameSet` gates) = (decl:yes, no)
	| otherwise				     = (yes,      (reqd,decl) `consBag` no)

800
801
lookupFixityRn :: Name -> RnMS Fixity
lookupFixityRn name
802
803
  | isLocallyDefined name
  = getFixityEnv			`thenRn` \ local_fix_env ->
804
    returnRn (lookupLocalFixity local_fix_env name)
805
806

  | otherwise	-- Imported
807
808
809
810
811
812
813
      -- For imported names, we have to get their fixities by doing a loadHomeInterface,
      -- and consulting the Ifaces that comes back from that, because the interface
      -- file for the Name might not have been loaded yet.  Why not?  Suppose you import module A,
      -- which exports a function 'f', which is defined in module B.  Then B isn't loaded
      -- right away (after all, it's possible that nothing from B will be used).
      -- When we come across a use of 'f', we need to know its fixity, and it's then,
      -- and only then, that we load B.hi.  That is what's happening here.
814
815
816
817
818
819
820
821
  = getHomeSymbolTableRn 		`thenRn` \ hst ->
    case lookupFixityEnv hst name of {
	Just fixity -> returnRn fixity ;
	Nothing	    -> 

    loadHomeInterface doc name		`thenRn` \ ifaces ->
    returnRn (lookupFixityEnv (iPST ifaces) name `orElse` defaultFixity) 
    }
822
  where
823
    doc = ptext SLIT("Checking fixity for") <+> ppr name
824
825
\end{code}

sof's avatar
sof committed
826
827
828
829
830
831
832

%*********************************************************
%*							*
\subsection{Keeping track of what we've slurped, and version numbers}
%*							*
%*********************************************************

833
834
835
836
getImportVersions figures out what the ``usage information'' for this
moudule is; that is, what it must record in its interface file as the
things it uses.  It records:

837
\begin{itemize}
838
839
840
\item	(a) anything reachable from its body code
\item	(b) any module exported with a @module Foo@
\item   (c) anything reachable from an exported item
841
\end{itemize}
842
843

Why (b)?  Because if @Foo@ changes then this module's export list
844
845
846
847
will change, so we must recompile this module at least as far as
making a new interface file --- but in practice that means complete
recompilation.

848
Why (c)?  Consider this:
849
850
851
852
853
\begin{verbatim}
	module A( f, g ) where	|	module B( f ) where
	  import B( f )		|	  f = h 3
	  g = ...		|	  h = ...
\end{verbatim}
854

855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
Here, @B.f@ isn't used in A.  Should we nevertheless record @B.f@ in
@A@'s usages?  Our idea is that we aren't going to touch A.hi if it is
*identical* to what it was before.  If anything about @B.f@ changes
than anyone who imports @A@ should be recompiled in case they use
@B.f@ (they'll get an early exit if they don't).  So, if anything
about @B.f@ changes we'd better make sure that something in A.hi
changes, and the convenient way to do that is to record the version
number @B.f@ in A.hi in the usage list.  If B.f changes that'll force a
complete recompiation of A, which is overkill but it's the only way to 
write a new, slightly different, A.hi.

But the example is tricker.  Even if @B.f@ doesn't change at all,
@B.h@ may do so, and this change may not be reflected in @f@'s version
number.  But with -O, a module that imports A must be recompiled if
@B.h@ changes!  So A must record a dependency on @B.h@.  So we treat
the occurrence of @B.f@ in the export list *just as if* it were in the
code of A, and thereby haul in all the stuff reachable from it.

[NB: If B was compiled with -O, but A isn't, we should really *still*
haul in all the unfoldings for B, in case the module that imports A *is*
compiled with -O.  I think this is the case.]

Even if B is used at all we get a usage line for B
	import B <n> :: ... ;
879
880
881
882
in A.hi, to record the fact that A does import B.  This is used to decide
to look to look for B.hi rather than B.hi-boot when compiling a module that
imports A.  This line says that A imports B, but uses nothing in it.
So we'll get an early bale-out when compiling A if B's version changes.
883

884
\begin{code}
885
886
887
888
889
890
891
892
893
mkImportExportInfo :: ModuleName			-- Name of this module
		   -> Avails				-- Info about exports 
		   -> Maybe [RdrNameIE]			-- The export header
		   -> RnMG ([ExportItem], 		-- Export info for iface file; sorted
			    [ImportVersion OccName])	-- Import info for iface file; sorted
			-- Both results are sorted into canonical order to
			-- reduce needless wobbling of interface files

mkImportExportInfo this_mod export_avails exports
894
895
  = getIfacesRn					`thenRn` \ ifaces ->
    let
896
897
898
899
900
	export_all_mods = case exports of
				Nothing -> []
				Just es -> [mod | IEModuleContents mod <- es, 
						  mod /= this_mod]

901
902
	mod_map   = iImpModInfo ifaces
	imp_names = iVSlurp     ifaces
903

904
	-- mv_map groups together all the things imported from a particular module.
905
	mv_map :: FiniteMap ModuleName [(OccName,Version)]
906
	mv_map = foldr add_mv emptyFM imp_names
907

908
909
910
        add_mv (name, version) mv_map = addItem mv_map (moduleName (nameModule name)) 
						       (nameOccName name, version)

911
	-- Build the result list by adding info for each module.
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
	-- For (a) a library module, we don't record it at all unless it contains orphans
	-- 	   (We must never lose track of orphans.)
	-- 
	--     (b) a source-imported module, don't record the dependency at all
	--	
	-- (b) may seem a bit strange.  The idea is that the usages in a .hi file records
	-- *all* the module's dependencies other than the loop-breakers.  We use
	-- this info in findAndReadInterface to decide whether to look for a .hi file or
	-- a .hi-boot file.  
	--
	-- This means we won't track version changes, or orphans, from .hi-boot files.
	-- The former is potentially rather bad news.  It could be fixed by recording
	-- whether something is a boot file along with the usage info for it, but 
	-- I can't be bothered just now.

927
	mk_imp_info mod_name (has_orphans, is_boot, contents) so_far
928
929
930
931
932
933
934
	   | mod_name == this_mod	-- Check if M appears in the set of modules 'below' M
					-- This seems like a convenient place to check
	   = WARN( not is_boot, ptext SLIT("Wierd:") <+> ppr this_mod <+> 
			        ptext SLIT("imports itself (perhaps indirectly)") )
	     so_far
 
	   | otherwise
935
	   = let
936
		go_for_it exports = (mod_name, has_orphans, is_boot, exports) 
937
                                    : so_far
938
939
940
941
942
943
944
945
	     in 
	     case contents of
		Nothing -> 	-- We didn't even open the interface
			-- This happens when a module, Foo, that we explicitly imported has 
			-- 'import Baz' in its interface file, recording that Baz is below
			-- Foo in the module dependency hierarchy.  We want to propagate this
			-- information.  The Nothing says that we didn't even open the interface
			-- file but we must still propagate the dependeny info.
946
			-- The module in question must be a local module (in the same package)
947
		   go_for_it NothingAtAll
948

949
		Just (mod, mod_vers, fix_vers, rule_vers, how_imported, _)
950
		   |  is_sys_import && is_lib_module && not has_orphans
951
		   -> so_far		
952
	   
953
954
		   |  is_lib_module 			-- Record the module but not detailed
		   || mod_name `elem` export_all_mods	-- version information for the imports
955
		   -> go_for_it (Everything mod_vers)
956
957
958

		   |  otherwise
		   -> case lookupFM mv_map mod_name of
959
960
961
			Just whats_imported -> go_for_it (Specifically mod_vers fix_vers rule_vers 
								       (sortImport whats_imported))
			Nothing		    -> go_for_it NothingAtAll
962
963
964
965
966
						-- This happens if you have
						--	import Foo
						-- but don't actually *use* anything from Foo
					 	-- In which case record an empty dependency list
		   where
967
		     is_lib_module = not (isModuleInThisPackage mod)
968
969
970
		     is_sys_import = case how_imported of
					ImportBySystem -> True
					other	       -> False
971
	     
972
973
974
975
976
977
978
979
980
981
982

	import_info = foldFM mk_imp_info [] mod_map

	-- Sort exports into groups by module
	export_fm :: FiniteMap ModuleName [RdrAvailInfo]
	export_fm = foldr insert emptyFM export_avails

        insert avail efm = addItem efm (moduleName (nameModule (availName avail)))
				       (rdrAvailInfo avail)

	export_info = [(m, sortExport as) | (m,as) <- fmToList export_fm]
sof's avatar
sof committed
983
    in
984
    traceRn (text "Modules in Ifaces: " <+> fsep (map ppr (keysFM mod_map)))	`thenRn_`
985
    returnRn (export_info, import_info)
986

987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002

addItem :: FiniteMap ModuleName [a] -> ModuleName -> a -> FiniteMap ModuleName [a]
addItem fm mod x = addToFM_C add_item fm mod [x]
		 where
		   add_item xs _ = x:xs

sortImport :: [(OccName,Version)] -> [(OccName,Version)]
	-- Make the usage lists appear in canonical order
sortImport vs = sortLt lt vs
	      where
		lt (n1,v1) (n2,v2) = n1 < n2

sortExport :: [RdrAvailInfo] -> [RdrAvailInfo]
sortExport as = sortLt lt as
	      where
		lt a1 a2 = availName a1 < availName a2
1003
\end{code}
1004

sof's avatar
sof committed
1005
\begin{code}
1006
getSlurped
sof's avatar
sof committed
1007
  = getIfacesRn 	`thenRn` \ ifaces ->
1008
    returnRn (iSlurp ifaces)
sof's avatar
sof committed
1009

1010
1011
1012
recordSlurp ifaces@(Ifaces { iSlurp = slurped_names, iVSlurp = imp_names })
	    version avail
  = let
sof's avatar
sof committed
1013
	new_slurped_names = addAvailToNameSet slurped_names avail
1014
1015
1016
	new_imp_names = (availName avail, version) : imp_names
    in
    ifaces { iSlurp  = new_slurped_names, iVSlurp = new_imp_names }
sof's avatar
sof committed
1017

1018
1019
1020
1021
recordLocalSlurps local_avails
  = getIfacesRn 	`thenRn` \ ifaces ->
    let
	new_slurped_names = foldl addAvailToNameSet (iSlurp ifaces) local_avails
sof's avatar
sof committed
1022
    in
1023
    setIfacesRn (ifaces { iSlurp  = new_slurped_names })
sof's avatar
sof committed
1024
1025
1026
\end{code}


1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
%*********************************************************
%*							*
\subsection{Getting binders out of a declaration}
%*							*
%*********************************************************

@getDeclBinders@ returns the names for a @RdrNameHsDecl@.
It's used for both source code (from @availsFromDecl@) and interface files
(from @loadDecl@).

1037
1038
It doesn't deal with source-code specific things: @ValD@, @DefD@.  They
are handled by the sourc-code specific stuff in @RnNames@.
1039

1040
\begin{code}
1041
getDeclBinders :: (RdrName -> SrcLoc -> RnM d Name)	-- New-name function
1042
		-> RdrNameHsDecl
1043
		-> RnM d (Maybe AvailInfo)
1044

1045
getDeclBinders new_name (TyClD (TyData _ _ tycon _ condecls _ _ _ src_loc _ _))
1046
1047
  = new_name tycon src_loc			`thenRn` \ tycon_name ->
    getConFieldNames new_name condecls		`thenRn` \ sub_names ->
1048
    returnRn (Just (AvailTC tycon_name (tycon_name : nub sub_names)))
sof's avatar
sof committed
1049
1050
	-- The "nub" is because getConFieldNames can legitimately return duplicates,
	-- when a record declaration has the same field in multiple constructors
1051

1052
getDeclBinders new_name (TyClD (TySynonym tycon _ _ src_loc))
1053
  = new_name tycon src_loc		`thenRn` \ tycon_name ->
1054
    returnRn (Just (AvailTC tycon_name [tycon_name]))
1055

1056
getDeclBinders new_name (TyClD (ClassDecl _ cname _ _ sigs _ _ _ src_loc))
1057
  = new_name cname src_loc			`thenRn` \ class_name ->
1058
1059

	-- Record the names for the class ops
sof's avatar
sof committed
1060
    let
sof's avatar
sof committed
1061
1062
	-- just want class-op sigs
	op_sigs = filter isClassOpSig sigs
sof's avatar
sof committed
1063
    in
sof's avatar
sof committed
1064
    mapRn (getClassOpNames new_name) op_sigs	`thenRn` \ sub_names ->
1065

1066
    returnRn (Just (AvailTC class_name (class_name : sub_names)))
1067
1068
1069

getDeclBinders new_name (SigD (IfaceSig var ty prags src_loc))
  = new_name var src_loc			`thenRn` \ var_name ->
1070
    returnRn (Just (Avail var_name))
1071

1072
1073
getDeclBinders new_name (FixD _)    = returnRn Nothing
getDeclBinders new_name (DeprecD _) = returnRn Nothing
sof's avatar
sof committed
1074
1075
1076
1077
1078
1079
1080

    -- foreign declarations
getDeclBinders new_name (ForD (ForeignDecl nm kind _ dyn _ loc))
  | binds_haskell_name kind dyn
  = new_name nm loc		    `thenRn` \ name ->
    returnRn (Just (Avail name))

1081
1082
  | otherwise 		-- a foreign export
  = lookupOrigName nm `thenRn_` 
sof's avatar
sof committed
1083
1084
    returnRn Nothing