TcErrors.hs 129 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 13
import GhcPrelude

14
import TcRnTypes
15 16
import TcRnMonad
import TcMType
17
import TcUnify( occCheckForErrors, OccCheckResult(..) )
18
import TcEnv( tcInitTidyEnv )
19
import TcType
20
import RnUnbound ( unknownNameSuggestions )
batterseapower's avatar
batterseapower committed
21
import Type
22 23
import TyCoRep
import Kind
24
import Unify            ( tcMatchTys )
25
import Module
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
26
import FamInst
27
import FamInstEnv       ( flattenTys )
28 29 30
import Inst
import InstEnv
import TyCon
31
import Class
32
import DataCon
33
import TcEvidence
34
import HsExpr  ( UnboundVar(..) )
35
import HsBinds ( PatSynBind(..) )
36
import Name
37
import RdrName ( lookupGlobalRdrEnv, lookupGRE_Name, GlobalRdrEnv
38 39
               , mkRdrUnqual, isLocalGRE, greSrcSpan, pprNameProvenance
               , GlobalRdrElt (..), globalRdrEnvElts )
Richard Eisenberg's avatar
Richard Eisenberg committed
40
import PrelNames ( typeableClassName, hasKey, liftedRepDataConKey )
41
import Id
42 43 44
import Var
import VarSet
import VarEnv
45
import NameSet
46
import Bag
47
import ErrUtils         ( ErrMsg, errDoc, pprLocErrMsg )
48
import BasicTypes
49
import ConLike          ( ConLike(..))
50
import Util
51 52
import TcEnv (tcLookup)
import {-# SOURCE #-} TcSimplify ( tcCheckHoleFit )
53 54
import FastString
import Outputable
55
import SrcLoc
56
import DynFlags
57
import ListSetOps       ( equivClasses )
58
import Maybes
59
import Pair
60
import qualified GHC.LanguageExtensions as LangExt
61
import FV ( fvVarList, fvVarSet, unionFV )
Icelandjack's avatar
Icelandjack committed
62

63
import Control.Monad    ( when )
64
import Data.Foldable    ( toList )
65
import Data.List        ( partition, mapAccumL, nub, sortBy, unfoldr, foldl')
66
import qualified Data.Set as Set
67

68 69
import Data.Semigroup   ( Semigroup )
import qualified Data.Semigroup as Semigroup
70 71


Austin Seipp's avatar
Austin Seipp committed
72 73 74
{-
************************************************************************
*                                                                      *
75
\section{Errors and contexts}
Austin Seipp's avatar
Austin Seipp committed
76 77
*                                                                      *
************************************************************************
78 79 80 81 82

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?

83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101
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
102

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

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

132
       ; defer_holes <- goptM Opt_DeferTypedHoles
133 134 135 136 137
       ; warn_holes  <- woptM Opt_WarnTypedHoles
       ; let expr_holes | not defer_holes = HoleError
                        | warn_holes      = HoleWarn
                        | otherwise       = HoleDefer

138
       ; partial_sigs      <- xoptM LangExt.PartialTypeSignatures
thomasw's avatar
thomasw committed
139
       ; warn_partial_sigs <- woptM Opt_WarnPartialTypeSignatures
140 141 142 143
       ; let type_holes | not partial_sigs  = HoleError
                        | warn_partial_sigs = HoleWarn
                        | otherwise         = HoleDefer

144 145 146 147 148 149
       ; defer_out_of_scope <- goptM Opt_DeferOutOfScopeVariables
       ; warn_out_of_scope <- woptM Opt_WarnDeferredOutOfScopeVariables
       ; let out_of_scope_holes | not defer_out_of_scope = HoleError
                                | warn_out_of_scope      = HoleWarn
                                | otherwise              = HoleDefer

150
       ; report_unsolved binds_var False type_errors expr_holes
151
          type_holes out_of_scope_holes wanted
152 153 154

       ; ev_binds <- getTcEvBindsMap binds_var
       ; return (evBindMapBinds ev_binds)}
155

156
-- | Report *all* unsolved goals as errors, even if -fdefer-type-errors is on
Simon Peyton Jones's avatar
Simon Peyton Jones committed
157 158
-- However, do not make any evidence bindings, because we don't
-- have any convenient place to put them.
159
-- See Note [Deferring coercion errors to runtime]
Simon Peyton Jones's avatar
Simon Peyton Jones committed
160 161 162
-- Used by solveEqualities for kind equalities
--      (see Note [Fail fast on kind errors] in TcSimplify]
-- and for simplifyDefault.
163
reportAllUnsolved :: WantedConstraints -> TcM ()
164
reportAllUnsolved wanted
165 166 167
  = do { ev_binds <- newTcEvBinds
       ; report_unsolved ev_binds False TypeError
                         HoleError HoleError HoleError wanted }
168

169 170 171 172 173
-- | 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
174 175 176
  = do { ev_binds <- newTcEvBinds
       ; report_unsolved ev_binds True TypeWarn
                         HoleWarn HoleWarn HoleWarn wanted }
177 178

-- | Report unsolved goals as errors or warnings.
179
report_unsolved :: EvBindsVar        -- cec_binds
180
                -> Bool              -- Errors as warnings
181
                -> TypeErrorChoice   -- Deferred type errors
182 183
                -> HoleChoice        -- Expression holes
                -> HoleChoice        -- Type holes
184
                -> HoleChoice        -- Out of scope holes
185
                -> WantedConstraints -> TcM ()
186 187
report_unsolved mb_binds_var err_as_warn type_errors expr_holes
    type_holes out_of_scope_holes wanted
188
  | isEmptyWC wanted
189
  = return ()
190
  | otherwise
191
  = do { traceTc "reportUnsolved (before zonking and tidying)" (ppr wanted)
192

193
       ; wanted <- zonkWC wanted   -- Zonk to reveal all information
194
       ; env0 <- tcInitTidyEnv
195 196
            -- If we are deferring we are going to need /all/ evidence around,
            -- including the evidence produced by unflattening (zonkWC)
197
       ; let tidy_env = tidyFreeTyCoVars env0 free_tvs
niteria's avatar
niteria committed
198
             free_tvs = tyCoVarsOfWCList wanted
199

200 201
       ; traceTc "reportUnsolved (after zonking):" $
         vcat [ text "Free tyvars:" <+> pprTyVars free_tvs
202
              , text "Tidy env:" <+> ppr tidy_env
203
              , text "Wanted:" <+> ppr wanted ]
204 205 206

       ; warn_redundant <- woptM Opt_WarnRedundantConstraints
       ; let err_ctxt = CEC { cec_encl  = []
207
                            , cec_tidy  = tidy_env
208
                            , cec_defer_type_errors = type_errors
209
                            , cec_errors_as_warns = err_as_warn
210 211
                            , cec_expr_holes = expr_holes
                            , cec_type_holes = type_holes
212
                            , cec_out_of_scope_holes = out_of_scope_holes
213
                            , cec_suppress = False -- See Note [Suppressing error messages]
214
                            , cec_warn_redundant = warn_redundant
215
                            , cec_binds    = mb_binds_var }
216

217 218
       ; tc_lvl <- getTcLevel
       ; reportWanteds err_ctxt tc_lvl wanted }
219

220 221 222
--------------------------------------------
--      Internal functions
--------------------------------------------
223

224 225 226 227 228
-- | 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]
229
           , report_valid_substitutions :: [SDoc]
230 231
           }

