TcErrors.hs 127 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
import TyCoRep
23
import Unify            ( tcMatchTys )
24
import Module
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
25
import FamInst
26
import FamInstEnv       ( flattenTys )
27 28 29
import Inst
import InstEnv
import TyCon
30
import Class
31
import DataCon
32
import TcEvidence
33
import TcEvTerm
34
import HsExpr  ( UnboundVar(..) )
35
import HsBinds ( PatSynBind(..) )
36
import Name
37
import RdrName ( lookupGlobalRdrEnv, lookupGRE_Name, GlobalRdrEnv
38
               , mkRdrUnqual, isLocalGRE, greSrcSpan )
39
import PrelNames ( typeableClassName, hasKey, liftedRepDataConKey, tYPETyConKey )
40
import Id
41 42 43
import Var
import VarSet
import VarEnv
44
import NameSet
45
import Bag
46
import ErrUtils         ( ErrMsg, errDoc, pprLocErrMsg )
47
import BasicTypes
48
import ConLike          ( ConLike(..))
49 50 51
import Util
import FastString
import Outputable
52
import SrcLoc
53
import DynFlags
54
import ListSetOps       ( equivClasses )
55
import Maybes
56
import Pair
57
import qualified GHC.LanguageExtensions as LangExt
58
import FV ( fvVarList, unionFV )
Icelandjack's avatar
Icelandjack committed
59

60
import Control.Monad    ( when )
61
import Data.Foldable    ( toList )
62
import Data.List        ( partition, mapAccumL, nub, sortBy, unfoldr )
63
import qualified Data.Set as Set
64 65

import {-# SOURCE #-} TcHoleErrors ( findValidHoleFits )
66

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


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

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?

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

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

120 121
-- | Report unsolved goals as errors or warnings. We may also turn some into
-- deferred run-time errors if `-fdefer-type-errors` is on.
122 123
reportUnsolved :: WantedConstraints -> TcM (Bag EvBind)
reportUnsolved wanted
124 125 126 127
  = do { binds_var <- newTcEvBinds
       ; defer_errors <- goptM Opt_DeferTypeErrors
       ; warn_errors <- woptM Opt_WarnDeferredTypeErrors -- implement #10283
       ; let type_errors | not defer_errors = TypeError
128
                         | warn_errors      = TypeWarn (Reason Opt_WarnDeferredTypeErrors)
129
                         | otherwise        = TypeDefer
130

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

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

143 144 145 146 147 148
       ; 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

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

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

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

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

-- | Report unsolved goals as errors or warnings.
178
report_unsolved :: EvBindsVar        -- cec_binds
179
                -> TypeErrorChoice   -- Deferred type errors
180 181
                -> HoleChoice        -- Expression holes
                -> HoleChoice        -- Type holes
182
                -> HoleChoice        -- Out of scope holes
183
                -> WantedConstraints -> TcM ()
184
report_unsolved mb_binds_var type_errors expr_holes
185
    type_holes out_of_scope_holes wanted
186
  | isEmptyWC wanted
187
  = return ()
188
  | otherwise
189 190 191 192 193 194
  = do { traceTc "reportUnsolved warning/error settings:" $
           vcat [ text "type errors:" <+> ppr type_errors
                , text "expr holes:" <+> ppr expr_holes
                , text "type holes:" <+> ppr type_holes
                , text "scope holes:" <+> ppr out_of_scope_holes ]
       ; traceTc "reportUnsolved (before zonking and tidying)" (ppr wanted)
195

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

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

       ; warn_redundant <- woptM Opt_WarnRedundantConstraints
       ; let err_ctxt = CEC { cec_encl  = []
210
                            , cec_tidy  = tidy_env
211
                            , cec_defer_type_errors = type_errors
212 213
                            , cec_expr_holes = expr_holes
                            , cec_type_holes = type_holes
214
                            , cec_out_of_scope_holes = out_of_scope_holes
215 216 217 218 219 220
                            , cec_suppress = insolubleWC wanted
                                 -- See Note [Suppressing error messages]
                                 -- Suppress low-priority errors if there
                                 -- are insolule errors anywhere;
                                 -- See Trac #15539 and c.f. setting ic_status
                                 -- in TcSimplify.setImplicationStatus
221
                            , cec_warn_redundant = warn_redundant
222
                            , cec_binds    = mb_binds_var }
223

224 225
       ; tc_lvl <- getTcLevel
       ; reportWanteds err_ctxt tc_lvl wanted }
226

227 228 229
--------------------------------------------
--      Internal functions
--------------------------------------------
230

231 232 233 234 235
-- | 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]
236
           , report_valid_hole_fits :: [SDoc]
237 238
           }

