RnEnv.hs 79.4 KB
Newer Older
Austin Seipp's avatar
Austin Seipp committed
1 2 3
{-
(c) The GRASP/AQUA Project, Glasgow University, 1992-2006

4
\section[RnEnv]{Environment manipulation for the renamer monad}
Austin Seipp's avatar
Austin Seipp committed
5
-}
6

7 8
{-# LANGUAGE CPP #-}

Ian Lynagh's avatar
Ian Lynagh committed
9 10 11
module RnEnv (
        newTopSrcBinder,
        lookupLocatedTopBndrRn, lookupTopBndrRn,
12
        lookupLocatedOccRn, lookupOccRn, lookupOccRn_maybe,
13
        lookupLocalOccRn_maybe, lookupInfoOccRn,
gmainland's avatar
gmainland committed
14
        lookupLocalOccThLvl_maybe,
Ian Lynagh's avatar
Ian Lynagh committed
15
        lookupTypeOccRn, lookupKindOccRn,
16
        lookupGlobalOccRn, lookupGlobalOccRn_maybe,
17
        reportUnboundName, unknownNameSuggestions,
18

Ian Lynagh's avatar
Ian Lynagh committed
19
        HsSigCtxt(..), lookupLocalTcNames, lookupSigOccRn,
20
        lookupSigCtxtOccRn,
21

Ian Lynagh's avatar
Ian Lynagh committed
22 23
        lookupFixityRn, lookupTyFixityRn,
        lookupInstDeclBndr, lookupSubBndrOcc, lookupFamInstName,
24
        lookupSubBndrGREs, lookupConstructorFields,
25
        lookupSyntaxName, lookupSyntaxNames, lookupIfThenElse,
26
        lookupGreAvailRn,
Ian Lynagh's avatar
Ian Lynagh committed
27 28 29
        getLookupOccRn, addUsedRdrNames,

        newLocalBndrRn, newLocalBndrsRn,
30
        bindLocalNames, bindLocalNamesFV,
Austin Seipp's avatar
Austin Seipp committed
31
        MiniFixityEnv,
Ian Lynagh's avatar
Ian Lynagh committed
32 33 34 35 36
        addLocalFixities,
        bindLocatedLocalsFV, bindLocatedLocalsRn,
        extendTyVarEnvFVRn,

        checkDupRdrNames, checkShadowedRdrNames,
37
        checkDupNames, checkDupAndShadowedNames, checkTupSize,
Ian Lynagh's avatar
Ian Lynagh committed
38 39 40
        addFvRn, mapFvRn, mapMaybeFvRn, mapFvRnCPS,
        warnUnusedMatches,
        warnUnusedTopBinds, warnUnusedLocalBinds,
41
        dataTcOccs, kindSigErr, perhapsForallMsg,
42
        HsDocContext(..), docOfHsDocContext
43
    ) where
44

45
#include "HsVersions.h"
46

47
import LoadIface        ( loadInterfaceForName, loadSrcInterface_maybe )
48
import IfaceEnv
Ian Lynagh's avatar
Ian Lynagh committed
49
import HsSyn
50
import RdrName
51
import HscTypes
Ian Lynagh's avatar
Ian Lynagh committed
52
import TcEnv            ( tcLookupDataCon, tcLookupField, isBrackStage )
53
import TcRnMonad
54
import RdrHsSyn         ( setRdrNameSpace )
Ian Lynagh's avatar
Ian Lynagh committed
55
import Id               ( isRecordSelector )
56
import Name
57
import NameSet
58
import NameEnv
59
import Avail
60
import Module
cactus's avatar
cactus committed
61
import ConLike
Ian Lynagh's avatar
Ian Lynagh committed
62 63
import DataCon          ( dataConFieldLabels, dataConTyCon )
import TyCon            ( isTupleTyCon, tyConArity )
64
import PrelNames        ( mkUnboundName, isUnboundName, rOOT_MAIN, forall_tv_RDR )
Ian Lynagh's avatar
Ian Lynagh committed
65
import ErrUtils         ( MsgDoc )
66
import BasicTypes       ( Fixity(..), FixityDirection(..), minPrecedence, defaultFixity )
Ian Lynagh's avatar
Ian Lynagh committed
67
import SrcLoc
68
import Outputable
69
import Util
70
import Maybes
71
import BasicTypes       ( TopLevelFlag(..) )
Ian Lynagh's avatar
Ian Lynagh committed
72
import ListSetOps       ( removeDups )
73
import DynFlags
74
import FastString
Ian Lynagh's avatar
Ian Lynagh committed
75
import Control.Monad
76
import Data.List
77
import qualified Data.Set as Set
78
import ListSetOps       ( minusList )
Ian Lynagh's avatar
Ian Lynagh committed
79
import Constants        ( mAX_TUPLE_SIZE )
Ian Lynagh's avatar
Ian Lynagh committed
80

Austin Seipp's avatar
Austin Seipp committed
81 82 83
{-
*********************************************************
*                                                      *
Ian Lynagh's avatar
Ian Lynagh committed
84
                Source-code binders
Austin Seipp's avatar
Austin Seipp committed
85 86
*                                                      *
*********************************************************
87

88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144
Note [Signature lazy interface loading]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

GHC's lazy interface loading can be a bit confusing, so this Note is an
empirical description of what happens in one interesting case. When
compiling a signature module against an its implementation, we do NOT
load interface files associated with its names until after the type
checking phase.  For example:

    module ASig where
        data T
        f :: T -> T

Suppose we compile this with -sig-of "A is ASig":

    module B where
        data T = T
        f T = T

    module A(module B) where
        import B

During type checking, we'll load A.hi because we need to know what the
RdrEnv for the module is, but we DO NOT load the interface for B.hi!
It's wholly unnecessary: our local definition 'data T' in ASig is all
the information we need to finish type checking.  This is contrast to
type checking of ordinary Haskell files, in which we would not have the
local definition "data T" and would need to consult B.hi immediately.
(Also, this situation never occurs for hs-boot files, since you're not
allowed to reexport from another module.)

After type checking, we then check that the types we provided are
consistent with the backing implementation (in checkHiBootOrHsigIface).
At this point, B.hi is loaded, because we need something to compare
against.

I discovered this behavior when trying to figure out why type class
instances for Data.Map weren't in the EPS when I was type checking a
test very much like ASig (sigof02dm): the associated interface hadn't
been loaded yet!  (The larger issue is a moot point, since an instance
declared in a signature can never be a duplicate.)

This behavior might change in the future.  Consider this
alternate module B:

    module B where
        {-# DEPRECATED T, f "Don't use" #-}
        data T = T
        f T = T

One might conceivably want to report deprecation warnings when compiling
ASig with -sig-of B, in which case we need to look at B.hi to find the
deprecation warnings during renaming.  At the moment, you don't get any
warning until you use the identifier further downstream.  This would
require adjusting addUsedRdrName so that during signature compilation,
we do not report deprecation warnings for LocalDef.  See also
Note [Handling of deprecations]
Austin Seipp's avatar
Austin Seipp committed
145
-}
146

147 148
newTopSrcBinder :: Located RdrName -> RnM Name
newTopSrcBinder (L loc rdr_name)
149
  | Just name <- isExact_maybe rdr_name
Ian Lynagh's avatar
Ian Lynagh committed
150 151 152 153 154 155 156 157 158
  =     -- This is here to catch
        --   (a) Exact-name binders created by Template Haskell
        --   (b) The PrelBase defn of (say) [] and similar, for which
        --       the parser reads the special syntax and returns an Exact RdrName
        -- We are at a binding site for the name, so check first that it
        -- the current module is the correct one; otherwise GHC can get
        -- very confused indeed. This test rejects code like
        --      data T = (,) Int Int
        -- unless we are in GHC.Tup
159 160 161
    if isExternalName name then
      do { this_mod <- getModule
         ; unless (this_mod == nameModule name)
Ian Lynagh's avatar
Ian Lynagh committed
162
                  (addErrAt loc (badOrigBinding rdr_name))
163 164
         ; return name }
    else   -- See Note [Binders in Template Haskell] in Convert.hs
165 166
      do { this_mod <- getModule
         ; externaliseName this_mod name }
167

Simon Marlow's avatar
Simon Marlow committed
168
  | Just (rdr_mod, rdr_occ) <- isOrig_maybe rdr_name
Ian Lynagh's avatar
Ian Lynagh committed
169
  = do  { this_mod <- getModule
170
        ; unless (rdr_mod == this_mod || rdr_mod == rOOT_MAIN)
Ian Lynagh's avatar
Ian Lynagh committed
171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189
                 (addErrAt loc (badOrigBinding rdr_name))
        -- When reading External Core we get Orig names as binders,
        -- but they should agree with the module gotten from the monad
        --
        -- We can get built-in syntax showing up here too, sadly.  If you type
        --      data T = (,,,)
        -- the constructor is parsed as a type, and then RdrHsSyn.tyConToDataCon
        -- uses setRdrNameSpace to make it into a data constructors.  At that point
        -- the nice Exact name for the TyCon gets swizzled to an Orig name.
        -- Hence the badOrigBinding error message.
        --
        -- Except for the ":Main.main = ..." definition inserted into
        -- the Main module; ugh!

        -- Because of this latter case, we call newGlobalBinder with a module from
        -- the RdrName, not from the environment.  In principle, it'd be fine to
        -- have an arbitrary mixture of external core definitions in a single module,
        -- (apart from module-initialisation issues, perhaps).
        ; newGlobalBinder rdr_mod rdr_occ loc }
190 191

  | otherwise
Ian Lynagh's avatar
Ian Lynagh committed
192 193 194 195 196 197
  = do  { unless (not (isQual rdr_name))
                 (addErrAt loc (badQualBndrErr rdr_name))
                -- Binders should not be qualified; if they are, and with a different
                -- module name, we we get a confusing "M.T is not in scope" error later

        ; stage <- getStage
198
        ; env <- getGblEnv
Ian Lynagh's avatar
Ian Lynagh committed
199 200 201 202 203
        ; if isBrackStage stage then
                -- We are inside a TH bracket, so make an *Internal* name
                -- See Note [Top-level Names in Template Haskell decl quotes] in RnNames
             do { uniq <- newUnique
                ; return (mkInternalName uniq (rdrNameOcc rdr_name) loc) }
204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227
          else case tcg_impl_rdr_env env of
            Just gr ->
                -- We're compiling --sig-of, so resolve with respect to this
                -- module.
                -- See Note [Signature parameters in TcGblEnv and DynFlags]
             do { case lookupGlobalRdrEnv gr (rdrNameOcc rdr_name) of
                    -- Be sure to override the loc so that we get accurate
                    -- information later
                    [GRE{ gre_name = n }] -> do
                      -- NB: Just adding this line will not work:
                      --    addUsedRdrName True gre rdr_name
                      -- see Note [Signature lazy interface loading] for
                      -- more details.
                      return (setNameLoc n loc)
                    _ -> do
                      { -- NB: cannot use reportUnboundName rdr_name
                        -- because it looks up in the wrong RdrEnv
                        -- ToDo: more helpful error messages
                      ; addErr (unknownNameErr (pprNonVarNameSpace
                            (occNameSpace (rdrNameOcc rdr_name))) rdr_name)
                      ; return (mkUnboundName rdr_name)
                      }
                }
            Nothing ->
Ian Lynagh's avatar
Ian Lynagh committed
228
                -- Normal case
229
             do { this_mod <- getModule
230
                ; traceRn (text "newTopSrcBinder" <+> (ppr this_mod $$ ppr rdr_name $$ ppr loc))
231
                ; newGlobalBinder this_mod (rdrNameOcc rdr_name) loc } }
232

Austin Seipp's avatar
Austin Seipp committed
233 234 235
{-
*********************************************************
*                                                      *
Ian Lynagh's avatar
Ian Lynagh committed
236
        Source code occurrences
Austin Seipp's avatar
Austin Seipp committed
237 238
*                                                      *
*********************************************************
239 240 241

Looking up a name in the RnEnv.

242 243 244 245 246 247 248 249 250 251 252
Note [Type and class operator definitions]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
We want to reject all of these unless we have -XTypeOperators (Trac #3265)
   data a :*: b  = ...
   class a :*: b where ...
   data (:*:) a b  = ....
   class (:*:) a b where ...
The latter two mean that we are not just looking for a
*syntactically-infix* declaration, but one that uses an operator
OccName.  We use OccName.isSymOcc to detect that case, which isn't
terribly efficient, but there seems to be no better way.
Austin Seipp's avatar
Austin Seipp committed
253
-}
254

255 256
lookupTopBndrRn :: RdrName -> RnM Name
lookupTopBndrRn n = do nopt <- lookupTopBndrRn_maybe n
Ian Lynagh's avatar
Ian Lynagh committed
257
                       case nopt of
258
                         Just n' -> return n'
259
                         Nothing -> do traceRn $ (text "lookupTopBndrRn fail" <+> ppr n)
260
                                       unboundName WL_LocalTop n
261

262 263 264
lookupLocatedTopBndrRn :: Located RdrName -> RnM (Located Name)
lookupLocatedTopBndrRn = wrapLocM lookupTopBndrRn

265
lookupTopBndrRn_maybe :: RdrName -> RnM (Maybe Name)
266
-- Look up a top-level source-code binder.   We may be looking up an unqualified 'f',
267
-- and there may be several imported 'f's too, which must not confuse us.
268
-- For example, this is OK:
Ian Lynagh's avatar
Ian Lynagh committed
269 270 271
--      import Foo( f )
--      infix 9 f       -- The 'f' here does not need to be qualified
--      f x = x         -- Nor here, of course
272
-- So we have to filter out the non-local ones.
273
--
274 275
-- A separate function (importsFromLocalDecls) reports duplicate top level
-- decls, so here it's safe just to choose an arbitrary one.
276
--
277 278
-- There should never be a qualified name in a binding position in Haskell,
-- but there can be if we have read in an external-Core file.
Ian Lynagh's avatar
Ian Lynagh committed
279
-- The Haskell parser checks for the illegal qualified name in Haskell
280
-- source files, so we don't need to do so here.
281

282
lookupTopBndrRn_maybe rdr_name
283
  | Just name <- isExact_maybe rdr_name
284
  = do { name' <- lookupExactOcc name; return (Just name') }
285

Ian Lynagh's avatar
Ian Lynagh committed
286 287 288 289 290 291
  | Just (rdr_mod, rdr_occ) <- isOrig_maybe rdr_name
        -- This deals with the case of derived bindings, where
        -- we don't bother to call newTopSrcBinder first
        -- We assume there is no "parent" name
  = do  { loc <- getSrcSpanM
        ; n <- newGlobalBinder rdr_mod rdr_occ loc
292
        ; return (Just n)}
293 294

  | otherwise
Ian Lynagh's avatar
Ian Lynagh committed
295
  = do  {  -- Check for operators in type or class declarations
296 297 298
           -- See Note [Type and class operator definitions]
          let occ = rdrNameOcc rdr_name
        ; when (isTcOcc occ && isSymOcc occ)
299
               (do { op_ok <- xoptM Opt_TypeOperators
Ian Lynagh's avatar
Ian Lynagh committed
300 301
                   ; unless op_ok (addErr (opDeclErr rdr_name)) })

302 303 304 305 306
        ; env <- getGlobalRdrEnv
        ; case filter isLocalGRE (lookupGRE_RdrName rdr_name env) of
            [gre] -> return (Just (gre_name gre))
            _     -> return Nothing  -- Ambiguous (can't happen) or unbound
    }
307

308
-----------------------------------------------
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
309 310
-- | Lookup an @Exact@ @RdrName@. See Note [Looking up Exact RdrNames].
-- This adds an error if the name cannot be found.
311 312
lookupExactOcc :: Name -> RnM Name
lookupExactOcc name
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
313 314 315 316 317 318 319 320 321 322 323
  = do { result <- lookupExactOcc_either name
       ; case result of
           Left err -> do { addErr err
                          ; return name }
           Right name' -> return name' }

-- | Lookup an @Exact@ @RdrName@. See Note [Looking up Exact RdrNames].
-- This never adds an error, but it may return one.
lookupExactOcc_either :: Name -> RnM (Either MsgDoc Name)
-- See Note [Looking up Exact RdrNames]
lookupExactOcc_either name
324 325
  | Just thing <- wiredInNameTyThing_maybe name
  , Just tycon <- case thing of
cactus's avatar
cactus committed
326 327 328
                    ATyCon tc                 -> Just tc
                    AConLike (RealDataCon dc) -> Just (dataConTyCon dc)
                    _                         -> Nothing
329 330
  , isTupleTyCon tycon
  = do { checkTupSize (tyConArity tycon)
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
331
       ; return (Right name) }
332

Ian Lynagh's avatar
Ian Lynagh committed
333
  | isExternalName name
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
334
  = return (Right name)
335

Ian Lynagh's avatar
Ian Lynagh committed
336
  | otherwise
337
  = do { env <- getGlobalRdrEnv
Ian Lynagh's avatar
Ian Lynagh committed
338
       ; let -- See Note [Splicing Exact names]
339 340 341 342 343 344
             main_occ =  nameOccName name
             demoted_occs = case demoteOccName main_occ of
                              Just occ -> [occ]
                              Nothing  -> []
             gres = [ gre | occ <- main_occ : demoted_occs
                          , gre <- lookupGlobalRdrEnv env occ
Ian Lynagh's avatar
Ian Lynagh committed
345
                          , gre_name gre == name ]
346
       ; case gres of
347 348
           [gre] -> return (Right (gre_name gre))

349 350
           []    -> -- See Note [Splicing Exact names]
                    do { lcl_env <- getLocalRdrEnv
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
351 352 353
                       ; if name `inLocalRdrEnvScope` lcl_env
                         then return (Right name)
                         else
354 355 356
#ifdef GHCI
                         do { th_topnames_var <- fmap tcg_th_topnames getGblEnv
                            ; th_topnames <- readTcRef th_topnames_var
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
357 358 359
                            ; if name `elemNameSet` th_topnames
                              then return (Right name)
                              else return (Left exact_nm_err)
360 361
                            }
#else /* !GHCI */
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
362
                         return (Left exact_nm_err)
363 364
#endif /* !GHCI */
                       }
365
           gres -> return (Left (sameNameErr gres))   -- Ugh!  See Note [Template Haskell ambiguity]
366
       }
367 368
  where
    exact_nm_err = hang (ptext (sLit "The exact Name") <+> quotes (ppr name) <+> ptext (sLit "is not in scope"))
369 370
                      2 (vcat [ ptext (sLit "Probable cause: you used a unique Template Haskell name (NameU), ")
                              , ptext (sLit "perhaps via newName, but did not bind it")
371
                              , ptext (sLit "If that's it, then -ddump-splices might be useful") ])
372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388

sameNameErr :: [GlobalRdrElt] -> MsgDoc
sameNameErr [] = panic "addSameNameErr: empty list"
sameNameErr gres@(_ : _)
  = hang (ptext (sLit "Same exact name in multiple name-spaces:"))
       2 (vcat (map pp_one sorted_names) $$ th_hint)
  where
    sorted_names = sortWith nameSrcLoc (map gre_name gres)
    pp_one name
      = hang (pprNameSpace (occNameSpace (getOccName name))
              <+> quotes (ppr name) <> comma)
           2 (ptext (sLit "declared at:") <+> ppr (nameSrcLoc name))

    th_hint = vcat [ ptext (sLit "Probable cause: you bound a unique Template Haskell name (NameU),")
                   , ptext (sLit "perhaps via newName, in different name-spaces.")
                   , ptext (sLit "If that's it, then -ddump-splices might be useful") ]

389

390
-----------------------------------------------
391
lookupInstDeclBndr :: Name -> SDoc -> RdrName -> RnM Name
Ian Lynagh's avatar
Ian Lynagh committed
392
-- This is called on the method name on the left-hand side of an
393 394 395 396 397
-- instance declaration binding. eg.  instance Functor T where
--                                       fmap = ...
--                                       ^^^^ called on this
-- Regardless of how many unqualified fmaps are in scope, we want
-- the one that comes from the Functor class.
398
--
Ian Lynagh's avatar
Ian Lynagh committed
399
-- Furthermore, note that we take no account of whether the
400 401 402
-- name is only in scope qualified.  I.e. even if method op is
-- in scope as M.op, we still allow plain 'op' on the LHS of
-- an instance decl
403 404 405 406
--
-- The "what" parameter says "method" or "associated type",
-- depending on what we are looking up
lookupInstDeclBndr cls what rdr
407
  = do { when (isQual rdr)
Ian Lynagh's avatar
Ian Lynagh committed
408 409 410 411
              (addErr (badQualBndrErr rdr))
                -- In an instance decl you aren't allowed
                -- to use a qualified name for the method
                -- (Although it'd make perfect sense.)
412 413 414 415 416
       ; lookupSubBndrOcc False -- False => we don't give deprecated
                                -- warnings when a deprecated class
                                -- method is defined. We only warn
                                -- when it's used
                          (ParentIs cls) doc rdr }
417
  where
418
    doc = what <+> ptext (sLit "of class") <+> quotes (ppr cls)
419

420 421

-----------------------------------------------
422
lookupFamInstName :: Maybe Name -> Located RdrName -> RnM (Located Name)
Ian Lynagh's avatar
Ian Lynagh committed
423
-- Used for TyData and TySynonym family instances only,
424
-- See Note [Family instance binders]
425
lookupFamInstName (Just cls) tc_rdr  -- Associated type; c.f RnBinds.rnMethodBind
426
  = wrapLocM (lookupInstDeclBndr cls (ptext (sLit "associated type"))) tc_rdr
427
lookupFamInstName Nothing tc_rdr     -- Family instance; tc_rdr is an *occurrence*
Ian Lynagh's avatar
Ian Lynagh committed
428
  = lookupLocatedOccRn tc_rdr
429

430 431 432
-----------------------------------------------
lookupConstructorFields :: Name -> RnM [Name]
-- Look up the fields of a given constructor
Ian Lynagh's avatar
Ian Lynagh committed
433 434 435 436 437 438 439
--   *  For constructors from this module, use the record field env,
--      which is itself gathered from the (as yet un-typechecked)
--      data type decls
--
--    * For constructors from imported modules, use the *type* environment
--      since imported modles are already compiled, the info is conveniently
--      right there
440 441

lookupConstructorFields con_name
Ian Lynagh's avatar
Ian Lynagh committed
442 443 444 445 446 447 448
  = do  { this_mod <- getModule
        ; if nameIsLocalOrFrom this_mod con_name then
          do { RecFields field_env _ <- getRecFieldEnv
             ; return (lookupNameEnv field_env con_name `orElse` []) }
          else
          do { con <- tcLookupDataCon con_name
             ; return (dataConFieldLabels con) } }
449 450

-----------------------------------------------
451 452 453 454
-- Used for record construction and pattern matching
-- When the -XDisambiguateRecordFields flag is on, take account of the
-- constructor name to disambiguate which field to use; it's just the
-- same as for instance decls
Ian Lynagh's avatar
Ian Lynagh committed
455
--
456
-- NB: Consider this:
Ian Lynagh's avatar
Ian Lynagh committed
457 458
--      module Foo where { data R = R { fld :: Int } }
--      module Odd where { import Foo; fld x = x { fld = 3 } }
459 460 461 462
-- Arguably this should work, because the reference to 'fld' is
-- unambiguous because there is only one field id 'fld' in scope.
-- But currently it's rejected.

463 464
lookupSubBndrOcc :: Bool
                 -> Parent  -- NoParent   => just look it up as usual
Ian Lynagh's avatar
Ian Lynagh committed
465 466
                            -- ParentIs p => use p to disambiguate
                 -> SDoc -> RdrName
467
                 -> RnM Name
468
lookupSubBndrOcc warnIfDeprec parent doc rdr_name
469
  | Just n <- isExact_maybe rdr_name   -- This happens in derived code
470
  = lookupExactOcc n
471 472 473 474

  | Just (rdr_mod, rdr_occ) <- isOrig_maybe rdr_name
  = lookupOrig rdr_mod rdr_occ

Ian Lynagh's avatar
Ian Lynagh committed
475 476 477 478 479 480 481
  | otherwise   -- Find all the things the rdr-name maps to
  = do  {       -- and pick the one with the right parent namep
          env <- getGlobalRdrEnv
        ; case lookupSubBndrGREs env parent rdr_name of
                -- NB: lookupGlobalRdrEnv, not lookupGRE_RdrName!
                --     The latter does pickGREs, but we want to allow 'x'
                --     even if only 'M.x' is in scope
482
            [gre] -> do { addUsedRdrName warnIfDeprec gre (used_rdr_name gre)
483
                          -- Add a usage; this is an *occurrence* site
484
                        ; return (gre_name gre) }
485 486 487 488 489 490 491
            []    -> do { ns <- lookupQualifiedNameGHCi rdr_name
                        ; case ns of {
                                (n:_) -> return n ;
                                -- Unlikely to be more than one...?
                                [] -> do
                        { addErr (unknownSubordinateErr doc rdr_name)
                        ; return (mkUnboundName rdr_name) } } }
Ian Lynagh's avatar
Ian Lynagh committed
492 493
            gres  -> do { addNameClashErrRn rdr_name gres
                        ; return (gre_name (head gres)) } }
494
  where
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
495
    -- Note [Usage for sub-bndrs]
496 497
    used_rdr_name gre
      | isQual rdr_name = rdr_name
498
      | otherwise       = greUsedRdrName gre
499 500 501 502 503 504 505 506 507 508

lookupSubBndrGREs :: GlobalRdrEnv -> Parent -> RdrName -> [GlobalRdrElt]
-- If Parent = NoParent, just do a normal lookup
-- If Parent = Parent p then find all GREs that
--   (a) have parent p
--   (b) for Unqual, are in scope qualified or unqualified
--       for Qual, are in scope with that qualification
lookupSubBndrGREs env parent rdr_name
  = case parent of
      NoParent   -> pickGREs rdr_name gres
Ian Lynagh's avatar
Ian Lynagh committed
509
      ParentIs p
510 511 512 513 514 515 516 517
        | isUnqual rdr_name -> filter (parent_is p) gres
        | otherwise         -> filter (parent_is p) (pickGREs rdr_name gres)

  where
    gres = lookupGlobalRdrEnv env (rdrNameOcc rdr_name)

    parent_is p (GRE { gre_par = ParentIs p' }) = p == p'
    parent_is _ _                               = False
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
518

Austin Seipp's avatar
Austin Seipp committed
519
{-
520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546
Note [Family instance binders]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Consider
  data family F a
  data instance F T = X1 | X2

The 'data instance' decl has an *occurrence* of F (and T), and *binds*
X1 and X2.  (This is unlike a normal data type declaration which would
bind F too.)  So we want an AvailTC F [X1,X2].

Now consider a similar pair:
  class C a where
    data G a
  instance C S where
    data G S = Y1 | Y2

The 'data G S' *binds* Y1 and Y2, and has an *occurrence* of G.

But there is a small complication: in an instance decl, we don't use
qualified names on the LHS; instead we use the class to disambiguate.
Thus:
  module M where
    import Blib( G )
    class C a where
      data G a
    instance C S where
      data G S = Y1 | Y2
Gabor Greif's avatar
Gabor Greif committed
547
Even though there are two G's in scope (M.G and Blib.G), the occurrence
Gabor Greif's avatar
typos  
Gabor Greif committed
548
of 'G' in the 'instance C S' decl is unambiguous, because C has only
549 550 551 552 553
one associated type called G. This is exactly what happens for methods,
and it is only consistent to do the same thing for types. That's the
role of the function lookupTcdName; the (Maybe Name) give the class of
the encloseing instance decl, if any.

554 555 556 557 558 559 560 561 562 563
Note [Looking up Exact RdrNames]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Exact RdrNames are generated by Template Haskell.  See Note [Binders
in Template Haskell] in Convert.

For data types and classes have Exact system Names in the binding
positions for constructors, TyCons etc.  For example
    [d| data T = MkT Int |]
when we splice in and Convert to HsSyn RdrName, we'll get
    data (Exact (system Name "T")) = (Exact (system Name "MkT")) ...
564
These System names are generated by Convert.thRdrName
565 566 567 568

But, constructors and the like need External Names, not System Names!
So we do the following

569
 * In RnEnv.newTopSrcBinder we spot Exact RdrNames that wrap a
570 571 572 573 574
   non-External Name, and make an External name for it. This is
   the name that goes in the GlobalRdrEnv

 * When looking up an occurrence of an Exact name, done in
   RnEnv.lookupExactOcc, we find the Name with the right unique in the
575
   GlobalRdrEnv, and use the one from the envt -- it will be an
576 577 578 579 580
   External Name in the case of the data type/constructor above.

 * Exact names are also use for purely local binders generated
   by TH, such as    \x_33. x_33
   Both binder and occurrence are Exact RdrNames.  The occurrence
Ian Lynagh's avatar
Ian Lynagh committed
581
   gets looked up in the LocalRdrEnv by RnEnv.lookupOccRn, and
582 583 584 585 586
   misses, because lookupLocalRdrEnv always returns Nothing for
   an Exact Name.  Now we fall through to lookupExactOcc, which
   will find the Name is not in the GlobalRdrEnv, so we just use
   the Exact supplied Name.

587 588 589
Note [Splicing Exact names]
~~~~~~~~~~~~~~~~~~~~~~~~~~~
Consider the splice $(do { x <- newName "x"; return (VarE x) })
Ian Lynagh's avatar
Ian Lynagh committed
590
This will generate a (HsExpr RdrName) term that mentions the
591 592 593 594 595
Exact RdrName "x_56" (or whatever), but does not bind it.  So
when looking such Exact names we want to check that it's in scope,
otherwise the type checker will get confused.  To do this we need to
keep track of all the Names in scope, and the LocalRdrEnv does just that;
we consult it with RdrName.inLocalRdrEnvScope.
596

597
There is another wrinkle.  With TH and -XDataKinds, consider
Ian Lynagh's avatar
Ian Lynagh committed
598
   $( [d| data Nat = Zero
599 600 601 602
          data T = MkT (Proxy 'Zero)  |] )
After splicing, but before renaming we get this:
   data Nat_77{tc} = Zero_78{d}
   data T_79{tc} = MkT_80{d} (Proxy 'Zero_78{tc})  |] )
603
The occurrence of 'Zero in the data type for T has the right unique,
604
but it has a TcClsName name-space in its OccName.  (This is set by
Ian Lynagh's avatar
Ian Lynagh committed
605
the ctxt_ns argument of Convert.thRdrName.)  When we check that is
606 607 608 609
in scope in the GlobalRdrEnv, we need to look up the DataName namespace
too.  (An alternative would be to make the GlobalRdrEnv also have
a Name -> GRE mapping.)

610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628
Note [Template Haskell ambiguity]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The GlobalRdrEnv invariant says that if
  occ -> [gre1, ..., gren]
then the gres have distinct Names (INVARIANT 1 of GlobalRdrEnv).
This is guaranteed by extendGlobalRdrEnvRn (the dups check in add_gre).

So how can we get multiple gres in lookupExactOcc_maybe?  Because in
TH we might use the same TH NameU in two different name spaces.
eg (Trac #7241):
   $(newName "Foo" >>= \o -> return [DataD [] o [] [RecC o []] [''Show]])
Here we generate a type constructor and data constructor with the same
unique, but differnt name spaces.

It'd be nicer to rule this out in extendGlobalRdrEnvRn, but that would
mean looking up the OccName in every name-space, just in case, and that
seems a bit brutal.  So it's just done here on lookup.  But we might
need to revisit that choice.

simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
629 630 631
Note [Usage for sub-bndrs]
~~~~~~~~~~~~~~~~~~~~~~~~~~
If you have this
Ian Lynagh's avatar
Ian Lynagh committed
632
   import qualified M( C( f ) )
633
   instance M.C T where
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
634 635 636 637 638
     f x = x
then is the qualified import M.f used?  Obviously yes.
But the RdrName used in the instance decl is unqualified.  In effect,
we fill in the qualification by looking for f's whose class is M.C
But when adding to the UsedRdrNames we must make that qualification
639 640 641 642 643 644 645 646 647
explicit (saying "used  M.f"), otherwise we get "Redundant import of M.f".

So we make up a suitable (fake) RdrName.  But be careful
   import qualifed M
   import M( C(f) )
   instance C T where
     f x = x
Here we want to record a use of 'f', not of 'M.f', otherwise
we'll miss the fact that the qualified import is redundant.
648

649
--------------------------------------------------
Ian Lynagh's avatar
Ian Lynagh committed
650
--              Occurrences
651
--------------------------------------------------
Austin Seipp's avatar
Austin Seipp committed
652
-}
653

654 655
getLookupOccRn :: RnM (Name -> Maybe Name)
getLookupOccRn
656 657
  = do local_env <- getLocalRdrEnv
       return (lookupLocalRdrOcc local_env . nameOccName)
658

659 660 661
lookupLocatedOccRn :: Located RdrName -> RnM (Located Name)
lookupLocatedOccRn = wrapLocM lookupOccRn

662 663
lookupLocalOccRn_maybe :: RdrName -> RnM (Maybe Name)
-- Just look in the local environment
Ian Lynagh's avatar
Ian Lynagh committed
664
lookupLocalOccRn_maybe rdr_name
665 666 667
  = do { local_env <- getLocalRdrEnv
       ; return (lookupLocalRdrEnv local_env rdr_name) }

668
lookupLocalOccThLvl_maybe :: Name -> RnM (Maybe (TopLevelFlag, ThLevel))
gmainland's avatar
gmainland committed
669
-- Just look in the local environment
670 671 672
lookupLocalOccThLvl_maybe name
  = do { lcl_env <- getLclEnv
       ; return (lookupNameEnv (tcl_th_bndrs lcl_env) name) }
gmainland's avatar
gmainland committed
673

dreixel's avatar
dreixel committed
674 675
-- lookupOccRn looks up an occurrence of a RdrName
lookupOccRn :: RdrName -> RnM Name
676
lookupOccRn rdr_name
677 678
  = do { mb_name <- lookupOccRn_maybe rdr_name
       ; case mb_name of
679
           Just name -> return name
680
           Nothing   -> reportUnboundName rdr_name }
dreixel's avatar
dreixel committed
681

682 683 684 685 686 687
lookupKindOccRn :: RdrName -> RnM Name
-- Looking up a name occurring in a kind
lookupKindOccRn rdr_name
  = do { mb_name <- lookupOccRn_maybe rdr_name
       ; case mb_name of
           Just name -> return name
688
           Nothing   -> reportUnboundName rdr_name  }
689

dreixel's avatar
dreixel committed
690
-- lookupPromotedOccRn looks up an optionally promoted RdrName.
691
lookupTypeOccRn :: RdrName -> RnM Name
Ian Lynagh's avatar
Ian Lynagh committed
692 693 694
-- see Note [Demotion]
lookupTypeOccRn rdr_name
  = do { mb_name <- lookupOccRn_maybe rdr_name
695 696
       ; case mb_name of {
             Just name -> return name ;
697 698 699 700 701 702 703 704
             Nothing   -> lookup_demoted rdr_name } }

lookup_demoted :: RdrName -> RnM Name
lookup_demoted rdr_name
  | Just demoted_rdr <- demoteRdrName rdr_name
    -- Maybe it's the name of a *data* constructor
  = do { data_kinds <- xoptM Opt_DataKinds
       ; mb_demoted_name <- lookupOccRn_maybe demoted_rdr
705
       ; case mb_demoted_name of
706
           Nothing -> reportUnboundName rdr_name
Ian Lynagh's avatar
Ian Lynagh committed
707
           Just demoted_name
carlostome's avatar
carlostome committed
708 709 710 711
             | data_kinds ->
             do { whenWOptM Opt_WarnUntickedPromotedConstructors $
                  addWarn (untickedPromConstrWarn demoted_name)
                ; return demoted_name }
712
             | otherwise  -> unboundNameX WL_Any rdr_name suggest_dk }
Ian Lynagh's avatar
Ian Lynagh committed
713

714
  | otherwise
715
  = reportUnboundName rdr_name
716

Ian Lynagh's avatar
Ian Lynagh committed
717
  where
718
    suggest_dk = ptext (sLit "A data constructor of that name is in scope; did you mean DataKinds?")
carlostome's avatar
carlostome committed
719 720 721 722 723 724 725
    untickedPromConstrWarn name =
      text "Unticked promoted constructor" <> colon <+> quotes (ppr name) <> dot
      $$
      hsep [ text "Use"
           , quotes (char '\'' <> ppr name)
           , text "instead of"
           , quotes (ppr name) <> dot ]
726

Austin Seipp's avatar
Austin Seipp committed
727
{-
728 729 730 731 732 733 734 735
Note [Demotion]
~~~~~~~~~~~~~~~
When the user writes:
  data Nat = Zero | Succ Nat
  foo :: f Zero -> Int

'Zero' in the type signature of 'foo' is parsed as:
  HsTyVar ("Zero", TcClsName)
dreixel's avatar
dreixel committed
736

Gabor Greif's avatar
Gabor Greif committed
737
When the renamer hits this occurrence of 'Zero' it's going to realise
738 739 740 741 742 743
that it's not in scope. But because it is renaming a type, it knows
that 'Zero' might be a promoted data constructor, so it will demote
its namespace to DataName and do a second lookup.

The final result (after the renamer) will be:
  HsTyVar ("Zero", DataName)
Austin Seipp's avatar
Austin Seipp committed
744
-}
745

746 747 748 749 750 751 752 753 754 755 756 757 758 759 760
--              Use this version to get tracing
--
-- lookupOccRn_maybe, lookupOccRn_maybe' :: RdrName -> RnM (Maybe Name)
-- lookupOccRn_maybe rdr_name
--  = do { mb_res <- lookupOccRn_maybe' rdr_name
--       ; gbl_rdr_env   <- getGlobalRdrEnv
--       ; local_rdr_env <- getLocalRdrEnv
--       ; traceRn $ text "lookupOccRn_maybe" <+>
--           vcat [ ppr rdr_name <+> ppr (getUnique (rdrNameOcc rdr_name))
--                , ppr mb_res
--                , text "Lcl env" <+> ppr local_rdr_env
--                , text "Gbl env" <+> ppr [ (getUnique (nameOccName (gre_name (head gres'))),gres') | gres <- occEnvElts gbl_rdr_env
--                                         , let gres' = filter isLocalGRE gres, not (null gres') ] ]
--       ; return mb_res }

761
lookupOccRn_maybe :: RdrName -> RnM (Maybe Name)
762
-- lookupOccRn looks up an occurrence of a RdrName
763
lookupOccRn_maybe rdr_name
764
  = do { local_env <- getLocalRdrEnv
dreixel's avatar
dreixel committed
765 766 767 768
       ; case lookupLocalRdrEnv local_env rdr_name of {
          Just name -> return (Just name) ;
          Nothing   -> do
       { mb_name <- lookupGlobalOccRn_maybe rdr_name
769
       ; case mb_name of {
dreixel's avatar
dreixel committed
770 771
                Just name  -> return (Just name) ;
                Nothing -> do
772 773 774 775 776 777
       { ns <- lookupQualifiedNameGHCi rdr_name
                      -- This test is not expensive,
                      -- and only happens for failed lookups
       ; case ns of
           (n:_) -> return (Just n)  -- Unlikely to be more than one...?
           []    -> return Nothing } } } } }
778 779

lookupGlobalOccRn :: RdrName -> RnM Name
Ian Lynagh's avatar
Ian Lynagh committed
780
-- lookupGlobalOccRn is like lookupOccRn, except that it looks in the global
781 782 783 784 785
-- environment.  Adds an error message if the RdrName is not in scope.
lookupGlobalOccRn rdr_name
  = do { mb_name <- lookupGlobalOccRn_maybe rdr_name
       ; case mb_name of
           Just n  -> return n
786 787
           Nothing -> do { traceRn (text "lookupGlobalOccRn" <+> ppr rdr_name)
                         ; unboundName WL_Global rdr_name } }
788

789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807
lookupInfoOccRn :: RdrName -> RnM [Name]
-- lookupInfoOccRn is intended for use in GHCi's ":info" command
-- It finds all the GREs that RdrName could mean, not complaining
-- about ambiguity, but rather returning them all
-- C.f. Trac #9881
lookupInfoOccRn rdr_name
  | Just n <- isExact_maybe rdr_name   -- e.g. (->)
  = return [n]

  | Just (rdr_mod, rdr_occ) <- isOrig_maybe rdr_name
  = do { n <- lookupOrig rdr_mod rdr_occ
       ; return [n] }

  | otherwise
  = do { rdr_env <- getGlobalRdrEnv
       ; let ns = map gre_name (lookupGRE_RdrName rdr_name rdr_env)
       ; qual_ns <- lookupQualifiedNameGHCi rdr_name
       ; return (ns ++ (qual_ns `minusList` ns)) }

808 809 810 811 812
lookupGlobalOccRn_maybe :: RdrName -> RnM (Maybe Name)
-- No filter function; does not report an error on failure

lookupGlobalOccRn_maybe rdr_name
  | Just n <- isExact_maybe rdr_name   -- This happens in derived code
813
  = do { n' <- lookupExactOcc n; return (Just n') }
814

Simon Marlow's avatar
Simon Marlow committed
815
  | Just (rdr_mod, rdr_occ) <- isOrig_maybe rdr_name
816 817
  = do { n <- lookupOrig rdr_mod rdr_occ
       ; return (Just n) }
Simon Marlow's avatar
Simon Marlow committed
818 819

  | otherwise
Ian Lynagh's avatar
Ian Lynagh committed
820 821 822 823
  = do  { mb_gre <- lookupGreRn_maybe rdr_name
        ; case mb_gre of
                Nothing  -> return Nothing
                Just gre -> return (Just (gre_name gre)) }
824

825 826

--------------------------------------------------
Ian Lynagh's avatar
Ian Lynagh committed
827
--      Lookup in the Global RdrEnv of the module
828 829
--------------------------------------------------

830
lookupGreRn_maybe :: RdrName -> RnM (Maybe GlobalRdrElt)
831 832 833 834 835 836
-- Look up the RdrName in the GlobalRdrEnv
--   Exactly one binding: records it as "used", return (Just gre)
--   No bindings:         return Nothing
--   Many bindings:       report "ambiguous", return an arbitrary (Just gre)
-- (This API is a bit strange; lookupGRERn2_maybe is simpler.
--  But it works and I don't want to fiddle too much.)
Ian Lynagh's avatar
Ian Lynagh committed
837 838
lookupGreRn_maybe rdr_name
  = do  { env <- getGlobalRdrEnv
839
        ; case lookupGRE_RdrName rdr_name env of
Ian Lynagh's avatar
Ian Lynagh committed
840
            []    -> return Nothing
841
            [gre] -> do { addUsedRdrName True gre rdr_name
842
                        ; return (Just gre) }
Ian Lynagh's avatar
Ian Lynagh committed
843
            gres  -> do { addNameClashErrRn rdr_name gres
844
                        ; traceRn (text "name clash" <+> (ppr rdr_name $$ ppr gres $$ ppr env))
Ian Lynagh's avatar
Ian Lynagh committed
845
                        ; return (Just (head gres)) } }
846

847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874
lookupGreRn2_maybe :: RdrName -> RnM (Maybe GlobalRdrElt)
-- Look up the RdrName in the GlobalRdrEnv
--   Exactly one binding: record it as "used",   return (Just gre)
--   No bindings:         report "not in scope", return Nothing
--   Many bindings:       report "ambiguous",    return Nothing
lookupGreRn2_maybe rdr_name
  = do  { env <- getGlobalRdrEnv
        ; case lookupGRE_RdrName rdr_name env of
            []    -> do { _ <- unboundName WL_Global rdr_name
                        ; return Nothing }
            [gre] -> do { addUsedRdrName True gre rdr_name
                        ; return (Just gre) }
            gres  -> do { addNameClashErrRn rdr_name gres
                        ; traceRn (text "name clash" <+> (ppr rdr_name $$ ppr gres $$ ppr env))
                        ; return Nothing } }

lookupGreAvailRn :: RdrName -> RnM (Name, AvailInfo)
-- Used in export lists
-- If not found or ambiguous, add error message, and fake with UnboundName
lookupGreAvailRn rdr_name
  = do  { mb_gre <- lookupGreRn2_maybe rdr_name
        ; case mb_gre of {
            Just gre -> return (gre_name gre, availFromGRE gre) ;
            Nothing  ->
    do  { traceRn (text "lookupGreRn" <+> ppr rdr_name)
        ; let name = mkUnboundName rdr_name
        ; return (name, Avail name) } } }

Austin Seipp's avatar
Austin Seipp committed
875 876 877
{-
*********************************************************
*                                                      *
Ian Lynagh's avatar
Ian Lynagh committed
878
                Deprecations
Austin Seipp's avatar
Austin Seipp committed
879 880
*                                                      *
*********************************************************
881

882 883 884 885 886
Note [Handling of deprecations]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* We report deprecations at each *occurrence* of the deprecated thing
  (see Trac #5867)

Simon Peyton Jones's avatar
Simon Peyton Jones committed
887
* We do not report deprecations for locally-defined names. For a
888 889 890 891 892 893 894 895 896
  start, we may be exporting a deprecated thing. Also we may use a
  deprecated thing in the defn of another deprecated things.  We may
  even use a deprecated thing in the defn of a non-deprecated thing,
  when changing a module's interface.

* addUsedRdrNames: we do not report deprecations for sub-binders:
     - the ".." completion for records
     - the ".." in an export item 'T(..)'
     - the things exported by a module export 'module M'
Austin Seipp's avatar
Austin Seipp committed
897
-}
898

899
addUsedRdrName :: Bool -> GlobalRdrElt -> RdrName -> RnM ()
900
-- Record usage of imported RdrNames
901 902 903
addUsedRdrName warn_if_deprec gre rdr
  = do { unless (isLocalGRE gre) $
         do { env <- getGblEnv
904
            ; traceRn (text "addUsedRdrName 1" <+> ppr gre)
905 906 907 908 909
            ; updMutVar (tcg_used_rdrnames env)
                        (\s -> Set.insert rdr s) }

       ; when warn_if_deprec $
         warnIfDeprecated gre }
910 911 912 913 914

addUsedRdrNames :: [RdrName] -> RnM ()
-- Record used sub-binders
-- We don't check for imported-ness here, because it's inconvenient
-- and not stritly necessary.
915
-- NB: no call to warnIfDeprecated; see Note [Handling of deprecations]
916 917
addUsedRdrNames rdrs
  = do { env <- getGblEnv
918
       ; traceRn (text "addUsedRdrName 2" <+> ppr rdrs)
919
       ; updMutVar (tcg_used_rdrnames env)
Ian Lynagh's avatar
Ian Lynagh committed
920
                   (\s -> foldr Set.insert s rdrs) }
921

922
warnIfDeprecated :: GlobalRdrElt -> RnM ()
923 924
warnIfDeprecated gre@(GRE { gre_name = name, gre_imp = iss })
  | (imp_spec : _) <- iss
925
  = do { dflags <- getDynFlags
926 927 928 929
       ; this_mod <- getModule
       ; when (wopt Opt_WarnWarningsDeprecations dflags &&
               not (nameIsLocalOrFrom this_mod name)) $
                   -- See Note [Handling of deprecations]
930 931
         do { iface <- loadInterfaceForName doc name
            ; case lookupImpDeprec iface gre of
932
                Just txt -> addWarn (mk_msg imp_spec txt)
933
                Nothing  -> return () } }
934 935
  | otherwise
  = return ()
936 937 938 939
  where
    name_mod = ASSERT2( isExternalName name, ppr name ) nameModule name
    doc = ptext (sLit "The name") <+> quotes (ppr name) <+> ptext (sLit "is mentioned explicitly")

940 941 942 943 944 945 946 947 948 949 950
    mk_msg imp_spec txt
      = sep [ sep [ ptext (sLit "In the use of")
                    <+> pprNonVarNameSpace (occNameSpace (nameOccName name))
                    <+> quotes (ppr name)
                  , parens imp_msg <> colon ]
            , ppr txt ]
      where
        imp_mod  = importSpecModule imp_spec
        imp_msg  = ptext (sLit "imported from") <+> ppr imp_mod <> extra
        extra | imp_mod == moduleName name_mod = Outputable.empty
              | otherwise = ptext (sLit ", but defined in") <+> ppr name_mod
951 952 953 954

lookupImpDeprec :: ModIface -> GlobalRdrElt -> Maybe WarningTxt
lookupImpDeprec iface gre
  = mi_warn_fn iface (gre_name gre) `mplus`  -- Bleat if the thing,
955
    case gre_par gre of                      -- or its parent, is warn'd
Ian Lynagh's avatar
Ian Lynagh committed
956
       ParentIs p -> mi_warn_fn iface p
957
       NoParent   -> Nothing
958

Austin Seipp's avatar
Austin Seipp committed
959
{-
960 961
Note [Used names with interface not loaded]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
962
It's (just) possible to find a used
963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979
Name whose interface hasn't been loaded:

a) It might be a WiredInName; in that case we may not load
   its interface (although we could).

b) It might be GHC.Real.fromRational, or GHC.Num.fromInteger
   These are seen as "used" by the renamer (if -XRebindableSyntax)
   is on), but the typechecker may discard their uses
   if in fact the in-scope fromRational is GHC.Read.fromRational,
   (see tcPat.tcOverloadedLit), and the typechecker sees that the type
   is fixed, say, to GHC.Base.Float (see Inst.lookupSimpleInst).
   In that obscure case it won't force the interface in.

In both cases we simply don't permit deprecations;
this is, after all, wired-in stuff.


Austin Seipp's avatar
Austin Seipp committed
980 981
*********************************************************
*                                                      *
Ian Lynagh's avatar
Ian Lynagh committed
982
                GHCi support
Austin Seipp's avatar
Austin Seipp committed
983 984
*                                                      *
*********************************************************
985