232
instance Outputable Report where   -- Debugging only
233 234 235
  ppr (Report { report_important = imp
              , report_relevant_bindings = rel
              , report_valid_substitutions = val })
236
    = vcat [ text "important:" <+> vcat imp
237 238
           , text "relevant:"  <+> vcat rel
           , text "valid:"  <+> vcat val ]
239

240 241 242 243 244 245 246 247 248 249 250 251 252
{- 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.
-}

253
instance Semigroup Report where
254
    Report a1 b1 c1 <> Report a2 b2 c2 = Report (a1 ++ a2) (b1 ++ b2) (c1 ++ c2)
255

256
instance Monoid Report where
257
    mempty = Report [] [] []
258
    mappend = (Semigroup.<>)
259 260 261 262 263 264 265 266 267

-- | 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] }

268 269 270 271
-- | Put a doc into the valid substitutions block.
valid_substitutions :: SDoc -> Report
valid_substitutions docs = mempty { report_valid_substitutions = [docs] }

272 273 274 275 276
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

277 278 279 280 281
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

282 283 284 285 286 287 288 289 290 291
instance Outputable HoleChoice where
  ppr HoleError = text "HoleError"
  ppr HoleWarn  = text "HoleWarn"
  ppr HoleDefer = text "HoleDefer"

