TcErrors.hs 114 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 RnEnv( 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 35
import RdrName ( lookupGlobalRdrEnv, lookupGRE_Name, GlobalRdrEnv
               , mkRdrUnqual, isLocalGRE, greSrcSpan )
36 37
import PrelNames ( typeableClassName, hasKey, ptrRepLiftedDataConKey
                 , ptrRepUnliftedDataConKey )
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(..) )
47 48 49
import Util
import FastString
import Outputable
50
import SrcLoc
51
import DynFlags
52
import StaticFlags      ( opt_PprStyle_Debug )
53
import ListSetOps       ( equivClasses )
54
import Maybes
55
import qualified GHC.LanguageExtensions as LangExt
niteria's avatar
niteria committed
56
import FV ( fvVarList, unionFV )
Icelandjack's avatar
Icelandjack committed
57

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

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


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

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?

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

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

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

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

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

140 141 142 143 144 145
       ; 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

146
       ; report_unsolved binds_var False type_errors expr_holes
147
          type_holes out_of_scope_holes wanted
148 149 150

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

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

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

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

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

       ; traceTc "reportUnsolved (after zonking and tidying):" $
Ben Gamari's avatar
Ben Gamari committed
197
         vcat [ pprTyVars free_tvs
198 199 200 201
              , ppr wanted ]

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

212 213
       ; tc_lvl <- getTcLevel
       ; reportWanteds err_ctxt tc_lvl wanted }
214

215 216 217
--------------------------------------------
--      Internal functions
--------------------------------------------
218

219 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 227 228 229 230
instance Outputable Report where   -- Debugging only
  ppr (Report { report_important = imp, report_relevant_bindings = rel })
    = vcat [ text "important:" <+> vcat imp
           , text "relevant:"  <+> vcat rel ]

231 232 233 234 235 236 237 238 239 240 241 242 243
{- 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.
-}

244 245 246 247 248
#if __GLASGOW_HASKELL__ > 710
instance Semigroup Report where
    Report a1 b1 <> Report a2 b2 = Report (a1 ++ a2) (b1 ++ b2)
#endif

249 250 251 252 253 254 255 256 257 258 259 260
instance Monoid Report where
    mempty = Report [] []
    mappend (Report a1 b1) (Report a2 b2) = Report (a1 ++ a2) (b1 ++ b2)

-- | Put a doc into the important msgs block.
important :: SDoc -> Report
important doc = mempty { report_important = [doc] }

-- | Put a doc into the relevant bindings block.
relevant_bindings :: SDoc -> Report
relevant_bindings doc = mempty { report_relevant_bindings = [doc] }

261 262 263 264 265
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

266 267 268 269 270
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

271 272 273 274 275 276 277 278 279 280
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"

281
data ReportErrCtxt
282
    = CEC { cec_encl :: [Implication]  -- Enclosing implications
283
                                       --   (innermost first)
284
                                       -- ic_skols and givens are tidied, rest are not
285
          , cec_tidy  :: TidyEnv
Simon Peyton Jones's avatar
Simon Peyton Jones committed
286

287 288 289
          , cec_binds :: EvBindsVar    -- Make some errors (depending on cec_defer)
                                       -- into warnings, and emit evidence bindings
                                       -- into 'cec_binds' for unsolved constraints
290

291 292 293 294
          , cec_errors_as_warns :: Bool   -- Turn all errors into warnings
                                          -- (except for Holes, which are
                                          -- controlled by cec_type_holes and
                                          -- cec_expr_holes)
295
          , cec_defer_type_errors :: TypeErrorChoice -- Defer type errors until runtime
296

297 298 299 300 301 302 303
          -- 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
304

305
          , cec_warn_redundant :: Bool    -- True <=> -Wredundant-constraints
306

307 308 309
          , cec_suppress :: Bool    -- True <=> More important errors have occurred,
                                    --          so create bindings if need be, but
                                    --          don't issue any more errors/warnings
310
                                    -- See Note [Suppressing error messages]
311 312
      }

Austin Seipp's avatar
Austin Seipp committed
313
{-
314 315
Note [Suppressing error messages]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
316
The cec_suppress flag says "don't report any errors".  Instead, just create
317
evidence bindings (as usual).  It's used when more important errors have occurred.
318

319 320 321
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.
322
  * If there are any insolubles (eg Int~Bool), here or in a nested implication,
323 324
    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
325
-}
326

