2 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
4 \section[RnEnv]{Environment manipulation for the renamer monad}
7 module RnEnv where -- Export everything
9 #include "HsVersions.h"
11 import {-# SOURCE #-} RnHiFiles( loadInterface )
13 import FlattenInfo ( namesNeededForFlattening )
15 import RdrHsSyn ( RdrNameHsType, RdrNameFixitySig, extractHsTyRdrTyVars )
16 import RdrName ( RdrName, rdrNameModule, rdrNameOcc, isQual, isUnqual, isOrig,
17 mkRdrUnqual, mkRdrQual, setRdrNameSpace, rdrNameOcc,
18 lookupRdrEnv, rdrEnvToList, elemRdrEnv,
19 extendRdrEnv, addListToRdrEnv, emptyRdrEnv,
20 isExact_maybe, unqualifyRdrName
22 import HsTypes ( hsTyVarName, replaceTyVarName )
23 import HscTypes ( Provenance(..), pprNameProvenance, hasBetterProv,
24 ImportReason(..), GlobalRdrEnv, GlobalRdrElt(..),
25 GenAvailInfo(..), AvailInfo, Avails,
26 ModIface(..), NameCache(..), OrigNameCache,
27 Deprecations(..), lookupDeprec, isLocalGRE,
28 extendLocalRdrEnv, availName, availNames,
32 import Name ( Name, getName, nameIsLocalOrFrom,
33 isWiredInName, mkInternalName, mkExternalName, mkIPName,
34 nameSrcLoc, nameOccName, setNameSrcLoc, nameModule )
36 import OccName ( OccName, tcName, isDataOcc, occNameFlavour, reportIfUnused )
37 import Module ( Module, ModuleName, moduleName, mkHomeModule,
38 lookupModuleEnv, lookupModuleEnvByName, extendModuleEnv_C )
39 import PrelNames ( mkUnboundName, intTyConName,
40 boolTyConName, funTyConName,
41 unpackCStringName, unpackCStringFoldrName, unpackCStringUtf8Name,
42 eqStringName, printName,
43 bindIOName, returnIOName, failIOName, thenIOName
46 import DsMeta ( templateHaskellNames, qTyConName )
48 import TysWiredIn ( unitTyCon ) -- A little odd
49 import Finder ( findModule )
52 import SrcLoc ( SrcLoc, importedSrcLoc )
54 import ListSetOps ( removeDups, equivClasses )
55 import BasicTypes ( mapIPName, FixitySig(..) )
58 import FastString ( FastString )
61 %*********************************************************
63 \subsection{Making new names}
65 %*********************************************************
68 newTopBinder :: Module -> RdrName -> SrcLoc -> TcRn m Name
69 newTopBinder mod rdr_name loc
70 | Just name <- isExact_maybe rdr_name
74 = ASSERT( not (isOrig rdr_name) || rdrNameModule rdr_name == moduleName mod )
75 -- When reading External Core we get Orig names as binders,
76 -- but they should agree with the module gotten from the monad
77 newGlobalName mod (rdrNameOcc rdr_name) loc
79 newGlobalName :: Module -> OccName -> SrcLoc -> TcRn m Name
80 newGlobalName mod occ loc
81 = -- First check the cache
82 getNameCache `thenM` \ name_supply ->
83 case lookupOrigNameCache (nsNames name_supply) mod occ of
85 -- A hit in the cache! We are at the binding site of the name.
86 -- This is the moment when we know the defining SrcLoc
87 -- of the Name, so we set the SrcLoc of the name we return.
89 -- Main reason: then (bogus) multiple bindings of the same Name
90 -- get different SrcLocs can can be reported as such.
92 -- Possible other reason: it might be in the cache because we
93 -- encountered an occurrence before the binding site for an
94 -- implicitly-imported Name. Perhaps the current SrcLoc is
95 -- better... but not really: it'll still just say 'imported'
97 -- IMPORTANT: Don't mess with wired-in names.
98 -- Their wired-in-ness is in the SrcLoc
100 Just name | isWiredInName name -> returnM name
101 | otherwise -> returnM (setNameSrcLoc name loc)
103 -- Miss in the cache!
104 -- Build a completely new Name, and put it in the cache
105 Nothing -> addNewName name_supply mod occ loc
107 -- Look up a "system name" in the name cache.
108 -- This is done by the type checker...
109 lookupSysName :: Name -- Base name
110 -> (OccName -> OccName) -- Occurrence name modifier
111 -> TcRn m Name -- System name
112 lookupSysName base_name mk_sys_occ
113 = newGlobalName (nameModule base_name)
114 (mk_sys_occ (nameOccName base_name))
115 (nameSrcLoc base_name)
118 newGlobalNameFromRdrName rdr_name -- Qualified original name
119 = newGlobalName2 (rdrNameModule rdr_name) (rdrNameOcc rdr_name)
121 newGlobalName2 :: ModuleName -> OccName -> TcRn m Name
122 -- This one starts with a ModuleName, not a Module, because
123 -- we may be simply looking at an occurrence M.x in an interface file.
125 -- Used for *occurrences*. Even if we get a miss in the
126 -- original-name cache, we make a new External Name.
127 -- We get its Module either from the OrigNameCache, or (if this
128 -- is the first Name from that module) from the Finder
130 -- In the case of a miss, we have to make up the SrcLoc, but that's
131 -- OK: it must be an implicitly-imported Name, and that never occurs
132 -- in an error message.
134 newGlobalName2 mod_name occ
135 = getNameCache `thenM` \ name_supply ->
137 new_name mod = addNewName name_supply mod occ importedSrcLoc
139 case lookupModuleEnvByName (nsNames name_supply) mod_name of
140 Just (mod, occ_env) ->
141 -- There are some names from this module already
142 -- Next, look up in the OccNameEnv
143 case lookupFM occ_env occ of
144 Just name -> returnM name
145 Nothing -> new_name mod
147 Nothing -> -- No names from this module yet
148 ioToTcRn (findModule mod_name) `thenM` \ mb_loc ->
150 Right (mod, _) -> new_name mod
152 getDOpts `thenM` \ dflags ->
153 addErr (noIfaceErr dflags mod_name False files) `thenM_`
154 -- Things have really gone wrong at this point,
155 -- so having the wrong package info in the
156 -- Module is the least of our worries.
157 new_name (mkHomeModule mod_name)
160 newIPName rdr_name_ip
161 = getNameCache `thenM` \ name_supply ->
163 ipcache = nsIPs name_supply
165 case lookupFM ipcache key of
166 Just name_ip -> returnM name_ip
167 Nothing -> setNameCache new_ns `thenM_`
170 (us', us1) = splitUniqSupply (nsUniqs name_supply)
171 uniq = uniqFromSupply us1
172 name_ip = mapIPName mk_name rdr_name_ip
173 mk_name rdr_name = mkIPName uniq (rdrNameOcc rdr_name)
174 new_ipcache = addToFM ipcache key name_ip
175 new_ns = name_supply {nsUniqs = us', nsIPs = new_ipcache}
177 key = rdr_name_ip -- Ensures that ?x and %x get distinct Names
179 -- A local helper function
180 addNewName name_supply mod occ loc
181 = setNameCache new_name_supply `thenM_`
184 (new_name_supply, name) = newExternalName name_supply mod occ loc
187 newExternalName :: NameCache -> Module -> OccName -> SrcLoc
189 -- Allocate a new unique, manufacture a new External Name,
190 -- put it in the cache, and return the two
191 newExternalName name_supply mod occ loc
192 = (new_name_supply, name)
194 (us', us1) = splitUniqSupply (nsUniqs name_supply)
195 uniq = uniqFromSupply us1
196 name = mkExternalName uniq mod occ loc
197 new_cache = extend_name_cache (nsNames name_supply) mod occ name
198 new_name_supply = name_supply {nsUniqs = us', nsNames = new_cache}
200 lookupOrigNameCache :: OrigNameCache -> Module -> OccName -> Maybe Name
201 lookupOrigNameCache nc mod occ
202 = case lookupModuleEnv nc mod of
204 Just (_, occ_env) -> lookupFM occ_env occ
206 extendOrigNameCache :: OrigNameCache -> Name -> OrigNameCache
207 extendOrigNameCache nc name
208 = extend_name_cache nc (nameModule name) (nameOccName name) name
210 extend_name_cache :: OrigNameCache -> Module -> OccName -> Name -> OrigNameCache
211 extend_name_cache nc mod occ name
212 = extendModuleEnv_C combine nc mod (mod, unitFM occ name)
214 combine (mod, occ_env) _ = (mod, addToFM occ_env occ name)
217 %*********************************************************
219 \subsection{Looking up names}
221 %*********************************************************
223 Looking up a name in the RnEnv.
226 lookupBndrRn rdr_name
227 = getLocalRdrEnv `thenM` \ local_env ->
228 case lookupRdrEnv local_env rdr_name of
229 Just name -> returnM name
230 Nothing -> lookupTopBndrRn rdr_name
232 lookupTopBndrRn rdr_name
233 -- Look up a top-level local binder. We may be looking up an unqualified 'f',
234 -- and there may be several imported 'f's too, which must not confuse us.
235 -- So we have to filter out the non-local ones.
236 -- A separate function (importsFromLocalDecls) reports duplicate top level
237 -- decls, so here it's safe just to choose an arbitrary one.
239 -- There should never be a qualified name in a binding position in Haskell,
240 -- but there can be if we have read in an external-Core file.
241 -- The Haskell parser checks for the illegal qualified name in Haskell
242 -- source files, so we don't need to do so here.
244 = getModeRn `thenM` \ mode ->
247 getSrcLocM `thenM` \ loc ->
248 newTopBinder mod rdr_name loc
250 other -> lookupTopSrcBndr rdr_name
252 lookupTopSrcBndr :: RdrName -> TcRn m Name
253 lookupTopSrcBndr rdr_name
254 = lookupTopSrcBndr_maybe rdr_name `thenM` \ maybe_name ->
256 Just name -> returnM name
257 Nothing -> unboundName rdr_name
260 lookupTopSrcBndr_maybe :: RdrName -> TcRn m (Maybe Name)
261 -- Look up a source-code binder
263 -- Ignores imported names; for example, this is OK:
265 -- infix 9 f -- The 'f' here does not need to be qualified
266 -- f x = x -- Nor here, of course
268 lookupTopSrcBndr_maybe rdr_name
269 | Just name <- isExact_maybe rdr_name
270 -- This is here just to catch the PrelBase defn of (say) [] and similar
271 -- The parser reads the special syntax and returns an Exact RdrName
272 -- But the global_env contains only Qual RdrNames, so we won't
273 -- find it there; instead just get the name via the Orig route
275 -- We are at a binding site for the name, so check first that it
276 -- the current module is the correct one; otherwise GHC can get
277 -- very confused indeed. This test rejects code like
278 -- data T = (,) Int Int
279 -- unless we are in GHC.Tup
280 = getModule `thenM` \ mod ->
281 checkErr (moduleName mod == moduleName (nameModule name))
282 (badOrigBinding rdr_name) `thenM_`
286 = getGlobalRdrEnv `thenM` \ global_env ->
287 case lookupRdrEnv global_env rdr_name of
288 Nothing -> returnM Nothing
289 Just gres -> case [gre_name gre | gre <- gres, isLocalGRE gre] of
290 [] -> returnM Nothing
291 (n:ns) -> returnM (Just n)
294 -- lookupSigOccRn is used for type signatures and pragmas
300 -- It's clear that the 'f' in the signature must refer to A.f
301 -- The Haskell98 report does not stipulate this, but it will!
302 -- So we must treat the 'f' in the signature in the same way
303 -- as the binding occurrence of 'f', using lookupBndrRn
304 lookupSigOccRn :: RdrName -> RnM Name
305 lookupSigOccRn = lookupBndrRn
307 -- lookupInstDeclBndr is used for the binders in an
308 -- instance declaration. Here we use the class name to
311 lookupInstDeclBndr :: Name -> RdrName -> RnM Name
312 -- We use the selector name as the binder
313 lookupInstDeclBndr cls_name rdr_name
315 = -- Find all the things the class op name maps to
316 -- and pick the one with the right parent name
317 getGblEnv `thenM` \ gbl_env ->
319 avail_env = imp_env (tcg_imports gbl_env)
320 occ = rdrNameOcc rdr_name
322 case lookupAvailEnv_maybe avail_env cls_name of
324 -- If the class itself isn't in scope, then cls_name will
325 -- be unboundName, and there'll already be an error for
326 -- that in the error list. Example:
327 -- e.g. import Prelude hiding( Ord )
328 -- instance Ord T where ...
329 -- The program is wrong, but that should not cause a crash.
330 returnM (mkUnboundName rdr_name)
332 Just (AvailTC _ ns) -> case [n | n <- ns, nameOccName n == occ] of
333 (n:ns)-> ASSERT( null ns ) returnM n
334 [] -> unboundName rdr_name
336 other -> pprPanic "lookupInstDeclBndr" (ppr cls_name)
339 | otherwise -- Occurs in derived instances, where we just
340 -- refer directly to the right method, and avail_env
342 = ASSERT2( not (isQual rdr_name), ppr rdr_name )
343 -- NB: qualified names are rejected by the parser
344 lookupOrigName rdr_name
347 lookupSysBndr :: RdrName -> RnM Name
348 -- Used for the 'system binders' in a data type or class declaration
349 -- Do *not* look up in the RdrEnv; these system binders are never in scope
350 -- Instead, get the module from the monad... but remember that
351 -- where the module is depends on whether we are renaming source or
352 -- interface file stuff
353 lookupSysBndr rdr_name
354 = getSrcLocM `thenM` \ loc ->
355 getModeRn `thenM` \ mode ->
357 InterfaceMode mod -> newTopBinder mod rdr_name loc
358 other -> getModule `thenM` \ mod ->
359 newTopBinder mod rdr_name loc
361 -- lookupOccRn looks up an occurrence of a RdrName
362 lookupOccRn :: RdrName -> RnM Name
364 = getLocalRdrEnv `thenM` \ local_env ->
365 case lookupRdrEnv local_env rdr_name of
366 Just name -> returnM name
367 Nothing -> lookupGlobalOccRn rdr_name
369 -- lookupGlobalOccRn is like lookupOccRn, except that it looks in the global
370 -- environment. It's used only for
371 -- record field names
372 -- class op names in class and instance decls
374 lookupGlobalOccRn rdr_name
375 = getModeRn `thenM` \ mode ->
377 InterfaceMode mod -> lookupIfaceName mod rdr_name
378 SourceMode -> lookupSrcName rdr_name
381 | not (isQual rdr_name) ->
382 lookupSrcName rdr_name
384 -- We allow qualified names on the command line to refer to
385 -- *any* name exported by any module in scope, just as if
386 -- there was an "import qualified M" declaration for every
389 -- First look up the name in the normal environment. If
390 -- it isn't there, we manufacture a new occurrence of an
393 lookupSrcName_maybe rdr_name `thenM` \ mb_name ->
395 Just name -> returnM name
396 Nothing -> lookupQualifiedName rdr_name
398 -- A qualified name on the command line can refer to any module at all: we
399 -- try to load the interface if we don't already have it.
400 lookupQualifiedName :: RdrName -> TcRn m Name
401 lookupQualifiedName rdr_name
403 mod = rdrNameModule rdr_name
404 occ = rdrNameOcc rdr_name
406 loadInterface (ppr rdr_name) mod (ImportByUser False) `thenM` \ iface ->
407 case [ name | (_,avails) <- mi_exports iface,
409 name <- availNames avail,
410 nameOccName name == occ ] of
411 (n:ns) -> ASSERT (null ns) returnM n
412 _ -> unboundName rdr_name
414 lookupSrcName :: RdrName -> TcRn m Name
415 lookupSrcName rdr_name
416 = lookupSrcName_maybe rdr_name `thenM` \ mb_name ->
418 Nothing -> unboundName rdr_name
419 Just name -> returnM name
421 lookupSrcName_maybe :: RdrName -> TcRn m (Maybe Name)
422 lookupSrcName_maybe rdr_name
423 | Just name <- isExact_maybe rdr_name -- Can occur in source code too
424 = returnM (Just name)
426 | isOrig rdr_name -- An original name
427 = newGlobalNameFromRdrName rdr_name `thenM` \ name ->
431 = lookupGRE rdr_name `thenM` \ mb_gre ->
433 Nothing -> returnM Nothing
434 Just gre -> returnM (Just (gre_name gre))
436 lookupGRE :: RdrName -> TcRn m (Maybe GlobalRdrElt)
438 = getGlobalRdrEnv `thenM` \ global_env ->
439 case lookupRdrEnv global_env rdr_name of
440 Just [gre] -> case gre_deprec gre of
441 Nothing -> returnM (Just gre)
442 Just _ -> warnDeprec gre `thenM_`
444 Just stuff@(gre : _) -> addNameClashErrRn rdr_name stuff `thenM_`
446 Nothing -> return Nothing
448 lookupIfaceName :: Module -> RdrName -> TcRn m Name
449 -- An Unqual is allowed; interface files contain
450 -- unqualified names for locally-defined things, such as
451 -- constructors of a data type.
452 lookupIfaceName mod rdr_name
453 | isUnqual rdr_name = newGlobalName mod (rdrNameOcc rdr_name) importedSrcLoc
454 | otherwise = lookupOrigName rdr_name
456 lookupOrigName :: RdrName -> TcRn m Name
457 -- Just for original or exact names
458 lookupOrigName rdr_name
459 | Just n <- isExact_maybe rdr_name
460 -- This happens in derived code, which we
461 -- rename in InterfaceMode
464 | otherwise -- Usually Orig, but can be a Qual when
465 -- we are reading a .hi-boot file
466 = newGlobalNameFromRdrName rdr_name
469 dataTcOccs :: RdrName -> [RdrName]
470 -- If the input is a data constructor, return both it and a type
471 -- constructor. This is useful when we aren't sure which we are
474 | isDataOcc occ = [rdr_name, rdr_name_tc]
475 | otherwise = [rdr_name]
477 occ = rdrNameOcc rdr_name
478 rdr_name_tc = setRdrNameSpace rdr_name tcName
482 unboundName rdr_name = addErr (unknownNameErr rdr_name) `thenM_`
483 returnM (mkUnboundName rdr_name)
486 %*********************************************************
490 %*********************************************************
493 --------------------------------
494 bindLocalFixities :: [RdrNameFixitySig] -> RnM a -> RnM a
495 -- Used for nested fixity decls
496 -- No need to worry about type constructors here,
497 -- Should check for duplicates but we don't
498 bindLocalFixities fixes thing_inside
499 | null fixes = thing_inside
500 | otherwise = mappM rn_sig fixes `thenM` \ new_bit ->
501 extendFixityEnv new_bit thing_inside
503 rn_sig (FixitySig v fix src_loc)
504 = addSrcLoc src_loc $
505 lookupSigOccRn v `thenM` \ new_v ->
506 returnM (new_v, FixitySig new_v fix src_loc)
509 --------------------------------
510 lookupFixity is a bit strange.
512 * Nested local fixity decls are put in the local fixity env, which we
513 find with getFixtyEnv
515 * Imported fixities are found in the HIT or PIT
517 * Top-level fixity decls in this module may be for Names that are
518 either Global (constructors, class operations)
519 or Local/Exported (everything else)
520 (See notes with RnNames.getLocalDeclBinders for why we have this split.)
521 We put them all in the local fixity environment
524 lookupFixityRn :: Name -> RnM Fixity
526 = getModule `thenM` \ this_mod ->
527 if nameIsLocalOrFrom this_mod name
528 then -- It's defined in this module
529 getFixityEnv `thenM` \ local_fix_env ->
530 returnM (lookupFixity local_fix_env name)
532 else -- It's imported
533 -- For imported names, we have to get their fixities by doing a
534 -- loadHomeInterface, and consulting the Ifaces that comes back
535 -- from that, because the interface file for the Name might not
536 -- have been loaded yet. Why not? Suppose you import module A,
537 -- which exports a function 'f', thus;
538 -- module CurrentModule where
540 -- module A( f ) where
542 -- Then B isn't loaded right away (after all, it's possible that
543 -- nothing from B will be used). When we come across a use of
544 -- 'f', we need to know its fixity, and it's then, and only
545 -- then, that we load B.hi. That is what's happening here.
546 loadInterface doc name_mod ImportBySystem `thenM` \ iface ->
547 returnM (lookupFixity (mi_fixities iface) name)
549 doc = ptext SLIT("Checking fixity for") <+> ppr name
550 name_mod = moduleName (nameModule name)
554 %*********************************************************
556 \subsection{Implicit free vars and sugar names}
558 %*********************************************************
560 @getXImplicitFVs@ forces the renamer to slurp in some things which aren't
561 mentioned explicitly, but which might be needed by the type checker.
564 implicitStmtFVs source_fvs -- Compiling a statement
565 = stmt_fvs `plusFV` implicitModuleFVs source_fvs
567 stmt_fvs = mkFVs [printName, bindIOName, thenIOName, returnIOName, failIOName]
568 -- These are all needed implicitly when compiling a statement
569 -- See TcModule.tc_stmts
571 implicitModuleFVs source_fvs
572 = mkTemplateHaskellFVs source_fvs `plusFV`
573 namesNeededForFlattening `plusFV`
577 thProxyName :: NameSet
578 mkTemplateHaskellFVs :: NameSet -> NameSet
579 -- This is a bit of a hack. When we see the Template-Haskell construct
581 -- we are going to need lots of the ``smart constructors'' defined in
582 -- the main Template Haskell data type module. Rather than treat them
583 -- all as free vars at every occurrence site, we just make the Q type
584 -- consructor a free var.... and then use that here to haul in the others
587 --------------- Template Haskell enabled --------------
588 thProxyName = unitFV qTyConName
590 mkTemplateHaskellFVs source_fvs
591 | qTyConName `elemNameSet` source_fvs = templateHaskellNames
592 | otherwise = emptyFVs
595 --------------- Template Haskell disabled --------------
597 thProxyName = emptyFVs
598 mkTemplateHaskellFVs source_fvs = emptyFVs
600 --------------------------------------------------------
602 -- ubiquitous_names are loaded regardless, because
603 -- they are needed in virtually every program
605 = mkFVs [unpackCStringName, unpackCStringFoldrName,
606 unpackCStringUtf8Name, eqStringName,
607 -- Virtually every program has error messages in it somewhere
608 getName unitTyCon, funTyConName, boolTyConName, intTyConName]
609 -- Add occurrences for very frequently used types.
610 -- (e.g. we don't want to be bothered with making
611 -- funTyCon a free var at every function application!)
614 %************************************************************************
616 \subsection{Re-bindable desugaring names}
618 %************************************************************************
620 Haskell 98 says that when you say "3" you get the "fromInteger" from the
621 Standard Prelude, regardless of what is in scope. However, to experiment
622 with having a language that is less coupled to the standard prelude, we're
623 trying a non-standard extension that instead gives you whatever "Prelude.fromInteger"
624 happens to be in scope. Then you can
626 import MyPrelude as Prelude
627 to get the desired effect.
629 At the moment this just happens for
630 * fromInteger, fromRational on literals (in expressions and patterns)
631 * negate (in expressions)
632 * minus (arising from n+k patterns)
635 We store the relevant Name in the HsSyn tree, in
636 * HsIntegral/HsFractional
640 respectively. Initially, we just store the "standard" name (PrelNames.fromIntegralName,
641 fromRationalName etc), but the renamer changes this to the appropriate user
642 name if Opt_NoImplicitPrelude is on. That is what lookupSyntaxName does.
644 We treat the orignal (standard) names as free-vars too, because the type checker
645 checks the type of the user thing against the type of the standard thing.
648 lookupSyntaxName :: Name -- The standard name
649 -> RnM (Name, FreeVars) -- Possibly a non-standard name
650 lookupSyntaxName std_name
651 = getModeRn `thenM` \ mode ->
652 if isInterfaceMode mode then
653 returnM (std_name, unitFV std_name)
654 -- Happens for 'derived' code
655 -- where we don't want to rebind
658 doptM Opt_NoImplicitPrelude `thenM` \ no_prelude ->
659 if not no_prelude then
660 returnM (std_name, unitFV std_name) -- Normal case
663 -- Get the similarly named thing from the local environment
664 lookupOccRn (mkRdrUnqual (nameOccName std_name)) `thenM` \ usr_name ->
665 returnM (usr_name, mkFVs [usr_name, std_name])
669 %*********************************************************
673 %*********************************************************
676 newLocalsRn :: [(RdrName,SrcLoc)]
678 newLocalsRn rdr_names_w_loc
679 = newUniqueSupply `thenM` \ us ->
681 uniqs = uniqsFromSupply us
682 names = [ mkInternalName uniq (rdrNameOcc rdr_name) loc
683 | ((rdr_name,loc), uniq) <- rdr_names_w_loc `zip` uniqs
689 bindLocatedLocalsRn :: SDoc -- Documentation string for error message
690 -> [(RdrName,SrcLoc)]
693 bindLocatedLocalsRn doc_str rdr_names_w_loc enclosed_scope
694 = getModeRn `thenM` \ mode ->
695 getLocalRdrEnv `thenM` \ local_env ->
696 getGlobalRdrEnv `thenM` \ global_env ->
698 -- Check for duplicate names
699 checkDupOrQualNames doc_str rdr_names_w_loc `thenM_`
701 -- Warn about shadowing, but only in source modules
703 check_shadow (rdr_name,loc)
704 | rdr_name `elemRdrEnv` local_env
705 || rdr_name `elemRdrEnv` global_env
706 = addSrcLoc loc $ addWarn (shadowedNameWarn rdr_name)
712 SourceMode -> ifOptM Opt_WarnNameShadowing $
713 mappM_ check_shadow rdr_names_w_loc
717 newLocalsRn rdr_names_w_loc `thenM` \ names ->
719 new_local_env = addListToRdrEnv local_env (map fst rdr_names_w_loc `zip` names)
721 setLocalRdrEnv new_local_env (enclosed_scope names)
723 bindCoreLocalRn :: RdrName -> (Name -> RnM a) -> RnM a
724 -- A specialised variant when renaming stuff from interface
725 -- files (of which there is a lot)
727 -- * no checks for shadowing
729 -- * deal with free vars
730 bindCoreLocalRn rdr_name enclosed_scope
731 = getSrcLocM `thenM` \ loc ->
732 getLocalRdrEnv `thenM` \ name_env ->
733 newUnique `thenM` \ uniq ->
735 name = mkInternalName uniq (rdrNameOcc rdr_name) loc
736 new_name_env = extendRdrEnv name_env rdr_name name
738 setLocalRdrEnv new_name_env (enclosed_scope name)
740 bindCoreLocalsRn [] thing_inside = thing_inside []
741 bindCoreLocalsRn (b:bs) thing_inside = bindCoreLocalRn b $ \ name' ->
742 bindCoreLocalsRn bs $ \ names' ->
743 thing_inside (name':names')
745 bindLocalNames names enclosed_scope
746 = getLocalRdrEnv `thenM` \ name_env ->
747 setLocalRdrEnv (extendLocalRdrEnv name_env names)
750 bindLocalNamesFV names enclosed_scope
751 = bindLocalNames names $
752 enclosed_scope `thenM` \ (thing, fvs) ->
753 returnM (thing, delListFromNameSet fvs names)
756 -------------------------------------
757 bindLocalRn doc rdr_name enclosed_scope
758 = getSrcLocM `thenM` \ loc ->
759 bindLocatedLocalsRn doc [(rdr_name,loc)] $ \ (n:ns) ->
763 bindLocalsRn doc rdr_names enclosed_scope
764 = getSrcLocM `thenM` \ loc ->
765 bindLocatedLocalsRn doc
766 (rdr_names `zip` repeat loc)
769 -- binLocalsFVRn is the same as bindLocalsRn
770 -- except that it deals with free vars
771 bindLocalsFV doc rdr_names enclosed_scope
772 = bindLocalsRn doc rdr_names $ \ names ->
773 enclosed_scope names `thenM` \ (thing, fvs) ->
774 returnM (thing, delListFromNameSet fvs names)
776 -------------------------------------
777 extendTyVarEnvFVRn :: [Name] -> RnM (a, FreeVars) -> RnM (a, FreeVars)
778 -- This tiresome function is used only in rnSourceDecl on InstDecl
779 extendTyVarEnvFVRn tyvars enclosed_scope
780 = bindLocalNames tyvars enclosed_scope `thenM` \ (thing, fvs) ->
781 returnM (thing, delListFromNameSet fvs tyvars)
783 bindTyVarsRn :: SDoc -> [HsTyVarBndr RdrName]
784 -> ([HsTyVarBndr Name] -> RnM a)
786 bindTyVarsRn doc_str tyvar_names enclosed_scope
787 = getSrcLocM `thenM` \ loc ->
789 located_tyvars = [(hsTyVarName tv, loc) | tv <- tyvar_names]
791 bindLocatedLocalsRn doc_str located_tyvars $ \ names ->
792 enclosed_scope (zipWith replaceTyVarName tyvar_names names)
794 bindPatSigTyVars :: [RdrNameHsType] -> ([Name] -> RnM a) -> RnM a
795 -- Find the type variables in the pattern type
796 -- signatures that must be brought into scope
798 bindPatSigTyVars tys thing_inside
799 = getLocalRdrEnv `thenM` \ name_env ->
800 getSrcLocM `thenM` \ loc ->
802 forall_tyvars = nub [ tv | ty <- tys,
803 tv <- extractHsTyRdrTyVars ty,
804 not (tv `elemFM` name_env)
806 -- The 'nub' is important. For example:
807 -- f (x :: t) (y :: t) = ....
808 -- We don't want to complain about binding t twice!
810 located_tyvars = [(tv, loc) | tv <- forall_tyvars]
811 doc_sig = text "In a pattern type-signature"
813 bindLocatedLocalsRn doc_sig located_tyvars thing_inside
815 bindPatSigTyVarsFV :: [RdrNameHsType]
818 bindPatSigTyVarsFV tys thing_inside
819 = bindPatSigTyVars tys $ \ tvs ->
820 thing_inside `thenM` \ (result,fvs) ->
821 returnM (result, fvs `delListFromNameSet` tvs)
823 -------------------------------------
824 checkDupOrQualNames, checkDupNames :: SDoc
825 -> [(RdrName, SrcLoc)]
827 -- Works in any variant of the renamer monad
829 checkDupOrQualNames doc_str rdr_names_w_loc
830 = -- Qualified names in patterns are now rejected by the parser
831 -- but I'm not 100% certain that it finds all cases, so I've left
832 -- this check in for now. Should go eventually.
833 -- Hmm. Sooner rather than later.. data type decls
834 -- mappM_ (qualNameErr doc_str) quals `thenM_`
835 checkDupNames doc_str rdr_names_w_loc
837 quals = filter (isQual . fst) rdr_names_w_loc
839 checkDupNames doc_str rdr_names_w_loc
840 = -- Check for duplicated names in a binding group
841 mappM_ (dupNamesErr doc_str) dups
843 (_, dups) = removeDups (\(n1,l1) (n2,l2) -> n1 `compare` n2) rdr_names_w_loc
847 %************************************************************************
849 \subsection{GlobalRdrEnv}
851 %************************************************************************
854 mkGlobalRdrEnv :: ModuleName -- Imported module (after doing the "as M" name change)
855 -> Bool -- True <=> want unqualified import
856 -> (Name -> Provenance)
857 -> Avails -- Whats imported
861 mkGlobalRdrEnv this_mod unqual_imp mk_provenance avails deprecs
864 -- Make the name environment. We're talking about a
865 -- single module here, so there must be no name clashes.
866 -- In practice there only ever will be if it's the module
869 -- Add qualified names for the things that are available
870 -- (Qualified names are always imported)
871 gbl_env1 = foldl add_avail emptyRdrEnv avails
873 -- Add unqualified names
874 gbl_env2 | unqual_imp = foldl add_unqual gbl_env1 (rdrEnvToList gbl_env1)
875 | otherwise = gbl_env1
877 add_unqual env (qual_name, elts)
878 = foldl add_one env elts
880 add_one env elt = addOneToGlobalRdrEnv env unqual_name elt
881 unqual_name = unqualifyRdrName qual_name
882 -- The qualified import should only have added one
883 -- binding for each qualified name! But if there's an error in
884 -- the module (multiple bindings for the same name) we may get
885 -- duplicates. So the simple thing is to do the fold.
887 add_avail :: GlobalRdrEnv -> AvailInfo -> GlobalRdrEnv
888 add_avail env avail = foldl (add_name (availName avail)) env (availNames avail)
890 add_name parent env name -- Add qualified name only
891 = addOneToGlobalRdrEnv env (mkRdrQual this_mod occ) elt
893 occ = nameOccName name
894 elt = GRE {gre_name = name,
895 gre_parent = if name == parent
898 gre_prov = mk_provenance name,
899 gre_deprec = lookupDeprec deprecs name}
903 plusGlobalRdrEnv :: GlobalRdrEnv -> GlobalRdrEnv -> GlobalRdrEnv
904 plusGlobalRdrEnv env1 env2 = plusFM_C combine_globals env1 env2
906 addOneToGlobalRdrEnv :: GlobalRdrEnv -> RdrName -> GlobalRdrElt -> GlobalRdrEnv
907 addOneToGlobalRdrEnv env rdr_name name = addToFM_C combine_globals env rdr_name [name]
909 delOneFromGlobalRdrEnv :: GlobalRdrEnv -> RdrName -> GlobalRdrEnv
910 delOneFromGlobalRdrEnv env rdr_name = delFromFM env rdr_name
912 combine_globals :: [GlobalRdrElt] -- Old
913 -> [GlobalRdrElt] -- New
915 combine_globals ns_old ns_new -- ns_new is often short
916 = foldr add ns_old ns_new
918 add n ns | any (is_duplicate n) ns_old = map (choose n) ns -- Eliminate duplicates
921 choose n m | n `beats` m = n
924 g1 `beats` g2 = gre_name g1 == gre_name g2 &&
925 gre_prov g1 `hasBetterProv` gre_prov g2
927 is_duplicate :: GlobalRdrElt -> GlobalRdrElt -> Bool
928 is_duplicate g1 g2 | isLocalGRE g1 && isLocalGRE g2 = False
929 is_duplicate g1 g2 = gre_name g1 == gre_name g2
932 We treat two bindings of a locally-defined name as a duplicate,
933 because they might be two separate, local defns and we want to report
934 and error for that, {\em not} eliminate a duplicate.
936 On the other hand, if you import the same name from two different
937 import statements, we {\em do} want to eliminate the duplicate, not report
940 If a module imports itself then there might be a local defn and an imported
941 defn of the same name; in this case the names will compare as equal, but
942 will still have different provenances.
945 %************************************************************************
947 \subsection{Free variable manipulation}
949 %************************************************************************
953 mapFvRn f xs = mappM f xs `thenM` \ stuff ->
955 (ys, fvs_s) = unzip stuff
957 returnM (ys, plusFVs fvs_s)
961 %************************************************************************
963 \subsection{Envt utility functions}
965 %************************************************************************
968 warnUnusedModules :: [ModuleName] -> TcRn m ()
969 warnUnusedModules mods
970 = ifOptM Opt_WarnUnusedImports (mappM_ (addWarn . unused_mod) mods)
972 unused_mod m = vcat [ptext SLIT("Module") <+> quotes (ppr m) <+>
973 text "is imported, but nothing from it is used",
974 parens (ptext SLIT("except perhaps instances visible in") <+>
977 warnUnusedImports, warnUnusedTopBinds :: [GlobalRdrElt] -> TcRn m ()
978 warnUnusedImports gres = ifOptM Opt_WarnUnusedImports (warnUnusedGREs gres)
979 warnUnusedTopBinds gres = ifOptM Opt_WarnUnusedBinds (warnUnusedGREs gres)
981 warnUnusedLocalBinds, warnUnusedMatches :: [Name] -> TcRn m ()
982 warnUnusedLocalBinds names = ifOptM Opt_WarnUnusedBinds (warnUnusedLocals names)
983 warnUnusedMatches names = ifOptM Opt_WarnUnusedMatches (warnUnusedLocals names)
985 -------------------------
987 warnUnusedGREs gres = warnUnusedBinds [(n,p) | GRE {gre_name = n, gre_prov = p} <- gres]
988 warnUnusedLocals names = warnUnusedBinds [(n,LocalDef) | n<-names]
990 warnUnusedBinds :: [(Name,Provenance)] -> TcRn m ()
991 warnUnusedBinds names
992 = mappM_ warnUnusedGroup groups
994 -- Group by provenance
995 groups = equivClasses cmp (filter reportable names)
996 (_,prov1) `cmp` (_,prov2) = prov1 `compare` prov2
998 reportable (name,_) = reportIfUnused (nameOccName name)
1001 -------------------------
1003 warnUnusedGroup :: [(Name,Provenance)] -> TcRn m ()
1004 warnUnusedGroup names
1005 = addSrcLoc def_loc $
1007 sep [msg <> colon, nest 4 (fsep (punctuate comma (map (ppr.fst) names)))]
1009 (name1, prov1) = head names
1010 loc1 = nameSrcLoc name1
1011 (def_loc, msg) = case prov1 of
1012 LocalDef -> (loc1, unused_msg)
1013 NonLocalDef (UserImport mod loc _) -> (loc, imp_from mod)
1015 unused_msg = text "Defined but not used"
1016 imp_from mod = text "Imported from" <+> quotes (ppr mod) <+> text "but not used"
1020 addNameClashErrRn rdr_name (np1:nps)
1021 = addErr (vcat [ptext SLIT("Ambiguous occurrence") <+> quotes (ppr rdr_name),
1022 ptext SLIT("It could refer to") <+> vcat (msg1 : msgs)])
1024 msg1 = ptext SLIT("either") <+> mk_ref np1
1025 msgs = [ptext SLIT(" or") <+> mk_ref np | np <- nps]
1026 mk_ref gre = quotes (ppr (gre_name gre)) <> comma <+> pprNameProvenance gre
1028 shadowedNameWarn shadow
1029 = hsep [ptext SLIT("This binding for"),
1030 quotes (ppr shadow),
1031 ptext SLIT("shadows an existing binding")]
1034 = sep [text flavour, ptext SLIT("not in scope:"), quotes (ppr name)]
1036 flavour = occNameFlavour (rdrNameOcc name)
1039 = ptext SLIT("Illegal binding of built-in syntax:") <+> ppr (rdrNameOcc name)
1040 -- The rdrNameOcc is because we don't want to print Prelude.(,)
1042 qualNameErr descriptor (name,loc)
1044 addErr (vcat [ ptext SLIT("Invalid use of qualified name") <+> quotes (ppr name),
1047 dupNamesErr descriptor ((name,loc) : dup_things)
1049 addErr ((ptext SLIT("Conflicting definitions for") <+> quotes (ppr name))
1053 noIfaceErr dflags mod_name boot_file files
1054 = ptext SLIT("Could not find interface file for") <+> quotes (ppr mod_name)
1058 | verbosity dflags < 3 =
1059 text "(use -v to see a list of the files searched for)"
1061 hang (ptext SLIT("locations searched:")) 4 (vcat (map text files))
1063 warnDeprec :: GlobalRdrElt -> TcRn m ()
1064 warnDeprec (GRE {gre_name = name, gre_deprec = Just txt})
1065 = ifOptM Opt_WarnDeprecations $
1066 addWarn (sep [ text (occNameFlavour (nameOccName name)) <+>
1067 quotes (ppr name) <+> text "is deprecated:",