compiler/typecheck/TcRnMonad.lhs

   1 \begin{code}
   2 module TcRnMonad(
   3         module TcRnMonad,
   4         module TcRnTypes,
   5         module IOEnv
   6   ) where
   7
   8 #include "HsVersions.h"
   9
  10 import TcRnTypes        -- Re-export all
  11 import IOEnv            -- Re-export all
  12
  13 #if defined(GHCI) && defined(BREAKPOINT)
  14 import TypeRep          ( Type(..), liftedTypeKind )
  15 import Var              ( mkTyVar, mkGlobalId )
  16 import IdInfo           ( GlobalIdDetails(..), vanillaIdInfo )
  17 import OccName          ( mkOccName, tvName )
  18 import SrcLoc           ( noSrcLoc  )
  19 import TysWiredIn       ( intTy, stringTy, mkListTy, unitTy, boolTy )
  20 import PrelNames        ( breakpointJumpName, breakpointCondJumpName )
  21 import NameEnv          ( mkNameEnv )
  22 import TcEnv            ( tcExtendIdEnv )
  23 #endif
  24
  25 import HsSyn            ( emptyLHsBinds, HaddockModInfo(..) )
  26 import HscTypes         ( HscEnv(..), ModGuts(..), ModIface(..),
  27                           TypeEnv, emptyTypeEnv, HscSource(..), isHsBoot,
  28                           ExternalPackageState(..), HomePackageTable,
  29                           Deprecs(..), FixityEnv, FixItem,
  30                           mkPrintUnqualified )
  31 import Module           ( Module, moduleName )
  32 import RdrName          ( GlobalRdrEnv, LocalRdrEnv, emptyLocalRdrEnv )
  33 import Name             ( Name, mkInternalName, tidyNameOcc, nameOccName, getSrcLoc )
  34 import Type             ( Type )
  35 import TcType           ( TcType, tcIsTyVarTy, tcGetTyVar )
  36 import NameEnv          ( extendNameEnvList, nameEnvElts )
  37 import InstEnv          ( emptyInstEnv )
  38 import FamInstEnv       ( emptyFamInstEnv )
  39
  40 import Var              ( setTyVarName )
  41 import Id               ( mkSysLocal )
  42 import VarSet           ( emptyVarSet )
  43 import VarEnv           ( TidyEnv, emptyTidyEnv, extendVarEnv )
  44 import ErrUtils         ( Message, Messages, emptyMessages, errorsFound,
  45                           mkWarnMsg, printErrorsAndWarnings,
  46                           mkLocMessage, mkLongErrMsg )
  47 import SrcLoc           ( mkGeneralSrcSpan, isGoodSrcSpan, SrcSpan, Located(..) )
  48 import NameEnv          ( emptyNameEnv )
  49 import NameSet          ( NameSet, emptyDUs, emptyNameSet, unionNameSets, addOneToNameSet )
  50 import OccName          ( emptyOccEnv, tidyOccName )
  51 import Bag              ( emptyBag )
  52 import Outputable
  53 import UniqSupply       ( UniqSupply, mkSplitUniqSupply, uniqFromSupply, uniqsFromSupply, splitUniqSupply )
  54 import UniqFM           ( unitUFM )
  55 import Unique           ( Unique )
  56 import DynFlags         ( DynFlags(..), DynFlag(..), dopt, dopt_set,
  57                           dopt_unset, GhcMode )
  58 import StaticFlags      ( opt_PprStyle_Debug )
  59 import FastString       ( FastString )
  60 import Bag              ( snocBag, unionBags )
  61 import Panic            ( showException )
  62
  63 import IO               ( stderr )
  64 import DATA_IOREF       ( newIORef, readIORef )
  65 import EXCEPTION        ( Exception )
  66 \end{code}
  67
  68
  69
  70 %************************************************************************
  71 %*                                                                      *
  72                         initTc
  73 %*                                                                      *
  74 %************************************************************************
  75
  76 \begin{code}
  77 ioToTcRn :: IO r -> TcRn r
  78 ioToTcRn = ioToIOEnv
  79 \end{code}
  80
  81 \begin{code}
  82 initTc :: HscEnv
  83        -> HscSource
  84        -> Module
  85        -> TcM r
  86        -> IO (Messages, Maybe r)
  87                 -- Nothing => error thrown by the thing inside
  88                 -- (error messages should have been printed already)
  89
  90 initTc hsc_env hsc_src mod do_this
  91  = do { errs_var     <- newIORef (emptyBag, emptyBag) ;
  92         tvs_var      <- newIORef emptyVarSet ;
  93         type_env_var <- newIORef emptyNameEnv ;
  94         dfuns_var    <- newIORef emptyNameSet ;
  95         keep_var     <- newIORef emptyNameSet ;
  96         th_var       <- newIORef False ;
  97         dfun_n_var   <- newIORef 1 ;
  98         let {
  99              gbl_env = TcGblEnv {
 100                 tcg_mod      = mod,
 101                 tcg_src      = hsc_src,
 102                 tcg_rdr_env  = hsc_global_rdr_env hsc_env,
 103                 tcg_fix_env  = emptyNameEnv,
 104                 tcg_default  = Nothing,
 105                 tcg_type_env = hsc_global_type_env hsc_env,
 106                 tcg_type_env_var = type_env_var,
 107                 tcg_inst_env  = emptyInstEnv,
 108                 tcg_fam_inst_env  = emptyFamInstEnv,
 109                 tcg_inst_uses = dfuns_var,
 110                 tcg_th_used   = th_var,
 111                 tcg_exports  = emptyNameSet,
 112                 tcg_imports  = init_imports,
 113                 tcg_dus      = emptyDUs,
 114                 tcg_rn_imports = Nothing,
 115                 tcg_rn_exports = Nothing,
 116                 tcg_rn_decls = Nothing,
 117                 tcg_binds    = emptyLHsBinds,
 118                 tcg_deprecs  = NoDeprecs,
 119                 tcg_insts    = [],
 120                 tcg_fam_insts= [],
 121                 tcg_rules    = [],
 122                 tcg_fords    = [],
 123                 tcg_dfun_n   = dfun_n_var,
 124                 tcg_keep     = keep_var,
 125                 tcg_doc      = Nothing,
 126                 tcg_hmi      = HaddockModInfo Nothing Nothing Nothing Nothing
 127              } ;
 128              lcl_env = TcLclEnv {
 129                 tcl_errs       = errs_var,
 130                 tcl_loc        = mkGeneralSrcSpan FSLIT("Top level"),
 131                 tcl_ctxt       = [],
 132                 tcl_rdr        = emptyLocalRdrEnv,
 133                 tcl_th_ctxt    = topStage,
 134                 tcl_arrow_ctxt = NoArrowCtxt,
 135                 tcl_env        = emptyNameEnv,
 136                 tcl_tyvars     = tvs_var,
 137                 tcl_lie        = panic "initTc:LIE"     -- LIE only valid inside a getLIE
 138              } ;
 139         } ;
 140
 141         -- OK, here's the business end!
 142         maybe_res <- initTcRnIf 'a' hsc_env gbl_env lcl_env $
 143                      addBreakpointBindings $
 144                      do { r <- tryM do_this
 145                         ; case r of
 146                           Right res -> return (Just res)
 147                           Left _    -> return Nothing } ;
 148
 149         -- Collect any error messages
 150         msgs <- readIORef errs_var ;
 151
 152         let { dflags = hsc_dflags hsc_env
 153             ; final_res | errorsFound dflags msgs = Nothing
 154                         | otherwise               = maybe_res } ;
 155
 156         return (msgs, final_res)
 157     }
 158   where
 159     init_imports = emptyImportAvails {imp_env =
 160                                         unitUFM (moduleName mod) emptyNameSet}
 161         -- Initialise tcg_imports with an empty set of bindings for
 162         -- this module, so that if we see 'module M' in the export
 163         -- list, and there are no bindings in M, we don't bleat
 164         -- "unknown module M".
 165
 166 initTcPrintErrors       -- Used from the interactive loop only
 167        :: HscEnv
 168        -> Module
 169        -> TcM r
 170        -> IO (Maybe r)
 171 initTcPrintErrors env mod todo = do
 172   (msgs, res) <- initTc env HsSrcFile mod todo
 173   printErrorsAndWarnings (hsc_dflags env) msgs
 174   return res
 175 \end{code}
 176
 177 \begin{code}
 178 addBreakpointBindings :: TcM a -> TcM a
 179 addBreakpointBindings thing_inside
 180 #if defined(GHCI) && defined(BREAKPOINT)
 181   = do  { unique <- newUnique
 182         ; let { var = mkInternalName unique (mkOccName tvName "a") noSrcLoc;
 183                 tyvar = mkTyVar var liftedTypeKind;
 184                 basicType extra = (FunTy intTy
 185                                    (FunTy (mkListTy unitTy)
 186                                     (FunTy stringTy
 187                                      (ForAllTy tyvar
 188                                       (extra
 189                                        (FunTy (TyVarTy tyvar)
 190                                         (TyVarTy tyvar)))))));
 191                 breakpointJumpId
 192                     = mkGlobalId VanillaGlobal breakpointJumpName
 193                                  (basicType id) vanillaIdInfo;
 194                 breakpointCondJumpId
 195                     = mkGlobalId VanillaGlobal breakpointCondJumpName
 196                                  (basicType (FunTy boolTy)) vanillaIdInfo
 197           }
 198         ; tcExtendIdEnv [breakpointJumpId, breakpointCondJumpId] thing_inside}
 199 #else
 200    = thing_inside
 201 #endif
 202 \end{code}
 203
 204 %************************************************************************
 205 %*                                                                      *
 206                 Initialisation
 207 %*                                                                      *
 208 %************************************************************************
 209
 210
 211 \begin{code}
 212 initTcRnIf :: Char              -- Tag for unique supply
 213            -> HscEnv
 214            -> gbl -> lcl
 215            -> TcRnIf gbl lcl a
 216            -> IO a
 217 initTcRnIf uniq_tag hsc_env gbl_env lcl_env thing_inside
 218    = do { us     <- mkSplitUniqSupply uniq_tag ;
 219         ; us_var <- newIORef us ;
 220
 221         ; let { env = Env { env_top = hsc_env,
 222                             env_us  = us_var,
 223                             env_gbl = gbl_env,
 224                             env_lcl = lcl_env } }
 225
 226         ; runIOEnv env thing_inside
 227         }
 228 \end{code}
 229
 230 %************************************************************************
 231 %*                                                                      *
 232                 Simple accessors
 233 %*                                                                      *
 234 %************************************************************************
 235
 236 \begin{code}
 237 getTopEnv :: TcRnIf gbl lcl HscEnv
 238 getTopEnv = do { env <- getEnv; return (env_top env) }
 239
 240 getGblEnv :: TcRnIf gbl lcl gbl
 241 getGblEnv = do { env <- getEnv; return (env_gbl env) }
 242
 243 updGblEnv :: (gbl -> gbl) -> TcRnIf gbl lcl a -> TcRnIf gbl lcl a
 244 updGblEnv upd = updEnv (\ env@(Env { env_gbl = gbl }) ->
 245                           env { env_gbl = upd gbl })
 246
 247 setGblEnv :: gbl -> TcRnIf gbl lcl a -> TcRnIf gbl lcl a
 248 setGblEnv gbl_env = updEnv (\ env -> env { env_gbl = gbl_env })
 249
 250 getLclEnv :: TcRnIf gbl lcl lcl
 251 getLclEnv = do { env <- getEnv; return (env_lcl env) }
 252
 253 updLclEnv :: (lcl -> lcl) -> TcRnIf gbl lcl a -> TcRnIf gbl lcl a
 254 updLclEnv upd = updEnv (\ env@(Env { env_lcl = lcl }) ->
 255                           env { env_lcl = upd lcl })
 256
 257 setLclEnv :: lcl' -> TcRnIf gbl lcl' a -> TcRnIf gbl lcl a
 258 setLclEnv lcl_env = updEnv (\ env -> env { env_lcl = lcl_env })
 259
 260 getEnvs :: TcRnIf gbl lcl (gbl, lcl)
 261 getEnvs = do { env <- getEnv; return (env_gbl env, env_lcl env) }
 262
 263 setEnvs :: (gbl', lcl') -> TcRnIf gbl' lcl' a -> TcRnIf gbl lcl a
 264 setEnvs (gbl_env, lcl_env) = updEnv (\ env -> env { env_gbl = gbl_env, env_lcl = lcl_env })
 265 \end{code}
 266
 267
 268 Command-line flags
 269
 270 \begin{code}
 271 getDOpts :: TcRnIf gbl lcl DynFlags
 272 getDOpts = do { env <- getTopEnv; return (hsc_dflags env) }
 273
 274 doptM :: DynFlag -> TcRnIf gbl lcl Bool
 275 doptM flag = do { dflags <- getDOpts; return (dopt flag dflags) }
 276
 277 setOptM :: DynFlag -> TcRnIf gbl lcl a -> TcRnIf gbl lcl a
 278 setOptM flag = updEnv (\ env@(Env { env_top = top }) ->
 279                          env { env_top = top { hsc_dflags = dopt_set (hsc_dflags top) flag}} )
 280
 281 unsetOptM :: DynFlag -> TcRnIf gbl lcl a -> TcRnIf gbl lcl a
 282 unsetOptM flag = updEnv (\ env@(Env { env_top = top }) ->
 283                          env { env_top = top { hsc_dflags = dopt_unset (hsc_dflags top) flag}} )
 284
 285 ifOptM :: DynFlag -> TcRnIf gbl lcl () -> TcRnIf gbl lcl ()     -- Do it flag is true
 286 ifOptM flag thing_inside = do { b <- doptM flag;
 287                                 if b then thing_inside else return () }
 288
 289 getGhcMode :: TcRnIf gbl lcl GhcMode
 290 getGhcMode = do { env <- getTopEnv; return (ghcMode (hsc_dflags env)) }
 291 \end{code}
 292
 293 \begin{code}
 294 getEpsVar :: TcRnIf gbl lcl (TcRef ExternalPackageState)
 295 getEpsVar = do { env <- getTopEnv; return (hsc_EPS env) }
 296
 297 getEps :: TcRnIf gbl lcl ExternalPackageState
 298 getEps = do { env <- getTopEnv; readMutVar (hsc_EPS env) }
 299
 300 -- Updating the EPS.  This should be an atomic operation.
 301 -- Note the delicate 'seq' which forces the EPS before putting it in the
 302 -- variable.  Otherwise what happens is that we get
 303 --      write eps_var (....(unsafeRead eps_var)....)
 304 -- and if the .... is strict, that's obviously bottom.  By forcing it beforehand
 305 -- we make the unsafeRead happen before we update the variable.
 306
 307 updateEps :: (ExternalPackageState -> (ExternalPackageState, a))
 308           -> TcRnIf gbl lcl a
 309 updateEps upd_fn = do   { traceIf (text "updating EPS")
 310                         ; eps_var <- getEpsVar
 311                         ; eps <- readMutVar eps_var
 312                         ; let { (eps', val) = upd_fn eps }
 313                         ; seq eps' (writeMutVar eps_var eps')
 314                         ; return val }
 315
 316 updateEps_ :: (ExternalPackageState -> ExternalPackageState)
 317            -> TcRnIf gbl lcl ()
 318 updateEps_ upd_fn = do  { traceIf (text "updating EPS_")
 319                         ; eps_var <- getEpsVar
 320                         ; eps <- readMutVar eps_var
 321                         ; let { eps' = upd_fn eps }
 322                         ; seq eps' (writeMutVar eps_var eps') }
 323
 324 getHpt :: TcRnIf gbl lcl HomePackageTable
 325 getHpt = do { env <- getTopEnv; return (hsc_HPT env) }
 326
 327 getEpsAndHpt :: TcRnIf gbl lcl (ExternalPackageState, HomePackageTable)
 328 getEpsAndHpt = do { env <- getTopEnv; eps <- readMutVar (hsc_EPS env)
 329                   ; return (eps, hsc_HPT env) }
 330 \end{code}
 331
 332 %************************************************************************
 333 %*                                                                      *
 334                 Unique supply
 335 %*                                                                      *
 336 %************************************************************************
 337
 338 \begin{code}
 339 newUnique :: TcRnIf gbl lcl Unique
 340 newUnique
 341  = do { env <- getEnv ;
 342         let { u_var = env_us env } ;
 343         us <- readMutVar u_var ;
 344         case splitUniqSupply us of { (us1,_) -> do {
 345         writeMutVar u_var us1 ;
 346         return $! uniqFromSupply us }}}
 347    -- NOTE 1: we strictly split the supply, to avoid the possibility of leaving
 348    -- a chain of unevaluated supplies behind.
 349    -- NOTE 2: we use the uniq in the supply from the MutVar directly, and
 350    -- throw away one half of the new split supply.  This is safe because this
 351    -- is the only place we use that unique.  Using the other half of the split
 352    -- supply is safer, but slower.
 353
 354 newUniqueSupply :: TcRnIf gbl lcl UniqSupply
 355 newUniqueSupply
 356  = do { env <- getEnv ;
 357         let { u_var = env_us env } ;
 358         us <- readMutVar u_var ;
 359         case splitUniqSupply us of { (us1,us2) -> do {
 360         writeMutVar u_var us1 ;
 361         return us2 }}}
 362
 363 newLocalName :: Name -> TcRnIf gbl lcl Name
 364 newLocalName name       -- Make a clone
 365   = do  { uniq <- newUnique
 366         ; return (mkInternalName uniq (nameOccName name) (getSrcLoc name)) }
 367
 368 newSysLocalIds :: FastString -> [TcType] -> TcRnIf gbl lcl [TcId]
 369 newSysLocalIds fs tys
 370   = do  { us <- newUniqueSupply
 371         ; return (zipWith (mkSysLocal fs) (uniqsFromSupply us) tys) }
 372 \end{code}
 373
 374
 375 %************************************************************************
 376 %*                                                                      *
 377                 Debugging
 378 %*                                                                      *
 379 %************************************************************************
 380
 381 \begin{code}
 382 traceTc, traceRn :: SDoc -> TcRn ()
 383 traceRn      = traceOptTcRn Opt_D_dump_rn_trace
 384 traceTc      = traceOptTcRn Opt_D_dump_tc_trace
 385 traceSplice  = traceOptTcRn Opt_D_dump_splices
 386
 387
 388 traceIf :: SDoc -> TcRnIf m n ()
 389 traceIf      = traceOptIf Opt_D_dump_if_trace
 390 traceHiDiffs = traceOptIf Opt_D_dump_hi_diffs
 391
 392
 393 traceOptIf :: DynFlag -> SDoc -> TcRnIf m n ()  -- No RdrEnv available, so qualify everything
 394 traceOptIf flag doc = ifOptM flag $
 395                      ioToIOEnv (printForUser stderr alwaysQualify doc)
 396
 397 traceOptTcRn :: DynFlag -> SDoc -> TcRn ()
 398 traceOptTcRn flag doc = ifOptM flag $ do
 399                         { ctxt <- getErrCtxt
 400                         ; loc  <- getSrcSpanM
 401                         ; env0 <- tcInitTidyEnv
 402                         ; ctxt_msgs <- do_ctxt env0 ctxt
 403                         ; let real_doc = mkLocMessage loc (vcat (doc : ctxt_to_use ctxt_msgs))
 404                         ; dumpTcRn real_doc }
 405
 406 dumpTcRn :: SDoc -> TcRn ()
 407 dumpTcRn doc = do { rdr_env <- getGlobalRdrEnv ;
 408                     ioToTcRn (printForUser stderr (mkPrintUnqualified rdr_env) doc) }
 409
 410 dumpOptTcRn :: DynFlag -> SDoc -> TcRn ()
 411 dumpOptTcRn flag doc = ifOptM flag (dumpTcRn doc)
 412 \end{code}
 413
 414
 415 %************************************************************************
 416 %*                                                                      *
 417                 Typechecker global environment
 418 %*                                                                      *
 419 %************************************************************************
 420
 421 \begin{code}
 422 getModule :: TcRn Module
 423 getModule = do { env <- getGblEnv; return (tcg_mod env) }
 424
 425 setModule :: Module -> TcRn a -> TcRn a
 426 setModule mod thing_inside = updGblEnv (\env -> env { tcg_mod = mod }) thing_inside
 427
 428 tcIsHsBoot :: TcRn Bool
 429 tcIsHsBoot = do { env <- getGblEnv; return (isHsBoot (tcg_src env)) }
 430
 431 getGlobalRdrEnv :: TcRn GlobalRdrEnv
 432 getGlobalRdrEnv = do { env <- getGblEnv; return (tcg_rdr_env env) }
 433
 434 getImports :: TcRn ImportAvails
 435 getImports = do { env <- getGblEnv; return (tcg_imports env) }
 436
 437 getFixityEnv :: TcRn FixityEnv
 438 getFixityEnv = do { env <- getGblEnv; return (tcg_fix_env env) }
 439
 440 extendFixityEnv :: [(Name,FixItem)] -> RnM a -> RnM a
 441 extendFixityEnv new_bit
 442   = updGblEnv (\env@(TcGblEnv { tcg_fix_env = old_fix_env }) ->
 443                 env {tcg_fix_env = extendNameEnvList old_fix_env new_bit})
 444
 445 getDefaultTys :: TcRn (Maybe [Type])
 446 getDefaultTys = do { env <- getGblEnv; return (tcg_default env) }
 447 \end{code}
 448
 449 %************************************************************************
 450 %*                                                                      *
 451                 Error management
 452 %*                                                                      *
 453 %************************************************************************
 454
 455 \begin{code}
 456 getSrcSpanM :: TcRn SrcSpan
 457         -- Avoid clash with Name.getSrcLoc
 458 getSrcSpanM = do { env <- getLclEnv; return (tcl_loc env) }
 459
 460 setSrcSpan :: SrcSpan -> TcRn a -> TcRn a
 461 setSrcSpan loc thing_inside
 462   | isGoodSrcSpan loc = updLclEnv (\env -> env { tcl_loc = loc }) thing_inside
 463   | otherwise         = thing_inside    -- Don't overwrite useful info with useless
 464
 465 addLocM :: (a -> TcM b) -> Located a -> TcM b
 466 addLocM fn (L loc a) = setSrcSpan loc $ fn a
 467
 468 wrapLocM :: (a -> TcM b) -> Located a -> TcM (Located b)
 469 wrapLocM fn (L loc a) = setSrcSpan loc $ do b <- fn a; return (L loc b)
 470
 471 wrapLocFstM :: (a -> TcM (b,c)) -> Located a -> TcM (Located b, c)
 472 wrapLocFstM fn (L loc a) =
 473   setSrcSpan loc $ do
 474     (b,c) <- fn a
 475     return (L loc b, c)
 476
 477 wrapLocSndM :: (a -> TcM (b,c)) -> Located a -> TcM (b, Located c)
 478 wrapLocSndM fn (L loc a) =
 479   setSrcSpan loc $ do
 480     (b,c) <- fn a
 481     return (b, L loc c)
 482 \end{code}
 483
 484
 485 \begin{code}
 486 getErrsVar :: TcRn (TcRef Messages)
 487 getErrsVar = do { env <- getLclEnv; return (tcl_errs env) }
 488
 489 setErrsVar :: TcRef Messages -> TcRn a -> TcRn a
 490 setErrsVar v = updLclEnv (\ env -> env { tcl_errs =  v })
 491
 492 addErr :: Message -> TcRn ()
 493 addErr msg = do { loc <- getSrcSpanM ; addErrAt loc msg }
 494
 495 addLocErr :: Located e -> (e -> Message) -> TcRn ()
 496 addLocErr (L loc e) fn = addErrAt loc (fn e)
 497
 498 addErrAt :: SrcSpan -> Message -> TcRn ()
 499 addErrAt loc msg = addLongErrAt loc msg empty
 500
 501 addLongErrAt :: SrcSpan -> Message -> Message -> TcRn ()
 502 addLongErrAt loc msg extra
 503   = do { traceTc (ptext SLIT("Adding error:") <+> (mkLocMessage loc (msg $$ extra))) ;
 504          errs_var <- getErrsVar ;
 505          rdr_env <- getGlobalRdrEnv ;
 506          let { err = mkLongErrMsg loc (mkPrintUnqualified rdr_env) msg extra } ;
 507          (warns, errs) <- readMutVar errs_var ;
 508          writeMutVar errs_var (warns, errs `snocBag` err) }
 509
 510 addErrs :: [(SrcSpan,Message)] -> TcRn ()
 511 addErrs msgs = mappM_ add msgs
 512              where
 513                add (loc,msg) = addErrAt loc msg
 514
 515 addReport :: Message -> TcRn ()
 516 addReport msg = do loc <- getSrcSpanM; addReportAt loc msg
 517
 518 addReportAt :: SrcSpan -> Message -> TcRn ()
 519 addReportAt loc msg
 520   = do { errs_var <- getErrsVar ;
 521          rdr_env <- getGlobalRdrEnv ;
 522          let { warn = mkWarnMsg loc (mkPrintUnqualified rdr_env) msg } ;
 523          (warns, errs) <- readMutVar errs_var ;
 524          writeMutVar errs_var (warns `snocBag` warn, errs) }
 525
 526 addWarn :: Message -> TcRn ()
 527 addWarn msg = addReport (ptext SLIT("Warning:") <+> msg)
 528
 529 addWarnAt :: SrcSpan -> Message -> TcRn ()
 530 addWarnAt loc msg = addReportAt loc (ptext SLIT("Warning:") <+> msg)
 531
 532 addLocWarn :: Located e -> (e -> Message) -> TcRn ()
 533 addLocWarn (L loc e) fn = addReportAt loc (fn e)
 534
 535 checkErr :: Bool -> Message -> TcRn ()
 536 -- Add the error if the bool is False
 537 checkErr ok msg = checkM ok (addErr msg)
 538
 539 warnIf :: Bool -> Message -> TcRn ()
 540 warnIf True  msg = addWarn msg
 541 warnIf False msg = return ()
 542
 543 addMessages :: Messages -> TcRn ()
 544 addMessages (m_warns, m_errs)
 545   = do { errs_var <- getErrsVar ;
 546          (warns, errs) <- readMutVar errs_var ;
 547          writeMutVar errs_var (warns `unionBags` m_warns,
 548                                errs  `unionBags` m_errs) }
 549
 550 discardWarnings :: TcRn a -> TcRn a
 551 -- Ignore warnings inside the thing inside;
 552 -- used to ignore-unused-variable warnings inside derived code
 553 -- With -dppr-debug, the effects is switched off, so you can still see
 554 -- what warnings derived code would give
 555 discardWarnings thing_inside
 556   | opt_PprStyle_Debug = thing_inside
 557   | otherwise
 558   = do  { errs_var <- newMutVar emptyMessages
 559         ; result <- setErrsVar errs_var thing_inside
 560         ; (_warns, errs) <- readMutVar errs_var
 561         ; addMessages (emptyBag, errs)
 562         ; return result }
 563 \end{code}
 564
 565
 566 \begin{code}
 567 try_m :: TcRn r -> TcRn (Either Exception r)
 568 -- Does try_m, with a debug-trace on failure
 569 try_m thing
 570   = do { mb_r <- tryM thing ;
 571          case mb_r of
 572              Left exn -> do { traceTc (exn_msg exn); return mb_r }
 573              Right r  -> return mb_r }
 574   where
 575     exn_msg exn = text "tryTc/recoverM recovering from" <+> text (showException exn)
 576
 577 -----------------------
 578 recoverM :: TcRn r      -- Recovery action; do this if the main one fails
 579          -> TcRn r      -- Main action: do this first
 580          -> TcRn r
 581 -- Errors in 'thing' are retained
 582 recoverM recover thing
 583   = do { mb_res <- try_m thing ;
 584          case mb_res of
 585            Left exn  -> recover
 586            Right res -> returnM res }
 587
 588 -----------------------
 589 tryTc :: TcRn a -> TcRn (Messages, Maybe a)
 590 -- (tryTc m) executes m, and returns
 591 --      Just r,  if m succeeds (returning r)
 592 --      Nothing, if m fails
 593 -- It also returns all the errors and warnings accumulated by m
 594 -- It always succeeds (never raises an exception)
 595 tryTc m
 596  = do { errs_var <- newMutVar emptyMessages ;
 597         res  <- try_m (setErrsVar errs_var m) ;
 598         msgs <- readMutVar errs_var ;
 599         return (msgs, case res of
 600                             Left exn  -> Nothing
 601                             Right val -> Just val)
 602         -- The exception is always the IOEnv built-in
 603         -- in exception; see IOEnv.failM
 604    }
 605
 606 -----------------------
 607 tryTcErrs :: TcRn a -> TcRn (Messages, Maybe a)
 608 -- Run the thing, returning
 609 --      Just r,  if m succceeds with no error messages
 610 --      Nothing, if m fails, or if it succeeds but has error messages
 611 -- Either way, the messages are returned; even in the Just case
 612 -- there might be warnings
 613 tryTcErrs thing
 614   = do  { (msgs, res) <- tryTc thing
 615         ; dflags <- getDOpts
 616         ; let errs_found = errorsFound dflags msgs
 617         ; return (msgs, case res of
 618                           Nothing -> Nothing
 619                           Just val | errs_found -> Nothing
 620                                    | otherwise  -> Just val)
 621         }
 622
 623 -----------------------
 624 tryTcLIE :: TcM a -> TcM (Messages, Maybe a)
 625 -- Just like tryTcErrs, except that it ensures that the LIE
 626 -- for the thing is propagated only if there are no errors
 627 -- Hence it's restricted to the type-check monad
 628 tryTcLIE thing_inside
 629   = do  { ((msgs, mb_res), lie) <- getLIE (tryTcErrs thing_inside) ;
 630         ; case mb_res of
 631             Nothing  -> return (msgs, Nothing)
 632             Just val -> do { extendLIEs lie; return (msgs, Just val) }
 633         }
 634
 635 -----------------------
 636 tryTcLIE_ :: TcM r -> TcM r -> TcM r
 637 -- (tryTcLIE_ r m) tries m;
 638 --      if m succeeds with no error messages, it's the answer
 639 --      otherwise tryTcLIE_ drops everything from m and tries r instead.
 640 tryTcLIE_ recover main
 641   = do  { (msgs, mb_res) <- tryTcLIE main
 642         ; case mb_res of
 643              Just val -> do { addMessages msgs  -- There might be warnings
 644                              ; return val }
 645              Nothing  -> recover                -- Discard all msgs
 646         }
 647
 648 -----------------------
 649 checkNoErrs :: TcM r -> TcM r
 650 -- (checkNoErrs m) succeeds iff m succeeds and generates no errors
 651 -- If m fails then (checkNoErrsTc m) fails.
 652 -- If m succeeds, it checks whether m generated any errors messages
 653 --      (it might have recovered internally)
 654 --      If so, it fails too.
 655 -- Regardless, any errors generated by m are propagated to the enclosing context.
 656 checkNoErrs main
 657   = do  { (msgs, mb_res) <- tryTcLIE main
 658         ; addMessages msgs
 659         ; case mb_res of
 660             Nothing   -> failM
 661             Just val -> return val
 662         }
 663
 664 ifErrsM :: TcRn r -> TcRn r -> TcRn r
 665 --      ifErrsM bale_out main
 666 -- does 'bale_out' if there are errors in errors collection
 667 -- otherwise does 'main'
 668 ifErrsM bale_out normal
 669  = do { errs_var <- getErrsVar ;
 670         msgs <- readMutVar errs_var ;
 671         dflags <- getDOpts ;
 672         if errorsFound dflags msgs then
 673            bale_out
 674         else
 675            normal }
 676
 677 failIfErrsM :: TcRn ()
 678 -- Useful to avoid error cascades
 679 failIfErrsM = ifErrsM failM (return ())
 680 \end{code}
 681
 682
 683 %************************************************************************
 684 %*                                                                      *
 685         Context management and error message generation
 686                     for the type checker
 687 %*                                                                      *
 688 %************************************************************************
 689
 690 \begin{code}
 691 getErrCtxt :: TcM ErrCtxt
 692 getErrCtxt = do { env <- getLclEnv; return (tcl_ctxt env) }
 693
 694 setErrCtxt :: ErrCtxt -> TcM a -> TcM a
 695 setErrCtxt ctxt = updLclEnv (\ env -> env { tcl_ctxt = ctxt })
 696
 697 addErrCtxt :: Message -> TcM a -> TcM a
 698 addErrCtxt msg = addErrCtxtM (\env -> returnM (env, msg))
 699
 700 addErrCtxtM :: (TidyEnv -> TcM (TidyEnv, Message)) -> TcM a -> TcM a
 701 addErrCtxtM msg = updCtxt (\ msgs -> msg : msgs)
 702
 703 -- Helper function for the above
 704 updCtxt :: (ErrCtxt -> ErrCtxt) -> TcM a -> TcM a
 705 updCtxt upd = updLclEnv (\ env@(TcLclEnv { tcl_ctxt = ctxt }) ->
 706                            env { tcl_ctxt = upd ctxt })
 707
 708 -- Conditionally add an error context
 709 maybeAddErrCtxt :: Maybe Message -> TcM a -> TcM a
 710 maybeAddErrCtxt (Just msg) thing_inside = addErrCtxt msg thing_inside
 711 maybeAddErrCtxt Nothing    thing_inside = thing_inside
 712
 713 popErrCtxt :: TcM a -> TcM a
 714 popErrCtxt = updCtxt (\ msgs -> case msgs of { [] -> []; (m:ms) -> ms })
 715
 716 getInstLoc :: InstOrigin -> TcM InstLoc
 717 getInstLoc origin
 718   = do { loc <- getSrcSpanM ; env <- getLclEnv ;
 719          return (InstLoc origin loc (tcl_ctxt env)) }
 720
 721 addInstCtxt :: InstLoc -> TcM a -> TcM a
 722 -- Add the SrcSpan and context from the first Inst in the list
 723 --      (they all have similar locations)
 724 addInstCtxt (InstLoc _ src_loc ctxt) thing_inside
 725   = setSrcSpan src_loc (updCtxt (\ old_ctxt -> ctxt) thing_inside)
 726 \end{code}
 727
 728     The addErrTc functions add an error message, but do not cause failure.
 729     The 'M' variants pass a TidyEnv that has already been used to
 730     tidy up the message; we then use it to tidy the context messages
 731
 732 \begin{code}
 733 addErrTc :: Message -> TcM ()
 734 addErrTc err_msg = do { env0 <- tcInitTidyEnv
 735                       ; addErrTcM (env0, err_msg) }
 736
 737 addErrsTc :: [Message] -> TcM ()
 738 addErrsTc err_msgs = mappM_ addErrTc err_msgs
 739
 740 addErrTcM :: (TidyEnv, Message) -> TcM ()
 741 addErrTcM (tidy_env, err_msg)
 742   = do { ctxt <- getErrCtxt ;
 743          loc  <- getSrcSpanM ;
 744          add_err_tcm tidy_env err_msg loc ctxt }
 745 \end{code}
 746
 747 The failWith functions add an error message and cause failure
 748
 749 \begin{code}
 750 failWithTc :: Message -> TcM a               -- Add an error message and fail
 751 failWithTc err_msg
 752   = addErrTc err_msg >> failM
 753
 754 failWithTcM :: (TidyEnv, Message) -> TcM a   -- Add an error message and fail
 755 failWithTcM local_and_msg
 756   = addErrTcM local_and_msg >> failM
 757
 758 checkTc :: Bool -> Message -> TcM ()         -- Check that the boolean is true
 759 checkTc True  err = returnM ()
 760 checkTc False err = failWithTc err
 761 \end{code}
 762
 763         Warnings have no 'M' variant, nor failure
 764
 765 \begin{code}
 766 addWarnTc :: Message -> TcM ()
 767 addWarnTc msg
 768  = do { ctxt <- getErrCtxt ;
 769         env0 <- tcInitTidyEnv ;
 770         ctxt_msgs <- do_ctxt env0 ctxt ;
 771         addWarn (vcat (msg : ctxt_to_use ctxt_msgs)) }
 772
 773 warnTc :: Bool -> Message -> TcM ()
 774 warnTc warn_if_true warn_msg
 775   | warn_if_true = addWarnTc warn_msg
 776   | otherwise    = return ()
 777 \end{code}
 778
 779 -----------------------------------
 780          Tidying
 781
 782 We initialise the "tidy-env", used for tidying types before printing,
 783 by building a reverse map from the in-scope type variables to the
 784 OccName that the programmer originally used for them
 785
 786 \begin{code}
 787 tcInitTidyEnv :: TcM TidyEnv
 788 tcInitTidyEnv
 789   = do  { lcl_env <- getLclEnv
 790         ; let nm_tv_prs = [ (name, tcGetTyVar "tcInitTidyEnv" ty)
 791                           | ATyVar name ty <- nameEnvElts (tcl_env lcl_env)
 792                           , tcIsTyVarTy ty ]
 793         ; return (foldl add emptyTidyEnv nm_tv_prs) }
 794   where
 795     add (env,subst) (name, tyvar)
 796         = case tidyOccName env (nameOccName name) of
 797             (env', occ') ->  (env', extendVarEnv subst tyvar tyvar')
 798                 where
 799                   tyvar' = setTyVarName tyvar name'
 800                   name'  = tidyNameOcc name occ'
 801 \end{code}
 802
 803 -----------------------------------
 804         Other helper functions
 805
 806 \begin{code}
 807 add_err_tcm tidy_env err_msg loc ctxt
 808  = do { ctxt_msgs <- do_ctxt tidy_env ctxt ;
 809         addLongErrAt loc err_msg (vcat (ctxt_to_use ctxt_msgs)) }
 810
 811 do_ctxt tidy_env []
 812  = return []
 813 do_ctxt tidy_env (c:cs)
 814  = do { (tidy_env', m) <- c tidy_env  ;
 815         ms             <- do_ctxt tidy_env' cs  ;
 816         return (m:ms) }
 817
 818 ctxt_to_use ctxt | opt_PprStyle_Debug = ctxt
 819                  | otherwise          = take 3 ctxt
 820 \end{code}
 821
 822 debugTc is useful for monadic debugging code
 823
 824 \begin{code}
 825 debugTc :: TcM () -> TcM ()
 826 #ifdef DEBUG
 827 debugTc thing = thing
 828 #else
 829 debugTc thing = return ()
 830 #endif
 831 \end{code}
 832
 833  %************************************************************************
 834 %*                                                                      *
 835              Type constraints (the so-called LIE)
 836 %*                                                                      *
 837 %************************************************************************
 838
 839 \begin{code}
 840 nextDFunIndex :: TcM Int        -- Get the next dfun index
 841 nextDFunIndex = do { env <- getGblEnv
 842                    ; let dfun_n_var = tcg_dfun_n env
 843                    ; n <- readMutVar dfun_n_var
 844                    ; writeMutVar dfun_n_var (n+1)
 845                    ; return n }
 846
 847 getLIEVar :: TcM (TcRef LIE)
 848 getLIEVar = do { env <- getLclEnv; return (tcl_lie env) }
 849
 850 setLIEVar :: TcRef LIE -> TcM a -> TcM a
 851 setLIEVar lie_var = updLclEnv (\ env -> env { tcl_lie = lie_var })
 852
 853 getLIE :: TcM a -> TcM (a, [Inst])
 854 -- (getLIE m) runs m, and returns the type constraints it generates
 855 getLIE thing_inside
 856   = do { lie_var <- newMutVar emptyLIE ;
 857          res <- updLclEnv (\ env -> env { tcl_lie = lie_var })
 858                           thing_inside ;
 859          lie <- readMutVar lie_var ;
 860          return (res, lieToList lie) }
 861
 862 extendLIE :: Inst -> TcM ()
 863 extendLIE inst
 864   = do { lie_var <- getLIEVar ;
 865          lie <- readMutVar lie_var ;
 866          writeMutVar lie_var (inst `consLIE` lie) }
 867
 868 extendLIEs :: [Inst] -> TcM ()
 869 extendLIEs []
 870   = returnM ()
 871 extendLIEs insts
 872   = do { lie_var <- getLIEVar ;
 873          lie <- readMutVar lie_var ;
 874          writeMutVar lie_var (mkLIE insts `plusLIE` lie) }
 875 \end{code}
 876
 877 \begin{code}
 878 setLclTypeEnv :: TcLclEnv -> TcM a -> TcM a
 879 -- Set the local type envt, but do *not* disturb other fields,
 880 -- notably the lie_var
 881 setLclTypeEnv lcl_env thing_inside
 882   = updLclEnv upd thing_inside
 883   where
 884     upd env = env { tcl_env = tcl_env lcl_env,
 885                     tcl_tyvars = tcl_tyvars lcl_env }
 886 \end{code}
 887
 888
 889 %************************************************************************
 890 %*                                                                      *
 891              Template Haskell context
 892 %*                                                                      *
 893 %************************************************************************
 894
 895 \begin{code}
 896 recordThUse :: TcM ()
 897 recordThUse = do { env <- getGblEnv; writeMutVar (tcg_th_used env) True }
 898
 899 keepAliveTc :: Name -> TcM ()   -- Record the name in the keep-alive set
 900 keepAliveTc n = do { env <- getGblEnv;
 901                    ; updMutVar (tcg_keep env) (`addOneToNameSet` n) }
 902
 903 keepAliveSetTc :: NameSet -> TcM ()     -- Record the name in the keep-alive set
 904 keepAliveSetTc ns = do { env <- getGblEnv;
 905                        ; updMutVar (tcg_keep env) (`unionNameSets` ns) }
 906
 907 getStage :: TcM ThStage
 908 getStage = do { env <- getLclEnv; return (tcl_th_ctxt env) }
 909
 910 setStage :: ThStage -> TcM a -> TcM a
 911 setStage s = updLclEnv (\ env -> env { tcl_th_ctxt = s })
 912 \end{code}
 913
 914
 915 %************************************************************************
 916 %*                                                                      *
 917              Stuff for the renamer's local env
 918 %*                                                                      *
 919 %************************************************************************
 920
 921 \begin{code}
 922 getLocalRdrEnv :: RnM LocalRdrEnv
 923 getLocalRdrEnv = do { env <- getLclEnv; return (tcl_rdr env) }
 924
 925 setLocalRdrEnv :: LocalRdrEnv -> RnM a -> RnM a
 926 setLocalRdrEnv rdr_env thing_inside
 927   = updLclEnv (\env -> env {tcl_rdr = rdr_env}) thing_inside
 928 \end{code}
 929
 930
 931 %************************************************************************
 932 %*                                                                      *
 933              Stuff for interface decls
 934 %*                                                                      *
 935 %************************************************************************
 936
 937 \begin{code}
 938 mkIfLclEnv :: Module -> SDoc -> IfLclEnv
 939 mkIfLclEnv mod loc = IfLclEnv { if_mod     = mod,
 940                                 if_loc     = loc,
 941                                 if_tv_env  = emptyOccEnv,
 942                                 if_id_env  = emptyOccEnv }
 943
 944 initIfaceTcRn :: IfG a -> TcRn a
 945 initIfaceTcRn thing_inside
 946   = do  { tcg_env <- getGblEnv
 947         ; let { if_env = IfGblEnv { if_rec_types = Just (tcg_mod tcg_env, get_type_env) }
 948               ; get_type_env = readMutVar (tcg_type_env_var tcg_env) }
 949         ; setEnvs (if_env, ()) thing_inside }
 950
 951 initIfaceExtCore :: IfL a -> TcRn a
 952 initIfaceExtCore thing_inside
 953   = do  { tcg_env <- getGblEnv
 954         ; let { mod = tcg_mod tcg_env
 955               ; doc = ptext SLIT("External Core file for") <+> quotes (ppr mod)
 956               ; if_env = IfGblEnv {
 957                         if_rec_types = Just (mod, return (tcg_type_env tcg_env)) }
 958               ; if_lenv = mkIfLclEnv mod doc
 959           }
 960         ; setEnvs (if_env, if_lenv) thing_inside }
 961
 962 initIfaceCheck :: HscEnv -> IfG a -> IO a
 963 -- Used when checking the up-to-date-ness of the old Iface
 964 -- Initialise the environment with no useful info at all
 965 initIfaceCheck hsc_env do_this
 966  = do   { let gbl_env = IfGblEnv { if_rec_types = Nothing }
 967         ; initTcRnIf 'i' hsc_env gbl_env () do_this
 968     }
 969
 970 initIfaceTc :: ModIface
 971             -> (TcRef TypeEnv -> IfL a) -> TcRnIf gbl lcl a
 972 -- Used when type-checking checking an up-to-date interface file
 973 -- No type envt from the current module, but we do know the module dependencies
 974 initIfaceTc iface do_this
 975  = do   { tc_env_var <- newMutVar emptyTypeEnv
 976         ; let { gbl_env = IfGblEnv { if_rec_types = Just (mod, readMutVar tc_env_var) } ;
 977               ; if_lenv = mkIfLclEnv mod doc
 978            }
 979         ; setEnvs (gbl_env, if_lenv) (do_this tc_env_var)
 980     }
 981   where
 982     mod = mi_module iface
 983     doc = ptext SLIT("The interface for") <+> quotes (ppr mod)
 984
 985 initIfaceRules :: HscEnv -> ModGuts -> IfG a -> IO a
 986 -- Used when sucking in new Rules in SimplCore
 987 -- We have available the type envt of the module being compiled, and we must use it
 988 initIfaceRules hsc_env guts do_this
 989  = do   { let {
 990              type_info = (mg_module guts, return (mg_types guts))
 991            ; gbl_env = IfGblEnv { if_rec_types = Just type_info } ;
 992            }
 993
 994         -- Run the thing; any exceptions just bubble out from here
 995         ; initTcRnIf 'i' hsc_env gbl_env () do_this
 996     }
 997
 998 initIfaceLcl :: Module -> SDoc -> IfL a -> IfM lcl a
 999 initIfaceLcl mod loc_doc thing_inside
1000   = setLclEnv (mkIfLclEnv mod loc_doc) thing_inside
1001
1002 getIfModule :: IfL Module
1003 getIfModule = do { env <- getLclEnv; return (if_mod env) }
1004
1005 --------------------
1006 failIfM :: Message -> IfL a
1007 -- The Iface monad doesn't have a place to accumulate errors, so we
1008 -- just fall over fast if one happens; it "shouldnt happen".
1009 -- We use IfL here so that we can get context info out of the local env
1010 failIfM msg
1011   = do  { env <- getLclEnv
1012         ; let full_msg = (if_loc env <> colon) $$ nest 2 msg
1013         ; ioToIOEnv (printErrs (full_msg defaultErrStyle))
1014         ; failM }
1015
1016 --------------------
1017 forkM_maybe :: SDoc -> IfL a -> IfL (Maybe a)
1018 -- Run thing_inside in an interleaved thread.
1019 -- It shares everything with the parent thread, so this is DANGEROUS.
1020 --
1021 -- It returns Nothing if the computation fails
1022 --
1023 -- It's used for lazily type-checking interface
1024 -- signatures, which is pretty benign
1025
1026 forkM_maybe doc thing_inside
1027  = do { unsafeInterleaveM $
1028         do { traceIf (text "Starting fork {" <+> doc)
1029            ; mb_res <- tryM $
1030                        updLclEnv (\env -> env { if_loc = if_loc env $$ doc }) $
1031                        thing_inside
1032            ; case mb_res of
1033                 Right r  -> do  { traceIf (text "} ending fork" <+> doc)
1034                                 ; return (Just r) }
1035                 Left exn -> do {
1036
1037                     -- Bleat about errors in the forked thread, if -ddump-if-trace is on
1038                     -- Otherwise we silently discard errors. Errors can legitimately
1039                     -- happen when compiling interface signatures (see tcInterfaceSigs)
1040                       ifOptM Opt_D_dump_if_trace
1041                              (print_errs (hang (text "forkM failed:" <+> doc)
1042                                              4 (text (show exn))))
1043
1044                     ; traceIf (text "} ending fork (badly)" <+> doc)
1045                     ; return Nothing }
1046         }}
1047   where
1048     print_errs sdoc = ioToIOEnv (printErrs (sdoc defaultErrStyle))
1049
1050 forkM :: SDoc -> IfL a -> IfL a
1051 forkM doc thing_inside
1052  = do   { mb_res <- forkM_maybe doc thing_inside
1053         ; return (case mb_res of
1054                         Nothing -> pgmError "Cannot continue after interface file error"
1055                                    -- pprPanic "forkM" doc
1056                         Just r  -> r) }
1057 \end{code}
1058
1059