327 328
reportImplic :: ReportErrCtxt -> Implication -> TcM ()
reportImplic ctxt implic@(Implic { ic_skols = tvs, ic_given = given
329
                                 , ic_wanted = wanted, ic_binds = evb
330
                                 , ic_status = status, ic_info = info
331
                                 , ic_env = tcl_env, ic_tclvl = tc_lvl })
332
  | BracketSkol <- info
333
  , not insoluble
334 335
  = 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
336 337
                     -- later when we plug it in, and meanwhile there may
                     -- certainly be un-satisfied constraints
338 339

  | otherwise
340
  = do { reportWanteds ctxt' tc_lvl wanted
341 342 343
       ; traceTc "reportImplic" (ppr implic)
       ; when (cec_warn_redundant ctxt) $
         warnRedundantConstraints ctxt' tcl_env info' dead_givens }
344
  where
345
    insoluble    = isInsolubleStatus status
346
    (env1, tvs') = mapAccumL tidyTyCoVarBndr (cec_tidy ctxt) tvs
Simon Peyton Jones's avatar
Simon Peyton Jones committed
347
    info'        = tidySkolemInfo env1 info
348
    implic' = implic { ic_skols = tvs'
Simon Peyton Jones's avatar
Simon Peyton Jones committed
349
                     , ic_given = map (tidyEvVar env1) given
350
                     , ic_info  = info' }
Simon Peyton Jones's avatar
Simon Peyton Jones committed
351
    ctxt' = ctxt { cec_tidy     = env1
352
                 , cec_encl     = implic' : cec_encl ctxt
353 354 355 356 357 358 359

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

360
                 , cec_binds    = evb }
361

362 363 364 365 366
    dead_givens = case status of
                    IC_Solved { ics_dead = dead } -> dead
                    _                             -> []

warnRedundantConstraints :: ReportErrCtxt -> TcLclEnv -> SkolemInfo -> [EvVar] -> TcM ()
367
-- See Note [Tracking redundant constraints] in TcSimplify
368
warnRedundantConstraints ctxt env info ev_vars
369
 | null redundant_evs
370 371 372 373 374
 = return ()

 | SigSkol {} <- info
 = setLclEnv env $  -- We want to add "In the type signature for f"
                    -- to the error context, which is a bit tiresome
375
   addErrCtxt (text "In" <+> ppr info) $
376
   do { env <- getLclEnv
377
      ; msg <- mkErrorReport ctxt env (important doc)
378
      ; reportWarning (Reason Opt_WarnRedundantConstraints) msg }
379 380 381 382

 | 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
383
 = do { msg <- mkErrorReport ctxt env (important doc)
384
      ; reportWarning (Reason Opt_WarnRedundantConstraints) msg }
385
 where
386
   doc = text "Redundant constraint" <> plural redundant_evs <> colon
387 388 389 390 391 392 393
         <+> 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 $
394
                      transSuperClasses (idType ev_var)
395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411

{- Note [Redundant constraints in instance decls]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
For instance declarations, we don't report unused givens if
they can give rise to improvement.  Example (Trac #10100):
    class Add a b ab | a b -> ab, a ab -> b
    instance Add Zero b b
    instance Add a b ab => Add (Succ a) b (Succ ab)
The context (Add a b ab) for the instance is clearly unused in terms
of evidence, since the dictionary has no feilds.  But it is still
needed!  With the context, a wanted constraint
   Add (Succ Zero) beta (Succ Zero)
we will reduce to (Add Zero beta Zero), and thence we get beta := Zero.
But without the context we won't find beta := Zero.

This only matters in instance declarations..
-}
412

413 414
reportWanteds :: ReportErrCtxt -> TcLevel -> WantedConstraints -> TcM ()
reportWanteds ctxt tc_lvl (WC { wc_simple = simples, wc_insol = insols, wc_impl = implics })
415 416
  = do { traceTc "reportWanteds" (vcat [ text "Simples =" <+> ppr simples
                                       , text "Suppress =" <+> ppr (cec_suppress ctxt)])
417
       ; let tidy_cts = bagToList (mapBag (tidyCt env) (insols `unionBags` simples))
418 419 420 421

         -- First deal with things that are utterly wrong
         -- Like Int ~ Bool (incl nullary TyCons)
         -- or  Int ~ t a   (AppTy on one side)
422 423 424 425 426 427 428 429 430
         -- These ones are not suppressed by the incoming context
       ; let ctxt_for_insols = ctxt { cec_suppress = False }
       ; (ctxt1, cts1) <- tryReporters ctxt_for_insols report1 tidy_cts

         -- Now all the other constraints.  We suppress errors here if
         -- any of the first batch failed, or if the enclosing context
         -- says to suppress
       ; let ctxt2 = ctxt { cec_suppress = cec_suppress ctxt || cec_suppress ctxt1 }
       ; (_, leftovers) <- tryReporters ctxt2 report2 cts1
431 432
       ; MASSERT2( null leftovers, ppr leftovers )

433
            -- All the Derived ones have been filtered out of simples
434 435 436
            -- 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]
437

438
     ; mapBagM_ (reportImplic ctxt2) implics }