instance Outputable TypeErrorChoice  where
  ppr TypeError = text "TypeError"
  ppr TypeWarn  = text "TypeWarn"
  ppr TypeDefer = text "TypeDefer"

292
data ReportErrCtxt
293
    = CEC { cec_encl :: [Implication]  -- Enclosing implications
294
                                       --   (innermost first)
295
                                       -- ic_skols and givens are tidied, rest are not
296
          , cec_tidy  :: TidyEnv
Simon Peyton Jones's avatar
Simon Peyton Jones committed
297

298 299 300
          , cec_binds :: EvBindsVar    -- Make some errors (depending on cec_defer)
                                       -- into warnings, and emit evidence bindings
                                       -- into 'cec_binds' for unsolved constraints
301

302 303 304 305
          , cec_errors_as_warns :: Bool   -- Turn all errors into warnings
                                          -- (except for Holes, which are
                                          -- controlled by cec_type_holes and
                                          -- cec_expr_holes)
306
          , cec_defer_type_errors :: TypeErrorChoice -- Defer type errors until runtime
307

308 309 310 311 312 313 314
          -- cec_expr_holes is a union of:
          --   cec_type_holes - a set of typed holes: '_', '_a', '_foo'
          --   cec_out_of_scope_holes - a set of variables which are
          --                            out of scope: 'x', 'y', 'bar'
          , cec_expr_holes :: HoleChoice           -- Holes in expressions
          , cec_type_holes :: HoleChoice           -- Holes in types
          , cec_out_of_scope_holes :: HoleChoice   -- Out of scope holes
315

316
          , cec_warn_redundant :: Bool    -- True <=> -Wredundant-constraints
317

318 319 320
          , cec_suppress :: Bool    -- True <=> More important errors have occurred,
                                    --          so create bindings if need be, but
                                    --          don't issue any more errors/warnings
321
                                    -- See Note [Suppressing error messages]
322 323
      }

324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342
instance Outputable ReportErrCtxt where
  ppr (CEC { cec_binds              = bvar
           , cec_errors_as_warns    = ew
           , cec_defer_type_errors  = dte
           , cec_expr_holes         = eh
           , cec_type_holes         = th
           , cec_out_of_scope_holes = osh
           , cec_warn_redundant     = wr
           , cec_suppress           = sup })
    = text "CEC" <+> braces (vcat
         [ text "cec_binds"              <+> equals <+> ppr bvar
         , text "cec_errors_as_warns"    <+> equals <+> ppr ew
         , text "cec_defer_type_errors"  <+> equals <+> ppr dte
         , text "cec_expr_holes"         <+> equals <+> ppr eh
         , text "cec_type_holes"         <+> equals <+> ppr th
         , text "cec_out_of_scope_holes" <+> equals <+> ppr osh
         , text "cec_warn_redundant"     <+> equals <+> ppr wr
         , text "cec_suppress"           <+> equals <+> ppr sup ])

Austin Seipp's avatar
Austin Seipp committed
343
{-
344 345
Note [Suppressing error messages]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
346
The cec_suppress flag says "don't report any errors".  Instead, just create
347
evidence bindings (as usual).  It's used when more important errors have occurred.
348

349 350 351
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.
352
  * If there are any insolubles (eg Int~Bool), here or in a nested implication,
353 354
    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
355
-}
356

357 358
reportImplic :: ReportErrCtxt -> Implication -> TcM ()
reportImplic ctxt implic@(Implic { ic_skols = tvs, ic_given = given
359
                                 , ic_wanted = wanted, ic_binds = evb
360
                                 , ic_status = status, ic_info = info
361
                                 , ic_env = tcl_env, ic_tclvl = tc_lvl })
362
  | BracketSkol <- info
363
  , not insoluble
