TcErrors.hs 123 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
import TcRnMonad
import TcMType
15
import TcUnify( occCheckForErrors, OccCheckResult(..) )
16
import TcType
17
import RnUnbound ( unknownNameSuggestions )
batterseapower's avatar
batterseapower committed
18
import Type
19 20
import TyCoRep
import Kind
21
import Unify            ( tcMatchTys )
22
import Module
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
23
import FamInst
24
import FamInstEnv       ( flattenTys )
25 26 27
import Inst
import InstEnv
import TyCon
28
import Class
29
import DataCon
30
import TcEvidence
31
import HsExpr  ( UnboundVar(..) )
32
import HsBinds ( PatSynBind(..) )
33
import Name
34
import RdrName ( lookupGlobalRdrEnv, lookupGRE_Name, GlobalRdrEnv
35 36
               , mkRdrUnqual, isLocalGRE, greSrcSpan, pprNameProvenance
               , GlobalRdrElt (..), globalRdrEnvElts )
Richard Eisenberg's avatar
Richard Eisenberg committed
37
import PrelNames ( typeableClassName, hasKey, liftedRepDataConKey )
38
import Id
39 40 41
import Var
import VarSet
import VarEnv
42
import NameSet
43
import Bag
44
import ErrUtils         ( ErrMsg, errDoc, pprLocErrMsg )
45
import BasicTypes
46
import ConLike          ( ConLike(..), conLikeWrapId_maybe )
47
import Util
48 49
import HscTypes (HscEnv, lookupTypeHscEnv, TypeEnv, lookupTypeEnv )
import NameEnv (lookupNameEnv)
50 51
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
niteria's avatar
niteria committed
58
import FV ( fvVarList, unionFV )
Icelandjack's avatar
Icelandjack committed
59

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

64 65 66 67
#if __GLASGOW_HASKELL__ > 710
import Data.Semigroup   ( Semigroup )
import qualified Data.Semigroup as Semigroup
#endif
68 69


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

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?

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

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

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

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

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

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

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

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

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

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

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

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

198 199 200
       ; traceTc "reportUnsolved (after zonking):" $
         vcat [ text "Free tyvars:" <+> pprTyVars free_tvs
              , text "Wanted:" <+> ppr wanted ]
201 202 203

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

214 215
       ; tc_lvl <- getTcLevel
       ; reportWanteds err_ctxt tc_lvl wanted }
216

217 218 219
--------------------------------------------
--      Internal functions
--------------------------------------------
220

221 222 223 224 225
-- | 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]
226
           , report_valid_substitutions :: [SDoc]
227 228
           }

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

237 238 239 240 241 242 243 244 245 246 247 248 249
{- 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.
-}

250 251
#if __GLASGOW_HASKELL__ > 710
instance Semigroup Report where
252
    Report a1 b1 c1 <> Report a2 b2 c2 = Report (a1 ++ a2) (b1 ++ b2) (c1 ++ c2)
253 254
#endif

255
instance Monoid Report where
256 257 258
    mempty = Report [] [] []
    mappend (Report a1 b1 c1) (Report a2 b2 c2)
      = Report (a1 ++ a2) (b1 ++ b2) (c1 ++ c2)
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 444
reportWanteds :: ReportErrCtxt -> TcLevel -> WantedConstraints -> TcM ()
reportWanteds ctxt tc_lvl (WC { wc_simple = simples, wc_insol = insols, wc_impl = implics })
445
  = do { traceTc "reportWanteds" (vcat [ text "Simples =" <+> ppr simples
446
                                       , text "Insols =" <+> ppr insols
447
                                       , text "Suppress =" <+> ppr (cec_suppress ctxt)])
448
       ; let tidy_cts = bagToList (mapBag (tidyCt env) (insols `unionBags` simples))
449 450 451 452

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

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

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

476 477 478 479 480 481
    -- 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
482
    report1 = [ ("custom_error", is_user_type_error,True, mkUserTypeErrorReporter)
483
              , given_eq_spec
484 485 486 487 488 489 490
              , ("insoluble2 ty", utterly_wrong_ty, True, mkGroupReporter mkEqErr)
              , ("insoluble2_ki", 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)
              , ("Holes",         is_hole,          False, mkHoleReporter)
491 492 493

                  -- The only remaining equalities are alpha ~ ty,
                  -- where alpha is untouchable; and representational equalities
494 495 496 497 498
                  -- 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) ]
499 500 501 502 503 504

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

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

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

514 515 516 517
    -- Things like (Int ~N Bool)
    utterly_wrong _ (EqPred NomEq ty1 ty2) = isRigidTy ty1 && isRigidTy ty2
    utterly_wrong _ _                      = False

