TcErrors.hs 141 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 TcEvTerm
35
import HsExpr  ( UnboundVar(..) )
36
import HsBinds ( PatSynBind(..) )
37
import Name
38
import RdrName ( lookupGlobalRdrEnv, lookupGRE_Name, GlobalRdrEnv
39 40
               , mkRdrUnqual, isLocalGRE, greSrcSpan, pprNameProvenance
               , GlobalRdrElt (..), globalRdrEnvElts )
Richard Eisenberg's avatar
Richard Eisenberg committed
41
import PrelNames ( typeableClassName, hasKey, liftedRepDataConKey )
42
import Id
43 44 45
import Var
import VarSet
import VarEnv
46
import NameSet
47
import Bag
48
import ErrUtils         ( ErrMsg, errDoc, pprLocErrMsg )
49
import BasicTypes
50
import ConLike          ( ConLike(..))
51
import Util
52
import TcEnv (tcLookup)
53
import {-# SOURCE #-} TcSimplify ( tcCheckHoleFit, tcSubsumes )
54 55
import FastString
import Outputable
56
import SrcLoc
57
import DynFlags
58
import ListSetOps       ( equivClasses )
59
import Maybes
60
import Pair
61
import qualified GHC.LanguageExtensions as LangExt
62
import FV ( fvVarList, fvVarSet, unionFV )
Icelandjack's avatar
Icelandjack committed
63

64
import Control.Monad    ( when, filterM, replicateM )
65
import Data.Foldable    ( toList )
66 67
import Data.List        ( partition, mapAccumL, nub
                        , sortBy, sort, unfoldr, foldl' )
68
import qualified Data.Set as Set
69 70
import Data.Graph       ( graphFromEdges, topSort )
import Data.Function    ( on )
71

72 73
import Data.Semigroup   ( Semigroup )
import qualified Data.Semigroup as Semigroup
74 75


Austin Seipp's avatar
Austin Seipp committed
76 77 78
{-
************************************************************************
*                                                                      *
79
\section{Errors and contexts}
Austin Seipp's avatar
Austin Seipp committed
80 81
*                                                                      *
************************************************************************
82 83 84 85 86

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?

87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105
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
106

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

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

136
       ; defer_holes <- goptM Opt_DeferTypedHoles
137 138 139 140 141
       ; warn_holes  <- woptM Opt_WarnTypedHoles
       ; let expr_holes | not defer_holes = HoleError
                        | warn_holes      = HoleWarn
                        | otherwise       = HoleDefer

142
       ; partial_sigs      <- xoptM LangExt.PartialTypeSignatures
thomasw's avatar
thomasw committed
143
       ; warn_partial_sigs <- woptM Opt_WarnPartialTypeSignatures
144 145 146 147
       ; let type_holes | not partial_sigs  = HoleError
                        | warn_partial_sigs = HoleWarn
                        | otherwise         = HoleDefer

148 149 150 151 152 153
       ; 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

154
       ; report_unsolved binds_var False type_errors expr_holes
155
          type_holes out_of_scope_holes wanted
156 157 158

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

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

173 174 175 176 177
-- | 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
178 179 180
  = do { ev_binds <- newTcEvBinds
       ; report_unsolved ev_binds True TypeWarn
                         HoleWarn HoleWarn HoleWarn wanted }
181 182

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

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

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

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

221 222
       ; tc_lvl <- getTcLevel
       ; reportWanteds err_ctxt tc_lvl wanted }
223

224 225 226
--------------------------------------------
--      Internal functions
--------------------------------------------
227

228 229 230 231 232
-- | 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]
233
           , report_valid_substitutions :: [SDoc]
234 235
           }

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