364 365
  = 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
366 367
                     -- later when we plug it in, and meanwhile there may
                     -- certainly be un-satisfied constraints
368 369

  | otherwise
370 371
  = do { traceTc "reportImplic" (ppr implic')
       ; reportWanteds ctxt' tc_lvl wanted
372 373
       ; when (cec_warn_redundant ctxt) $
         warnRedundantConstraints ctxt' tcl_env info' dead_givens }
374
  where
375
    insoluble    = isInsolubleStatus status
376
    (env1, tvs') = mapAccumL tidyTyCoVarBndr (cec_tidy ctxt) tvs
Simon Peyton Jones's avatar
Simon Peyton Jones committed
377
    info'        = tidySkolemInfo env1 info
378
    implic' = implic { ic_skols = tvs'
Simon Peyton Jones's avatar
Simon Peyton Jones committed
379
                     , ic_given = map (tidyEvVar env1) given
380
                     , ic_info  = info' }
Simon Peyton Jones's avatar
Simon Peyton Jones committed
381
    ctxt' = ctxt { cec_tidy     = env1
382
                 , cec_encl     = implic' : cec_encl ctxt
383 384 385 386 387 388 389

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

390
                 , cec_binds    = evb }
391

392 393 394 395 396
    dead_givens = case status of
                    IC_Solved { ics_dead = dead } -> dead
                    _                             -> []

warnRedundantConstraints :: ReportErrCtxt -> TcLclEnv -> SkolemInfo -> [EvVar] -> TcM ()
397
-- See Note [Tracking redundant constraints] in TcSimplify
398
warnRedundantConstraints ctxt env info ev_vars
399
 | null redundant_evs
400 401 402 403 404
 = return ()

 | SigSkol {} <- info
 = setLclEnv env $  -- We want to add "In the type signature for f"
                    -- to the error context, which is a bit tiresome
405
   addErrCtxt (text "In" <+> ppr info) $
406
   do { env <- getLclEnv
407
      ; msg <- mkErrorReport ctxt env (important doc)
408
      ; reportWarning (Reason Opt_WarnRedundantConstraints) msg }
409 410 411 412

 | 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
413
 = do { msg <- mkErrorReport ctxt env (important doc)
414
      ; reportWarning (Reason Opt_WarnRedundantConstraints) msg }
415
 where
416
   doc = text "Redundant constraint" <> plural redundant_evs <> colon
417 418 419 420 421 422 423
         <+> 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 $
424
                      transSuperClasses (idType ev_var)
425 426 427 428 429 430 431 432 433

{- 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
434
of evidence, since the dictionary has no fields.  But it is still
435 436 437 438 439 440 441
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..
-}
442

443
reportWanteds :: ReportErrCtxt -> TcLevel -> WantedConstraints -> TcM ()
444
reportWanteds ctxt tc_lvl (WC { wc_simple = simples, wc_impl = implics })
445 446
  = do { traceTc "reportWanteds" (vcat [ text "Simples =" <+> ppr simples
                                       , text "Suppress =" <+> ppr (cec_suppress ctxt)])
447
       ; traceTc "rw2" (ppr tidy_cts)
448 449 450 451

         -- First deal with things that are utterly wrong
         -- Like Int ~ Bool (incl nullary TyCons)
         -- or  Int ~ t a   (AppTy on one side)
452
         -- These /ones/ are not suppressed by the incoming context
453 454 455 456 457 458 459 460
       ; 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
461 462
       ; MASSERT2( null leftovers, ppr leftovers )

463
            -- All the Derived ones have been filtered out of simples
464 465 466
            -- 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]
467

468
     ; mapBagM_ (reportImplic ctxt2) implics }
469
            -- NB ctxt1: don't suppress inner insolubles if there's only a
470
            -- wanted insoluble here; but do suppress inner insolubles
471
            -- if there's a *given* insoluble here (= inaccessible code)
472
 where
473
    env = cec_tidy ctxt
474
    tidy_cts = bagToList (mapBag (tidyCt env) simples)
475

476 477 478
    -- report1: ones that should *not* be suppresed by
    --          an insoluble somewhere else in the tree
    -- It's crucial that anything that is considered insoluble