518 519 520 521 522 523
     -- Like utterly_wrong, but suppress derived kind equalities
    utterly_wrong_ty ct pred
      = utterly_wrong ct pred && case ctOrigin ct of
                                   KindEqOrigin {} -> False
                                   _               -> True

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

528
    -- Things like (a ~N b) or (a  ~N  F Bool)
529
    skolem_eq _ (EqPred NomEq ty1 _) = isSkolemTy tc_lvl ty1
530
    skolem_eq _ _                    = False
531

532 533 534 535 536 537 538 539
    -- 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
540

541 542 543
    is_homo_equality _ (EqPred _ ty1 ty2) = typeKind ty1 `tcEqType` typeKind ty2
    is_homo_equality _ _                  = False

544 545 546
    is_equality _ (EqPred {}) = True
    is_equality _ _           = False

547 548 549 550 551 552 553 554 555
    is_dict _ (ClassPred {}) = True
    is_dict _ _              = False

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

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

556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571
    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
572

573
---------------
574
isSkolemTy :: TcLevel -> Type -> Bool
575
-- The type is a skolem tyvar
576
isSkolemTy tc_lvl ty
577 578 579 580 581 582 583 584
  | 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
585

586 587
isTyFun_maybe :: Type -> Maybe TyCon
isTyFun_maybe ty = case tcSplitTyConApp_maybe ty of
588
                      Just (tc,_) | isTypeFamilyTyCon tc -> Just tc
589 590
                      _ -> Nothing

591
--------------------------------------------
592
--      Reporters
593 594
--------------------------------------------

595 596 597 598 599 600 601 602 603
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
604
-- Suppress duplicates with either the same LHS, or same location
605
mkSkolReporter ctxt cts
606
  = mapM_ (reportGroup mkEqErr ctxt) (group cts)
607
  where
608 609 610 611 612 613
     group [] = []
     group (ct:cts) = (ct : yeses) : group noes
        where
          (yeses, noes) = partition (group_with ct) cts

     group_with ct1 ct2
614 615 616
       | EQ <- cmp_loc ct1 ct2 = True
       | eq_lhs_type   ct1 ct2 = True
       | otherwise             = False
617

618
mkHoleReporter :: Reporter
619
-- Reports errors one at a time
620
mkHoleReporter ctxt
621 622 623
  = mapM_ $ \ct -> do { err <- mkHoleError ctxt ct
                      ; maybeReportHoleError ctxt ct err
                      ; maybeAddDeferredHoleBinding ctxt err ct }
624

625 626
mkUserTypeErrorReporter :: Reporter
mkUserTypeErrorReporter ctxt
627
  = mapM_ $ \ct -> do { err <- mkUserTypeError ctxt ct
628 629
                      ; maybeReportError ctxt err
                      ; addDeferredBinding ctxt err ct }
630 631 632

mkUserTypeError :: ReportErrCtxt -> Ct -> TcM ErrMsg
mkUserTypeError ctxt ct = mkErrorMsgFromCt ctxt ct
633
                        $ important
634 635
                        $ pprUserTypeErrorTy
                        $ case getUserTypeErrorMsg ct of
636 637
                            Just msg -> msg
                            Nothing  -> pprPanic "mkUserTypeError" (ppr ct)
638 639


640
mkGivenErrorReporter :: Implication -> Reporter
641
-- See Note [Given errors]
642
mkGivenErrorReporter implic ctxt cts
643 644 645 646 647 648 649 650 651 652 653 654 655 656
  = 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
657
       ; traceTc "mkGivenErrorReporter" (ppr ct)
658 659 660 661 662
       ; maybeReportError ctxt err }
  where
    (ct : _ )  = cts    -- Never empty
    (ty1, ty2) = getEqPredTys (ctPred ct)

663 664
ignoreErrorReporter :: Reporter
-- Discard Given errors that don't come from
Simon Peyton Jones's avatar
Simon Peyton Jones committed
665
-- a pattern match; maybe we should warn instead?
666
ignoreErrorReporter ctxt cts
Simon Peyton Jones's avatar
Simon Peyton Jones committed
667
  = do { traceTc "mkGivenErrorReporter no" (ppr cts $$ ppr (cec_encl ctxt))
668 669
       ; return () }

670 671 672

{- Note [Given errors]
~~~~~~~~~~~~~~~~~~~~~~
Gabor Greif's avatar
Gabor Greif committed
673
Given constraints represent things for which we have (or will have)
674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704
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
#12466 for a long discussion on.  For example, if we aren't careful
we'll complain about
   f :: ((Int ~ Bool) => a -> a) -> Int
which arguably is OK.  It's more debatable for
   g :: (Int ~ Bool) => Int -> Int
but it's tricky to distinguish these cases to we don't report
either.

The bottom line is this: find_gadt_match looks for an encosing
pattern match which binds some equality constraints.  If we
find one, we report the insoluble Given.
-}

