8 #include "HsVersions.h"
10 import TcRnTypes -- Re-export all
11 import IOEnv -- Re-export all
13 import HsSyn ( emptyLHsBinds )
14 import HscTypes ( HscEnv(..), ModGuts(..), ModIface(..),
15 TyThing, TypeEnv, emptyTypeEnv, HscSource(..), isHsBoot,
16 ExternalPackageState(..), HomePackageTable,
17 Deprecs(..), FixityEnv, FixItem,
18 lookupType, unQualInScope )
19 import Module ( Module, unitModuleEnv )
20 import RdrName ( GlobalRdrEnv, emptyGlobalRdrEnv,
21 LocalRdrEnv, emptyLocalRdrEnv )
22 import Name ( Name, isInternalName )
24 import NameEnv ( extendNameEnvList )
25 import InstEnv ( emptyInstEnv )
27 import VarSet ( emptyVarSet )
28 import VarEnv ( TidyEnv, emptyTidyEnv, emptyVarEnv )
29 import ErrUtils ( Message, Messages, emptyMessages, errorsFound,
30 mkWarnMsg, printErrorsAndWarnings,
31 mkLocMessage, mkLongErrMsg )
32 import SrcLoc ( mkGeneralSrcSpan, isGoodSrcSpan, SrcSpan, Located(..) )
33 import NameEnv ( emptyNameEnv )
34 import NameSet ( NameSet, emptyDUs, emptyNameSet, unionNameSets, addOneToNameSet )
35 import OccName ( emptyOccEnv )
36 import Bag ( emptyBag )
38 import UniqSupply ( UniqSupply, mkSplitUniqSupply, uniqFromSupply, splitUniqSupply )
39 import Unique ( Unique )
40 import DynFlags ( DynFlags(..), DynFlag(..), dopt, dopt_set, GhcMode )
41 import StaticFlags ( opt_PprStyle_Debug )
42 import Bag ( snocBag, unionBags )
43 import Panic ( showException )
45 import Maybe ( isJust )
47 import DATA_IOREF ( newIORef, readIORef )
48 import EXCEPTION ( Exception )
53 %************************************************************************
57 %************************************************************************
60 ioToTcRn :: IO r -> TcRn r
69 -> IO (Messages, Maybe r)
70 -- Nothing => error thrown by the thing inside
71 -- (error messages should have been printed already)
73 initTc hsc_env hsc_src mod do_this
74 = do { errs_var <- newIORef (emptyBag, emptyBag) ;
75 tvs_var <- newIORef emptyVarSet ;
76 type_env_var <- newIORef emptyNameEnv ;
77 dfuns_var <- newIORef emptyNameSet ;
78 keep_var <- newIORef emptyNameSet ;
79 th_var <- newIORef False ;
80 dfun_n_var <- newIORef 1 ;
86 tcg_rdr_env = emptyGlobalRdrEnv,
87 tcg_fix_env = emptyNameEnv,
88 tcg_default = Nothing,
89 tcg_type_env = emptyNameEnv,
90 tcg_type_env_var = type_env_var,
91 tcg_inst_env = emptyInstEnv,
92 tcg_inst_uses = dfuns_var,
94 tcg_exports = emptyNameSet,
95 tcg_imports = init_imports,
97 tcg_rn_decls = Nothing,
98 tcg_binds = emptyLHsBinds,
99 tcg_deprecs = NoDeprecs,
103 tcg_dfun_n = dfun_n_var,
108 tcl_loc = mkGeneralSrcSpan FSLIT("Top level"),
110 tcl_rdr = emptyLocalRdrEnv,
111 tcl_th_ctxt = topStage,
112 tcl_arrow_ctxt = NoArrowCtxt,
113 tcl_env = emptyNameEnv,
114 tcl_tyvars = tvs_var,
115 tcl_lie = panic "initTc:LIE", -- LIE only valid inside a getLIE
116 tcl_gadt = emptyVarEnv
120 -- OK, here's the business end!
121 maybe_res <- initTcRnIf 'a' hsc_env gbl_env lcl_env $
122 do { r <- tryM do_this
124 Right res -> return (Just res)
125 Left _ -> return Nothing } ;
127 -- Collect any error messages
128 msgs <- readIORef errs_var ;
130 let { dflags = hsc_dflags hsc_env
131 ; final_res | errorsFound dflags msgs = Nothing
132 | otherwise = maybe_res } ;
134 return (msgs, final_res)
137 init_imports = emptyImportAvails { imp_env = unitModuleEnv mod emptyNameSet }
138 -- Initialise tcg_imports with an empty set of bindings for
139 -- this module, so that if we see 'module M' in the export
140 -- list, and there are no bindings in M, we don't bleat
141 -- "unknown module M".
143 initTcPrintErrors -- Used from the interactive loop only
148 initTcPrintErrors env mod todo = do
149 (msgs, res) <- initTc env HsSrcFile mod todo
150 printErrorsAndWarnings msgs
153 -- mkImpTypeEnv makes the imported symbol table
154 mkImpTypeEnv :: ExternalPackageState -> HomePackageTable
155 -> Name -> Maybe TyThing
156 mkImpTypeEnv pcs hpt = lookup
159 lookup name | isInternalName name = Nothing
160 | otherwise = lookupType hpt pte name
164 %************************************************************************
168 %************************************************************************
172 initTcRnIf :: Char -- Tag for unique supply
177 initTcRnIf uniq_tag hsc_env gbl_env lcl_env thing_inside
178 = do { us <- mkSplitUniqSupply uniq_tag ;
179 ; us_var <- newIORef us ;
181 ; let { env = Env { env_top = hsc_env,
184 env_lcl = lcl_env } }
186 ; runIOEnv env thing_inside
190 %************************************************************************
194 %************************************************************************
197 getTopEnv :: TcRnIf gbl lcl HscEnv
198 getTopEnv = do { env <- getEnv; return (env_top env) }
200 getGblEnv :: TcRnIf gbl lcl gbl
201 getGblEnv = do { env <- getEnv; return (env_gbl env) }
203 updGblEnv :: (gbl -> gbl) -> TcRnIf gbl lcl a -> TcRnIf gbl lcl a
204 updGblEnv upd = updEnv (\ env@(Env { env_gbl = gbl }) ->
205 env { env_gbl = upd gbl })
207 setGblEnv :: gbl -> TcRnIf gbl lcl a -> TcRnIf gbl lcl a
208 setGblEnv gbl_env = updEnv (\ env -> env { env_gbl = gbl_env })
210 getLclEnv :: TcRnIf gbl lcl lcl
211 getLclEnv = do { env <- getEnv; return (env_lcl env) }
213 updLclEnv :: (lcl -> lcl) -> TcRnIf gbl lcl a -> TcRnIf gbl lcl a
214 updLclEnv upd = updEnv (\ env@(Env { env_lcl = lcl }) ->
215 env { env_lcl = upd lcl })
217 setLclEnv :: lcl' -> TcRnIf gbl lcl' a -> TcRnIf gbl lcl a
218 setLclEnv lcl_env = updEnv (\ env -> env { env_lcl = lcl_env })
220 getEnvs :: TcRnIf gbl lcl (gbl, lcl)
221 getEnvs = do { env <- getEnv; return (env_gbl env, env_lcl env) }
223 setEnvs :: (gbl', lcl') -> TcRnIf gbl' lcl' a -> TcRnIf gbl lcl a
224 setEnvs (gbl_env, lcl_env) = updEnv (\ env -> env { env_gbl = gbl_env, env_lcl = lcl_env })
231 getDOpts :: TcRnIf gbl lcl DynFlags
232 getDOpts = do { env <- getTopEnv; return (hsc_dflags env) }
234 doptM :: DynFlag -> TcRnIf gbl lcl Bool
235 doptM flag = do { dflags <- getDOpts; return (dopt flag dflags) }
237 setOptM :: DynFlag -> TcRnIf gbl lcl a -> TcRnIf gbl lcl a
238 setOptM flag = updEnv (\ env@(Env { env_top = top }) ->
239 env { env_top = top { hsc_dflags = dopt_set (hsc_dflags top) flag}} )
241 ifOptM :: DynFlag -> TcRnIf gbl lcl () -> TcRnIf gbl lcl () -- Do it flag is true
242 ifOptM flag thing_inside = do { b <- doptM flag;
243 if b then thing_inside else return () }
245 getGhciMode :: TcRnIf gbl lcl GhcMode
246 getGhciMode = do { env <- getTopEnv; return (ghcMode (hsc_dflags env)) }
250 getEpsVar :: TcRnIf gbl lcl (TcRef ExternalPackageState)
251 getEpsVar = do { env <- getTopEnv; return (hsc_EPS env) }
253 getEps :: TcRnIf gbl lcl ExternalPackageState
254 getEps = do { env <- getTopEnv; readMutVar (hsc_EPS env) }
256 -- Updating the EPS. This should be an atomic operation.
257 -- Note the delicate 'seq' which forces the EPS before putting it in the
258 -- variable. Otherwise what happens is that we get
259 -- write eps_var (....(unsafeRead eps_var)....)
260 -- and if the .... is strict, that's obviously bottom. By forcing it beforehand
261 -- we make the unsafeRead happen before we update the variable.
263 updateEps :: (ExternalPackageState -> (ExternalPackageState, a))
265 updateEps upd_fn = do { traceIf (text "updating EPS")
266 ; eps_var <- getEpsVar
267 ; eps <- readMutVar eps_var
268 ; let { (eps', val) = upd_fn eps }
269 ; seq eps' (writeMutVar eps_var eps')
272 updateEps_ :: (ExternalPackageState -> ExternalPackageState)
274 updateEps_ upd_fn = do { traceIf (text "updating EPS_")
275 ; eps_var <- getEpsVar
276 ; eps <- readMutVar eps_var
277 ; let { eps' = upd_fn eps }
278 ; seq eps' (writeMutVar eps_var eps') }
280 getHpt :: TcRnIf gbl lcl HomePackageTable
281 getHpt = do { env <- getTopEnv; return (hsc_HPT env) }
283 getEpsAndHpt :: TcRnIf gbl lcl (ExternalPackageState, HomePackageTable)
284 getEpsAndHpt = do { env <- getTopEnv; eps <- readMutVar (hsc_EPS env)
285 ; return (eps, hsc_HPT env) }
288 %************************************************************************
292 %************************************************************************
295 newUnique :: TcRnIf gbl lcl Unique
296 newUnique = do { us <- newUniqueSupply ;
297 return (uniqFromSupply us) }
299 newUniqueSupply :: TcRnIf gbl lcl UniqSupply
301 = do { env <- getEnv ;
302 let { u_var = env_us env } ;
303 us <- readMutVar u_var ;
304 let { (us1, us2) = splitUniqSupply us } ;
305 writeMutVar u_var us1 ;
310 %************************************************************************
314 %************************************************************************
317 traceTc, traceRn :: SDoc -> TcRn ()
318 traceRn = dumpOptTcRn Opt_D_dump_rn_trace
319 traceTc = dumpOptTcRn Opt_D_dump_tc_trace
320 traceSplice = dumpOptTcRn Opt_D_dump_splices
323 traceIf :: SDoc -> TcRnIf m n ()
324 traceIf = dumpOptIf Opt_D_dump_if_trace
325 traceHiDiffs = dumpOptIf Opt_D_dump_hi_diffs
328 dumpOptIf :: DynFlag -> SDoc -> TcRnIf m n () -- No RdrEnv available, so qualify everything
329 dumpOptIf flag doc = ifOptM flag $
330 ioToIOEnv (printForUser stderr alwaysQualify doc)
332 dumpOptTcRn :: DynFlag -> SDoc -> TcRn ()
333 dumpOptTcRn flag doc = ifOptM flag $ do
336 ; ctxt_msgs <- do_ctxt emptyTidyEnv ctxt
337 ; let real_doc = mkLocMessage loc (vcat (doc : ctxt_to_use ctxt_msgs))
338 ; dumpTcRn real_doc }
340 dumpTcRn :: SDoc -> TcRn ()
341 dumpTcRn doc = do { rdr_env <- getGlobalRdrEnv ;
342 ioToTcRn (printForUser stderr (unQualInScope rdr_env) doc) }
346 %************************************************************************
348 Typechecker global environment
350 %************************************************************************
353 getModule :: TcRn Module
354 getModule = do { env <- getGblEnv; return (tcg_mod env) }
356 tcIsHsBoot :: TcRn Bool
357 tcIsHsBoot = do { env <- getGblEnv; return (isHsBoot (tcg_src env)) }
359 getGlobalRdrEnv :: TcRn GlobalRdrEnv
360 getGlobalRdrEnv = do { env <- getGblEnv; return (tcg_rdr_env env) }
362 getImports :: TcRn ImportAvails
363 getImports = do { env <- getGblEnv; return (tcg_imports env) }
365 getFixityEnv :: TcRn FixityEnv
366 getFixityEnv = do { env <- getGblEnv; return (tcg_fix_env env) }
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})
373 getDefaultTys :: TcRn (Maybe [Type])
374 getDefaultTys = do { env <- getGblEnv; return (tcg_default env) }
377 %************************************************************************
381 %************************************************************************
384 getSrcSpanM :: TcRn SrcSpan
385 -- Avoid clash with Name.getSrcLoc
386 getSrcSpanM = do { env <- getLclEnv; return (tcl_loc env) }
388 setSrcSpan :: SrcSpan -> TcRn a -> TcRn a
389 setSrcSpan 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
393 addLocM :: (a -> TcM b) -> Located a -> TcM b
394 addLocM fn (L loc a) = setSrcSpan loc $ fn a
396 wrapLocM :: (a -> TcM b) -> Located a -> TcM (Located b)
397 wrapLocM fn (L loc a) = setSrcSpan loc $ do b <- fn a; return (L loc b)
399 wrapLocFstM :: (a -> TcM (b,c)) -> Located a -> TcM (Located b, c)
400 wrapLocFstM fn (L loc a) =
405 wrapLocSndM :: (a -> TcM (b,c)) -> Located a -> TcM (b, Located c)
406 wrapLocSndM fn (L loc a) =
414 getErrsVar :: TcRn (TcRef Messages)
415 getErrsVar = do { env <- getLclEnv; return (tcl_errs env) }
417 setErrsVar :: TcRef Messages -> TcRn a -> TcRn a
418 setErrsVar v = updLclEnv (\ env -> env { tcl_errs = v })
420 addErr :: Message -> TcRn ()
421 addErr msg = do { loc <- getSrcSpanM ; addErrAt loc msg }
423 addLocErr :: Located e -> (e -> Message) -> TcRn ()
424 addLocErr (L loc e) fn = addErrAt loc (fn e)
426 addErrAt :: SrcSpan -> Message -> TcRn ()
427 addErrAt loc msg = addLongErrAt loc msg empty
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) }
437 addErrs :: [(SrcSpan,Message)] -> TcRn ()
438 addErrs msgs = mappM_ add msgs
440 add (loc,msg) = addErrAt loc msg
442 addReport :: Message -> TcRn ()
443 addReport msg = do loc <- getSrcSpanM; addReportAt loc msg
445 addReportAt :: SrcSpan -> Message -> TcRn ()
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) }
453 addWarn :: Message -> TcRn ()
454 addWarn msg = addReport (ptext SLIT("Warning:") <+> msg)
456 addWarnAt :: SrcSpan -> Message -> TcRn ()
457 addWarnAt loc msg = addReportAt loc (ptext SLIT("Warning:") <+> msg)
459 addLocWarn :: Located e -> (e -> Message) -> TcRn ()
460 addLocWarn (L loc e) fn = addReportAt loc (fn e)
462 checkErr :: Bool -> Message -> TcRn ()
463 -- Add the error if the bool is False
464 checkErr ok msg = checkM ok (addErr msg)
466 warnIf :: Bool -> Message -> TcRn ()
467 warnIf True msg = addWarn msg
468 warnIf False msg = return ()
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) }
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
485 = do { errs_var <- newMutVar emptyMessages
486 ; result <- setErrsVar errs_var thing_inside
487 ; (_warns, errs) <- readMutVar errs_var
488 ; addMessages (emptyBag, errs)
494 try_m :: TcRn r -> TcRn (Either Exception r)
495 -- Does try_m, with a debug-trace on failure
497 = do { mb_r <- tryM thing ;
499 Left exn -> do { traceTc (exn_msg exn); return mb_r }
500 Right r -> return mb_r }
502 exn_msg exn = text "tryTc/recoverM recovering from" <+> text (showException exn)
504 -----------------------
505 recoverM :: TcRn r -- Recovery action; do this if the main one fails
506 -> TcRn r -- Main action: do this first
508 -- Errors in 'thing' are retained
509 recoverM recover thing
510 = do { mb_res <- try_m thing ;
513 Right res -> returnM res }
515 -----------------------
516 tryTc :: TcRn a -> TcRn (Messages, Maybe a)
517 -- (tryTc m) executes m, and returns
518 -- Just r, if m succeeds (returning r)
519 -- Nothing, if m fails
520 -- It also returns all the errors and warnings accumulated by m
521 -- It always succeeds (never raises an exception)
523 = do { errs_var <- newMutVar emptyMessages ;
524 res <- try_m (setErrsVar errs_var m) ;
525 msgs <- readMutVar errs_var ;
526 return (msgs, case res of
528 Right val -> Just val)
529 -- The exception is always the IOEnv built-in
530 -- in exception; see IOEnv.failM
533 -----------------------
534 tryTcErrs :: TcRn a -> TcRn (Messages, Maybe a)
535 -- Run the thing, returning
536 -- Just r, if m succceeds with no error messages
537 -- Nothing, if m fails, or if it succeeds but has error messages
538 -- Either way, the messages are returned; even in the Just case
539 -- there might be warnings
541 = do { (msgs, res) <- tryTc thing
543 ; let errs_found = errorsFound dflags msgs
544 ; return (msgs, case res of
546 Just val | errs_found -> Nothing
547 | otherwise -> Just val)
550 -----------------------
551 tryTcLIE :: TcM a -> TcM (Messages, Maybe a)
552 -- Just like tryTcErrs, except that it ensures that the LIE
553 -- for the thing is propagated only if there are no errors
554 -- Hence it's restricted to the type-check monad
555 tryTcLIE thing_inside
556 = do { ((msgs, mb_res), lie) <- getLIE (tryTcErrs thing_inside) ;
558 Nothing -> return (msgs, Nothing)
559 Just val -> do { extendLIEs lie; return (msgs, Just val) }
562 -----------------------
563 tryTcLIE_ :: TcM r -> TcM r -> TcM r
564 -- (tryTcLIE_ r m) tries m;
565 -- if m succeeds with no error messages, it's the answer
566 -- otherwise tryTcLIE_ drops everything from m and tries r instead.
567 tryTcLIE_ recover main
568 = do { (msgs, mb_res) <- tryTcLIE main
570 Just val -> do { addMessages msgs -- There might be warnings
572 Nothing -> recover -- Discard all msgs
575 -----------------------
576 checkNoErrs :: TcM r -> TcM r
577 -- (checkNoErrs m) succeeds iff m succeeds and generates no errors
578 -- If m fails then (checkNoErrsTc m) fails.
579 -- If m succeeds, it checks whether m generated any errors messages
580 -- (it might have recovered internally)
581 -- If so, it fails too.
582 -- Regardless, any errors generated by m are propagated to the enclosing context.
584 = do { (msgs, mb_res) <- tryTcLIE main
588 Just val -> return val
591 ifErrsM :: TcRn r -> TcRn r -> TcRn r
592 -- ifErrsM bale_out main
593 -- does 'bale_out' if there are errors in errors collection
594 -- otherwise does 'main'
595 ifErrsM bale_out normal
596 = do { errs_var <- getErrsVar ;
597 msgs <- readMutVar errs_var ;
599 if errorsFound dflags msgs then
604 failIfErrsM :: TcRn ()
605 -- Useful to avoid error cascades
606 failIfErrsM = ifErrsM failM (return ())
610 %************************************************************************
612 Context management and error message generation
615 %************************************************************************
618 getErrCtxt :: TcM ErrCtxt
619 getErrCtxt = do { env <- getLclEnv; return (tcl_ctxt env) }
621 setErrCtxt :: ErrCtxt -> TcM a -> TcM a
622 setErrCtxt ctxt = updLclEnv (\ env -> env { tcl_ctxt = ctxt })
624 addErrCtxtM :: (TidyEnv -> TcM (TidyEnv, Message)) -> TcM a -> TcM a
625 addErrCtxtM msg = updCtxt (\ msgs -> msg : msgs)
627 addErrCtxt :: Message -> TcM a -> TcM a
628 addErrCtxt msg = addErrCtxtM (\env -> returnM (env, msg))
630 -- Helper function for the above
631 updCtxt :: (ErrCtxt -> ErrCtxt) -> TcM a -> TcM a
632 updCtxt upd = updLclEnv (\ env@(TcLclEnv { tcl_ctxt = ctxt }) ->
633 env { tcl_ctxt = upd ctxt })
635 -- Conditionally add an error context
636 maybeAddErrCtxt :: Maybe Message -> TcM a -> TcM a
637 maybeAddErrCtxt (Just msg) thing_inside = addErrCtxt msg thing_inside
638 maybeAddErrCtxt Nothing thing_inside = thing_inside
640 popErrCtxt :: TcM a -> TcM a
641 popErrCtxt = updCtxt (\ msgs -> case msgs of { [] -> []; (m:ms) -> ms })
643 getInstLoc :: InstOrigin -> TcM InstLoc
645 = do { loc <- getSrcSpanM ; env <- getLclEnv ;
646 return (InstLoc origin loc (tcl_ctxt env)) }
648 addInstCtxt :: InstLoc -> TcM a -> TcM a
649 -- Add the SrcSpan and context from the first Inst in the list
650 -- (they all have similar locations)
651 addInstCtxt (InstLoc _ src_loc ctxt) thing_inside
652 = setSrcSpan src_loc (updCtxt (\ old_ctxt -> ctxt) thing_inside)
655 The addErrTc functions add an error message, but do not cause failure.
656 The 'M' variants pass a TidyEnv that has already been used to
657 tidy up the message; we then use it to tidy the context messages
660 addErrTc :: Message -> TcM ()
661 addErrTc err_msg = addErrTcM (emptyTidyEnv, err_msg)
663 addErrsTc :: [Message] -> TcM ()
664 addErrsTc err_msgs = mappM_ addErrTc err_msgs
666 addErrTcM :: (TidyEnv, Message) -> TcM ()
667 addErrTcM (tidy_env, err_msg)
668 = do { ctxt <- getErrCtxt ;
670 add_err_tcm tidy_env err_msg loc ctxt }
673 The failWith functions add an error message and cause failure
676 failWithTc :: Message -> TcM a -- Add an error message and fail
678 = addErrTc err_msg >> failM
680 failWithTcM :: (TidyEnv, Message) -> TcM a -- Add an error message and fail
681 failWithTcM local_and_msg
682 = addErrTcM local_and_msg >> failM
684 checkTc :: Bool -> Message -> TcM () -- Check that the boolean is true
685 checkTc True err = returnM ()
686 checkTc False err = failWithTc err
689 Warnings have no 'M' variant, nor failure
692 addWarnTc :: Message -> TcM ()
694 = do { ctxt <- getErrCtxt ;
695 ctxt_msgs <- do_ctxt emptyTidyEnv ctxt ;
696 addWarn (vcat (msg : ctxt_to_use ctxt_msgs)) }
698 warnTc :: Bool -> Message -> TcM ()
699 warnTc warn_if_true warn_msg
700 | warn_if_true = addWarnTc warn_msg
701 | otherwise = return ()
707 add_err_tcm tidy_env err_msg loc ctxt
708 = do { ctxt_msgs <- do_ctxt tidy_env ctxt ;
709 addLongErrAt loc err_msg (vcat (ctxt_to_use ctxt_msgs)) }
713 do_ctxt tidy_env (c:cs)
714 = do { (tidy_env', m) <- c tidy_env ;
715 ms <- do_ctxt tidy_env' cs ;
718 ctxt_to_use ctxt | opt_PprStyle_Debug = ctxt
719 | otherwise = take 3 ctxt
722 debugTc is useful for monadi debugging code
725 debugTc :: TcM () -> TcM ()
727 debugTc thing = thing
729 debugTc thing = return ()
733 %************************************************************************
735 Type constraints (the so-called LIE)
737 %************************************************************************
740 nextDFunIndex :: TcM Int -- Get the next dfun index
741 nextDFunIndex = do { env <- getGblEnv
742 ; let dfun_n_var = tcg_dfun_n env
743 ; n <- readMutVar dfun_n_var
744 ; writeMutVar dfun_n_var (n+1)
747 getLIEVar :: TcM (TcRef LIE)
748 getLIEVar = do { env <- getLclEnv; return (tcl_lie env) }
750 setLIEVar :: TcRef LIE -> TcM a -> TcM a
751 setLIEVar lie_var = updLclEnv (\ env -> env { tcl_lie = lie_var })
753 getLIE :: TcM a -> TcM (a, [Inst])
754 -- (getLIE m) runs m, and returns the type constraints it generates
756 = do { lie_var <- newMutVar emptyLIE ;
757 res <- updLclEnv (\ env -> env { tcl_lie = lie_var })
759 lie <- readMutVar lie_var ;
760 return (res, lieToList lie) }
762 extendLIE :: Inst -> TcM ()
764 = do { lie_var <- getLIEVar ;
765 lie <- readMutVar lie_var ;
766 writeMutVar lie_var (inst `consLIE` lie) }
768 extendLIEs :: [Inst] -> TcM ()
772 = do { lie_var <- getLIEVar ;
773 lie <- readMutVar lie_var ;
774 writeMutVar lie_var (mkLIE insts `plusLIE` lie) }
778 setLclTypeEnv :: TcLclEnv -> TcM a -> TcM a
779 -- Set the local type envt, but do *not* disturb other fields,
780 -- notably the lie_var
781 setLclTypeEnv lcl_env thing_inside
782 = updLclEnv upd thing_inside
784 upd env = env { tcl_env = tcl_env lcl_env,
785 tcl_tyvars = tcl_tyvars lcl_env }
789 %************************************************************************
791 Template Haskell context
793 %************************************************************************
796 recordThUse :: TcM ()
797 recordThUse = do { env <- getGblEnv; writeMutVar (tcg_th_used env) True }
799 keepAliveTc :: Name -> TcM () -- Record the name in the keep-alive set
800 keepAliveTc n = do { env <- getGblEnv;
801 ; updMutVar (tcg_keep env) (`addOneToNameSet` n) }
803 keepAliveSetTc :: NameSet -> TcM () -- Record the name in the keep-alive set
804 keepAliveSetTc ns = do { env <- getGblEnv;
805 ; updMutVar (tcg_keep env) (`unionNameSets` ns) }
807 getStage :: TcM ThStage
808 getStage = do { env <- getLclEnv; return (tcl_th_ctxt env) }
810 setStage :: ThStage -> TcM a -> TcM a
811 setStage s = updLclEnv (\ env -> env { tcl_th_ctxt = s })
815 %************************************************************************
817 Stuff for the renamer's local env
819 %************************************************************************
822 getLocalRdrEnv :: RnM LocalRdrEnv
823 getLocalRdrEnv = do { env <- getLclEnv; return (tcl_rdr env) }
825 setLocalRdrEnv :: LocalRdrEnv -> RnM a -> RnM a
826 setLocalRdrEnv rdr_env thing_inside
827 = updLclEnv (\env -> env {tcl_rdr = rdr_env}) thing_inside
831 %************************************************************************
833 Stuff for interface decls
835 %************************************************************************
838 mkIfLclEnv :: Module -> SDoc -> IfLclEnv
839 mkIfLclEnv mod loc = IfLclEnv { if_mod = mod,
841 if_tv_env = emptyOccEnv,
842 if_id_env = emptyOccEnv }
844 initIfaceTcRn :: IfG a -> TcRn a
845 initIfaceTcRn thing_inside
846 = do { tcg_env <- getGblEnv
847 ; let { if_env = IfGblEnv { if_rec_types = Just (tcg_mod tcg_env, get_type_env) }
848 ; get_type_env = readMutVar (tcg_type_env_var tcg_env) }
849 ; setEnvs (if_env, ()) thing_inside }
851 initIfaceExtCore :: IfL a -> TcRn a
852 initIfaceExtCore thing_inside
853 = do { tcg_env <- getGblEnv
854 ; let { mod = tcg_mod tcg_env
855 ; doc = ptext SLIT("External Core file for") <+> quotes (ppr mod)
856 ; if_env = IfGblEnv {
857 if_rec_types = Just (mod, return (tcg_type_env tcg_env)) }
858 ; if_lenv = mkIfLclEnv mod doc
860 ; setEnvs (if_env, if_lenv) thing_inside }
862 initIfaceCheck :: HscEnv -> IfG a -> IO a
863 -- Used when checking the up-to-date-ness of the old Iface
864 -- Initialise the environment with no useful info at all
865 initIfaceCheck hsc_env do_this
866 = do { let gbl_env = IfGblEnv { if_rec_types = Nothing }
867 ; initTcRnIf 'i' hsc_env gbl_env () do_this
870 initIfaceTc :: ModIface
871 -> (TcRef TypeEnv -> IfL a) -> TcRnIf gbl lcl a
872 -- Used when type-checking checking an up-to-date interface file
873 -- No type envt from the current module, but we do know the module dependencies
874 initIfaceTc iface do_this
875 = do { tc_env_var <- newMutVar emptyTypeEnv
876 ; let { gbl_env = IfGblEnv { if_rec_types = Just (mod, readMutVar tc_env_var) } ;
877 ; if_lenv = mkIfLclEnv mod doc
879 ; setEnvs (gbl_env, if_lenv) (do_this tc_env_var)
882 mod = mi_module iface
883 doc = ptext SLIT("The interface for") <+> quotes (ppr mod)
885 initIfaceRules :: HscEnv -> ModGuts -> IfG a -> IO a
886 -- Used when sucking in new Rules in SimplCore
887 -- We have available the type envt of the module being compiled, and we must use it
888 initIfaceRules hsc_env guts do_this
890 type_info = (mg_module guts, return (mg_types guts))
891 ; gbl_env = IfGblEnv { if_rec_types = Just type_info } ;
894 -- Run the thing; any exceptions just bubble out from here
895 ; initTcRnIf 'i' hsc_env gbl_env () do_this
898 initIfaceLcl :: Module -> SDoc -> IfL a -> IfM lcl a
899 initIfaceLcl mod loc_doc thing_inside
900 = setLclEnv (mkIfLclEnv mod loc_doc) thing_inside
902 getIfModule :: IfL Module
903 getIfModule = do { env <- getLclEnv; return (if_mod env) }
906 failIfM :: Message -> IfL a
907 -- The Iface monad doesn't have a place to accumulate errors, so we
908 -- just fall over fast if one happens; it "shouldnt happen".
909 -- We use IfL here so that we can get context info out of the local env
911 = do { env <- getLclEnv
912 ; let full_msg = if_loc env $$ nest 2 msg
913 ; ioToIOEnv (printErrs (full_msg defaultErrStyle))
917 forkM_maybe :: SDoc -> IfL a -> IfL (Maybe a)
918 -- Run thing_inside in an interleaved thread.
919 -- It shares everything with the parent thread, so this is DANGEROUS.
921 -- It returns Nothing if the computation fails
923 -- It's used for lazily type-checking interface
924 -- signatures, which is pretty benign
926 forkM_maybe doc thing_inside
927 = do { unsafeInterleaveM $
928 do { traceIf (text "Starting fork {" <+> doc)
929 ; mb_res <- tryM thing_inside ;
931 Right r -> do { traceIf (text "} ending fork" <+> doc)
935 -- Bleat about errors in the forked thread, if -ddump-if-trace is on
936 -- Otherwise we silently discard errors. Errors can legitimately
937 -- happen when compiling interface signatures (see tcInterfaceSigs)
938 ifOptM Opt_D_dump_if_trace
939 (print_errs (hang (text "forkM failed:" <+> doc)
940 4 (text (show exn))))
942 ; traceIf (text "} ending fork (badly)" <+> doc)
946 print_errs sdoc = ioToIOEnv (printErrs (sdoc defaultErrStyle))
948 forkM :: SDoc -> IfL a -> IfL a
949 forkM doc thing_inside
950 = do { mb_res <- forkM_maybe doc thing_inside
951 ; return (case mb_res of
952 Nothing -> pprPanic "forkM" doc
956 %************************************************************************
960 %************************************************************************
963 getTypeRefinement :: TcM GadtRefinement
964 getTypeRefinement = do { lcl_env <- getLclEnv; return (tcl_gadt lcl_env) }
966 setTypeRefinement :: GadtRefinement -> TcM a -> TcM a
967 setTypeRefinement gadt = updLclEnv (\env -> env { tcl_gadt = gadt })