439
            -- NB ctxt1: don't suppress inner insolubles if there's only a
440
            -- wanted insoluble here; but do suppress inner insolubles
441
            -- if there's a *given* insoluble here (= inaccessible code)
442
 where
443
    env = cec_tidy ctxt
444

445 446 447 448 449 450
    -- 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
451 452
    report1 = [ ("custom_error", is_user_type_error,
                                                  True, mkUserTypeErrorReporter)
453
              , ("insoluble1",   is_given_eq,     True, mkGivenErrorReporter)
454
              , ("insoluble2",   utterly_wrong,   True, mkGroupReporter mkEqErr)
455 456 457
              , ("skolem eq1",   very_wrong,      True, mkSkolReporter)
              , ("skolem eq2",   skolem_eq,       True, mkSkolReporter)
              , ("non-tv eq",    non_tv_eq,       True, mkSkolReporter)
458
              , ("Out of scope", is_out_of_scope, True, mkHoleReporter)
459 460 461 462 463 464 465 466 467 468 469
              , ("Holes",        is_hole,         False, mkHoleReporter)

                  -- The only remaining equalities are alpha ~ ty,
                  -- where alpha is untouchable; and representational equalities
              , ("Other eqs",    is_equality,     False, mkGroupReporter mkEqErr) ]

    -- report2: we suppress these if there are insolubles elsewhere in the tree
    report2 = [ ("Implicit params", is_ip,           False, mkGroupReporter mkIPErr)
              , ("Irreds",          is_irred,        False, mkGroupReporter mkIrredErr)
              , ("Dicts",           is_dict,         False, mkGroupReporter mkDictErr) ]

470 471
    -- rigid_nom_eq, rigid_nom_tv_eq,
    is_hole, is_dict,
472
      is_equality, is_ip, is_irred :: Ct -> PredTree -> Bool
473

474 475 476 477 478
    is_given_eq ct pred
       | EqPred {} <- pred = arisesFromGivens ct
       | otherwise         = False
       -- I think all given residuals are equalities

479 480 481 482 483 484 485
    -- 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
486

487
    -- Things like (a ~N b) or (a  ~N  F Bool)
488
    skolem_eq _ (EqPred NomEq ty1 _) = isSkolemTy tc_lvl ty1
489
    skolem_eq _ _                    = False
490

491 492 493 494 495 496 497 498 499 500 501 502 503 504
    -- Things like (F a  ~N  Int)
    non_tv_eq _ (EqPred NomEq ty1 _) = not (isTyVarTy ty1)
    non_tv_eq _ _                    = False

--    rigid_nom_eq _ pred = isRigidEqPred tc_lvl pred
--
--    rigid_nom_tv_eq _ pred
--      | EqPred _ ty1 _ <- pred = isRigidEqPred tc_lvl pred && isTyVarTy ty1
--      | otherwise              = False

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

    is_user_type_error ct _ = isUserTypeErrorCt ct
505

506 507 508
    is_equality _ (EqPred {}) = True
    is_equality _ _           = False

509 510 511 512 513 514 515 516 517 518
    is_dict _ (ClassPred {}) = True
    is_dict _ _              = False

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

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


519
---------------
520
isSkolemTy :: TcLevel -> Type -> Bool
521
-- The type is a skolem tyvar
522
isSkolemTy tc_lvl ty
523 524 525 526 527 528 529 530
  | 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
531

532 533
isTyFun_maybe :: Type -> Maybe TyCon
isTyFun_maybe ty = case tcSplitTyConApp_maybe ty of
534
                      Just (tc,_) | isTypeFamilyTyCon tc -> Just tc
535 536
                      _ -> Nothing

537
--------------------------------------------
538
--      Reporters
539 540
--------------------------------------------