705 706 707
mkGroupReporter :: (ReportErrCtxt -> [Ct] -> TcM ErrMsg)
                             -- Make error message for a group
                -> Reporter  -- Deal with lots of constraints
708 709 710 711
-- 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)
712

713 714
eq_lhs_type :: Ct -> Ct -> Bool
eq_lhs_type ct1 ct2
715 716
  = case (classifyPredType (ctPred ct1), classifyPredType (ctPred ct2)) of
       (EqPred eq_rel1 ty1 _, EqPred eq_rel2 ty2 _) ->
717
         (eq_rel1 == eq_rel2) && (ty1 `eqType` ty2)
718 719 720 721
       _ -> pprPanic "mkSkolReporter" (ppr ct1 $$ ppr ct2)

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

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

        (_, cts') -> do { err <- mk_err ctxt cts'
                        ; maybeReportError ctxt err
735 736 737 738 739 740 741
                            -- 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
742 743 744 745 746
  where
    isMonadFailInstanceMissing ct =
        case ctLocOrigin (ctLoc ct) of
            FailablePattern _pat -> True
            _otherwise           -> False
747

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

762 763 764 765
  -- 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
766
  | isOutOfScopeCt ct
767 768 769 770 771 772
  = -- 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 ()
773 774 775

  -- Otherwise this is a typed hole in an expression,
  -- but not for an out-of-scope variable
776
  | otherwise
777
  = -- If deferring, report a warning only if -Wtyped-holes is on
778 779
    case cec_expr_holes ctxt of
       HoleError -> reportError err
780
       HoleWarn  -> reportWarning (Reason Opt_WarnTypedHoles) err
781
       HoleDefer -> return ()
782

783
maybeReportError :: ReportErrCtxt -> ErrMsg -> TcM ()
784
-- Report the error and/or make a deferred binding for it
785
maybeReportError ctxt err
786 787 788
  | cec_suppress ctxt    -- Some worse error has occurred;
  = return ()            -- so suppress this error/warning

789
  | cec_errors_as_warns ctxt
790
  = reportWarning NoReason err
791

792
  | otherwise
793
  = case cec_defer_type_errors ctxt of
794
      TypeDefer -> return ()
795
      TypeWarn  -> reportWarning (Reason Opt_WarnDeferredTypeErrors) err
796
      TypeError -> reportError err
797

798
addDeferredBinding :: ReportErrCtxt -> ErrMsg -> Ct -> TcM ()
799
-- See Note [Deferring coercion errors to runtime]
800
addDeferredBinding ctxt err ct
801
  | CtWanted { ctev_pred = pred, ctev_dest = dest } <- ctEvidence ct
802 803 804 805 806
    -- 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)"
807
             err_tm  = EvDelayedError pred err_fs
808
             ev_binds_var = cec_binds ctxt
809

810 811 812 813 814 815 816 817
       ; 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) }}
818 819

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

822 823
maybeAddDeferredHoleBinding :: ReportErrCtxt -> ErrMsg -> Ct -> TcM ()
maybeAddDeferredHoleBinding ctxt err ct
824 825 826 827
  | isExprHoleCt ct
  = addDeferredBinding ctxt err ct  -- Only add bindings for holes in expressions
  | otherwise                       -- not for holes in partial type signatures
  = return ()
828

829
tryReporters :: ReportErrCtxt -> [ReporterSpec] -> [Ct] -> TcM (ReportErrCtxt, [Ct])
830
-- Use the first reporter in the list whose predicate says True
831
tryReporters ctxt reporters cts
832
  = do { traceTc "tryReporters {" (ppr cts)
833 834 835
       ; (ctxt', cts') <- go ctxt reporters cts
       ; traceTc "tryReporters }" (ppr cts')
       ; return (ctxt', cts') }
836
  where
837
    go ctxt [] cts
838 839 840 841 842 843 844 845 846 847 848 849
      = 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)
850
  | otherwise  = do { traceTc "tryReporter{ " (text str <+> ppr yeses)
851 852
                    ; reporter ctxt yeses
                    ; let ctxt' = ctxt { cec_suppress = suppress_after || cec_suppress ctxt }
853
                    ; traceTc "tryReporter end }" (text str <+> ppr (cec_suppress ctxt) <+> ppr suppress_after)
854 855 856
                    ; return (ctxt', nos) }
  where
    (yeses, nos) = partition (\ct -> keep_me ct (classifyPredType (ctPred ct))) cts
857

858 859 860 861 862 863 864 865 866

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

867