239
instance Outputable Report where   -- Debugging only
240 241
  ppr (Report { report_important = imp
              , report_relevant_bindings = rel
242
              , report_valid_hole_fits = val })
243
    = vcat [ text "important:" <+> vcat imp
244 245
           , text "relevant:"  <+> vcat rel
           , text "valid:"  <+> vcat val ]
246

247 248 249 250 251 252 253 254
{- 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.

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

260
instance Semigroup Report where
261
    Report a1 b1 c1 <> Report a2 b2 c2 = Report (a1 ++ a2) (b1 ++ b2) (c1 ++ c2)
262

263
instance Monoid Report where
264
    mempty = Report [] [] []
265
    mappend = (Semigroup.<>)
266 267 268 269 270 271 272 273 274

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

275 276 277
-- | Put a doc into the valid hole fits block.
valid_hole_fits :: SDoc -> Report
valid_hole_fits docs = mempty { report_valid_hole_fits = [docs] }
278

279 280
data TypeErrorChoice   -- What to do for type errors found by the type checker
  = TypeError     -- A type error aborts compilation with an error message
281 282 283 284 285
  | TypeWarn WarnReason
                  -- A type error is deferred to runtime, plus a compile-time warning
                  -- The WarnReason should usually be (Reason Opt_WarnDeferredTypeErrors)
                  -- but it isn't for the Safe Haskell Overlapping Instances warnings
                  -- see warnAllUnsolved
286 287
  | TypeDefer     -- A type error is deferred to runtime; no error or warning at compile time

288 289 290 291 292
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

293 294 295 296 297 298
instance Outputable HoleChoice where
  ppr HoleError = text "HoleError"
  ppr HoleWarn  = text "HoleWarn"
  ppr HoleDefer = text "HoleDefer"

instance Outputable TypeErrorChoice  where
299 300 301
  ppr TypeError         = text "TypeError"
  ppr (TypeWarn reason) = text "TypeWarn" <+> ppr reason
  ppr TypeDefer         = text "TypeDefer"
302

303
data ReportErrCtxt
304
    = CEC { cec_encl :: [Implication]  -- Enclosing implications
305
                                       --   (innermost first)
306
                                       -- ic_skols and givens are tidied, rest are not
307
          , cec_tidy  :: TidyEnv
Simon Peyton Jones's avatar
Simon Peyton Jones committed
308

309 310 311
          , cec_binds :: EvBindsVar    -- Make some errors (depending on cec_defer)
                                       -- into warnings, and emit evidence bindings
                                       -- into 'cec_binds' for unsolved constraints
312

313
          , cec_defer_type_errors :: TypeErrorChoice -- Defer type errors until runtime
314

315 316 317 318 319 320 321
          -- 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
322

323
          , cec_warn_redundant :: Bool    -- True <=> -Wredundant-constraints
324

325 326 327
          , cec_suppress :: Bool    -- True <=> More important errors have occurred,
                                    --          so create bindings if need be, but
                                    --          don't issue any more errors/warnings
328
                                    -- See Note [Suppressing error messages]
329 330
      }

331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347
instance Outputable ReportErrCtxt where
  ppr (CEC { cec_binds              = bvar
           , 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_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 ])

348 349 350 351 352 353 354 355 356 357 358 359 360 361 362
-- | Returns True <=> the ReportErrCtxt indicates that something is deferred
deferringAnyBindings :: ReportErrCtxt -> Bool
  -- Don't check cec_type_holes, as these don't cause bindings to be deferred
deferringAnyBindings (CEC { cec_defer_type_errors  = TypeError
                          , cec_expr_holes         = HoleError
                          , cec_out_of_scope_holes = HoleError }) = False
deferringAnyBindings _                                            = True

-- | Transforms a 'ReportErrCtxt' into one that does not defer any bindings
-- at all.
noDeferredBindings :: ReportErrCtxt -> ReportErrCtxt
noDeferredBindings ctxt = ctxt { cec_defer_type_errors  = TypeError
                               , cec_expr_holes         = HoleError
                               , cec_out_of_scope_holes = HoleError }

Simon Peyton Jones's avatar
Simon Peyton Jones committed
363 364
{- Note [Suppressing error messages]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
365
The cec_suppress flag says "don't report any errors".  Instead, just create
366
evidence bindings (as usual).  It's used when more important errors have occurred.
367

368 369 370
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.
371
  * If there are any insolubles (eg Int~Bool), here or in a nested implication,
372 373
    then suppress errors from the simple constraints here.  Sometimes the
    simple-constraint errors are a knock-on effect of the insolubles.
Simon Peyton Jones's avatar
Simon Peyton Jones committed
374 375 376 377 378 379 380 381 382 383 384 385 386

This suppression behaviour is controlled by the Bool flag in
ReportErrorSpec, as used in reportWanteds.

But we need to take care: flags can turn errors into warnings, and we
don't want those warnings to suppress subsequent errors (including
suppressing the essential addTcEvBind for them: Trac #15152). So in
tryReporter we use askNoErrs to see if any error messages were
/actually/ produced; if not, we don't switch on suppression.

A consequence is that warnings never suppress warnings, so turning an
error into a warning may allow subsequent warnings to appear that were
previously suppressed.   (e.g. partial-sigs/should_fail/T14584)
Austin Seipp's avatar
Austin Seipp committed
387
-}
388

389
reportImplic :: ReportErrCtxt -> Implication -> TcM ()
390 391
reportImplic ctxt implic@(Implic { ic_skols = tvs, ic_telescope = m_telescope
                                 , ic_given = given
392
                                 , ic_wanted = wanted, ic_binds = evb
393
                                 , ic_status = status, ic_info = info
394
                                 , ic_tclvl = tc_lvl })
395
  | BracketSkol <- info
396
  , not insoluble
397 398
  = 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
399 400
                     -- later when we plug it in, and meanwhile there may
                     -- certainly be un-satisfied constraints
401 402

  | otherwise
403 404
  = do { traceTc "reportImplic" (ppr implic')
       ; reportWanteds ctxt' tc_lvl wanted
405
       ; when (cec_warn_redundant ctxt) $
406 407
         warnRedundantConstraints ctxt' tcl_env info' dead_givens
       ; when bad_telescope $ reportBadTelescope ctxt tcl_env m_telescope tvs }
408
  where
409
    tcl_env      = implicLclEnv implic
410
    insoluble    = isInsolubleStatus status
Ningning Xie's avatar
Ningning Xie committed
411
    (env1, tvs') = mapAccumL tidyVarBndr (cec_tidy ctxt) tvs
Simon Peyton Jones's avatar
Simon Peyton Jones committed
412
    info'        = tidySkolemInfo env1 info
413
    implic' = implic { ic_skols = tvs'
Simon Peyton Jones's avatar
Simon Peyton Jones committed
414
                     , ic_given = map (tidyEvVar env1) given
415
                     , ic_info  = info' }
Simon Peyton Jones's avatar
Simon Peyton Jones committed
416
    ctxt1 | CoEvBindsVar{} <- evb    = noDeferredBindings ctxt
417
          | otherwise                = ctxt
418
          -- If we go inside an implication that has no term
419
          -- evidence (e.g. unifying under a forall), we can't defer
420 421 422 423 424 425 426 427 428 429 430 431 432 433 434
          -- type errors.  You could imagine using the /enclosing/
          -- bindings (in cec_binds), but that may not have enough stuff
          -- in scope for the bindings to be well typed.  So we just
          -- switch off deferred type errors altogether.  See Trac #14605.

    ctxt' = ctxt1 { cec_tidy     = env1
                  , cec_encl     = implic' : cec_encl ctxt

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

                  , cec_binds    = evb }
435

436 437 438 439
    dead_givens = case status of
                    IC_Solved { ics_dead = dead } -> dead
                    _                             -> []

440 441 442 443
    bad_telescope = case status of
              IC_BadTelescope -> True
              _               -> False

444
warnRedundantConstraints :: ReportErrCtxt -> TcLclEnv -> SkolemInfo -> [EvVar] -> TcM ()
445
-- See Note [Tracking redundant constraints] in TcSimplify
446
warnRedundantConstraints ctxt env info ev_vars
447
 | null redundant_evs
448 449 450 451 452
 = return ()

 | SigSkol {} <- info
 = setLclEnv env $  -- We want to add "In the type signature for f"
                    -- to the error context, which is a bit tiresome
453
   addErrCtxt (text "In" <+> ppr info) $
454
   do { env <- getLclEnv
455
      ; msg <- mkErrorReport ctxt env (important doc)
456
      ; reportWarning (Reason Opt_WarnRedundantConstraints) msg }
457 458 459 460

 | 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
461
 = do { msg <- mkErrorReport ctxt env (important doc)
462
      ; reportWarning (Reason Opt_WarnRedundantConstraints) msg }
463
 where
464
   doc = text "Redundant constraint" <> plural redundant_evs <> colon
465 466
         <+> pprEvVarTheta redundant_evs

467 468 469
   redundant_evs =
       filterOut is_type_error $
       case info of -- See Note [Redundant constraints in instance decls]
470
         InstSkol -> filterOut (improving . idType) ev_vars
471 472 473 474
         _        -> ev_vars

   -- See #15232
   is_type_error = isJust . userTypeError_maybe . idType
475

476 477
   improving pred -- (transSuperClasses p) does not include p
     = any isImprovementPred (pred : transSuperClasses pred)
478

479 480 481 482 483 484 485 486 487
reportBadTelescope :: ReportErrCtxt -> TcLclEnv -> Maybe SDoc -> [TcTyVar] -> TcM ()
reportBadTelescope ctxt env (Just telescope) skols
  = do { msg <- mkErrorReport ctxt env (important doc)
       ; reportError msg }
  where
    doc = hang (text "These kind and type variables:" <+> telescope $$
                text "are out of dependency order. Perhaps try this ordering:")
             2 (pprTyVars sorted_tvs)

Tobias Dammers's avatar
Tobias Dammers committed
488
    sorted_tvs = scopedSort skols
489 490 491 492

reportBadTelescope _ _ Nothing skols
  = pprPanic "reportBadTelescope" (ppr skols)

493 494 495 496 497 498 499 500
{- 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
501
of evidence, since the dictionary has no fields.  But it is still
502 503 504 505 506 507 508
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..
-}
509

510
reportWanteds :: ReportErrCtxt -> TcLevel -> WantedConstraints -> TcM ()
511
reportWanteds ctxt tc_lvl (WC { wc_simple = simples, wc_impl = implics })
512 513
  = do { traceTc "reportWanteds" (vcat [ text "Simples =" <+> ppr simples
                                       , text "Suppress =" <+> ppr (cec_suppress ctxt)])
514
       ; traceTc "rw2" (ppr tidy_cts)
515 516 517 518

         -- First deal with things that are utterly wrong
         -- Like Int ~ Bool (incl nullary TyCons)
         -- or  Int ~ t a   (AppTy on one side)
519
         -- These /ones/ are not suppressed by the incoming context
520 521 522 523 524 525 526 527
       ; 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
528 529
       ; MASSERT2( null leftovers, ppr leftovers )

530
            -- All the Derived ones have been filtered out of simples
531 532 533
            -- 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]
534

535
     ; mapBagM_ (reportImplic ctxt2) implics }
536
            -- NB ctxt1: don't suppress inner insolubles if there's only a
537
            -- wanted insoluble here; but do suppress inner insolubles
538
            -- if there's a *given* insoluble here (= inaccessible code)
539
 where
540
    env = cec_tidy ctxt
541
    tidy_cts = bagToList (mapBag (tidyCt env) simples)
542

543 544 545
    -- report1: ones that should *not* be suppresed by
    --          an insoluble somewhere else in the tree
    -- It's crucial that anything that is considered insoluble
546
    -- (see TcRnTypes.insolubleCt) is caught here, otherwise
547 548
    -- we might suppress its error message, and proceed on past
    -- type checking to get a Lint error later
Simon Peyton Jones's avatar
Simon Peyton Jones committed
549
    report1 = [ ("Out of scope", is_out_of_scope,    True,  mkHoleReporter tidy_cts)
550
              , ("Holes",        is_hole,            False, mkHoleReporter tidy_cts)
Simon Peyton Jones's avatar
Simon Peyton Jones committed
551
              , ("custom_error", is_user_type_error, True,  mkUserTypeErrorReporter)
552

553
              , given_eq_spec
554 555 556 557
              , ("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)
558 559 560

                  -- The only remaining equalities are alpha ~ ty,
                  -- where alpha is untouchable; and representational equalities
561 562 563 564 565
                  -- 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) ]
566 567 568 569 570 571

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

572 573
    -- rigid_nom_eq, rigid_nom_tv_eq,
    is_hole, is_dict,
574
      is_equality, is_ip, is_irred :: Ct -> PredTree -> Bool
575

576 577 578 579 580
    is_given_eq ct pred
       | EqPred {} <- pred = arisesFromGivens ct
       | otherwise         = False
       -- I think all given residuals are equalities

581 582 583 584 585 586 587
    -- 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
588

589
    -- Things like (a ~N b) or (a  ~N  F Bool)
590
    skolem_eq _ (EqPred NomEq ty1 _) = isSkolemTy tc_lvl ty1
591
    skolem_eq _ _                    = False
592

593 594 595 596 597 598 599 600
    -- 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
601

602 603 604
    is_homo_equality _ (EqPred _ ty1 ty2) = typeKind ty1 `tcEqType` typeKind ty2
    is_homo_equality _ _                  = False

605 606 607
    is_equality _ (EqPred {}) = True
    is_equality _ _           = False

608 609 610 611 612 613 614 615 616
    is_dict _ (ClassPred {}) = True
    is_dict _ _              = False

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

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

617 618 619 620 621 622 623 624 625 626 627 628 629 630
    given_eq_spec  -- See Note [Given errors]
      | has_gadt_match (cec_encl ctxt)
      = ("insoluble1a", is_given_eq, True,  mkGivenErrorReporter)
      | otherwise
      = ("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

    -- See Note [Given errors]
    has_gadt_match [] = False
    has_gadt_match (implic : implics)
631 632
      | PatSkol {} <- ic_info implic
      , not (ic_no_eqs implic)
633 634 635
      , wopt Opt_WarnInaccessibleCode (implicDynFlags implic)
          -- Don't bother doing this if -Winaccessible-code isn't enabled.
          -- See Note [Avoid -Winaccessible-code when deriving] in TcInstDcls.
636
      = True
637
      | otherwise
638
      = has_gadt_match implics
639

640
---------------
641
isSkolemTy :: TcLevel -> Type -> Bool
642
-- The type is a skolem tyvar
643
isSkolemTy tc_lvl ty
644 645
  | Just tv <- getTyVar_maybe ty
  =  isSkolemTyVar tv
646 647
  || (isTyVarTyVar tv && isTouchableMetaTyVar tc_lvl tv)
     -- The last case is for touchable TyVarTvs
648 649 650 651
     -- we postpone untouchables to a latter test (too obscure)

  | otherwise
  = False
652

653 654
isTyFun_maybe :: Type -> Maybe TyCon
isTyFun_maybe ty = case tcSplitTyConApp_maybe ty of
655
                      Just (tc,_) | isTypeFamilyTyCon tc -> Just tc
656 657
                      _ -> Nothing

658
--------------------------------------------
659
--      Reporters
660 661
--------------------------------------------

662 663 664 665 666 667 668 669 670
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
671
-- Suppress duplicates with either the same LHS, or same location
672
mkSkolReporter ctxt cts
673
  = mapM_ (reportGroup mkEqErr ctxt) (group cts)
674
  where
675 676 677 678 679 680
     group [] = []
     group (ct:cts) = (ct : yeses) : group noes
        where
          (yeses, noes) = partition (group_with ct) cts

     group_with ct1 ct2
681 682 683
       | EQ <- cmp_loc ct1 ct2 = True
       | eq_lhs_type   ct1 ct2 = True
       | otherwise             = False
684

685
mkHoleReporter :: [Ct] -> Reporter
686
-- Reports errors one at a time
687 688
mkHoleReporter tidy_simples ctxt
  = mapM_ $ \ct -> do { err <- mkHoleError tidy_simples ctxt ct
689 690
                      ; maybeReportHoleError ctxt ct err
                      ; maybeAddDeferredHoleBinding ctxt err ct }
691

692 693
mkUserTypeErrorReporter :: Reporter
mkUserTypeErrorReporter ctxt
694
  = mapM_ $ \ct -> do { err <- mkUserTypeError ctxt ct
695 696
                      ; maybeReportError ctxt err
                      ; addDeferredBinding ctxt err ct }
697 698 699

mkUserTypeError :: ReportErrCtxt -> Ct -> TcM ErrMsg
mkUserTypeError ctxt ct = mkErrorMsgFromCt ctxt ct
700
                        $ important
701 702
                        $ pprUserTypeErrorTy
                        $ case getUserTypeErrorMsg ct of
703 704
                            Just msg -> msg
                            Nothing  -> pprPanic "mkUserTypeError" (ppr ct)
705 706


707
mkGivenErrorReporter :: Reporter
708
-- See Note [Given errors]
709
mkGivenErrorReporter ctxt cts
710 711
  = do { (ctxt, binds_msg, ct) <- relevantBindings True ctxt ct
       ; dflags <- getDynFlags
712 713 714
       ; let (implic:_) = cec_encl ctxt
                 -- Always non-empty when mkGivenErrorReporter is called
             ct' = setCtLoc ct (setCtLocEnv (ctLoc ct) (implicLclEnv implic))
715
                   -- For given constraints we overwrite the env (and hence src-loc)
716 717
                   -- with one from the immediately-enclosing implication.
                   -- See Note [Inaccessible code]
718 719 720 721 722 723 724 725 726

             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
727
       ; traceTc "mkGivenErrorReporter" (ppr ct)
728
       ; reportWarning (Reason Opt_WarnInaccessibleCode) err }
729 730 731 732
  where
    (ct : _ )  = cts    -- Never empty
    (ty1, ty2) = getEqPredTys (ctPred ct)

733 734
ignoreErrorReporter :: Reporter
-- Discard Given errors that don't come from
Simon Peyton Jones's avatar
Simon Peyton Jones committed
735
-- a pattern match; maybe we should warn instead?
736
ignoreErrorReporter ctxt cts
Simon Peyton Jones's avatar
Simon Peyton Jones committed
737
  = do { traceTc "mkGivenErrorReporter no" (ppr cts $$ ppr (cec_encl ctxt))
738 739
       ; return () }

740 741 742

{- Note [Given errors]
~~~~~~~~~~~~~~~~~~~~~~
Gabor Greif's avatar
Gabor Greif committed
743
Given constraints represent things for which we have (or will have)
744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761
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
762
#12466 for a long discussion.  For example, if we aren't careful
763 764 765 766
we'll complain about
   f :: ((Int ~ Bool) => a -> a) -> Int
which arguably is OK.  It's more debatable for
   g :: (Int ~ Bool) => Int -> Int
767
but it's tricky to distinguish these cases so we don't report
768 769
either.

770
The bottom line is this: has_gadt_match looks for an enclosing
771 772 773 774
pattern match which binds some equality constraints.  If we
find one, we report the insoluble Given.
-}

775 776 777
mkGroupReporter :: (ReportErrCtxt -> [Ct] -> TcM ErrMsg)
                             -- Make error message for a group
                -> Reporter  -- Deal with lots of constraints
778 779 780
-- Group together errors from same location,
-- and report only the first (to avoid a cascade)
mkGroupReporter mk_err ctxt cts
781
  = mapM_ (reportGroup mk_err ctxt . toList) (equivClasses cmp_loc cts)
782

783 784
eq_lhs_type :: Ct -> Ct -> Bool
eq_lhs_type ct1 ct2
785 786
  = case (classifyPredType (ctPred ct1), classifyPredType (ctPred ct2)) of
       (EqPred eq_rel1 ty1 _, EqPred eq_rel2 ty2 _) ->
787
         (eq_rel1 == eq_rel2) && (ty1 `eqType` ty2)
788 789 790 791
       _ -> pprPanic "mkSkolReporter" (ppr ct1 $$ ppr ct2)

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

793 794
reportGroup :: (ReportErrCtxt -> [Ct] -> TcM ErrMsg) -> ReportErrCtxt
            -> [Ct] -> TcM ()
quchen's avatar
quchen committed
795 796 797
reportGroup mk_err ctxt cts =
  case partition isMonadFailInstanceMissing cts of
        -- Only warn about missing MonadFail constraint when
Gabor Greif's avatar
Gabor Greif committed
798
        -- there are no other missing constraints!
799 800 801
        (monadFailCts, []) ->
            do { err <- mk_err ctxt monadFailCts
               ; reportWarning (Reason Opt_WarnMissingMonadFailInstances) err }
quchen's avatar
quchen committed
802 803

        (_, cts') -> do { err <- mk_err ctxt cts'
Simon Peyton Jones's avatar
Simon Peyton Jones committed
804 805 806 807
                        ; traceTc "About to maybeReportErr" $
                          vcat [ text "Constraint:"             <+> ppr cts'
                               , text "cec_suppress ="          <+> ppr (cec_suppress ctxt)
                               , text "cec_defer_type_errors =" <+> ppr (cec_defer_type_errors ctxt) ]
quchen's avatar
quchen committed
808
                        ; maybeReportError ctxt err
809 810 811 812 813 814 815
                            -- 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
816 817 818 819 820
  where
    isMonadFailInstanceMissing ct =
        case ctLocOrigin (ctLoc ct) of
            FailablePattern _pat -> True
            _otherwise           -> False
821

822
maybeReportHoleError :: ReportErrCtxt -> Ct -> ErrMsg -> TcM ()
823 824
-- Unlike maybeReportError, these "hole" errors are
-- /not/ suppressed by cec_suppress.  We want to see them!
825
maybeReportHoleError ctxt ct err
thomasw's avatar
thomasw committed
826
  -- When -XPartialTypeSignatures is on, warnings (instead of errors) are
827 828 829
  -- generated for holes in partial type signatures.
  -- Unless -fwarn_partial_type_signatures is not on,
  -- in which case the messages are discarded.
830 831 832 833 834
  | 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
835
       HoleWarn  -> reportWarning (Reason Opt_WarnPartialTypeSignatures) err
836 837
       HoleDefer -> return ()

838 839 840 841
  -- 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
842
  | isOutOfScopeCt ct
843 844 845 846 847 848
  = -- 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 ()
849 850 851

  -- Otherwise this is a typed hole in an expression,
  -- but not for an out-of-scope variable
852
  | otherwise
853
  = -- If deferring, report a warning only if -Wtyped-holes is on
854 855
    case cec_expr_holes ctxt of
       HoleError -> reportError err
856
       HoleWarn  -> reportWarning (Reason Opt_WarnTypedHoles) err
857
       HoleDefer -> return ()
858

859
maybeReportError :: ReportErrCtxt -> ErrMsg -> TcM ()
860
-- Report the error and/or make a deferred binding for it
861
maybeReportError ctxt err
862 863 864
  | cec_suppress ctxt    -- Some worse error has occurred;
  = return ()            -- so suppress this error/warning

865
  | otherwise
866
  = case cec_defer_type_errors ctxt of
867 868 869
      TypeDefer       -> return ()
      TypeWarn reason -> reportWarning reason err
      TypeError       -> reportError err
870

871
addDeferredBinding :: ReportErrCtxt -> ErrMsg -> Ct -> TcM ()
872
-- See Note [Deferring coercion errors to runtime]
873
addDeferredBinding ctxt err ct