541 542 543 544 545 546 547 548 549
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
550
-- Suppress duplicates with either the same LHS, or same location
551
mkSkolReporter ctxt cts
552
  = mapM_ (reportGroup mkEqErr ctxt) (group cts)
553
  where
554 555 556 557 558 559
     group [] = []
     group (ct:cts) = (ct : yeses) : group noes
        where
          (yeses, noes) = partition (group_with ct) cts

     group_with ct1 ct2
560 561 562
       | EQ <- cmp_loc ct1 ct2 = True
       | eq_lhs_type   ct1 ct2 = True
       | otherwise             = False
563

564
mkHoleReporter :: Reporter
565
-- Reports errors one at a time
566
mkHoleReporter ctxt
567 568 569
  = mapM_ $ \ct -> do { err <- mkHoleError ctxt ct
                      ; maybeReportHoleError ctxt ct err
                      ; maybeAddDeferredHoleBinding ctxt err ct }
570

571 572
mkUserTypeErrorReporter :: Reporter
mkUserTypeErrorReporter ctxt
573 574
  = mapM_ $ \ct -> do { err <- mkUserTypeError ctxt ct
                      ; maybeReportError ctxt err }
575 576 577

mkUserTypeError :: ReportErrCtxt -> Ct -> TcM ErrMsg
mkUserTypeError ctxt ct = mkErrorMsgFromCt ctxt ct
578
                        $ important
579 580
                        $ pprUserTypeErrorTy
                        $ case getUserTypeErrorMsg ct of
581 582
                            Just msg -> msg
                            Nothing  -> pprPanic "mkUserTypeError" (ppr ct)
583 584


585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623
mkGivenErrorReporter :: Reporter
-- See Note [Given errors]
mkGivenErrorReporter ctxt cts
  | Just implic <- find_gadt_match (cec_encl ctxt)
  = 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

       ; traceTc "mkGivenErrorRporter" (ppr ct)
       ; maybeReportError ctxt err }

  | otherwise   -- Discard Given errors that don't come from
                -- a pattern match; maybe we should warn instead?
  = do { traceTc "mkGivenErrorRporter no" (ppr ct $$ ppr (cec_encl ctxt))
       ; return () }
  where
    (ct : _ )  = cts    -- Never empty
    (ty1, ty2) = getEqPredTys (ctPred ct)

    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

{- Note [Given errors]
~~~~~~~~~~~~~~~~~~~~~~
Gabor Greif's avatar
Gabor Greif committed
624
Given constraints represent things for which we have (or will have)
625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655
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.
-}

656 657 658
mkGroupReporter :: (ReportErrCtxt -> [Ct] -> TcM ErrMsg)
                             -- Make error message for a group
                -> Reporter  -- Deal with lots of constraints
659 660 661 662
-- 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)
663

664 665
eq_lhs_type :: Ct -> Ct -> Bool
eq_lhs_type ct1 ct2
666 667
  = case (classifyPredType (ctPred ct1), classifyPredType (ctPred ct2)) of
       (EqPred eq_rel1 ty1 _, EqPred eq_rel2 ty2 _) ->
668
         (eq_rel1 == eq_rel2) && (ty1 `eqType` ty2)
669 670 671 672
       _ -> pprPanic "mkSkolReporter" (ppr ct1 $$ ppr ct2)

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

674 675
reportGroup :: (ReportErrCtxt -> [Ct] -> TcM ErrMsg) -> ReportErrCtxt
            -> [Ct] -> TcM ()
quchen's avatar
quchen committed
676 677 678
reportGroup mk_err ctxt cts =
  case partition isMonadFailInstanceMissing cts of
        -- Only warn about missing MonadFail constraint when
Gabor Greif's avatar
Gabor Greif committed
679
        -- there are no other missing constraints!
680 681 682
        (monadFailCts, []) ->
            do { err <- mk_err ctxt monadFailCts
               ; reportWarning (Reason Opt_WarnMissingMonadFailInstances) err }
