TcErrors.hs 109 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 HsExpr  ( UnboundVar(..) )
31
import HsBinds ( PatSynBind(..) )
32
import Name
33 34
import RdrName ( lookupGlobalRdrEnv, lookupGRE_Name, GlobalRdrEnv
               , mkRdrUnqual, isLocalGRE, greSrcSpan )
35 36
import PrelNames ( typeableClassName, hasKey, ptrRepLiftedDataConKey
                 , ptrRepUnliftedDataConKey )
37
import Id
38 39 40
import Var
import VarSet
import VarEnv
41
import NameSet
42
import Bag
43
import ErrUtils         ( ErrMsg, errDoc, pprLocErrMsg )
44
import BasicTypes
45
import ConLike          ( ConLike(..) )
46 47 48
import Util
import FastString
import Outputable
49
import SrcLoc
50
import DynFlags
51
import StaticFlags      ( opt_PprStyle_Debug )
52
import ListSetOps       ( equivClasses )
53
import Maybes
54
import qualified GHC.LanguageExtensions as LangExt
niteria's avatar
niteria committed
55
import FV ( fvVarList, unionFV )
Icelandjack's avatar
Icelandjack committed
56

57
import Control.Monad    ( when )
58
import Data.List        ( partition, mapAccumL, nub, sortBy, unfoldr )
59
import qualified Data.Set as Set
60

61 62 63 64
#if __GLASGOW_HASKELL__ > 710
import Data.Semigroup   ( Semigroup )
import qualified Data.Semigroup as Semigroup
#endif
65 66


Austin Seipp's avatar
Austin Seipp committed
67 68 69
{-
************************************************************************
*                                                                      *
70
\section{Errors and contexts}
Austin Seipp's avatar
Austin Seipp committed
71 72
*                                                                      *
************************************************************************
73 74 75 76 77

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?

78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96
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
97

98 99 100 101 102 103 104 105 106 107 108 109 110 111
  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
112
and does not fail if -fdefer-type-errors is on, so that we can continue
113
compilation. The errors are turned into warnings in `reportUnsolved`.
Austin Seipp's avatar
Austin Seipp committed
114
-}
115

116 117
-- | Report unsolved goals as errors or warnings. We may also turn some into
-- deferred run-time errors if `-fdefer-type-errors` is on.
118 119
reportUnsolved :: WantedConstraints -> TcM (Bag EvBind)
reportUnsolved wanted
120 121 122 123 124 125
  = 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
126

127
       ; defer_holes <- goptM Opt_DeferTypedHoles
128 129 130 131 132
       ; warn_holes  <- woptM Opt_WarnTypedHoles
       ; let expr_holes | not defer_holes = HoleError
                        | warn_holes      = HoleWarn
                        | otherwise       = HoleDefer

133
       ; partial_sigs      <- xoptM LangExt.PartialTypeSignatures
thomasw's avatar
thomasw committed
134
       ; warn_partial_sigs <- woptM Opt_WarnPartialTypeSignatures
135 136 137 138
       ; let type_holes | not partial_sigs  = HoleError
                        | warn_partial_sigs = HoleWarn
                        | otherwise         = HoleDefer

139
       ; report_unsolved (Just binds_var) False type_errors expr_holes type_holes wanted
140 141
       ; getTcEvBinds binds_var }

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

153 154 155 156 157
-- | 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
158
  = report_unsolved Nothing True TypeWarn HoleWarn HoleWarn wanted
159 160

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

173
       ; wanted <- zonkWC wanted   -- Zonk to reveal all information
174
       ; env0 <- tcInitTidyEnv
175 176
            -- If we are deferring we are going to need /all/ evidence around,
            -- including the evidence produced by unflattening (zonkWC)
177
       ; let tidy_env = tidyFreeTyCoVars env0 free_tvs
niteria's avatar
niteria committed
178
             free_tvs = tyCoVarsOfWCList wanted
179 180

       ; traceTc "reportUnsolved (after zonking and tidying):" $
niteria's avatar
niteria committed
181
         vcat [ pprTvBndrs free_tvs
182 183 184 185
              , ppr wanted ]

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

195 196
       ; tc_lvl <- getTcLevel
       ; reportWanteds err_ctxt tc_lvl wanted }
197