479
    -- (see TcRnTypes.insolubleWantedCt) is caught here, otherwise
480 481
    -- we might suppress its error message, and proceed on past
    -- type checking to get a Lint error later
482
    report1 = [ ("custom_error", is_user_type_error,True, mkUserTypeErrorReporter)
483
              , given_eq_spec
484 485 486 487 488 489
              , ("insoluble2",   utterly_wrong,  True, mkGroupReporter mkEqErr)
              , ("skolem eq1",   very_wrong,     True, mkSkolReporter)
              , ("skolem eq2",   skolem_eq,      True, mkSkolReporter)
              , ("non-tv eq",    non_tv_eq,      True, mkSkolReporter)
              , ("Out of scope", is_out_of_scope,True, mkHoleReporter tidy_cts)
              , ("Holes",        is_hole,        False, mkHoleReporter tidy_cts)
490 491 492

                  -- The only remaining equalities are alpha ~ ty,
                  -- where alpha is untouchable; and representational equalities
493 494 495 496 497
                  -- Prefer homogeneous equalities over hetero, because the
                  -- former might be holding up the latter.
                  -- See Note [Equalities with incompatible kinds] in TcCanonical
              , ("Homo eqs",      is_homo_equality, True,  mkGroupReporter mkEqErr)
              , ("Other eqs",     is_equality,      False, mkGroupReporter mkEqErr) ]
498 499 500 501 502 503

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

504 505
    -- rigid_nom_eq, rigid_nom_tv_eq,
    is_hole, is_dict,
506
      is_equality, is_ip, is_irred :: Ct -> PredTree -> Bool
507

508 509 510 511 512
    is_given_eq ct pred
       | EqPred {} <- pred = arisesFromGivens ct
       | otherwise         = False
       -- I think all given residuals are equalities

513 514 515 516 517 518 519
    -- 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
520

521
    -- Things like (a ~N b) or (a  ~N  F Bool)
522
    skolem_eq _ (EqPred NomEq ty1 _) = isSkolemTy tc_lvl ty1
523
    skolem_eq _ _                    = False
524

525 526 527 528 529 530 531 532
    -- Things like (F a  ~N  Int)
    non_tv_eq _ (EqPred NomEq ty1 _) = not (isTyVarTy ty1)
    non_tv_eq _ _                    = False

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

    is_user_type_error ct _ = isUserTypeErrorCt ct
533

534 535 536
    is_homo_equality _ (EqPred _ ty1 ty2) = typeKind ty1 `tcEqType` typeKind ty2
    is_homo_equality _ _                  = False

537 538 539
    is_equality _ (EqPred {}) = True
    is_equality _ _           = False

540 541 542 543 544 545 546 547 548
    is_dict _ (ClassPred {}) = True
    is_dict _ _              = False

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

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

549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564
    given_eq_spec = case find_gadt_match (cec_encl ctxt) of
       Just imp -> ("insoluble1a", is_given_eq, True,  mkGivenErrorReporter imp)
       Nothing  -> ("insoluble1b", is_given_eq, False, ignoreErrorReporter)
                  -- False means don't suppress subsequent errors
                  -- Reason: we don't report all given errors
                  --         (see mkGivenErrorReporter), and we should only suppress
                  --         subsequent errors if we actually report this one!
                  --         Trac #13446 is an example

    find_gadt_match [] = Nothing
    find_gadt_match (implic : implics)
      | PatSkol {} <- ic_info implic
      , not (ic_no_eqs implic)
      = Just implic
      | otherwise
      = find_gadt_match implics
565

566
---------------
567
isSkolemTy :: TcLevel -> Type -> Bool
568
-- The type is a skolem tyvar
569
isSkolemTy tc_lvl ty
570 571 572 573 574 575 576 577
  | 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
578

579 580
isTyFun_maybe :: Type -> Maybe TyCon
isTyFun_maybe ty = case tcSplitTyConApp_maybe ty of
581
                      Just (tc,_) | isTypeFamilyTyCon tc -> Just tc
582 583
                      _ -> Nothing

584
--------------------------------------------
585
--      Reporters
586 587
--------------------------------------------