quchen's avatar
quchen committed
683 684 685

        (_, cts') -> do { err <- mk_err ctxt cts'
                        ; maybeReportError ctxt err
686 687 688 689 690 691 692
                            -- 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
693 694 695 696 697
  where
    isMonadFailInstanceMissing ct =
        case ctLocOrigin (ctLoc ct) of
            FailablePattern _pat -> True
            _otherwise           -> False
698

699 700
maybeReportHoleError :: ReportErrCtxt -> Ct -> ErrMsg -> TcM ()
maybeReportHoleError ctxt ct err
thomasw's avatar
thomasw committed
701
  -- When -XPartialTypeSignatures is on, warnings (instead of errors) are
702 703 704
  -- generated for holes in partial type signatures.
  -- Unless -fwarn_partial_type_signatures is not on,
  -- in which case the messages are discarded.
705 706 707 708 709
  | 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
710
       HoleWarn  -> reportWarning (Reason Opt_WarnPartialTypeSignatures) err
711 712
       HoleDefer -> return ()

713 714 715 716
  -- 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
717
  | isOutOfScopeCt ct
718 719 720 721 722 723
  = -- 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 ()
724 725 726

  -- Otherwise this is a typed hole in an expression,
  -- but not for an out-of-scope variable
727
  | otherwise
728
  = -- If deferring, report a warning only if -Wtyped-holes is on
729 730
    case cec_expr_holes ctxt of
       HoleError -> reportError err
731
       HoleWarn  -> reportWarning (Reason Opt_WarnTypedHoles) err
732
       HoleDefer -> return ()
733

734
maybeReportError :: ReportErrCtxt -> ErrMsg -> TcM ()
735
-- Report the error and/or make a deferred binding for it
736
maybeReportError ctxt err
737 738 739
  | cec_suppress ctxt    -- Some worse error has occurred;
  = return ()            -- so suppress this error/warning

740
  | cec_errors_as_warns ctxt
741
  = reportWarning NoReason err
742

743
  | otherwise
744
  = case cec_defer_type_errors ctxt of
745
      TypeDefer -> return ()
746
      TypeWarn  -> reportWarning (Reason Opt_WarnDeferredTypeErrors) err
747
      TypeError -> reportError err
748

749
addDeferredBinding :: ReportErrCtxt -> ErrMsg -> Ct -> TcM ()
750
-- See Note [Deferring coercion errors to runtime]
751
addDeferredBinding ctxt err ct
752
  | CtWanted { ctev_pred = pred, ctev_dest = dest } <- ctEvidence ct
753 754 755 756 757
    -- 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)"
758
             err_tm  = EvDelayedError pred err_fs
759
             ev_binds_var = cec_binds ctxt
760

761 762 763 764 765 766 767 768
       ; 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) }}
769 770

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

773 774
maybeAddDeferredHoleBinding :: ReportErrCtxt -> ErrMsg -> Ct -> TcM ()
maybeAddDeferredHoleBinding ctxt err ct
775 776 777 778
  | isExprHoleCt ct
  = addDeferredBinding ctxt err ct  -- Only add bindings for holes in expressions
  | otherwise                       -- not for holes in partial type signatures
  = return ()
779

780
tryReporters :: ReportErrCtxt -> [ReporterSpec] -> [Ct] -> TcM (ReportErrCtxt, [Ct])
781
-- Use the first reporter in the list whose predicate says True
782
tryReporters ctxt reporters cts
783
  = do { traceTc "tryReporters {" (ppr cts)
784 785 786
       ; (ctxt', cts') <- go ctxt reporters cts
       ; traceTc "tryReporters }" (ppr cts')
       ; return (ctxt', cts') }
787
  where
788
    go ctxt [] cts
789 790 791 792 793 794 795 796 797 798 799 800
      = 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)
801
  | otherwise  = do { traceTc "tryReporter{ " (text str <+> ppr yeses)
802 803
                    ; reporter ctxt yeses
                    ; let ctxt' = ctxt { cec_suppress = suppress_after || cec_suppress ctxt }
804
                    ; traceTc "tryReporter end }" (text str <+> ppr (cec_suppress ctxt) <+> ppr suppress_after)
805 806 807
                    ; return (ctxt', nos) }
  where
    (yeses, nos) = partition (\ct -> keep_me ct (classifyPredType (ctPred ct))) cts
808

809 810 811 812 813 814 815 816 817

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

818
-- Add the "arising from..." part to a message about bunch of dicts
819
addArising :: CtOrigin -> SDoc -> SDoc
820
addArising orig msg = hang msg 2 (pprArising orig)
821

822
pprWithArising :: [Ct] -> (CtLoc, SDoc)
823 824
-- Print something like
--    (Eq a) arising from a use of x at y
825 826
--    (Show a) arising from a use of p at q
-- Also return a location for the error message
827
-- Works for Wanted/Derived only
828
pprWithArising []
829
  = panic "pprWithArising"
830 831
pprWithArising (ct:cts)
  | null cts
832
  = (loc, addArising (ctLocOrigin loc)
dimitris's avatar
dimitris committed
833
                     (pprTheta [ctPred ct]))
834 835
  | otherwise
  = (loc, vcat (map ppr_one (ct:cts)))
836
  where
837
    loc = ctLoc ct
838
    ppr_one ct' = hang (parens (pprType (ctPred ct')))
