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
14 import RdrHsSyn ( RdrNameIE, RdrNameHsType, extractHsTyRdrTyVars )
15 import RdrName ( RdrName, rdrNameModule, rdrNameOcc, isQual, isUnqual, isOrig,
16 mkRdrUnqual, mkRdrQual,
17 lookupRdrEnv, foldRdrEnv, rdrEnvToList, elemRdrEnv,
20 import HsTypes ( hsTyVarName, replaceTyVarName )
21 import HscTypes ( Provenance(..), pprNameProvenance, hasBetterProv,
22 ImportReason(..), GlobalRdrEnv, GlobalRdrElt(..), AvailEnv,
23 AvailInfo, Avails, GenAvailInfo(..), NameSupply(..),
25 Deprecations(..), lookupDeprec,
30 getSrcLoc, nameIsLocalOrFrom,
31 mkLocalName, mkGlobalName, nameModule,
32 mkIPName, nameOccName, nameModule_maybe,
37 import OccName ( OccName, occNameUserString, occNameFlavour )
38 import Module ( ModuleName, moduleName, mkVanillaModule,
39 mkSysModuleNameFS, moduleNameFS, WhereFrom(..) )
40 import PrelNames ( mkUnboundName,
42 mAIN_Name, pREL_MAIN_Name,
43 ioTyConName, intTyConName,
44 boolTyConName, funTyConName,
45 unpackCStringName, unpackCStringFoldrName, unpackCStringUtf8Name,
46 eqStringName, printName,
47 bindIOName, returnIOName, failIOName
49 import TysWiredIn ( unitTyCon ) -- A little odd
52 import SrcLoc ( SrcLoc, noSrcLoc )
54 import ListSetOps ( removeDups, equivClasses )
55 import Util ( sortLt )
56 import BasicTypes ( mapIPName )
58 import UniqFM ( lookupWithDefaultUFM )
59 import Maybe ( mapMaybe )
61 import FastString ( FastString )
64 %*********************************************************
66 \subsection{Making new names}
68 %*********************************************************
71 newTopBinder :: Module -> RdrName -> SrcLoc -> RnM d Name
72 -- newTopBinder puts into the cache the binder with the
73 -- module information set correctly. When the decl is later renamed,
74 -- the binding site will thereby get the correct module.
75 -- There maybe occurrences that don't have the correct Module, but
76 -- by the typechecker will propagate the binding definition to all
77 -- the occurrences, so that doesn't matter
79 newTopBinder mod rdr_name loc
80 = -- First check the cache
82 -- There should never be a qualified name in a binding position (except in instance decls)
83 -- The parser doesn't check this because the same parser parses instance decls
84 (if isQual rdr_name then
85 qualNameErr (text "In its declaration") (rdr_name,loc)
90 getNameSupplyRn `thenRn` \ name_supply ->
92 occ = rdrNameOcc rdr_name
93 key = (moduleName mod, occ)
94 cache = nsNames name_supply
96 case lookupFM cache key of
98 -- A hit in the cache! We are at the binding site of the name, and
99 -- this is the moment when we know all about
100 -- a) the Name's host Module (in particular, which
101 -- package it comes from)
102 -- b) its defining SrcLoc
103 -- So we update this info
106 new_name = setNameModuleAndLoc name mod loc
107 new_cache = addToFM cache key new_name
109 setNameSupplyRn (name_supply {nsNames = new_cache}) `thenRn_`
110 -- traceRn (text "newTopBinder: overwrite" <+> ppr new_name) `thenRn_`
113 -- Miss in the cache!
114 -- Build a completely new Name, and put it in the cache
115 -- Even for locally-defined names we use implicitImportProvenance;
116 -- updateProvenances will set it to rights
118 (us', us1) = splitUniqSupply (nsUniqs name_supply)
119 uniq = uniqFromSupply us1
120 new_name = mkGlobalName uniq mod occ loc
121 new_cache = addToFM cache key new_name
123 setNameSupplyRn (name_supply {nsUniqs = us', nsNames = new_cache}) `thenRn_`
124 -- traceRn (text "newTopBinder: new" <+> ppr new_name) `thenRn_`
128 newGlobalName :: ModuleName -> OccName -> RnM d Name
129 -- Used for *occurrences*. We make a place-holder Name, really just
130 -- to agree on its unique, which gets overwritten when we read in
131 -- the binding occurence later (newTopBinder)
132 -- The place-holder Name doesn't have the right SrcLoc, and its
133 -- Module won't have the right Package either.
135 -- (We have to pass a ModuleName, not a Module, because we may be
136 -- simply looking at an occurrence M.x in an interface file.)
138 -- This means that a renamed program may have incorrect info
139 -- on implicitly-imported occurrences, but the correct info on the
140 -- *binding* declaration. It's the type checker that propagates the
141 -- correct information to all the occurrences.
142 -- Since implicitly-imported names never occur in error messages,
143 -- it doesn't matter that we get the correct info in place till later,
144 -- (but since it affects DLL-ery it does matter that we get it right
146 newGlobalName mod_name occ
147 = getNameSupplyRn `thenRn` \ name_supply ->
149 key = (mod_name, occ)
150 cache = nsNames name_supply
152 case lookupFM cache key of
153 Just name -> -- traceRn (text "newGlobalName: hit" <+> ppr name) `thenRn_`
156 Nothing -> setNameSupplyRn (name_supply {nsUniqs = us', nsNames = new_cache}) `thenRn_`
157 -- traceRn (text "newGlobalName: new" <+> ppr name) `thenRn_`
160 (us', us1) = splitUniqSupply (nsUniqs name_supply)
161 uniq = uniqFromSupply us1
162 mod = mkVanillaModule mod_name
163 name = mkGlobalName uniq mod occ noSrcLoc
164 new_cache = addToFM cache key name
166 newIPName rdr_name_ip
167 = getNameSupplyRn `thenRn` \ name_supply ->
169 ipcache = nsIPs name_supply
171 case lookupFM ipcache key of
172 Just name_ip -> returnRn name_ip
173 Nothing -> setNameSupplyRn new_ns `thenRn_`
176 (us', us1) = splitUniqSupply (nsUniqs name_supply)
177 uniq = uniqFromSupply us1
178 name_ip = mapIPName mk_name rdr_name_ip
179 mk_name rdr_name = mkIPName uniq (rdrNameOcc rdr_name)
180 new_ipcache = addToFM ipcache key name_ip
181 new_ns = name_supply {nsUniqs = us', nsIPs = new_ipcache}
183 key = rdr_name_ip -- Ensures that ?x and %x get distinct Names
186 %*********************************************************
188 \subsection{Looking up names}
190 %*********************************************************
192 Looking up a name in the RnEnv.
195 lookupBndrRn rdr_name
196 = getLocalNameEnv `thenRn` \ local_env ->
197 case lookupRdrEnv local_env rdr_name of
198 Just name -> returnRn name
199 Nothing -> lookupTopBndrRn rdr_name
201 lookupTopBndrRn rdr_name
202 -- Look up a top-level local binder. We may be looking up an unqualified 'f',
203 -- and there may be several imported 'f's too, which must not confuse us.
204 -- So we have to filter out the non-local ones.
205 -- A separate function (importsFromLocalDecls) reports duplicate top level
206 -- decls, so here it's safe just to choose an arbitrary one.
209 -- This is here just to catch the PrelBase defn of (say) [] and similar
210 -- The parser reads the special syntax and returns an Orig RdrName
211 -- But the global_env contains only Qual RdrNames, so we won't
212 -- find it there; instead just get the name via the Orig route
213 = lookupOrigName rdr_name
216 = getModeRn `thenRn` \ mode ->
217 if isInterfaceMode mode
218 then lookupIfaceName rdr_name
220 getModuleRn `thenRn` \ mod ->
221 getGlobalNameEnv `thenRn` \ global_env ->
222 case lookup_local mod global_env rdr_name of
223 Just name -> returnRn name
224 Nothing -> failWithRn (mkUnboundName rdr_name)
225 (unknownNameErr rdr_name)
227 lookup_local mod global_env rdr_name
228 = case lookupRdrEnv global_env rdr_name of
230 Just gres -> case [n | GRE n _ _ <- gres, nameIsLocalOrFrom mod n] of
235 -- lookupSigOccRn is used for type signatures and pragmas
241 -- It's clear that the 'f' in the signature must refer to A.f
242 -- The Haskell98 report does not stipulate this, but it will!
243 -- So we must treat the 'f' in the signature in the same way
244 -- as the binding occurrence of 'f', using lookupBndrRn
245 lookupSigOccRn :: RdrName -> RnMS Name
246 lookupSigOccRn = lookupBndrRn
248 -- lookupInstDeclBndr is used for the binders in an
249 -- instance declaration. Here we use the class name to
252 lookupInstDeclBndr :: Name -> RdrName -> RnMS Name
253 -- We use the selector name as the binder
254 lookupInstDeclBndr cls_name rdr_name
255 | isOrig rdr_name -- Occurs in derived instances, where we just
256 -- refer diectly to the right method
257 = lookupOrigName rdr_name
260 = getGlobalAvails `thenRn` \ avail_env ->
261 case lookupNameEnv avail_env cls_name of
262 -- The class itself isn't in scope, so cls_name is unboundName
263 -- e.g. import Prelude hiding( Ord )
264 -- instance Ord T where ...
265 -- The program is wrong, but that should not cause a crash.
266 Nothing -> returnRn (mkUnboundName rdr_name)
267 Just (AvailTC _ ns) -> case [n | n <- ns, nameOccName n == occ] of
268 (n:ns)-> ASSERT( null ns ) returnRn n
269 [] -> failWithRn (mkUnboundName rdr_name)
270 (unknownNameErr rdr_name)
271 other -> pprPanic "lookupInstDeclBndr" (ppr cls_name)
273 occ = rdrNameOcc rdr_name
275 -- lookupOccRn looks up an occurrence of a RdrName
276 lookupOccRn :: RdrName -> RnMS Name
278 = getLocalNameEnv `thenRn` \ local_env ->
279 case lookupRdrEnv local_env rdr_name of
280 Just name -> returnRn name
281 Nothing -> lookupGlobalOccRn rdr_name
283 -- lookupGlobalOccRn is like lookupOccRn, except that it looks in the global
284 -- environment. It's used only for
285 -- record field names
286 -- class op names in class and instance decls
288 lookupGlobalOccRn rdr_name
289 = getModeRn `thenRn` \ mode ->
290 if (isInterfaceMode mode)
291 then lookupIfaceName rdr_name
294 getGlobalNameEnv `thenRn` \ global_env ->
296 SourceMode -> lookupSrcName global_env rdr_name
299 | not (isQual rdr_name) ->
300 lookupSrcName global_env rdr_name
302 -- We allow qualified names on the command line to refer to
303 -- *any* name exported by any module in scope, just as if
304 -- there was an "import qualified M" declaration for every
307 -- First look up the name in the normal environment. If
308 -- it isn't there, we manufacture a new occurrence of an
311 case lookupRdrEnv global_env rdr_name of
312 Just _ -> lookupSrcName global_env rdr_name
313 Nothing -> lookupQualifiedName rdr_name
315 -- a qualified name on the command line can refer to any module at all: we
316 -- try to load the interface if we don't already have it.
317 lookupQualifiedName :: RdrName -> RnM d Name
318 lookupQualifiedName rdr_name
320 mod = rdrNameModule rdr_name
321 occ = rdrNameOcc rdr_name
323 loadInterface (ppr rdr_name) mod ImportByUser `thenRn` \ iface ->
324 case [ name | (_,avails) <- mi_exports iface,
326 name <- availNames avail,
327 nameOccName name == occ ] of
328 (n:ns) -> ASSERT (null ns) returnRn n
329 _ -> failWithRn (mkUnboundName rdr_name) (unknownNameErr rdr_name)
331 lookupSrcName :: GlobalRdrEnv -> RdrName -> RnM d Name
332 -- NB: passed GlobalEnv explicitly, not necessarily in RnMS monad
333 lookupSrcName global_env rdr_name
334 | isOrig rdr_name -- Can occur in source code too
335 = lookupOrigName rdr_name
338 = case lookupRdrEnv global_env rdr_name of
339 Just [GRE name _ Nothing] -> returnRn name
340 Just [GRE name _ (Just deprec)] -> warnDeprec name deprec `thenRn_`
342 Just stuff@(GRE name _ _ : _) -> addNameClashErrRn rdr_name stuff `thenRn_`
344 Nothing -> failWithRn (mkUnboundName rdr_name)
345 (unknownNameErr rdr_name)
347 lookupOrigName :: RdrName -> RnM d Name
348 lookupOrigName rdr_name
349 = ASSERT( isOrig rdr_name )
350 newGlobalName (rdrNameModule rdr_name) (rdrNameOcc rdr_name)
352 lookupIfaceUnqual :: RdrName -> RnM d Name
353 lookupIfaceUnqual rdr_name
354 = ASSERT( isUnqual rdr_name )
355 -- An Unqual is allowed; interface files contain
356 -- unqualified names for locally-defined things, such as
357 -- constructors of a data type.
358 getModuleRn `thenRn ` \ mod ->
359 newGlobalName (moduleName mod) (rdrNameOcc rdr_name)
361 lookupIfaceName :: RdrName -> RnM d Name
362 lookupIfaceName rdr_name
363 | isUnqual rdr_name = lookupIfaceUnqual rdr_name
364 | otherwise = lookupOrigName rdr_name
367 @lookupOrigName@ takes an RdrName representing an {\em original}
368 name, and adds it to the occurrence pool so that it'll be loaded
369 later. This is used when language constructs (such as monad
370 comprehensions, overloaded literals, or deriving clauses) require some
371 stuff to be loaded that isn't explicitly mentioned in the code.
373 This doesn't apply in interface mode, where everything is explicit,
374 but we don't check for this case: it does no harm to record an
375 ``extra'' occurrence and @lookupOrigNames@ isn't used much in
376 interface mode (it's only the @Nothing@ clause of @rnDerivs@ that
377 calls it at all I think).
379 \fbox{{\em Jan 98: this comment is wrong: @rnHsType@ uses it quite a bit.}}
382 lookupOrigNames :: [RdrName] -> RnM d NameSet
383 lookupOrigNames rdr_names
384 = mapRn lookupOrigName rdr_names `thenRn` \ names ->
385 returnRn (mkNameSet names)
388 lookupSysBinder is used for the "system binders" of a type, class, or
389 instance decl. It ensures that the module is set correctly in the
390 name cache, and sets the provenance on the returned name too. The
391 returned name will end up actually in the type, class, or instance.
394 lookupSysBinder rdr_name
395 = ASSERT( isUnqual rdr_name )
396 getModuleRn `thenRn` \ mod ->
397 getSrcLocRn `thenRn` \ loc ->
398 newTopBinder mod rdr_name loc
402 %*********************************************************
404 \subsection{Implicit free vars and sugar names}
406 %*********************************************************
408 @getXImplicitFVs@ forces the renamer to slurp in some things which aren't
409 mentioned explicitly, but which might be needed by the type checker.
412 getImplicitStmtFVs -- Compiling a statement
413 = returnRn (mkFVs [printName, bindIOName, returnIOName, failIOName]
414 `plusFV` ubiquitousNames)
415 -- These are all needed implicitly when compiling a statement
416 -- See TcModule.tc_stmts
418 getImplicitModuleFVs mod_name decls -- Compiling a module
419 = lookupOrigNames deriv_occs `thenRn` \ deriving_names ->
420 returnRn (deriving_names `plusFV` implicit_main `plusFV` ubiquitousNames)
422 -- Add occurrences for IO or PrimIO
423 implicit_main | mod_name == mAIN_Name
424 || mod_name == pREL_MAIN_Name = unitFV ioTyConName
425 | otherwise = emptyFVs
427 deriv_occs = [occ | TyClD (TyData {tcdDerivs = Just deriv_classes}) <- decls,
428 cls <- deriv_classes,
429 occ <- lookupWithDefaultUFM derivingOccurrences [] cls ]
431 -- ubiquitous_names are loaded regardless, because
432 -- they are needed in virtually every program
434 = mkFVs [unpackCStringName, unpackCStringFoldrName,
435 unpackCStringUtf8Name, eqStringName]
436 -- Virtually every program has error messages in it somewhere
439 mkFVs [getName unitTyCon, funTyConName, boolTyConName, intTyConName]
440 -- Add occurrences for very frequently used types.
441 -- (e.g. we don't want to be bothered with making funTyCon a
442 -- free var at every function application!)
445 %************************************************************************
447 \subsection{Re-bindable desugaring names}
449 %************************************************************************
451 Haskell 98 says that when you say "3" you get the "fromInteger" from the
452 Standard Prelude, regardless of what is in scope. However, to experiment
453 with having a language that is less coupled to the standard prelude, we're
454 trying a non-standard extension that instead gives you whatever "Prelude.fromInteger"
455 happens to be in scope. Then you can
457 import MyPrelude as Prelude
458 to get the desired effect.
460 At the moment this just happens for
461 * fromInteger, fromRational on literals (in expressions and patterns)
462 * negate (in expressions)
463 * minus (arising from n+k patterns)
465 We store the relevant Name in the HsSyn tree, in
466 * HsIntegral/HsFractional
469 respectively. Initially, we just store the "standard" name (PrelNames.fromIntegralName,
470 fromRationalName etc), but the renamer changes this to the appropriate user
471 name if Opt_NoImplicitPrelude is on. That is what lookupSyntaxName does.
474 lookupSyntaxName :: Name -- The standard name
475 -> RnMS Name -- Possibly a non-standard name
476 lookupSyntaxName std_name
477 = doptRn Opt_NoImplicitPrelude `thenRn` \ no_prelude ->
478 if not no_prelude then
479 returnRn std_name -- Normal case
482 rdr_name = mkRdrUnqual (nameOccName std_name)
483 -- Get the similarly named thing from the local environment
489 %*********************************************************
493 %*********************************************************
496 newLocalsRn :: [(RdrName,SrcLoc)]
498 newLocalsRn rdr_names_w_loc
499 = getNameSupplyRn `thenRn` \ name_supply ->
501 (us', us1) = splitUniqSupply (nsUniqs name_supply)
502 uniqs = uniqsFromSupply us1
503 names = [ mkLocalName uniq (rdrNameOcc rdr_name) loc
504 | ((rdr_name,loc), uniq) <- rdr_names_w_loc `zip` uniqs
507 setNameSupplyRn (name_supply {nsUniqs = us'}) `thenRn_`
511 bindLocatedLocalsRn :: SDoc -- Documentation string for error message
512 -> [(RdrName,SrcLoc)]
513 -> ([Name] -> RnMS a)
515 bindLocatedLocalsRn doc_str rdr_names_w_loc enclosed_scope
516 = getModeRn `thenRn` \ mode ->
517 getLocalNameEnv `thenRn` \ local_env ->
518 getGlobalNameEnv `thenRn` \ global_env ->
520 -- Check for duplicate names
521 checkDupOrQualNames doc_str rdr_names_w_loc `thenRn_`
523 -- Warn about shadowing, but only in source modules
525 check_shadow (rdr_name,loc)
526 | rdr_name `elemRdrEnv` local_env
527 || rdr_name `elemRdrEnv` global_env
528 = pushSrcLocRn loc $ addWarnRn (shadowedNameWarn rdr_name)
534 SourceMode -> ifOptRn Opt_WarnNameShadowing $
535 mapRn_ check_shadow rdr_names_w_loc
539 newLocalsRn rdr_names_w_loc `thenRn` \ names ->
541 new_local_env = addListToRdrEnv local_env (map fst rdr_names_w_loc `zip` names)
543 setLocalNameEnv new_local_env (enclosed_scope names)
545 bindCoreLocalRn :: RdrName -> (Name -> RnMS a) -> RnMS a
546 -- A specialised variant when renaming stuff from interface
547 -- files (of which there is a lot)
549 -- * no checks for shadowing
551 -- * deal with free vars
552 bindCoreLocalRn rdr_name enclosed_scope
553 = getSrcLocRn `thenRn` \ loc ->
554 getLocalNameEnv `thenRn` \ name_env ->
555 getNameSupplyRn `thenRn` \ name_supply ->
557 (us', us1) = splitUniqSupply (nsUniqs name_supply)
558 uniq = uniqFromSupply us1
559 name = mkLocalName uniq (rdrNameOcc rdr_name) loc
561 setNameSupplyRn (name_supply {nsUniqs = us'}) `thenRn_`
563 new_name_env = extendRdrEnv name_env rdr_name name
565 setLocalNameEnv new_name_env (enclosed_scope name)
567 bindCoreLocalsRn [] thing_inside = thing_inside []
568 bindCoreLocalsRn (b:bs) thing_inside = bindCoreLocalRn b $ \ name' ->
569 bindCoreLocalsRn bs $ \ names' ->
570 thing_inside (name':names')
572 bindLocalNames names enclosed_scope
573 = getLocalNameEnv `thenRn` \ name_env ->
574 setLocalNameEnv (extendLocalRdrEnv name_env names)
577 bindLocalNamesFV names enclosed_scope
578 = bindLocalNames names $
579 enclosed_scope `thenRn` \ (thing, fvs) ->
580 returnRn (thing, delListFromNameSet fvs names)
583 -------------------------------------
584 bindLocalRn doc rdr_name enclosed_scope
585 = getSrcLocRn `thenRn` \ loc ->
586 bindLocatedLocalsRn doc [(rdr_name,loc)] $ \ (n:ns) ->
590 bindLocalsRn doc rdr_names enclosed_scope
591 = getSrcLocRn `thenRn` \ loc ->
592 bindLocatedLocalsRn doc
593 (rdr_names `zip` repeat loc)
596 -- binLocalsFVRn is the same as bindLocalsRn
597 -- except that it deals with free vars
598 bindLocalsFVRn doc rdr_names enclosed_scope
599 = bindLocalsRn doc rdr_names $ \ names ->
600 enclosed_scope names `thenRn` \ (thing, fvs) ->
601 returnRn (thing, delListFromNameSet fvs names)
603 -------------------------------------
604 extendTyVarEnvFVRn :: [Name] -> RnMS (a, FreeVars) -> RnMS (a, FreeVars)
605 -- This tiresome function is used only in rnSourceDecl on InstDecl
606 extendTyVarEnvFVRn tyvars enclosed_scope
607 = bindLocalNames tyvars enclosed_scope `thenRn` \ (thing, fvs) ->
608 returnRn (thing, delListFromNameSet fvs tyvars)
610 bindTyVarsRn :: SDoc -> [HsTyVarBndr RdrName]
611 -> ([HsTyVarBndr Name] -> RnMS a)
613 bindTyVarsRn doc_str tyvar_names enclosed_scope
614 = bindTyVars2Rn doc_str tyvar_names $ \ names tyvars ->
615 enclosed_scope tyvars
617 -- Gruesome name: return Names as well as HsTyVars
618 bindTyVars2Rn :: SDoc -> [HsTyVarBndr RdrName]
619 -> ([Name] -> [HsTyVarBndr Name] -> RnMS a)
621 bindTyVars2Rn doc_str tyvar_names enclosed_scope
622 = getSrcLocRn `thenRn` \ loc ->
624 located_tyvars = [(hsTyVarName tv, loc) | tv <- tyvar_names]
626 bindLocatedLocalsRn doc_str located_tyvars $ \ names ->
627 enclosed_scope names (zipWith replaceTyVarName tyvar_names names)
629 bindPatSigTyVars :: [RdrNameHsType]
630 -> RnMS (a, FreeVars)
631 -> RnMS (a, FreeVars)
632 -- Find the type variables in the pattern type
633 -- signatures that must be brought into scope
635 bindPatSigTyVars tys enclosed_scope
636 = getLocalNameEnv `thenRn` \ name_env ->
637 getSrcLocRn `thenRn` \ loc ->
639 forall_tyvars = nub [ tv | ty <- tys,
640 tv <- extractHsTyRdrTyVars ty,
641 not (tv `elemFM` name_env)
643 -- The 'nub' is important. For example:
644 -- f (x :: t) (y :: t) = ....
645 -- We don't want to complain about binding t twice!
647 located_tyvars = [(tv, loc) | tv <- forall_tyvars]
648 doc_sig = text "In a pattern type-signature"
650 bindLocatedLocalsRn doc_sig located_tyvars $ \ names ->
651 enclosed_scope `thenRn` \ (thing, fvs) ->
652 returnRn (thing, delListFromNameSet fvs names)
655 -------------------------------------
656 checkDupOrQualNames, checkDupNames :: SDoc
657 -> [(RdrName, SrcLoc)]
659 -- Works in any variant of the renamer monad
661 checkDupOrQualNames doc_str rdr_names_w_loc
662 = -- Check for use of qualified names
663 mapRn_ (qualNameErr doc_str) quals `thenRn_`
664 checkDupNames doc_str rdr_names_w_loc
666 quals = filter (isQual . fst) rdr_names_w_loc
668 checkDupNames doc_str rdr_names_w_loc
669 = -- Check for duplicated names in a binding group
670 mapRn_ (dupNamesErr doc_str) dups
672 (_, dups) = removeDups (\(n1,l1) (n2,l2) -> n1 `compare` n2) rdr_names_w_loc
676 %************************************************************************
678 \subsection{GlobalRdrEnv}
680 %************************************************************************
683 mkGlobalRdrEnv :: ModuleName -- Imported module (after doing the "as M" name change)
684 -> Bool -- True <=> want unqualified import
685 -> (Name -> Provenance)
686 -> Avails -- Whats imported
690 mkGlobalRdrEnv this_mod unqual_imp mk_provenance avails deprecs
693 -- Make the name environment. We're talking about a
694 -- single module here, so there must be no name clashes.
695 -- In practice there only ever will be if it's the module
698 -- Add qualified names for the things that are available
699 -- (Qualified names are always imported)
700 gbl_env1 = foldl add_avail emptyRdrEnv avails
702 -- Add unqualified names
703 gbl_env2 | unqual_imp = foldl add_unqual gbl_env1 (rdrEnvToList gbl_env1)
704 | otherwise = gbl_env1
706 add_unqual env (qual_name, elts)
707 = foldl add_one env elts
709 add_one env elt = addOneToGlobalRdrEnv env unqual_name elt
710 unqual_name = unqualifyRdrName qual_name
711 -- The qualified import should only have added one
712 -- binding for each qualified name! But if there's an error in
713 -- the module (multiple bindings for the same name) we may get
714 -- duplicates. So the simple thing is to do the fold.
716 add_avail :: GlobalRdrEnv -> AvailInfo -> GlobalRdrEnv
717 add_avail env avail = foldl add_name env (availNames avail)
719 add_name env name -- Add qualified name only
720 = addOneToGlobalRdrEnv env (mkRdrQual this_mod occ) elt
722 occ = nameOccName name
723 elt = GRE name (mk_provenance name) (lookupDeprec deprecs name)
725 mkIfaceGlobalRdrEnv :: [(ModuleName,Avails)] -> GlobalRdrEnv
726 -- Used to construct a GlobalRdrEnv for an interface that we've
727 -- read from a .hi file. We can't construct the original top-level
728 -- environment because we don't have enough info, but we compromise
729 -- by making an environment from its exports
730 mkIfaceGlobalRdrEnv m_avails
731 = foldl add emptyRdrEnv m_avails
733 add env (mod,avails) = plusGlobalRdrEnv env (mkGlobalRdrEnv mod True
734 (\n -> LocalDef) avails NoDeprecs)
735 -- The NoDeprecs is a bit of a hack I suppose
739 plusGlobalRdrEnv :: GlobalRdrEnv -> GlobalRdrEnv -> GlobalRdrEnv
740 plusGlobalRdrEnv env1 env2 = plusFM_C combine_globals env1 env2
742 addOneToGlobalRdrEnv :: GlobalRdrEnv -> RdrName -> GlobalRdrElt -> GlobalRdrEnv
743 addOneToGlobalRdrEnv env rdr_name name = addToFM_C combine_globals env rdr_name [name]
745 delOneFromGlobalRdrEnv :: GlobalRdrEnv -> RdrName -> GlobalRdrEnv
746 delOneFromGlobalRdrEnv env rdr_name = delFromFM env rdr_name
748 combine_globals :: [GlobalRdrElt] -- Old
749 -> [GlobalRdrElt] -- New
751 combine_globals ns_old ns_new -- ns_new is often short
752 = foldr add ns_old ns_new
754 add n ns | any (is_duplicate n) ns_old = map (choose n) ns -- Eliminate duplicates
757 choose n m | n `beats` m = n
760 (GRE n pn _) `beats` (GRE m pm _) = n==m && pn `hasBetterProv` pm
762 is_duplicate :: GlobalRdrElt -> GlobalRdrElt -> Bool
763 is_duplicate (GRE n1 LocalDef _) (GRE n2 LocalDef _) = False
764 is_duplicate (GRE n1 _ _) (GRE n2 _ _) = n1 == n2
767 We treat two bindings of a locally-defined name as a duplicate,
768 because they might be two separate, local defns and we want to report
769 and error for that, {\em not} eliminate a duplicate.
771 On the other hand, if you import the same name from two different
772 import statements, we {\em do} want to eliminate the duplicate, not report
775 If a module imports itself then there might be a local defn and an imported
776 defn of the same name; in this case the names will compare as equal, but
777 will still have different provenances.
780 @unQualInScope@ returns a function that takes a @Name@ and tells whether
781 its unqualified name is in scope. This is put as a boolean flag in
782 the @Name@'s provenance to guide whether or not to print the name qualified
786 unQualInScope :: GlobalRdrEnv -> Name -> Bool
787 -- True if 'f' is in scope, and has only one binding,
788 -- and the thing it is bound to is the name we are looking for
789 -- (i.e. false if A.f and B.f are both in scope as unqualified 'f')
791 -- This fn is only efficient if the shared
792 -- partial application is used a lot.
794 = (`elemNameSet` unqual_names)
796 unqual_names :: NameSet
797 unqual_names = foldRdrEnv add emptyNameSet env
798 add rdr_name [GRE name _ _] unquals | isUnqual rdr_name = addOneToNameSet unquals name
799 add _ _ unquals = unquals
803 %************************************************************************
807 %************************************************************************
810 plusAvail (Avail n1) (Avail n2) = Avail n1
811 plusAvail (AvailTC n1 ns1) (AvailTC n2 ns2) = AvailTC n2 (nub (ns1 ++ ns2))
814 plusAvail a1 a2 = pprPanic "RnEnv.plusAvail" (hsep [ppr a1,ppr a2])
817 addAvail :: AvailEnv -> AvailInfo -> AvailEnv
818 addAvail avails avail = extendNameEnv_C plusAvail avails (availName avail) avail
820 unitAvailEnv :: AvailInfo -> AvailEnv
821 unitAvailEnv a = unitNameEnv (availName a) a
823 plusAvailEnv :: AvailEnv -> AvailEnv -> AvailEnv
824 plusAvailEnv = plusNameEnv_C plusAvail
826 availEnvElts = nameEnvElts
828 addAvailToNameSet :: NameSet -> AvailInfo -> NameSet
829 addAvailToNameSet names avail = addListToNameSet names (availNames avail)
831 availsToNameSet :: [AvailInfo] -> NameSet
832 availsToNameSet avails = foldl addAvailToNameSet emptyNameSet avails
834 availName :: GenAvailInfo name -> name
835 availName (Avail n) = n
836 availName (AvailTC n _) = n
838 availNames :: GenAvailInfo name -> [name]
839 availNames (Avail n) = [n]
840 availNames (AvailTC n ns) = ns
842 -------------------------------------
843 filterAvail :: RdrNameIE -- Wanted
844 -> AvailInfo -- Available
845 -> Maybe AvailInfo -- Resulting available;
846 -- Nothing if (any of the) wanted stuff isn't there
848 filterAvail ie@(IEThingWith want wants) avail@(AvailTC n ns)
849 | sub_names_ok = Just (AvailTC n (filter is_wanted ns))
850 | otherwise = Nothing
852 is_wanted name = nameOccName name `elem` wanted_occs
853 sub_names_ok = all (`elem` avail_occs) wanted_occs
854 avail_occs = map nameOccName ns
855 wanted_occs = map rdrNameOcc (want:wants)
857 filterAvail (IEThingAbs _) (AvailTC n ns) = ASSERT( n `elem` ns )
860 filterAvail (IEThingAbs _) avail@(Avail n) = Just avail -- Type synonyms
862 filterAvail (IEVar _) avail@(Avail n) = Just avail
863 filterAvail (IEVar v) avail@(AvailTC n ns) = Just (AvailTC n (filter wanted ns))
865 wanted n = nameOccName n == occ
867 -- The second equation happens if we import a class op, thus
869 -- where op is a class operation
871 filterAvail (IEThingAll _) avail@(AvailTC _ _) = Just avail
872 -- We don't complain even if the IE says T(..), but
873 -- no constrs/class ops of T are available
874 -- Instead that's caught with a warning by the caller
876 filterAvail ie avail = Nothing
878 -------------------------------------
879 groupAvails :: Module -> Avails -> [(ModuleName, Avails)]
880 -- Group by module and sort by occurrence
881 -- This keeps the list in canonical order
882 groupAvails this_mod avails
883 = [ (mkSysModuleNameFS fs, sortLt lt avails)
884 | (fs,avails) <- fmToList groupFM
887 groupFM :: FiniteMap FastString Avails
888 -- Deliberately use the FastString so we
889 -- get a canonical ordering
890 groupFM = foldl add emptyFM avails
892 add env avail = addToFM_C combine env mod_fs [avail']
894 mod_fs = moduleNameFS (moduleName avail_mod)
895 avail_mod = case nameModule_maybe (availName avail) of
898 combine old _ = avail':old
899 avail' = sortAvail avail
901 a1 `lt` a2 = occ1 < occ2
903 occ1 = nameOccName (availName a1)
904 occ2 = nameOccName (availName a2)
906 sortAvail :: AvailInfo -> AvailInfo
907 -- Sort the sub-names into canonical order.
908 -- The canonical order has the "main name" at the beginning
909 -- (if it's there at all)
910 sortAvail (Avail n) = Avail n
911 sortAvail (AvailTC n ns) | n `elem` ns = AvailTC n (n : sortLt lt (filter (/= n) ns))
912 | otherwise = AvailTC n ( sortLt lt ns)
914 n1 `lt` n2 = nameOccName n1 < nameOccName n2
918 pruneAvails :: (Name -> Bool) -- Keep if this is True
921 pruneAvails keep avails
922 = mapMaybe del avails
924 del :: AvailInfo -> Maybe AvailInfo -- Nothing => nothing left!
925 del (Avail n) | keep n = Just (Avail n)
926 | otherwise = Nothing
927 del (AvailTC n ns) | null ns' = Nothing
928 | otherwise = Just (AvailTC n ns')
933 %************************************************************************
935 \subsection{Free variable manipulation}
937 %************************************************************************
941 mapFvRn f xs = mapRn f xs `thenRn` \ stuff ->
943 (ys, fvs_s) = unzip stuff
945 returnRn (ys, plusFVs fvs_s)
949 %************************************************************************
951 \subsection{Envt utility functions}
953 %************************************************************************
956 warnUnusedModules :: [ModuleName] -> RnM d ()
957 warnUnusedModules mods
958 = ifOptRn Opt_WarnUnusedImports (mapRn_ (addWarnRn . unused_mod) mods)
960 unused_mod m = vcat [ptext SLIT("Module") <+> quotes (ppr m) <+>
961 text "is imported, but nothing from it is used",
962 parens (ptext SLIT("except perhaps to re-export instances visible in") <+>
965 warnUnusedImports :: [(Name,Provenance)] -> RnM d ()
966 warnUnusedImports names
967 = ifOptRn Opt_WarnUnusedImports (warnUnusedBinds names)
969 warnUnusedLocalBinds, warnUnusedMatches :: [Name] -> RnM d ()
970 warnUnusedLocalBinds names
971 = ifOptRn Opt_WarnUnusedBinds (warnUnusedBinds [(n,LocalDef) | n<-names])
973 warnUnusedMatches names
974 = ifOptRn Opt_WarnUnusedMatches (warnUnusedGroup [(n,LocalDef) | n<-names])
976 -------------------------
978 warnUnusedBinds :: [(Name,Provenance)] -> RnM d ()
979 warnUnusedBinds names
980 = mapRn_ warnUnusedGroup groups
982 -- Group by provenance
983 groups = equivClasses cmp names
984 (_,prov1) `cmp` (_,prov2) = prov1 `compare` prov2
987 -------------------------
989 warnUnusedGroup :: [(Name,Provenance)] -> RnM d ()
990 warnUnusedGroup names
991 | null filtered_names = returnRn ()
992 | not is_local = returnRn ()
994 = pushSrcLocRn def_loc $
996 sep [msg <> colon, nest 4 (fsep (punctuate comma (map (ppr.fst) filtered_names)))]
998 filtered_names = filter reportable names
999 (name1, prov1) = head filtered_names
1000 (is_local, def_loc, msg)
1002 LocalDef -> (True, getSrcLoc name1, text "Defined but not used")
1004 NonLocalDef (UserImport mod loc _)
1005 -> (True, loc, text "Imported from" <+> quotes (ppr mod) <+> text "but not used")
1007 reportable (name,_) = case occNameUserString (nameOccName name) of
1010 -- Haskell 98 encourages compilers to suppress warnings about
1011 -- unused names in a pattern if they start with "_".
1015 addNameClashErrRn rdr_name (np1:nps)
1016 = addErrRn (vcat [ptext SLIT("Ambiguous occurrence") <+> quotes (ppr rdr_name),
1017 ptext SLIT("It could refer to") <+> vcat (msg1 : msgs)])
1019 msg1 = ptext SLIT("either") <+> mk_ref np1
1020 msgs = [ptext SLIT(" or") <+> mk_ref np | np <- nps]
1021 mk_ref (GRE name prov _) = quotes (ppr name) <> comma <+> pprNameProvenance name prov
1023 shadowedNameWarn shadow
1024 = hsep [ptext SLIT("This binding for"),
1025 quotes (ppr shadow),
1026 ptext SLIT("shadows an existing binding")]
1029 = sep [text flavour, ptext SLIT("not in scope:"), quotes (ppr name)]
1031 flavour = occNameFlavour (rdrNameOcc name)
1033 qualNameErr descriptor (name,loc)
1034 = pushSrcLocRn loc $
1035 addErrRn (vcat [ ptext SLIT("Invalid use of qualified name") <+> quotes (ppr name),
1038 dupNamesErr descriptor ((name,loc) : dup_things)
1039 = pushSrcLocRn loc $
1040 addErrRn ((ptext SLIT("Conflicting definitions for") <+> quotes (ppr name))
1044 warnDeprec :: Name -> DeprecTxt -> RnM d ()
1046 = ifOptRn Opt_WarnDeprecations $
1047 addWarnRn (sep [ text (occNameFlavour (nameOccName name)) <+>
1048 quotes (ppr name) <+> text "is deprecated:",