588 589 590 591 592 593 594 595 596
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
597
-- Suppress duplicates with either the same LHS, or same location
598
mkSkolReporter ctxt cts
599
  = mapM_ (reportGroup mkEqErr ctxt) (group cts)
600
  where
601 602 603 604 605 606
     group [] = []
     group (ct:cts) = (ct : yeses) : group noes
        where
          (yeses, noes) = partition (group_with ct) cts

     group_with ct1 ct2
607 608 609
       | EQ <- cmp_loc ct1 ct2 = True
       | eq_lhs_type   ct1 ct2 = True
       | otherwise             = False
610

611
mkHoleReporter :: [Ct] -> Reporter
612
-- Reports errors one at a time
613 614
mkHoleReporter tidy_simples ctxt
  = mapM_ $ \ct -> do { err <- mkHoleError tidy_simples ctxt ct
615 616
                      ; maybeReportHoleError ctxt ct err
                      ; maybeAddDeferredHoleBinding ctxt err ct }
617

618 619
mkUserTypeErrorReporter :: Reporter
mkUserTypeErrorReporter ctxt
620
  = mapM_ $ \ct -> do { err <- mkUserTypeError ctxt ct
621 622
                      ; maybeReportError ctxt err
                      ; addDeferredBinding ctxt err ct }
623 624 625

mkUserTypeError :: ReportErrCtxt -> Ct -> TcM ErrMsg
mkUserTypeError ctxt ct = mkErrorMsgFromCt ctxt ct
626
                        $ important
627 628
                        $ pprUserTypeErrorTy
                        $ case getUserTypeErrorMsg ct of
629 630
                            Just msg -> msg
                            Nothing  -> pprPanic "mkUserTypeError" (ppr ct)
631 632


633
mkGivenErrorReporter :: Implication -> Reporter
634
-- See Note [Given errors]
635
mkGivenErrorReporter implic ctxt cts
636 637 638 639 640 641 642 643 644 645 646 647 648 649
  = do { (ctxt, binds_msg, ct) <- relevantBindings True ctxt ct
       ; dflags <- getDynFlags
       ; let ct' = setCtLoc ct (setCtLocEnv (ctLoc ct) (ic_env implic))
                   -- For given constraints we overwrite the env (and hence src-loc)
                  -- with one from the implication.  See Note [Inaccessible code]

             inaccessible_msg = hang (text "Inaccessible code in")
                                   2 (ppr (ic_info implic))
             report = important inaccessible_msg `mappend`
                      relevant_bindings binds_msg

       ; err <- mkEqErr_help dflags ctxt report ct'
                             Nothing ty1 ty2

Simon Peyton Jones's avatar
Simon Peyton Jones committed
650
       ; traceTc "mkGivenErrorReporter" (ppr ct)
651 652 653 654 655
       ; maybeReportError ctxt err }
  where
    (ct : _ )  = cts    -- Never empty
    (ty1, ty2) = getEqPredTys (ctPred ct)

656 657
ignoreErrorReporter :: Reporter
-- Discard Given errors that don't come from
Simon Peyton Jones's avatar
Simon Peyton Jones committed
658
-- a pattern match; maybe we should warn instead?
659
ignoreErrorReporter ctxt cts
Simon Peyton Jones's avatar
Simon Peyton Jones committed
660
  = do { traceTc "mkGivenErrorReporter no" (ppr cts $$ ppr (cec_encl ctxt))
661 662
       ; return () }

663 664 665

{- Note [Given errors]
~~~~~~~~~~~~~~~~~~~~~~
Gabor Greif's avatar
Gabor Greif committed
666
Given constraints represent things for which we have (or will have)
667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684
evidence, so they aren't errors.  But if a Given constraint is
insoluble, this code is inaccessible, and we might want to at least
warn about that.  A classic case is

   data T a where
     T1 :: T Int
     T2 :: T a
     T3 :: T Bool

   f :: T Int -> Bool
   f T1 = ...
   f T2 = ...
   f T3 = ...  -- We want to report this case as inaccessible

We'd like to point out that the T3 match is inaccessible. It
will have a Given constraint [G] Int ~ Bool.

But we don't want to report ALL insoluble Given constraints.  See Trac
Simon Peyton Jones's avatar
Simon Peyton Jones committed
685
#12466 for a long discussion.  For example, if we aren't careful
686 687 688 689
we'll complain about
   f :: ((Int ~ Bool) => a -> a) -> Int
which arguably is OK.  It's more debatable for
   g :: (Int ~ Bool) => Int -> Int
690
but it's tricky to distinguish these cases so we don't report
691 692
either.

Simon Peyton Jones's avatar
Simon Peyton Jones committed
693
The bottom line is this: find_gadt_match looks for an enclosing
694 695 696 697
pattern match which binds some equality constraints.  If we
find one, we report the insoluble Given.
-}