198 199 200
--------------------------------------------
--      Internal functions
--------------------------------------------
201

202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221
-- | 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.
-}

222 223 224 225 226
#if __GLASGOW_HASKELL__ > 710
instance Semigroup Report where
    Report a1 b1 <> Report a2 b2 = Report (a1 ++ a2) (b1 ++ b2)
#endif

227 228 229 230 231 232 233 234 235 236 237 238
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] }

239 240 241 242 243
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

244 245 246 247 248
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

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

255
          , cec_binds :: Maybe EvBindsVar
Simon Peyton Jones's avatar
Simon Peyton Jones committed
256 257 258 259 260 261 262
                         -- 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
263

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

271 272
          , cec_expr_holes :: HoleChoice  -- Holes in expressions
          , cec_type_holes :: HoleChoice  -- Holes in types
273

274
          , cec_warn_redundant :: Bool    -- True <=> -Wredundant-constraints
275

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

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

288 289 290
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.
291
  * If there are any insolubles (eg Int~Bool), here or in a nested implication,
292 293
    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
294
-}
295

296 297
reportImplic :: ReportErrCtxt -> Implication -> TcM ()
reportImplic ctxt implic@(Implic { ic_skols = tvs, ic_given = given
298
                                 , ic_wanted = wanted, ic_binds = m_evb
299
                                 , ic_status = status, ic_info = info
300
                                 , ic_env = tcl_env, ic_tclvl = tc_lvl })
301
  | BracketSkol <- info
302
  , not insoluble
303 304
  = 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
305 306
                     -- later when we plug it in, and meanwhile there may
                     -- certainly be un-satisfied constraints
307 308

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

                 , 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)

329
                 , cec_binds    = cec_binds ctxt *> m_evb }
330 331 332 333 334
                      -- 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.

335 336 337 338 339 340
    dead_givens = case status of
                    IC_Solved { ics_dead = dead } -> dead
                    _                             -> []

warnRedundantConstraints :: ReportErrCtxt -> TcLclEnv -> SkolemInfo -> [EvVar] -> TcM ()
warnRedundantConstraints ctxt env info ev_vars
341
 | null redundant_evs
342 343 344 345 346
 = return ()

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

 | 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
355
 = do { msg <- mkErrorReport ctxt env (important doc)
356
      ; reportWarning (Reason Opt_WarnRedundantConstraints) msg }
357
 where
358
   doc = text "Redundant constraint" <> plural redundant_evs <> colon
359 360 361 362 363 364 365
         <+> 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 $
366
                      transSuperClasses (idType ev_var)
367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383

{- 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..
-}
384

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

         -- First deal with things that are utterly wrong
         -- Like Int ~ Bool (incl nullary TyCons)
         -- or  Int ~ t a   (AppTy on one side)
394 395 396 397 398 399 400 401 402
         -- 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
403 404
       ; MASSERT2( null leftovers, ppr leftovers )

405
            -- All the Derived ones have been filtered out of simples
406 407 408
            -- 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]
409

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

417 418 419 420 421 422
    -- 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
