ghc/compiler/typecheck/TcMonad.lhs

   1 \begin{code}
   2 module TcMonad(
   3         TcM, NF_TcM, TcDown, TcEnv,
   4
   5         initTc,
   6         returnTc, thenTc, thenTc_, mapTc, mapTc_, listTc,
   7         foldrTc, foldlTc, mapAndUnzipTc, mapAndUnzip3Tc,
   8         mapBagTc, fixTc, tryTc, tryTc_, getErrsTc,
   9         traceTc, ioToTc,
  10
  11         uniqSMToTcM,
  12
  13         returnNF_Tc, thenNF_Tc, thenNF_Tc_, mapNF_Tc,
  14         fixNF_Tc, forkNF_Tc, foldrNF_Tc, foldlNF_Tc,
  15
  16         listNF_Tc, mapAndUnzipNF_Tc, mapBagNF_Tc,
  17
  18         checkTc, checkTcM, checkMaybeTc, checkMaybeTcM,
  19         failTc, failWithTc, addErrTc, addErrsTc, warnTc,
  20         recoverTc, checkNoErrsTc, recoverNF_Tc, discardErrsTc,
  21         addErrTcM, addInstErrTcM, failWithTcM,
  22
  23         tcGetEnv, tcSetEnv,
  24         tcGetDefaultTys, tcSetDefaultTys,
  25         tcGetUnique, tcGetUniques,
  26         doptsTc, getDOptsTc,
  27
  28         tcAddSrcLoc, tcGetSrcLoc, tcGetInstLoc,
  29         tcAddErrCtxtM, tcSetErrCtxtM,
  30         tcAddErrCtxt, tcSetErrCtxt, tcPopErrCtxt,
  31
  32         tcNewMutVar, tcReadMutVar, tcWriteMutVar, TcRef,
  33         tcNewMutTyVar, tcReadMutTyVar, tcWriteMutTyVar,
  34
  35         InstOrigin(..), InstLoc, pprInstLoc,
  36
  37         TcError, TcWarning, TidyEnv, emptyTidyEnv,
  38         arityErr
  39   ) where
  40
  41 #include "HsVersions.h"
  42
  43 import {-# SOURCE #-} TcEnv  ( TcEnv )
  44
  45 import HsLit            ( HsOverLit )
  46 import RnHsSyn          ( RenamedPat, RenamedArithSeqInfo, RenamedHsExpr )
  47 import TcType           ( Type, Kind, TyVarDetails, IPName )
  48 import ErrUtils         ( addShortErrLocLine, addShortWarnLocLine, ErrMsg, Message, WarnMsg )
  49
  50 import Bag              ( Bag, emptyBag, isEmptyBag,
  51                           foldBag, unitBag, unionBags, snocBag )
  52 import Class            ( Class )
  53 import Name             ( Name )
  54 import Var              ( Id, TyVar, newMutTyVar, readMutTyVar, writeMutTyVar )
  55 import VarEnv           ( TidyEnv, emptyTidyEnv )
  56 import UniqSupply       ( UniqSupply, uniqFromSupply, uniqsFromSupply,
  57                           splitUniqSupply, mkSplitUniqSupply,
  58                           UniqSM, initUs_ )
  59 import SrcLoc           ( SrcLoc, noSrcLoc )
  60 import UniqFM           ( emptyUFM )
  61 import Unique           ( Unique )
  62 import CmdLineOpts
  63 import Outputable
  64
  65 import IOExts           ( IORef, newIORef, readIORef, writeIORef,
  66                           unsafeInterleaveIO, fixIO
  67                         )
  68
  69
  70 infixr 9 `thenTc`, `thenTc_`, `thenNF_Tc`, `thenNF_Tc_`
  71 \end{code}
  72
  73
  74 %************************************************************************
  75 %*                                                                      *
  76 \subsection{The main monads: TcM, NF_TcM}
  77 %*                                                                      *
  78 %************************************************************************
  79
  80 \begin{code}
  81 type NF_TcM r =  TcDown -> TcEnv -> IO r        -- Can't raise UserError
  82 type TcM    r =  TcDown -> TcEnv -> IO r        -- Can raise UserError
  83
  84 type Either_TcM r =  TcDown -> TcEnv -> IO r    -- Either NF_TcM or TcM
  85         -- Used only in this file for type signatures which
  86         -- have a part that's polymorphic in whether it's NF_TcM or TcM
  87         -- E.g. thenNF_Tc
  88
  89 type TcRef a = IORef a
  90 \end{code}
  91
  92 \begin{code}
  93
  94 initTc :: DynFlags
  95        -> TcEnv
  96        -> TcM r
  97        -> IO (Maybe r, (Bag WarnMsg, Bag ErrMsg))
  98
  99 initTc dflags tc_env do_this
 100   = do {
 101       us       <- mkSplitUniqSupply 'a' ;
 102       us_var   <- newIORef us ;
 103       errs_var <- newIORef (emptyBag,emptyBag) ;
 104       tvs_var  <- newIORef emptyUFM ;
 105
 106       let
 107           init_down = TcDown { tc_dflags = dflags, tc_def = [],
 108                                tc_us = us_var, tc_loc = noSrcLoc,
 109                                tc_ctxt = [], tc_errs = errs_var }
 110       ;
 111
 112       maybe_res <- catch (do {  res <- do_this init_down tc_env ;
 113                                 return (Just res)})
 114                          (\_ -> return Nothing) ;
 115
 116       (warns,errs) <- readIORef errs_var ;
 117       return (maybe_res, (warns, errs))
 118     }
 119
 120 -- Monadic operations
 121
 122 returnNF_Tc :: a -> NF_TcM a
 123 returnTc    :: a -> TcM a
 124 returnTc v down env = return v
 125
 126 thenTc    :: TcM a ->    (a -> TcM b)        -> TcM b
 127 thenNF_Tc :: NF_TcM a -> (a -> Either_TcM b) -> Either_TcM b
 128 thenTc m k down env = do { r <- m down env; k r down env }
 129
 130 thenTc_    :: TcM a    -> TcM b        -> TcM b
 131 thenNF_Tc_ :: NF_TcM a -> Either_TcM b -> Either_TcM b
 132 thenTc_ m k down env = do { m down env; k down env }
 133
 134 listTc    :: [TcM a]    -> TcM [a]
 135 listNF_Tc :: [NF_TcM a] -> NF_TcM [a]
 136 listTc []     = returnTc []
 137 listTc (x:xs) = x                       `thenTc` \ r ->
 138                 listTc xs               `thenTc` \ rs ->
 139                 returnTc (r:rs)
 140
 141 mapTc    :: (a -> TcM b)    -> [a] -> TcM [b]
 142 mapTc_   :: (a -> TcM b)    -> [a] -> TcM ()
 143 mapNF_Tc :: (a -> NF_TcM b) -> [a] -> NF_TcM [b]
 144 mapTc f []     = returnTc []
 145 mapTc f (x:xs) = f x            `thenTc` \ r ->
 146                  mapTc f xs     `thenTc` \ rs ->
 147                  returnTc (r:rs)
 148 mapTc_ f xs = mapTc f xs  `thenTc_` returnTc ()
 149
 150
 151 foldrTc    :: (a -> b -> TcM b)    -> b -> [a] -> TcM b
 152 foldrNF_Tc :: (a -> b -> NF_TcM b) -> b -> [a] -> NF_TcM b
 153 foldrTc k z []     = returnTc z
 154 foldrTc k z (x:xs) = foldrTc k z xs     `thenTc` \r ->
 155                      k x r
 156
 157 foldlTc    :: (a -> b -> TcM a)    -> a -> [b] -> TcM a
 158 foldlNF_Tc :: (a -> b -> NF_TcM a) -> a -> [b] -> NF_TcM a
 159 foldlTc k z []     = returnTc z
 160 foldlTc k z (x:xs) = k z x              `thenTc` \r ->
 161                      foldlTc k r xs
 162
 163 mapAndUnzipTc    :: (a -> TcM (b,c))    -> [a]   -> TcM ([b],[c])
 164 mapAndUnzipNF_Tc :: (a -> NF_TcM (b,c)) -> [a]   -> NF_TcM ([b],[c])
 165 mapAndUnzipTc f []     = returnTc ([],[])
 166 mapAndUnzipTc f (x:xs) = f x                    `thenTc` \ (r1,r2) ->
 167                          mapAndUnzipTc f xs     `thenTc` \ (rs1,rs2) ->
 168                          returnTc (r1:rs1, r2:rs2)
 169
 170 mapAndUnzip3Tc    :: (a -> TcM (b,c,d)) -> [a] -> TcM ([b],[c],[d])
 171 mapAndUnzip3Tc f []     = returnTc ([],[],[])
 172 mapAndUnzip3Tc f (x:xs) = f x                   `thenTc` \ (r1,r2,r3) ->
 173                           mapAndUnzip3Tc f xs   `thenTc` \ (rs1,rs2,rs3) ->
 174                           returnTc (r1:rs1, r2:rs2, r3:rs3)
 175
 176 mapBagTc    :: (a -> TcM b)    -> Bag a -> TcM (Bag b)
 177 mapBagNF_Tc :: (a -> NF_TcM b) -> Bag a -> NF_TcM (Bag b)
 178 mapBagTc f bag
 179   = foldBag (\ b1 b2 -> b1 `thenTc` \ r1 ->
 180                         b2 `thenTc` \ r2 ->
 181                         returnTc (unionBags r1 r2))
 182             (\ a -> f a `thenTc` \ r -> returnTc (unitBag r))
 183             (returnTc emptyBag)
 184             bag
 185
 186 fixTc    :: (a -> TcM a)    -> TcM a
 187 fixNF_Tc :: (a -> NF_TcM a) -> NF_TcM a
 188 fixTc m env down = fixIO (\ loop -> m loop env down)
 189 {-# NOINLINE fixTc #-}
 190 -- aargh!  Not inlining fixTc alleviates a space leak problem.
 191 -- Normally fixTc is used with a lazy tuple match: if the optimiser is
 192 -- shown the definition of fixTc, it occasionally transforms the code
 193 -- in such a way that the code generator doesn't spot the selector
 194 -- thunks.  Sigh.
 195
 196 recoverTc    :: TcM r -> TcM r -> TcM r
 197 recoverNF_Tc :: NF_TcM r -> TcM r -> NF_TcM r
 198 recoverTc recover m down env
 199   = catch (m down env) (\ _ -> recover down env)
 200
 201 returnNF_Tc      = returnTc
 202 thenNF_Tc        = thenTc
 203 thenNF_Tc_       = thenTc_
 204 fixNF_Tc         = fixTc
 205 recoverNF_Tc     = recoverTc
 206 mapNF_Tc         = mapTc
 207 foldrNF_Tc       = foldrTc
 208 foldlNF_Tc       = foldlTc
 209 listNF_Tc        = listTc
 210 mapAndUnzipNF_Tc = mapAndUnzipTc
 211 mapBagNF_Tc      = mapBagTc
 212 \end{code}
 213
 214 @forkNF_Tc@ runs a sub-typecheck action *lazily* in a separate state
 215 thread.  Ideally, this elegantly ensures that it can't zap any type
 216 variables that belong to the main thread.  But alas, the environment
 217 contains TyCon and Class environments that include TcKind stuff,
 218 which is a Royal Pain.  By the time this fork stuff is used they'll
 219 have been unified down so there won't be any kind variables, but we
 220 can't express that in the current typechecker framework.
 221
 222 So we compromise and use unsafeInterleaveIO.
 223
 224 We throw away any error messages!
 225
 226 \begin{code}
 227 forkNF_Tc :: NF_TcM r -> NF_TcM r
 228 forkNF_Tc m down@(TcDown { tc_us = u_var }) env
 229   = do
 230         -- Get a fresh unique supply
 231         us <- readIORef u_var
 232         let (us1, us2) = splitUniqSupply us
 233         writeIORef u_var us1
 234
 235         unsafeInterleaveIO (do {
 236                 us_var'  <- newIORef us2 ;
 237                 err_var' <- newIORef (emptyBag,emptyBag) ;
 238                 let { down' = down { tc_us = us_var', tc_errs = err_var' } };
 239                 m down' env
 240                         -- ToDo: optionally dump any error messages
 241                 })
 242 \end{code}
 243
 244 \begin{code}
 245 traceTc :: SDoc -> NF_TcM ()
 246 traceTc doc (TcDown { tc_dflags=dflags }) env
 247   | dopt Opt_D_dump_tc_trace dflags = printDump doc
 248   | otherwise                       = return ()
 249
 250 ioToTc :: IO a -> NF_TcM a
 251 ioToTc io down env = io
 252 \end{code}
 253
 254
 255 %************************************************************************
 256 %*                                                                      *
 257 \subsection{Error handling}
 258 %*                                                                      *
 259 %************************************************************************
 260
 261 \begin{code}
 262 getErrsTc :: NF_TcM (Bag WarnMsg, Bag ErrMsg)
 263 getErrsTc down env
 264   = readIORef (getTcErrs down)
 265
 266 failTc :: TcM a
 267 failTc down env = give_up
 268
 269 give_up :: IO a
 270 give_up = ioError (userError "Typecheck failed")
 271
 272 failWithTc :: Message -> TcM a                  -- Add an error message and fail
 273 failWithTc err_msg = failWithTcM (emptyTidyEnv, err_msg)
 274
 275 addErrTc :: Message -> NF_TcM ()
 276 addErrTc err_msg = addErrTcM (emptyTidyEnv, err_msg)
 277
 278 addErrsTc :: [Message] -> NF_TcM ()
 279 addErrsTc []       = returnNF_Tc ()
 280 addErrsTc err_msgs = listNF_Tc (map addErrTc err_msgs)  `thenNF_Tc_` returnNF_Tc ()
 281
 282 -- The 'M' variants do the TidyEnv bit
 283 failWithTcM :: (TidyEnv, Message) -> TcM a      -- Add an error message and fail
 284 failWithTcM env_and_msg
 285   = addErrTcM env_and_msg       `thenNF_Tc_`
 286     failTc
 287
 288 checkTc :: Bool -> Message -> TcM ()            -- Check that the boolean is true
 289 checkTc True  err = returnTc ()
 290 checkTc False err = failWithTc err
 291
 292 checkTcM :: Bool -> TcM () -> TcM ()    -- Check that the boolean is true
 293 checkTcM True  err = returnTc ()
 294 checkTcM False err = err
 295
 296 checkMaybeTc :: Maybe val -> Message -> TcM val
 297 checkMaybeTc (Just val) err = returnTc val
 298 checkMaybeTc Nothing    err = failWithTc err
 299
 300 checkMaybeTcM :: Maybe val -> TcM val -> TcM val
 301 checkMaybeTcM (Just val) err = returnTc val
 302 checkMaybeTcM Nothing    err = err
 303
 304 addErrTcM :: (TidyEnv, Message) -> NF_TcM ()    -- Add an error message but don't fail
 305 addErrTcM (tidy_env, err_msg) down env
 306   = add_err_tcm tidy_env err_msg ctxt loc down env
 307   where
 308     ctxt     = getErrCtxt down
 309     loc      = getLoc down
 310
 311 addInstErrTcM :: InstLoc -> (TidyEnv, Message) -> NF_TcM ()     -- Add an error message but don't fail
 312 addInstErrTcM inst_loc@(_, loc, ctxt) (tidy_env, err_msg) down env
 313   = add_err_tcm tidy_env err_msg full_ctxt loc down env
 314   where
 315     full_ctxt = (\env -> returnNF_Tc (env, pprInstLoc inst_loc)) : ctxt
 316
 317 add_err_tcm tidy_env err_msg ctxt loc down env
 318   = do
 319         (warns, errs) <- readIORef errs_var
 320         ctxt_msgs     <- do_ctxt tidy_env ctxt down env
 321         let err = addShortErrLocLine loc $
 322                   vcat (err_msg : ctxt_to_use ctxt_msgs)
 323         writeIORef errs_var (warns, errs `snocBag` err)
 324   where
 325     errs_var = getTcErrs down
 326
 327 do_ctxt tidy_env [] down env
 328   = return []
 329 do_ctxt tidy_env (c:cs) down env
 330   = do
 331         (tidy_env', m) <- c tidy_env down env
 332         ms             <- do_ctxt tidy_env' cs down env
 333         return (m:ms)
 334
 335 -- warnings don't have an 'M' variant
 336 warnTc :: Bool -> Message -> NF_TcM ()
 337 warnTc warn_if_true warn_msg down env
 338   | warn_if_true
 339   = do
 340         (warns,errs) <- readIORef errs_var
 341         ctxt_msgs    <- do_ctxt emptyTidyEnv ctxt down env
 342         let warn = addShortWarnLocLine loc $
 343                    vcat (warn_msg : ctxt_to_use ctxt_msgs)
 344         writeIORef errs_var (warns `snocBag` warn, errs)
 345   | otherwise
 346   = return ()
 347   where
 348     errs_var = getTcErrs down
 349     ctxt     = getErrCtxt down
 350     loc      = getLoc down
 351
 352 -- (tryTc r m) succeeds if m succeeds and generates no errors
 353 -- If m fails then r is invoked, passing the warnings and errors from m
 354 -- If m succeeds, (tryTc r m) checks whether m generated any errors messages
 355 --      (it might have recovered internally)
 356 --      If so, then r is invoked, passing the warnings and errors from m
 357
 358 tryTc :: ((Bag WarnMsg, Bag ErrMsg) -> TcM r)   -- Recovery action
 359       -> TcM r                          -- Thing to try
 360       -> TcM r
 361 tryTc recover main down env
 362   = do
 363         m_errs_var <- newIORef (emptyBag,emptyBag)
 364         catch (my_main m_errs_var) (\ _ -> my_recover m_errs_var)
 365   where
 366     errs_var = getTcErrs down
 367
 368     my_recover m_errs_var
 369       = do warns_and_errs <- readIORef m_errs_var
 370            recover warns_and_errs down env
 371
 372     my_main m_errs_var
 373        = do result <- main (setTcErrs down m_errs_var) env
 374
 375                 -- Check that m has no errors; if it has internal recovery
 376                 -- mechanisms it might "succeed" but having found a bunch of
 377                 -- errors along the way.
 378             (m_warns, m_errs) <- readIORef m_errs_var
 379             if isEmptyBag m_errs then
 380                 -- No errors, so return normally, but don't lose the warnings
 381                 if isEmptyBag m_warns then
 382                    return result
 383                 else
 384                    do (warns, errs) <- readIORef errs_var
 385                       writeIORef errs_var (warns `unionBags` m_warns, errs)
 386                       return result
 387               else
 388                 give_up         -- This triggers the catch
 389
 390
 391 -- (checkNoErrsTc m) succeeds iff m succeeds and generates no errors
 392 -- If m fails then (checkNoErrsTc m) fails.
 393 -- If m succeeds, it checks whether m generated any errors messages
 394 --      (it might have recovered internally)
 395 --      If so, it fails too.
 396 -- Regardless, any errors generated by m are propagated to the enclosing context.
 397 checkNoErrsTc :: TcM r -> TcM r
 398 checkNoErrsTc main
 399   = tryTc my_recover main
 400   where
 401     my_recover (m_warns, m_errs) down env
 402         = do (warns, errs)     <- readIORef errs_var
 403              writeIORef errs_var (warns `unionBags` m_warns,
 404                                   errs  `unionBags` m_errs)
 405              give_up
 406         where
 407           errs_var = getTcErrs down
 408
 409
 410 -- (tryTc_ r m) tries m; if it succeeds it returns it,
 411 -- otherwise it returns r.  Any error messages added by m are discarded,
 412 -- whether or not m succeeds.
 413 tryTc_ :: TcM r -> TcM r -> TcM r
 414 tryTc_ recover main
 415   = tryTc my_recover main
 416   where
 417     my_recover warns_and_errs = recover
 418
 419 -- (discardErrsTc m) runs m, but throw away all its error messages.
 420 discardErrsTc :: Either_TcM r -> Either_TcM r
 421 discardErrsTc main down env
 422   = do new_errs_var <- newIORef (emptyBag,emptyBag)
 423        main (setTcErrs down new_errs_var) env
 424 \end{code}
 425
 426
 427
 428 %************************************************************************
 429 %*                                                                      *
 430 \subsection{Mutable variables}
 431 %*                                                                      *
 432 %************************************************************************
 433
 434 \begin{code}
 435 tcNewMutVar :: a -> NF_TcM (TcRef a)
 436 tcNewMutVar val down env = newIORef val
 437
 438 tcWriteMutVar :: TcRef a -> a -> NF_TcM ()
 439 tcWriteMutVar var val down env = writeIORef var val
 440
 441 tcReadMutVar :: TcRef a -> NF_TcM a
 442 tcReadMutVar var down env = readIORef var
 443
 444 tcNewMutTyVar :: Name -> Kind -> TyVarDetails -> NF_TcM TyVar
 445 tcNewMutTyVar name kind details down env = newMutTyVar name kind details
 446
 447 tcReadMutTyVar :: TyVar -> NF_TcM (Maybe Type)
 448 tcReadMutTyVar tyvar down env = readMutTyVar tyvar
 449
 450 tcWriteMutTyVar :: TyVar -> Maybe Type -> NF_TcM ()
 451 tcWriteMutTyVar tyvar val down env = writeMutTyVar tyvar val
 452 \end{code}
 453
 454
 455 %************************************************************************
 456 %*                                                                      *
 457 \subsection{The environment}
 458 %*                                                                      *
 459 %************************************************************************
 460
 461 \begin{code}
 462 tcGetEnv :: NF_TcM TcEnv
 463 tcGetEnv down env = return env
 464
 465 tcSetEnv :: TcEnv -> Either_TcM a -> Either_TcM a
 466 tcSetEnv new_env m down old_env = m down new_env
 467 \end{code}
 468
 469
 470 %************************************************************************
 471 %*                                                                      *
 472 \subsection{Source location}
 473 %*                                                                      *
 474 %************************************************************************
 475
 476 \begin{code}
 477 tcGetDefaultTys :: NF_TcM [Type]
 478 tcGetDefaultTys down env = return (getDefaultTys down)
 479
 480 tcSetDefaultTys :: [Type] -> TcM r -> TcM r
 481 tcSetDefaultTys tys m down env = m (setDefaultTys down tys) env
 482
 483 tcAddSrcLoc :: SrcLoc -> Either_TcM a -> Either_TcM a
 484 tcAddSrcLoc loc m down env = m (setLoc down loc) env
 485
 486 tcGetSrcLoc :: NF_TcM SrcLoc
 487 tcGetSrcLoc down env = return (getLoc down)
 488
 489 tcGetInstLoc :: InstOrigin -> NF_TcM InstLoc
 490 tcGetInstLoc origin TcDown{tc_loc=loc, tc_ctxt=ctxt} env
 491    = return (origin, loc, ctxt)
 492
 493 tcSetErrCtxtM, tcAddErrCtxtM :: (TidyEnv -> NF_TcM (TidyEnv, Message))
 494                              -> TcM a -> TcM a
 495 tcSetErrCtxtM msg m down env = m (setErrCtxt down msg) env
 496 tcAddErrCtxtM msg m down env = m (addErrCtxt down msg) env
 497
 498 tcSetErrCtxt, tcAddErrCtxt :: Message -> Either_TcM r -> Either_TcM r
 499 -- Usual thing
 500 tcSetErrCtxt msg m down env = m (setErrCtxt down (\env -> returnNF_Tc (env, msg))) env
 501 tcAddErrCtxt msg m down env = m (addErrCtxt down (\env -> returnNF_Tc (env, msg))) env
 502
 503 tcPopErrCtxt :: Either_TcM r -> Either_TcM  r
 504 tcPopErrCtxt m down env = m (popErrCtxt down) env
 505 \end{code}
 506
 507
 508 %************************************************************************
 509 %*                                                                      *
 510 \subsection{Unique supply}
 511 %*                                                                      *
 512 %************************************************************************
 513
 514 \begin{code}
 515 tcGetUnique :: NF_TcM Unique
 516 tcGetUnique down env
 517   = do  uniq_supply <- readIORef u_var
 518         let (new_uniq_supply, uniq_s) = splitUniqSupply uniq_supply
 519             uniq                      = uniqFromSupply uniq_s
 520         writeIORef u_var new_uniq_supply
 521         return uniq
 522   where
 523     u_var = getUniqSupplyVar down
 524
 525 tcGetUniques :: NF_TcM [Unique]
 526 tcGetUniques down env
 527   = do  uniq_supply <- readIORef u_var
 528         let (new_uniq_supply, uniq_s) = splitUniqSupply uniq_supply
 529             uniqs                     = uniqsFromSupply uniq_s
 530         writeIORef u_var new_uniq_supply
 531         return uniqs
 532   where
 533     u_var = getUniqSupplyVar down
 534
 535 uniqSMToTcM :: UniqSM a -> NF_TcM a
 536 uniqSMToTcM m down env
 537   = do  uniq_supply <- readIORef u_var
 538         let (new_uniq_supply, uniq_s) = splitUniqSupply uniq_supply
 539         writeIORef u_var new_uniq_supply
 540         return (initUs_ uniq_s m)
 541   where
 542     u_var = getUniqSupplyVar down
 543 \end{code}
 544
 545
 546
 547 %************************************************************************
 548 %*                                                                      *
 549 \subsection{TcDown}
 550 %*                                                                      *
 551 %************************************************************************
 552
 553 \begin{code}
 554 data TcDown
 555    = TcDown {
 556         tc_dflags :: DynFlags,
 557         tc_def    :: [Type],                    -- Types used for defaulting
 558         tc_us     :: (TcRef UniqSupply),        -- Unique supply
 559         tc_loc    :: SrcLoc,                    -- Source location
 560         tc_ctxt   :: ErrCtxt,                   -- Error context
 561         tc_errs   :: (TcRef (Bag WarnMsg, Bag ErrMsg))
 562    }
 563
 564 type ErrCtxt = [TidyEnv -> NF_TcM (TidyEnv, Message)]
 565                         -- Innermost first.  Monadic so that we have a chance
 566                         -- to deal with bound type variables just before error
 567                         -- message construction
 568 \end{code}
 569
 570 -- These selectors are *local* to TcMonad.lhs
 571
 572 \begin{code}
 573 getTcErrs (TcDown{tc_errs=errs}) = errs
 574 setTcErrs down errs = down{tc_errs=errs}
 575
 576 getDefaultTys (TcDown{tc_def=def}) = def
 577 setDefaultTys down def = down{tc_def=def}
 578
 579 getLoc (TcDown{tc_loc=loc}) = loc
 580 setLoc down loc = down{tc_loc=loc}
 581
 582 getUniqSupplyVar (TcDown{tc_us=us}) = us
 583
 584 getErrCtxt (TcDown{tc_ctxt=ctxt}) = ctxt
 585 setErrCtxt down msg = down{tc_ctxt=[msg]}
 586 addErrCtxt down msg = down{tc_ctxt = msg : tc_ctxt down}
 587
 588 popErrCtxt down = case tc_ctxt down of
 589                         []     -> down
 590                         m : ms -> down{tc_ctxt = ms}
 591
 592 doptsTc :: DynFlag -> TcM Bool
 593 doptsTc dflag (TcDown{tc_dflags=dflags}) env_down
 594    = return (dopt dflag dflags)
 595
 596 getDOptsTc :: TcM DynFlags
 597 getDOptsTc (TcDown{tc_dflags=dflags}) env_down
 598    = return dflags
 599 \end{code}
 600
 601
 602
 603
 604 %************************************************************************
 605 %*                                                                      *
 606 \subsection{TypeChecking Errors}
 607 %*                                                                      *
 608 %************************************************************************
 609
 610 \begin{code}
 611 type TcError   = Message
 612 type TcWarning = Message
 613
 614 ctxt_to_use ctxt | opt_PprStyle_Debug = ctxt
 615                  | otherwise          = take 3 ctxt
 616
 617 arityErr kind name n m
 618   = hsep [ text kind, quotes (ppr name), ptext SLIT("should have"),
 619            n_arguments <> comma, text "but has been given", int m]
 620     where
 621         n_arguments | n == 0 = ptext SLIT("no arguments")
 622                     | n == 1 = ptext SLIT("1 argument")
 623                     | True   = hsep [int n, ptext SLIT("arguments")]
 624 \end{code}
 625
 626
 627
 628 %************************************************************************
 629 %*                                                                      *
 630 \subsection[Inst-origin]{The @InstOrigin@ type}
 631 %*                                                                      *
 632 %************************************************************************
 633
 634 The @InstOrigin@ type gives information about where a dictionary came from.
 635 This is important for decent error message reporting because dictionaries
 636 don't appear in the original source code.  Doubtless this type will evolve...
 637
 638 It appears in TcMonad because there are a couple of error-message-generation
 639 functions that deal with it.
 640
 641 \begin{code}
 642 type InstLoc = (InstOrigin, SrcLoc, ErrCtxt)
 643
 644 data InstOrigin
 645   = OccurrenceOf Id             -- Occurrence of an overloaded identifier
 646
 647   | IPOcc (IPName Name)         -- Occurrence of an implicit parameter
 648   | IPBind (IPName Name)        -- Binding site of an implicit parameter
 649
 650   | RecordUpdOrigin
 651
 652   | DataDeclOrigin              -- Typechecking a data declaration
 653
 654   | InstanceDeclOrigin          -- Typechecking an instance decl
 655
 656   | LiteralOrigin HsOverLit     -- Occurrence of a literal
 657
 658   | PatOrigin RenamedPat
 659
 660   | ArithSeqOrigin RenamedArithSeqInfo -- [x..], [x..y] etc
 661
 662   | SignatureOrigin             -- A dict created from a type signature
 663   | Rank2Origin                 -- A dict created when typechecking the argument
 664                                 -- of a rank-2 typed function
 665
 666   | DoOrigin                    -- The monad for a do expression
 667
 668   | ClassDeclOrigin             -- Manufactured during a class decl
 669
 670   | InstanceSpecOrigin  Class   -- in a SPECIALIZE instance pragma
 671                         Type
 672
 673         -- When specialising instances the instance info attached to
 674         -- each class is not yet ready, so we record it inside the
 675         -- origin information.  This is a bit of a hack, but it works
 676         -- fine.  (Patrick is to blame [WDP].)
 677
 678   | ValSpecOrigin       Name    -- in a SPECIALIZE pragma for a value
 679
 680         -- Argument or result of a ccall
 681         -- Dictionaries with this origin aren't actually mentioned in the
 682         -- translated term, and so need not be bound.  Nor should they
 683         -- be abstracted over.
 684
 685   | CCallOrigin         String                  -- CCall label
 686                         (Maybe RenamedHsExpr)   -- Nothing if it's the result
 687                                                 -- Just arg, for an argument
 688
 689   | LitLitOrigin        String  -- the litlit
 690
 691   | UnknownOrigin       -- Help! I give up...
 692 \end{code}
 693
 694 \begin{code}
 695 pprInstLoc :: InstLoc -> SDoc
 696 pprInstLoc (orig, locn, ctxt)
 697   = hsep [text "arising from", pp_orig orig, text "at", ppr locn]
 698   where
 699     pp_orig (OccurrenceOf id)
 700         = hsep [ptext SLIT("use of"), quotes (ppr id)]
 701     pp_orig (IPOcc name)
 702         = hsep [ptext SLIT("use of implicit parameter"), quotes (char '?' <> ppr name)]
 703     pp_orig (IPBind name)
 704         = hsep [ptext SLIT("binding for implicit parameter"), quotes (char '?' <> ppr name)]
 705     pp_orig RecordUpdOrigin
 706         = ptext SLIT("a record update")
 707     pp_orig DataDeclOrigin
 708         = ptext SLIT("the data type declaration")
 709     pp_orig InstanceDeclOrigin
 710         = ptext SLIT("the instance declaration")
 711     pp_orig (LiteralOrigin lit)
 712         = hsep [ptext SLIT("the literal"), quotes (ppr lit)]
 713     pp_orig (PatOrigin pat)
 714         = hsep [ptext SLIT("the pattern"), quotes (ppr pat)]
 715     pp_orig (ArithSeqOrigin seq)
 716         = hsep [ptext SLIT("the arithmetic sequence"), quotes (ppr seq)]
 717     pp_orig (SignatureOrigin)
 718         =  ptext SLIT("a type signature")
 719     pp_orig (Rank2Origin)
 720         =  ptext SLIT("a function with an overloaded argument type")
 721     pp_orig (DoOrigin)
 722         =  ptext SLIT("a do statement")
 723     pp_orig (ClassDeclOrigin)
 724         =  ptext SLIT("a class declaration")
 725     pp_orig (InstanceSpecOrigin clas ty)
 726         = hsep [text "a SPECIALIZE instance pragma; class",
 727                 quotes (ppr clas), text "type:", ppr ty]
 728     pp_orig (ValSpecOrigin name)
 729         = hsep [ptext SLIT("a SPECIALIZE user-pragma for"), quotes (ppr name)]
 730     pp_orig (CCallOrigin clabel Nothing{-ccall result-})
 731         = hsep [ptext SLIT("the result of the _ccall_ to"), quotes (text clabel)]
 732     pp_orig (CCallOrigin clabel (Just arg_expr))
 733         = hsep [ptext SLIT("an argument in the _ccall_ to"), quotes (text clabel) <> comma,
 734                 text "namely", quotes (ppr arg_expr)]
 735     pp_orig (LitLitOrigin s)
 736         = hsep [ptext SLIT("the ``literal-literal''"), quotes (text s)]
 737     pp_orig (UnknownOrigin)
 738         = ptext SLIT("...oops -- I don't know where the overloading came from!")
 739 \end{code}