ghc/compiler/rename/RnEnv.lhs

   1 %
   2 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
   3 %
   4 \section[RnEnv]{Environment manipulation for the renamer monad}
   5
   6 \begin{code}
   7 module RnEnv where              -- Export everything
   8
   9 #include "HsVersions.h"
  10
  11 import {-# SOURCE #-} RnHiFiles
  12
  13 import HsSyn
  14 import RdrHsSyn         ( RdrNameIE )
  15 import RdrName          ( RdrName, rdrNameModule, rdrNameOcc, isQual, isUnqual, isOrig,
  16                           mkRdrUnqual, mkRdrQual, lookupRdrEnv, foldRdrEnv
  17                         )
  18 import HsTypes          ( hsTyVarName, replaceTyVarName )
  19 import HscTypes         ( Provenance(..), pprNameProvenance, hasBetterProv,
  20                           ImportReason(..), GlobalRdrEnv, GlobalRdrElt(..), AvailEnv,
  21                           AvailInfo, Avails, GenAvailInfo(..), NameSupply(..),
  22                           ModIface(..),
  23                           Deprecations(..), lookupDeprec,
  24                           extendLocalRdrEnv
  25                         )
  26 import RnMonad
  27 import Name             ( Name,
  28                           getSrcLoc, nameIsLocalOrFrom,
  29                           mkLocalName, mkGlobalName,
  30                           mkIPName, nameOccName, nameModule_maybe,
  31                           setNameModuleAndLoc
  32                         )
  33 import NameEnv
  34 import NameSet
  35 import OccName          ( OccName, occNameUserString, occNameFlavour )
  36 import Module           ( ModuleName, moduleName, mkVanillaModule,
  37                           mkSysModuleNameFS, moduleNameFS, WhereFrom(..) )
  38 import PrelNames        ( mkUnboundName, syntaxList, SyntaxMap, vanillaSyntaxMap,
  39                           derivingOccurrences,
  40                           mAIN_Name, pREL_MAIN_Name,
  41                           ioTyConName, integerTyConName, doubleTyConName, intTyConName,
  42                           boolTyConName, funTyConName,
  43                           unpackCStringName, unpackCStringFoldrName, unpackCStringUtf8Name,
  44                           eqStringName, printName,
  45                           hasKey, fractionalClassKey, numClassKey,
  46                           bindIOName, returnIOName, failIOName
  47                         )
  48 import TysWiredIn       ( unitTyCon )   -- A little odd
  49 import FiniteMap
  50 import UniqSupply
  51 import SrcLoc           ( SrcLoc, noSrcLoc )
  52 import Outputable
  53 import ListSetOps       ( removeDups, equivClasses )
  54 import Util             ( sortLt )
  55 import List             ( nub )
  56 import UniqFM           ( lookupWithDefaultUFM )
  57 import Maybes           ( orElse )
  58 import CmdLineOpts
  59 import FastString       ( FastString )
  60 \end{code}
  61
  62 %*********************************************************
  63 %*                                                      *
  64 \subsection{Making new names}
  65 %*                                                      *
  66 %*********************************************************
  67
  68 \begin{code}
  69 newTopBinder :: Module -> RdrName -> SrcLoc -> RnM d Name
  70         -- newTopBinder puts into the cache the binder with the
  71         -- module information set correctly.  When the decl is later renamed,
  72         -- the binding site will thereby get the correct module.
  73         -- There maybe occurrences that don't have the correct Module, but
  74         -- by the typechecker will propagate the binding definition to all
  75         -- the occurrences, so that doesn't matter
  76
  77 newTopBinder mod rdr_name loc
  78   =     -- First check the cache
  79
  80         -- There should never be a qualified name in a binding position (except in instance decls)
  81         -- The parser doesn't check this because the same parser parses instance decls
  82     (if isQual rdr_name then
  83         qualNameErr (text "its declaration") (rdr_name,loc)
  84      else
  85         returnRn ()
  86     )                           `thenRn_`
  87
  88     getNameSupplyRn             `thenRn` \ name_supply ->
  89     let
  90         occ = rdrNameOcc rdr_name
  91         key = (moduleName mod, occ)
  92         cache = nsNames name_supply
  93     in
  94     case lookupFM cache key of
  95
  96         -- A hit in the cache!  We are at the binding site of the name, and
  97         -- this is the moment when we know all about
  98         --      a) the Name's host Module (in particular, which
  99         --         package it comes from)
 100         --      b) its defining SrcLoc
 101         -- So we update this info
 102
 103         Just name -> let
 104                         new_name  = setNameModuleAndLoc name mod loc
 105                         new_cache = addToFM cache key new_name
 106                      in
 107                      setNameSupplyRn (name_supply {nsNames = new_cache})        `thenRn_`
 108 --                   traceRn (text "newTopBinder: overwrite" <+> ppr new_name) `thenRn_`
 109                      returnRn new_name
 110
 111         -- Miss in the cache!
 112         -- Build a completely new Name, and put it in the cache
 113         -- Even for locally-defined names we use implicitImportProvenance;
 114         -- updateProvenances will set it to rights
 115         Nothing -> let
 116                         (us', us1) = splitUniqSupply (nsUniqs name_supply)
 117                         uniq       = uniqFromSupply us1
 118                         new_name   = mkGlobalName uniq mod occ loc
 119                         new_cache  = addToFM cache key new_name
 120                    in
 121                    setNameSupplyRn (name_supply {nsUniqs = us', nsNames = new_cache})   `thenRn_`
 122 --                 traceRn (text "newTopBinder: new" <+> ppr new_name) `thenRn_`
 123                    returnRn new_name
 124
 125
 126 newGlobalName :: ModuleName -> OccName -> RnM d Name
 127   -- Used for *occurrences*.  We make a place-holder Name, really just
 128   -- to agree on its unique, which gets overwritten when we read in
 129   -- the binding occurence later (newTopBinder)
 130   -- The place-holder Name doesn't have the right SrcLoc, and its
 131   -- Module won't have the right Package either.
 132   --
 133   -- (We have to pass a ModuleName, not a Module, because we may be
 134   -- simply looking at an occurrence M.x in an interface file.)
 135   --
 136   -- This means that a renamed program may have incorrect info
 137   -- on implicitly-imported occurrences, but the correct info on the
 138   -- *binding* declaration. It's the type checker that propagates the
 139   -- correct information to all the occurrences.
 140   -- Since implicitly-imported names never occur in error messages,
 141   -- it doesn't matter that we get the correct info in place till later,
 142   -- (but since it affects DLL-ery it does matter that we get it right
 143   --  in the end).
 144 newGlobalName mod_name occ
 145   = getNameSupplyRn             `thenRn` \ name_supply ->
 146     let
 147         key = (mod_name, occ)
 148         cache = nsNames name_supply
 149     in
 150     case lookupFM cache key of
 151         Just name -> -- traceRn (text "newGlobalName: hit" <+> ppr name) `thenRn_`
 152                      returnRn name
 153
 154         Nothing   -> setNameSupplyRn (name_supply {nsUniqs = us', nsNames = new_cache})  `thenRn_`
 155                      -- traceRn (text "newGlobalName: new" <+> ppr name)                  `thenRn_`
 156                      returnRn name
 157                   where
 158                      (us', us1) = splitUniqSupply (nsUniqs name_supply)
 159                      uniq       = uniqFromSupply us1
 160                      mod        = mkVanillaModule mod_name
 161                      name       = mkGlobalName uniq mod occ noSrcLoc
 162                      new_cache  = addToFM cache key name
 163
 164 newIPName rdr_name
 165   = getNameSupplyRn             `thenRn` \ name_supply ->
 166     let
 167         ipcache = nsIPs name_supply
 168     in
 169     case lookupFM ipcache key of
 170         Just name -> returnRn name
 171         Nothing   -> setNameSupplyRn (name_supply {nsUniqs = us', nsIPs = new_ipcache}) `thenRn_`
 172                      returnRn name
 173                   where
 174                      (us', us1)  = splitUniqSupply (nsUniqs name_supply)
 175                      uniq        = uniqFromSupply us1
 176                      name        = mkIPName uniq key
 177                      new_ipcache = addToFM ipcache key name
 178     where key = (rdrNameOcc rdr_name)
 179 \end{code}
 180
 181 %*********************************************************
 182 %*                                                      *
 183 \subsection{Looking up names}
 184 %*                                                      *
 185 %*********************************************************
 186
 187 Looking up a name in the RnEnv.
 188
 189 \begin{code}
 190 lookupBndrRn rdr_name
 191   = getLocalNameEnv             `thenRn` \ local_env ->
 192     case lookupRdrEnv local_env rdr_name of
 193           Just name -> returnRn name
 194           Nothing   -> lookupTopBndrRn rdr_name
 195
 196 lookupTopBndrRn rdr_name
 197 -- Look up a top-level local binder.   We may be looking up an unqualified 'f',
 198 -- and there may be several imported 'f's too, which must not confuse us.
 199 -- So we have to filter out the non-local ones.
 200 -- A separate function (importsFromLocalDecls) reports duplicate top level
 201 -- decls, so here it's safe just to choose an arbitrary one.
 202
 203   | isOrig rdr_name
 204         -- This is here just to catch the PrelBase defn of (say) [] and similar
 205         -- The parser reads the special syntax and returns an Orig RdrName
 206         -- But the global_env contains only Qual RdrNames, so we won't
 207         -- find it there; instead just get the name via the Orig route
 208   = lookupOrigName rdr_name
 209
 210   | otherwise
 211   = getModeRn   `thenRn` \ mode ->
 212     if isInterfaceMode mode
 213         then lookupIfaceName rdr_name
 214     else
 215     getModuleRn         `thenRn` \ mod ->
 216     getGlobalNameEnv    `thenRn` \ global_env ->
 217     case lookup_local mod global_env rdr_name of
 218         Just name -> returnRn name
 219         Nothing   -> failWithRn (mkUnboundName rdr_name)
 220                                 (unknownNameErr rdr_name)
 221   where
 222     lookup_local mod global_env rdr_name
 223       = case lookupRdrEnv global_env rdr_name of
 224           Nothing   -> Nothing
 225           Just gres -> case [n | GRE n _ _ <- gres, nameIsLocalOrFrom mod n] of
 226                          []     -> Nothing
 227                          (n:ns) -> Just n
 228
 229
 230 -- lookupSigOccRn is used for type signatures and pragmas
 231 -- Is this valid?
 232 --   module A
 233 --      import M( f )
 234 --      f :: Int -> Int
 235 --      f x = x
 236 -- It's clear that the 'f' in the signature must refer to A.f
 237 -- The Haskell98 report does not stipulate this, but it will!
 238 -- So we must treat the 'f' in the signature in the same way
 239 -- as the binding occurrence of 'f', using lookupBndrRn
 240 lookupSigOccRn :: RdrName -> RnMS Name
 241 lookupSigOccRn = lookupBndrRn
 242
 243 -- lookupOccRn looks up an occurrence of a RdrName
 244 lookupOccRn :: RdrName -> RnMS Name
 245 lookupOccRn rdr_name
 246   = getLocalNameEnv                     `thenRn` \ local_env ->
 247     case lookupRdrEnv local_env rdr_name of
 248           Just name -> returnRn name
 249           Nothing   -> lookupGlobalOccRn rdr_name
 250
 251 -- lookupGlobalOccRn is like lookupOccRn, except that it looks in the global
 252 -- environment.  It's used only for
 253 --      record field names
 254 --      class op names in class and instance decls
 255
 256 lookupGlobalOccRn rdr_name
 257   = getModeRn           `thenRn` \ mode ->
 258     if (isInterfaceMode mode)
 259         then lookupIfaceName rdr_name
 260         else
 261
 262     getGlobalNameEnv    `thenRn` \ global_env ->
 263     case mode of
 264         SourceMode -> lookupSrcName global_env rdr_name
 265
 266         CmdLineMode
 267          | not (isQual rdr_name) ->
 268                 lookupSrcName global_env rdr_name
 269
 270                 -- We allow qualified names on the command line to refer to
 271                 -- *any* name exported by any module in scope, just as if
 272                 -- there was an "import qualified M" declaration for every
 273                 -- module.
 274                 --
 275                 -- First look up the name in the normal environment.  If
 276                 -- it isn't there, we manufacture a new occurrence of an
 277                 -- original name.
 278          | otherwise ->
 279                 case lookupRdrEnv global_env rdr_name of
 280                        Just _  -> lookupSrcName global_env rdr_name
 281                        Nothing -> lookupQualifiedName rdr_name
 282
 283 -- a qualified name on the command line can refer to any module at all: we
 284 -- try to load the interface if we don't already have it.
 285 lookupQualifiedName :: RdrName -> RnM d Name
 286 lookupQualifiedName rdr_name
 287  = let
 288        mod = rdrNameModule rdr_name
 289        occ = rdrNameOcc rdr_name
 290    in
 291    loadInterface (ppr rdr_name) mod ImportBySystem `thenRn` \ iface ->
 292    case  [ name | (_,avails) <- mi_exports iface,
 293            avail             <- avails,
 294            name              <- availNames avail,
 295            nameOccName name == occ ] of
 296       (n:ns) -> ASSERT (null ns) returnRn n
 297       _      -> failWithRn (mkUnboundName rdr_name) (unknownNameErr rdr_name)
 298
 299 lookupSrcName :: GlobalRdrEnv -> RdrName -> RnM d Name
 300 -- NB: passed GlobalEnv explicitly, not necessarily in RnMS monad
 301 lookupSrcName global_env rdr_name
 302   | isOrig rdr_name     -- Can occur in source code too
 303   = lookupOrigName rdr_name
 304
 305   | otherwise
 306   = case lookupRdrEnv global_env rdr_name of
 307         Just [GRE name _ Nothing]       -> returnRn name
 308         Just [GRE name _ (Just deprec)] -> warnDeprec name deprec       `thenRn_`
 309                                            returnRn name
 310         Just stuff@(GRE name _ _ : _)   -> addNameClashErrRn rdr_name stuff     `thenRn_`
 311                                            returnRn name
 312         Nothing                         -> failWithRn (mkUnboundName rdr_name)
 313                                                       (unknownNameErr rdr_name)
 314
 315 lookupOrigName :: RdrName -> RnM d Name
 316 lookupOrigName rdr_name
 317   = ASSERT( isOrig rdr_name )
 318     newGlobalName (rdrNameModule rdr_name) (rdrNameOcc rdr_name)
 319
 320 lookupIfaceUnqual :: RdrName -> RnM d Name
 321 lookupIfaceUnqual rdr_name
 322   = ASSERT( isUnqual rdr_name )
 323         -- An Unqual is allowed; interface files contain
 324         -- unqualified names for locally-defined things, such as
 325         -- constructors of a data type.
 326     getModuleRn                         `thenRn ` \ mod ->
 327     newGlobalName (moduleName mod) (rdrNameOcc rdr_name)
 328
 329 lookupIfaceName :: RdrName -> RnM d Name
 330 lookupIfaceName rdr_name
 331   | isUnqual rdr_name = lookupIfaceUnqual rdr_name
 332   | otherwise         = lookupOrigName rdr_name
 333 \end{code}
 334
 335 @lookupOrigName@ takes an RdrName representing an {\em original}
 336 name, and adds it to the occurrence pool so that it'll be loaded
 337 later.  This is used when language constructs (such as monad
 338 comprehensions, overloaded literals, or deriving clauses) require some
 339 stuff to be loaded that isn't explicitly mentioned in the code.
 340
 341 This doesn't apply in interface mode, where everything is explicit,
 342 but we don't check for this case: it does no harm to record an
 343 ``extra'' occurrence and @lookupOrigNames@ isn't used much in
 344 interface mode (it's only the @Nothing@ clause of @rnDerivs@ that
 345 calls it at all I think).
 346
 347   \fbox{{\em Jan 98: this comment is wrong: @rnHsType@ uses it quite a bit.}}
 348
 349 \begin{code}
 350 lookupOrigNames :: [RdrName] -> RnM d NameSet
 351 lookupOrigNames rdr_names
 352   = mapRn lookupOrigName rdr_names      `thenRn` \ names ->
 353     returnRn (mkNameSet names)
 354 \end{code}
 355
 356 lookupSysBinder is used for the "system binders" of a type, class, or
 357 instance decl.  It ensures that the module is set correctly in the
 358 name cache, and sets the provenance on the returned name too.  The
 359 returned name will end up actually in the type, class, or instance.
 360
 361 \begin{code}
 362 lookupSysBinder rdr_name
 363   = ASSERT( isUnqual rdr_name )
 364     getModuleRn                         `thenRn` \ mod ->
 365     getSrcLocRn                         `thenRn` \ loc ->
 366     newTopBinder mod rdr_name loc
 367 \end{code}
 368
 369
 370 %*********************************************************
 371 %*                                                      *
 372 \subsection{Implicit free vars and sugar names}
 373 %*                                                      *
 374 %*********************************************************
 375
 376 @getXImplicitFVs@ forces the renamer to slurp in some things which aren't
 377 mentioned explicitly, but which might be needed by the type checker.
 378
 379 \begin{code}
 380 getImplicitStmtFVs      -- Compiling a statement
 381   = returnRn (mkFVs [printName, bindIOName, returnIOName, failIOName]
 382               `plusFV` ubiquitousNames)
 383                 -- These are all needed implicitly when compiling a statement
 384                 -- See TcModule.tc_stmts
 385
 386 getImplicitModuleFVs mod_name decls     -- Compiling a module
 387   = lookupOrigNames deriv_occs          `thenRn` \ deriving_names ->
 388     returnRn (deriving_names `plusFV` implicit_main `plusFV` ubiquitousNames)
 389   where
 390         -- Add occurrences for IO or PrimIO
 391         implicit_main |  mod_name == mAIN_Name
 392                       || mod_name == pREL_MAIN_Name = unitFV ioTyConName
 393                       |  otherwise                  = emptyFVs
 394
 395         deriv_occs = [occ | TyClD (TyData {tcdDerivs = Just deriv_classes}) <- decls,
 396                             cls <- deriv_classes,
 397                             occ <- lookupWithDefaultUFM derivingOccurrences [] cls ]
 398
 399 -- ubiquitous_names are loaded regardless, because
 400 -- they are needed in virtually every program
 401 ubiquitousNames
 402   = mkFVs [unpackCStringName, unpackCStringFoldrName,
 403            unpackCStringUtf8Name, eqStringName]
 404         -- Virtually every program has error messages in it somewhere
 405
 406   `plusFV`
 407     mkFVs [getName unitTyCon, funTyConName, boolTyConName, intTyConName]
 408         -- Add occurrences for very frequently used types.
 409         --       (e.g. we don't want to be bothered with making funTyCon a
 410         --        free var at every function application!)
 411 \end{code}
 412
 413 \begin{code}
 414 implicitGates :: Name -> FreeVars
 415 -- If we load class Num, add Integer to the gates
 416 -- This takes account of the fact that Integer might be needed for
 417 -- defaulting, but we don't want to load Integer (and all its baggage)
 418 -- if there's no numeric stuff needed.
 419 -- Similarly for class Fractional and Double
 420 --
 421 -- NB: If we load (say) Floating, we'll end up loading Fractional too,
 422 --     since Fractional is a superclass of Floating
 423 implicitGates cls | cls `hasKey` numClassKey        = unitFV integerTyConName
 424                   | cls `hasKey` fractionalClassKey = unitFV doubleTyConName
 425                   | otherwise                       = emptyFVs
 426 \end{code}
 427
 428 \begin{code}
 429 rnSyntaxNames :: GlobalRdrEnv -> FreeVars -> RnMG (FreeVars, SyntaxMap)
 430 -- Look up the re-bindable syntactic sugar names
 431 -- Any errors arising from these lookups may surprise the
 432 -- programmer, since they aren't explicitly mentioned, and
 433 -- the src line will be unhelpful (ToDo)
 434
 435 rnSyntaxNames gbl_env source_fvs
 436   = doptRn Opt_NoImplicitPrelude        `thenRn` \ no_prelude ->
 437     if not no_prelude then
 438         returnRn (source_fvs, vanillaSyntaxMap)
 439     else
 440
 441         -- There's a -fno-implicit-prelude flag,
 442         -- so build the re-mapping function
 443     let
 444         reqd_syntax_list = filter is_reqd syntaxList
 445         is_reqd (n,_)    = n `elemNameSet` source_fvs
 446         lookup (n,rn)    = lookupSrcName gbl_env rn     `thenRn` \ rn' ->
 447                            returnRn (n,rn')
 448     in
 449     mapRn lookup reqd_syntax_list       `thenRn` \ rn_syntax_list ->
 450     let
 451         -- Delete the proxies and add the actuals
 452         proxies = map fst rn_syntax_list
 453         actuals = map snd rn_syntax_list
 454         new_source_fvs = (proxies `delFVs` source_fvs) `plusFV` mkFVs actuals
 455
 456         syntax_env   = mkNameEnv rn_syntax_list
 457         syntax_map n = lookupNameEnv syntax_env n `orElse` n
 458     in
 459     returnRn (new_source_fvs, syntax_map)
 460 \end{code}
 461
 462
 463 %*********************************************************
 464 %*                                                      *
 465 \subsection{Binding}
 466 %*                                                      *
 467 %*********************************************************
 468
 469 \begin{code}
 470 newLocalsRn :: [(RdrName,SrcLoc)]
 471             -> RnMS [Name]
 472 newLocalsRn rdr_names_w_loc
 473  =  getNameSupplyRn             `thenRn` \ name_supply ->
 474     let
 475         n          = length rdr_names_w_loc
 476         (us', us1) = splitUniqSupply (nsUniqs name_supply)
 477         uniqs      = uniqsFromSupply n us1
 478         names      = [ mkLocalName uniq (rdrNameOcc rdr_name) loc
 479                      | ((rdr_name,loc), uniq) <- rdr_names_w_loc `zip` uniqs
 480                      ]
 481     in
 482     setNameSupplyRn (name_supply {nsUniqs = us'})       `thenRn_`
 483     returnRn names
 484
 485
 486 bindLocatedLocalsRn :: SDoc     -- Documentation string for error message
 487                     -> [(RdrName,SrcLoc)]
 488                     -> ([Name] -> RnMS a)
 489                     -> RnMS a
 490 bindLocatedLocalsRn doc_str rdr_names_w_loc enclosed_scope
 491   = getModeRn                           `thenRn` \ mode ->
 492     getLocalNameEnv                     `thenRn` \ name_env ->
 493
 494         -- Check for duplicate names
 495     checkDupOrQualNames doc_str rdr_names_w_loc `thenRn_`
 496
 497         -- Warn about shadowing, but only in source modules
 498     (case mode of
 499         SourceMode -> ifOptRn Opt_WarnNameShadowing     $
 500                       mapRn_ (check_shadow name_env) rdr_names_w_loc
 501         other      -> returnRn ()
 502     )                                   `thenRn_`
 503
 504     newLocalsRn rdr_names_w_loc         `thenRn` \ names ->
 505     let
 506         new_local_env = addListToRdrEnv name_env (map fst rdr_names_w_loc `zip` names)
 507     in
 508     setLocalNameEnv new_local_env (enclosed_scope names)
 509
 510   where
 511     check_shadow name_env (rdr_name,loc)
 512         = case lookupRdrEnv name_env rdr_name of
 513                 Nothing   -> returnRn ()
 514                 Just name -> pushSrcLocRn loc $
 515                              addWarnRn (shadowedNameWarn rdr_name)
 516
 517 bindCoreLocalRn :: RdrName -> (Name -> RnMS a) -> RnMS a
 518   -- A specialised variant when renaming stuff from interface
 519   -- files (of which there is a lot)
 520   --    * one at a time
 521   --    * no checks for shadowing
 522   --    * always imported
 523   --    * deal with free vars
 524 bindCoreLocalRn rdr_name enclosed_scope
 525   = getSrcLocRn                 `thenRn` \ loc ->
 526     getLocalNameEnv             `thenRn` \ name_env ->
 527     getNameSupplyRn             `thenRn` \ name_supply ->
 528     let
 529         (us', us1) = splitUniqSupply (nsUniqs name_supply)
 530         uniq       = uniqFromSupply us1
 531         name       = mkLocalName uniq (rdrNameOcc rdr_name) loc
 532     in
 533     setNameSupplyRn (name_supply {nsUniqs = us'})       `thenRn_`
 534     let
 535         new_name_env = extendRdrEnv name_env rdr_name name
 536     in
 537     setLocalNameEnv new_name_env (enclosed_scope name)
 538
 539 bindCoreLocalsRn []     thing_inside = thing_inside []
 540 bindCoreLocalsRn (b:bs) thing_inside = bindCoreLocalRn b        $ \ name' ->
 541                                        bindCoreLocalsRn bs      $ \ names' ->
 542                                        thing_inside (name':names')
 543
 544 bindLocalNames names enclosed_scope
 545   = getLocalNameEnv             `thenRn` \ name_env ->
 546     setLocalNameEnv (extendLocalRdrEnv name_env names)
 547                     enclosed_scope
 548
 549 bindLocalNamesFV names enclosed_scope
 550   = bindLocalNames names $
 551     enclosed_scope `thenRn` \ (thing, fvs) ->
 552     returnRn (thing, delListFromNameSet fvs names)
 553
 554
 555 -------------------------------------
 556 bindLocalRn doc rdr_name enclosed_scope
 557   = getSrcLocRn                                 `thenRn` \ loc ->
 558     bindLocatedLocalsRn doc [(rdr_name,loc)]    $ \ (n:ns) ->
 559     ASSERT( null ns )
 560     enclosed_scope n
 561
 562 bindLocalsRn doc rdr_names enclosed_scope
 563   = getSrcLocRn         `thenRn` \ loc ->
 564     bindLocatedLocalsRn doc
 565                         (rdr_names `zip` repeat loc)
 566                         enclosed_scope
 567
 568         -- binLocalsFVRn is the same as bindLocalsRn
 569         -- except that it deals with free vars
 570 bindLocalsFVRn doc rdr_names enclosed_scope
 571   = bindLocalsRn doc rdr_names          $ \ names ->
 572     enclosed_scope names                `thenRn` \ (thing, fvs) ->
 573     returnRn (thing, delListFromNameSet fvs names)
 574
 575 -------------------------------------
 576 extendTyVarEnvFVRn :: [Name] -> RnMS (a, FreeVars) -> RnMS (a, FreeVars)
 577         -- This tiresome function is used only in rnSourceDecl on InstDecl
 578 extendTyVarEnvFVRn tyvars enclosed_scope
 579   = bindLocalNames tyvars enclosed_scope        `thenRn` \ (thing, fvs) ->
 580     returnRn (thing, delListFromNameSet fvs tyvars)
 581
 582 bindTyVarsRn :: SDoc -> [HsTyVarBndr RdrName]
 583               -> ([HsTyVarBndr Name] -> RnMS a)
 584               -> RnMS a
 585 bindTyVarsRn doc_str tyvar_names enclosed_scope
 586   = bindTyVars2Rn doc_str tyvar_names   $ \ names tyvars ->
 587     enclosed_scope tyvars
 588
 589 -- Gruesome name: return Names as well as HsTyVars
 590 bindTyVars2Rn :: SDoc -> [HsTyVarBndr RdrName]
 591               -> ([Name] -> [HsTyVarBndr Name] -> RnMS a)
 592               -> RnMS a
 593 bindTyVars2Rn doc_str tyvar_names enclosed_scope
 594   = getSrcLocRn                                 `thenRn` \ loc ->
 595     let
 596         located_tyvars = [(hsTyVarName tv, loc) | tv <- tyvar_names]
 597     in
 598     bindLocatedLocalsRn doc_str located_tyvars  $ \ names ->
 599     enclosed_scope names (zipWith replaceTyVarName tyvar_names names)
 600
 601 bindTyVarsFVRn :: SDoc -> [HsTyVarBndr RdrName]
 602               -> ([HsTyVarBndr Name] -> RnMS (a, FreeVars))
 603               -> RnMS (a, FreeVars)
 604 bindTyVarsFVRn doc_str rdr_names enclosed_scope
 605   = bindTyVars2Rn doc_str rdr_names     $ \ names tyvars ->
 606     enclosed_scope tyvars               `thenRn` \ (thing, fvs) ->
 607     returnRn (thing, delListFromNameSet fvs names)
 608
 609 bindTyVarsFV2Rn :: SDoc -> [HsTyVarBndr RdrName]
 610               -> ([Name] -> [HsTyVarBndr Name] -> RnMS (a, FreeVars))
 611               -> RnMS (a, FreeVars)
 612 bindTyVarsFV2Rn doc_str rdr_names enclosed_scope
 613   = bindTyVars2Rn doc_str rdr_names     $ \ names tyvars ->
 614     enclosed_scope names tyvars         `thenRn` \ (thing, fvs) ->
 615     returnRn (thing, delListFromNameSet fvs names)
 616
 617 bindNakedTyVarsFVRn :: SDoc -> [RdrName]
 618                     -> ([Name] -> RnMS (a, FreeVars))
 619                     -> RnMS (a, FreeVars)
 620 bindNakedTyVarsFVRn doc_str tyvar_names enclosed_scope
 621   = getSrcLocRn                                 `thenRn` \ loc ->
 622     let
 623         located_tyvars = [(tv, loc) | tv <- tyvar_names]
 624     in
 625     bindLocatedLocalsRn doc_str located_tyvars  $ \ names ->
 626     enclosed_scope names                        `thenRn` \ (thing, fvs) ->
 627     returnRn (thing, delListFromNameSet fvs names)
 628
 629
 630 -------------------------------------
 631 checkDupOrQualNames, checkDupNames :: SDoc
 632                                    -> [(RdrName, SrcLoc)]
 633                                    -> RnM d ()
 634         -- Works in any variant of the renamer monad
 635
 636 checkDupOrQualNames doc_str rdr_names_w_loc
 637   =     -- Check for use of qualified names
 638     mapRn_ (qualNameErr doc_str) quals  `thenRn_`
 639     checkDupNames doc_str rdr_names_w_loc
 640   where
 641     quals = filter (isQual . fst) rdr_names_w_loc
 642
 643 checkDupNames doc_str rdr_names_w_loc
 644   =     -- Check for duplicated names in a binding group
 645     mapRn_ (dupNamesErr doc_str) dups
 646   where
 647     (_, dups) = removeDups (\(n1,l1) (n2,l2) -> n1 `compare` n2) rdr_names_w_loc
 648 \end{code}
 649
 650
 651 %************************************************************************
 652 %*                                                                      *
 653 \subsection{GlobalRdrEnv}
 654 %*                                                                      *
 655 %************************************************************************
 656
 657 \begin{code}
 658 mkGlobalRdrEnv :: ModuleName            -- Imported module (after doing the "as M" name change)
 659                -> Bool                  -- True <=> want unqualified import
 660                -> Bool                  -- True <=> want qualified import
 661                -> [AvailInfo]           -- What's to be hidden (but only the unqualified
 662                                         --      version is hidden)
 663                -> (Name -> Provenance)
 664                -> Avails                -- Whats imported and how
 665                -> Deprecations
 666                -> GlobalRdrEnv
 667
 668 mkGlobalRdrEnv this_mod unqual_imp qual_imp hides
 669                mk_provenance avails deprecs
 670   = gbl_env2
 671   where
 672         -- Make the name environment.  We're talking about a
 673         -- single module here, so there must be no name clashes.
 674         -- In practice there only ever will be if it's the module
 675         -- being compiled.
 676
 677         -- Add the things that are available
 678     gbl_env1 = foldl add_avail emptyRdrEnv avails
 679
 680         -- Delete things that are hidden
 681     gbl_env2 = foldl del_avail gbl_env1 hides
 682
 683     add_avail :: GlobalRdrEnv -> AvailInfo -> GlobalRdrEnv
 684     add_avail env avail = foldl add_name env (availNames avail)
 685
 686     add_name env name
 687         | qual_imp && unqual_imp = env3
 688         | unqual_imp             = env2
 689         | qual_imp               = env1
 690         | otherwise              = env
 691         where
 692           env1 = addOneToGlobalRdrEnv env  (mkRdrQual this_mod occ) elt
 693           env2 = addOneToGlobalRdrEnv env  (mkRdrUnqual occ)        elt
 694           env3 = addOneToGlobalRdrEnv env1 (mkRdrUnqual occ)        elt
 695           occ  = nameOccName name
 696           elt  = GRE name (mk_provenance name) (lookupDeprec deprecs name)
 697
 698     del_avail env avail = foldl delOneFromGlobalRdrEnv env rdr_names
 699                         where
 700                           rdr_names = map (mkRdrUnqual . nameOccName) (availNames avail)
 701
 702 mkIfaceGlobalRdrEnv :: [(ModuleName,Avails)] -> GlobalRdrEnv
 703 -- Used to construct a GlobalRdrEnv for an interface that we've
 704 -- read from a .hi file.  We can't construct the original top-level
 705 -- environment because we don't have enough info, but we compromise
 706 -- by making an environment from its exports
 707 mkIfaceGlobalRdrEnv m_avails
 708   = foldl add emptyRdrEnv m_avails
 709   where
 710     add env (mod,avails) = plusGlobalRdrEnv env (mkGlobalRdrEnv mod True False []
 711                                                                 (\n -> LocalDef) avails NoDeprecs)
 712                 -- The NoDeprecs is a bit of a hack I suppose
 713 \end{code}
 714
 715 \begin{code}
 716 plusGlobalRdrEnv :: GlobalRdrEnv -> GlobalRdrEnv -> GlobalRdrEnv
 717 plusGlobalRdrEnv env1 env2 = plusFM_C combine_globals env1 env2
 718
 719 addOneToGlobalRdrEnv :: GlobalRdrEnv -> RdrName -> GlobalRdrElt -> GlobalRdrEnv
 720 addOneToGlobalRdrEnv env rdr_name name = addToFM_C combine_globals env rdr_name [name]
 721
 722 delOneFromGlobalRdrEnv :: GlobalRdrEnv -> RdrName -> GlobalRdrEnv
 723 delOneFromGlobalRdrEnv env rdr_name = delFromFM env rdr_name
 724
 725 combine_globals :: [GlobalRdrElt]       -- Old
 726                 -> [GlobalRdrElt]       -- New
 727                 -> [GlobalRdrElt]
 728 combine_globals ns_old ns_new   -- ns_new is often short
 729   = foldr add ns_old ns_new
 730   where
 731     add n ns | any (is_duplicate n) ns_old = map (choose n) ns  -- Eliminate duplicates
 732              | otherwise                   = n:ns
 733
 734     choose n m | n `beats` m = n
 735                | otherwise   = m
 736
 737     (GRE n pn _) `beats` (GRE m pm _) = n==m && pn `hasBetterProv` pm
 738
 739     is_duplicate :: GlobalRdrElt -> GlobalRdrElt -> Bool
 740     is_duplicate (GRE n1 LocalDef _) (GRE n2 LocalDef _) = False
 741     is_duplicate (GRE n1 _        _) (GRE n2 _        _) = n1 == n2
 742 \end{code}
 743
 744 We treat two bindings of a locally-defined name as a duplicate,
 745 because they might be two separate, local defns and we want to report
 746 and error for that, {\em not} eliminate a duplicate.
 747
 748 On the other hand, if you import the same name from two different
 749 import statements, we {\em do} want to eliminate the duplicate, not report
 750 an error.
 751
 752 If a module imports itself then there might be a local defn and an imported
 753 defn of the same name; in this case the names will compare as equal, but
 754 will still have different provenances.
 755
 756
 757 @unQualInScope@ returns a function that takes a @Name@ and tells whether
 758 its unqualified name is in scope.  This is put as a boolean flag in
 759 the @Name@'s provenance to guide whether or not to print the name qualified
 760 in error messages.
 761
 762 \begin{code}
 763 unQualInScope :: GlobalRdrEnv -> Name -> Bool
 764 -- True if 'f' is in scope, and has only one binding
 765 -- (i.e. false if A.f and B.f are both in scope as unqualified 'f')
 766 unQualInScope env
 767   = (`elemNameSet` unqual_names)
 768   where
 769     unqual_names :: NameSet
 770     unqual_names = foldRdrEnv add emptyNameSet env
 771     add rdr_name [GRE name _ _] unquals | isUnqual rdr_name = addOneToNameSet unquals name
 772     add _        _              unquals                     = unquals
 773 \end{code}
 774
 775
 776 %************************************************************************
 777 %*                                                                      *
 778 \subsection{Avails}
 779 %*                                                                      *
 780 %************************************************************************
 781
 782 \begin{code}
 783 plusAvail (Avail n1)       (Avail n2)       = Avail n1
 784 plusAvail (AvailTC n1 ns1) (AvailTC n2 ns2) = AvailTC n2 (nub (ns1 ++ ns2))
 785 -- Added SOF 4/97
 786 #ifdef DEBUG
 787 plusAvail a1 a2 = pprPanic "RnEnv.plusAvail" (hsep [ppr a1,ppr a2])
 788 #endif
 789
 790 addAvail :: AvailEnv -> AvailInfo -> AvailEnv
 791 addAvail avails avail = extendNameEnv_C plusAvail avails (availName avail) avail
 792
 793 emptyAvailEnv = emptyNameEnv
 794 unitAvailEnv :: AvailInfo -> AvailEnv
 795 unitAvailEnv a = unitNameEnv (availName a) a
 796
 797 plusAvailEnv :: AvailEnv -> AvailEnv -> AvailEnv
 798 plusAvailEnv = plusNameEnv_C plusAvail
 799
 800 availEnvElts = nameEnvElts
 801
 802 addAvailToNameSet :: NameSet -> AvailInfo -> NameSet
 803 addAvailToNameSet names avail = addListToNameSet names (availNames avail)
 804
 805 availsToNameSet :: [AvailInfo] -> NameSet
 806 availsToNameSet avails = foldl addAvailToNameSet emptyNameSet avails
 807
 808 availName :: GenAvailInfo name -> name
 809 availName (Avail n)     = n
 810 availName (AvailTC n _) = n
 811
 812 availNames :: GenAvailInfo name -> [name]
 813 availNames (Avail n)      = [n]
 814 availNames (AvailTC n ns) = ns
 815
 816 -------------------------------------
 817 filterAvail :: RdrNameIE        -- Wanted
 818             -> AvailInfo        -- Available
 819             -> Maybe AvailInfo  -- Resulting available;
 820                                 -- Nothing if (any of the) wanted stuff isn't there
 821
 822 filterAvail ie@(IEThingWith want wants) avail@(AvailTC n ns)
 823   | sub_names_ok = Just (AvailTC n (filter is_wanted ns))
 824   | otherwise    = Nothing
 825   where
 826     is_wanted name = nameOccName name `elem` wanted_occs
 827     sub_names_ok   = all (`elem` avail_occs) wanted_occs
 828     avail_occs     = map nameOccName ns
 829     wanted_occs    = map rdrNameOcc (want:wants)
 830
 831 filterAvail (IEThingAbs _) (AvailTC n ns)       = ASSERT( n `elem` ns )
 832                                                   Just (AvailTC n [n])
 833
 834 filterAvail (IEThingAbs _) avail@(Avail n)      = Just avail            -- Type synonyms
 835
 836 filterAvail (IEVar _)      avail@(Avail n)      = Just avail
 837 filterAvail (IEVar v)      avail@(AvailTC n ns) = Just (AvailTC n (filter wanted ns))
 838                                                 where
 839                                                   wanted n = nameOccName n == occ
 840                                                   occ      = rdrNameOcc v
 841         -- The second equation happens if we import a class op, thus
 842         --      import A( op )
 843         -- where op is a class operation
 844
 845 filterAvail (IEThingAll _) avail@(AvailTC _ _)   = Just avail
 846         -- We don't complain even if the IE says T(..), but
 847         -- no constrs/class ops of T are available
 848         -- Instead that's caught with a warning by the caller
 849
 850 filterAvail ie avail = Nothing
 851
 852 -------------------------------------
 853 groupAvails :: Module -> Avails -> [(ModuleName, Avails)]
 854   -- Group by module and sort by occurrence
 855   -- This keeps the list in canonical order
 856 groupAvails this_mod avails
 857   = [ (mkSysModuleNameFS fs, sortLt lt avails)
 858     | (fs,avails) <- fmToList groupFM
 859     ]
 860   where
 861     groupFM :: FiniteMap FastString Avails
 862         -- Deliberately use the FastString so we
 863         -- get a canonical ordering
 864     groupFM = foldl add emptyFM avails
 865
 866     add env avail = addToFM_C combine env mod_fs [avail']
 867                   where
 868                     mod_fs = moduleNameFS (moduleName avail_mod)
 869                     avail_mod = case nameModule_maybe (availName avail) of
 870                                           Just m  -> m
 871                                           Nothing -> this_mod
 872                     combine old _ = avail':old
 873                     avail'        = sortAvail avail
 874
 875     a1 `lt` a2 = occ1 < occ2
 876                where
 877                  occ1  = nameOccName (availName a1)
 878                  occ2  = nameOccName (availName a2)
 879
 880 sortAvail :: AvailInfo -> AvailInfo
 881 -- Sort the sub-names into canonical order.
 882 -- The canonical order has the "main name" at the beginning
 883 -- (if it's there at all)
 884 sortAvail (Avail n) = Avail n
 885 sortAvail (AvailTC n ns) | n `elem` ns = AvailTC n (n : sortLt lt (filter (/= n) ns))
 886                          | otherwise   = AvailTC n (    sortLt lt ns)
 887                          where
 888                            n1 `lt` n2 = nameOccName n1 < nameOccName n2
 889 \end{code}
 890
 891
 892 %************************************************************************
 893 %*                                                                      *
 894 \subsection{Free variable manipulation}
 895 %*                                                                      *
 896 %************************************************************************
 897
 898 \begin{code}
 899 -- A useful utility
 900 mapFvRn f xs = mapRn f xs       `thenRn` \ stuff ->
 901                let
 902                   (ys, fvs_s) = unzip stuff
 903                in
 904                returnRn (ys, plusFVs fvs_s)
 905 \end{code}
 906
 907
 908 %************************************************************************
 909 %*                                                                      *
 910 \subsection{Envt utility functions}
 911 %*                                                                      *
 912 %************************************************************************
 913
 914 \begin{code}
 915 warnUnusedModules :: [ModuleName] -> RnM d ()
 916 warnUnusedModules mods
 917   = ifOptRn Opt_WarnUnusedImports (mapRn_ (addWarnRn . unused_mod) mods)
 918   where
 919     unused_mod m = vcat [ptext SLIT("Module") <+> quotes (ppr m) <+>
 920                            text "is imported, but nothing from it is used",
 921                          parens (ptext SLIT("except perhaps to re-export instances visible in") <+>
 922                                    quotes (ppr m))]
 923
 924 warnUnusedImports :: [(Name,Provenance)] -> RnM d ()
 925 warnUnusedImports names
 926   = ifOptRn Opt_WarnUnusedImports (warnUnusedBinds names)
 927
 928 warnUnusedLocalBinds, warnUnusedMatches :: [Name] -> RnM d ()
 929 warnUnusedLocalBinds names
 930   = ifOptRn Opt_WarnUnusedBinds (warnUnusedBinds [(n,LocalDef) | n<-names])
 931
 932 warnUnusedMatches names
 933   = ifOptRn Opt_WarnUnusedMatches (warnUnusedGroup [(n,LocalDef) | n<-names])
 934
 935 -------------------------
 936
 937 warnUnusedBinds :: [(Name,Provenance)] -> RnM d ()
 938 warnUnusedBinds names
 939   = mapRn_ warnUnusedGroup  groups
 940   where
 941         -- Group by provenance
 942    groups = equivClasses cmp names
 943    (_,prov1) `cmp` (_,prov2) = prov1 `compare` prov2
 944
 945
 946 -------------------------
 947
 948 warnUnusedGroup :: [(Name,Provenance)] -> RnM d ()
 949 warnUnusedGroup names
 950   | null filtered_names  = returnRn ()
 951   | not is_local         = returnRn ()
 952   | otherwise
 953   = pushSrcLocRn def_loc        $
 954     addWarnRn                   $
 955     sep [msg <> colon, nest 4 (fsep (punctuate comma (map (ppr.fst) filtered_names)))]
 956   where
 957     filtered_names = filter reportable names
 958     (name1, prov1) = head filtered_names
 959     (is_local, def_loc, msg)
 960         = case prov1 of
 961                 LocalDef -> (True, getSrcLoc name1, text "Defined but not used")
 962
 963                 NonLocalDef (UserImport mod loc _)
 964                         -> (True, loc, text "Imported from" <+> quotes (ppr mod) <+> text "but not used")
 965
 966     reportable (name,_) = case occNameUserString (nameOccName name) of
 967                                 ('_' : _) -> False
 968                                 zz_other  -> True
 969         -- Haskell 98 encourages compilers to suppress warnings about
 970         -- unused names in a pattern if they start with "_".
 971 \end{code}
 972
 973 \begin{code}
 974 addNameClashErrRn rdr_name (np1:nps)
 975   = addErrRn (vcat [ptext SLIT("Ambiguous occurrence") <+> quotes (ppr rdr_name),
 976                     ptext SLIT("It could refer to") <+> vcat (msg1 : msgs)])
 977   where
 978     msg1 = ptext  SLIT("either") <+> mk_ref np1
 979     msgs = [ptext SLIT("    or") <+> mk_ref np | np <- nps]
 980     mk_ref (GRE name prov _) = quotes (ppr name) <> comma <+> pprNameProvenance name prov
 981
 982 shadowedNameWarn shadow
 983   = hsep [ptext SLIT("This binding for"),
 984                quotes (ppr shadow),
 985                ptext SLIT("shadows an existing binding")]
 986
 987 unknownNameErr name
 988   = sep [text flavour, ptext SLIT("not in scope:"), quotes (ppr name)]
 989   where
 990     flavour = occNameFlavour (rdrNameOcc name)
 991
 992 qualNameErr descriptor (name,loc)
 993   = pushSrcLocRn loc $
 994     addErrRn (hsep [ ptext SLIT("Invalid use of qualified name"),
 995                      quotes (ppr name),
 996                      ptext SLIT("in"),
 997                      descriptor])
 998
 999 dupNamesErr descriptor ((name,loc) : dup_things)
1000   = pushSrcLocRn loc $
1001     addErrRn ((ptext SLIT("Conflicting definitions for") <+> quotes (ppr name))
1002               $$
1003               (ptext SLIT("in") <+> descriptor))
1004
1005 warnDeprec :: Name -> DeprecTxt -> RnM d ()
1006 warnDeprec name txt
1007   = ifOptRn Opt_WarnDeprecations        $
1008     addWarnRn (sep [ text (occNameFlavour (nameOccName name)) <+>
1009                      quotes (ppr name) <+> text "is deprecated:",
1010                      nest 4 (ppr txt) ])
1011 \end{code}