698 699 700
mkGroupReporter :: (ReportErrCtxt -> [Ct] -> TcM ErrMsg)
                             -- Make error message for a group
                -> Reporter  -- Deal with lots of constraints
701 702 703
-- Group together errors from same location,
-- and report only the first (to avoid a cascade)
mkGroupReporter mk_err ctxt cts
704
  = mapM_ (reportGroup mk_err ctxt . toList) (equivClasses cmp_loc cts)
705

706 707
eq_lhs_type :: Ct -> Ct -> Bool
eq_lhs_type ct1 ct2
708 709
  = case (classifyPredType (ctPred ct1), classifyPredType (ctPred ct2)) of
       (EqPred eq_rel1 ty1 _, EqPred eq_rel2 ty2 _) ->
710
         (eq_rel1 == eq_rel2) && (ty1 `eqType` ty2)
711 712 713 714
       _ -> pprPanic "mkSkolReporter" (ppr ct1 $$ ppr ct2)

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

716 717
reportGroup :: (ReportErrCtxt -> [Ct] -> TcM ErrMsg) -> ReportErrCtxt
            -> [Ct] -> TcM ()
quchen's avatar
quchen committed
718 719 720
reportGroup mk_err ctxt cts =
  case partition isMonadFailInstanceMissing cts of
        -- Only warn about missing MonadFail constraint when
Gabor Greif's avatar
Gabor Greif committed
721
        -- there are no other missing constraints!
722 723 724
        (monadFailCts, []) ->
            do { err <- mk_err ctxt monadFailCts
               ; reportWarning (Reason Opt_WarnMissingMonadFailInstances) err }