423 424
    report1 = [ ("custom_error", is_user_type_error,
                                                  True, mkUserTypeErrorReporter)
425
              , ("insoluble1",   is_given_eq,     True, mkGroupReporter mkEqErr)
426
              , ("insoluble2",   utterly_wrong,   True, mkGroupReporter mkEqErr)
427 428 429
              , ("skolem eq1",   very_wrong,      True, mkSkolReporter)
              , ("skolem eq2",   skolem_eq,       True, mkSkolReporter)
              , ("non-tv eq",    non_tv_eq,       True, mkSkolReporter)
430 431 432 433 434 435 436 437 438 439 440 441
              , ("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) ]

442 443
    -- rigid_nom_eq, rigid_nom_tv_eq,
    is_hole, is_dict,
444
      is_equality, is_ip, is_irred :: Ct -> PredTree -> Bool
445

446 447 448 449 450
    is_given_eq ct pred
       | EqPred {} <- pred = arisesFromGivens ct
       | otherwise         = False
       -- I think all given residuals are equalities

451 452 453 454 455 456 457
    -- 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
458

459
    -- Things like (a ~N b) or (a  ~N  F Bool)
460
    skolem_eq _ (EqPred NomEq ty1 _) = isSkolemTy tc_lvl ty1
461
    skolem_eq _ _                    = False
462

463 464 465 466 467 468 469 470 471 472 473 474 475 476
    -- 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
477

478 479 480
    is_equality _ (EqPred {}) = True
    is_equality _ _           = False

481 482 483 484 485 486 487 488 489 490
    is_dict _ (ClassPred {}) = True
    is_dict _ _              = False

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

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


491
---------------
492
isSkolemTy :: TcLevel -> Type -> Bool
493
-- The type is a skolem tyvar
494
isSkolemTy tc_lvl ty
495 496 497 498 499 500 501 502
  | 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
503

504 505
isTyFun_maybe :: Type -> Maybe TyCon
isTyFun_maybe ty = case tcSplitTyConApp_maybe ty of
506
                      Just (tc,_) | isTypeFamilyTyCon tc -> Just tc
507 508
                      _ -> Nothing

509
--------------------------------------------
510
--      Reporters
511 512
--------------------------------------------

513 514 515 516 517 518 519 520 521
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
522
-- Suppress duplicates with either the same LHS, or same location
523
mkSkolReporter ctxt cts
524
  = mapM_ (reportGroup mkEqErr ctxt) (group cts)
525
  where
526 527 528 529 530 531
     group [] = []
     group (ct:cts) = (ct : yeses) : group noes
        where
          (yeses, noes) = partition (group_with ct) cts

     group_with ct1 ct2
532 533 534
       | EQ <- cmp_loc ct1 ct2 = True
       | eq_lhs_type   ct1 ct2 = True
       | otherwise             = False
535

536
mkHoleReporter :: Reporter
537
-- Reports errors one at a time
538
mkHoleReporter ctxt
539
  = mapM_ $ \ct ->
540 541
    do { err <- mkHoleError ctxt ct
       ; maybeReportHoleError ctxt ct err
542
       ; maybeAddDeferredHoleBinding ctxt err ct }
543

544 545 546 547 548 549
mkUserTypeErrorReporter :: Reporter
mkUserTypeErrorReporter ctxt
  = mapM_ $ \ct -> maybeReportError ctxt =<< mkUserTypeError ctxt ct

mkUserTypeError :: ReportErrCtxt -> Ct -> TcM ErrMsg
mkUserTypeError ctxt ct = mkErrorMsgFromCt ctxt ct
550
                        $ important
551 552
                        $ pprUserTypeErrorTy
                        $ case getUserTypeErrorMsg ct of
553 554
                            Just msg -> msg
                            Nothing  -> pprPanic "mkUserTypeError" (ppr ct)
555 556


557 558 559
mkGroupReporter :: (ReportErrCtxt -> [Ct] -> TcM ErrMsg)
                             -- Make error message for a group
                -> Reporter  -- Deal with lots of constraints
560 561 562 563 564
-- 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
565

566 567
eq_lhs_type :: Ct -> Ct -> Bool
eq_lhs_type ct1 ct2
568 569
  = case (classifyPredType (ctPred ct1), classifyPredType (ctPred ct2)) of
       (EqPred eq_rel1 ty1 _, EqPred eq_rel2 ty2 _) ->
570
         (eq_rel1 == eq_rel2) && (ty1 `eqType` ty2)
571 572 573 574
       _ -> pprPanic "mkSkolReporter" (ppr ct1 $$ ppr ct2)

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

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

        (_, 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
596

597 598
maybeReportHoleError :: ReportErrCtxt -> Ct -> ErrMsg -> TcM ()
maybeReportHoleError ctxt ct err
thomasw's avatar
thomasw committed
599
  -- When -XPartialTypeSignatures is on, warnings (instead of errors) are
600 601 602
  -- generated for holes in partial type signatures.
  -- Unless -fwarn_partial_type_signatures is not on,
  -- in which case the messages are discarded.
603 604 605 606 607
  | 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
608
       HoleWarn  -> reportWarning (Reason Opt_WarnPartialTypeSignatures) err
609 610 611
       HoleDefer -> return ()

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

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

625
  | cec_errors_as_warns ctxt
626
  = reportWarning NoReason err
627

628
  | otherwise
629
  = case cec_defer_type_errors ctxt of
630
      TypeDefer -> return ()
631
      TypeWarn  -> reportWarning (Reason Opt_WarnDeferredTypeErrors) err
632
      TypeError -> reportError err
633

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

646 647 648 649 650 651 652 653
       ; 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) }}
