ghc/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 import HscTypes         ( HscEnv(..), ModGuts(..), ModIface(..),
  14                           TyThing, Dependencies(..), TypeEnv, emptyTypeEnv,
  15                           ExternalPackageState(..), HomePackageTable,
  16                           ModDetails(..), HomeModInfo(..),
  17                           Deprecs(..), FixityEnv, FixItem,
  18                           GhciMode, lookupType, unQualInScope )
  19 import Module           ( Module, ModuleName, unitModuleEnv, foldModuleEnv, emptyModuleEnv )
  20 import RdrName          ( GlobalRdrEnv, emptyGlobalRdrEnv,
  21                           LocalRdrEnv, emptyLocalRdrEnv )
  22 import Name             ( Name, isInternalName )
  23 import Type             ( Type )
  24 import NameEnv          ( extendNameEnvList )
  25 import InstEnv          ( InstEnv, emptyInstEnv, extendInstEnv )
  26
  27 import VarSet           ( emptyVarSet )
  28 import VarEnv           ( TidyEnv, emptyTidyEnv )
  29 import ErrUtils         ( Message, Messages, emptyMessages, errorsFound,
  30                           mkErrMsg, mkWarnMsg, printErrorsAndWarnings,
  31                           mkLocMessage, mkLongErrMsg )
  32 import SrcLoc           ( mkGeneralSrcSpan, isGoodSrcSpan, SrcSpan, Located(..) )
  33 import NameEnv          ( emptyNameEnv )
  34 import NameSet          ( emptyDUs, emptyNameSet )
  35 import OccName          ( emptyOccEnv )
  36 import Module           ( moduleName )
  37 import Bag              ( emptyBag )
  38 import Outputable
  39 import UniqSupply       ( UniqSupply, mkSplitUniqSupply, uniqFromSupply, splitUniqSupply )
  40 import Unique           ( Unique )
  41 import CmdLineOpts      ( DynFlags, DynFlag(..), dopt, opt_PprStyle_Debug, dopt_set )
  42 import Bag              ( snocBag, unionBags )
  43 import Panic            ( showException )
  44
  45 import Maybe            ( isJust )
  46 import IO               ( stderr )
  47 import DATA_IOREF       ( newIORef, readIORef )
  48 import EXCEPTION        ( Exception )
  49 \end{code}
  50
  51
  52
  53 %************************************************************************
  54 %*                                                                      *
  55                         initTc
  56 %*                                                                      *
  57 %************************************************************************
  58
  59 \begin{code}
  60 ioToTcRn :: IO r -> TcRn r
  61 ioToTcRn = ioToIOEnv
  62 \end{code}
  63
  64 \begin{code}
  65 initTc :: HscEnv
  66        -> Module
  67        -> TcM r
  68        -> IO (Messages, Maybe r)
  69                 -- Nothing => error thrown by the thing inside
  70                 -- (error messages should have been printed already)
  71
  72 initTc hsc_env mod do_this
  73  = do { errs_var     <- newIORef (emptyBag, emptyBag) ;
  74         tvs_var      <- newIORef emptyVarSet ;
  75         type_env_var <- newIORef emptyNameEnv ;
  76         dfuns_var    <- newIORef emptyNameSet ;
  77         th_var       <- newIORef False ;
  78
  79         let {
  80              gbl_env = TcGblEnv {
  81                 tcg_mod      = mod,
  82                 tcg_rdr_env  = emptyGlobalRdrEnv,
  83                 tcg_fix_env  = emptyNameEnv,
  84                 tcg_default  = Nothing,
  85                 tcg_type_env = emptyNameEnv,
  86                 tcg_type_env_var = type_env_var,
  87                 tcg_inst_env  = mkImpInstEnv hsc_env,
  88                 tcg_inst_uses = dfuns_var,
  89                 tcg_th_used   = th_var,
  90                 tcg_exports  = emptyNameSet,
  91                 tcg_imports  = init_imports,
  92                 tcg_dus      = emptyDUs,
  93                 tcg_binds    = emptyBag,
  94                 tcg_deprecs  = NoDeprecs,
  95                 tcg_insts    = [],
  96                 tcg_rules    = [],
  97                 tcg_fords    = [],
  98                 tcg_keep     = emptyNameSet
  99              } ;
 100              lcl_env = TcLclEnv {
 101                 tcl_errs       = errs_var,
 102                 tcl_loc        = mkGeneralSrcSpan FSLIT("Top level"),
 103                 tcl_ctxt       = [],
 104                 tcl_rdr        = emptyLocalRdrEnv,
 105                 tcl_th_ctxt    = topStage,
 106                 tcl_arrow_ctxt = topArrowCtxt,
 107                 tcl_env        = emptyNameEnv,
 108                 tcl_tyvars     = tvs_var,
 109                 tcl_lie        = panic "initTc:LIE"     -- LIE only valid inside a getLIE
 110              } ;
 111         } ;
 112
 113         -- OK, here's the business end!
 114         maybe_res <- initTcRnIf 'a' hsc_env gbl_env lcl_env $
 115                              do { r <- tryM do_this
 116                                 ; case r of
 117                                     Right res -> return (Just res)
 118                                     Left _    -> return Nothing } ;
 119
 120         -- Collect any error messages
 121         msgs <- readIORef errs_var ;
 122
 123         let { dflags = hsc_dflags hsc_env
 124             ; final_res | errorsFound dflags msgs = Nothing
 125                         | otherwise               = maybe_res } ;
 126
 127         return (msgs, final_res)
 128     }
 129   where
 130     init_imports = emptyImportAvails { imp_qual = unitModuleEnv mod emptyAvailEnv }
 131         -- Initialise tcg_imports with an empty set of bindings for
 132         -- this module, so that if we see 'module M' in the export
 133         -- list, and there are no bindings in M, we don't bleat
 134         -- "unknown module M".
 135
 136 initTcPrintErrors
 137        :: HscEnv
 138        -> Module
 139        -> TcM r
 140        -> IO (Maybe r)
 141 initTcPrintErrors env mod todo = do
 142   (msgs, res) <- initTc env mod todo
 143   printErrorsAndWarnings msgs
 144   return res
 145
 146 mkImpInstEnv :: HscEnv -> InstEnv
 147 -- At the moment we (wrongly) build an instance environment from all the
 148 -- home-package modules we have already compiled.
 149 -- We should really only get instances from modules below us in the
 150 -- module import tree.
 151 mkImpInstEnv (HscEnv {hsc_dflags = dflags, hsc_HPT = hpt})
 152   = foldModuleEnv (add . md_insts . hm_details) emptyInstEnv hpt
 153   where
 154     add dfuns inst_env = foldl extendInstEnv inst_env dfuns
 155
 156 -- mkImpTypeEnv makes the imported symbol table
 157 mkImpTypeEnv :: ExternalPackageState -> HomePackageTable
 158              -> Name -> Maybe TyThing
 159 mkImpTypeEnv pcs hpt = lookup
 160   where
 161     pte = eps_PTE pcs
 162     lookup name | isInternalName name = Nothing
 163                 | otherwise           = lookupType hpt pte name
 164 \end{code}
 165
 166
 167 %************************************************************************
 168 %*                                                                      *
 169                 Initialisation
 170 %*                                                                      *
 171 %************************************************************************
 172
 173
 174 \begin{code}
 175 initTcRnIf :: Char              -- Tag for unique supply
 176            -> HscEnv
 177            -> gbl -> lcl
 178            -> TcRnIf gbl lcl a
 179            -> IO a
 180 initTcRnIf uniq_tag hsc_env gbl_env lcl_env thing_inside
 181    = do { us     <- mkSplitUniqSupply uniq_tag ;
 182         ; us_var <- newIORef us ;
 183
 184         ; let { env = Env { env_top = hsc_env,
 185                             env_us  = us_var,
 186                             env_gbl = gbl_env,
 187                             env_lcl = lcl_env } }
 188
 189         ; runIOEnv env thing_inside
 190         }
 191 \end{code}
 192
 193 %************************************************************************
 194 %*                                                                      *
 195                 Simple accessors
 196 %*                                                                      *
 197 %************************************************************************
 198
 199 \begin{code}
 200 getTopEnv :: TcRnIf gbl lcl HscEnv
 201 getTopEnv = do { env <- getEnv; return (env_top env) }
 202
 203 getGblEnv :: TcRnIf gbl lcl gbl
 204 getGblEnv = do { env <- getEnv; return (env_gbl env) }
 205
 206 updGblEnv :: (gbl -> gbl) -> TcRnIf gbl lcl a -> TcRnIf gbl lcl a
 207 updGblEnv upd = updEnv (\ env@(Env { env_gbl = gbl }) ->
 208                           env { env_gbl = upd gbl })
 209
 210 setGblEnv :: gbl -> TcRnIf gbl lcl a -> TcRnIf gbl lcl a
 211 setGblEnv gbl_env = updEnv (\ env -> env { env_gbl = gbl_env })
 212
 213 getLclEnv :: TcRnIf gbl lcl lcl
 214 getLclEnv = do { env <- getEnv; return (env_lcl env) }
 215
 216 updLclEnv :: (lcl -> lcl) -> TcRnIf gbl lcl a -> TcRnIf gbl lcl a
 217 updLclEnv upd = updEnv (\ env@(Env { env_lcl = lcl }) ->
 218                           env { env_lcl = upd lcl })
 219
 220 setLclEnv :: lcl' -> TcRnIf gbl lcl' a -> TcRnIf gbl lcl a
 221 setLclEnv lcl_env = updEnv (\ env -> env { env_lcl = lcl_env })
 222
 223 getEnvs :: TcRnIf gbl lcl (gbl, lcl)
 224 getEnvs = do { env <- getEnv; return (env_gbl env, env_lcl env) }
 225
 226 setEnvs :: (gbl', lcl') -> TcRnIf gbl' lcl' a -> TcRnIf gbl lcl a
 227 setEnvs (gbl_env, lcl_env) = updEnv (\ env -> env { env_gbl = gbl_env, env_lcl = lcl_env })
 228 \end{code}
 229
 230
 231 Command-line flags
 232
 233 \begin{code}
 234 getDOpts :: TcRnIf gbl lcl DynFlags
 235 getDOpts = do { env <- getTopEnv; return (hsc_dflags env) }
 236
 237 doptM :: DynFlag -> TcRnIf gbl lcl Bool
 238 doptM flag = do { dflags <- getDOpts; return (dopt flag dflags) }
 239
 240 setOptM :: DynFlag -> TcRnIf gbl lcl a -> TcRnIf gbl lcl a
 241 setOptM flag = updEnv (\ env@(Env { env_top = top }) ->
 242                          env { env_top = top { hsc_dflags = dopt_set (hsc_dflags top) flag}} )
 243
 244 ifOptM :: DynFlag -> TcRnIf gbl lcl () -> TcRnIf gbl lcl ()     -- Do it flag is true
 245 ifOptM flag thing_inside = do { b <- doptM flag;
 246                                 if b then thing_inside else return () }
 247
 248 getGhciMode :: TcRnIf gbl lcl GhciMode
 249 getGhciMode = do { env <- getTopEnv; return (hsc_mode env) }
 250 \end{code}
 251
 252 \begin{code}
 253 getEpsVar :: TcRnIf gbl lcl (TcRef ExternalPackageState)
 254 getEpsVar = do { env <- getTopEnv; return (hsc_EPS env) }
 255
 256 getEps :: TcRnIf gbl lcl ExternalPackageState
 257 getEps = do { env <- getTopEnv; readMutVar (hsc_EPS env) }
 258
 259 setEps :: ExternalPackageState -> TcRnIf gbl lcl ()
 260 setEps eps = do { env <- getTopEnv; writeMutVar (hsc_EPS env) eps }
 261
 262 updateEps :: (ExternalPackageState -> (ExternalPackageState, a))
 263           -> TcRnIf gbl lcl a
 264 updateEps upd_fn = do   { eps_var <- getEpsVar
 265                         ; eps <- readMutVar eps_var
 266                         ; let { (eps', val) = upd_fn eps }
 267                         ; writeMutVar eps_var eps'
 268                         ; return val }
 269
 270 updateEps_ :: (ExternalPackageState -> ExternalPackageState)
 271            -> TcRnIf gbl lcl ()
 272 updateEps_ upd_fn = do  { eps_var <- getEpsVar
 273                         ; updMutVar eps_var upd_fn }
 274
 275 getHpt :: TcRnIf gbl lcl HomePackageTable
 276 getHpt = do { env <- getTopEnv; return (hsc_HPT env) }
 277
 278 getEpsAndHpt :: TcRnIf gbl lcl (ExternalPackageState, HomePackageTable)
 279 getEpsAndHpt = do { env <- getTopEnv; eps <- readMutVar (hsc_EPS env)
 280                   ; return (eps, hsc_HPT env) }
 281 \end{code}
 282
 283 %************************************************************************
 284 %*                                                                      *
 285                 Unique supply
 286 %*                                                                      *
 287 %************************************************************************
 288
 289 \begin{code}
 290 newUnique :: TcRnIf gbl lcl Unique
 291 newUnique = do { us <- newUniqueSupply ;
 292                  return (uniqFromSupply us) }
 293
 294 newUniqueSupply :: TcRnIf gbl lcl UniqSupply
 295 newUniqueSupply
 296  = do { env <- getEnv ;
 297         let { u_var = env_us env } ;
 298         us <- readMutVar u_var ;
 299         let { (us1, us2) = splitUniqSupply us } ;
 300         writeMutVar u_var us1 ;
 301         return us2 }
 302 \end{code}
 303
 304
 305 %************************************************************************
 306 %*                                                                      *
 307                 Debugging
 308 %*                                                                      *
 309 %************************************************************************
 310
 311 \begin{code}
 312 traceTc, traceRn :: SDoc -> TcRn ()
 313 traceRn      = dumpOptTcRn Opt_D_dump_rn_trace
 314 traceTc      = dumpOptTcRn Opt_D_dump_tc_trace
 315 traceSplice  = dumpOptTcRn Opt_D_dump_splices
 316
 317
 318 traceIf :: SDoc -> TcRnIf m n ()
 319 traceIf      = dumpOptIf Opt_D_dump_if_trace
 320 traceHiDiffs = dumpOptIf Opt_D_dump_hi_diffs
 321
 322
 323 dumpOptIf :: DynFlag -> SDoc -> TcRnIf m n ()  -- No RdrEnv available, so qualify everything
 324 dumpOptIf flag doc = ifOptM flag $
 325                      ioToIOEnv (printForUser stderr alwaysQualify doc)
 326
 327 dumpOptTcRn :: DynFlag -> SDoc -> TcRn ()
 328 dumpOptTcRn flag doc = ifOptM flag $ do
 329                         { ctxt <- getErrCtxt
 330                         ; loc  <- getSrcSpanM
 331                         ; ctxt_msgs <- do_ctxt emptyTidyEnv ctxt
 332                         ; let real_doc = mkLocMessage loc (vcat (doc : ctxt_to_use ctxt_msgs))
 333                         ; dumpTcRn real_doc }
 334
 335 dumpTcRn :: SDoc -> TcRn ()
 336 dumpTcRn doc = do { rdr_env <- getGlobalRdrEnv ;
 337                     ioToTcRn (printForUser stderr (unQualInScope rdr_env) doc) }
 338 \end{code}
 339
 340
 341 %************************************************************************
 342 %*                                                                      *
 343                 Typechecker global environment
 344 %*                                                                      *
 345 %************************************************************************
 346
 347 \begin{code}
 348 getModule :: TcRn Module
 349 getModule = do { env <- getGblEnv; return (tcg_mod env) }
 350
 351 getGlobalRdrEnv :: TcRn GlobalRdrEnv
 352 getGlobalRdrEnv = do { env <- getGblEnv; return (tcg_rdr_env env) }
 353
 354 getImports :: TcRn ImportAvails
 355 getImports = do { env <- getGblEnv; return (tcg_imports env) }
 356
 357 getFixityEnv :: TcRn FixityEnv
 358 getFixityEnv = do { env <- getGblEnv; return (tcg_fix_env env) }
 359
 360 extendFixityEnv :: [(Name,FixItem)] -> RnM a -> RnM a
 361 extendFixityEnv new_bit
 362   = updGblEnv (\env@(TcGblEnv { tcg_fix_env = old_fix_env }) ->
 363                 env {tcg_fix_env = extendNameEnvList old_fix_env new_bit})
 364
 365 getDefaultTys :: TcRn (Maybe [Type])
 366 getDefaultTys = do { env <- getGblEnv; return (tcg_default env) }
 367 \end{code}
 368
 369 %************************************************************************
 370 %*                                                                      *
 371                 Error management
 372 %*                                                                      *
 373 %************************************************************************
 374
 375 \begin{code}
 376 getSrcSpanM :: TcRn SrcSpan
 377         -- Avoid clash with Name.getSrcLoc
 378 getSrcSpanM = do { env <- getLclEnv; return (tcl_loc env) }
 379
 380 addSrcSpan :: SrcSpan -> TcRn a -> TcRn a
 381 addSrcSpan loc thing_inside
 382   | isGoodSrcSpan loc = updLclEnv (\env -> env { tcl_loc = loc }) thing_inside
 383   | otherwise         = thing_inside    -- Don't overwrite useful info with useless
 384
 385 addLocM :: (a -> TcM b) -> Located a -> TcM b
 386 addLocM fn (L loc a) = addSrcSpan loc $ fn a
 387
 388 wrapLocM :: (a -> TcM b) -> Located a -> TcM (Located b)
 389 wrapLocM fn (L loc a) = addSrcSpan loc $ do b <- fn a; return (L loc b)
 390
 391 wrapLocFstM :: (a -> TcM (b,c)) -> Located a -> TcM (Located b, c)
 392 wrapLocFstM fn (L loc a) =
 393   addSrcSpan loc $ do
 394     (b,c) <- fn a
 395     return (L loc b, c)
 396
 397 wrapLocSndM :: (a -> TcM (b,c)) -> Located a -> TcM (b, Located c)
 398 wrapLocSndM fn (L loc a) =
 399   addSrcSpan loc $ do
 400     (b,c) <- fn a
 401     return (b, L loc c)
 402 \end{code}
 403
 404
 405 \begin{code}
 406 getErrsVar :: TcRn (TcRef Messages)
 407 getErrsVar = do { env <- getLclEnv; return (tcl_errs env) }
 408
 409 setErrsVar :: TcRef Messages -> TcRn a -> TcRn a
 410 setErrsVar v = updLclEnv (\ env -> env { tcl_errs =  v })
 411
 412 addErr :: Message -> TcRn ()
 413 addErr msg = do { loc <- getSrcSpanM ; addErrAt loc msg }
 414
 415 addLocErr :: Located e -> (e -> Message) -> TcRn ()
 416 addLocErr (L loc e) fn = addErrAt loc (fn e)
 417
 418 addErrAt :: SrcSpan -> Message -> TcRn ()
 419 addErrAt loc msg = addLongErrAt loc msg empty
 420
 421 addLongErrAt :: SrcSpan -> Message -> Message -> TcRn ()
 422 addLongErrAt loc msg extra
 423  = do {  errs_var <- getErrsVar ;
 424          rdr_env <- getGlobalRdrEnv ;
 425          let { err = mkLongErrMsg loc (unQualInScope rdr_env) msg extra } ;
 426          (warns, errs) <- readMutVar errs_var ;
 427          writeMutVar errs_var (warns, errs `snocBag` err) }
 428
 429 addErrs :: [(SrcSpan,Message)] -> TcRn ()
 430 addErrs msgs = mappM_ add msgs
 431              where
 432                add (loc,msg) = addErrAt loc msg
 433
 434 addReport :: Message -> TcRn ()
 435 addReport msg = do loc <- getSrcSpanM; addReportAt loc msg
 436
 437 addReportAt :: SrcSpan -> Message -> TcRn ()
 438 addReportAt loc msg
 439   = do { errs_var <- getErrsVar ;
 440          rdr_env <- getGlobalRdrEnv ;
 441          let { warn = mkWarnMsg loc (unQualInScope rdr_env) msg } ;
 442          (warns, errs) <- readMutVar errs_var ;
 443          writeMutVar errs_var (warns `snocBag` warn, errs) }
 444
 445 addWarn :: Message -> TcRn ()
 446 addWarn msg = addReport (ptext SLIT("Warning:") <+> msg)
 447
 448 addWarnAt :: SrcSpan -> Message -> TcRn ()
 449 addWarnAt loc msg = addReportAt loc (ptext SLIT("Warning:") <+> msg)
 450
 451 addLocWarn :: Located e -> (e -> Message) -> TcRn ()
 452 addLocWarn (L loc e) fn = addReportAt loc (fn e)
 453
 454 checkErr :: Bool -> Message -> TcRn ()
 455 -- Add the error if the bool is False
 456 checkErr ok msg = checkM ok (addErr msg)
 457
 458 warnIf :: Bool -> Message -> TcRn ()
 459 warnIf True  msg = addWarn msg
 460 warnIf False msg = return ()
 461
 462 addMessages :: Messages -> TcRn ()
 463 addMessages (m_warns, m_errs)
 464   = do { errs_var <- getErrsVar ;
 465          (warns, errs) <- readMutVar errs_var ;
 466          writeMutVar errs_var (warns `unionBags` m_warns,
 467                                errs  `unionBags` m_errs) }
 468
 469 discardWarnings :: TcRn a -> TcRn a
 470 -- Ignore warnings inside the thing inside;
 471 -- used to ignore-unused-variable warnings inside derived code
 472 -- With -dppr-debug, the effects is switched off, so you can still see
 473 -- what warnings derived code would give
 474 discardWarnings thing_inside
 475   | opt_PprStyle_Debug = thing_inside
 476   | otherwise
 477   = do  { errs_var <- newMutVar emptyMessages
 478         ; result <- setErrsVar errs_var thing_inside
 479         ; (_warns, errs) <- readMutVar errs_var
 480         ; addMessages (emptyBag, errs)
 481         ; return result }
 482 \end{code}
 483
 484
 485 \begin{code}
 486 recoverM :: TcRn r      -- Recovery action; do this if the main one fails
 487          -> TcRn r      -- Main action: do this first
 488          -> TcRn r
 489 recoverM recover thing
 490   = do { mb_res <- try_m thing ;
 491          case mb_res of
 492            Left exn  -> recover
 493            Right res -> returnM res }
 494
 495 tryTc :: TcRn a -> TcRn (Messages, Maybe a)
 496     -- (tryTc m) executes m, and returns
 497     --  Just r,  if m succeeds (returning r) and caused no errors
 498     --  Nothing, if m fails, or caused errors
 499     -- It also returns all the errors accumulated by m
 500     --  (even in the Just case, there might be warnings)
 501     --
 502     -- It always succeeds (never raises an exception)
 503 tryTc m
 504  = do { errs_var <- newMutVar emptyMessages ;
 505
 506         mb_r <- try_m (setErrsVar errs_var m) ;
 507
 508         new_errs <- readMutVar errs_var ;
 509
 510         dflags <- getDOpts ;
 511
 512         return (new_errs,
 513                 case mb_r of
 514                   Left exn -> Nothing
 515                   Right r | errorsFound dflags new_errs -> Nothing
 516                           | otherwise                   -> Just r)
 517    }
 518
 519 try_m :: TcRn r -> TcRn (Either Exception r)
 520 -- Does try_m, with a debug-trace on failure
 521 try_m thing
 522   = do { mb_r <- tryM thing ;
 523          case mb_r of
 524              Left exn -> do { traceTc (exn_msg exn); return mb_r }
 525              Right r  -> return mb_r }
 526   where
 527     exn_msg exn = text "tryTc/recoverM recovering from" <+> text (showException exn)
 528
 529 tryTcLIE :: TcM a -> TcM (Messages, Maybe a)
 530 -- Just like tryTc, except that it ensures that the LIE
 531 -- for the thing is propagated only if there are no errors
 532 -- Hence it's restricted to the type-check monad
 533 tryTcLIE thing_inside
 534   = do { ((errs, mb_r), lie) <- getLIE (tryTc thing_inside) ;
 535          ifM (isJust mb_r) (extendLIEs lie) ;
 536          return (errs, mb_r) }
 537
 538 tryTcLIE_ :: TcM r -> TcM r -> TcM r
 539 -- (tryTcLIE_ r m) tries m; if it succeeds it returns it,
 540 -- otherwise it returns r.  Any error messages added by m are discarded,
 541 -- whether or not m succeeds.
 542 tryTcLIE_ recover main
 543   = do { (_msgs, mb_res) <- tryTcLIE main ;
 544          case mb_res of
 545            Just res -> return res
 546            Nothing  -> recover }
 547
 548 checkNoErrs :: TcM r -> TcM r
 549 -- (checkNoErrs m) succeeds iff m succeeds and generates no errors
 550 -- If m fails then (checkNoErrsTc m) fails.
 551 -- If m succeeds, it checks whether m generated any errors messages
 552 --      (it might have recovered internally)
 553 --      If so, it fails too.
 554 -- Regardless, any errors generated by m are propagated to the enclosing context.
 555 checkNoErrs main
 556   = do { (msgs, mb_res) <- tryTcLIE main ;
 557          addMessages msgs ;
 558          case mb_res of
 559            Just r  -> return r
 560            Nothing -> failM
 561    }
 562
 563 ifErrsM :: TcRn r -> TcRn r -> TcRn r
 564 --      ifErrsM bale_out main
 565 -- does 'bale_out' if there are errors in errors collection
 566 -- otherwise does 'main'
 567 ifErrsM bale_out normal
 568  = do { errs_var <- getErrsVar ;
 569         msgs <- readMutVar errs_var ;
 570         dflags <- getDOpts ;
 571         if errorsFound dflags msgs then
 572            bale_out
 573         else
 574            normal }
 575
 576 failIfErrsM :: TcRn ()
 577 -- Useful to avoid error cascades
 578 failIfErrsM = ifErrsM failM (return ())
 579 \end{code}
 580
 581
 582 %************************************************************************
 583 %*                                                                      *
 584         Context management and error message generation
 585                     for the type checker
 586 %*                                                                      *
 587 %************************************************************************
 588
 589 \begin{code}
 590 setErrCtxtM, addErrCtxtM :: (TidyEnv -> TcM (TidyEnv, Message)) -> TcM a -> TcM a
 591 setErrCtxtM msg = updCtxt (\ msgs -> [msg])
 592 addErrCtxtM msg = updCtxt (\ msgs -> msg : msgs)
 593
 594 setErrCtxt, addErrCtxt :: Message -> TcM a -> TcM a
 595 setErrCtxt msg = setErrCtxtM (\env -> returnM (env, msg))
 596 addErrCtxt msg = addErrCtxtM (\env -> returnM (env, msg))
 597
 598 popErrCtxt :: TcM a -> TcM a
 599 popErrCtxt = updCtxt (\ msgs -> case msgs of { [] -> []; (m:ms) -> ms })
 600
 601 getErrCtxt :: TcM ErrCtxt
 602 getErrCtxt = do { env <- getLclEnv ; return (tcl_ctxt env) }
 603
 604 -- Helper function for the above
 605 updCtxt :: (ErrCtxt -> ErrCtxt) -> TcM a -> TcM a
 606 updCtxt upd = updLclEnv (\ env@(TcLclEnv { tcl_ctxt = ctxt }) ->
 607                            env { tcl_ctxt = upd ctxt })
 608
 609 getInstLoc :: InstOrigin -> TcM InstLoc
 610 getInstLoc origin
 611   = do { loc <- getSrcSpanM ; env <- getLclEnv ;
 612          return (InstLoc origin loc (tcl_ctxt env)) }
 613
 614 addInstCtxt :: InstLoc -> TcM a -> TcM a
 615 -- Add the SrcSpan and context from the first Inst in the list
 616 --      (they all have similar locations)
 617 addInstCtxt (InstLoc _ src_loc ctxt) thing_inside
 618   = addSrcSpan src_loc (updCtxt (\ old_ctxt -> ctxt) thing_inside)
 619 \end{code}
 620
 621     The addErrTc functions add an error message, but do not cause failure.
 622     The 'M' variants pass a TidyEnv that has already been used to
 623     tidy up the message; we then use it to tidy the context messages
 624
 625 \begin{code}
 626 addErrTc :: Message -> TcM ()
 627 addErrTc err_msg = addErrTcM (emptyTidyEnv, err_msg)
 628
 629 addErrsTc :: [Message] -> TcM ()
 630 addErrsTc err_msgs = mappM_ addErrTc err_msgs
 631
 632 addErrTcM :: (TidyEnv, Message) -> TcM ()
 633 addErrTcM (tidy_env, err_msg)
 634   = do { ctxt <- getErrCtxt ;
 635          loc  <- getSrcSpanM ;
 636          add_err_tcm tidy_env err_msg loc ctxt }
 637 \end{code}
 638
 639 The failWith functions add an error message and cause failure
 640
 641 \begin{code}
 642 failWithTc :: Message -> TcM a               -- Add an error message and fail
 643 failWithTc err_msg
 644   = addErrTc err_msg >> failM
 645
 646 failWithTcM :: (TidyEnv, Message) -> TcM a   -- Add an error message and fail
 647 failWithTcM local_and_msg
 648   = addErrTcM local_and_msg >> failM
 649
 650 checkTc :: Bool -> Message -> TcM ()         -- Check that the boolean is true
 651 checkTc True  err = returnM ()
 652 checkTc False err = failWithTc err
 653 \end{code}
 654
 655         Warnings have no 'M' variant, nor failure
 656
 657 \begin{code}
 658 addWarnTc :: Message -> TcM ()
 659 addWarnTc msg
 660  = do { ctxt <- getErrCtxt ;
 661         ctxt_msgs <- do_ctxt emptyTidyEnv ctxt ;
 662         addWarn (vcat (msg : ctxt_to_use ctxt_msgs)) }
 663
 664 warnTc :: Bool -> Message -> TcM ()
 665 warnTc warn_if_true warn_msg
 666   | warn_if_true = addWarnTc warn_msg
 667   | otherwise    = return ()
 668 \end{code}
 669
 670         Helper functions
 671
 672 \begin{code}
 673 add_err_tcm tidy_env err_msg loc ctxt
 674  = do { ctxt_msgs <- do_ctxt tidy_env ctxt ;
 675         addLongErrAt loc err_msg (vcat (ctxt_to_use ctxt_msgs)) }
 676
 677 do_ctxt tidy_env []
 678  = return []
 679 do_ctxt tidy_env (c:cs)
 680  = do { (tidy_env', m) <- c tidy_env  ;
 681         ms             <- do_ctxt tidy_env' cs  ;
 682         return (m:ms) }
 683
 684 ctxt_to_use ctxt | opt_PprStyle_Debug = ctxt
 685                  | otherwise          = take 3 ctxt
 686 \end{code}
 687
 688 %************************************************************************
 689 %*                                                                      *
 690              Type constraints (the so-called LIE)
 691 %*                                                                      *
 692 %************************************************************************
 693
 694 \begin{code}
 695 getLIEVar :: TcM (TcRef LIE)
 696 getLIEVar = do { env <- getLclEnv; return (tcl_lie env) }
 697
 698 setLIEVar :: TcRef LIE -> TcM a -> TcM a
 699 setLIEVar lie_var = updLclEnv (\ env -> env { tcl_lie = lie_var })
 700
 701 getLIE :: TcM a -> TcM (a, [Inst])
 702 -- (getLIE m) runs m, and returns the type constraints it generates
 703 getLIE thing_inside
 704   = do { lie_var <- newMutVar emptyLIE ;
 705          res <- updLclEnv (\ env -> env { tcl_lie = lie_var })
 706                           thing_inside ;
 707          lie <- readMutVar lie_var ;
 708          return (res, lieToList lie) }
 709
 710 extendLIE :: Inst -> TcM ()
 711 extendLIE inst
 712   = do { lie_var <- getLIEVar ;
 713          lie <- readMutVar lie_var ;
 714          writeMutVar lie_var (inst `consLIE` lie) }
 715
 716 extendLIEs :: [Inst] -> TcM ()
 717 extendLIEs []
 718   = returnM ()
 719 extendLIEs insts
 720   = do { lie_var <- getLIEVar ;
 721          lie <- readMutVar lie_var ;
 722          writeMutVar lie_var (mkLIE insts `plusLIE` lie) }
 723 \end{code}
 724
 725 \begin{code}
 726 setLclTypeEnv :: TcLclEnv -> TcM a -> TcM a
 727 -- Set the local type envt, but do *not* disturb other fields,
 728 -- notably the lie_var
 729 setLclTypeEnv lcl_env thing_inside
 730   = updLclEnv upd thing_inside
 731   where
 732     upd env = env { tcl_env = tcl_env lcl_env,
 733                     tcl_tyvars = tcl_tyvars lcl_env }
 734 \end{code}
 735
 736
 737 %************************************************************************
 738 %*                                                                      *
 739              Template Haskell context
 740 %*                                                                      *
 741 %************************************************************************
 742
 743 \begin{code}
 744 recordThUse :: TcM ()
 745 recordThUse = do { env <- getGblEnv; writeMutVar (tcg_th_used env) True }
 746
 747 getStage :: TcM ThStage
 748 getStage = do { env <- getLclEnv; return (tcl_th_ctxt env) }
 749
 750 setStage :: ThStage -> TcM a -> TcM a
 751 setStage s = updLclEnv (\ env -> env { tcl_th_ctxt = s })
 752 \end{code}
 753
 754
 755 %************************************************************************
 756 %*                                                                      *
 757              Arrow context
 758 %*                                                                      *
 759 %************************************************************************
 760
 761 \begin{code}
 762 popArrowBinders :: TcM a -> TcM a       -- Move to the left of a (-<); see comments in TcRnTypes
 763 popArrowBinders
 764   = updLclEnv (\ env -> env { tcl_arrow_ctxt = pop (tcl_arrow_ctxt env)  })
 765   where
 766     pop (ArrCtxt {proc_level = curr_lvl, proc_banned = banned})
 767         = ASSERT( not (curr_lvl `elem` banned) )
 768           ArrCtxt {proc_level = curr_lvl, proc_banned = curr_lvl : banned}
 769
 770 getBannedProcLevels :: TcM [ProcLevel]
 771   = do { env <- getLclEnv; return (proc_banned (tcl_arrow_ctxt env)) }
 772
 773 incProcLevel :: TcM a -> TcM a
 774 incProcLevel
 775   = updLclEnv (\ env -> env { tcl_arrow_ctxt = inc (tcl_arrow_ctxt env) })
 776   where
 777     inc ctxt = ctxt { proc_level = proc_level ctxt + 1 }
 778 \end{code}
 779
 780
 781 %************************************************************************
 782 %*                                                                      *
 783              Stuff for the renamer's local env
 784 %*                                                                      *
 785 %************************************************************************
 786
 787 \begin{code}
 788 getLocalRdrEnv :: RnM LocalRdrEnv
 789 getLocalRdrEnv = do { env <- getLclEnv; return (tcl_rdr env) }
 790
 791 setLocalRdrEnv :: LocalRdrEnv -> RnM a -> RnM a
 792 setLocalRdrEnv rdr_env thing_inside
 793   = updLclEnv (\env -> env {tcl_rdr = rdr_env}) thing_inside
 794 \end{code}
 795
 796
 797 %************************************************************************
 798 %*                                                                      *
 799              Stuff for interface decls
 800 %*                                                                      *
 801 %************************************************************************
 802
 803 \begin{code}
 804 initIfaceTcRn :: IfG a -> TcRn a
 805 initIfaceTcRn thing_inside
 806   = do  { tcg_env <- getGblEnv
 807         ; let { if_env = IfGblEnv {
 808                         if_rec_types = Just (tcg_mod tcg_env, get_type_env),
 809                         if_is_boot   = imp_dep_mods (tcg_imports tcg_env) }
 810               ; get_type_env = readMutVar (tcg_type_env_var tcg_env) }
 811         ; setEnvs (if_env, ()) thing_inside }
 812
 813 initIfaceExtCore :: IfL a -> TcRn a
 814 initIfaceExtCore thing_inside
 815   = do  { tcg_env <- getGblEnv
 816         ; let { mod = tcg_mod tcg_env
 817               ; if_env = IfGblEnv {
 818                         if_rec_types = Just (mod, return (tcg_type_env tcg_env)),
 819                         if_is_boot   = imp_dep_mods (tcg_imports tcg_env) }
 820               ; if_lenv = IfLclEnv { if_mod     = moduleName mod,
 821                                      if_tv_env  = emptyOccEnv,
 822                                      if_id_env  = emptyOccEnv }
 823           }
 824         ; setEnvs (if_env, if_lenv) thing_inside }
 825
 826 initIfaceCheck :: HscEnv -> IfG a -> IO a
 827 -- Used when checking the up-to-date-ness of the old Iface
 828 -- Initialise the environment with no useful info at all
 829 initIfaceCheck hsc_env do_this
 830  = do   { let { gbl_env = IfGblEnv { if_is_boot   = emptyModuleEnv,
 831                                      if_rec_types = Nothing } ;
 832            }
 833         ; initTcRnIf 'i' hsc_env gbl_env () do_this
 834     }
 835
 836 initIfaceTc :: HscEnv -> ModIface
 837             -> (TcRef TypeEnv -> IfL a) -> IO a
 838 -- Used when type-checking checking an up-to-date interface file
 839 -- No type envt from the current module, but we do know the module dependencies
 840 initIfaceTc hsc_env iface do_this
 841  = do   { tc_env_var <- newIORef emptyTypeEnv
 842         ; let { gbl_env = IfGblEnv { if_is_boot   = mkModDeps (dep_mods (mi_deps iface)),
 843                                      if_rec_types = Just (mod, readMutVar tc_env_var) } ;
 844               ; if_lenv = IfLclEnv { if_mod     = moduleName mod,
 845                                      if_tv_env  = emptyOccEnv,
 846                                      if_id_env  = emptyOccEnv }
 847            }
 848         ; initTcRnIf 'i' hsc_env gbl_env if_lenv (do_this tc_env_var)
 849     }
 850   where
 851     mod = mi_module iface
 852
 853 initIfaceRules :: HscEnv -> ModGuts -> IfG a -> IO a
 854 -- Used when sucking in new Rules in SimplCore
 855 -- We have available the type envt of the module being compiled, and we must use it
 856 initIfaceRules hsc_env guts do_this
 857  = do   { let {
 858              is_boot = mkModDeps (dep_mods (mg_deps guts))
 859                         -- Urgh!  But we do somehow need to get the info
 860                         -- on whether (for this particular compilation) we should
 861                         -- import a hi-boot file or not.
 862            ; type_info = (mg_module guts, return (mg_types guts))
 863            ; gbl_env = IfGblEnv { if_is_boot   = is_boot,
 864                                   if_rec_types = Just type_info } ;
 865            }
 866
 867         -- Run the thing; any exceptions just bubble out from here
 868         ; initTcRnIf 'i' hsc_env gbl_env () do_this
 869     }
 870
 871 initIfaceLcl :: ModuleName -> IfL a -> IfM lcl a
 872 initIfaceLcl mod thing_inside
 873   = setLclEnv (IfLclEnv { if_mod      = mod,
 874                            if_tv_env  = emptyOccEnv,
 875                            if_id_env  = emptyOccEnv })
 876               thing_inside
 877
 878
 879 --------------------
 880 forkM_maybe :: SDoc -> IfL a -> IfL (Maybe a)
 881 -- Run thing_inside in an interleaved thread.
 882 -- It shares everything with the parent thread, so this is DANGEROUS.
 883 --
 884 -- It returns Nothing if the computation fails
 885 --
 886 -- It's used for lazily type-checking interface
 887 -- signatures, which is pretty benign
 888
 889 forkM_maybe doc thing_inside
 890  = do { unsafeInterleaveM $
 891         do { traceIf (text "Starting fork {" <+> doc)
 892            ; mb_res <- tryM thing_inside ;
 893              case mb_res of
 894                 Right r  -> do  { traceIf (text "} ending fork" <+> doc)
 895                                 ; return (Just r) }
 896                 Left exn -> do {
 897
 898                     -- Bleat about errors in the forked thread, if -ddump-if-trace is on
 899                     -- Otherwise we silently discard errors. Errors can legitimately
 900                     -- happen when compiling interface signatures (see tcInterfaceSigs)
 901                       ifOptM Opt_D_dump_if_trace
 902                              (print_errs (hang (text "forkM failed:" <+> doc)
 903                                              4 (text (show exn))))
 904
 905                     ; traceIf (text "} ending fork (badly)" <+> doc)
 906                     ; return Nothing }
 907         }}
 908   where
 909     print_errs sdoc = ioToIOEnv (printErrs (sdoc defaultErrStyle))
 910
 911 forkM :: SDoc -> IfL a -> IfL a
 912 forkM doc thing_inside
 913  = do   { mb_res <- forkM_maybe doc thing_inside
 914         ; return (case mb_res of
 915                         Nothing -> pprPanic "forkM" doc
 916                         Just r  -> r) }
 917 \end{code}