quchen's avatar
quchen committed
725 726 727

        (_, cts') -> do { err <- mk_err ctxt cts'
                        ; maybeReportError ctxt err
728 729 730 731 732 733 734
                            -- But see Note [Always warn with -fdefer-type-errors]
                        ; traceTc "reportGroup" (ppr cts')
                        ; mapM_ (addDeferredBinding ctxt err) cts' }
                            -- Add deferred bindings for all
                            -- Redundant if we are going to abort compilation,
                            -- but that's hard to know for sure, and if we don't
                            -- abort, we need bindings for all (e.g. Trac #12156)
quchen's avatar
quchen committed
735 736 737 738 739
  where
    isMonadFailInstanceMissing ct =
        case ctLocOrigin (ctLoc ct) of
            FailablePattern _pat -> True
            _otherwise           -> False
740

741 742
maybeReportHoleError :: ReportErrCtxt -> Ct -> ErrMsg -> TcM ()
maybeReportHoleError ctxt ct err
thomasw's avatar
thomasw committed
743
  -- When -XPartialTypeSignatures is on, warnings (instead of errors) are
744 745 746
  -- generated for holes in partial type signatures.
  -- Unless -fwarn_partial_type_signatures is not on,
  -- in which case the messages are discarded.
747 748 749 750 751
  | 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
752
       HoleWarn  -> reportWarning (Reason Opt_WarnPartialTypeSignatures) err
753 754
       HoleDefer -> return ()

755 756 757 758
  -- Always report an error for out-of-scope variables
  -- Unless -fdefer-out-of-scope-variables is on,
  -- in which case the messages are discarded.
  -- See Trac #12170, #12406
759
  | isOutOfScopeCt ct
760 761 762 763 764 765
  = -- If deferring, report a warning only if -Wout-of-scope-variables is on
    case cec_out_of_scope_holes ctxt of
      HoleError -> reportError err
      HoleWarn  ->
        reportWarning (Reason Opt_WarnDeferredOutOfScopeVariables) err
      HoleDefer -> return ()
766 767 768

  -- Otherwise this is a typed hole in an expression,
  -- but not for an out-of-scope variable
769
  | otherwise
770
  = -- If deferring, report a warning only if -Wtyped-holes is on
771 772
    case cec_expr_holes ctxt of
       HoleError -> reportError err
773
       HoleWarn  -> reportWarning (Reason Opt_WarnTypedHoles) err
774
       HoleDefer -> return ()
775

776
maybeReportError :: ReportErrCtxt -> ErrMsg -> TcM ()
777
-- Report the error and/or make a deferred binding for it
778
maybeReportError ctxt err
779 780 781
  | cec_suppress ctxt    -- Some worse error has occurred;
  = return ()            -- so suppress this error/warning

782
  | cec_errors_as_warns ctxt
783
  = reportWarning NoReason err
784

785
  | otherwise
786
  = case cec_defer_type_errors ctxt of
787
      TypeDefer -> return ()
788
      TypeWarn  -> reportWarning (Reason Opt_WarnDeferredTypeErrors) err
789
      TypeError -> reportError err
790

791
addDeferredBinding :: ReportErrCtxt -> ErrMsg -> Ct -> TcM ()
792
-- See Note [Deferring coercion errors to runtime]
793
addDeferredBinding ctxt err ct
794
  | CtWanted { ctev_pred = pred, ctev_dest = dest } <- ctEvidence ct
795 796 797 798 799
    -- Only add deferred bindings for Wanted constraints
  = do { dflags <- getDynFlags
       ; let err_msg = pprLocErrMsg err
             err_fs  = mkFastString $ showSDoc dflags $
                       err_msg $$ text "(deferred type error)"
800
             err_tm  = EvDelayedError pred err_fs
801
             ev_binds_var = cec_binds ctxt
802

803 804 805 806 807
       ; case dest of
           EvVarDest evar
             -> addTcEvBind ev_binds_var $ mkWantedEvBind evar err_tm
           HoleDest hole
             -> do { -- See Note [Deferred errors for coercion holes]
Simon Peyton Jones's avatar
Simon Peyton Jones committed
808 809 810
                     let co_var = coHoleCoVar hole
                   ; addTcEvBind ev_binds_var $ mkWantedEvBind co_var err_tm
                   ; fillCoercionHole hole (mkTcCoVarCo co_var) }}
811 812

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

815 816
maybeAddDeferredHoleBinding :: ReportErrCtxt -> ErrMsg -> Ct -> TcM ()
maybeAddDeferredHoleBinding ctxt err ct
817 818 819 820
  | isExprHoleCt ct
  = addDeferredBinding ctxt err ct  -- Only add bindings for holes in expressions
  | otherwise                       -- not for holes in partial type signatures
  = return ()
821

822
tryReporters :: ReportErrCtxt -> [ReporterSpec] -> [Ct] -> TcM (ReportErrCtxt, [Ct])
823
-- Use the first reporter in the list whose predicate says True
824
tryReporters ctxt reporters cts
825 826 827
  = do { let (vis_cts, invis_cts) = partition (isVisibleOrigin . ctOrigin) cts
       ; traceTc "tryReporters {" (ppr vis_cts $$ ppr invis_cts)
       ; (ctxt', cts') <- go ctxt reporters vis_cts invis_cts
828 829
       ; traceTc "tryReporters }" (ppr cts')
       ; return (ctxt', cts') }
830
  where
831 832 833 834 835 836 837 838 839
    go ctxt [] vis_cts invis_cts
      = return (ctxt, vis_cts ++ invis_cts)

    go ctxt (r : rs) vis_cts invis_cts
       -- always look at *visible* Origins before invisible ones
       -- this is the whole point of isVisibleOrigin
      = do { (ctxt', vis_cts') <- tryReporter ctxt r vis_cts
           ; (ctxt'', invis_cts') <- tryReporter ctxt' r invis_cts
           ; go ctxt'' rs vis_cts' invis_cts' }
840 841 842 843 844 845 846
                -- 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)
847
  | otherwise  = do { traceTc "tryReporter{ " (text str <+> ppr yeses)