654 655

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

658 659
maybeAddDeferredHoleBinding :: ReportErrCtxt -> ErrMsg -> Ct -> TcM ()
maybeAddDeferredHoleBinding ctxt err ct
660 661 662 663 664 665 666
    | 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
667 668 669
    = return ()

maybeAddDeferredBinding :: ReportErrCtxt -> ErrMsg -> Ct -> TcM ()
670 671 672 673 674 675 676
maybeAddDeferredBinding ctxt err ct =
  case cec_defer_type_errors ctxt of
        TypeDefer -> deferred
        TypeWarn -> deferred
        TypeError -> return ()
  where
    deferred = addDeferredBinding ctxt err ct
677

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

706 707 708 709 710 711 712 713 714

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

715
-- Add the "arising from..." part to a message about bunch of dicts
716
addArising :: CtOrigin -> SDoc -> SDoc
717
addArising orig msg = hang msg 2 (pprArising orig)
718

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

738 739 740
mkErrorMsgFromCt :: ReportErrCtxt -> Ct -> Report -> TcM ErrMsg
mkErrorMsgFromCt ctxt ct report
  = mkErrorReport ctxt (ctLocEnv (ctLoc ct)) report
741

742 743 744 745 746 747
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)
       }
748

749
type UserGiven = Implication
750 751

getUserGivens :: ReportErrCtxt -> [UserGiven]
752
-- One item for each enclosing implication
753 754 755 756
getUserGivens (CEC {cec_encl = implics}) = getUserGivensFromImplics implics

getUserGivensFromImplics :: [Implication] -> [UserGiven]
getUserGivensFromImplics implics
757
  = reverse (filterOut (null . ic_given) implics)
758

Austin Seipp's avatar
Austin Seipp committed
759
{-
760 761 762 763 764 765
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
766
time.
767 768 769 770 771

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
772
location in mkGroupReporter, when -fdefer-type-errors is on.  But that
773 774
is perhaps a bit *over*-consistent! Again, an easy choice to change.

775 776
With #10283, you can now opt out of deferred type error warnings.

777 778 779 780 781 782 783 784 785
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.
786

787 788
Note [Do not report derived but soluble errors]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
789
The wc_simples include Derived constraints that have not been solved, but are
790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807
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
808
        MkT :: C Int b => a -> b -> T a
809 810 811 812 813 814
      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.

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

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

  class C a b | a -> b
822 823 824 825
  g :: C a b => a -> b -> ()
  f :: C a b => a -> b -> ()
  f xa xb =
      let loop = g xa
826 827 828 829
      in loop xb

We will first try to infer a type for loop, and we will succeed:
    C a b' => b' -> ()
830 831 832 833 834
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.
835 836


Austin Seipp's avatar
Austin Seipp committed
837
************************************************************************
838
*                                                                      *
batterseapower's avatar
batterseapower committed
839
                Irreducible predicate errors
840
*                                                                      *
Austin Seipp's avatar
Austin Seipp committed
841 842
************************************************************************
-}
batterseapower's avatar
batterseapower committed
843

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

854
----------------
855
mkHoleError :: ReportErrCtxt -> Ct -> TcM ErrMsg
856 857 858 859 860 861 862 863 864 865 866 867
mkHoleError _ctxt ct@(CHoleCan { cc_hole = ExprHole (OutOfScope occ rdr_env0) })
  -- Out-of-scope variables, like 'a', where 'a' isn't bound; suggest possible
  -- in-scope variables in the message, and note inaccessible exact matches
  = do { dflags   <- getDynFlags
       ; imp_info <- getImports
       ; let suggs_msg = unknownNameSuggestions dflags rdr_env0
                                                (tcl_rdr lcl_env) imp_info rdr
       ; rdr_env     <- getGlobalRdrEnv
       ; splice_locs <- getTopLevelSpliceLocs
       ; let match_msgs = mk_match_msgs rdr_env splice_locs
       ; mkErrDocAt (RealSrcSpan err_loc) $
                    errDoc [out_of_scope_msg] [] (match_msgs ++ [