TcErrors.lhs 50.5 KB
Newer Older
1
\begin{code}
2
{-# LANGUAGE ScopedTypeVariables #-}
Ian Lynagh's avatar
Ian Lynagh committed
3 4 5 6 7 8 9
{-# OPTIONS -fno-warn-tabs #-}
-- The above warning supression flag is a temporary kludge.
-- While working on this module you are encouraged to remove it and
-- detab the module (please do the detabbing in a separate patch). See
--     http://hackage.haskell.org/trac/ghc/wiki/Commentary/CodingStyle#TabsvsSpaces
-- for details

10
module TcErrors( 
11
       reportUnsolved, reportAllUnsolved,
12
       warnDefaulting,
13 14

       solverDepthErrorTcS
15 16 17 18
  ) where

#include "HsVersions.h"

19
import TcCanonical( occurCheckExpand )
20
import TcRnTypes
21 22 23
import TcRnMonad
import TcMType
import TcType
24
import TypeRep
batterseapower's avatar
batterseapower committed
25
import Type
26
import Kind ( isKind )
27
import Unify            ( tcMatchTys )
28 29 30
import Inst
import InstEnv
import TyCon
31
import TcEvidence
32
import Name
33
import Id 
34 35 36 37
import Var
import VarSet
import VarEnv
import Bag
38 39
import Maybes
import ErrUtils         ( ErrMsg, makeIntoWarning, pprLocErrMsg )
40
import BasicTypes 
41 42 43
import Util
import FastString
import Outputable
44
import SrcLoc
45
import DynFlags
46
import Data.List        ( partition, mapAccumL )
47 48 49 50 51 52 53 54 55 56 57 58
\end{code}

%************************************************************************
%*									*
\section{Errors and contexts}
%*									*
%************************************************************************

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?

59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77
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
78

79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95
  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
and does not fail if -fwarn-type-errors is on, so that we can continue
compilation. The errors are turned into warnings in `reportUnsolved`.

96 97 98 99 100
Note [Suppressing error messages]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
If there are any insolubles, like (Int~Bool), then we suppress all less-drastic
errors (like (Eq a)).  Often the latter are a knock-on effect of the former.

101 102 103 104 105 106 107 108 109 110 111
\begin{code}
reportUnsolved :: WantedConstraints -> TcM (Bag EvBind)
reportUnsolved wanted
  = do { binds_var <- newTcEvBinds
       ; defer <- doptM Opt_DeferTypeErrors
       ; report_unsolved (Just binds_var) defer wanted
       ; getTcEvBinds binds_var }

reportAllUnsolved :: WantedConstraints -> TcM ()
-- Report all unsolved goals, even if -fdefer-type-errors is on
-- See Note [Deferring coercion errors to runtime]
Simon Peyton Jones's avatar
Simon Peyton Jones committed
112
reportAllUnsolved wanted = report_unsolved Nothing False wanted
113 114 115 116

report_unsolved :: Maybe EvBindsVar  -- cec_binds
                -> Bool              -- cec_defer
                -> WantedConstraints -> TcM ()
117 118 119
-- Important precondition:
-- WantedConstraints are fully zonked and unflattened, that is,
-- zonkWC has already been applied to these constraints.
120
report_unsolved mb_binds_var defer wanted
121
  | isEmptyWC wanted
122
  = return ()
123
  | otherwise
124
  = do { traceTc "reportUnsolved (before unflattening)" (ppr wanted)
125

126
       ; env0 <- tcInitTidyEnv
127 128 129
                 
            -- If we are deferring we are going to need /all/ evidence around,
            -- including the evidence produced by unflattening (zonkWC)
130
       ; let tidy_env = tidyFreeTyVars env0 free_tvs
131
             free_tvs = tyVarsOfWC wanted
132
             err_ctxt = CEC { cec_encl  = []
133
                            , cec_tidy  = tidy_env
134
                            , cec_defer    = defer
135
                            , cec_suppress = insolubleWC wanted
136
                                  -- See Note [Suppressing error messages]
137
                            , cec_binds    = mb_binds_var }
138

139 140 141
       ; traceTc "reportUnsolved (after unflattening):" $ 
         vcat [ pprTvBndrs (varSetElems free_tvs)
              , ppr wanted ]
142

143
       ; reportWanteds err_ctxt wanted }
144

145 146 147
--------------------------------------------
--      Internal functions
--------------------------------------------
148 149 150 151

data ReportErrCtxt 
    = CEC { cec_encl :: [Implication]  -- Enclosing implications
                	       	       --   (innermost first)
152
                                       -- ic_skols and givens are tidied, rest are not
153
          , cec_tidy  :: TidyEnv
154 155 156 157 158
          , cec_binds :: Maybe EvBindsVar 
                         -- Nothinng <=> Report all errors, including holes; no bindings
                         -- Just ev  <=> make some errors (depending on cec_defer)
                         --              into warnings, and emit evidence bindings
                         --              into 'ev' for unsolved constraints
159

160 161
          , cec_defer :: Bool       -- True <=> -fdefer-type-errors
                                    -- Irrelevant if cec_binds = Nothing
162 163 164
          , cec_suppress :: Bool    -- True <=> More important errors have occurred,
                                    --          so create bindings if need be, but
                                    --          don't issue any more errors/warnings
165 166
      }

167 168 169
reportImplic :: ReportErrCtxt -> Implication -> TcM ()
reportImplic ctxt implic@(Implic { ic_skols = tvs, ic_given = given
                                 , ic_wanted = wanted, ic_binds = evb
Simon Peyton Jones's avatar
Simon Peyton Jones committed
170
                                 , ic_insol = ic_insoluble, ic_info = info })
171
  | BracketSkol <- info
Simon Peyton Jones's avatar
Simon Peyton Jones committed
172 173 174 175
  , not ic_insoluble -- For Template Haskell brackets report only
  = return ()        -- definite errors. The whole thing will be re-checked
                     -- later when we plug it in, and meanwhile there may
                     -- certainly be un-satisfied constraints
176 177

  | otherwise
178
  = reportWanteds ctxt' wanted
179
  where
180
    (env1, tvs') = mapAccumL tidyTyVarBndr (cec_tidy ctxt) tvs
181
    (env2, info') = tidySkolemInfo env1 info
182
    implic' = implic { ic_skols = tvs'
183 184 185
                     , ic_given = map (tidyEvVar env2) given
                     , ic_info  = info' }
    ctxt' = ctxt { cec_tidy  = env2
186
                 , cec_encl  = implic' : cec_encl ctxt
187
                 , cec_binds = case cec_binds ctxt of
188 189 190 191 192
                                 Nothing -> Nothing
                                 Just {} -> Just evb }

reportWanteds :: ReportErrCtxt -> WantedConstraints -> TcM ()
reportWanteds ctxt (WC { wc_flat = flats, wc_insol = insols, wc_impl = implics })
193 194
  = do { reportFlats (ctxt { cec_suppress = False }) (mapBag (tidyCt env) insols)
       ; reportFlats ctxt                            (mapBag (tidyCt env) flats)
195 196 197 198
            -- All the Derived ones have been filtered out of flats 
            -- 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]
199
       ; mapBagM_ (reportImplic ctxt) implics }
200
  where
201 202
    env = cec_tidy ctxt

203 204
reportFlats :: ReportErrCtxt -> Cts -> TcM ()
reportFlats ctxt flats    -- Here 'flats' includes insolble goals
Simon Peyton Jones's avatar
Simon Peyton Jones committed
205 206
  = traceTc "reportFlats" (ppr flats) >>
    tryReporters 
207 208 209
      [ -- First deal with things that are utterly wrong
        -- Like Int ~ Bool (incl nullary TyCons)
        -- or  Int ~ t a   (AppTy on one side)
210 211
        ("Utterly wrong",  utterly_wrong,   mkGroupReporter mkEqErr)
      , ("Holes",          is_hole,         mkUniReporter mkHoleError)
212 213 214 215

        -- Report equalities of form (a~ty).  They are usually
        -- skolem-equalities, and they cause confusing knock-on 
        -- effects in other errors; see test T4093b.
Simon Peyton Jones's avatar
Simon Peyton Jones committed
216 217
      , ("Skolem equalities",    skolem_eq,   mkUniReporter mkEqErr1) ]
      reportFlatErrs
218
      ctxt (bagToList flats)
219
  where
Simon Peyton Jones's avatar
Simon Peyton Jones committed
220
    utterly_wrong, skolem_eq :: Ct -> PredTree -> Bool
221 222 223
    utterly_wrong _ (EqPred ty1 ty2) = isRigid ty1 && isRigid ty2 
    utterly_wrong _ _ = False

224 225
    is_hole ct _ = isHoleCt ct

226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246
    skolem_eq _ (EqPred ty1 ty2) = isRigidOrSkol ty1 && isRigidOrSkol ty2 
    skolem_eq _ _ = False

---------------
isRigid, isRigidOrSkol :: Type -> Bool
isRigid ty 
  | Just (tc,_) <- tcSplitTyConApp_maybe ty = isDecomposableTyCon tc
  | Just {} <- tcSplitAppTy_maybe ty        = True
  | isForAllTy ty                           = True
  | otherwise                               = False

isRigidOrSkol ty 
  | Just tv <- getTyVar_maybe ty = isSkolemTyVar tv
  | otherwise                    = isRigid ty

isTyFun_maybe :: Type -> Maybe TyCon
isTyFun_maybe ty = case tcSplitTyConApp_maybe ty of
                      Just (tc,_) | isSynFamilyTyCon tc -> Just tc
                      _ -> Nothing

-----------------
247
reportFlatErrs :: Reporter
248 249 250 251
-- Called once for non-ambigs, once for ambigs
-- Report equality errors, and others only if we've done all 
-- the equalities.  The equality errors are more basic, and
-- can lead to knock on type-class errors
252
reportFlatErrs
253
  = tryReporters
254
      [ ("Equalities", is_equality, mkGroupReporter mkEqErr) ]
255 256 257 258
      (\ctxt cts -> do { let (dicts, ips, irreds) = go cts [] [] []
                       ; mkGroupReporter mkIPErr    ctxt ips   
                       ; mkGroupReporter mkIrredErr ctxt irreds
                       ; mkGroupReporter mkDictErr  ctxt dicts })
259
  where
260 261 262 263 264 265
    is_equality _ (EqPred {}) = True
    is_equality _ _           = False

    go [] dicts ips irreds
      = (dicts, ips, irreds)
    go (ct:cts) dicts ips irreds
Simon Peyton Jones's avatar
Simon Peyton Jones committed
266 267
      | isIPPred (ctPred ct) 
      = go cts dicts (ct:ips) irreds
268
      | otherwise
269 270 271
      = case classifyPredType (ctPred ct) of
          ClassPred {}  -> go cts (ct:dicts) ips irreds
          IrredPred {}  -> go cts dicts ips (ct:irreds)
272
          _             -> panic "reportFlatErrs"
batterseapower's avatar
batterseapower committed
273 274
    -- TuplePreds should have been expanded away by the constraint
    -- simplifier, so they shouldn't show up at this point
275 276
    -- And EqPreds are dealt with by the is_equality test

277 278

--------------------------------------------
279
--      Reporters
280 281
--------------------------------------------

282 283 284 285 286 287
type Reporter = ReportErrCtxt -> [Ct] -> TcM ()

mkUniReporter :: (ReportErrCtxt -> Ct -> TcM ErrMsg) -> Reporter
-- Reports errors one at a time
mkUniReporter mk_err ctxt 
  = mapM_ $ \ct -> 
288 289 290
    do { err <- mk_err ctxt ct
       ; maybeReportError ctxt err ct
       ; maybeAddDeferredBinding ctxt err ct }
291 292 293 294

mkGroupReporter :: (ReportErrCtxt -> [Ct] -> TcM ErrMsg)
                             -- Make error message for a group
                -> Reporter  -- Deal with lots of constraints
295
-- Group together insts from same location
296 297
-- We want to report them together in error messages

298
mkGroupReporter _ _ [] 
299
  = return ()
300
mkGroupReporter mk_err ctxt (ct1 : rest)
301 302 303 304
  = do { err <- mk_err ctxt cts
       ; maybeReportError ctxt err ct1
       ; mapM_ (maybeAddDeferredBinding ctxt err) (ct1:rest)
               -- Add deferred bindings for all
305
       ; mkGroupReporter mk_err ctxt others }
306
  where
307
   loc               = cc_loc ct1
308 309
   cts               = ct1 : friends
   (friends, others) = partition is_friend rest
310
   is_friend friend  = cc_loc friend `same_loc` loc
311

312
   same_loc :: CtLoc -> CtLoc -> Bool
313 314
   same_loc l1 l2 = ctLocSpan l1 == ctLocSpan l2

315 316
maybeReportError :: ReportErrCtxt -> ErrMsg -> Ct -> TcM ()
-- Report the error and/or make a deferred binding for it
317 318 319 320
maybeReportError ctxt err _ct
  | cec_defer ctxt  -- We have -fdefer-type-errors
                    -- so warn about all, even if cec_suppress is on
  = reportWarning (makeIntoWarning err)
321 322 323 324 325 326 327 328 329 330 331
  | cec_suppress ctxt
  = return ()
  | otherwise
  = reportError err

maybeAddDeferredBinding :: ReportErrCtxt -> ErrMsg -> Ct -> TcM ()
-- See Note [Deferring coercion errors to runtime]
maybeAddDeferredBinding ctxt err ct
  | CtWanted { ctev_pred = pred, ctev_evar = ev_id } <- cc_ev ct
    -- Only add deferred bindings for Wanted constraints
  , isHoleCt ct || cec_defer ctxt  -- And it's a hole or we have -fdefer-type-errors
332
  , Just ev_binds_var <- cec_binds ctxt  -- We have somewhere to put the bindings
333 334 335 336 337 338 339 340 341 342
  = do { dflags <- getDynFlags
       ; let err_msg = pprLocErrMsg err
             err_fs  = mkFastString $ showSDoc dflags $
                       err_msg $$ text "(deferred type error)"

         -- Create the binding
       ; addTcEvBind ev_binds_var ev_id (EvDelayedError pred err_fs) }

  | otherwise   -- Do not set any evidence for Given/Derived
  = return ()   
343 344 345 346 347 348

tryReporters :: [(String, Ct -> PredTree -> Bool, Reporter)] 
             -> Reporter -> Reporter
-- Use the first reporter in the list whose predicate says True
tryReporters reporters deflt ctxt cts
  = do { traceTc "tryReporters {" (ppr cts) 
349
       ; go ctxt reporters cts
350 351
       ; traceTc "tryReporters }" empty }
  where
352 353 354 355 356 357 358 359 360 361
    go ctxt [] cts = deflt ctxt cts 
    go ctxt ((str, pred, reporter) : rs) cts
      | null yeses  = do { traceTc "tryReporters: no" (text str)
                         ; go ctxt rs cts }
      | otherwise   = do { traceTc "tryReporters: yes" (text str <+> ppr yeses)
                         ; reporter ctxt yeses :: TcM ()
                         ; go (ctxt { cec_suppress = True }) rs nos }
                         -- Carry on with the rest, because we must make
                         -- deferred bindings for them if we have 
                         -- -fdefer-type-errors
Simon Peyton Jones's avatar
Simon Peyton Jones committed
362
                         -- But suppress their error messages
363
      where
364
       (yeses, nos) = partition keep_me cts
365
       keep_me ct = pred ct (classifyPredType (ctPred ct))
366 367

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

371
pprWithArising :: [Ct] -> (CtLoc, SDoc)
372 373
-- Print something like
--    (Eq a) arising from a use of x at y
374 375
--    (Show a) arising from a use of p at q
-- Also return a location for the error message
376
-- Works for Wanted/Derived only
377 378
pprWithArising [] 
  = panic "pprWithArising"
379 380
pprWithArising (ct:cts)
  | null cts
381
  = (loc, addArising (ctLocOrigin loc) 
dimitris's avatar
dimitris committed
382
                     (pprTheta [ctPred ct]))
383 384
  | otherwise
  = (loc, vcat (map ppr_one (ct:cts)))
385
  where
386
    loc = cc_loc ct
387
    ppr_one ct = hang (parens (pprType (ctPred ct))) 
388
                    2 (pprArisingAt (cc_loc ct))
389

390 391 392 393 394
mkErrorMsg :: ReportErrCtxt -> Ct -> SDoc -> TcM ErrMsg
mkErrorMsg ctxt ct msg 
  = do { let tcl_env = ctLocEnv (cc_loc ct)
       ; err_info <- mkErrInfo (cec_tidy ctxt) (tcl_ctxt tcl_env)
       ; mkLongErrAt (tcl_loc tcl_env) msg err_info }
395

396
type UserGiven = ([EvVar], SkolemInfo, SrcSpan)
397 398

getUserGivens :: ReportErrCtxt -> [UserGiven]
399
-- One item for each enclosing implication
400
getUserGivens (CEC {cec_encl = ctxt})
401
  = reverse $
402 403 404
    [ (givens, info, tcl_loc env) 
    | Implic {ic_given = givens, ic_env = env, ic_info = info } <- ctxt
    , not (null givens) ]
405 406
\end{code}

407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456
Note [Do not report derived but soluble errors]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The wc_flats include Derived constraints that have not been solved, but are
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
        MkT :: C Int b => a -> b -> T a 
      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.

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

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

  class C a b | a -> b
  g :: C a b => a -> b -> () 
  f :: C a b => a -> b -> () 
  f xa xb = 
      let loop = g xa 
      in loop xb

We will first try to infer a type for loop, and we will succeed:
    C a b' => b' -> ()
Subsequently, we will type check (loop xb) and all is good. But, 
recall that we have to solve a final implication constraint: 
    C a b => (C a b' => .... cts from body of loop .... )) 
And now we have a problem as we will generate an equality b ~ b' and fail to 
solve it. 


batterseapower's avatar
batterseapower committed
457 458 459 460 461 462 463
%************************************************************************
%*                  *
                Irreducible predicate errors
%*                  *
%************************************************************************

\begin{code}
464 465
mkIrredErr :: ReportErrCtxt -> [Ct] -> TcM ErrMsg
mkIrredErr ctxt cts 
466 467
  = do { (ctxt, binds_msg) <- relevantBindings ctxt ct1
       ; mkErrorMsg ctxt ct1 (msg $$ binds_msg) }
batterseapower's avatar
batterseapower committed
468
  where
469
    (ct1:_) = cts
470
    orig    = ctLocOrigin (cc_loc ct1)
471 472
    givens  = getUserGivens ctxt
    msg = couldNotDeduce givens (map ctPred cts, orig)
batterseapower's avatar
batterseapower committed
473

474
----------------
475 476
mkHoleError :: ReportErrCtxt -> Ct -> TcM ErrMsg
mkHoleError ctxt ct@(CHoleCan {})
477 478 479
  = do { let tyvars = varSetElems (tyVarsOfCt ct)
             tyvars_msg = map loc_msg tyvars
             msg = (text "Found hole" <+> quotes (text "_") 
480
                    <+> text "with type") <+> pprType (ctEvPred (cc_ev ct))
481
                   $$ (if null tyvars_msg then empty else text "Where:" <+> vcat tyvars_msg)
482 483
       ; (ctxt, binds_doc) <- relevantBindings ctxt ct
       ; mkErrorMsg ctxt ct (msg $$ binds_doc) }
484
  where
485 486 487
    loc_msg tv 
       = case tcTyVarDetails tv of
          SkolemTv {} -> quotes (ppr tv) <+> skol_msg
488
          MetaTv {}   -> quotes (ppr tv) <+> text "is an ambiguous type variable"
489 490 491
          det -> pprTcTyVarDetails det
       where 
          skol_msg = pprSkol (getSkolemInfo (cec_encl ctxt) tv) (getSrcLoc tv)
492 493

mkHoleError _ ct = pprPanic "mkHoleError" (ppr ct)
494

495
----------------
496 497
mkIPErr :: ReportErrCtxt -> [Ct] -> TcM ErrMsg
mkIPErr ctxt cts
498 499 500
  = do { (ctxt, _, ambig_err) <- mkAmbigMsg ctxt cts
       ; (ctxt, bind_msg) <- relevantBindings ctxt ct1
       ; mkErrorMsg ctxt ct1 (msg $$ ambig_err $$ bind_msg) }
501
  where
502
    (ct1:_) = cts
503
    orig    = ctLocOrigin (cc_loc ct1)
504 505
    preds   = map ctPred cts
    givens  = getUserGivens ctxt
506 507
    msg | null givens
        = addArising orig $
508 509
          sep [ ptext (sLit "Unbound implicit parameter") <> plural cts
              , nest 2 (pprTheta preds) ] 
510
        | otherwise
511
        = couldNotDeduce givens (preds, orig)
512 513 514 515 516 517 518 519 520
\end{code}


%************************************************************************
%*									*
                Equality errors
%*									*
%************************************************************************

521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538
Note [Inaccessible code]
~~~~~~~~~~~~~~~~~~~~~~~~
Consider
   data T a where
     T1 :: T a
     T2 :: T Bool

   f :: (a ~ Int) => T a -> Int
   f T1 = 3
   f T2 = 4   -- Unreachable code

Here the second equation is unreachable. The original constraint
(a~Int) from the signature gets rewritten by the pattern-match to
(Bool~Int), so the danger is that we report the error as coming from
the *signature* (Trac #7293).  So, for Given errors we replace the
env (and hence src-loc) on its CtLoc with that from the immediately
enclosing implication.

539
\begin{code}
540 541 542 543 544 545 546 547 548
mkEqErr :: ReportErrCtxt -> [Ct] -> TcM ErrMsg
-- Don't have multiple equality errors from the same location
-- E.g.   (Int,Bool) ~ (Bool,Int)   one error will do!
mkEqErr ctxt (ct:_) = mkEqErr1 ctxt ct
mkEqErr _ [] = panic "mkEqErr"

mkEqErr1 :: ReportErrCtxt -> Ct -> TcM ErrMsg
-- Wanted constraints only!
mkEqErr1 ctxt ct
549
  | isGiven ev
550
  = do { (ctxt, binds_msg) <- relevantBindings ctxt ct
551 552 553 554 555 556 557 558 559 560 561
       ; let (given_loc, given_msg) = mk_given (cec_encl ctxt)
       ; mkEqErr_help ctxt (given_msg $$ binds_msg) 
                      (ct { cc_loc = given_loc}) -- Note [Inaccessible code]
                      Nothing ty1 ty2 }

  | otherwise   -- Wanted or derived
  = do { (ctxt, binds_msg) <- relevantBindings ctxt ct
       ; (ctxt, tidy_orig) <- zonkTidyOrigin ctxt (ctLocOrigin (cc_loc ct))
       ; let (is_oriented, wanted_msg) = mk_wanted_extra tidy_orig
       ; mkEqErr_help ctxt (wanted_msg $$ binds_msg) 
                      ct is_oriented ty1 ty2 }
562
  where
563
    ev         = cc_ev ct
564 565 566 567 568 569 570 571 572
    (ty1, ty2) = getEqPredTys (ctEvPred ev)

    mk_given :: [Implication] -> (CtLoc, SDoc)
    -- For given constraints we overwrite the env (and hence src-loc)
    -- with one from the implication.  See Note [Inaccessible code]
    mk_given []           = (cc_loc ct, empty)
    mk_given (implic : _) = (setCtLocEnv (cc_loc ct) (ic_env implic)
                            , hang (ptext (sLit "Inaccessible code in"))
                                 2 (ppr (ic_info implic)))
573

574 575
       -- If the types in the error message are the same as the types
       -- we are unifying, don't add the extra expected/actual message
576 577 578 579 580 581
    mk_wanted_extra orig@(TypeEqOrigin {})
      = mkExpectedActualMsg ty1 ty2 orig


    mk_wanted_extra (KindEqOrigin cty1 cty2 sub_o)
      = (Nothing, msg1 $$ msg2)
582
      where
583 584 585 586 587 588 589 590
        msg1 = hang (ptext (sLit "When matching types"))
                  2 (vcat [ ppr cty1 <+> dcolon <+> ppr (typeKind cty1)
                          , ppr cty2 <+> dcolon <+> ppr (typeKind cty2) ])
        msg2 = case sub_o of
                 TypeEqOrigin {} -> snd (mkExpectedActualMsg cty1 cty2 sub_o)
                 _ -> empty

    mk_wanted_extra _ = (Nothing, empty)
591

592
mkEqErr_help, reportEqErr 
593
   :: ReportErrCtxt -> SDoc
594
   -> Ct
595
   -> Maybe SwapFlag   -- Nothing <=> not sure
596
   -> TcType -> TcType -> TcM ErrMsg
597 598 599 600
mkEqErr_help ctxt extra ct oriented ty1 ty2
  | Just tv1 <- tcGetTyVar_maybe ty1 = mkTyVarEqErr ctxt extra ct oriented tv1 ty2
  | Just tv2 <- tcGetTyVar_maybe ty2 = mkTyVarEqErr ctxt extra ct oriented tv2 ty1
  | otherwise                        = reportEqErr  ctxt extra ct oriented ty1 ty2
601

602 603 604 605
reportEqErr ctxt extra1 ct oriented ty1 ty2
  = do { (ctxt', extra2) <- mkEqInfoMsg ctxt ct ty1 ty2
       ; mkErrorMsg ctxt' ct (vcat [ misMatchOrCND ctxt' ct oriented ty1 ty2
                                   , extra2, extra1]) }
606

607
mkTyVarEqErr :: ReportErrCtxt -> SDoc -> Ct -> Maybe SwapFlag -> TcTyVar -> TcType -> TcM ErrMsg
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
608
-- tv1 and ty2 are already tidied
609
mkTyVarEqErr ctxt extra ct oriented tv1 ty2
610
  -- Occurs check
Simon Peyton Jones's avatar
Simon Peyton Jones committed
611 612
  |  isUserSkolem ctxt tv1   -- ty2 won't be a meta-tyvar, or else the thing would
     		   	     -- be oriented the other way round; see TcCanonical.reOrient
613
  || isSigTyVar tv1 && not (isTyVarTy ty2)
614 615 616
  = mkErrorMsg ctxt ct (vcat [ misMatchOrCND ctxt ct oriented ty1 ty2
                             , extraTyVarInfo ctxt ty1 ty2
                             , extra ])
617 618 619

  -- So tv is a meta tyvar, and presumably it is
  -- an *untouchable* meta tyvar, else it'd have been unified
620
  | not (k2 `tcIsSubKind` k1)   	 -- Kind error
621
  = mkErrorMsg ctxt ct $ (kindErrorMsg (mkTyVarTy tv1) ty2 $$ extra)
622

Simon Peyton Jones's avatar
Simon Peyton Jones committed
623 624 625 626 627
  | isNothing (occurCheckExpand tv1 ty2)
  = let occCheckMsg = hang (text "Occurs check: cannot construct the infinite type:") 2
                           (sep [ppr ty1, char '~', ppr ty2])
    in mkErrorMsg ctxt ct (occCheckMsg $$ extra)

628 629
  -- Check for skolem escape
  | (implic:_) <- cec_encl ctxt   -- Get the innermost context
630 631
  , Implic { ic_env = env, ic_skols = skols, ic_info = skol_info } <- implic
  , let esc_skols = filter (`elemVarSet` (tyVarsOfType ty2)) skols
632
  , not (null esc_skols)
633
  = do { let msg = misMatchMsg oriented ty1 ty2
634 635 636 637 638
             esc_doc = sep [ ptext (sLit "because type variable") <> plural esc_skols
                             <+> pprQuotedList esc_skols
                           , ptext (sLit "would escape") <+>
                             if isSingleton esc_skols then ptext (sLit "its scope")
                                                      else ptext (sLit "their scope") ]
639 640 641 642 643 644 645 646
             tv_extra = vcat [ nest 2 $ esc_doc
                             , sep [ (if isSingleton esc_skols 
                                      then ptext (sLit "This (rigid, skolem) type variable is")
                                      else ptext (sLit "These (rigid, skolem) type variables are"))
                               <+> ptext (sLit "bound by")
                             , nest 2 $ ppr skol_info
                             , nest 2 $ ptext (sLit "at") <+> ppr (tcl_loc env) ] ]
       ; mkErrorMsg ctxt ct (msg $$ tv_extra $$ extra) }
647 648 649

  -- Nastiest case: attempt to unify an untouchable variable
  | (implic:_) <- cec_encl ctxt   -- Get the innermost context
650 651 652 653 654 655 656 657 658 659
  , Implic { ic_env = env, ic_given = given, ic_info = skol_info } <- implic
  = do { let msg = misMatchMsg oriented ty1 ty2
             untch_extra 
                = nest 2 $
                  sep [ quotes (ppr tv1) <+> ptext (sLit "is untouchable")
                      , nest 2 $ ptext (sLit "inside the constraints") <+> pprEvVarTheta given
                      , nest 2 $ ptext (sLit "bound by") <+> ppr skol_info
                      , nest 2 $ ptext (sLit "at") <+> ppr (tcl_loc env) ]
             tv_extra = extraTyVarInfo ctxt ty1 ty2
       ; mkErrorMsg ctxt ct (vcat [msg, untch_extra, tv_extra, extra]) }
660

661
  | otherwise
662
  = reportEqErr ctxt extra ct oriented (mkTyVarTy tv1) ty2
663 664 665
        -- This *can* happen (Trac #6123, and test T2627b)
        -- Consider an ambiguous top-level constraint (a ~ F a)
        -- Not an occurs check, becuase F is a type function.
666
  where         
667 668 669
    k1 	= tyVarKind tv1
    k2 	= typeKind ty2
    ty1 = mkTyVarTy tv1
670

671
mkEqInfoMsg :: ReportErrCtxt -> Ct -> TcType -> TcType -> TcM (ReportErrCtxt, SDoc)
672 673 674 675 676 677 678 679 680
-- Report (a) ambiguity if either side is a type function application
--            e.g. F a0 ~ Int    
--        (b) warning about injectivity if both sides are the same
--            type function application   F a ~ F b
--            See Note [Non-injective type functions]
mkEqInfoMsg ctxt ct ty1 ty2
  = do { (ctxt', _, ambig_msg) <- if isJust mb_fun1 || isJust mb_fun2
                                  then mkAmbigMsg ctxt [ct]
                                  else return (ctxt, False, empty)
681
       ; return (ctxt', tyfun_msg $$ ambig_msg) }
682 683 684 685 686 687 688 689 690 691
  where
    mb_fun1 = isTyFun_maybe ty1
    mb_fun2 = isTyFun_maybe ty2
    tyfun_msg | Just tc1 <- mb_fun1
              , Just tc2 <- mb_fun2
              , tc1 == tc2 
              = ptext (sLit "NB:") <+> quotes (ppr tc1) 
                <+> ptext (sLit "is a type function, and may not be injective")
              | otherwise = empty

Simon Peyton Jones's avatar
Simon Peyton Jones committed
692 693 694 695 696 697 698 699 700 701 702
isUserSkolem :: ReportErrCtxt -> TcTyVar -> Bool
-- See Note [Reporting occurs-check errors]
isUserSkolem ctxt tv
  = isSkolemTyVar tv && any is_user_skol_tv (cec_encl ctxt)
  where
    is_user_skol_tv (Implic { ic_skols = sks, ic_info = skol_info })
      = tv `elem` sks && is_user_skol_info skol_info

    is_user_skol_info (InferSkol {}) = False
    is_user_skol_info _ = True

703
misMatchOrCND :: ReportErrCtxt -> Ct -> Maybe SwapFlag -> TcType -> TcType -> SDoc
704 705 706 707
-- If oriented then ty1 is expected, ty2 is actual
misMatchOrCND ctxt ct oriented ty1 ty2
  | null givens || 
    (isRigid ty1 && isRigid ty2) || 
708
    isGivenCt ct
709 710 711 712
       -- If the equality is unconditionally insoluble
       -- or there is no context, don't report the context
  = misMatchMsg oriented ty1 ty2
  | otherwise      
713
  = couldNotDeduce givens ([mkEqPred ty1 ty2], orig)
714 715
  where
    givens = getUserGivens ctxt
716
    orig   = TypeEqOrigin ty1 ty2
717

718
couldNotDeduce :: [UserGiven] -> (ThetaType, CtOrigin) -> SDoc
719
couldNotDeduce givens (wanteds, orig)
720
  = vcat [ addArising orig (ptext (sLit "Could not deduce") <+> pprTheta wanteds)
dimitris's avatar
dimitris committed
721 722
         , vcat (pp_givens givens)]

723
pp_givens :: [UserGiven] -> [SDoc]
dimitris's avatar
dimitris committed
724 725
pp_givens givens 
   = case givens of
726 727 728
         []     -> []
         (g:gs) ->      ppr_given (ptext (sLit "from the context")) g
                 : map (ppr_given (ptext (sLit "or from"))) gs
729 730
    where 
       ppr_given herald (gs, skol_info, loc)
dimitris's avatar
dimitris committed
731
           = hang (herald <+> pprEvVarTheta gs)
732 733
                2 (sep [ ptext (sLit "bound by") <+> ppr skol_info
                       , ptext (sLit "at") <+> ppr loc])
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
734

735
extraTyVarInfo :: ReportErrCtxt -> TcType -> TcType -> SDoc
736 737
-- Add on extra info about the types themselves
-- NB: The types themselves are already tidied
738 739
extraTyVarInfo ctxt ty1 ty2
  = nest 2 (extra1 $$ extra2)
740
  where
741 742
    extra1 = tyVarExtraInfoMsg (cec_encl ctxt) ty1
    extra2 = tyVarExtraInfoMsg (cec_encl ctxt) ty2
743

744
tyVarExtraInfoMsg :: [Implication] -> Type -> SDoc
745
-- Shows a bit of extra info about skolem constants
746
tyVarExtraInfoMsg implics ty
747
  | Just tv <- tcGetTyVar_maybe ty
Simon Peyton Jones's avatar
Simon Peyton Jones committed
748 749 750
  , isTcTyVar tv, isSkolemTyVar tv
  , let pp_tv = quotes (ppr tv)
 = case tcTyVarDetails tv of
751
    SkolemTv {}   -> pp_tv <+> pprSkol (getSkolemInfo implics tv) (getSrcLoc tv)
Simon Peyton Jones's avatar
Simon Peyton Jones committed
752 753 754 755 756 757 758
    FlatSkol {}   -> pp_tv <+> ptext (sLit "is a flattening type variable")
    RuntimeUnk {} -> pp_tv <+> ptext (sLit "is an interactive-debugger skolem")
    MetaTv {}     -> empty

 | otherwise             -- Normal case
 = empty
 
759 760 761 762 763 764 765 766 767
kindErrorMsg :: TcType -> TcType -> SDoc   -- Types are already tidy
kindErrorMsg ty1 ty2
  = vcat [ ptext (sLit "Kind incompatibility when matching types:")
         , nest 2 (vcat [ ppr ty1 <+> dcolon <+> ppr k1
                        , ppr ty2 <+> dcolon <+> ppr k2 ]) ]
  where
    k1 = typeKind ty1
    k2 = typeKind ty2

768
--------------------
769
misMatchMsg :: Maybe SwapFlag -> TcType -> TcType -> SDoc	   -- Types are already tidy
770
-- If oriented then ty1 is expected, ty2 is actual
771 772 773 774
misMatchMsg oriented ty1 ty2  
  | Just IsSwapped <- oriented
  = misMatchMsg (Just NotSwapped) ty2 ty1
  | Just NotSwapped <- oriented
775 776 777 778 779 780 781 782
  = sep [ ptext (sLit "Couldn't match expected") <+> what <+> quotes (ppr ty1)
        , nest 12 $   ptext (sLit "with actual") <+> what <+> quotes (ppr ty2) ]
  | otherwise
  = sep [ ptext (sLit "Couldn't match") <+> what <+> quotes (ppr ty1)
        , nest 14 $ ptext (sLit "with") <+> quotes (ppr ty2) ]
  where 
    what | isKind ty1 = ptext (sLit "kind")
         | otherwise  = ptext (sLit "type")
783

784 785 786 787 788 789 790 791 792 793
mkExpectedActualMsg :: Type -> Type -> CtOrigin -> (Maybe SwapFlag, SDoc)
mkExpectedActualMsg ty1 ty2 (TypeEqOrigin { uo_actual = act, uo_expected = exp })
  | act `pickyEqType` ty1, exp `pickyEqType` ty2 = (Just IsSwapped,  empty)
  | exp `pickyEqType` ty1, act `pickyEqType` ty2 = (Just NotSwapped, empty)
  | otherwise                                    = (Nothing, msg)
  where
    msg = vcat [ text "Expected type:" <+> ppr exp
               , text "  Actual type:" <+> ppr act ]

mkExpectedActualMsg _ _ _ = panic "mkExprectedAcutalMsg"
794 795
\end{code}

Simon Peyton Jones's avatar
Simon Peyton Jones committed
796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813
Note [Reporting occurs-check errors]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Given (a ~ [a]), if 'a' is a rigid type variable bound by a user-supplied
type signature, then the best thing is to report that we can't unify
a with [a], because a is a skolem variable.  That avoids the confusing
"occur-check" error message.

But nowadays when inferring the type of a function with no type signature,
even if there are errors inside, we still generalise its signature and
carry on. For example
   f x = x:x
Here we will infer somethiing like
   f :: forall a. a -> [a]
with a suspended error of (a ~ [a]).  So 'a' is now a skolem, but not
one bound by the programmer!  Here we really should report an occurs check.

So isUserSkolem distinguishes the two.

814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831
Note [Non-injective type functions]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
It's very confusing to get a message like
     Couldn't match expected type `Depend s'
            against inferred type `Depend s1'
so mkTyFunInfoMsg adds:
       NB: `Depend' is type function, and hence may not be injective

Warn of loopy local equalities that were dropped.


%************************************************************************
%*									*
                 Type-class errors
%*									*
%************************************************************************

\begin{code}
832 833
mkDictErr :: ReportErrCtxt -> [Ct] -> TcM ErrMsg
mkDictErr ctxt cts 
834 835 836 837 838 839 840
  = ASSERT( not (null cts) )
    do { inst_envs <- tcGetInstEnvs
       ; lookups   <- mapM (lookup_cls_inst inst_envs) cts
       ; let (no_inst_cts, overlap_cts) = partition is_no_inst lookups

       -- Report definite no-instance errors, 
       -- or (iff there are none) overlap errors
841 842 843
       -- But we report only one of them (hence 'head') becuase they all
       -- have the same source-location origin, to try avoid a cascade
       -- of error from one location
844
       ; (ctxt, err) <- mk_dict_err ctxt (head (no_inst_cts ++ overlap_cts))
845
       ; mkErrorMsg ctxt ct1 err }
846
  where
847
    ct1:_ = cts
848 849 850 851 852 853 854 855 856 857
    no_givens = null (getUserGivens ctxt)
    is_no_inst (ct, (matches, unifiers, _))
      =  no_givens 
      && null matches 
      && (null unifiers || all (not . isAmbiguousTyVar) (varSetElems (tyVarsOfCt ct)))
           
    lookup_cls_inst inst_envs ct
      = do { tys_flat <- mapM quickFlattenTy tys
                -- Note [Flattening in error message generation]
           ; return (ct, lookupInstEnv inst_envs clas tys_flat) }
858
      where
859
        (clas, tys) = getClassPredTys (ctPred ct)
860

861
mk_dict_err :: ReportErrCtxt -> (Ct, ClsInstLookupResult)
862
            -> TcM (ReportErrCtxt, SDoc)
863 864 865 866
-- Report an overlap error if this class constraint results
-- from an overlap (returning Left clas), otherwise return (Right pred)
mk_dict_err ctxt (ct, (matches, unifiers, safe_haskell)) 
  | null matches  -- No matches but perhaps several unifiers
867 868
  = do { (ctxt, is_ambig, ambig_msg) <- mkAmbigMsg ctxt [ct]
       ; (ctxt, binds_msg) <- relevantBindings ctxt ct
Simon Peyton Jones's avatar
Simon Peyton Jones committed
869
       ; traceTc "mk_dict_err" (ppr ct $$ ppr is_ambig $$ ambig_msg)
870
       ; return (ctxt, cannot_resolve_msg is_ambig binds_msg ambig_msg) }
871

872 873
  | not safe_haskell   -- Some matches => overlap errors
  = return (ctxt, overlap_msg)
874

875 876 877
  | otherwise
  = return (ctxt, safe_haskell_msg)
  where
878
    orig        = ctLocOrigin (cc_loc ct)
879 880 881 882 883 884
    pred        = ctPred ct
    (clas, tys) = getClassPredTys pred
    ispecs      = [ispec | (ispec, _) <- matches]
    givens      = getUserGivens ctxt
    all_tyvars  = all isTyVarTy tys

885
    cannot_resolve_msg has_ambig_tvs binds_msg ambig_msg
886 887
      = vcat [ addArising orig (no_inst_herald <+> pprParendType pred)
             , vcat (pp_givens givens)
888
             , if (has_ambig_tvs && not (null unifiers && null givens))
Simon Peyton Jones's avatar
Simon Peyton Jones committed
889
               then vcat [ ambig_msg, binds_msg, potential_msg ]
890
               else empty
891
             , show_fixes (add_to_ctxt_fixes has_ambig_tvs ++ drv_fixes) ]
892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912

    potential_msg
      | null unifiers = empty
      | otherwise 
      = hang (if isSingleton unifiers 
              then ptext (sLit "Note: there is a potential instance available:")
              else ptext (sLit "Note: there are several potential instances:"))
    	   2 (ppr_insts unifiers)

    add_to_ctxt_fixes has_ambig_tvs
      | not has_ambig_tvs && all_tyvars
      , (orig:origs) <- mapCatMaybes get_good_orig (cec_encl ctxt)
      = [sep [ ptext (sLit "add") <+> pprParendType pred
               <+> ptext (sLit "to the context of")
	     , nest 2 $ ppr_skol orig $$ 
                        vcat [ ptext (sLit "or") <+> ppr_skol orig 
                             | orig <- origs ] ] ]
      | otherwise = []

    ppr_skol (PatSkol dc _) = ptext (sLit "the data constructor") <+> quotes (ppr dc)
    ppr_skol skol_info      = ppr skol_info
913 914

	-- Do not suggest adding constraints to an *inferred* type signature!
915 916 917
    get_good_orig ic = case ic_info ic of 
                         SigSkol (InfSigCtxt {}) _ -> Nothing
                         origin                    -> Just origin
918

919 920 921
    no_inst_herald
      | null givens && null matches = ptext (sLit "No instance for")
      | otherwise                   = ptext (sLit "Could not deduce")
922

923 924 925
    drv_fixes = case orig of
                   DerivOrigin -> [drv_fix]
                   _           -> []
926

927 928
    drv_fix = hang (ptext (sLit "use a standalone 'deriving instance' declaration,"))
                 2 (ptext (sLit "so you can specify the instance context yourself"))
929

930
    -- Normal overlap error
931
    overlap_msg
932 933
      = ASSERT( not (null matches) )
        vcat [	addArising orig (ptext (sLit "Overlapping instances for") 
batterseapower's avatar
batterseapower committed
934
				<+> pprType (mkClassPred clas tys))
dimitris's avatar
dimitris committed
935

936
             ,  if not (null matching_givens) then 
937
                  sep [ptext (sLit "Matching givens (or their superclasses):") 
938
                      , nest 2 (vcat matching_givens)]
dimitris's avatar
dimitris committed
939 940
                else empty

941 942 943
    	     ,	sep [ptext (sLit "Matching instances:"),
    		     nest 2 (vcat [pprInstances ispecs, pprInstances unifiers])]

944 945 946 947 948 949 950
             ,  if null matching_givens && isSingleton matches && null unifiers then
                -- Intuitively, some given matched the wanted in their
                -- flattened or rewritten (from given equalities) form
                -- but the matcher can't figure that out because the
                -- constraints are non-flat and non-rewritten so we
                -- simply report back the whole given
                -- context. Accelerate Smart.hs showed this problem.
951
                  sep [ ptext (sLit "There exists a (perhaps superclass) match:") 
952
                      , nest 2 (vcat (pp_givens givens))]
dimitris's avatar
dimitris committed
953 954
                else empty 

955 956 957
	     ,	if not (isSingleton matches)
    		then 	-- Two or more matches
		     empty
Simon Peyton Jones's avatar
Simon Peyton Jones committed
958
    		else 	-- One match
959
		parens (vcat [ptext (sLit "The choice depends on the instantiation of") <+>
batterseapower's avatar
batterseapower committed
960
	    		         quotes (pprWithCommas ppr (varSetElems (tyVarsOfTypes tys))),
961
			      if null (matching_givens) then
dimitris's avatar
dimitris committed
962 963 964
                                   vcat [ ptext (sLit "To pick the first instance above, use -XIncoherentInstances"),
			                  ptext (sLit "when compiling the other instance declarations")]
                              else empty])]
965 966 967 968
        where
            ispecs = [ispec | (ispec, _) <- matches]

            givens = getUserGivens ctxt
969 970
            matching_givens = mapCatMaybes matchable givens

971
            matchable (evvars,skol_info,loc) 
972 973 974
              = case ev_vars_matching of
                     [] -> Nothing
                     _  -> Just $ hang (pprTheta ev_vars_matching)
975 976
                                    2 (sep [ ptext (sLit "bound by") <+> ppr skol_info
                                           , ptext (sLit "at") <+> ppr loc])
977
                where ev_vars_matching = filter ev_var_matches (map evVarPred evvars)
batterseapower's avatar
batterseapower committed
978 979 980 981 982 983 984 985
                      ev_var_matches ty = case getClassPredTys_maybe ty of
                         Just (clas', tys')
                           | clas' == clas
                           , Just _ <- tcMatchTys (tyVarsOfTypes tys) tys tys'
                           -> True 
                           | otherwise
                           -> any ev_var_matches (immSuperClasses clas' tys')
                         Nothing -> False
986

987 988 989
    -- Overlap error because of Safe Haskell (first 
    -- match should be the most specific match)
    safe_haskell_msg
990 991
      = ASSERT( length matches > 1 )
        vcat [ addArising orig (ptext (sLit "Unsafe overlapping instances for") 
batterseapower's avatar
batterseapower committed
992
                        <+> pprType (mkClassPred clas tys))
993
             , sep [ptext (sLit "The matching instance is:"),
994 995 996 997 998 999 1000
                    nest 2 (pprInstance $ head ispecs)]
             , vcat [ ptext $ sLit "It is compiled in a Safe module and as such can only"
                    , ptext $ sLit "overlap instances from the same module, however it"
                    , ptext $ sLit "overlaps the following instances from different modules:"
                    , nest 2 (vcat [pprInstances $ tail ispecs])
                    ]
             ]
1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015

show_fixes :: [SDoc] -> SDoc
show_fixes []     = empty
show_fixes (f:fs) = sep [ ptext (sLit "Possible fix:")
                        , nest 2 (vcat (f : map (ptext (sLit "or") <+>) fs))]

ppr_insts :: [ClsInst] -> SDoc
ppr_insts insts
  = pprInstances (take 3 insts) $$ dot_dot_message
  where
    n_extra = length insts - 3
    dot_dot_message 
       | n_extra <= 0 = empty
       | otherwise    = ptext (sLit "...plus") 
                        <+> speakNOf n_extra (ptext (sLit "other"))
dimitris's avatar
dimitris committed
1016

1017 1018 1019 1020 1021 1022
----------------------
quickFlattenTy :: TcType -> TcM TcType
-- See Note [Flattening in error message generation]
quickFlattenTy ty | Just ty' <- tcView ty = quickFlattenTy ty'
quickFlattenTy ty@(TyVarTy {})  = return ty
quickFlattenTy ty@(ForAllTy {}) = return ty     -- See
1023
quickFlattenTy ty@(LitTy {})    = return ty
1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1