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 -- Updating the EPS.  This should be an atomic operation.
 260 -- Note the delicate 'seq' which forces the EPS before putting it in the
 261 -- variable.  Otherwise what happens is that we get
 262 --      write eps_var (....(unsafeRead eps_var)....)
 263 -- and if the .... is strict, that's obviously bottom.  By forcing it beforehand
 264 -- we make the unsafeRead happen before we update the variable.
 265
 266 updateEps :: (ExternalPackageState -> (ExternalPackageState, a))
 267           -> TcRnIf gbl lcl a
 268 updateEps upd_fn = do   { traceIf (text "updating EPS")
 269                         ; eps_var <- getEpsVar
 270                         ; eps <- readMutVar eps_var
 271                         ; let { (eps', val) = upd_fn eps }
 272                         ; seq eps' (writeMutVar eps_var eps')
 273                         ; return val }
 274
 275 updateEps_ :: (ExternalPackageState -> ExternalPackageState)
 276            -> TcRnIf gbl lcl ()
 277 updateEps_ upd_fn = do  { traceIf (text "updating EPS_")
 278                         ; eps_var <- getEpsVar
 279                         ; eps <- readMutVar eps_var
 280                         ; let { eps' = upd_fn eps }
 281                         ; seq eps' (writeMutVar eps_var eps') }
 282
 283 getHpt :: TcRnIf gbl lcl HomePackageTable
 284 getHpt = do { env <- getTopEnv; return (hsc_HPT env) }
 285
 286 getEpsAndHpt :: TcRnIf gbl lcl (ExternalPackageState, HomePackageTable)
 287 getEpsAndHpt = do { env <- getTopEnv; eps <- readMutVar (hsc_EPS env)
 288                   ; return (eps, hsc_HPT env) }
 289 \end{code}
 290
 291 %************************************************************************
 292 %*                                                                      *
 293                 Unique supply
 294 %*                                                                      *
 295 %************************************************************************
 296
 297 \begin{code}
 298 newUnique :: TcRnIf gbl lcl Unique
 299 newUnique = do { us <- newUniqueSupply ;
 300                  return (uniqFromSupply us) }
 301
 302 newUniqueSupply :: TcRnIf gbl lcl UniqSupply
 303 newUniqueSupply
 304  = do { env <- getEnv ;
 305         let { u_var = env_us env } ;
 306         us <- readMutVar u_var ;
 307         let { (us1, us2) = splitUniqSupply us } ;
 308         writeMutVar u_var us1 ;
 309         return us2 }
 310 \end{code}
 311
 312
 313 %************************************************************************
 314 %*                                                                      *
 315                 Debugging
 316 %*                                                                      *
 317 %************************************************************************
 318
 319 \begin{code}
 320 traceTc, traceRn :: SDoc -> TcRn ()
 321 traceRn      = dumpOptTcRn Opt_D_dump_rn_trace
 322 traceTc      = dumpOptTcRn Opt_D_dump_tc_trace
 323 traceSplice  = dumpOptTcRn Opt_D_dump_splices
 324
 325
 326 traceIf :: SDoc -> TcRnIf m n ()
 327 traceIf      = dumpOptIf Opt_D_dump_if_trace
 328 traceHiDiffs = dumpOptIf Opt_D_dump_hi_diffs
 329
 330
 331 dumpOptIf :: DynFlag -> SDoc -> TcRnIf m n ()  -- No RdrEnv available, so qualify everything
 332 dumpOptIf flag doc = ifOptM flag $
 333                      ioToIOEnv (printForUser stderr alwaysQualify doc)
 334
 335 dumpOptTcRn :: DynFlag -> SDoc -> TcRn ()
 336 dumpOptTcRn flag doc = ifOptM flag $ do
 337                         { ctxt <- getErrCtxt
 338                         ; loc  <- getSrcSpanM
 339                         ; ctxt_msgs <- do_ctxt emptyTidyEnv ctxt
 340                         ; let real_doc = mkLocMessage loc (vcat (doc : ctxt_to_use ctxt_msgs))
 341                         ; dumpTcRn real_doc }
 342
 343 dumpTcRn :: SDoc -> TcRn ()
 344 dumpTcRn doc = do { rdr_env <- getGlobalRdrEnv ;
 345                     ioToTcRn (printForUser stderr (unQualInScope rdr_env) doc) }
 346 \end{code}
 347
 348
 349 %************************************************************************
 350 %*                                                                      *
 351                 Typechecker global environment
 352 %*                                                                      *
 353 %************************************************************************
 354
 355 \begin{code}
 356 getModule :: TcRn Module
 357 getModule = do { env <- getGblEnv; return (tcg_mod env) }
 358
 359 getGlobalRdrEnv :: TcRn GlobalRdrEnv
 360 getGlobalRdrEnv = do { env <- getGblEnv; return (tcg_rdr_env env) }
 361
 362 getImports :: TcRn ImportAvails
 363 getImports = do { env <- getGblEnv; return (tcg_imports env) }
 364
 365 getFixityEnv :: TcRn FixityEnv
 366 getFixityEnv = do { env <- getGblEnv; return (tcg_fix_env env) }
 367
 368 extendFixityEnv :: [(Name,FixItem)] -> RnM a -> RnM a
 369 extendFixityEnv new_bit
 370   = updGblEnv (\env@(TcGblEnv { tcg_fix_env = old_fix_env }) ->
 371                 env {tcg_fix_env = extendNameEnvList old_fix_env new_bit})
 372
 373 getDefaultTys :: TcRn (Maybe [Type])
 374 getDefaultTys = do { env <- getGblEnv; return (tcg_default env) }
 375 \end{code}
 376
 377 %************************************************************************
 378 %*                                                                      *
 379                 Error management
 380 %*                                                                      *
 381 %************************************************************************
 382
 383 \begin{code}
 384 getSrcSpanM :: TcRn SrcSpan
 385         -- Avoid clash with Name.getSrcLoc
 386 getSrcSpanM = do { env <- getLclEnv; return (tcl_loc env) }
 387
 388 addSrcSpan :: SrcSpan -> TcRn a -> TcRn a
 389 addSrcSpan loc thing_inside
 390   | isGoodSrcSpan loc = updLclEnv (\env -> env { tcl_loc = loc }) thing_inside
 391   | otherwise         = thing_inside    -- Don't overwrite useful info with useless
 392
 393 addLocM :: (a -> TcM b) -> Located a -> TcM b
 394 addLocM fn (L loc a) = addSrcSpan loc $ fn a
 395
 396 wrapLocM :: (a -> TcM b) -> Located a -> TcM (Located b)
 397 wrapLocM fn (L loc a) = addSrcSpan loc $ do b <- fn a; return (L loc b)
 398
 399 wrapLocFstM :: (a -> TcM (b,c)) -> Located a -> TcM (Located b, c)
 400 wrapLocFstM fn (L loc a) =
 401   addSrcSpan loc $ do
 402     (b,c) <- fn a
 403     return (L loc b, c)
 404
 405 wrapLocSndM :: (a -> TcM (b,c)) -> Located a -> TcM (b, Located c)
 406 wrapLocSndM fn (L loc a) =
 407   addSrcSpan loc $ do
 408     (b,c) <- fn a
 409     return (b, L loc c)
 410 \end{code}
 411
 412
 413 \begin{code}
 414 getErrsVar :: TcRn (TcRef Messages)
 415 getErrsVar = do { env <- getLclEnv; return (tcl_errs env) }
 416
 417 setErrsVar :: TcRef Messages -> TcRn a -> TcRn a
 418 setErrsVar v = updLclEnv (\ env -> env { tcl_errs =  v })
 419
 420 addErr :: Message -> TcRn ()
 421 addErr msg = do { loc <- getSrcSpanM ; addErrAt loc msg }
 422
 423 addLocErr :: Located e -> (e -> Message) -> TcRn ()
 424 addLocErr (L loc e) fn = addErrAt loc (fn e)
 425
 426 addErrAt :: SrcSpan -> Message -> TcRn ()
 427 addErrAt loc msg = addLongErrAt loc msg empty
 428
 429 addLongErrAt :: SrcSpan -> Message -> Message -> TcRn ()
 430 addLongErrAt loc msg extra
 431  = do {  errs_var <- getErrsVar ;
 432          rdr_env <- getGlobalRdrEnv ;
 433          let { err = mkLongErrMsg loc (unQualInScope rdr_env) msg extra } ;
 434          (warns, errs) <- readMutVar errs_var ;
 435          writeMutVar errs_var (warns, errs `snocBag` err) }
 436
 437 addErrs :: [(SrcSpan,Message)] -> TcRn ()
 438 addErrs msgs = mappM_ add msgs
 439              where
 440                add (loc,msg) = addErrAt loc msg
 441
 442 addReport :: Message -> TcRn ()
 443 addReport msg = do loc <- getSrcSpanM; addReportAt loc msg
 444
 445 addReportAt :: SrcSpan -> Message -> TcRn ()
 446 addReportAt loc msg
 447   = do { errs_var <- getErrsVar ;
 448          rdr_env <- getGlobalRdrEnv ;
 449          let { warn = mkWarnMsg loc (unQualInScope rdr_env) msg } ;
 450          (warns, errs) <- readMutVar errs_var ;
 451          writeMutVar errs_var (warns `snocBag` warn, errs) }
 452
 453 addWarn :: Message -> TcRn ()
 454 addWarn msg = addReport (ptext SLIT("Warning:") <+> msg)
 455
 456 addWarnAt :: SrcSpan -> Message -> TcRn ()
 457 addWarnAt loc msg = addReportAt loc (ptext SLIT("Warning:") <+> msg)
 458
 459 addLocWarn :: Located e -> (e -> Message) -> TcRn ()
 460 addLocWarn (L loc e) fn = addReportAt loc (fn e)
 461
 462 checkErr :: Bool -> Message -> TcRn ()
 463 -- Add the error if the bool is False
 464 checkErr ok msg = checkM ok (addErr msg)
 465
 466 warnIf :: Bool -> Message -> TcRn ()
 467 warnIf True  msg = addWarn msg
 468 warnIf False msg = return ()
 469
 470 addMessages :: Messages -> TcRn ()
 471 addMessages (m_warns, m_errs)
 472   = do { errs_var <- getErrsVar ;
 473          (warns, errs) <- readMutVar errs_var ;
 474          writeMutVar errs_var (warns `unionBags` m_warns,
 475                                errs  `unionBags` m_errs) }
 476
 477 discardWarnings :: TcRn a -> TcRn a
 478 -- Ignore warnings inside the thing inside;
 479 -- used to ignore-unused-variable warnings inside derived code
 480 -- With -dppr-debug, the effects is switched off, so you can still see
 481 -- what warnings derived code would give
 482 discardWarnings thing_inside
 483   | opt_PprStyle_Debug = thing_inside
 484   | otherwise
 485   = do  { errs_var <- newMutVar emptyMessages
 486         ; result <- setErrsVar errs_var thing_inside
 487         ; (_warns, errs) <- readMutVar errs_var
 488         ; addMessages (emptyBag, errs)
 489         ; return result }
 490 \end{code}
 491
 492
 493 \begin{code}
 494 recoverM :: TcRn r      -- Recovery action; do this if the main one fails
 495          -> TcRn r      -- Main action: do this first
 496          -> TcRn r
 497 recoverM recover thing
 498   = do { mb_res <- try_m thing ;
 499          case mb_res of
 500            Left exn  -> recover
 501            Right res -> returnM res }
 502
 503 tryTc :: TcRn a -> TcRn (Messages, Maybe a)
 504     -- (tryTc m) executes m, and returns
 505     --  Just r,  if m succeeds (returning r) and caused no errors
 506     --  Nothing, if m fails, or caused errors
 507     -- It also returns all the errors accumulated by m
 508     --  (even in the Just case, there might be warnings)
 509     --
 510     -- It always succeeds (never raises an exception)
 511 tryTc m
 512  = do { errs_var <- newMutVar emptyMessages ;
 513
 514         mb_r <- try_m (setErrsVar errs_var m) ;
 515
 516         new_errs <- readMutVar errs_var ;
 517
 518         dflags <- getDOpts ;
 519
 520         return (new_errs,
 521                 case mb_r of
 522                   Left exn -> Nothing
 523                   Right r | errorsFound dflags new_errs -> Nothing
 524                           | otherwise                   -> Just r)
 525    }
 526
 527 try_m :: TcRn r -> TcRn (Either Exception r)
 528 -- Does try_m, with a debug-trace on failure
 529 try_m thing
 530   = do { mb_r <- tryM thing ;
 531          case mb_r of
 532              Left exn -> do { traceTc (exn_msg exn); return mb_r }
 533              Right r  -> return mb_r }
 534   where
 535     exn_msg exn = text "tryTc/recoverM recovering from" <+> text (showException exn)
 536
 537 tryTcLIE :: TcM a -> TcM (Messages, Maybe a)
 538 -- Just like tryTc, except that it ensures that the LIE
 539 -- for the thing is propagated only if there are no errors
 540 -- Hence it's restricted to the type-check monad
 541 tryTcLIE thing_inside
 542   = do { ((errs, mb_r), lie) <- getLIE (tryTc thing_inside) ;
 543          ifM (isJust mb_r) (extendLIEs lie) ;
 544          return (errs, mb_r) }
 545
 546 tryTcLIE_ :: TcM r -> TcM r -> TcM r
 547 -- (tryTcLIE_ r m) tries m; if it succeeds it returns it,
 548 -- otherwise it returns r.  Any error messages added by m are discarded,
 549 -- whether or not m succeeds.
 550 tryTcLIE_ recover main
 551   = do { (_msgs, mb_res) <- tryTcLIE main ;
 552          case mb_res of
 553            Just res -> return res
 554            Nothing  -> recover }
 555
 556 checkNoErrs :: TcM r -> TcM r
 557 -- (checkNoErrs m) succeeds iff m succeeds and generates no errors
 558 -- If m fails then (checkNoErrsTc m) fails.
 559 -- If m succeeds, it checks whether m generated any errors messages
 560 --      (it might have recovered internally)
 561 --      If so, it fails too.
 562 -- Regardless, any errors generated by m are propagated to the enclosing context.
 563 checkNoErrs main
 564   = do { (msgs, mb_res) <- tryTcLIE main ;
 565          addMessages msgs ;
 566          case mb_res of
 567            Just r  -> return r
 568            Nothing -> failM
 569    }
 570
 571 ifErrsM :: TcRn r -> TcRn r -> TcRn r
 572 --      ifErrsM bale_out main
 573 -- does 'bale_out' if there are errors in errors collection
 574 -- otherwise does 'main'
 575 ifErrsM bale_out normal
 576  = do { errs_var <- getErrsVar ;
 577         msgs <- readMutVar errs_var ;
 578         dflags <- getDOpts ;
 579         if errorsFound dflags msgs then
 580            bale_out
 581         else
 582            normal }
 583
 584 failIfErrsM :: TcRn ()
 585 -- Useful to avoid error cascades
 586 failIfErrsM = ifErrsM failM (return ())
 587 \end{code}
 588
 589
 590 %************************************************************************
 591 %*                                                                      *
 592         Context management and error message generation
 593                     for the type checker
 594 %*                                                                      *
 595 %************************************************************************
 596
 597 \begin{code}
 598 setErrCtxtM, addErrCtxtM :: (TidyEnv -> TcM (TidyEnv, Message)) -> TcM a -> TcM a
 599 setErrCtxtM msg = updCtxt (\ msgs -> [msg])
 600 addErrCtxtM msg = updCtxt (\ msgs -> msg : msgs)
 601
 602 setErrCtxt, addErrCtxt :: Message -> TcM a -> TcM a
 603 setErrCtxt msg = setErrCtxtM (\env -> returnM (env, msg))
 604 addErrCtxt msg = addErrCtxtM (\env -> returnM (env, msg))
 605
 606 popErrCtxt :: TcM a -> TcM a
 607 popErrCtxt = updCtxt (\ msgs -> case msgs of { [] -> []; (m:ms) -> ms })
 608
 609 getErrCtxt :: TcM ErrCtxt
 610 getErrCtxt = do { env <- getLclEnv ; return (tcl_ctxt env) }
 611
 612 -- Helper function for the above
 613 updCtxt :: (ErrCtxt -> ErrCtxt) -> TcM a -> TcM a
 614 updCtxt upd = updLclEnv (\ env@(TcLclEnv { tcl_ctxt = ctxt }) ->
 615                            env { tcl_ctxt = upd ctxt })
 616
 617 getInstLoc :: InstOrigin -> TcM InstLoc
 618 getInstLoc origin
 619   = do { loc <- getSrcSpanM ; env <- getLclEnv ;
 620          return (InstLoc origin loc (tcl_ctxt env)) }
 621
 622 addInstCtxt :: InstLoc -> TcM a -> TcM a
 623 -- Add the SrcSpan and context from the first Inst in the list
 624 --      (they all have similar locations)
 625 addInstCtxt (InstLoc _ src_loc ctxt) thing_inside
 626   = addSrcSpan src_loc (updCtxt (\ old_ctxt -> ctxt) thing_inside)
 627 \end{code}
 628
 629     The addErrTc functions add an error message, but do not cause failure.
 630     The 'M' variants pass a TidyEnv that has already been used to
 631     tidy up the message; we then use it to tidy the context messages
 632
 633 \begin{code}
 634 addErrTc :: Message -> TcM ()
 635 addErrTc err_msg = addErrTcM (emptyTidyEnv, err_msg)
 636
 637 addErrsTc :: [Message] -> TcM ()
 638 addErrsTc err_msgs = mappM_ addErrTc err_msgs
 639
 640 addErrTcM :: (TidyEnv, Message) -> TcM ()
 641 addErrTcM (tidy_env, err_msg)
 642   = do { ctxt <- getErrCtxt ;
 643          loc  <- getSrcSpanM ;
 644          add_err_tcm tidy_env err_msg loc ctxt }
 645 \end{code}
 646
 647 The failWith functions add an error message and cause failure
 648
 649 \begin{code}
 650 failWithTc :: Message -> TcM a               -- Add an error message and fail
 651 failWithTc err_msg
 652   = addErrTc err_msg >> failM
 653
 654 failWithTcM :: (TidyEnv, Message) -> TcM a   -- Add an error message and fail
 655 failWithTcM local_and_msg
 656   = addErrTcM local_and_msg >> failM
 657
 658 checkTc :: Bool -> Message -> TcM ()         -- Check that the boolean is true
 659 checkTc True  err = returnM ()
 660 checkTc False err = failWithTc err
 661 \end{code}
 662
 663         Warnings have no 'M' variant, nor failure
 664
 665 \begin{code}
 666 addWarnTc :: Message -> TcM ()
 667 addWarnTc msg
 668  = do { ctxt <- getErrCtxt ;
 669         ctxt_msgs <- do_ctxt emptyTidyEnv ctxt ;
 670         addWarn (vcat (msg : ctxt_to_use ctxt_msgs)) }
 671
 672 warnTc :: Bool -> Message -> TcM ()
 673 warnTc warn_if_true warn_msg
 674   | warn_if_true = addWarnTc warn_msg
 675   | otherwise    = return ()
 676 \end{code}
 677
 678         Helper functions
 679
 680 \begin{code}
 681 add_err_tcm tidy_env err_msg loc ctxt
 682  = do { ctxt_msgs <- do_ctxt tidy_env ctxt ;
 683         addLongErrAt loc err_msg (vcat (ctxt_to_use ctxt_msgs)) }
 684
 685 do_ctxt tidy_env []
 686  = return []
 687 do_ctxt tidy_env (c:cs)
 688  = do { (tidy_env', m) <- c tidy_env  ;
 689         ms             <- do_ctxt tidy_env' cs  ;
 690         return (m:ms) }
 691
 692 ctxt_to_use ctxt | opt_PprStyle_Debug = ctxt
 693                  | otherwise          = take 3 ctxt
 694 \end{code}
 695
 696 %************************************************************************
 697 %*                                                                      *
 698              Type constraints (the so-called LIE)
 699 %*                                                                      *
 700 %************************************************************************
 701
 702 \begin{code}
 703 getLIEVar :: TcM (TcRef LIE)
 704 getLIEVar = do { env <- getLclEnv; return (tcl_lie env) }
 705
 706 setLIEVar :: TcRef LIE -> TcM a -> TcM a
 707 setLIEVar lie_var = updLclEnv (\ env -> env { tcl_lie = lie_var })
 708
 709 getLIE :: TcM a -> TcM (a, [Inst])
 710 -- (getLIE m) runs m, and returns the type constraints it generates
 711 getLIE thing_inside
 712   = do { lie_var <- newMutVar emptyLIE ;
 713          res <- updLclEnv (\ env -> env { tcl_lie = lie_var })
 714                           thing_inside ;
 715          lie <- readMutVar lie_var ;
 716          return (res, lieToList lie) }
 717
 718 extendLIE :: Inst -> TcM ()
 719 extendLIE inst
 720   = do { lie_var <- getLIEVar ;
 721          lie <- readMutVar lie_var ;
 722          writeMutVar lie_var (inst `consLIE` lie) }
 723
 724 extendLIEs :: [Inst] -> TcM ()
 725 extendLIEs []
 726   = returnM ()
 727 extendLIEs insts
 728   = do { lie_var <- getLIEVar ;
 729          lie <- readMutVar lie_var ;
 730          writeMutVar lie_var (mkLIE insts `plusLIE` lie) }
 731 \end{code}
 732
 733 \begin{code}
 734 setLclTypeEnv :: TcLclEnv -> TcM a -> TcM a
 735 -- Set the local type envt, but do *not* disturb other fields,
 736 -- notably the lie_var
 737 setLclTypeEnv lcl_env thing_inside
 738   = updLclEnv upd thing_inside
 739   where
 740     upd env = env { tcl_env = tcl_env lcl_env,
 741                     tcl_tyvars = tcl_tyvars lcl_env }
 742 \end{code}
 743
 744
 745 %************************************************************************
 746 %*                                                                      *
 747              Template Haskell context
 748 %*                                                                      *
 749 %************************************************************************
 750
 751 \begin{code}
 752 recordThUse :: TcM ()
 753 recordThUse = do { env <- getGblEnv; writeMutVar (tcg_th_used env) True }
 754
 755 getStage :: TcM ThStage
 756 getStage = do { env <- getLclEnv; return (tcl_th_ctxt env) }
 757
 758 setStage :: ThStage -> TcM a -> TcM a
 759 setStage s = updLclEnv (\ env -> env { tcl_th_ctxt = s })
 760 \end{code}
 761
 762
 763 %************************************************************************
 764 %*                                                                      *
 765              Arrow context
 766 %*                                                                      *
 767 %************************************************************************
 768
 769 \begin{code}
 770 popArrowBinders :: TcM a -> TcM a       -- Move to the left of a (-<); see comments in TcRnTypes
 771 popArrowBinders
 772   = updLclEnv (\ env -> env { tcl_arrow_ctxt = pop (tcl_arrow_ctxt env)  })
 773   where
 774     pop (ArrCtxt {proc_level = curr_lvl, proc_banned = banned})
 775         = ASSERT( not (curr_lvl `elem` banned) )
 776           ArrCtxt {proc_level = curr_lvl, proc_banned = curr_lvl : banned}
 777
 778 getBannedProcLevels :: TcM [ProcLevel]
 779   = do { env <- getLclEnv; return (proc_banned (tcl_arrow_ctxt env)) }
 780
 781 incProcLevel :: TcM a -> TcM a
 782 incProcLevel
 783   = updLclEnv (\ env -> env { tcl_arrow_ctxt = inc (tcl_arrow_ctxt env) })
 784   where
 785     inc ctxt = ctxt { proc_level = proc_level ctxt + 1 }
 786 \end{code}
 787
 788
 789 %************************************************************************
 790 %*                                                                      *
 791              Stuff for the renamer's local env
 792 %*                                                                      *
 793 %************************************************************************
 794
 795 \begin{code}
 796 getLocalRdrEnv :: RnM LocalRdrEnv
 797 getLocalRdrEnv = do { env <- getLclEnv; return (tcl_rdr env) }
 798
 799 setLocalRdrEnv :: LocalRdrEnv -> RnM a -> RnM a
 800 setLocalRdrEnv rdr_env thing_inside
 801   = updLclEnv (\env -> env {tcl_rdr = rdr_env}) thing_inside
 802 \end{code}
 803
 804
 805 %************************************************************************
 806 %*                                                                      *
 807              Stuff for interface decls
 808 %*                                                                      *
 809 %************************************************************************
 810
 811 \begin{code}
 812 initIfaceTcRn :: IfG a -> TcRn a
 813 initIfaceTcRn thing_inside
 814   = do  { tcg_env <- getGblEnv
 815         ; let { if_env = IfGblEnv {
 816                         if_rec_types = Just (tcg_mod tcg_env, get_type_env) }
 817               ; get_type_env = readMutVar (tcg_type_env_var tcg_env) }
 818         ; setEnvs (if_env, ()) thing_inside }
 819
 820 initIfaceExtCore :: IfL a -> TcRn a
 821 initIfaceExtCore thing_inside
 822   = do  { tcg_env <- getGblEnv
 823         ; let { mod = tcg_mod tcg_env
 824               ; if_env = IfGblEnv {
 825                         if_rec_types = Just (mod, return (tcg_type_env tcg_env)) }
 826               ; if_lenv = IfLclEnv { if_mod     = moduleName mod,
 827                                      if_tv_env  = emptyOccEnv,
 828                                      if_id_env  = emptyOccEnv }
 829           }
 830         ; setEnvs (if_env, if_lenv) thing_inside }
 831
 832 initIfaceCheck :: HscEnv -> IfG a -> IO a
 833 -- Used when checking the up-to-date-ness of the old Iface
 834 -- Initialise the environment with no useful info at all
 835 initIfaceCheck hsc_env do_this
 836  = do   { let { gbl_env = IfGblEnv { if_rec_types = Nothing } ;
 837            }
 838         ; initTcRnIf 'i' hsc_env gbl_env () do_this
 839     }
 840
 841 initIfaceTc :: HscEnv -> ModIface
 842             -> (TcRef TypeEnv -> IfL a) -> IO a
 843 -- Used when type-checking checking an up-to-date interface file
 844 -- No type envt from the current module, but we do know the module dependencies
 845 initIfaceTc hsc_env iface do_this
 846  = do   { tc_env_var <- newIORef emptyTypeEnv
 847         ; let { gbl_env = IfGblEnv { if_rec_types = Just (mod, readMutVar tc_env_var) } ;
 848               ; if_lenv = IfLclEnv { if_mod     = moduleName mod,
 849                                      if_tv_env  = emptyOccEnv,
 850                                      if_id_env  = emptyOccEnv }
 851            }
 852         ; initTcRnIf 'i' hsc_env gbl_env if_lenv (do_this tc_env_var)
 853     }
 854   where
 855     mod = mi_module iface
 856
 857 initIfaceRules :: HscEnv -> ModGuts -> IfG a -> IO a
 858 -- Used when sucking in new Rules in SimplCore
 859 -- We have available the type envt of the module being compiled, and we must use it
 860 initIfaceRules hsc_env guts do_this
 861  = do   { let {
 862              type_info = (mg_module guts, return (mg_types guts))
 863            ; gbl_env = IfGblEnv { if_rec_types = Just type_info } ;
 864            }
 865
 866         -- Run the thing; any exceptions just bubble out from here
 867         ; initTcRnIf 'i' hsc_env gbl_env () do_this
 868     }
 869
 870 initIfaceLcl :: ModuleName -> IfL a -> IfM lcl a
 871 initIfaceLcl mod thing_inside
 872   = setLclEnv (IfLclEnv { if_mod      = mod,
 873                            if_tv_env  = emptyOccEnv,
 874                            if_id_env  = emptyOccEnv })
 875               thing_inside
 876
 877
 878 --------------------
 879 forkM_maybe :: SDoc -> IfL a -> IfL (Maybe a)
 880 -- Run thing_inside in an interleaved thread.
 881 -- It shares everything with the parent thread, so this is DANGEROUS.
 882 --
 883 -- It returns Nothing if the computation fails
 884 --
 885 -- It's used for lazily type-checking interface
 886 -- signatures, which is pretty benign
 887
 888 forkM_maybe doc thing_inside
 889  = do { unsafeInterleaveM $
 890         do { traceIf (text "Starting fork {" <+> doc)
 891            ; mb_res <- tryM thing_inside ;
 892              case mb_res of
 893                 Right r  -> do  { traceIf (text "} ending fork" <+> doc)
 894                                 ; return (Just r) }
 895                 Left exn -> do {
 896
 897                     -- Bleat about errors in the forked thread, if -ddump-if-trace is on
 898                     -- Otherwise we silently discard errors. Errors can legitimately
 899                     -- happen when compiling interface signatures (see tcInterfaceSigs)
 900                       ifOptM Opt_D_dump_if_trace
 901                              (print_errs (hang (text "forkM failed:" <+> doc)
 902                                              4 (text (show exn))))
 903
 904                     ; traceIf (text "} ending fork (badly)" <+> doc)
 905                     ; return Nothing }
 906         }}
 907   where
 908     print_errs sdoc = ioToIOEnv (printErrs (sdoc defaultErrStyle))
 909
 910 forkM :: SDoc -> IfL a -> IfL a
 911 forkM doc thing_inside
 912  = do   { mb_res <- forkM_maybe doc thing_inside
 913         ; return (case mb_res of
 914                         Nothing -> pprPanic "forkM" doc
 915                         Just r  -> r) }
 916 \end{code}