Remove the USAVOURY HACK in simplifyInfer
[ghc.git] / compiler / typecheck / TcSimplify.lhs
1 \begin{code}
2 {-# OPTIONS -fno-warn-tabs #-}
3 -- The above warning supression flag is a temporary kludge.
4 -- While working on this module you are encouraged to remove it and
5 -- detab the module (please do the detabbing in a separate patch). See
6 --     http://hackage.haskell.org/trac/ghc/wiki/Commentary/CodingStyle#TabsvsSpaces
7 -- for details
8
9 module TcSimplify( 
10        simplifyInfer, simplifyAmbiguityCheck,
11        simplifyDefault, simplifyDeriv, 
12        simplifyRule, simplifyTop, simplifyInteractive
13   ) where
14
15 #include "HsVersions.h"
16
17 import TcRnMonad
18 import TcErrors
19 import TcMType
20 import TcType 
21 import TcSMonad 
22 import TcInteract 
23 import Inst
24 import Unify    ( niFixTvSubst, niSubstTvSet )
25 import Type     ( classifyPredType, PredTree(..), isIPPred_maybe )
26 import Var
27 import Unique
28 import VarSet
29 import VarEnv 
30 import TcEvidence
31 import TypeRep
32 import Name
33 import Bag
34 import ListSetOps
35 import Util
36 import PrelInfo
37 import PrelNames
38 import Class            ( classKey )
39 import BasicTypes       ( RuleName )
40 import Control.Monad    ( when )
41 import Outputable
42 import FastString
43 import TrieMap () -- DV: for now
44 import DynFlags
45 import Data.Maybe ( mapMaybe )
46 \end{code}
47
48
49 *********************************************************************************
50 *                                                                               * 
51 *                           External interface                                  *
52 *                                                                               *
53 *********************************************************************************
54
55
56 \begin{code}
57
58
59 simplifyTop :: WantedConstraints -> TcM (Bag EvBind)
60 -- Simplify top-level constraints
61 -- Usually these will be implications,
62 -- but when there is nothing to quantify we don't wrap
63 -- in a degenerate implication, so we do that here instead
64 simplifyTop wanteds 
65   = do { ev_binds_var <- newTcEvBinds
66                          
67        ; zonked_wanteds <- zonkWC wanteds
68        ; wc_first_go <- runTcSWithEvBinds ev_binds_var $ solveWanteds zonked_wanteds
69        ; cts <- applyTyVarDefaulting wc_first_go 
70                 -- See Note [Top-level Defaulting Plan]
71                 
72        ; let wc_for_loop = wc_first_go { wc_flat = wc_flat wc_first_go `unionBags` cts }
73                            
74        ; traceTc "simpl_top_loop {" $ text "zonked_wc =" <+> ppr zonked_wanteds
75        ; simpl_top_loop ev_binds_var wc_for_loop }
76     
77   where simpl_top_loop ev_binds_var wc
78           | isEmptyWC wc 
79           = do { traceTc "simpl_top_loop }" empty
80                ; TcRnMonad.getTcEvBinds ev_binds_var }
81           | otherwise
82           = do { wc_residual <- runTcSWithEvBinds ev_binds_var $ solveWanteds wc
83                ; let wc_flat_approximate = approximateWC wc_residual
84                ; (dflt_eqs,_unused_bind) <- runTcS $
85                                             applyDefaultingRules wc_flat_approximate
86                                             -- See Note [Top-level Defaulting Plan]
87                ; if isEmptyBag dflt_eqs then 
88                    do { traceTc "simpl_top_loop }" empty
89                       ; report_and_finish ev_binds_var wc_residual }
90                  else
91                    simpl_top_loop ev_binds_var $ 
92                    wc_residual { wc_flat = wc_flat wc_residual `unionBags` dflt_eqs } }
93
94         report_and_finish ev_binds_var wc_residual 
95           = do { eb1 <- TcRnMonad.getTcEvBinds ev_binds_var
96                ; traceTc "reportUnsolved {" empty
97                    -- See Note [Deferring coercion errors to runtime]
98                ; runtimeCoercionErrors <- doptM Opt_DeferTypeErrors
99                ; eb2 <- reportUnsolved runtimeCoercionErrors wc_residual
100                ; traceTc "reportUnsolved }" empty
101                ; return (eb1 `unionBags` eb2) }
102 \end{code}
103
104 Note [Top-level Defaulting Plan]
105 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
106
107 We have considered two design choices for where/when to apply defaulting.   
108    (i) Do it in SimplCheck mode only /whenever/ you try to solve some 
109        flat constraints, maybe deep inside the context of implications.
110        This used to be the case in GHC 7.4.1.
111    (ii) Do it in a tight loop at simplifyTop, once all other constraint has 
112         finished. This is the current story.
113
114 Option (i) had many disadvantages: 
115    a) First it was deep inside the actual solver, 
116    b) Second it was dependent on the context (Infer a type signature, 
117       or Check a type signature, or Interactive) since we did not want 
118       to always start defaulting when inferring (though there is an exception to  
119       this see Note [Default while Inferring])
120    c) It plainly did not work. Consider typecheck/should_compile/DfltProb2.hs:
121           f :: Int -> Bool
122           f x = const True (\y -> let w :: a -> a
123                                       w a = const a (y+1)
124                                   in w y)
125       We will get an implication constraint (for beta the type of y):
126                [untch=beta] forall a. 0 => Num beta
127       which we really cannot default /while solving/ the implication, since beta is
128       untouchable.
129
130 Instead our new defaulting story is to pull defaulting out of the solver loop and
131 go with option (i), implemented at SimplifyTop. Namely:
132      - First have a go at solving the residual constraint of the whole program
133      - Try to approximate it with a flat constraint
134      - Figure out derived defaulting equations for that flat constraint
135      - Go round the loop again if you did manage to get some equations
136
137 Now, that has to do with class defaulting. However there exists type variable /kind/
138 defaulting. Again this is done at the top-level and the plan is:
139      - At the top-level, once you had a go at solving the constraint, do 
140        figure out /all/ the touchable unification variables of the wanted contraints.
141      - Apply defaulting to their kinds
142
143 More details in Note [DefaultTyVar].
144
145 \begin{code}
146
147 ------------------
148 simplifyAmbiguityCheck :: Name -> WantedConstraints -> TcM (Bag EvBind)
149 simplifyAmbiguityCheck name wanteds
150   = traceTc "simplifyAmbiguityCheck" (text "name =" <+> ppr name) >> 
151     simplifyCheck wanteds
152  
153 ------------------
154 simplifyInteractive :: WantedConstraints -> TcM (Bag EvBind)
155 simplifyInteractive wanteds 
156   = traceTc "simplifyInteractive" empty >>
157     simplifyTop wanteds 
158
159 ------------------
160 simplifyDefault :: ThetaType    -- Wanted; has no type variables in it
161                 -> TcM ()       -- Succeeds iff the constraint is soluble
162 simplifyDefault theta
163   = do { traceTc "simplifyInteractive" empty
164        ; wanted <- newFlatWanteds DefaultOrigin theta
165        ; _ignored_ev_binds <- simplifyCheck (mkFlatWC wanted)
166        ; return () }
167 \end{code}
168
169
170 ***********************************************************************************
171 *                                                                                 * 
172 *                            Deriving                                             *
173 *                                                                                 *
174 ***********************************************************************************
175
176 \begin{code}
177 simplifyDeriv :: CtOrigin
178               -> PredType
179               -> [TyVar]        
180               -> ThetaType              -- Wanted
181               -> TcM ThetaType  -- Needed
182 -- Given  instance (wanted) => C inst_ty 
183 -- Simplify 'wanted' as much as possibles
184 -- Fail if not possible
185 simplifyDeriv orig pred tvs theta 
186   = do { (skol_subst, tvs_skols) <- tcInstSkolTyVars tvs -- Skolemize
187                 -- The constraint solving machinery 
188                 -- expects *TcTyVars* not TyVars.  
189                 -- We use *non-overlappable* (vanilla) skolems
190                 -- See Note [Overlap and deriving]
191
192        ; let subst_skol = zipTopTvSubst tvs_skols $ map mkTyVarTy tvs
193              skol_set   = mkVarSet tvs_skols
194              doc = ptext (sLit "deriving") <+> parens (ppr pred)
195
196        ; wanted <- newFlatWanteds orig (substTheta skol_subst theta)
197
198        ; traceTc "simplifyDeriv" $ 
199          vcat [ pprTvBndrs tvs $$ ppr theta $$ ppr wanted, doc ]
200        ; (residual_wanted, _ev_binds1)
201              <- runTcS $ solveWanteds (mkFlatWC wanted)
202
203        ; let (good, bad) = partitionBagWith get_good (wc_flat residual_wanted)
204                          -- See Note [Exotic derived instance contexts]
205              get_good :: Ct -> Either PredType Ct
206              get_good ct | validDerivPred skol_set p = Left p
207                          | otherwise                 = Right ct
208                          where p = ctPred ct
209
210        -- We never want to defer these errors because they are errors in the
211        -- compiler! Hence the `False` below
212        ; _ev_binds2 <- reportUnsolved False (residual_wanted { wc_flat = bad })
213
214        ; let min_theta = mkMinimalBySCs (bagToList good)
215        ; return (substTheta subst_skol min_theta) }
216 \end{code}
217
218 Note [Overlap and deriving]
219 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
220 Consider some overlapping instances:
221   data Show a => Show [a] where ..
222   data Show [Char] where ...
223
224 Now a data type with deriving:
225   data T a = MkT [a] deriving( Show )
226
227 We want to get the derived instance
228   instance Show [a] => Show (T a) where...
229 and NOT
230   instance Show a => Show (T a) where...
231 so that the (Show (T Char)) instance does the Right Thing
232
233 It's very like the situation when we're inferring the type
234 of a function
235    f x = show [x]
236 and we want to infer
237    f :: Show [a] => a -> String
238
239 BOTTOM LINE: use vanilla, non-overlappable skolems when inferring
240              the context for the derived instance. 
241              Hence tcInstSkolTyVars not tcInstSuperSkolTyVars
242
243 Note [Exotic derived instance contexts]
244 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
245 In a 'derived' instance declaration, we *infer* the context.  It's a
246 bit unclear what rules we should apply for this; the Haskell report is
247 silent.  Obviously, constraints like (Eq a) are fine, but what about
248         data T f a = MkT (f a) deriving( Eq )
249 where we'd get an Eq (f a) constraint.  That's probably fine too.
250
251 One could go further: consider
252         data T a b c = MkT (Foo a b c) deriving( Eq )
253         instance (C Int a, Eq b, Eq c) => Eq (Foo a b c)
254
255 Notice that this instance (just) satisfies the Paterson termination 
256 conditions.  Then we *could* derive an instance decl like this:
257
258         instance (C Int a, Eq b, Eq c) => Eq (T a b c) 
259 even though there is no instance for (C Int a), because there just
260 *might* be an instance for, say, (C Int Bool) at a site where we
261 need the equality instance for T's.  
262
263 However, this seems pretty exotic, and it's quite tricky to allow
264 this, and yet give sensible error messages in the (much more common)
265 case where we really want that instance decl for C.
266
267 So for now we simply require that the derived instance context
268 should have only type-variable constraints.
269
270 Here is another example:
271         data Fix f = In (f (Fix f)) deriving( Eq )
272 Here, if we are prepared to allow -XUndecidableInstances we
273 could derive the instance
274         instance Eq (f (Fix f)) => Eq (Fix f)
275 but this is so delicate that I don't think it should happen inside
276 'deriving'. If you want this, write it yourself!
277
278 NB: if you want to lift this condition, make sure you still meet the
279 termination conditions!  If not, the deriving mechanism generates
280 larger and larger constraints.  Example:
281   data Succ a = S a
282   data Seq a = Cons a (Seq (Succ a)) | Nil deriving Show
283
284 Note the lack of a Show instance for Succ.  First we'll generate
285   instance (Show (Succ a), Show a) => Show (Seq a)
286 and then
287   instance (Show (Succ (Succ a)), Show (Succ a), Show a) => Show (Seq a)
288 and so on.  Instead we want to complain of no instance for (Show (Succ a)).
289
290 The bottom line
291 ~~~~~~~~~~~~~~~
292 Allow constraints which consist only of type variables, with no repeats.
293
294 *********************************************************************************
295 *                                                                                 * 
296 *                            Inference
297 *                                                                                 *
298 ***********************************************************************************
299
300 Note [Which variables to quantify]
301 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
302 Suppose the inferred type of a function is
303    T kappa (alpha:kappa) -> Int
304 where alpha is a type unification variable and 
305       kappa is a kind unification variable
306 Then we want to quantify over *both* alpha and kappa.  But notice that
307 kappa appears "at top level" of the type, as well as inside the kind
308 of alpha.  So it should be fine to just look for the "top level"
309 kind/type variables of the type, without looking transitively into the
310 kinds of those type variables.
311
312 \begin{code}
313 simplifyInfer :: Bool
314               -> Bool                  -- Apply monomorphism restriction
315               -> [(Name, TcTauType)]   -- Variables to be generalised,
316                                        -- and their tau-types
317               -> (Untouchables, WantedConstraints)
318               -> TcM ([TcTyVar],    -- Quantify over these type variables
319                       [EvVar],      -- ... and these constraints
320                       Bool,         -- The monomorphism restriction did something
321                                     --   so the results type is not as general as
322                                     --   it could be
323                       TcEvBinds)    -- ... binding these evidence variables
324 simplifyInfer _top_lvl apply_mr name_taus (untch,wanteds)
325   | isEmptyWC wanteds
326   = do { gbl_tvs     <- tcGetGlobalTyVars            -- Already zonked
327        ; zonked_taus <- zonkTcTypes (map snd name_taus)
328        ; let tvs_to_quantify = varSetElems (tyVarsOfTypes zonked_taus `minusVarSet` gbl_tvs)
329                                -- tvs_to_quantify can contain both kind and type vars
330                                -- See Note [Which variables to quantify]
331        ; qtvs <- zonkQuantifiedTyVars tvs_to_quantify
332        ; return (qtvs, [], False, emptyTcEvBinds) }
333
334   | otherwise
335   = do { runtimeCoercionErrors <- doptM Opt_DeferTypeErrors
336        ; gbl_tvs        <- tcGetGlobalTyVars
337        ; zonked_tau_tvs <- zonkTyVarsAndFV (tyVarsOfTypes (map snd name_taus))
338        ; zonked_wanteds <- zonkWC wanteds
339
340        ; traceTc "simplifyInfer {"  $ vcat
341              [ ptext (sLit "names =") <+> ppr (map fst name_taus)
342              , ptext (sLit "taus =") <+> ppr (map snd name_taus)
343              , ptext (sLit "tau_tvs (zonked) =") <+> ppr zonked_tau_tvs
344              , ptext (sLit "gbl_tvs =") <+> ppr gbl_tvs
345              , ptext (sLit "closed =") <+> ppr _top_lvl
346              , ptext (sLit "apply_mr =") <+> ppr apply_mr
347              , ptext (sLit "untch =") <+> ppr untch
348              , ptext (sLit "wanted =") <+> ppr zonked_wanteds
349              ]
350
351               -- Historical note: Before step 2 we used to have a
352               -- HORRIBLE HACK described in Note [Avoid unecessary
353               -- constraint simplification] but, as described in Trac
354               -- #4361, we have taken in out now.  That's why we start
355               -- with step 2!
356
357               -- Step 2) First try full-blown solving 
358
359               -- NB: we must gather up all the bindings from doing
360               -- this solving; hence (runTcSWithEvBinds ev_binds_var).
361               -- And note that since there are nested implications,
362               -- calling solveWanteds will side-effect their evidence
363               -- bindings, so we can't just revert to the input
364               -- constraint.
365        ; ev_binds_var <- newTcEvBinds
366        ; wanted_transformed <- runTcSWithEvBinds ev_binds_var $ 
367                                solveWanteds zonked_wanteds
368
369               -- Step 3) Fail fast if there is an insoluble constraint,
370               -- unless we are deferring errors to runtime
371        ; when (not runtimeCoercionErrors && insolubleWC wanted_transformed) $ 
372          do { _ev_binds <- reportUnsolved False wanted_transformed; failM }
373
374               -- Step 4) Candidates for quantification are an approximation of wanted_transformed
375        ; let quant_candidates = approximateWC wanted_transformed               
376               -- NB: Already the fixpoint of any unifications that may have happened                                
377               -- NB: We do not do any defaulting when inferring a type, this can lead
378               -- to less polymorphic types, see Note [Default while Inferring]
379                                 
380               -- Step 5) Minimize the quantification candidates                             
381        ; (quant_candidates_transformed, _extra_binds)   
382              <- runTcS $ solveWanteds $ WC { wc_flat  = quant_candidates
383                                            , wc_impl  = emptyBag
384                                            , wc_insol = emptyBag }
385
386               -- Step 6) Final candidates for quantification                
387        ; let final_quant_candidates :: Bag PredType
388              final_quant_candidates = mapBag ctPred $ 
389                                       keepWanted (wc_flat quant_candidates_transformed)
390              -- NB: Already the fixpoint of any unifications that may have happened
391                   
392        ; gbl_tvs        <- tcGetGlobalTyVars -- TODO: can we just use untch instead of gbl_tvs?
393        ; zonked_tau_tvs <- zonkTyVarsAndFV zonked_tau_tvs
394        
395        ; traceTc "simplifyWithApprox" $
396          vcat [ ptext (sLit "final_quant_candidates =") <+> ppr final_quant_candidates
397               , ptext (sLit "gbl_tvs=") <+> ppr gbl_tvs
398               , ptext (sLit "zonked_tau_tvs=") <+> ppr zonked_tau_tvs ]
399          
400        ; let init_tvs        = zonked_tau_tvs `minusVarSet` gbl_tvs
401              poly_qtvs       = growPreds gbl_tvs id final_quant_candidates init_tvs
402              
403              pbound          = filterBag (quantifyMe poly_qtvs id) final_quant_candidates
404              
405        ; traceTc "simplifyWithApprox" $
406          vcat [ ptext (sLit "pbound =") <+> ppr pbound ]
407          
408              -- Monomorphism restriction
409        ; let mr_qtvs         = init_tvs `minusVarSet` constrained_tvs
410              constrained_tvs = tyVarsOfBag tyVarsOfType final_quant_candidates
411              mr_bites        = apply_mr && not (isEmptyBag pbound)
412
413              (qtvs, bound)
414                 | mr_bites  = (mr_qtvs,   emptyBag)
415                 | otherwise = (poly_qtvs, pbound)
416              
417
418        ; if isEmptyVarSet qtvs && isEmptyBag bound
419          then ASSERT( isEmptyBag (wc_insol wanted_transformed) )
420               do { traceTc "} simplifyInfer/no quantification" empty                   
421                  ; emitWC wanted_transformed
422                  ; return ([], [], mr_bites, TcEvBinds ev_binds_var) }
423          else do
424
425        { traceTc "simplifyApprox" $ 
426          ptext (sLit "bound are =") <+> ppr bound 
427          
428             -- Step 4, zonk quantified variables 
429        ; let minimal_flat_preds = mkMinimalBySCs $ bagToList bound
430              skol_info = InferSkol [ (name, mkSigmaTy [] minimal_flat_preds ty)
431                                    | (name, ty) <- name_taus ]
432                         -- Don't add the quantified variables here, because
433                         -- they are also bound in ic_skols and we want them to be
434                         -- tidied uniformly
435
436        ; qtvs_to_return <- zonkQuantifiedTyVars (varSetElems qtvs)
437
438             -- Step 7) Emit an implication
439        ; minimal_bound_ev_vars <- mapM TcMType.newEvVar minimal_flat_preds
440        ; lcl_env <- getLclTypeEnv
441        ; gloc <- getCtLoc skol_info
442        ; let implic = Implic { ic_untch    = untch 
443                              , ic_env      = lcl_env
444                              , ic_skols    = qtvs_to_return
445                              , ic_given    = minimal_bound_ev_vars
446                              , ic_wanted   = wanted_transformed 
447                              , ic_insol    = False
448                              , ic_binds    = ev_binds_var
449                              , ic_loc      = gloc }
450        ; emitImplication implic
451          
452        ; traceTc "} simplifyInfer/produced residual implication for quantification" $
453              vcat [ ptext (sLit "implic =") <+> ppr implic
454                        -- ic_skols, ic_given give rest of result
455                   , ptext (sLit "qtvs =") <+> ppr qtvs_to_return
456                   , ptext (sLit "spb =") <+> ppr final_quant_candidates
457                   , ptext (sLit "bound =") <+> ppr bound ]
458
459        ; return ( qtvs_to_return, minimal_bound_ev_vars
460                 , mr_bites,  TcEvBinds ev_binds_var) } }
461     where 
462 \end{code}
463
464
465 Note [Note [Default while Inferring]
466 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
467 Our current plan is that defaulting only happens at simplifyTop and
468 not simplifyInfer.  This may lead to some insoluble deferred constraints
469 Example:
470
471 instance D g => C g Int b 
472
473 constraint inferred = (forall b. 0 => C gamma alpha b) /\ Num alpha
474 type inferred       = gamma -> gamma 
475
476 Now, if we try to default (alpha := Int) we will be able to refine the implication to 
477   (forall b. 0 => C gamma Int b) 
478 which can then be simplified further to 
479   (forall b. 0 => D gamma)
480 Finally we /can/ approximate this implication with (D gamma) and infer the quantified
481 type:  forall g. D g => g -> g
482
483 Instead what will currently happen is that we will get a quantified type 
484 (forall g. g -> g) and an implication:
485        forall g. 0 => (forall b. 0 => C g alpha b) /\ Num alpha
486
487 which, even if the simplifyTop defaults (alpha := Int) we will still be left with an 
488 unsolvable implication:
489        forall g. 0 => (forall b. 0 => D g)
490
491 The concrete example would be: 
492        h :: C g a s => g -> a -> ST s a
493        f (x::gamma) = (\_ -> x) (runST (h x (undefined::alpha)) + 1)
494
495 But it is quite tedious to do defaulting and resolve the implication constraints and
496 we have not observed code breaking because of the lack of defaulting in inference so 
497 we don't do it for now.
498
499
500
501 Note [Minimize by Superclasses]
502 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
503
504 When we quantify over a constraint, in simplifyInfer we need to
505 quantify over a constraint that is minimal in some sense: For
506 instance, if the final wanted constraint is (Eq alpha, Ord alpha),
507 we'd like to quantify over Ord alpha, because we can just get Eq alpha
508 from superclass selection from Ord alpha. This minimization is what
509 mkMinimalBySCs does. Then, simplifyInfer uses the minimal constraint
510 to check the original wanted.
511
512
513 \begin{code}
514
515
516 approximateWC :: WantedConstraints -> Cts
517 approximateWC wc = float_wc emptyVarSet wc
518   where 
519     float_wc :: TcTyVarSet -> WantedConstraints -> Cts
520     float_wc skols (WC { wc_flat = flat, wc_impl = implic }) = floats1 `unionBags` floats2
521       where floats1 = do_bag (float_flat skols) flat
522             floats2 = do_bag (float_implic skols) implic
523                                  
524     float_implic :: TcTyVarSet -> Implication -> Cts
525     float_implic skols imp
526       = float_wc (skols `extendVarSetList` ic_skols imp) (ic_wanted imp)
527             
528     float_flat :: TcTyVarSet -> Ct -> Cts
529     float_flat skols ct
530       | tyVarsOfCt ct `disjointVarSet` skols 
531       , isWantedCt ct = singleCt ct
532       | otherwise = emptyCts
533         
534     do_bag :: (a -> Bag c) -> Bag a -> Bag c
535     do_bag f = foldrBag (unionBags.f) emptyBag
536
537
538 \end{code}
539
540 \begin{code}
541 growPreds :: TyVarSet -> (a -> PredType) -> Bag a -> TyVarSet -> TyVarSet
542 growPreds gbl_tvs get_pred items tvs
543   = foldrBag extend tvs items
544   where
545     extend item tvs = tvs `unionVarSet`
546                       (growPredTyVars (get_pred item) tvs `minusVarSet` gbl_tvs)
547
548 --------------------
549 quantifyMe :: TyVarSet      -- Quantifying over these
550            -> (a -> PredType)
551            -> a -> Bool     -- True <=> quantify over this wanted
552 quantifyMe qtvs toPred ct
553   | isIPPred pred = True  -- Note [Inheriting implicit parameters]
554   | otherwise     = tyVarsOfType pred `intersectsVarSet` qtvs
555   where
556     pred = toPred ct
557 \end{code}
558
559 Note [Avoid unecessary constraint simplification]
560 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
561     -------- NB NB NB (Jun 12) ------------- 
562     This note not longer applies; see the notes with Trac #4361.
563     But I'm leaving it in here so we remember the issue.)
564     ----------------------------------------
565 When inferring the type of a let-binding, with simplifyInfer,
566 try to avoid unnecessarily simplifying class constraints.
567 Doing so aids sharing, but it also helps with delicate 
568 situations like
569
570    instance C t => C [t] where ..
571
572    f :: C [t] => ....
573    f x = let g y = ...(constraint C [t])... 
574          in ...
575 When inferring a type for 'g', we don't want to apply the
576 instance decl, because then we can't satisfy (C t).  So we
577 just notice that g isn't quantified over 't' and partition
578 the contraints before simplifying.
579
580 This only half-works, but then let-generalisation only half-works.
581
582
583 Note [Inheriting implicit parameters]
584 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
585 Consider this:
586
587         f x = (x::Int) + ?y
588
589 where f is *not* a top-level binding.
590 From the RHS of f we'll get the constraint (?y::Int).
591 There are two types we might infer for f:
592
593         f :: Int -> Int
594
595 (so we get ?y from the context of f's definition), or
596
597         f :: (?y::Int) => Int -> Int
598
599 At first you might think the first was better, becuase then
600 ?y behaves like a free variable of the definition, rather than
601 having to be passed at each call site.  But of course, the WHOLE
602 IDEA is that ?y should be passed at each call site (that's what
603 dynamic binding means) so we'd better infer the second.
604
605 BOTTOM LINE: when *inferring types* you *must* quantify 
606 over implicit parameters. See the predicate isFreeWhenInferring.
607
608
609 *********************************************************************************
610 *                                                                                 * 
611 *                             RULES                                               *
612 *                                                                                 *
613 ***********************************************************************************
614
615 See note [Simplifying RULE consraints] in TcRule
616
617 Note [RULE quanfification over equalities]
618 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
619 Decideing which equalities to quantify over is tricky:
620  * We do not want to quantify over insoluble equalities (Int ~ Bool)
621     (a) because we prefer to report a LHS type error
622     (b) because if such things end up in 'givens' we get a bogus
623         "inaccessible code" error
624
625  * But we do want to quantify over things like (a ~ F b), where
626    F is a type function.
627
628 The difficulty is that it's hard to tell what is insoluble!
629 So we see whether the simplificaiotn step yielded any type errors,
630 and if so refrain from quantifying over *any* equalites.
631
632 \begin{code}
633 simplifyRule :: RuleName 
634              -> WantedConstraints       -- Constraints from LHS
635              -> WantedConstraints       -- Constraints from RHS
636              -> TcM ([EvVar], WantedConstraints)   -- LHS evidence varaibles
637 -- See Note [Simplifying RULE constraints] in TcRule
638 simplifyRule name lhs_wanted rhs_wanted
639   = do { zonked_all <- zonkWC (lhs_wanted `andWC` rhs_wanted)
640        ; let doc = ptext (sLit "LHS of rule") <+> doubleQuotes (ftext name)
641              
642                  -- We allow ourselves to unify environment 
643                  -- variables: runTcS runs with NoUntouchables
644        ; (resid_wanted, _) <- runTcS (solveWanteds zonked_all)
645
646        ; zonked_lhs <- zonkWC lhs_wanted
647
648        ; let (q_cts, non_q_cts) = partitionBag quantify_me (wc_flat zonked_lhs)
649              quantify_me  -- Note [RULE quantification over equalities]
650                | insolubleWC resid_wanted = quantify_insol
651                | otherwise                = quantify_normal
652
653              quantify_insol ct = not (isEqPred (ctPred ct))
654
655              quantify_normal ct
656                | EqPred t1 t2 <- classifyPredType (ctPred ct)
657                = not (t1 `eqType` t2)
658                | otherwise
659                = True
660              
661        ; traceTc "simplifyRule" $
662          vcat [ doc
663               , text "zonked_lhs" <+> ppr zonked_lhs 
664               , text "q_cts"      <+> ppr q_cts ]
665
666        ; return ( map (ctEvId . ctEvidence) (bagToList q_cts)
667                 , zonked_lhs { wc_flat = non_q_cts }) }
668 \end{code}
669
670
671 *********************************************************************************
672 *                                                                                 * 
673 *                                 Main Simplifier                                 *
674 *                                                                                 *
675 ***********************************************************************************
676
677 \begin{code}
678 simplifyCheck :: WantedConstraints      -- Wanted
679               -> TcM (Bag EvBind)
680 -- Solve a single, top-level implication constraint
681 -- e.g. typically one created from a top-level type signature
682 --          f :: forall a. [a] -> [a]
683 --          f x = rhs
684 -- We do this even if the function has no polymorphism:
685 --          g :: Int -> Int
686
687 --          g y = rhs
688 -- (whereas for *nested* bindings we would not create
689 --  an implication constraint for g at all.)
690 --
691 -- Fails if can't solve something in the input wanteds
692 simplifyCheck wanteds
693   = do { wanteds <- zonkWC wanteds
694
695        ; traceTc "simplifyCheck {" (vcat
696              [ ptext (sLit "wanted =") <+> ppr wanteds ])
697
698        ; (unsolved, eb1) <- runTcS (solveWanteds wanteds)
699
700        ; traceTc "simplifyCheck }" $ ptext (sLit "unsolved =") <+> ppr unsolved
701
702        ; traceTc "reportUnsolved {" empty
703        -- See Note [Deferring coercion errors to runtime]
704        ; runtimeCoercionErrors <- doptM Opt_DeferTypeErrors
705        ; eb2 <- reportUnsolved runtimeCoercionErrors unsolved 
706        ; traceTc "reportUnsolved }" empty
707
708        ; return (eb1 `unionBags` eb2) }
709 \end{code}
710
711 Note [Deferring coercion errors to runtime]
712 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
713
714 While developing, sometimes it is desirable to allow compilation to succeed even
715 if there are type errors in the code. Consider the following case:
716
717   module Main where
718
719   a :: Int
720   a = 'a'
721
722   main = print "b"
723
724 Even though `a` is ill-typed, it is not used in the end, so if all that we're
725 interested in is `main` it is handy to be able to ignore the problems in `a`.
726
727 Since we treat type equalities as evidence, this is relatively simple. Whenever
728 we run into a type mismatch in TcUnify, we normally just emit an error. But it
729 is always safe to defer the mismatch to the main constraint solver. If we do
730 that, `a` will get transformed into
731
732   co :: Int ~ Char
733   co = ...
734
735   a :: Int
736   a = 'a' `cast` co
737
738 The constraint solver would realize that `co` is an insoluble constraint, and
739 emit an error with `reportUnsolved`. But we can also replace the right-hand side
740 of `co` with `error "Deferred type error: Int ~ Char"`. This allows the program
741 to compile, and it will run fine unless we evaluate `a`. This is what
742 `deferErrorsToRuntime` does.
743
744 It does this by keeping track of which errors correspond to which coercion
745 in TcErrors (with ErrEnv). TcErrors.reportTidyWanteds does not print the errors
746 and does not fail if -fwarn-type-errors is on, so that we can continue
747 compilation. The errors are turned into warnings in `reportUnsolved`.
748
749 \begin{code}
750 solveWanteds :: WantedConstraints -> TcS WantedConstraints
751 -- Returns: residual constraints, plus evidence bindings 
752 -- NB: When we are called from TcM there are no inerts to pass down to TcS
753 solveWanteds wanted
754   = do { (_,wc_out) <- solve_wanteds wanted
755        ; let wc_ret = wc_out { wc_flat = keepWanted (wc_flat wc_out) } 
756                       -- Discard Derived
757        ; return wc_ret }
758
759 solve_wanteds :: WantedConstraints
760               -> TcS (TvSubst, WantedConstraints) 
761               -- NB: wc_flats may be wanted *or* derived now
762               -- Returns the flattening substitution as well in case we need to apply it
763 solve_wanteds wanted@(WC { wc_flat = flats, wc_impl = implics, wc_insol = insols }) 
764   = do { traceTcS "solveWanteds {" (ppr wanted)
765
766                  -- Try the flat bit
767                  -- Discard from insols all the derived/given constraints
768                  -- because they will show up again when we try to solve
769                  -- everything else.  Solving them a second time is a bit
770                  -- of a waste, but the code is simple, and the program is
771                  -- wrong anyway!
772
773                  -- DV: why only keepWanted? We make sure that we never float out
774                  -- whatever constraints can yield equalities, including class 
775                  -- constraints with functional dependencies and hence all the derived
776                  -- that were potentially insoluble will be re-generated.
777                  -- (It would not hurt though to just keep the wanted and the derived)
778                  -- See Note [The HasEqualities Predicate] in Inst.lhs
779          
780        ; let all_flats = flats `unionBags` keepWanted insols
781                          
782        ; impls_from_flats <- solveInteractCts $ bagToList all_flats
783
784        -- solve_wanteds iterates when it is able to float equalities 
785        -- out of one or more of the implications. 
786        ; unsolved_implics <- simpl_loop 1 (implics `unionBags` impls_from_flats)
787
788        ; (insoluble_flats,unsolved_flats) <- extractUnsolvedTcS 
789
790        ; bb <- getTcEvBindsMap
791        ; tb <- getTcSTyBindsMap
792
793        ; traceTcS "solveWanteds }" $
794                  vcat [ text "unsolved_flats   =" <+> ppr unsolved_flats
795                       , text "unsolved_implics =" <+> ppr unsolved_implics
796                       , text "current evbinds  =" <+> ppr (evBindMapBinds bb)
797                       , text "current tybinds  =" <+> vcat (map ppr (varEnvElts tb))
798                       ]
799
800        ; (subst, remaining_unsolved_flats) <- solveCTyFunEqs unsolved_flats
801                 -- See Note [Solving Family Equations]
802                 -- NB: remaining_flats has already had subst applied
803
804        ; traceTcS "solveWanteds finished with" $
805                  vcat [ text "remaining_unsolved_flats =" <+> ppr remaining_unsolved_flats
806                       , text "subst =" <+> ppr subst
807                       ]
808
809        ; return $ 
810          (subst, WC { wc_flat  = mapBag (substCt subst) remaining_unsolved_flats
811                     , wc_impl  = mapBag (substImplication subst) unsolved_implics
812                     , wc_insol = mapBag (substCt subst) insoluble_flats })
813        }
814
815 simpl_loop :: Int
816            -> Bag Implication
817            -> TcS (Bag Implication)
818 simpl_loop n implics
819   | n > 10 
820   = traceTcS "solveWanteds: loop!" empty >> return implics
821   | otherwise 
822   = do { (implic_eqs, unsolved_implics) <- solveNestedImplications implics
823
824        ; inerts <- getTcSInerts
825        ; let ((_,unsolved_flats),_) = extractUnsolved inerts
826                                       
827        ; let improve_eqs = implic_eqs
828              -- NB: improve_eqs used to contain defaulting equations HERE but 
829              -- defaulting now happens only at simplifyTop and not deep inside 
830              -- simpl_loop! See Note [Top-level Defaulting Plan]
831              
832        ; traceTcS "solveWanteds: simpl_loop end" $
833              vcat [ text "improve_eqs      =" <+> ppr improve_eqs
834                   , text "unsolved_flats   =" <+> ppr unsolved_flats
835                   , text "unsolved_implics =" <+> ppr unsolved_implics ]
836
837        ; if isEmptyBag improve_eqs then return unsolved_implics 
838          else do { impls_from_eqs <- solveInteractCts $ bagToList improve_eqs
839                  ; simpl_loop (n+1) (unsolved_implics `unionBags` 
840                                                  impls_from_eqs)} }
841
842 solveNestedImplications :: Bag Implication
843                         -> TcS (Cts, Bag Implication)
844 -- Precondition: the TcS inerts may contain unsolved flats which have 
845 -- to be converted to givens before we go inside a nested implication.
846 solveNestedImplications implics
847   | isEmptyBag implics
848   = return (emptyBag, emptyBag)
849   | otherwise 
850   = do { inerts <- getTcSInerts
851        ; traceTcS "solveNestedImplications starting, inerts are:" $ ppr inerts
852          
853        ; let ((_insoluble_flats, unsolved_flats),thinner_inerts) = extractUnsolved inerts 
854        ; traceTcS "solveNestedImplications starting, more info:" $ 
855          vcat [ text "inerts          = " <+> ppr inerts
856               , text "insoluble_flats = " <+> ppr _insoluble_flats
857               , text "unsolved_flats  = " <+> ppr unsolved_flats
858               , text "thinner_inerts  = " <+> ppr thinner_inerts ]
859          
860        ; (implic_eqs, unsolved_implics)
861            <- doWithInert thinner_inerts $ 
862               do { let pushed_givens = givens_from_wanteds unsolved_flats
863                        tcs_untouchables 
864                          = foldr (unionVarSet . tyVarsOfCt) emptyVarSet pushed_givens
865                                           -- Typically pushed_givens is very small, consists
866                                           -- only of unsolved equalities, so no inefficiency 
867                                           -- danger.
868                                                                                     
869                                           
870                  -- See Note [Preparing inert set for implications]
871                  -- Push the unsolved wanteds inwards, but as givens
872                  ; traceTcS "solveWanteds: preparing inerts for implications {" $ 
873                    vcat [ppr tcs_untouchables, ppr pushed_givens]
874                  ; impls_from_givens <- solveInteractCts pushed_givens
875                                         
876                  ; MASSERT (isEmptyBag impls_from_givens)
877                        -- impls_from_givens must be empty, since we are reacting givens
878                        -- with givens, and they can never generate extra implications 
879                        -- from decomposition of ForAll types. (Whereas wanteds can, see
880                        -- TcCanonical, canEq ForAll-ForAll case)
881                    
882                  ; traceTcS "solveWanteds: } now doing nested implications {" empty
883                  ; flatMapBagPairM (solveImplication tcs_untouchables) implics }
884
885        -- ... and we are back in the original TcS inerts 
886        -- Notice that the original includes the _insoluble_flats so it was safe to ignore
887        -- them in the beginning of this function.
888        ; traceTcS "solveWanteds: done nested implications }" $
889                   vcat [ text "implic_eqs ="       <+> ppr implic_eqs
890                        , text "unsolved_implics =" <+> ppr unsolved_implics ]
891
892        ; return (implic_eqs, unsolved_implics) }
893
894   where givens_from_wanteds = foldrBag get_wanted []
895         get_wanted cc rest_givens
896             | pushable_wanted cc
897             = let fl   = ctEvidence cc
898                   gfl  = Given { ctev_gloc = setCtLocOrigin (ctev_wloc fl) UnkSkol
899                                , ctev_evtm = EvId (ctev_evar fl)
900                                , ctev_pred = ctev_pred fl }
901                   this_given = cc { cc_ev = gfl }
902               in this_given : rest_givens
903             | otherwise = rest_givens 
904
905         pushable_wanted :: Ct -> Bool 
906         pushable_wanted cc 
907          | isWantedCt cc 
908          = isEqPred (ctPred cc) -- see Note [Preparing inert set for implications]
909          | otherwise = False 
910
911 solveImplication :: TcTyVarSet     -- Untouchable TcS unification variables
912                  -> Implication    -- Wanted
913                  -> TcS (Cts,      -- All wanted or derived floated equalities: var = type
914                          Bag Implication) -- Unsolved rest (always empty or singleton)
915 -- Precondition: The TcS monad contains an empty worklist and given-only inerts 
916 -- which after trying to solve this implication we must restore to their original value
917 solveImplication tcs_untouchables
918      imp@(Implic { ic_untch  = untch
919                  , ic_binds  = ev_binds
920                  , ic_skols  = skols 
921                  , ic_given  = givens
922                  , ic_wanted = wanteds
923                  , ic_loc    = loc })
924   = shadowIPs givens $    -- See Note [Shadowing of Implicit Parameters]
925     nestImplicTcS ev_binds (untch, tcs_untouchables) $
926     recoverTcS (return (emptyBag, emptyBag)) $
927        -- Recover from nested failures.  Even the top level is
928        -- just a bunch of implications, so failing at the first one is bad
929     do { traceTcS "solveImplication {" (ppr imp) 
930
931          -- Solve flat givens
932        ; impls_from_givens <- solveInteractGiven loc givens 
933        ; MASSERT (isEmptyBag impls_from_givens)
934          
935          -- Simplify the wanteds
936        ; (_flat_subst, 
937            WC { wc_flat = unsolved_flats
938               , wc_impl = unsolved_implics
939               , wc_insol = insols }) <- solve_wanteds wanteds
940           -- NB: Not solveWanteds because we need the derived equalities,            
941           -- which may not be solvable (due to touchability) in this implication
942           -- but may become solvable by spontantenous unification outside. 
943
944        ; let (res_flat_free, res_flat_bound)
945                  = floatEqualities skols givens unsolved_flats
946              final_flat = keepWanted res_flat_bound
947
948        ; let res_wanted = WC { wc_flat  = final_flat
949                              , wc_impl  = unsolved_implics
950                              , wc_insol = insols }
951
952              res_implic = unitImplication $
953                           imp { ic_wanted = res_wanted
954                               , ic_insol  = insolubleWC res_wanted }
955
956        ; evbinds <- getTcEvBindsMap
957
958        ; traceTcS "solveImplication end }" $ vcat
959              [ text "res_flat_free =" <+> ppr res_flat_free
960              , text "implication evbinds = " <+> ppr (evBindMapBinds evbinds)
961              , text "res_implic =" <+> ppr res_implic ]
962
963        ; return (res_flat_free, res_implic) }
964     -- and we are back to the original inerts
965
966
967 floatEqualities :: [TcTyVar] -> [EvVar] -> Cts -> (Cts, Cts)
968 -- Post: The returned FlavoredEvVar's are only Wanted or Derived
969 -- and come from the input wanted ev vars or deriveds 
970 floatEqualities skols can_given wantders
971   | hasEqualities can_given = (emptyBag, wantders)
972           -- Note [Float Equalities out of Implications]
973   | otherwise = partitionBag is_floatable wantders
974   where skol_set = mkVarSet skols
975         is_floatable :: Ct -> Bool
976         is_floatable ct
977           | ct_predty <- ctPred ct
978           , isEqPred ct_predty
979           = skol_set `disjointVarSet` tvs_under_fsks ct_predty
980         is_floatable _ct = False
981
982         tvs_under_fsks :: Type -> TyVarSet
983         -- ^ NB: for type synonyms tvs_under_fsks does /not/ expand the synonym
984         tvs_under_fsks (TyVarTy tv)     
985           | not (isTcTyVar tv)               = unitVarSet tv
986           | FlatSkol ty <- tcTyVarDetails tv = tvs_under_fsks ty
987           | otherwise                        = unitVarSet tv
988         tvs_under_fsks (TyConApp _ tys) = unionVarSets (map tvs_under_fsks tys)
989         tvs_under_fsks (LitTy {})       = emptyVarSet
990         tvs_under_fsks (FunTy arg res)  = tvs_under_fsks arg `unionVarSet` tvs_under_fsks res
991         tvs_under_fsks (AppTy fun arg)  = tvs_under_fsks fun `unionVarSet` tvs_under_fsks arg
992         tvs_under_fsks (ForAllTy tv ty) -- The kind of a coercion binder 
993                                         -- can mention type variables!
994           | isTyVar tv                = inner_tvs `delVarSet` tv
995           | otherwise  {- Coercion -} = -- ASSERT( not (tv `elemVarSet` inner_tvs) )
996                                         inner_tvs `unionVarSet` tvs_under_fsks (tyVarKind tv)
997           where
998             inner_tvs = tvs_under_fsks ty
999
1000 shadowIPs :: [EvVar] -> TcS a -> TcS a
1001 shadowIPs gs m
1002   | null shadowed = m
1003   | otherwise     = do is <- getTcSInerts
1004                        doWithInert (purgeShadowed is) m
1005   where
1006   shadowed  = mapMaybe isIP gs
1007
1008   isIP g    = do p <- evVarPred_maybe g
1009                  (x,_) <- isIPPred_maybe p
1010                  return x
1011
1012   isShadowedCt ct = isShadowedEv (ctEvidence ct)
1013   isShadowedEv ev = case isIPPred_maybe (ctEvPred ev) of
1014                       Just (x,_) -> x `elem` shadowed
1015                       _          -> False
1016
1017   purgeShadowed is = is { inert_cans = purgeCans (inert_cans is)
1018                         , inert_solved = purgeSolved (inert_solved is)
1019                         }
1020
1021   purgeDicts    = snd . partitionCCanMap isShadowedCt
1022   purgeCans ics = ics { inert_dicts = purgeDicts (inert_dicts ics) }
1023   purgeSolved   = filterSolved (not . isShadowedEv)
1024 \end{code}
1025
1026 Note [Preparing inert set for implications]
1027 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1028 Before solving the nested implications, we convert any unsolved flat wanteds
1029 to givens, and add them to the inert set.  Reasons:
1030
1031   a) In checking mode, suppresses unnecessary errors.  We already have
1032      on unsolved-wanted error; adding it to the givens prevents any 
1033      consequential errors from showing up
1034
1035   b) More importantly, in inference mode, we are going to quantify over this
1036      constraint, and we *don't* want to quantify over any constraints that
1037      are deducible from it.
1038
1039   c) Flattened type-family equalities must be exposed to the nested
1040      constraints.  Consider
1041         F b ~ alpha, (forall c.  F b ~ alpha)
1042      Obviously this is soluble with [alpha := F b].  But the
1043      unification is only done by solveCTyFunEqs, right at the end of
1044      solveWanteds, and if we aren't careful we'll end up with an
1045      unsolved goal inside the implication.  We need to "push" the
1046      as-yes-unsolved (F b ~ alpha) inwards, as a *given*, so that it
1047      can be used to solve the inner (F b
1048      ~ alpha).  See Trac #4935.
1049
1050   d) There are other cases where interactions between wanteds that can help
1051      to solve a constraint. For example
1052
1053         class C a b | a -> b
1054
1055         (C Int alpha), (forall d. C d blah => C Int a)
1056
1057      If we push the (C Int alpha) inwards, as a given, it can produce
1058      a fundep (alpha~a) and this can float out again and be used to
1059      fix alpha.  (In general we can't float class constraints out just
1060      in case (C d blah) might help to solve (C Int a).)
1061
1062 The unsolved wanteds are *canonical* but they may not be *inert*,
1063 because when made into a given they might interact with other givens.
1064 Hence the call to solveInteract.  Example:
1065
1066  Original inert set = (d :_g D a) /\ (co :_w  a ~ [beta]) 
1067
1068 We were not able to solve (a ~w [beta]) but we can't just assume it as
1069 given because the resulting set is not inert. Hence we have to do a
1070 'solveInteract' step first. 
1071
1072 Finally, note that we convert them to [Given] and NOT [Given/Solved].
1073 The reason is that Given/Solved are weaker than Givens and may be discarded.
1074 As an example consider the inference case, where we may have, the following 
1075 original constraints: 
1076      [Wanted] F Int ~ Int
1077              (F Int ~ a => F Int ~ a)
1078 If we convert F Int ~ Int to [Given/Solved] instead of Given, then the next 
1079 given (F Int ~ a) is going to cause the Given/Solved to be ignored, casting 
1080 the (F Int ~ a) insoluble. Hence we should really convert the residual 
1081 wanteds to plain old Given. 
1082
1083 We need only push in unsolved equalities both in checking mode and inference mode: 
1084
1085   (1) In checking mode we should not push given dictionaries in because of
1086 example LongWayOverlapping.hs, where we might get strange overlap
1087 errors between far-away constraints in the program.  But even in
1088 checking mode, we must still push type family equations. Consider:
1089
1090    type instance F True a b = a 
1091    type instance F False a b = b
1092
1093    [w] F c a b ~ gamma 
1094    (c ~ True) => a ~ gamma 
1095    (c ~ False) => b ~ gamma
1096
1097 Since solveCTyFunEqs happens at the very end of solving, the only way to solve
1098 the two implications is temporarily consider (F c a b ~ gamma) as Given (NB: not 
1099 merely Given/Solved because it has to interact with the top-level instance 
1100 environment) and push it inside the implications. Now, when we come out again at
1101 the end, having solved the implications solveCTyFunEqs will solve this equality.
1102
1103   (2) In inference mode, we recheck the final constraint in checking mode and
1104 hence we will be able to solve inner implications from top-level quantified
1105 constraints nonetheless.
1106
1107
1108 Note [Extra TcsTv untouchables]
1109 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1110
1111 Whenever we are solving a bunch of flat constraints, they may contain 
1112 the following sorts of 'touchable' unification variables:
1113    
1114    (i)   Born-touchables in that scope
1115  
1116    (ii)  Simplifier-generated unification variables, such as unification 
1117          flatten variables
1118
1119    (iii) Touchables that have been floated out from some nested 
1120          implications, see Note [Float Equalities out of Implications]. 
1121
1122 Now, once we are done with solving these flats and have to move inwards to 
1123 the nested implications (perhaps for a second time), we must consider all the
1124 extra variables (categories (ii) and (iii) above) as untouchables for the 
1125 implication. Otherwise we have the danger or double unifications, as well
1126 as the danger of not ``seing'' some unification. Example (from Trac #4494):
1127
1128    (F Int ~ uf)  /\  [untch=beta](forall a. C a => F Int ~ beta) 
1129
1130 In this example, beta is touchable inside the implication. The 
1131 first solveInteract step leaves 'uf' ununified. Then we move inside 
1132 the implication where a new constraint
1133        uf  ~  beta  
1134 emerges. We may spontaneously solve it to get uf := beta, so the whole
1135 implication disappears but when we pop out again we are left with (F
1136 Int ~ uf) which will be unified by our final solveCTyFunEqs stage and
1137 uf will get unified *once more* to (F Int).
1138
1139 The solution is to record the unification variables of the flats, 
1140 and make them untouchables for the nested implication. In the 
1141 example above uf would become untouchable, so beta would be forced 
1142 to be unified as beta := uf.
1143
1144 Note [Float Equalities out of Implications]
1145 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
1146 For ordinary pattern matches (including existentials) we float 
1147 equalities out of implications, for instance: 
1148      data T where 
1149        MkT :: Eq a => a -> T 
1150      f x y = case x of MkT _ -> (y::Int)
1151 We get the implication constraint (x::T) (y::alpha): 
1152      forall a. [untouchable=alpha] Eq a => alpha ~ Int
1153 We want to float out the equality into a scope where alpha is no
1154 longer untouchable, to solve the implication!  
1155
1156 But we cannot float equalities out of implications whose givens may
1157 yield or contain equalities:
1158
1159       data T a where 
1160         T1 :: T Int
1161         T2 :: T Bool
1162         T3 :: T a 
1163         
1164       h :: T a -> a -> Int
1165       
1166       f x y = case x of 
1167                 T1 -> y::Int
1168                 T2 -> y::Bool
1169                 T3 -> h x y
1170
1171 We generate constraint, for (x::T alpha) and (y :: beta): 
1172    [untouchables = beta] (alpha ~ Int => beta ~ Int)   -- From 1st branch
1173    [untouchables = beta] (alpha ~ Bool => beta ~ Bool) -- From 2nd branch
1174    (alpha ~ beta)                                      -- From 3rd branch 
1175
1176 If we float the equality (beta ~ Int) outside of the first implication and 
1177 the equality (beta ~ Bool) out of the second we get an insoluble constraint.
1178 But if we just leave them inside the implications we unify alpha := beta and
1179 solve everything.
1180
1181 Principle: 
1182     We do not want to float equalities out which may need the given *evidence*
1183     to become soluble.
1184
1185 Consequence: classes with functional dependencies don't matter (since there is 
1186 no evidence for a fundep equality), but equality superclasses do matter (since 
1187 they carry evidence).
1188
1189 Notice that, due to Note [Extra TcSTv Untouchables], the free unification variables 
1190 of an equality that is floated out of an implication become effectively untouchables
1191 for the leftover implication. This is absolutely necessary. Consider the following 
1192 example. We start with two implications and a class with a functional dependency. 
1193
1194 class C x y | x -> y
1195 instance C [a] [a]
1196       
1197 (I1)      [untch=beta]forall b. 0 => F Int ~ [beta]
1198 (I2)      [untch=beta]forall b. 0 => F Int ~ [[alpha]] /\ C beta [b]
1199
1200 We float (F Int ~ [beta]) out of I1, and we float (F Int ~ [[alpha]]) out of I2. 
1201 They may react to yield that (beta := [alpha]) which can then be pushed inwards 
1202 the leftover of I2 to get (C [alpha] [a]) which, using the FunDep, will mean that
1203 (alpha := a). In the end we will have the skolem 'b' escaping in the untouchable
1204 beta! Concrete example is in indexed_types/should_fail/ExtraTcsUntch.hs:
1205
1206 class C x y | x -> y where 
1207  op :: x -> y -> ()
1208
1209 instance C [a] [a]
1210
1211 type family F a :: *
1212
1213 h :: F Int -> ()
1214 h = undefined
1215
1216 data TEx where 
1217   TEx :: a -> TEx 
1218
1219
1220 f (x::beta) = 
1221     let g1 :: forall b. b -> ()
1222         g1 _ = h [x]
1223         g2 z = case z of TEx y -> (h [[undefined]], op x [y])
1224     in (g1 '3', g2 undefined)
1225
1226 Note [Shadowing of Implicit Parameters]
1227 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1228 Consider the following example:
1229
1230 f :: (?x :: Char) => Char
1231 f = let ?x = 'a' in ?x
1232
1233 The "let ?x = ..." generates an implication constraint of the form:
1234
1235 ?x :: Char => ?x :: Char
1236
1237
1238 Furthermore, the signature for `f` also generates an implication
1239 constraint, so we end up with the following nested implication:
1240
1241 ?x :: Char => (?x :: Char => ?x :: Char)
1242
1243 Note that the wanted (?x :: Char) constraint may be solved in
1244 two incompatible ways:  either by using the parameter from the
1245 signature, or by using the local definition.  Our intention is
1246 that the local definition should "shadow" the parameter of the
1247 signature, and we implement this as follows: when we nest implications,
1248 we remove any implicit parameters in the outer implication, that
1249 have the same name as givens of the inner implication.
1250
1251 Here is another variation of the example:
1252
1253 f :: (?x :: Int) => Char
1254 f = let ?x = 'x' in ?x
1255
1256 This program should also be accepted: the two constraints `?x :: Int`
1257 and `?x :: Char` never exist in the same context, so they don't get to
1258 interact to cause failure.
1259 \begin{code}
1260
1261 solveCTyFunEqs :: Cts -> TcS (TvSubst, Cts)
1262 -- Default equalities (F xi ~ alpha) by setting (alpha := F xi), whenever possible
1263 -- See Note [Solving Family Equations]
1264 -- Returns: a bunch of unsolved constraints from the original Cts and implications
1265 --          where the newly generated equalities (alpha := F xi) have been substituted through.
1266 solveCTyFunEqs cts
1267  = do { untch   <- getUntouchables 
1268       ; let (unsolved_can_cts, (ni_subst, cv_binds))
1269                 = getSolvableCTyFunEqs untch cts
1270       ; traceTcS "defaultCTyFunEqs" (vcat [text "Trying to default family equations:"
1271                                           , ppr ni_subst, ppr cv_binds
1272                                           ])
1273       ; mapM_ solve_one cv_binds
1274
1275       ; return (niFixTvSubst ni_subst, unsolved_can_cts) }
1276   where
1277     solve_one (Wanted { ctev_evar = cv }, tv, ty) 
1278       = setWantedTyBind tv ty >> setEvBind cv (EvCoercion (mkTcReflCo ty))
1279     solve_one (Derived {}, tv, ty)
1280       = setWantedTyBind tv ty
1281     solve_one arg
1282       = pprPanic "solveCTyFunEqs: can't solve a /given/ family equation!" $ ppr arg
1283 ------------
1284 type FunEqBinds = (TvSubstEnv, [(CtEvidence, TcTyVar, TcType)])
1285   -- The TvSubstEnv is not idempotent, but is loop-free
1286   -- See Note [Non-idempotent substitution] in Unify
1287 emptyFunEqBinds :: FunEqBinds
1288 emptyFunEqBinds = (emptyVarEnv, [])
1289
1290 extendFunEqBinds :: FunEqBinds -> CtEvidence -> TcTyVar -> TcType -> FunEqBinds
1291 extendFunEqBinds (tv_subst, cv_binds) fl tv ty
1292   = (extendVarEnv tv_subst tv ty, (fl, tv, ty):cv_binds)
1293
1294 ------------
1295 getSolvableCTyFunEqs :: TcsUntouchables
1296                      -> Cts                -- Precondition: all Wanteds or Derived!
1297                      -> (Cts, FunEqBinds)  -- Postcondition: returns the unsolvables
1298 getSolvableCTyFunEqs untch cts
1299   = Bag.foldlBag dflt_funeq (emptyCts, emptyFunEqBinds) cts
1300   where
1301     dflt_funeq :: (Cts, FunEqBinds) -> Ct
1302                -> (Cts, FunEqBinds)
1303     dflt_funeq (cts_in, feb@(tv_subst, _))
1304                (CFunEqCan { cc_ev = fl
1305                           , cc_fun = tc
1306                           , cc_tyargs = xis
1307                           , cc_rhs = xi })
1308       | Just tv <- tcGetTyVar_maybe xi      -- RHS is a type variable
1309
1310       , isTouchableMetaTyVar_InRange untch tv
1311            -- And it's a *touchable* unification variable
1312
1313       , typeKind xi `tcIsSubKind` tyVarKind tv
1314          -- Must do a small kind check since TcCanonical invariants 
1315          -- on family equations only impose compatibility, not subkinding
1316
1317       , not (tv `elemVarEnv` tv_subst)
1318            -- Check not in extra_binds
1319            -- See Note [Solving Family Equations], Point 1
1320
1321       , not (tv `elemVarSet` niSubstTvSet tv_subst (tyVarsOfTypes xis))
1322            -- Occurs check: see Note [Solving Family Equations], Point 2
1323       = ASSERT ( not (isGiven fl) )
1324         (cts_in, extendFunEqBinds feb fl tv (mkTyConApp tc xis))
1325
1326     dflt_funeq (cts_in, fun_eq_binds) ct
1327       = (cts_in `extendCts` ct, fun_eq_binds)
1328 \end{code}
1329
1330 Note [Solving Family Equations] 
1331 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
1332 After we are done with simplification we may be left with constraints of the form:
1333      [Wanted] F xis ~ beta 
1334 If 'beta' is a touchable unification variable not already bound in the TyBinds 
1335 then we'd like to create a binding for it, effectively "defaulting" it to be 'F xis'.
1336
1337 When is it ok to do so? 
1338     1) 'beta' must not already be defaulted to something. Example: 
1339
1340            [Wanted] F Int  ~ beta   <~ Will default [beta := F Int]
1341            [Wanted] F Char ~ beta   <~ Already defaulted, can't default again. We 
1342                                        have to report this as unsolved.
1343
1344     2) However, we must still do an occurs check when defaulting (F xis ~ beta), to 
1345        set [beta := F xis] only if beta is not among the free variables of xis.
1346
1347     3) Notice that 'beta' can't be bound in ty binds already because we rewrite RHS 
1348        of type family equations. See Inert Set invariants in TcInteract. 
1349
1350
1351 *********************************************************************************
1352 *                                                                               * 
1353 *                          Defaulting and disamgiguation                        *
1354 *                                                                               *
1355 *********************************************************************************
1356 \begin{code}
1357 applyDefaultingRules :: Cts      -- All wanteds
1358                      -> TcS Cts  -- All wanteds again!
1359 -- Return some *extra* givens, which express the 
1360 -- type-class-default choice
1361 applyDefaultingRules wanteds
1362   | isEmptyBag wanteds 
1363   = return emptyBag
1364   | otherwise
1365   = do { traceTcS "applyDefaultingRules { " $ 
1366                   text "wanteds =" <+> ppr wanteds
1367                   
1368        ; info@(default_tys, _) <- getDefaultInfo
1369        ; let groups = findDefaultableGroups info wanteds
1370        ; traceTcS "findDefaultableGroups" $ vcat [ text "groups=" <+> ppr groups
1371                                                  , text "info=" <+> ppr info ]
1372        ; deflt_cts <- mapM (disambigGroup default_tys) groups
1373
1374        ; traceTcS "applyDefaultingRules }" $ 
1375                   vcat [ text "Type defaults =" <+> ppr deflt_cts]
1376
1377        ; return (unionManyBags deflt_cts) }
1378 \end{code}
1379
1380 Note [tryTcS in defaulting]
1381 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
1382
1383 defaultTyVar and disambigGroup create new evidence variables for
1384 default equations, and hence update the EvVar cache. However, after
1385 applyDefaultingRules we will try to solve these default equations
1386 using solveInteractCts, which will consult the cache and solve those
1387 EvVars from themselves! That's wrong.
1388
1389 To avoid this problem we guard defaulting under a @tryTcS@ which leaves
1390 the original cache unmodified.
1391
1392 There is a second reason for @tryTcS@ in defaulting: disambGroup does
1393 some constraint solving to determine if a default equation is
1394 ``useful'' in solving some wanted constraints, but we want to
1395 discharge all evidence and unifications that may have happened during
1396 this constraint solving.
1397
1398 Finally, @tryTcS@ importantly does not inherit the original cache from
1399 the higher level but makes up a new cache, the reason is that disambigGroup
1400 will call solveInteractCts so the new derived and the wanteds must not be 
1401 in the cache!
1402
1403
1404 \begin{code}
1405 ------------------
1406 touchablesOfWC :: WantedConstraints -> TcTyVarSet
1407 -- See Note [Extra Tcs Untouchables] to see why we carry a TcsUntouchables 
1408 -- instead of just using the Untouchable range have in our hands.
1409 touchablesOfWC = go (NoUntouchables, emptyVarSet)
1410   where go :: TcsUntouchables -> WantedConstraints -> TcTyVarSet
1411         go untch (WC { wc_flat = flats, wc_impl = impls }) 
1412           = filterVarSet is_touchable flat_tvs `unionVarSet`
1413               foldrBag (unionVarSet . (go_impl $ untch_for_impls untch)) emptyVarSet impls 
1414           where is_touchable = isTouchableMetaTyVar_InRange untch
1415                 flat_tvs = tyVarsOfCts flats
1416                 untch_for_impls (r,uset) = (r, uset `unionVarSet` flat_tvs)
1417         go_impl (_rng,set) implic = go (ic_untch implic,set) (ic_wanted implic)
1418
1419 applyTyVarDefaulting :: WantedConstraints -> TcM Cts
1420 applyTyVarDefaulting wc = runTcS do_dflt >>= (return . fst)
1421   where do_dflt = do { tv_cts <- mapM defaultTyVar $ 
1422                                  varSetElems (touchablesOfWC wc)
1423                      ; return (unionManyBags tv_cts) }
1424
1425 defaultTyVar :: TcTyVar -> TcS Cts
1426 -- Precondition: a touchable meta-variable
1427 defaultTyVar the_tv
1428   | not (k `eqKind` default_k)
1429   -- Why tryTcS? See Note [tryTcS in defaulting]
1430   = tryTcS $
1431     do { let loc = CtLoc DefaultOrigin (getSrcSpan the_tv) [] -- Yuk
1432        ; ty_k <- instFlexiTcSHelperTcS (tyVarName the_tv) default_k
1433        ; md <- newDerived loc (mkTcEqPred (mkTyVarTy the_tv) ty_k)
1434              -- Why not directly newDerived loc (mkTcEqPred k default_k)? 
1435              -- See Note [DefaultTyVar]
1436        ; let cts
1437               | Just der_ev <- md = [mkNonCanonical der_ev]
1438               | otherwise = []
1439        
1440        ; implics_from_defaulting <- solveInteractCts cts
1441        ; MASSERT (isEmptyBag implics_from_defaulting)
1442          
1443        ; (_,unsolved) <- extractUnsolvedTcS
1444        ; if isEmptyBag (keepWanted unsolved) then return (listToBag cts)
1445          else return emptyBag }
1446   | otherwise = return emptyBag  -- The common case
1447   where
1448     k = tyVarKind the_tv
1449     default_k = defaultKind k
1450 \end{code}
1451
1452 Note [DefaultTyVar]
1453 ~~~~~~~~~~~~~~~~~~~
1454 defaultTyVar is used on any un-instantiated meta type variables to
1455 default the kind of OpenKind and ArgKind etc to *.  This is important 
1456 to ensure that instance declarations match.  For example consider
1457
1458      instance Show (a->b)
1459      foo x = show (\_ -> True)
1460
1461 Then we'll get a constraint (Show (p ->q)) where p has kind ArgKind,
1462 and that won't match the typeKind (*) in the instance decl.  See tests
1463 tc217 and tc175.
1464
1465 We look only at touchable type variables. No further constraints
1466 are going to affect these type variables, so it's time to do it by
1467 hand.  However we aren't ready to default them fully to () or
1468 whatever, because the type-class defaulting rules have yet to run.
1469
1470 An important point is that if the type variable tv has kind k and the
1471 default is default_k we do not simply generate [D] (k ~ default_k) because:
1472
1473    (1) k may be ArgKind and default_k may be * so we will fail
1474
1475    (2) We need to rewrite all occurrences of the tv to be a type
1476        variable with the right kind and we choose to do this by rewriting 
1477        the type variable /itself/ by a new variable which does have the 
1478        right kind.
1479
1480 \begin{code}
1481
1482
1483 ----------------
1484 findDefaultableGroups 
1485     :: ( [Type]
1486        , (Bool,Bool) )  -- (Overloaded strings, extended default rules)
1487     -> Cts      -- Unsolved
1488     -> [[(Ct,TcTyVar)]]
1489 findDefaultableGroups (default_tys, (ovl_strings, extended_defaults)) wanteds
1490   | null default_tys             = []
1491   | otherwise = filter is_defaultable_group (equivClasses cmp_tv unaries)
1492   where 
1493     unaries     :: [(Ct, TcTyVar)]  -- (C tv) constraints
1494     non_unaries :: [Ct]             -- and *other* constraints
1495     
1496     (unaries, non_unaries) = partitionWith find_unary (bagToList wanteds)
1497         -- Finds unary type-class constraints
1498     find_unary cc@(CDictCan { cc_tyargs = [ty] })
1499         | Just tv <- tcGetTyVar_maybe ty
1500         = Left (cc, tv)
1501     find_unary cc = Right cc  -- Non unary or non dictionary 
1502
1503     bad_tvs :: TcTyVarSet  -- TyVars mentioned by non-unaries 
1504     bad_tvs = foldr (unionVarSet . tyVarsOfCt) emptyVarSet non_unaries 
1505
1506     cmp_tv (_,tv1) (_,tv2) = tv1 `compare` tv2
1507
1508     is_defaultable_group ds@((_,tv):_)
1509         = let b1 = isTyConableTyVar tv  -- Note [Avoiding spurious errors]
1510               b2 = not (tv `elemVarSet` bad_tvs)
1511               b4 = defaultable_classes [cc_class cc | (cc,_) <- ds]
1512           in (b1 && b2 && b4)
1513     is_defaultable_group [] = panic "defaultable_group"
1514
1515     defaultable_classes clss 
1516         | extended_defaults = any isInteractiveClass clss
1517         | otherwise         = all is_std_class clss && (any is_num_class clss)
1518
1519     -- In interactive mode, or with -XExtendedDefaultRules,
1520     -- we default Show a to Show () to avoid graututious errors on "show []"
1521     isInteractiveClass cls 
1522         = is_num_class cls || (classKey cls `elem` [showClassKey, eqClassKey, ordClassKey])
1523
1524     is_num_class cls = isNumericClass cls || (ovl_strings && (cls `hasKey` isStringClassKey))
1525     -- is_num_class adds IsString to the standard numeric classes, 
1526     -- when -foverloaded-strings is enabled
1527
1528     is_std_class cls = isStandardClass cls || (ovl_strings && (cls `hasKey` isStringClassKey))
1529     -- Similarly is_std_class
1530
1531 ------------------------------
1532 disambigGroup :: [Type]           -- The default types 
1533               -> [(Ct, TcTyVar)]  -- All classes of the form (C a)
1534                                   --  sharing same type variable
1535               -> TcS Cts
1536
1537 disambigGroup []  _grp
1538   = return emptyBag
1539 disambigGroup (default_ty:default_tys) group
1540   = do { traceTcS "disambigGroup" (ppr group $$ ppr default_ty)
1541        ; success <- tryTcS $ -- Why tryTcS? See Note [tryTcS in defaulting]
1542                     do { derived_eq <- tryTcS $ 
1543                        -- I need a new tryTcS because we will call solveInteractCts below!
1544                             do { md <- newDerived (ctev_wloc the_fl) 
1545                                                   (mkTcEqPred (mkTyVarTy the_tv) default_ty)
1546                                                   -- ctev_wloc because constraint is not Given!
1547                                ; case md of 
1548                                     Nothing   -> return []
1549                                     Just ctev -> return [ mkNonCanonical ctev ] }
1550                             
1551                        ; traceTcS "disambigGroup (solving) {" $
1552                          text "trying to solve constraints along with default equations ..."
1553                        ; implics_from_defaulting <- 
1554                                     solveInteractCts (derived_eq ++ wanteds)
1555                        ; MASSERT (isEmptyBag implics_from_defaulting)
1556                            -- I am not certain if any implications can be generated
1557                            -- but I am letting this fail aggressively if this ever happens.
1558                                      
1559                        ; (_,unsolved) <- extractUnsolvedTcS 
1560                        ; traceTcS "disambigGroup (solving) }" $
1561                          text "disambigGroup unsolved =" <+> ppr (keepWanted unsolved)
1562                        ; if isEmptyBag (keepWanted unsolved) then -- Don't care about Derived's
1563                              return (Just $ listToBag derived_eq) 
1564                          else 
1565                              return Nothing 
1566                        }
1567        ; case success of
1568            Just cts -> -- Success: record the type variable binding, and return
1569                     do { wrapWarnTcS $ warnDefaulting wanteds default_ty
1570                        ; traceTcS "disambigGroup succeeded" (ppr default_ty)
1571                        ; return cts }
1572            Nothing -> -- Failure: try with the next type
1573                     do { traceTcS "disambigGroup failed, will try other default types"
1574                                   (ppr default_ty)
1575                        ; disambigGroup default_tys group } }
1576   where
1577     ((the_ct,the_tv):_) = group
1578     the_fl              = cc_ev the_ct
1579     wanteds             = map fst group
1580 \end{code}
1581
1582 Note [Avoiding spurious errors]
1583 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1584 When doing the unification for defaulting, we check for skolem
1585 type variables, and simply don't default them.  For example:
1586    f = (*)      -- Monomorphic
1587    g :: Num a => a -> a
1588    g x = f x x
1589 Here, we get a complaint when checking the type signature for g,
1590 that g isn't polymorphic enough; but then we get another one when
1591 dealing with the (Num a) context arising from f's definition;
1592 we try to unify a with Int (to default it), but find that it's
1593 already been unified with the rigid variable from g's type sig
1594
1595
1596
1597 *********************************************************************************
1598 *                                                                               * 
1599 *                   Utility functions
1600 *                                                                               *
1601 *********************************************************************************
1602
1603 \begin{code}
1604 newFlatWanteds :: CtOrigin -> ThetaType -> TcM [Ct]
1605 newFlatWanteds orig theta
1606   = do { loc <- getCtLoc orig
1607        ; mapM (inst_to_wanted loc) theta }
1608   where 
1609     inst_to_wanted loc pty 
1610           = do { v <- TcMType.newWantedEvVar pty 
1611                ; return $ 
1612                  CNonCanonical { cc_ev = Wanted { ctev_evar = v
1613                                                 , ctev_wloc = loc
1614                                                 , ctev_pred = pty }
1615                                , cc_depth = 0 } }
1616 \end{code}