244 245 246 247 248 249 250 251
{- 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.

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

257
instance Semigroup Report where
258
    Report a1 b1 c1 <> Report a2 b2 c2 = Report (a1 ++ a2) (b1 ++ b2) (c1 ++ c2)
259

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

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

272 273 274 275
-- | Put a doc into the valid substitutions block.
valid_substitutions :: SDoc -> Report
valid_substitutions docs = mempty { report_valid_substitutions = [docs] }

276 277 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
  | 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

281 282 283 284 285
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

286 287 288 289 290 291 292 293 294 295
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"

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

302 303 304
          , cec_binds :: EvBindsVar    -- Make some errors (depending on cec_defer)
                                       -- into warnings, and emit evidence bindings
                                       -- into 'cec_binds' for unsolved constraints
305

306 307 308 309
          , cec_errors_as_warns :: Bool   -- Turn all errors into warnings
                                          -- (except for Holes, which are
                                          -- controlled by cec_type_holes and
                                          -- cec_expr_holes)
310
          , cec_defer_type_errors :: TypeErrorChoice -- Defer type errors until runtime
311

312 313 314 315 316 317 318
          -- 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
319

320
          , cec_warn_redundant :: Bool    -- True <=> -Wredundant-constraints
321

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

328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346
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
347
{-
348 349
Note [Suppressing error messages]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
350
The cec_suppress flag says "don't report any errors".  Instead, just create
351
evidence bindings (as usual).  It's used when more important errors have occurred.
352

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

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

  | otherwise
374 375
  = do { traceTc "reportImplic" (ppr implic')
       ; reportWanteds ctxt' tc_lvl wanted
376 377
       ; when (cec_warn_redundant ctxt) $
         warnRedundantConstraints ctxt' tcl_env info' dead_givens }
378
  where
379
    insoluble    = isInsolubleStatus status
380
    (env1, tvs') = mapAccumL tidyTyCoVarBndr (cec_tidy ctxt) tvs
Simon Peyton Jones's avatar
Simon Peyton Jones committed
381
    info'        = tidySkolemInfo env1 info
382
    implic' = implic { ic_skols = tvs'
Simon Peyton Jones's avatar
Simon Peyton Jones committed
383
                     , ic_given = map (tidyEvVar env1) given
384
                     , ic_info  = info' }
385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403
    ctxt1 | termEvidenceAllowed info = ctxt
          | otherwise                = ctxt { cec_defer_type_errors = TypeError }
          -- If we go inside an implication that has no term
          -- evidence (i.e. unifying under a forall), we can't defer
          -- 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 }
404

405 406 407 408 409
    dead_givens = case status of
                    IC_Solved { ics_dead = dead } -> dead
                    _                             -> []

warnRedundantConstraints :: ReportErrCtxt -> TcLclEnv -> SkolemInfo -> [EvVar] -> TcM ()
410
-- See Note [Tracking redundant constraints] in TcSimplify
411
warnRedundantConstraints ctxt env info ev_vars
412
 | null redundant_evs
413 414 415 416 417
 = return ()

 | SigSkol {} <- info
 = setLclEnv env $  -- We want to add "In the type signature for f"
                    -- to the error context, which is a bit tiresome
418
   addErrCtxt (text "In" <+> ppr info) $
419
   do { env <- getLclEnv
420
      ; msg <- mkErrorReport ctxt env (important doc)
421
      ; reportWarning (Reason Opt_WarnRedundantConstraints) msg }
422 423 424 425

 | 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
426
 = do { msg <- mkErrorReport ctxt env (important doc)
427
      ; reportWarning (Reason Opt_WarnRedundantConstraints) msg }
428
 where
429
   doc = text "Redundant constraint" <> plural redundant_evs <> colon
430 431 432 433 434 435 436
         <+> 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 $
437
                      transSuperClasses (idType ev_var)
438 439 440 441 442 443 444 445 446

{- 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
447
of evidence, since the dictionary has no fields.  But it is still
448 449 450 451 452 453 454
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..
-}
455

456
reportWanteds :: ReportErrCtxt -> TcLevel -> WantedConstraints -> TcM ()
457
reportWanteds ctxt tc_lvl (WC { wc_simple = simples, wc_impl = implics })
458 459
  = do { traceTc "reportWanteds" (vcat [ text "Simples =" <+> ppr simples
                                       , text "Suppress =" <+> ppr (cec_suppress ctxt)])
460
       ; traceTc "rw2" (ppr tidy_cts)
461 462 463 464

         -- First deal with things that are utterly wrong
         -- Like Int ~ Bool (incl nullary TyCons)
         -- or  Int ~ t a   (AppTy on one side)
465
         -- These /ones/ are not suppressed by the incoming context
466 467 468 469 470 471 472 473
       ; 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
474 475
       ; MASSERT2( null leftovers, ppr leftovers )

476
            -- All the Derived ones have been filtered out of simples
477 478 479
            -- 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]
480

481
     ; mapBagM_ (reportImplic ctxt2) implics }
482
            -- NB ctxt1: don't suppress inner insolubles if there's only a
483
            -- wanted insoluble here; but do suppress inner insolubles
484
            -- if there's a *given* insoluble here (= inaccessible code)
485
 where
486
    env = cec_tidy ctxt
487
    tidy_cts = bagToList (mapBag (tidyCt env) simples)
488

489 490 491
    -- report1: ones that should *not* be suppresed by
    --          an insoluble somewhere else in the tree
    -- It's crucial that anything that is considered insoluble
492
    -- (see TcRnTypes.insolubleWantedCt) is caught here, otherwise
493 494
    -- we might suppress its error message, and proceed on past
    -- type checking to get a Lint error later
495
    report1 = [ ("custom_error", is_user_type_error,True, mkUserTypeErrorReporter)
496
              , given_eq_spec
497 498 499 500 501 502
              , ("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)
503 504 505

                  -- The only remaining equalities are alpha ~ ty,
                  -- where alpha is untouchable; and representational equalities
506 507 508 509 510
                  -- 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) ]
511 512 513 514 515 516

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

517 518
    -- rigid_nom_eq, rigid_nom_tv_eq,
    is_hole, is_dict,
519
      is_equality, is_ip, is_irred :: Ct -> PredTree -> Bool
520

521 522 523 524 525
    is_given_eq ct pred
       | EqPred {} <- pred = arisesFromGivens ct
       | otherwise         = False
       -- I think all given residuals are equalities

526 527 528 529 530 531 532
    -- 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
533

534
    -- Things like (a ~N b) or (a  ~N  F Bool)
535
    skolem_eq _ (EqPred NomEq ty1 _) = isSkolemTy tc_lvl ty1
536
    skolem_eq _ _                    = False
537

538 539 540 541 542 543 544 545
    -- 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
546

547 548 549
    is_homo_equality _ (EqPred _ ty1 ty2) = typeKind ty1 `tcEqType` typeKind ty2
    is_homo_equality _ _                  = False

550 551 552
    is_equality _ (EqPred {}) = True
    is_equality _ _           = False

553 554 555 556 557 558 559 560 561
    is_dict _ (ClassPred {}) = True
    is_dict _ _              = False

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

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

562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577
    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
578

579
---------------
580
isSkolemTy :: TcLevel -> Type -> Bool
581
-- The type is a skolem tyvar
582
isSkolemTy tc_lvl ty
583 584 585 586 587 588 589 590
  | 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
591

592 593
isTyFun_maybe :: Type -> Maybe TyCon
isTyFun_maybe ty = case tcSplitTyConApp_maybe ty of
594
                      Just (tc,_) | isTypeFamilyTyCon tc -> Just tc
595 596
                      _ -> Nothing

597
--------------------------------------------
598
--      Reporters
599 600
--------------------------------------------

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

     group_with ct1 ct2
620 621 622
       | EQ <- cmp_loc ct1 ct2 = True
       | eq_lhs_type   ct1 ct2 = True
       | otherwise             = False
623

624
mkHoleReporter :: [Ct] -> Reporter
625
-- Reports errors one at a time
626 627
mkHoleReporter tidy_simples ctxt
  = mapM_ $ \ct -> do { err <- mkHoleError tidy_simples ctxt ct
628 629
                      ; maybeReportHoleError ctxt ct err
                      ; maybeAddDeferredHoleBinding ctxt err ct }
630

631 632
mkUserTypeErrorReporter :: Reporter
mkUserTypeErrorReporter ctxt
633
  = mapM_ $ \ct -> do { err <- mkUserTypeError ctxt ct
634 635
                      ; maybeReportError ctxt err
                      ; addDeferredBinding ctxt err ct }
636 637 638

mkUserTypeError :: ReportErrCtxt -> Ct -> TcM ErrMsg
mkUserTypeError ctxt ct = mkErrorMsgFromCt ctxt ct
639
                        $ important
640 641
                        $ pprUserTypeErrorTy
                        $ case getUserTypeErrorMsg ct of
642 643
                            Just msg -> msg
                            Nothing  -> pprPanic "mkUserTypeError" (ppr ct)
644 645


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

669 670
ignoreErrorReporter :: Reporter
-- Discard Given errors that don't come from
Simon Peyton Jones's avatar
Simon Peyton Jones committed
671
-- a pattern match; maybe we should warn instead?
672
ignoreErrorReporter ctxt cts
Simon Peyton Jones's avatar
Simon Peyton Jones committed
673
  = do { traceTc "mkGivenErrorReporter no" (ppr cts $$ ppr (cec_encl ctxt))
674 675
       ; return () }

676 677 678

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

Simon Peyton Jones's avatar
Simon Peyton Jones committed
706
The bottom line is this: find_gadt_match looks for an enclosing
707 708 709 710
pattern match which binds some equality constraints.  If we
find one, we report the insoluble Given.
-}

711 712 713
mkGroupReporter :: (ReportErrCtxt -> [Ct] -> TcM ErrMsg)
                             -- Make error message for a group
                -> Reporter  -- Deal with lots of constraints
714 715 716
-- Group together errors from same location,
-- and report only the first (to avoid a cascade)
mkGroupReporter mk_err ctxt cts
717
  = mapM_ (reportGroup mk_err ctxt . toList) (equivClasses cmp_loc cts)
718

719 720
eq_lhs_type :: Ct -> Ct -> Bool
eq_lhs_type ct1 ct2
721 722
  = case (classifyPredType (ctPred ct1), classifyPredType (ctPred ct2)) of
       (EqPred eq_rel1 ty1 _, EqPred eq_rel2 ty2 _) ->
723
         (eq_rel1 == eq_rel2) && (ty1 `eqType` ty2)
724 725 726 727
       _ -> pprPanic "mkSkolReporter" (ppr ct1 $$ ppr ct2)

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

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

        (_, cts') -> do { err <- mk_err ctxt cts'
                        ; maybeReportError ctxt err
741 742 743 744 745 746 747
                            -- 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
748 749 750 751 752
  where
    isMonadFailInstanceMissing ct =
        case ctLocOrigin (ctLoc ct) of
            FailablePattern _pat -> True
            _otherwise           -> False
753

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

768 769 770 771
  -- 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
772
  | isOutOfScopeCt ct
773 774 775 776 777 778
  = -- 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 ()
779 780 781

  -- Otherwise this is a typed hole in an expression,
  -- but not for an out-of-scope variable
782
  | otherwise
783
  = -- If deferring, report a warning only if -Wtyped-holes is on
784 785
    case cec_expr_holes ctxt of
       HoleError -> reportError err
786
       HoleWarn  -> reportWarning (Reason Opt_WarnTypedHoles) err
787
       HoleDefer -> return ()
788

789
maybeReportError :: ReportErrCtxt -> ErrMsg -> TcM ()
790
-- Report the error and/or make a deferred binding for it
791
maybeReportError ctxt err
792 793 794
  | cec_suppress ctxt    -- Some worse error has occurred;
  = return ()            -- so suppress this error/warning

795
  | cec_errors_as_warns ctxt
796
  = reportWarning NoReason err
797

798
  | otherwise
799
  = case cec_defer_type_errors ctxt of
800
      TypeDefer -> return ()
801
      TypeWarn  -> reportWarning (Reason Opt_WarnDeferredTypeErrors) err
802
      TypeError -> reportError err
803

804
addDeferredBinding :: ReportErrCtxt -> ErrMsg -> Ct -> TcM ()
805
-- See Note [Deferring coercion errors to runtime]
806
addDeferredBinding ctxt err ct
807
  | CtWanted { ctev_pred = pred, ctev_dest = dest } <- ctEvidence ct
808 809 810 811 812
    -- 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)"
813
             err_tm  = evDelayedError pred err_fs
814
             ev_binds_var = cec_binds ctxt
815

816 817
       ; case dest of
           EvVarDest evar
818
             -> addTcEvBind ev_binds_var $ mkWantedEvBind evar (EvExpr err_tm)
819 820
           HoleDest hole
             -> do { -- See Note [Deferred errors for coercion holes]
Simon Peyton Jones's avatar
Simon Peyton Jones committed
821
                     let co_var = coHoleCoVar hole
822
                   ; addTcEvBind ev_binds_var $ mkWantedEvBind co_var (EvExpr err_tm)
Simon Peyton Jones's avatar
Simon Peyton Jones committed
823
                   ; fillCoercionHole hole (mkTcCoVarCo co_var) }}
824 825

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

828 829
maybeAddDeferredHoleBinding :: ReportErrCtxt -> ErrMsg -> Ct -> TcM ()
maybeAddDeferredHoleBinding ctxt err ct
830 831 832 833
  | isExprHoleCt ct
  = addDeferredBinding ctxt err ct  -- Only add bindings for holes in expressions
  | otherwise                       -- not for holes in partial type signatures
  = return ()
834

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

868 869 870 871 872 873 874 875 876

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

877
-- Add the "arising from..." part to a message about bunch of dicts
878
addArising :: CtOrigin -> SDoc -> SDoc
879
addArising orig msg = hang msg 2 (pprArising orig)
880

881
pprWithArising :: [Ct] -> (CtLoc, SDoc)
882 883
-- Print something like
--    (Eq a) arising from a use of x at y
884 885