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 (
   8         newTopSrcBinder,
   9         lookupLocatedBndrRn, lookupBndrRn,
  10         lookupLocatedTopBndrRn, lookupTopBndrRn,
  11         lookupLocatedOccRn, lookupOccRn,
  12         lookupLocatedGlobalOccRn, lookupGlobalOccRn,
  13         lookupTopFixSigNames, lookupSrcOcc_maybe,
  14         lookupFixityRn, lookupLocatedSigOccRn,
  15         lookupLocatedInstDeclBndr,
  16         lookupSyntaxName, lookupSyntaxNames, lookupImportedName,
  17
  18         newLocalsRn, newIPNameRn,
  19         bindLocalNames, bindLocalNamesFV,
  20         bindLocatedLocalsFV, bindLocatedLocalsRn,
  21         bindSigTyVarsFV, bindPatSigTyVars, bindPatSigTyVarsFV,
  22         bindTyVarsRn, extendTyVarEnvFVRn,
  23         bindLocalFixities,
  24
  25         checkDupNames, mapFvRn,
  26         warnUnusedMatches, warnUnusedModules, warnUnusedImports,
  27         warnUnusedTopBinds, warnUnusedLocalBinds,
  28         dataTcOccs, unknownNameErr,
  29     ) where
  30
  31 #include "HsVersions.h"
  32
  33 import LoadIface        ( loadSrcInterface )
  34 import IfaceEnv         ( lookupOrig, newGlobalBinder, newIPName )
  35 import HsSyn
  36 import RdrHsSyn         ( extractHsTyRdrTyVars )
  37 import RdrName          ( RdrName, rdrNameModule, rdrNameOcc, isQual, isUnqual, isOrig,
  38                           mkRdrUnqual, setRdrNameSpace, rdrNameOcc,
  39                           pprGlobalRdrEnv, lookupGRE_RdrName,
  40                           isExact_maybe, isSrcRdrName,
  41                           GlobalRdrElt(..), GlobalRdrEnv, lookupGlobalRdrEnv,
  42                           isLocalGRE, extendLocalRdrEnv, elemLocalRdrEnv, lookupLocalRdrEnv,
  43                           Provenance(..), pprNameProvenance, ImportSpec(..)
  44                         )
  45 import HsTypes          ( replaceTyVarName )
  46 import HscTypes         ( availNames, ModIface(..), FixItem(..), lookupFixity )
  47 import TcRnMonad
  48 import Name             ( Name, nameIsLocalOrFrom, mkInternalName,
  49                           nameSrcLoc, nameOccName, nameModule, nameParent, isExternalName )
  50 import NameSet
  51 import OccName          ( tcName, isDataOcc, occNameFlavour, reportIfUnused )
  52 import Module           ( Module )
  53 import PrelNames        ( mkUnboundName, rOOT_MAIN, iNTERACTIVE, consDataConKey, hasKey )
  54 import UniqSupply
  55 import BasicTypes       ( IPName, mapIPName )
  56 import SrcLoc           ( SrcSpan, srcSpanStart, Located(..), eqLocated, unLoc,
  57                           srcLocSpan, getLoc, combineSrcSpans, srcSpanStartLine, srcSpanEndLine )
  58 import Outputable
  59 import Util             ( sortLe )
  60 import ListSetOps       ( removeDups )
  61 import List             ( nubBy )
  62 import CmdLineOpts
  63 import FastString       ( FastString )
  64 \end{code}
  65
  66 %*********************************************************
  67 %*                                                      *
  68                 Source-code binders
  69 %*                                                      *
  70 %*********************************************************
  71
  72 \begin{code}
  73 newTopSrcBinder :: Module -> Maybe Name -> Located RdrName -> RnM Name
  74 newTopSrcBinder this_mod mb_parent (L loc rdr_name)
  75   | Just name <- isExact_maybe rdr_name
  76   =     -- This is here to catch
  77         --   (a) Exact-name binders created by Template Haskell
  78         --   (b) The PrelBase defn of (say) [] and similar, for which
  79         --       the parser reads the special syntax and returns an Exact RdrName
  80         -- We are at a binding site for the name, so check first that it
  81         -- the current module is the correct one; otherwise GHC can get
  82         -- very confused indeed. This test rejects code like
  83         --      data T = (,) Int Int
  84         -- unless we are in GHC.Tup
  85     ASSERT2( isExternalName name,  ppr name )
  86     do  checkErr (this_mod == nameModule name)
  87                  (badOrigBinding rdr_name)
  88         returnM name
  89
  90
  91   | isOrig rdr_name
  92   = do  checkErr (rdr_mod == this_mod || rdr_mod == rOOT_MAIN)
  93                  (badOrigBinding rdr_name)
  94         -- When reading External Core we get Orig names as binders,
  95         -- but they should agree with the module gotten from the monad
  96         --
  97         -- We can get built-in syntax showing up here too, sadly.  If you type
  98         --      data T = (,,,)
  99         -- the constructor is parsed as a type, and then RdrHsSyn.tyConToDataCon
 100         -- uses setRdrNameSpace to make it into a data constructors.  At that point
 101         -- the nice Exact name for the TyCon gets swizzled to an Orig name.
 102         -- Hence the badOrigBinding error message.
 103         --
 104         -- Except for the ":Main.main = ..." definition inserted into
 105         -- the Main module; ugh!
 106
 107         -- Because of this latter case, we call newGlobalBinder with a module from
 108         -- the RdrName, not from the environment.  In principle, it'd be fine to
 109         -- have an arbitrary mixture of external core definitions in a single module,
 110         -- (apart from module-initialisation issues, perhaps).
 111         newGlobalBinder rdr_mod (rdrNameOcc rdr_name) mb_parent
 112                         (srcSpanStart loc) --TODO, should pass the whole span
 113
 114   | otherwise
 115   = newGlobalBinder this_mod (rdrNameOcc rdr_name) mb_parent (srcSpanStart loc)
 116   where
 117     rdr_mod  = rdrNameModule rdr_name
 118 \end{code}
 119
 120 %*********************************************************
 121 %*                                                      *
 122         Source code occurrences
 123 %*                                                      *
 124 %*********************************************************
 125
 126 Looking up a name in the RnEnv.
 127
 128 \begin{code}
 129 lookupLocatedBndrRn :: Located RdrName -> RnM (Located Name)
 130 lookupLocatedBndrRn = wrapLocM lookupBndrRn
 131
 132 lookupBndrRn :: RdrName -> RnM Name
 133 -- NOTE: assumes that the SrcSpan of the binder has already been setSrcSpan'd
 134 lookupBndrRn rdr_name
 135   = getLocalRdrEnv              `thenM` \ local_env ->
 136     case lookupLocalRdrEnv local_env rdr_name of
 137           Just name -> returnM name
 138           Nothing   -> lookupTopBndrRn rdr_name
 139
 140 lookupLocatedTopBndrRn :: Located RdrName -> RnM (Located Name)
 141 lookupLocatedTopBndrRn = wrapLocM lookupTopBndrRn
 142
 143 lookupTopBndrRn :: RdrName -> RnM Name
 144 -- Look up a top-level source-code binder.   We may be looking up an unqualified 'f',
 145 -- and there may be several imported 'f's too, which must not confuse us.
 146 -- For example, this is OK:
 147 --      import Foo( f )
 148 --      infix 9 f       -- The 'f' here does not need to be qualified
 149 --      f x = x         -- Nor here, of course
 150 -- So we have to filter out the non-local ones.
 151 --
 152 -- A separate function (importsFromLocalDecls) reports duplicate top level
 153 -- decls, so here it's safe just to choose an arbitrary one.
 154 --
 155 -- There should never be a qualified name in a binding position in Haskell,
 156 -- but there can be if we have read in an external-Core file.
 157 -- The Haskell parser checks for the illegal qualified name in Haskell
 158 -- source files, so we don't need to do so here.
 159
 160 lookupTopBndrRn rdr_name
 161   | Just name <- isExact_maybe rdr_name
 162   = returnM name
 163
 164   | isOrig rdr_name
 165         -- This deals with the case of derived bindings, where
 166         -- we don't bother to call newTopSrcBinder first
 167         -- We assume there is no "parent" name
 168   = do  { loc <- getSrcSpanM
 169         ; newGlobalBinder (rdrNameModule rdr_name)
 170                           (rdrNameOcc rdr_name) Nothing (srcSpanStart loc) }
 171
 172   | otherwise
 173   = do  { mb_gre <- lookupGreLocalRn rdr_name
 174         ; case mb_gre of
 175                 Nothing  -> unboundName rdr_name
 176                 Just gre -> returnM (gre_name gre) }
 177
 178 -- lookupLocatedSigOccRn is used for type signatures and pragmas
 179 -- Is this valid?
 180 --   module A
 181 --      import M( f )
 182 --      f :: Int -> Int
 183 --      f x = x
 184 -- It's clear that the 'f' in the signature must refer to A.f
 185 -- The Haskell98 report does not stipulate this, but it will!
 186 -- So we must treat the 'f' in the signature in the same way
 187 -- as the binding occurrence of 'f', using lookupBndrRn
 188 lookupLocatedSigOccRn :: Located RdrName -> RnM (Located Name)
 189 lookupLocatedSigOccRn = lookupLocatedBndrRn
 190
 191 -- lookupInstDeclBndr is used for the binders in an
 192 -- instance declaration.   Here we use the class name to
 193 -- disambiguate.
 194
 195 lookupLocatedInstDeclBndr :: Name -> Located RdrName -> RnM (Located Name)
 196 lookupLocatedInstDeclBndr cls = wrapLocM (lookupInstDeclBndr cls)
 197
 198 lookupInstDeclBndr :: Name -> RdrName -> RnM Name
 199 lookupInstDeclBndr cls_name rdr_name
 200   | isUnqual rdr_name   -- Find all the things the rdr-name maps to
 201   = do  {               -- and pick the one with the right parent name
 202           let { is_op gre     = cls_name == nameParent (gre_name gre)
 203               ; occ           = rdrNameOcc rdr_name
 204               ; lookup_fn env = filter is_op (lookupGlobalRdrEnv env occ) }
 205         ; mb_gre <- lookupGreRn_help rdr_name lookup_fn
 206         ; case mb_gre of
 207             Just gre -> return (gre_name gre)
 208             Nothing  -> do { addErr (unknownInstBndrErr cls_name rdr_name)
 209                            ; return (mkUnboundName rdr_name) } }
 210
 211   | otherwise   -- Occurs in derived instances, where we just
 212                 -- refer directly to the right method
 213   = ASSERT2( not (isQual rdr_name), ppr rdr_name )
 214           -- NB: qualified names are rejected by the parser
 215     lookupImportedName rdr_name
 216
 217 newIPNameRn :: IPName RdrName -> TcRnIf m n (IPName Name)
 218 newIPNameRn ip_rdr = newIPName (mapIPName rdrNameOcc ip_rdr)
 219
 220 --------------------------------------------------
 221 --              Occurrences
 222 --------------------------------------------------
 223
 224 lookupLocatedOccRn :: Located RdrName -> RnM (Located Name)
 225 lookupLocatedOccRn = wrapLocM lookupOccRn
 226
 227 -- lookupOccRn looks up an occurrence of a RdrName
 228 lookupOccRn :: RdrName -> RnM Name
 229 lookupOccRn rdr_name
 230   = getLocalRdrEnv                      `thenM` \ local_env ->
 231     case lookupLocalRdrEnv local_env rdr_name of
 232           Just name -> returnM name
 233           Nothing   -> lookupGlobalOccRn rdr_name
 234
 235 lookupLocatedGlobalOccRn :: Located RdrName -> RnM (Located Name)
 236 lookupLocatedGlobalOccRn = wrapLocM lookupGlobalOccRn
 237
 238 lookupGlobalOccRn :: RdrName -> RnM Name
 239 -- lookupGlobalOccRn is like lookupOccRn, except that it looks in the global
 240 -- environment.  It's used only for
 241 --      record field names
 242 --      class op names in class and instance decls
 243
 244 lookupGlobalOccRn rdr_name
 245   | not (isSrcRdrName rdr_name)
 246   = lookupImportedName rdr_name
 247
 248   | otherwise
 249   =     -- First look up the name in the normal environment.
 250    lookupGreRn rdr_name                 `thenM` \ mb_gre ->
 251    case mb_gre of {
 252         Just gre -> returnM (gre_name gre) ;
 253         Nothing   ->
 254
 255         -- We allow qualified names on the command line to refer to
 256         -- *any* name exported by any module in scope, just as if
 257         -- there was an "import qualified M" declaration for every
 258         -- module.
 259    getModule            `thenM` \ mod ->
 260    if isQual rdr_name && mod == iNTERACTIVE then
 261                                         -- This test is not expensive,
 262         lookupQualifiedName rdr_name    -- and only happens for failed lookups
 263    else
 264         unboundName rdr_name }
 265
 266 lookupImportedName :: RdrName -> TcRnIf m n Name
 267 -- Lookup the occurrence of an imported name
 268 -- The RdrName is *always* qualified or Exact
 269 -- Treat it as an original name, and conjure up the Name
 270 -- Usually it's Exact or Orig, but it can be Qual if it
 271 --      comes from an hi-boot file.  (This minor infelicity is
 272 --      just to reduce duplication in the parser.)
 273 lookupImportedName rdr_name
 274   | Just n <- isExact_maybe rdr_name
 275         -- This happens in derived code
 276   = returnM n
 277
 278   | otherwise   -- Always Orig, even when reading a .hi-boot file
 279   = ASSERT( not (isUnqual rdr_name) )
 280     lookupOrig (rdrNameModule rdr_name) (rdrNameOcc rdr_name)
 281
 282 unboundName :: RdrName -> RnM Name
 283 unboundName rdr_name
 284   = do  { addErr (unknownNameErr rdr_name)
 285         ; env <- getGlobalRdrEnv;
 286         ; traceRn (vcat [unknownNameErr rdr_name,
 287                          ptext SLIT("Global envt is:"),
 288                          nest 3 (pprGlobalRdrEnv env)])
 289         ; returnM (mkUnboundName rdr_name) }
 290
 291 --------------------------------------------------
 292 --      Lookup in the Global RdrEnv of the module
 293 --------------------------------------------------
 294
 295 lookupSrcOcc_maybe :: RdrName -> RnM (Maybe Name)
 296 -- No filter function; does not report an error on failure
 297 lookupSrcOcc_maybe rdr_name
 298   = do  { mb_gre <- lookupGreRn rdr_name
 299         ; case mb_gre of
 300                 Nothing  -> returnM Nothing
 301                 Just gre -> returnM (Just (gre_name gre)) }
 302
 303 -------------------------
 304 lookupGreRn :: RdrName -> RnM (Maybe GlobalRdrElt)
 305 -- Just look up the RdrName in the GlobalRdrEnv
 306 lookupGreRn rdr_name
 307   = lookupGreRn_help rdr_name (lookupGRE_RdrName rdr_name)
 308
 309 lookupGreLocalRn :: RdrName -> RnM (Maybe GlobalRdrElt)
 310 -- Similar, but restricted to locally-defined things
 311 lookupGreLocalRn rdr_name
 312   = lookupGreRn_help rdr_name lookup_fn
 313   where
 314     lookup_fn env = filter isLocalGRE (lookupGRE_RdrName rdr_name env)
 315
 316 lookupGreRn_help :: RdrName                     -- Only used in error message
 317                  -> (GlobalRdrEnv -> [GlobalRdrElt])    -- Lookup function
 318                  -> RnM (Maybe GlobalRdrElt)
 319 -- Checks for exactly one match; reports deprecations
 320 -- Returns Nothing, without error, if too few
 321 lookupGreRn_help rdr_name lookup
 322   = do  { env <- getGlobalRdrEnv
 323         ; case lookup env of
 324             []    -> returnM Nothing
 325             [gre] -> returnM (Just gre)
 326             gres  -> do { addNameClashErrRn rdr_name gres
 327                         ; returnM (Just (head gres)) } }
 328
 329 ------------------------------
 330 --      GHCi support
 331 ------------------------------
 332
 333 -- A qualified name on the command line can refer to any module at all: we
 334 -- try to load the interface if we don't already have it.
 335 lookupQualifiedName :: RdrName -> RnM Name
 336 lookupQualifiedName rdr_name
 337  = let
 338        mod = rdrNameModule rdr_name
 339        occ = rdrNameOcc rdr_name
 340    in
 341    loadSrcInterface doc mod False       `thenM` \ iface ->
 342
 343    case  [ (mod,occ) |
 344            (mod,avails) <- mi_exports iface,
 345            avail        <- avails,
 346            name         <- availNames avail,
 347            name == occ ] of
 348       ((mod,occ):ns) -> ASSERT (null ns)
 349                         lookupOrig mod occ
 350       _ -> unboundName rdr_name
 351   where
 352     doc = ptext SLIT("Need to find") <+> ppr rdr_name
 353 \end{code}
 354
 355 %*********************************************************
 356 %*                                                      *
 357                 Fixities
 358 %*                                                      *
 359 %*********************************************************
 360
 361 \begin{code}
 362 lookupTopFixSigNames :: RdrName -> RnM [Name]
 363 -- GHC extension: look up both the tycon and data con
 364 -- for con-like things
 365 lookupTopFixSigNames rdr_name
 366   | Just n <- isExact_maybe rdr_name
 367         -- Special case for (:), which doesn't get into the GlobalRdrEnv
 368   = return [n]  -- For this we don't need to try the tycon too
 369   | otherwise
 370   = do  { mb_gres <- mapM lookupGreLocalRn (dataTcOccs rdr_name)
 371         ; return [gre_name gre | Just gre <- mb_gres] }
 372
 373 --------------------------------
 374 bindLocalFixities :: [FixitySig RdrName] -> RnM a -> RnM a
 375 -- Used for nested fixity decls
 376 -- No need to worry about type constructors here,
 377 -- Should check for duplicates but we don't
 378 bindLocalFixities fixes thing_inside
 379   | null fixes = thing_inside
 380   | otherwise  = mappM rn_sig fixes     `thenM` \ new_bit ->
 381                  extendFixityEnv new_bit thing_inside
 382   where
 383     rn_sig (FixitySig lv@(L loc v) fix)
 384         = addLocM lookupBndrRn lv       `thenM` \ new_v ->
 385           returnM (new_v, (FixItem (rdrNameOcc v) fix loc))
 386 \end{code}
 387
 388 --------------------------------
 389 lookupFixity is a bit strange.
 390
 391 * Nested local fixity decls are put in the local fixity env, which we
 392   find with getFixtyEnv
 393
 394 * Imported fixities are found in the HIT or PIT
 395
 396 * Top-level fixity decls in this module may be for Names that are
 397     either  Global         (constructors, class operations)
 398     or      Local/Exported (everything else)
 399   (See notes with RnNames.getLocalDeclBinders for why we have this split.)
 400   We put them all in the local fixity environment
 401
 402 \begin{code}
 403 lookupFixityRn :: Name -> RnM Fixity
 404 lookupFixityRn name
 405   = getModule                           `thenM` \ this_mod ->
 406     if nameIsLocalOrFrom this_mod name
 407     then        -- It's defined in this module
 408         getFixityEnv            `thenM` \ local_fix_env ->
 409         traceRn (text "lookupFixityRn" <+> (ppr name $$ ppr local_fix_env)) `thenM_`
 410         returnM (lookupFixity local_fix_env name)
 411
 412     else        -- It's imported
 413       -- For imported names, we have to get their fixities by doing a
 414       -- loadHomeInterface, and consulting the Ifaces that comes back
 415       -- from that, because the interface file for the Name might not
 416       -- have been loaded yet.  Why not?  Suppose you import module A,
 417       -- which exports a function 'f', thus;
 418       --        module CurrentModule where
 419       --          import A( f )
 420       --        module A( f ) where
 421       --          import B( f )
 422       -- Then B isn't loaded right away (after all, it's possible that
 423       -- nothing from B will be used).  When we come across a use of
 424       -- 'f', we need to know its fixity, and it's then, and only
 425       -- then, that we load B.hi.  That is what's happening here.
 426         loadSrcInterface doc name_mod False     `thenM` \ iface ->
 427         returnM (mi_fix_fn iface (nameOccName name))
 428   where
 429     doc      = ptext SLIT("Checking fixity for") <+> ppr name
 430     name_mod = nameModule name
 431
 432 dataTcOccs :: RdrName -> [RdrName]
 433 -- If the input is a data constructor, return both it and a type
 434 -- constructor.  This is useful when we aren't sure which we are
 435 -- looking at.
 436 dataTcOccs rdr_name
 437   | Just n <- isExact_maybe rdr_name            -- Ghastly special case
 438   , n `hasKey` consDataConKey = [rdr_name]      -- see note below
 439   | isDataOcc occ             = [rdr_name_tc, rdr_name]
 440   | otherwise                 = [rdr_name]
 441   where
 442     occ         = rdrNameOcc rdr_name
 443     rdr_name_tc = setRdrNameSpace rdr_name tcName
 444
 445 -- If the user typed "[]" or "(,,)", we'll generate an Exact RdrName,
 446 -- and setRdrNameSpace generates an Orig, which is fine
 447 -- But it's not fine for (:), because there *is* no corresponding type
 448 -- constructor.  If we generate an Orig tycon for GHC.Base.(:), it'll
 449 -- appear to be in scope (because Orig's simply allocate a new name-cache
 450 -- entry) and then we get an error when we use dataTcOccs in
 451 -- TcRnDriver.tcRnGetInfo.  Large sigh.
 452 \end{code}
 453
 454 %************************************************************************
 455 %*                                                                      *
 456                         Rebindable names
 457         Dealing with rebindable syntax is driven by the
 458         Opt_NoImplicitPrelude dynamic flag.
 459
 460         In "deriving" code we don't want to use rebindable syntax
 461         so we switch off the flag locally
 462
 463 %*                                                                      *
 464 %************************************************************************
 465
 466 Haskell 98 says that when you say "3" you get the "fromInteger" from the
 467 Standard Prelude, regardless of what is in scope.   However, to experiment
 468 with having a language that is less coupled to the standard prelude, we're
 469 trying a non-standard extension that instead gives you whatever "Prelude.fromInteger"
 470 happens to be in scope.  Then you can
 471         import Prelude ()
 472         import MyPrelude as Prelude
 473 to get the desired effect.
 474
 475 At the moment this just happens for
 476   * fromInteger, fromRational on literals (in expressions and patterns)
 477   * negate (in expressions)
 478   * minus  (arising from n+k patterns)
 479   * "do" notation
 480
 481 We store the relevant Name in the HsSyn tree, in
 482   * HsIntegral/HsFractional
 483   * NegApp
 484   * NPlusKPatIn
 485   * HsDo
 486 respectively.  Initially, we just store the "standard" name (PrelNames.fromIntegralName,
 487 fromRationalName etc), but the renamer changes this to the appropriate user
 488 name if Opt_NoImplicitPrelude is on.  That is what lookupSyntaxName does.
 489
 490 We treat the orignal (standard) names as free-vars too, because the type checker
 491 checks the type of the user thing against the type of the standard thing.
 492
 493 \begin{code}
 494 lookupSyntaxName :: Name                        -- The standard name
 495                  -> RnM (Name, FreeVars)        -- Possibly a non-standard name
 496 lookupSyntaxName std_name
 497   = doptM Opt_ImplicitPrelude           `thenM` \ implicit_prelude ->
 498     if implicit_prelude then normal_case
 499     else
 500         -- Get the similarly named thing from the local environment
 501     lookupOccRn (mkRdrUnqual (nameOccName std_name)) `thenM` \ usr_name ->
 502     returnM (usr_name, unitFV usr_name)
 503   where
 504     normal_case = returnM (std_name, emptyFVs)
 505
 506 lookupSyntaxNames :: [Name]                             -- Standard names
 507                   -> RnM (ReboundNames Name, FreeVars)  -- See comments with HsExpr.ReboundNames
 508 lookupSyntaxNames std_names
 509   = doptM Opt_ImplicitPrelude           `thenM` \ implicit_prelude ->
 510     if implicit_prelude then normal_case
 511     else
 512         -- Get the similarly named thing from the local environment
 513     mappM (lookupOccRn . mkRdrUnqual . nameOccName) std_names   `thenM` \ usr_names ->
 514
 515     returnM (std_names `zip` map HsVar usr_names, mkFVs usr_names)
 516   where
 517     normal_case = returnM (std_names `zip` map HsVar std_names, emptyFVs)
 518 \end{code}
 519
 520
 521 %*********************************************************
 522 %*                                                      *
 523 \subsection{Binding}
 524 %*                                                      *
 525 %*********************************************************
 526
 527 \begin{code}
 528 newLocalsRn :: [Located RdrName] -> RnM [Name]
 529 newLocalsRn rdr_names_w_loc
 530   = newUniqueSupply             `thenM` \ us ->
 531     returnM (zipWith mk rdr_names_w_loc (uniqsFromSupply us))
 532   where
 533     mk (L loc rdr_name) uniq
 534         | Just name <- isExact_maybe rdr_name = name
 535                 -- This happens in code generated by Template Haskell
 536         | otherwise = ASSERT2( isUnqual rdr_name, ppr rdr_name )
 537                         -- We only bind unqualified names here
 538                         -- lookupRdrEnv doesn't even attempt to look up a qualified RdrName
 539                       mkInternalName uniq (rdrNameOcc rdr_name) (srcSpanStart loc)
 540
 541 bindLocatedLocalsRn :: SDoc     -- Documentation string for error message
 542                     -> [Located RdrName]
 543                     -> ([Name] -> RnM a)
 544                     -> RnM a
 545 bindLocatedLocalsRn doc_str rdr_names_w_loc enclosed_scope
 546   =     -- Check for duplicate names
 547     checkDupNames doc_str rdr_names_w_loc       `thenM_`
 548
 549         -- Warn about shadowing, but only in source modules
 550     ifOptM Opt_WarnNameShadowing
 551       (checkShadowing doc_str rdr_names_w_loc)  `thenM_`
 552
 553         -- Make fresh Names and extend the environment
 554     newLocalsRn rdr_names_w_loc         `thenM` \ names ->
 555     getLocalRdrEnv                      `thenM` \ local_env ->
 556     setLocalRdrEnv (extendLocalRdrEnv local_env names)
 557                    (enclosed_scope names)
 558
 559
 560 bindLocalNames :: [Name] -> RnM a -> RnM a
 561 bindLocalNames names enclosed_scope
 562   = getLocalRdrEnv              `thenM` \ name_env ->
 563     setLocalRdrEnv (extendLocalRdrEnv name_env names)
 564                     enclosed_scope
 565
 566 bindLocalNamesFV :: [Name] -> RnM (a, FreeVars) -> RnM (a, FreeVars)
 567 bindLocalNamesFV names enclosed_scope
 568   = do  { (result, fvs) <- bindLocalNames names enclosed_scope
 569         ; returnM (result, delListFromNameSet fvs names) }
 570
 571
 572 -------------------------------------
 573         -- binLocalsFVRn is the same as bindLocalsRn
 574         -- except that it deals with free vars
 575 bindLocatedLocalsFV :: SDoc -> [Located RdrName] -> ([Name] -> RnM (a,FreeVars))
 576   -> RnM (a, FreeVars)
 577 bindLocatedLocalsFV doc rdr_names enclosed_scope
 578   = bindLocatedLocalsRn doc rdr_names   $ \ names ->
 579     enclosed_scope names                `thenM` \ (thing, fvs) ->
 580     returnM (thing, delListFromNameSet fvs names)
 581
 582 -------------------------------------
 583 bindTyVarsRn :: SDoc -> [LHsTyVarBndr RdrName]
 584               -> ([LHsTyVarBndr Name] -> RnM a)
 585               -> RnM a
 586 -- Haskell-98 binding of type variables; e.g. within a data type decl
 587 bindTyVarsRn doc_str tyvar_names enclosed_scope
 588   = let
 589         located_tyvars = hsLTyVarLocNames tyvar_names
 590     in
 591     bindLocatedLocalsRn doc_str located_tyvars  $ \ names ->
 592     enclosed_scope (zipWith replace tyvar_names names)
 593     where
 594         replace (L loc n1) n2 = L loc (replaceTyVarName n1 n2)
 595
 596 bindPatSigTyVars :: [LHsType RdrName] -> ([Name] -> RnM a) -> RnM a
 597   -- Find the type variables in the pattern type
 598   -- signatures that must be brought into scope
 599 bindPatSigTyVars tys thing_inside
 600   = do  { scoped_tyvars <- doptM Opt_ScopedTypeVariables
 601         ; if not scoped_tyvars then
 602                 thing_inside []
 603           else
 604     do  { name_env <- getLocalRdrEnv
 605         ; let locd_tvs  = [ tv | ty <- tys
 606                                , tv <- extractHsTyRdrTyVars ty
 607                                , not (unLoc tv `elemLocalRdrEnv` name_env) ]
 608               nubbed_tvs = nubBy eqLocated locd_tvs
 609                 -- The 'nub' is important.  For example:
 610                 --      f (x :: t) (y :: t) = ....
 611                 -- We don't want to complain about binding t twice!
 612
 613         ; bindLocatedLocalsRn doc_sig nubbed_tvs thing_inside }}
 614   where
 615     doc_sig = text "In a pattern type-signature"
 616
 617 bindPatSigTyVarsFV :: [LHsType RdrName]
 618                    -> RnM (a, FreeVars)
 619                    -> RnM (a, FreeVars)
 620 bindPatSigTyVarsFV tys thing_inside
 621   = bindPatSigTyVars tys        $ \ tvs ->
 622     thing_inside                `thenM` \ (result,fvs) ->
 623     returnM (result, fvs `delListFromNameSet` tvs)
 624
 625 bindSigTyVarsFV :: [LSig Name]
 626                 -> RnM (a, FreeVars)
 627                 -> RnM (a, FreeVars)
 628 -- Bind the top-level forall'd type variables in the sigs.
 629 -- E.g  f :: a -> a
 630 --      f = rhs
 631 --      The 'a' scopes over the rhs
 632 --
 633 -- NB: there'll usually be just one (for a function binding)
 634 --     but if there are many, one may shadow the rest; too bad!
 635 --      e.g  x :: [a] -> [a]
 636 --           y :: [(a,a)] -> a
 637 --           (x,y) = e
 638 --      In e, 'a' will be in scope, and it'll be the one from 'y'!
 639 bindSigTyVarsFV sigs thing_inside
 640   = do  { scoped_tyvars <- doptM Opt_ScopedTypeVariables
 641         ; if not scoped_tyvars then
 642                 thing_inside
 643           else
 644                 bindLocalNamesFV tvs thing_inside }
 645   where
 646     tvs = [ hsLTyVarName ltv
 647           | L _ (Sig _ (L _ (HsForAllTy Explicit ltvs _ _))) <- sigs, ltv <- ltvs ]
 648         -- Note the pattern-match on "Explicit"; we only bind
 649         -- type variables from signatures with an explicit top-level for-all
 650
 651
 652 extendTyVarEnvFVRn :: [Name] -> RnM (a, FreeVars) -> RnM (a, FreeVars)
 653         -- This function is used only in rnSourceDecl on InstDecl
 654 extendTyVarEnvFVRn tyvars thing_inside = bindLocalNamesFV tyvars thing_inside
 655
 656 -------------------------------------
 657 checkDupNames :: SDoc
 658               -> [Located RdrName]
 659               -> RnM ()
 660 checkDupNames doc_str rdr_names_w_loc
 661   =     -- Check for duplicated names in a binding group
 662     mappM_ (dupNamesErr doc_str) dups
 663   where
 664     (_, dups) = removeDups (\n1 n2 -> unLoc n1 `compare` unLoc n2) rdr_names_w_loc
 665
 666 -------------------------------------
 667 checkShadowing doc_str loc_rdr_names
 668   = getLocalRdrEnv              `thenM` \ local_env ->
 669     getGlobalRdrEnv             `thenM` \ global_env ->
 670     let
 671       check_shadow (L loc rdr_name)
 672         |  rdr_name `elemLocalRdrEnv` local_env
 673         || not (null (lookupGRE_RdrName rdr_name global_env ))
 674         = setSrcSpan loc $ addWarn (shadowedNameWarn doc_str rdr_name)
 675         | otherwise = returnM ()
 676     in
 677     mappM_ check_shadow loc_rdr_names
 678 \end{code}
 679
 680
 681 %************************************************************************
 682 %*                                                                      *
 683 \subsection{Free variable manipulation}
 684 %*                                                                      *
 685 %************************************************************************
 686
 687 \begin{code}
 688 -- A useful utility
 689 mapFvRn f xs = mappM f xs       `thenM` \ stuff ->
 690                let
 691                   (ys, fvs_s) = unzip stuff
 692                in
 693                returnM (ys, plusFVs fvs_s)
 694 \end{code}
 695
 696
 697 %************************************************************************
 698 %*                                                                      *
 699 \subsection{Envt utility functions}
 700 %*                                                                      *
 701 %************************************************************************
 702
 703 \begin{code}
 704 warnUnusedModules :: [(Module,SrcSpan)] -> RnM ()
 705 warnUnusedModules mods
 706   = ifOptM Opt_WarnUnusedImports (mappM_ bleat mods)
 707   where
 708     bleat (mod,loc) = setSrcSpan loc $ addWarn (mk_warn mod)
 709     mk_warn m = vcat [ptext SLIT("Module") <+> quotes (ppr m) <+>
 710                          text "is imported, but nothing from it is used",
 711                          parens (ptext SLIT("except perhaps instances visible in") <+>
 712                                    quotes (ppr m))]
 713
 714 warnUnusedImports, warnUnusedTopBinds :: [GlobalRdrElt] -> RnM ()
 715 warnUnusedImports gres  = ifOptM Opt_WarnUnusedImports (warnUnusedGREs gres)
 716 warnUnusedTopBinds gres = ifOptM Opt_WarnUnusedBinds   (warnUnusedGREs gres)
 717
 718 warnUnusedLocalBinds, warnUnusedMatches :: [Name] -> RnM ()
 719 warnUnusedLocalBinds names = ifOptM Opt_WarnUnusedBinds   (warnUnusedLocals names)
 720 warnUnusedMatches    names = ifOptM Opt_WarnUnusedMatches (warnUnusedLocals names)
 721
 722 -------------------------
 723 --      Helpers
 724 warnUnusedGREs gres
 725  = warnUnusedBinds [(n,Just p) | GRE {gre_name = n, gre_prov = p} <- gres]
 726
 727 warnUnusedLocals names
 728  = warnUnusedBinds [(n,Nothing) | n<-names]
 729
 730 warnUnusedBinds :: [(Name,Maybe Provenance)] -> RnM ()
 731 warnUnusedBinds names  = mappM_ warnUnusedName (filter reportable names)
 732  where reportable (name,_) = reportIfUnused (nameOccName name)
 733
 734 -------------------------
 735
 736 warnUnusedName :: (Name, Maybe Provenance) -> RnM ()
 737 warnUnusedName (name, prov)
 738   = addWarnAt loc $
 739     sep [msg <> colon,
 740          nest 2 $ occNameFlavour (nameOccName name) <+> quotes (ppr name)]
 741         -- TODO should be a proper span
 742   where
 743     (loc,msg) = case prov of
 744                   Just (Imported is _) ->
 745                      ( is_loc (head is), imp_from (is_mod imp_spec) )
 746                      where
 747                          imp_spec = head is
 748                   other ->
 749                      ( srcLocSpan (nameSrcLoc name), unused_msg )
 750
 751     unused_msg   = text "Defined but not used"
 752     imp_from mod = text "Imported from" <+> quotes (ppr mod) <+> text "but not used"
 753 \end{code}
 754
 755 \begin{code}
 756 addNameClashErrRn rdr_name (np1:nps)
 757   = addErr (vcat [ptext SLIT("Ambiguous occurrence") <+> quotes (ppr rdr_name),
 758                   ptext SLIT("It could refer to") <+> vcat (msg1 : msgs)])
 759   where
 760     msg1 = ptext  SLIT("either") <+> mk_ref np1
 761     msgs = [ptext SLIT("    or") <+> mk_ref np | np <- nps]
 762     mk_ref gre = quotes (ppr (gre_name gre)) <> comma <+> pprNameProvenance gre
 763
 764 shadowedNameWarn doc shadow
 765   = hsep [ptext SLIT("This binding for"),
 766                quotes (ppr shadow),
 767                ptext SLIT("shadows an existing binding")]
 768     $$ doc
 769
 770 unknownNameErr rdr_name
 771   = sep [ptext SLIT("Not in scope:"),
 772          nest 2 $ occNameFlavour (rdrNameOcc rdr_name) <+> quotes (ppr rdr_name)]
 773
 774 unknownInstBndrErr cls op
 775   = quotes (ppr op) <+> ptext SLIT("is not a (visible) method of class") <+> quotes (ppr cls)
 776
 777 badOrigBinding name
 778   = ptext SLIT("Illegal binding of built-in syntax:") <+> ppr (rdrNameOcc name)
 779         -- The rdrNameOcc is because we don't want to print Prelude.(,)
 780
 781 dupNamesErr :: SDoc -> [Located RdrName] -> RnM ()
 782 dupNamesErr descriptor located_names
 783   = setSrcSpan big_loc $
 784     addErr (vcat [ptext SLIT("Conflicting definitions for") <+> quotes (ppr name1),
 785                   locations,
 786                   descriptor])
 787   where
 788     L _ name1 = head located_names
 789     locs      = map getLoc located_names
 790     big_loc   = foldr1 combineSrcSpans locs
 791     one_line  = srcSpanStartLine big_loc == srcSpanEndLine big_loc
 792     locations | one_line  = empty
 793               | otherwise = ptext SLIT("Bound at:") <+>
 794                             vcat (map ppr (sortLe (<=) locs))
 795 \end{code}