TcErrors.hs 99.2 KB
Newer Older
1
{-# LANGUAGE CPP, ScopedTypeVariables #-}
2 3

module TcErrors(
4
       reportUnsolved, reportAllUnsolved, warnAllUnsolved,
5
       warnDefaulting,
6 7

       solverDepthErrorTcS
8 9 10 11
  ) where

#include "HsVersions.h"

12
import TcRnTypes
13 14 15
import TcRnMonad
import TcMType
import TcType
16
import RnEnv( unknownNameSuggestions )
batterseapower's avatar
batterseapower committed
17
import Type
18 19
import TyCoRep
import Kind
20
import Unify            ( tcMatchTys )
21
import Module
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
22
import FamInst
23
import FamInstEnv       ( flattenTys )
24 25 26
import Inst
import InstEnv
import TyCon
27
import Class
28
import DataCon
29
import TcEvidence
30
import HsBinds ( PatSynBind(..) )
31
import Name
32
import RdrName ( lookupGRE_Name, GlobalRdrEnv, mkRdrUnqual )
33 34
import PrelNames ( typeableClassName, hasKey, ptrRepLiftedDataConKey
                 , ptrRepUnliftedDataConKey )
35
import Id
36 37 38
import Var
import VarSet
import VarEnv
39
import NameSet
40
import Bag
41
import ErrUtils         ( ErrMsg, errDoc, pprLocErrMsg )
42
import BasicTypes
43
import ConLike          ( ConLike(..) )
44 45 46
import Util
import FastString
import Outputable
47
import SrcLoc
48
import DynFlags
49
import StaticFlags      ( opt_PprStyle_Debug )
50
import ListSetOps       ( equivClasses )
51
import Maybes
52
import qualified GHC.LanguageExtensions as LangExt
Icelandjack's avatar
Icelandjack committed
53

54
import Control.Monad    ( when )
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
55
import Data.List        ( partition, mapAccumL, nub, sortBy )
56

57 58 59 60
#if __GLASGOW_HASKELL__ > 710
import Data.Semigroup   ( Semigroup )
import qualified Data.Semigroup as Semigroup
#endif
61 62


Austin Seipp's avatar
Austin Seipp committed
63 64 65
{-
************************************************************************
*                                                                      *
66
\section{Errors and contexts}
Austin Seipp's avatar
Austin Seipp committed
67 68
*                                                                      *
************************************************************************
69 70 71 72 73

ToDo: for these error messages, should we note the location as coming
from the insts, or just whatever seems to be around in the monad just
now?

74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92
Note [Deferring coercion errors to runtime]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
While developing, sometimes it is desirable to allow compilation to succeed even
if there are type errors in the code. Consider the following case:

  module Main where

  a :: Int
  a = 'a'

  main = print "b"

Even though `a` is ill-typed, it is not used in the end, so if all that we're
interested in is `main` it is handy to be able to ignore the problems in `a`.

Since we treat type equalities as evidence, this is relatively simple. Whenever
we run into a type mismatch in TcUnify, we normally just emit an error. But it
is always safe to defer the mismatch to the main constraint solver. If we do
that, `a` will get transformed into
93

94 95 96 97 98 99 100 101 102 103 104 105 106 107
  co :: Int ~ Char
  co = ...

  a :: Int
  a = 'a' `cast` co

The constraint solver would realize that `co` is an insoluble constraint, and
emit an error with `reportUnsolved`. But we can also replace the right-hand side
of `co` with `error "Deferred type error: Int ~ Char"`. This allows the program
to compile, and it will run fine unless we evaluate `a`. This is what
`deferErrorsToRuntime` does.

It does this by keeping track of which errors correspond to which coercion
in TcErrors. TcErrors.reportTidyWanteds does not print the errors
108
and does not fail if -fdefer-type-errors is on, so that we can continue
109
compilation. The errors are turned into warnings in `reportUnsolved`.
Austin Seipp's avatar
Austin Seipp committed
110
-}
111

112 113
-- | Report unsolved goals as errors or warnings. We may also turn some into
-- deferred run-time errors if `-fdefer-type-errors` is on.
114 115
reportUnsolved :: WantedConstraints -> TcM (Bag EvBind)
reportUnsolved wanted
116 117 118 119 120 121
  = do { binds_var <- newTcEvBinds
       ; defer_errors <- goptM Opt_DeferTypeErrors
       ; warn_errors <- woptM Opt_WarnDeferredTypeErrors -- implement #10283
       ; let type_errors | not defer_errors = TypeError
                         | warn_errors      = TypeWarn
                         | otherwise        = TypeDefer
122

123
       ; defer_holes <- goptM Opt_DeferTypedHoles
124 125 126 127 128
       ; warn_holes  <- woptM Opt_WarnTypedHoles
       ; let expr_holes | not defer_holes = HoleError
                        | warn_holes      = HoleWarn
                        | otherwise       = HoleDefer

129
       ; partial_sigs      <- xoptM LangExt.PartialTypeSignatures
thomasw's avatar
thomasw committed
130
       ; warn_partial_sigs <- woptM Opt_WarnPartialTypeSignatures
131 132 133 134
       ; let type_holes | not partial_sigs  = HoleError
                        | warn_partial_sigs = HoleWarn
                        | otherwise         = HoleDefer

135
       ; report_unsolved (Just binds_var) False type_errors expr_holes type_holes wanted
136 137
       ; getTcEvBinds binds_var }

138
-- | Report *all* unsolved goals as errors, even if -fdefer-type-errors is on
Simon Peyton Jones's avatar
Simon Peyton Jones committed
139 140
-- However, do not make any evidence bindings, because we don't
-- have any convenient place to put them.
141
-- See Note [Deferring coercion errors to runtime]
Simon Peyton Jones's avatar
Simon Peyton Jones committed
142 143 144
-- Used by solveEqualities for kind equalities
--      (see Note [Fail fast on kind errors] in TcSimplify]
-- and for simplifyDefault.
145
reportAllUnsolved :: WantedConstraints -> TcM ()
146
reportAllUnsolved wanted
147
  = report_unsolved Nothing False TypeError HoleError HoleError wanted
148

149 150 151 152 153
-- | Report all unsolved goals as warnings (but without deferring any errors to
-- run-time). See Note [Safe Haskell Overlapping Instances Implementation] in
-- TcSimplify
warnAllUnsolved :: WantedConstraints -> TcM ()
warnAllUnsolved wanted
154
  = report_unsolved Nothing True TypeWarn HoleWarn HoleWarn wanted
155 156

-- | Report unsolved goals as errors or warnings.
157
report_unsolved :: Maybe EvBindsVar  -- cec_binds
158
                -> Bool              -- Errors as warnings
159
                -> TypeErrorChoice   -- Deferred type errors
160 161
                -> HoleChoice        -- Expression holes
                -> HoleChoice        -- Type holes
162
                -> WantedConstraints -> TcM ()
163
report_unsolved mb_binds_var err_as_warn type_errors expr_holes type_holes wanted
164
  | isEmptyWC wanted
165
  = return ()
166
  | otherwise
167
  = do { traceTc "reportUnsolved (before zonking and tidying)" (ppr wanted)
168

169
       ; wanted <- zonkWC wanted   -- Zonk to reveal all information
170
       ; env0 <- tcInitTidyEnv
171 172
            -- If we are deferring we are going to need /all/ evidence around,
            -- including the evidence produced by unflattening (zonkWC)
173 174
       ; let tidy_env = tidyFreeTyCoVars env0 free_tvs
             free_tvs = tyCoVarsOfWC wanted
175 176 177 178 179 180 181

       ; traceTc "reportUnsolved (after zonking and tidying):" $
         vcat [ pprTvBndrs (varSetElems free_tvs)
              , ppr wanted ]

       ; warn_redundant <- woptM Opt_WarnRedundantConstraints
       ; let err_ctxt = CEC { cec_encl  = []
182
                            , cec_tidy  = tidy_env
183
                            , cec_defer_type_errors = type_errors
184
                            , cec_errors_as_warns = err_as_warn
185 186
                            , cec_expr_holes = expr_holes
                            , cec_type_holes = type_holes
187
                            , cec_suppress = False -- See Note [Suppressing error messages]
188
                            , cec_warn_redundant = warn_redundant
189
                            , cec_binds    = mb_binds_var }
190

191 192
       ; tc_lvl <- getTcLevel
       ; reportWanteds err_ctxt tc_lvl wanted }
193

194 195 196
--------------------------------------------
--      Internal functions
--------------------------------------------
197

198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217
-- | An error Report collects messages categorised by their importance.
-- See Note [Error report] for details.
data Report
  = Report { report_important :: [SDoc]
           , report_relevant_bindings :: [SDoc]
           }

{- Note [Error report]
The idea is that error msgs are divided into three parts: the main msg, the
context block (\"In the second argument of ...\"), and the relevant bindings
block, which are displayed in that order, with a mark to divide them.  The
idea is that the main msg ('report_important') varies depending on the error
in question, but context and relevant bindings are always the same, which
should simplify visual parsing.

The context is added when the the Report is passed off to 'mkErrorReport'.
Unfortunately, unlike the context, the relevant bindings are added in
multiple places so they have to be in the Report.
-}

218 219 220 221 222
#if __GLASGOW_HASKELL__ > 710
instance Semigroup Report where
    Report a1 b1 <> Report a2 b2 = Report (a1 ++ a2) (b1 ++ b2)
#endif

223 224 225 226 227 228 229 230 231 232 233 234
instance Monoid Report where
    mempty = Report [] []
    mappend (Report a1 b1) (Report a2 b2) = Report (a1 ++ a2) (b1 ++ b2)

-- | Put a doc into the important msgs block.
important :: SDoc -> Report
important doc = mempty { report_important = [doc] }

-- | Put a doc into the relevant bindings block.
relevant_bindings :: SDoc -> Report
relevant_bindings doc = mempty { report_relevant_bindings = [doc] }

235 236 237 238 239
data TypeErrorChoice   -- What to do for type errors found by the type checker
  = TypeError     -- A type error aborts compilation with an error message
  | TypeWarn      -- A type error is deferred to runtime, plus a compile-time warning
  | TypeDefer     -- A type error is deferred to runtime; no error or warning at compile time

240 241 242 243 244
data HoleChoice
  = HoleError     -- A hole is a compile-time error
  | HoleWarn      -- Defer to runtime, emit a compile-time warning
  | HoleDefer     -- Defer to runtime, no warning

245
data ReportErrCtxt
246
    = CEC { cec_encl :: [Implication]  -- Enclosing implications
247
                                       --   (innermost first)
248
                                       -- ic_skols and givens are tidied, rest are not
249
          , cec_tidy  :: TidyEnv
Simon Peyton Jones's avatar
Simon Peyton Jones committed
250

251
          , cec_binds :: Maybe EvBindsVar
Simon Peyton Jones's avatar
Simon Peyton Jones committed
252 253 254 255 256 257 258
                         -- Nothing <=> Report all errors, including holes
                         --             Do not add any evidence bindings, because
                         --             we have no convenient place to put them
                         --             See TcErrors.reportAllUnsolved
                         -- Just ev <=> make some errors (depending on cec_defer)
                         --             into warnings, and emit evidence bindings
                         --             into 'ev' for unsolved constraints
259

260 261 262 263
          , cec_errors_as_warns :: Bool   -- Turn all errors into warnings
                                          -- (except for Holes, which are
                                          -- controlled by cec_type_holes and
                                          -- cec_expr_holes)
264 265
          , cec_defer_type_errors :: TypeErrorChoice -- Defer type errors until runtime
                                                     -- Irrelevant if cec_binds = Nothing
266

267 268
          , cec_expr_holes :: HoleChoice  -- Holes in expressions
          , cec_type_holes :: HoleChoice  -- Holes in types
269

270
          , cec_warn_redundant :: Bool    -- True <=> -Wredundant-constraints
271

272 273 274
          , cec_suppress :: Bool    -- True <=> More important errors have occurred,
                                    --          so create bindings if need be, but
                                    --          don't issue any more errors/warnings
275
                                    -- See Note [Suppressing error messages]
276 277
      }

Austin Seipp's avatar
Austin Seipp committed
278
{-
279 280
Note [Suppressing error messages]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
281
The cec_suppress flag says "don't report any errors".  Instead, just create
282
evidence bindings (as usual).  It's used when more important errors have occurred.
283

284 285 286
Specifically (see reportWanteds)
  * If there are insoluble Givens, then we are in unreachable code and all bets
    are off.  So don't report any further errors.
287
  * If there are any insolubles (eg Int~Bool), here or in a nested implication,
288 289
    then suppress errors from the simple constraints here.  Sometimes the
    simple-constraint errors are a knock-on effect of the insolubles.
Austin Seipp's avatar
Austin Seipp committed
290
-}
291

292 293
reportImplic :: ReportErrCtxt -> Implication -> TcM ()
reportImplic ctxt implic@(Implic { ic_skols = tvs, ic_given = given
294
                                 , ic_wanted = wanted, ic_binds = m_evb
295
                                 , ic_status = status, ic_info = info
296
                                 , ic_env = tcl_env, ic_tclvl = tc_lvl })
297
  | BracketSkol <- info
298
  , not insoluble
299 300
  = return ()        -- For Template Haskell brackets report only
                     -- definite errors. The whole thing will be re-checked
Simon Peyton Jones's avatar
Simon Peyton Jones committed
301 302
                     -- later when we plug it in, and meanwhile there may
                     -- certainly be un-satisfied constraints
303 304

  | otherwise
305
  = do { reportWanteds ctxt' tc_lvl wanted
306 307 308
       ; traceTc "reportImplic" (ppr implic)
       ; when (cec_warn_redundant ctxt) $
         warnRedundantConstraints ctxt' tcl_env info' dead_givens }
309
  where
310
    insoluble    = isInsolubleStatus status
311
    (env1, tvs') = mapAccumL tidyTyCoVarBndr (cec_tidy ctxt) tvs
Simon Peyton Jones's avatar
Simon Peyton Jones committed
312
    info'        = tidySkolemInfo env1 info
313
    implic' = implic { ic_skols = tvs'
Simon Peyton Jones's avatar
Simon Peyton Jones committed
314
                     , ic_given = map (tidyEvVar env1) given
315
                     , ic_info  = info' }
Simon Peyton Jones's avatar
Simon Peyton Jones committed
316
    ctxt' = ctxt { cec_tidy     = env1
317
                 , cec_encl     = implic' : cec_encl ctxt
318 319 320 321 322 323 324

                 , cec_suppress = insoluble || cec_suppress ctxt
                      -- Suppress inessential errors if there
                      -- are are insolubles anywhere in the
                      -- tree rooted here, or we've come across
                      -- a suppress-worthy constraint higher up (Trac #11541)

325
                 , cec_binds    = cec_binds ctxt *> m_evb }
326 327 328 329 330
                      -- If cec_binds ctxt is Nothing, that means
                      -- we're reporting *all* errors. Don't change
                      -- that behavior just because we're going into
                      -- an implication.

331 332 333 334 335 336
    dead_givens = case status of
                    IC_Solved { ics_dead = dead } -> dead
                    _                             -> []

warnRedundantConstraints :: ReportErrCtxt -> TcLclEnv -> SkolemInfo -> [EvVar] -> TcM ()
warnRedundantConstraints ctxt env info ev_vars
337
 | null redundant_evs
338 339 340 341 342
 = return ()

 | SigSkol {} <- info
 = setLclEnv env $  -- We want to add "In the type signature for f"
                    -- to the error context, which is a bit tiresome
343
   addErrCtxt (text "In" <+> ppr info) $
344
   do { env <- getLclEnv
345
      ; msg <- mkErrorReport ctxt env (important doc)
346
      ; reportWarning (Reason Opt_WarnRedundantConstraints) msg }
347 348 349 350

 | otherwise  -- But for InstSkol there already *is* a surrounding
              -- "In the instance declaration for Eq [a]" context
              -- and we don't want to say it twice. Seems a bit ad-hoc
351
 = do { msg <- mkErrorReport ctxt env (important doc)
352
      ; reportWarning (Reason Opt_WarnRedundantConstraints) msg }
353
 where
354
   doc = text "Redundant constraint" <> plural redundant_evs <> colon
355 356 357 358 359 360 361
         <+> pprEvVarTheta redundant_evs

   redundant_evs = case info of -- See Note [Redundant constraints in instance decls]
                     InstSkol -> filterOut improving ev_vars
                     _        -> ev_vars

   improving ev_var = any isImprovementPred $
362
                      transSuperClasses (idType ev_var)
363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379

{- Note [Redundant constraints in instance decls]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
For instance declarations, we don't report unused givens if
they can give rise to improvement.  Example (Trac #10100):
    class Add a b ab | a b -> ab, a ab -> b
    instance Add Zero b b
    instance Add a b ab => Add (Succ a) b (Succ ab)
The context (Add a b ab) for the instance is clearly unused in terms
of evidence, since the dictionary has no feilds.  But it is still
needed!  With the context, a wanted constraint
   Add (Succ Zero) beta (Succ Zero)
we will reduce to (Add Zero beta Zero), and thence we get beta := Zero.
But without the context we won't find beta := Zero.

This only matters in instance declarations..
-}
380

381 382
reportWanteds :: ReportErrCtxt -> TcLevel -> WantedConstraints -> TcM ()
reportWanteds ctxt tc_lvl (WC { wc_simple = simples, wc_insol = insols, wc_impl = implics })
383 384
  = do { traceTc "reportWanteds" (vcat [ text "Simples =" <+> ppr simples
                                       , text "Suppress =" <+> ppr (cec_suppress ctxt)])
385
       ; let tidy_cts = bagToList (mapBag (tidyCt env) (insols `unionBags` simples))
386 387 388 389

         -- First deal with things that are utterly wrong
         -- Like Int ~ Bool (incl nullary TyCons)
         -- or  Int ~ t a   (AppTy on one side)
390 391 392 393 394 395 396 397 398
         -- These ones are not suppressed by the incoming context
       ; let ctxt_for_insols = ctxt { cec_suppress = False }
       ; (ctxt1, cts1) <- tryReporters ctxt_for_insols report1 tidy_cts

         -- Now all the other constraints.  We suppress errors here if
         -- any of the first batch failed, or if the enclosing context
         -- says to suppress
       ; let ctxt2 = ctxt { cec_suppress = cec_suppress ctxt || cec_suppress ctxt1 }
       ; (_, leftovers) <- tryReporters ctxt2 report2 cts1
399 400
       ; MASSERT2( null leftovers, ppr leftovers )

401
            -- All the Derived ones have been filtered out of simples
402 403 404
            -- by the constraint solver. This is ok; we don't want
            -- to report unsolved Derived goals as errors
            -- See Note [Do not report derived but soluble errors]
405

406
     ; mapBagM_ (reportImplic ctxt2) implics }
407
            -- NB ctxt1: don't suppress inner insolubles if there's only a
408
            -- wanted insoluble here; but do suppress inner insolubles
409
            -- if there's a *given* insoluble here (= inaccessible code)
410
 where
411
    env = cec_tidy ctxt
412

413 414 415 416 417 418
    -- report1: ones that should *not* be suppresed by
    --          an insoluble somewhere else in the tree
    -- It's crucial that anything that is considered insoluble
    -- (see TcRnTypes.trulyInsoluble) is caught here, otherwise
    -- we might suppress its error message, and proceed on past
    -- type checking to get a Lint error later
419 420
    report1 = [ ("custom_error", is_user_type_error,
                                                  True, mkUserTypeErrorReporter)
421
              , ("insoluble1",   is_given_eq,     True, mkGroupReporter mkEqErr)
422
              , ("insoluble2",   utterly_wrong,   True, mkGroupReporter mkEqErr)
423 424 425
              , ("skolem eq1",   very_wrong,      True, mkSkolReporter)
              , ("skolem eq2",   skolem_eq,       True, mkSkolReporter)
              , ("non-tv eq",    non_tv_eq,       True, mkSkolReporter)
426 427 428 429 430 431 432 433 434 435 436 437
              , ("Out of scope", is_out_of_scope, True,  mkHoleReporter)
              , ("Holes",        is_hole,         False, mkHoleReporter)

                  -- The only remaining equalities are alpha ~ ty,
                  -- where alpha is untouchable; and representational equalities
              , ("Other eqs",    is_equality,     False, mkGroupReporter mkEqErr) ]

    -- report2: we suppress these if there are insolubles elsewhere in the tree
    report2 = [ ("Implicit params", is_ip,           False, mkGroupReporter mkIPErr)
              , ("Irreds",          is_irred,        False, mkGroupReporter mkIrredErr)
              , ("Dicts",           is_dict,         False, mkGroupReporter mkDictErr) ]

438 439
    -- rigid_nom_eq, rigid_nom_tv_eq,
    is_hole, is_dict,
440
      is_equality, is_ip, is_irred :: Ct -> PredTree -> Bool
441

442 443 444 445 446
    is_given_eq ct pred
       | EqPred {} <- pred = arisesFromGivens ct
       | otherwise         = False
       -- I think all given residuals are equalities

447 448 449 450 451 452 453
    -- Things like (Int ~N Bool)
    utterly_wrong _ (EqPred NomEq ty1 ty2) = isRigidTy ty1 && isRigidTy ty2
    utterly_wrong _ _                      = False

    -- Things like (a ~N Int)
    very_wrong _ (EqPred NomEq ty1 ty2) = isSkolemTy tc_lvl ty1 && isRigidTy ty2
    very_wrong _ _                      = False
454

455
    -- Things like (a ~N b) or (a  ~N  F Bool)
456
    skolem_eq _ (EqPred NomEq ty1 _) = isSkolemTy tc_lvl ty1
457
    skolem_eq _ _                    = False
458

459 460 461 462 463 464 465 466 467 468 469 470 471 472
    -- Things like (F a  ~N  Int)
    non_tv_eq _ (EqPred NomEq ty1 _) = not (isTyVarTy ty1)
    non_tv_eq _ _                    = False

--    rigid_nom_eq _ pred = isRigidEqPred tc_lvl pred
--
--    rigid_nom_tv_eq _ pred
--      | EqPred _ ty1 _ <- pred = isRigidEqPred tc_lvl pred && isTyVarTy ty1
--      | otherwise              = False

    is_out_of_scope ct _ = isOutOfScopeCt ct
    is_hole         ct _ = isHoleCt ct

    is_user_type_error ct _ = isUserTypeErrorCt ct
473

474 475 476
    is_equality _ (EqPred {}) = True
    is_equality _ _           = False

477 478 479 480 481 482 483 484 485 486
    is_dict _ (ClassPred {}) = True
    is_dict _ _              = False

    is_ip _ (ClassPred cls _) = isIPClass cls
    is_ip _ _                 = False

    is_irred _ (IrredPred {}) = True
    is_irred _ _              = False


487
---------------
488
isSkolemTy :: TcLevel -> Type -> Bool
489
-- The type is a skolem tyvar
490
isSkolemTy tc_lvl ty
491 492 493 494 495 496 497 498
  | Just tv <- getTyVar_maybe ty
  =  isSkolemTyVar tv
  || (isSigTyVar tv && isTouchableMetaTyVar tc_lvl tv)
     -- The last case is for touchable SigTvs
     -- we postpone untouchables to a latter test (too obscure)

  | otherwise
  = False
499

500 501
isTyFun_maybe :: Type -> Maybe TyCon
isTyFun_maybe ty = case tcSplitTyConApp_maybe ty of
502
                      Just (tc,_) | isTypeFamilyTyCon tc -> Just tc
503 504
                      _ -> Nothing

505
--------------------------------------------
506
--      Reporters
507 508
--------------------------------------------

509 510 511 512 513 514 515 516 517
type Reporter
  = ReportErrCtxt -> [Ct] -> TcM ()
type ReporterSpec
  = ( String                     -- Name
    , Ct -> PredTree -> Bool     -- Pick these ones
    , Bool                       -- True <=> suppress subsequent reporters
    , Reporter)                  -- The reporter itself

mkSkolReporter :: Reporter
518
-- Suppress duplicates with either the same LHS, or same location
519
mkSkolReporter ctxt cts
520
  = mapM_ (reportGroup mkEqErr ctxt) (group cts)
521
  where
522 523 524 525 526 527 528 529 530
     group [] = []
     group (ct:cts) = (ct : yeses) : group noes
        where
          (yeses, noes) = partition (group_with ct) cts

     group_with ct1 ct2
       | EQ <- cmp_loc      ct1 ct2 = True
       | EQ <- cmp_lhs_type ct1 ct2 = True
       | otherwise                  = False
531

532
mkHoleReporter :: Reporter
533
-- Reports errors one at a time
534
mkHoleReporter ctxt
535
  = mapM_ $ \ct ->
536 537
    do { err <- mkHoleError ctxt ct
       ; maybeReportHoleError ctxt ct err
538
       ; maybeAddDeferredHoleBinding ctxt err ct }
539

540 541 542 543 544 545
mkUserTypeErrorReporter :: Reporter
mkUserTypeErrorReporter ctxt
  = mapM_ $ \ct -> maybeReportError ctxt =<< mkUserTypeError ctxt ct

mkUserTypeError :: ReportErrCtxt -> Ct -> TcM ErrMsg
mkUserTypeError ctxt ct = mkErrorMsgFromCt ctxt ct
546
                        $ important
547 548
                        $ pprUserTypeErrorTy
                        $ case getUserTypeErrorMsg ct of
549 550
                            Just msg -> msg
                            Nothing  -> pprPanic "mkUserTypeError" (ppr ct)
551 552


553 554 555
mkGroupReporter :: (ReportErrCtxt -> [Ct] -> TcM ErrMsg)
                             -- Make error message for a group
                -> Reporter  -- Deal with lots of constraints
556 557 558 559 560
-- Group together errors from same location,
-- and report only the first (to avoid a cascade)
mkGroupReporter mk_err ctxt cts
  = mapM_ (reportGroup mk_err ctxt) (equivClasses cmp_loc cts)
  where
561 562 563 564 565 566 567 568 569 570

cmp_lhs_type :: Ct -> Ct -> Ordering
cmp_lhs_type ct1 ct2
  = case (classifyPredType (ctPred ct1), classifyPredType (ctPred ct2)) of
       (EqPred eq_rel1 ty1 _, EqPred eq_rel2 ty2 _) ->
         (eq_rel1 `compare` eq_rel2) `thenCmp` (ty1 `cmpType` ty2)
       _ -> pprPanic "mkSkolReporter" (ppr ct1 $$ ppr ct2)

cmp_loc :: Ct -> Ct -> Ordering
cmp_loc ct1 ct2 = ctLocSpan (ctLoc ct1) `compare` ctLocSpan (ctLoc ct2)
571

572 573
reportGroup :: (ReportErrCtxt -> [Ct] -> TcM ErrMsg) -> ReportErrCtxt
            -> [Ct] -> TcM ()
quchen's avatar
quchen committed
574 575 576 577
reportGroup mk_err ctxt cts =
  case partition isMonadFailInstanceMissing cts of
        -- Only warn about missing MonadFail constraint when
        -- there are no other missing contstraints!
578 579 580
        (monadFailCts, []) ->
            do { err <- mk_err ctxt monadFailCts
               ; reportWarning (Reason Opt_WarnMissingMonadFailInstances) err }
quchen's avatar
quchen committed
581 582 583 584 585 586 587 588 589 590 591

        (_, cts') -> do { err <- mk_err ctxt cts'
                        ; maybeReportError ctxt err
                        ; mapM_ (maybeAddDeferredBinding ctxt err) cts' }
                                -- Add deferred bindings for all
                                -- But see Note [Always warn with -fdefer-type-errors]
  where
    isMonadFailInstanceMissing ct =
        case ctLocOrigin (ctLoc ct) of
            FailablePattern _pat -> True
            _otherwise           -> False
592

593 594
maybeReportHoleError :: ReportErrCtxt -> Ct -> ErrMsg -> TcM ()
maybeReportHoleError ctxt ct err
thomasw's avatar
thomasw committed
595
  -- When -XPartialTypeSignatures is on, warnings (instead of errors) are
596 597 598
  -- generated for holes in partial type signatures.
  -- Unless -fwarn_partial_type_signatures is not on,
  -- in which case the messages are discarded.
599 600 601 602 603
  | isTypeHoleCt ct
  = -- For partial type signatures, generate warnings only, and do that
    -- only if -fwarn_partial_type_signatures is on
    case cec_type_holes ctxt of
       HoleError -> reportError err
604
       HoleWarn  -> reportWarning (Reason Opt_WarnPartialTypeSignatures) err
605 606 607
       HoleDefer -> return ()

  -- Otherwise this is a typed hole in an expression
608
  | otherwise
609
  = -- If deferring, report a warning only if -Wtyped-holds is on
610 611
    case cec_expr_holes ctxt of
       HoleError -> reportError err
612
       HoleWarn  -> reportWarning (Reason Opt_WarnTypedHoles) err
613
       HoleDefer -> return ()
614

615
maybeReportError :: ReportErrCtxt -> ErrMsg -> TcM ()
616
-- Report the error and/or make a deferred binding for it
617
maybeReportError ctxt err
618 619 620
  | cec_suppress ctxt    -- Some worse error has occurred;
  = return ()            -- so suppress this error/warning

621
  | cec_errors_as_warns ctxt
622
  = reportWarning NoReason err
623

624
  | otherwise
625
  = case cec_defer_type_errors ctxt of
626
      TypeDefer -> return ()
627
      TypeWarn  -> reportWarning NoReason err
628
      TypeError -> reportError err
629

630
addDeferredBinding :: ReportErrCtxt -> ErrMsg -> Ct -> TcM ()
631
-- See Note [Deferring coercion errors to runtime]
632
addDeferredBinding ctxt err ct
633
  | CtWanted { ctev_pred = pred, ctev_dest = dest } <- ctEvidence ct
634
    -- Only add deferred bindings for Wanted constraints
635
  , Just ev_binds_var <- cec_binds ctxt  -- We have somewhere to put the bindings
636 637 638 639
  = do { dflags <- getDynFlags
       ; let err_msg = pprLocErrMsg err
             err_fs  = mkFastString $ showSDoc dflags $
                       err_msg $$ text "(deferred type error)"
640
             err_tm  = EvDelayedError pred err_fs
641

642 643 644 645 646 647 648 649
       ; case dest of
           EvVarDest evar
             -> addTcEvBind ev_binds_var $ mkWantedEvBind evar err_tm
           HoleDest hole
             -> do { -- See Note [Deferred errors for coercion holes]
                     evar <- newEvVar pred
                   ; addTcEvBind ev_binds_var $ mkWantedEvBind evar err_tm
                   ; fillCoercionHole hole (mkTcCoVarCo evar) }}
650 651

  | otherwise   -- Do not set any evidence for Given/Derived
652
  = return ()
653

654 655
maybeAddDeferredHoleBinding :: ReportErrCtxt -> ErrMsg -> Ct -> TcM ()
maybeAddDeferredHoleBinding ctxt err ct
656 657 658 659 660 661 662
    | isExprHoleCt ct
    , case cec_expr_holes ctxt of
        HoleDefer -> True
        HoleWarn  -> True
        HoleError -> False
    = addDeferredBinding ctxt err ct  -- Only add bindings for holes in expressions
    | otherwise                       -- not for holes in partial type signatures
663 664 665
    = return ()

maybeAddDeferredBinding :: ReportErrCtxt -> ErrMsg -> Ct -> TcM ()
666 667 668 669 670 671 672
maybeAddDeferredBinding ctxt err ct =
  case cec_defer_type_errors ctxt of
        TypeDefer -> deferred
        TypeWarn -> deferred
        TypeError -> return ()
  where
    deferred = addDeferredBinding ctxt err ct
673

674
tryReporters :: ReportErrCtxt -> [ReporterSpec] -> [Ct] -> TcM (ReportErrCtxt, [Ct])
675
-- Use the first reporter in the list whose predicate says True
676
tryReporters ctxt reporters cts
677
  = do { traceTc "tryReporters {" (ppr cts)
678 679 680
       ; (ctxt', cts') <- go ctxt reporters cts
       ; traceTc "tryReporters }" (ppr cts')
       ; return (ctxt', cts') }
681
  where
682
    go ctxt [] cts
683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700
      = return (ctxt, cts)

    go ctxt (r : rs) cts
      = do { (ctxt', cts') <- tryReporter ctxt r cts
           ; go ctxt' rs cts' }
                -- Carry on with the rest, because we must make
                -- deferred bindings for them if we have -fdefer-type-errors
                -- But suppress their error messages

tryReporter :: ReportErrCtxt -> ReporterSpec -> [Ct] -> TcM (ReportErrCtxt, [Ct])
tryReporter ctxt (str, keep_me,  suppress_after, reporter) cts
  | null yeses = return (ctxt, cts)
  | otherwise  = do { traceTc "tryReporter:" (text str <+> ppr yeses)
                    ; reporter ctxt yeses
                    ; let ctxt' = ctxt { cec_suppress = suppress_after || cec_suppress ctxt }
                    ; return (ctxt', nos) }
  where
    (yeses, nos) = partition (\ct -> keep_me ct (classifyPredType (ctPred ct))) cts
701

702 703 704 705 706 707 708 709 710

pprArising :: CtOrigin -> SDoc
-- Used for the main, top-level error message
-- We've done special processing for TypeEq, KindEq, Given
pprArising (TypeEqOrigin {}) = empty
pprArising (KindEqOrigin {}) = empty
pprArising (GivenOrigin {})  = empty
pprArising orig              = pprCtOrigin orig

711
-- Add the "arising from..." part to a message about bunch of dicts
712
addArising :: CtOrigin -> SDoc -> SDoc
713
addArising orig msg = hang msg 2 (pprArising orig)
714

715
pprWithArising :: [Ct] -> (CtLoc, SDoc)
716 717
-- Print something like
--    (Eq a) arising from a use of x at y
718 719
--    (Show a) arising from a use of p at q
-- Also return a location for the error message
720
-- Works for Wanted/Derived only
721
pprWithArising []
722
  = panic "pprWithArising"
723 724
pprWithArising (ct:cts)
  | null cts
725
  = (loc, addArising (ctLocOrigin loc)
dimitris's avatar
dimitris committed
726
                     (pprTheta [ctPred ct]))
727 728
  | otherwise
  = (loc, vcat (map ppr_one (ct:cts)))
729
  where
730
    loc = ctLoc ct
731
    ppr_one ct' = hang (parens (pprType (ctPred ct')))
732
                     2 (pprCtLoc (ctLoc ct'))
733

734 735 736
mkErrorMsgFromCt :: ReportErrCtxt -> Ct -> Report -> TcM ErrMsg
mkErrorMsgFromCt ctxt ct report
  = mkErrorReport ctxt (ctLocEnv (ctLoc ct)) report
737

738 739 740 741 742 743
mkErrorReport :: ReportErrCtxt -> TcLclEnv -> Report -> TcM ErrMsg
mkErrorReport ctxt tcl_env (Report important relevant_bindings)
  = do { context <- mkErrInfo (cec_tidy ctxt) (tcl_ctxt tcl_env)
       ; mkErrDocAt (RealSrcSpan (tcl_loc tcl_env))
            (errDoc important [context] relevant_bindings)
       }
744

745
type UserGiven = ([EvVar], SkolemInfo, Bool, RealSrcSpan)
746 747

getUserGivens :: ReportErrCtxt -> [UserGiven]
748
-- One item for each enclosing implication
749
getUserGivens (CEC {cec_encl = ctxt})
750
  = reverse $
751 752 753
    [ (givens, info, no_eqs, tcl_loc env)
    | Implic { ic_given = givens, ic_env = env
             , ic_no_eqs = no_eqs, ic_info = info } <- ctxt
754
    , not (null givens) ]
755

Austin Seipp's avatar
Austin Seipp committed
756
{-
757 758 759 760 761 762
Note [Always warn with -fdefer-type-errors]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
When -fdefer-type-errors is on we warn about *all* type errors, even
if cec_suppress is on.  This can lead to a lot more warnings than you
would get errors without -fdefer-type-errors, but if we suppress any of
them you might get a runtime error that wasn't warned about at compile
763
time.
764 765 766 767 768

This is an easy design choice to change; just flip the order of the
first two equations for maybeReportError

To be consistent, we should also report multiple warnings from a single
769
location in mkGroupReporter, when -fdefer-type-errors is on.  But that
770 771
is perhaps a bit *over*-consistent! Again, an easy choice to change.

772 773
With #10283, you can now opt out of deferred type error warnings.

774 775 776 777 778 779 780 781 782
Note [Deferred errors for coercion holes]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Suppose we need to defer a type error where the destination for the evidence
is a coercion hole. We can't just put the error in the hole, because we can't
make an erroneous coercion. (Remember that coercions are erased for runtime.)
Instead, we invent a new EvVar, bind it to an error and then make a coercion
from that EvVar, filling the hole with that coercion. Because coercions'
types are unlifted, the error is guaranteed to be hit before we get to the
coercion.
783

784 785
Note [Do not report derived but soluble errors]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
786
The wc_simples include Derived constraints that have not been solved, but are
787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804
not insoluble (in that case they'd be in wc_insols).  We do not want to report
these as errors:

* Superclass constraints. If we have an unsolved [W] Ord a, we'll also have
  an unsolved [D] Eq a, and we do not want to report that; it's just noise.

* Functional dependencies.  For givens, consider
      class C a b | a -> b
      data T a where
         MkT :: C a d => [d] -> T a
      f :: C a b => T a -> F Int
      f (MkT xs) = length xs
  Then we get a [D] b~d.  But there *is* a legitimate call to
  f, namely   f (MkT [True]) :: T Bool, in which b=d.  So we should
  not reject the program.

  For wanteds, something similar
      data T a where
805
        MkT :: C Int b => a -> b -> T a
806 807 808 809 810 811
      g :: C Int c => c -> ()
      f :: T a -> ()
      f (MkT x y) = g x
  Here we get [G] C Int b, [W] C Int a, hence [D] a~b.
  But again f (MkT True True) is a legitimate call.

812
(We leave the Deriveds in wc_simple until reportErrors, so that we don't lose
813 814
derived superclasses between iterations of the solver.)

815
For functional dependencies, here is a real example,
816 817 818
stripped off from libraries/utf8-string/Codec/Binary/UTF8/Generic.hs

  class C a b | a -> b
819 820 821 822
  g :: C a b => a -> b -> ()
  f :: C a b => a -> b -> ()
  f xa xb =
      let loop = g xa
823 824 825 826
      in loop xb

We will first try to infer a type for loop, and we will succeed:
    C a b' => b' -> ()
827 828 829 830 831
Subsequently, we will type check (loop xb) and all is good. But,
recall that we have to solve a final implication constraint:
    C a b => (C a b' => .... cts from body of loop .... ))
And now we have a problem as we will generate an equality b ~ b' and fail to
solve it.
832 833


Austin Seipp's avatar
Austin Seipp committed
834
************************************************************************
835
*                                                                      *
batterseapower's avatar
batterseapower committed
836
                Irreducible predicate errors
837
*                                                                      *
Austin Seipp's avatar
Austin Seipp committed
838 839
************************************************************************
-}
batterseapower's avatar
batterseapower committed
840

841
mkIrredErr :: ReportErrCtxt -> [Ct] -> TcM ErrMsg
842
mkIrredErr ctxt cts
843 844 845
  = do { (ctxt, binds_msg, ct1) <- relevantBindings True ctxt ct1
       ; let orig = ctOrigin ct1
             msg  = couldNotDeduce (getUserGivens ctxt) (map ctPred cts, orig)
846 847
       ; mkErrorMsgFromCt ctxt ct1 $
            important msg `mappend` relevant_bindings binds_msg }
batterseapower's avatar
batterseapower committed
848
  where
849
    (ct1:_) = cts
batterseapower's avatar
batterseapower committed
850

851
----------------
852
mkHoleError :: ReportErrCtxt -> Ct -> TcM ErrMsg
853
mkHoleError ctxt ct@(CHoleCan { cc_occ = occ, cc_hole = hole_sort })
Simon Peyton Jones's avatar
Simon Peyton Jones committed
854 855
  | isOutOfScopeCt ct  -- Out of scope variables, like 'a', where 'a' isn't bound
                       -- Suggest possible in-scope variables in the message
856 857
  = do { dflags  <- getDynFlags
       ; rdr_env <- getGlobalRdrEnv
Joachim Breitner's avatar
Joachim Breitner committed
858
       ; impInfo <- getImports
859 860 861 862
       ; mkErrDocAt (RealSrcSpan (tcl_loc lcl_env)) $
                    errDoc [out_of_scope_msg] []
                           [unknownNameSuggestions dflags rdr_env
                            (tcl_rdr lcl_env) impInfo (mkRdrUnqual occ)] }
863

Simon Peyton Jones's avatar
Simon Peyton Jones committed
864
  | otherwise  -- Explicit holes, like "_" or "_f"