839
                     2 (pprCtLoc (ctLoc ct'))
840

841 842 843
mkErrorMsgFromCt :: ReportErrCtxt -> Ct -> Report -> TcM ErrMsg
mkErrorMsgFromCt ctxt ct report
  = mkErrorReport ctxt (ctLocEnv (ctLoc ct)) report
844

845 846 847 848 849 850
mkErrorReport :: ReportErrCtxt -> TcLclEnv -> Report -> TcM ErrMsg
mkErrorReport ctxt tcl_env (Report important relevant_bindings)
  = do { context <- mkErrInfo (cec_tidy ctxt) (tcl_ctxt tcl_env)
       ; mkErrDocAt (RealSrcSpan (tcl_loc tcl_env))
            (errDoc important [context] relevant_bindings)
       }
851

852
type UserGiven = Implication
853 854

getUserGivens :: ReportErrCtxt -> [UserGiven]
855
-- One item for each enclosing implication
856 857 858 859
getUserGivens (CEC {cec_encl = implics}) = getUserGivensFromImplics implics

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

Austin Seipp's avatar
Austin Seipp committed
862
{-
863 864 865 866 867 868
Note [Always warn with -fdefer-type-errors]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
When -fdefer-type-errors is on we warn about *all* type errors, even
if cec_suppress is on.  This can lead to a lot more warnings than you
would get errors without -fdefer-type-errors, but if we suppress any of
them you might get a runtime error that wasn't warned about at compile
869
time.
870 871 872 873 874

This is an easy design choice to change; just flip the order of the
first two equations for maybeReportError

To be consistent, we should also report multiple warnings from a single
875
location in mkGroupReporter, when -fdefer-type-errors is on.  But that
876 877
is perhaps a bit *over*-consistent! Again, an easy choice to change.

878 879
With #10283, you can now opt out of deferred type error warnings.

880 881 882 883 884 885 886 887 888
Note [Deferred errors for coercion holes]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Suppose we need to defer a type error where the destination for the evidence
is a coercion hole. We can't just put the error in the hole, because we can't
make an erroneous coercion. (Remember that coercions are erased for runtime.)
Instead, we invent a new EvVar, bind it to an error and then make a coercion
from that EvVar, filling the hole with that coercion. Because coercions'
types are unlifted, the error is guaranteed to be hit before we get to the
coercion.
889

890 891
Note [Do not report derived but soluble errors]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
892
The wc_simples include Derived constraints that have not been solved, but are
893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910
not insoluble (in that case they'd be in wc_insols).  We do not want to report
these as errors:

* Superclass constraints. If we have an unsolved [W] Ord a, we'll also have
  an unsolved [D] Eq a, and we do not want to report that; it's just noise.

* Functional dependencies.  For givens, consider
      class C a b | a -> b
      data T a where
         MkT :: C a d => [d] -> T a
      f :: C a b => T a -> F Int
      f (MkT xs) = length xs
  Then we get a [D] b~d.  But there *is* a legitimate call to
  f, namely   f (MkT [True]) :: T Bool, in which b=d.  So we should
  not reject the program.

  For wanteds, something similar
      data T a where
911
        MkT :: C Int b => a -> b -> T a
912 913 914 915 916 917
      g :: C Int c => c -> ()
      f :: T a -> ()
      f (MkT x y) = g x
  Here we get [G] C Int b, [W] C Int a, hence [D] a~b.
  But again f (MkT True True) is a legitimate call.

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

921
For functional dependencies, here is a real example,
922 923 924
stripped off from libraries/utf8-string/Codec/Binary/UTF8/Generic.hs

  class C a b | a -> b
925 926 927 928
  g :: C a b => a -> b -> ()
  f :: C a b => a -> b -> ()
  f xa xb =
      let loop = g xa
929 930 931 932
      in loop xb

We will first try to infer a type for loop, and we will succeed:
    C a b' => b' -> ()
933