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