de60fcb6859ddc3bf262f0853165eaa6320b53c8
[ghc.git] / compiler / typecheck / TcPat.lhs
1 %
2 % (c) The University of Glasgow 2006
3 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
4 %
5
6 TcPat: Typechecking patterns
7
8 \begin{code}
9 {-# LANGUAGE CPP, RankNTypes #-}
10
11 module TcPat ( tcLetPat, TcSigFun, TcPragFun
12              , TcSigInfo(..), TcPatSynInfo(..)
13              , findScopedTyVars
14              , LetBndrSpec(..), addInlinePrags, warnPrags
15              , tcPat, tcPats, newNoSigLetBndr
16              , addDataConStupidTheta, badFieldCon, polyPatSig ) where
17
18 #include "HsVersions.h"
19
20 import {-# SOURCE #-}   TcExpr( tcSyntaxOp, tcInferRho)
21
22 import HsSyn
23 import TcHsSyn
24 import TcRnMonad
25 import Inst
26 import Id
27 import Var
28 import Name
29 import NameSet
30 import TcEnv
31 --import TcExpr
32 import TcMType
33 import TcValidity( arityErr )
34 import TcType
35 import TcUnify
36 import TcHsType
37 import TysWiredIn
38 import TcEvidence
39 import TyCon
40 import DataCon
41 import PatSyn
42 import ConLike
43 import PrelNames
44 import BasicTypes hiding (SuccessFlag(..))
45 import DynFlags
46 import SrcLoc
47 import Util
48 import Outputable
49 import FastString
50 import Control.Monad
51 \end{code}
52
53
54 %************************************************************************
55 %*                                                                      *
56                 External interface
57 %*                                                                      *
58 %************************************************************************
59
60 \begin{code}
61 tcLetPat :: TcSigFun -> LetBndrSpec
62          -> LPat Name -> TcSigmaType
63          -> TcM a
64          -> TcM (LPat TcId, a)
65 tcLetPat sig_fn no_gen pat pat_ty thing_inside
66   = tc_lpat pat pat_ty penv thing_inside
67   where
68     penv = PE { pe_lazy = True
69               , pe_ctxt = LetPat sig_fn no_gen }
70
71 -----------------
72 tcPats :: HsMatchContext Name
73        -> [LPat Name]            -- Patterns,
74        -> [TcSigmaType]          --   and their types
75        -> TcM a                  --   and the checker for the body
76        -> TcM ([LPat TcId], a)
77
78 -- This is the externally-callable wrapper function
79 -- Typecheck the patterns, extend the environment to bind the variables,
80 -- do the thing inside, use any existentially-bound dictionaries to
81 -- discharge parts of the returning LIE, and deal with pattern type
82 -- signatures
83
84 --   1. Initialise the PatState
85 --   2. Check the patterns
86 --   3. Check the body
87 --   4. Check that no existentials escape
88
89 tcPats ctxt pats pat_tys thing_inside
90   = tc_lpats penv pats pat_tys thing_inside
91   where
92     penv = PE { pe_lazy = False, pe_ctxt = LamPat ctxt }
93
94 tcPat :: HsMatchContext Name
95       -> LPat Name -> TcSigmaType
96       -> TcM a                 -- Checker for body, given
97                                -- its result type
98       -> TcM (LPat TcId, a)
99 tcPat ctxt pat pat_ty thing_inside
100   = tc_lpat pat pat_ty penv thing_inside
101   where
102     penv = PE { pe_lazy = False, pe_ctxt = LamPat ctxt }
103
104
105 -----------------
106 data PatEnv
107   = PE { pe_lazy :: Bool        -- True <=> lazy context, so no existentials allowed
108        , pe_ctxt :: PatCtxt     -- Context in which the whole pattern appears
109        }
110
111 data PatCtxt
112   = LamPat   -- Used for lambdas, case etc
113        (HsMatchContext Name)
114
115   | LetPat   -- Used only for let(rec) pattern bindings
116              -- See Note [Typing patterns in pattern bindings]
117        TcSigFun        -- Tells type sig if any
118        LetBndrSpec     -- True <=> no generalisation of this let
119
120 data LetBndrSpec
121   = LetLclBndr            -- The binder is just a local one;
122                           -- an AbsBinds will provide the global version
123
124   | LetGblBndr TcPragFun  -- Genrealisation plan is NoGen, so there isn't going
125                           -- to be an AbsBinds; So we must bind the global version
126                           -- of the binder right away.
127                           -- Oh, and dhhere is the inline-pragma information
128
129 makeLazy :: PatEnv -> PatEnv
130 makeLazy penv = penv { pe_lazy = True }
131
132 inPatBind :: PatEnv -> Bool
133 inPatBind (PE { pe_ctxt = LetPat {} }) = True
134 inPatBind (PE { pe_ctxt = LamPat {} }) = False
135
136 ---------------
137 type TcPragFun = Name -> [LSig Name]
138 type TcSigFun  = Name -> Maybe TcSigInfo
139
140 data TcSigInfo
141   = TcSigInfo {
142         sig_id     :: TcId,         --  *Polymorphic* binder for this value...
143
144         sig_tvs    :: [(Maybe Name, TcTyVar)],
145                            -- Instantiated type and kind variables
146                            -- Just n <=> this skolem is lexically in scope with name n
147                            -- See Note [Binding scoped type variables]
148
149         sig_theta  :: TcThetaType,  -- Instantiated theta
150
151         sig_tau    :: TcSigmaType,  -- Instantiated tau
152                                     -- See Note [sig_tau may be polymorphic]
153
154         sig_loc    :: SrcSpan       -- The location of the signature
155     }
156   | TcPatSynInfo TcPatSynInfo
157
158 data TcPatSynInfo
159   = TPSI {
160         patsig_name  :: Name,
161         patsig_tau   :: TcSigmaType,
162         patsig_ex    :: [TcTyVar],
163         patsig_prov  :: TcThetaType,
164         patsig_univ  :: [TcTyVar],
165         patsig_req   :: TcThetaType
166     }
167
168 findScopedTyVars  -- See Note [Binding scoped type variables]
169   :: LHsType Name             -- The HsType
170   -> TcType                   -- The corresponding Type:
171                               --   uses same Names as the HsType
172   -> [TcTyVar]                -- The instantiated forall variables of the Type
173   -> [(Maybe Name, TcTyVar)]  -- In 1-1 correspondence with the instantiated vars
174 findScopedTyVars hs_ty sig_ty inst_tvs
175   = zipWith find sig_tvs inst_tvs
176   where
177     find sig_tv inst_tv
178       | tv_name `elemNameSet` scoped_names = (Just tv_name, inst_tv)
179       | otherwise                          = (Nothing,      inst_tv)
180       where
181         tv_name = tyVarName sig_tv
182
183     scoped_names = mkNameSet (hsExplicitTvs hs_ty)
184     (sig_tvs,_)  = tcSplitForAllTys sig_ty
185
186 instance NamedThing TcSigInfo where
187     getName TcSigInfo{ sig_id = id } = idName id
188     getName (TcPatSynInfo tpsi) = patsig_name tpsi
189
190 instance Outputable TcSigInfo where
191     ppr (TcSigInfo { sig_id = id, sig_tvs = tyvars, sig_theta = theta, sig_tau = tau})
192         = ppr id <+> dcolon <+> vcat [ pprSigmaType (mkSigmaTy (map snd tyvars) theta tau)
193                                      , ppr (map fst tyvars) ]
194     ppr (TcPatSynInfo tpsi) = text "TcPatSynInfo" <+> ppr tpsi
195
196 instance Outputable TcPatSynInfo where
197     ppr (TPSI{ patsig_name = name}) = ppr name
198
199 \end{code}
200
201 Note [Binding scoped type variables]
202 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
203 The type variables *brought into lexical scope* by a type signature may
204 be a subset of the *quantified type variables* of the signatures, for two reasons:
205
206 * With kind polymorphism a signature like
207     f :: forall f a. f a -> f a
208   may actually give rise to
209     f :: forall k. forall (f::k -> *) (a:k). f a -> f a
210   So the sig_tvs will be [k,f,a], but only f,a are scoped.
211   NB: the scoped ones are not necessarily the *inital* ones!
212
213 * Even aside from kind polymorphism, tere may be more instantiated
214   type variables than lexically-scoped ones.  For example:
215         type T a = forall b. b -> (a,b)
216         f :: forall c. T c
217   Here, the signature for f will have one scoped type variable, c,
218   but two instantiated type variables, c' and b'.
219
220 The function findScopedTyVars takes
221   * hs_ty:    the original HsForAllTy
222   * sig_ty:   the corresponding Type (which is guaranteed to use the same Names
223               as the HsForAllTy)
224   * inst_tvs: the skolems instantiated from the forall's in sig_ty
225 It returns a [(Maybe Name, TcTyVar)], in 1-1 correspondence with inst_tvs
226 but with a (Just n) for the lexically scoped name of each in-scope tyvar.
227
228 Note [sig_tau may be polymorphic]
229 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
230 Note that "sig_tau" might actually be a polymorphic type,
231 if the original function had a signature like
232    forall a. Eq a => forall b. Ord b => ....
233 But that's ok: tcMatchesFun (called by tcRhs) can deal with that
234 It happens, too!  See Note [Polymorphic methods] in TcClassDcl.
235
236 Note [Existential check]
237 ~~~~~~~~~~~~~~~~~~~~~~~~
238 Lazy patterns can't bind existentials.  They arise in two ways:
239   * Let bindings      let { C a b = e } in b
240   * Twiddle patterns  f ~(C a b) = e
241 The pe_lazy field of PatEnv says whether we are inside a lazy
242 pattern (perhaps deeply)
243
244 If we aren't inside a lazy pattern then we can bind existentials,
245 but we need to be careful about "extra" tyvars. Consider
246     (\C x -> d) : pat_ty -> res_ty
247 When looking for existential escape we must check that the existential
248 bound by C don't unify with the free variables of pat_ty, OR res_ty
249 (or of course the environment).   Hence we need to keep track of the
250 res_ty free vars.
251
252
253 %************************************************************************
254 %*                                                                      *
255                 Binders
256 %*                                                                      *
257 %************************************************************************
258
259 \begin{code}
260 tcPatBndr :: PatEnv -> Name -> TcSigmaType -> TcM (TcCoercion, TcId)
261 -- (coi, xp) = tcPatBndr penv x pat_ty
262 -- Then coi : pat_ty ~ typeof(xp)
263 --
264 tcPatBndr (PE { pe_ctxt = LetPat lookup_sig no_gen}) bndr_name pat_ty
265           -- See Note [Typing patterns in pattern bindings]
266   | LetGblBndr prags <- no_gen
267   , Just sig <- lookup_sig bndr_name
268   = do { bndr_id <- addInlinePrags (sig_id sig) (prags bndr_name)
269        ; traceTc "tcPatBndr(gbl,sig)" (ppr bndr_id $$ ppr (idType bndr_id))
270        ; co <- unifyPatType (idType bndr_id) pat_ty
271        ; return (co, bndr_id) }
272
273   | otherwise
274   = do { bndr_id <- newNoSigLetBndr no_gen bndr_name pat_ty
275        ; traceTc "tcPatBndr(no-sig)" (ppr bndr_id $$ ppr (idType bndr_id))
276        ; return (mkTcNomReflCo pat_ty, bndr_id) }
277
278 tcPatBndr (PE { pe_ctxt = _lam_or_proc }) bndr_name pat_ty
279   = do { bndr <- mkLocalBinder bndr_name pat_ty
280        ; return (mkTcNomReflCo pat_ty, bndr) }
281
282 ------------
283 newNoSigLetBndr :: LetBndrSpec -> Name -> TcType -> TcM TcId
284 -- In the polymorphic case (no_gen = LetLclBndr), generate a "monomorphic version"
285 --    of the Id; the original name will be bound to the polymorphic version
286 --    by the AbsBinds
287 -- In the monomorphic case (no_gen = LetBglBndr) there is no AbsBinds, and we
288 --    use the original name directly
289 newNoSigLetBndr LetLclBndr name ty
290   =do  { mono_name <- newLocalName name
291        ; mkLocalBinder mono_name ty }
292 newNoSigLetBndr (LetGblBndr prags) name ty
293   = do { id <- mkLocalBinder name ty
294        ; addInlinePrags id (prags name) }
295
296 ----------
297 addInlinePrags :: TcId -> [LSig Name] -> TcM TcId
298 addInlinePrags poly_id prags
299   = do { traceTc "addInlinePrags" (ppr poly_id $$ ppr prags)
300        ; tc_inl inl_sigs }
301   where
302     inl_sigs = filter isInlineLSig prags
303     tc_inl [] = return poly_id
304     tc_inl (L loc (InlineSig _ prag) : other_inls)
305        = do { unless (null other_inls) (setSrcSpan loc warn_dup_inline)
306             ; traceTc "addInlinePrag" (ppr poly_id $$ ppr prag)
307             ; return (poly_id `setInlinePragma` prag) }
308     tc_inl _ = panic "tc_inl"
309
310     warn_dup_inline = warnPrags poly_id inl_sigs $
311                       ptext (sLit "Duplicate INLINE pragmas for")
312
313 warnPrags :: Id -> [LSig Name] -> SDoc -> TcM ()
314 warnPrags id bad_sigs herald
315   = addWarnTc (hang (herald <+> quotes (ppr id))
316                   2 (ppr_sigs bad_sigs))
317   where
318     ppr_sigs sigs = vcat (map (ppr . getLoc) sigs)
319
320 -----------------
321 mkLocalBinder :: Name -> TcType -> TcM TcId
322 mkLocalBinder name ty
323   = return (Id.mkLocalId name ty)
324 \end{code}
325
326 Note [Typing patterns in pattern bindings]
327 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
328 Suppose we are typing a pattern binding
329     pat = rhs
330 Then the PatCtxt will be (LetPat sig_fn let_bndr_spec).
331
332 There can still be signatures for the binders:
333      data T = MkT (forall a. a->a) Int
334      x :: forall a. a->a
335      y :: Int
336      MkT x y = <rhs>
337
338 Two cases, dealt with by the LetPat case of tcPatBndr
339
340  * If we are generalising (generalisation plan is InferGen or
341    CheckGen), then the let_bndr_spec will be LetLclBndr.  In that case
342    we want to bind a cloned, local version of the variable, with the
343    type given by the pattern context, *not* by the signature (even if
344    there is one; see Trac #7268). The mkExport part of the
345    generalisation step will do the checking and impedence matching
346    against the signature.
347
348  * If for some some reason we are not generalising (plan = NoGen), the
349    LetBndrSpec will be LetGblBndr.  In that case we must bind the
350    global version of the Id, and do so with precisely the type given
351    in the signature.  (Then we unify with the type from the pattern
352    context type.
353
354
355 %************************************************************************
356 %*                                                                      *
357                 The main worker functions
358 %*                                                                      *
359 %************************************************************************
360
361 Note [Nesting]
362 ~~~~~~~~~~~~~~
363 tcPat takes a "thing inside" over which the pattern scopes.  This is partly
364 so that tcPat can extend the environment for the thing_inside, but also
365 so that constraints arising in the thing_inside can be discharged by the
366 pattern.
367
368 This does not work so well for the ErrCtxt carried by the monad: we don't
369 want the error-context for the pattern to scope over the RHS.
370 Hence the getErrCtxt/setErrCtxt stuff in tcMultiple
371
372 \begin{code}
373 --------------------
374 type Checker inp out =  forall r.
375                           inp
376                        -> PatEnv
377                        -> TcM r
378                        -> TcM (out, r)
379
380 tcMultiple :: Checker inp out -> Checker [inp] [out]
381 tcMultiple tc_pat args penv thing_inside
382   = do  { err_ctxt <- getErrCtxt
383         ; let loop _ []
384                 = do { res <- thing_inside
385                      ; return ([], res) }
386
387               loop penv (arg:args)
388                 = do { (p', (ps', res))
389                                 <- tc_pat arg penv $
390                                    setErrCtxt err_ctxt $
391                                    loop penv args
392                 -- setErrCtxt: restore context before doing the next pattern
393                 -- See note [Nesting] above
394
395                      ; return (p':ps', res) }
396
397         ; loop penv args }
398
399 --------------------
400 tc_lpat :: LPat Name
401         -> TcSigmaType
402         -> PatEnv
403         -> TcM a
404         -> TcM (LPat TcId, a)
405 tc_lpat (L span pat) pat_ty penv thing_inside
406   = setSrcSpan span $
407     do  { (pat', res) <- maybeWrapPatCtxt pat (tc_pat penv pat pat_ty)
408                                           thing_inside
409         ; return (L span pat', res) }
410
411 tc_lpats :: PatEnv
412          -> [LPat Name] -> [TcSigmaType]
413          -> TcM a
414          -> TcM ([LPat TcId], a)
415 tc_lpats penv pats tys thing_inside
416   = ASSERT2( equalLength pats tys, ppr pats $$ ppr tys )
417     tcMultiple (\(p,t) -> tc_lpat p t)
418                 (zipEqual "tc_lpats" pats tys)
419                 penv thing_inside
420
421 --------------------
422 tc_pat  :: PatEnv
423         -> Pat Name
424         -> TcSigmaType  -- Fully refined result type
425         -> TcM a                -- Thing inside
426         -> TcM (Pat TcId,       -- Translated pattern
427                 a)              -- Result of thing inside
428
429 tc_pat penv (VarPat name) pat_ty thing_inside
430   = do  { (co, id) <- tcPatBndr penv name pat_ty
431         ; res <- tcExtendIdEnv1 name id thing_inside
432         ; return (mkHsWrapPatCo co (VarPat id) pat_ty, res) }
433
434 tc_pat penv (ParPat pat) pat_ty thing_inside
435   = do  { (pat', res) <- tc_lpat pat pat_ty penv thing_inside
436         ; return (ParPat pat', res) }
437
438 tc_pat penv (BangPat pat) pat_ty thing_inside
439   = do  { (pat', res) <- tc_lpat pat pat_ty penv thing_inside
440         ; return (BangPat pat', res) }
441
442 tc_pat penv lpat@(LazyPat pat) pat_ty thing_inside
443   = do  { (pat', (res, pat_ct))
444                 <- tc_lpat pat pat_ty (makeLazy penv) $
445                    captureConstraints thing_inside
446                 -- Ignore refined penv', revert to penv
447
448         ; emitConstraints pat_ct
449         -- captureConstraints/extendConstraints:
450         --   see Note [Hopping the LIE in lazy patterns]
451
452         -- Check there are no unlifted types under the lazy pattern
453         ; when (any (isUnLiftedType . idType) $ collectPatBinders pat') $
454                lazyUnliftedPatErr lpat
455
456         -- Check that the expected pattern type is itself lifted
457         ; pat_ty' <- newFlexiTyVarTy liftedTypeKind
458         ; _ <- unifyType pat_ty pat_ty'
459
460         ; return (LazyPat pat', res) }
461
462 tc_pat _ p@(QuasiQuotePat _) _ _
463   = pprPanic "Should never see QuasiQuotePat in type checker" (ppr p)
464
465 tc_pat _ (WildPat _) pat_ty thing_inside
466   = do  { res <- thing_inside
467         ; return (WildPat pat_ty, res) }
468
469 tc_pat penv (AsPat (L nm_loc name) pat) pat_ty thing_inside
470   = do  { (co, bndr_id) <- setSrcSpan nm_loc (tcPatBndr penv name pat_ty)
471         ; (pat', res) <- tcExtendIdEnv1 name bndr_id $
472                          tc_lpat pat (idType bndr_id) penv thing_inside
473             -- NB: if we do inference on:
474             --          \ (y@(x::forall a. a->a)) = e
475             -- we'll fail.  The as-pattern infers a monotype for 'y', which then
476             -- fails to unify with the polymorphic type for 'x'.  This could
477             -- perhaps be fixed, but only with a bit more work.
478             --
479             -- If you fix it, don't forget the bindInstsOfPatIds!
480         ; return (mkHsWrapPatCo co (AsPat (L nm_loc bndr_id) pat') pat_ty, res) }
481
482 tc_pat penv (ViewPat expr pat _) overall_pat_ty thing_inside
483   = do  {
484          -- Morally, expr must have type `forall a1...aN. OPT' -> B`
485          -- where overall_pat_ty is an instance of OPT'.
486          -- Here, we infer a rho type for it,
487          -- which replaces the leading foralls and constraints
488          -- with fresh unification variables.
489         ; (expr',expr'_inferred) <- tcInferRho expr
490
491          -- next, we check that expr is coercible to `overall_pat_ty -> pat_ty`
492          -- NOTE: this forces pat_ty to be a monotype (because we use a unification
493          -- variable to find it).  this means that in an example like
494          -- (view -> f)    where view :: _ -> forall b. b
495          -- we will only be able to use view at one instantation in the
496          -- rest of the view
497         ; (expr_co, pat_ty) <- tcInfer $ \ pat_ty ->
498                 unifyType expr'_inferred (mkFunTy overall_pat_ty pat_ty)
499
500          -- pattern must have pat_ty
501         ; (pat', res) <- tc_lpat pat pat_ty penv thing_inside
502
503         ; return (ViewPat (mkLHsWrapCo expr_co expr') pat' overall_pat_ty, res) }
504
505 -- Type signatures in patterns
506 -- See Note [Pattern coercions] below
507 tc_pat penv (SigPatIn pat sig_ty) pat_ty thing_inside
508   = do  { (inner_ty, tv_binds, wrap) <- tcPatSig (inPatBind penv) sig_ty pat_ty
509         ; (pat', res) <- tcExtendTyVarEnv2 tv_binds $
510                          tc_lpat pat inner_ty penv thing_inside
511
512         ; return (mkHsWrapPat wrap (SigPatOut pat' inner_ty) pat_ty, res) }
513
514 ------------------------
515 -- Lists, tuples, arrays
516 tc_pat penv (ListPat pats _ Nothing) pat_ty thing_inside
517   = do  { (coi, elt_ty) <- matchExpectedPatTy matchExpectedListTy pat_ty
518         ; (pats', res) <- tcMultiple (\p -> tc_lpat p elt_ty)
519                                      pats penv thing_inside
520         ; return (mkHsWrapPat coi (ListPat pats' elt_ty Nothing) pat_ty, res)
521         }
522
523 tc_pat penv (ListPat pats _ (Just (_,e))) pat_ty thing_inside
524   = do  { list_pat_ty <- newFlexiTyVarTy liftedTypeKind
525         ; e' <- tcSyntaxOp ListOrigin e (mkFunTy pat_ty list_pat_ty)
526         ; (coi, elt_ty) <- matchExpectedPatTy matchExpectedListTy list_pat_ty
527         ; (pats', res) <- tcMultiple (\p -> tc_lpat p elt_ty)
528                                      pats penv thing_inside
529         ; return (mkHsWrapPat coi (ListPat pats' elt_ty (Just (pat_ty,e'))) list_pat_ty, res)
530         }
531
532 tc_pat penv (PArrPat pats _) pat_ty thing_inside
533   = do  { (coi, elt_ty) <- matchExpectedPatTy matchExpectedPArrTy pat_ty
534         ; (pats', res) <- tcMultiple (\p -> tc_lpat p elt_ty)
535                                      pats penv thing_inside
536         ; return (mkHsWrapPat coi (PArrPat pats' elt_ty) pat_ty, res)
537         }
538
539 tc_pat penv (TuplePat pats boxity _) pat_ty thing_inside
540   = do  { let tc = tupleTyCon (boxityNormalTupleSort boxity) (length pats)
541         ; (coi, arg_tys) <- matchExpectedPatTy (matchExpectedTyConApp tc) pat_ty
542         ; (pats', res) <- tc_lpats penv pats arg_tys thing_inside
543
544         ; dflags <- getDynFlags
545
546         -- Under flag control turn a pattern (x,y,z) into ~(x,y,z)
547         -- so that we can experiment with lazy tuple-matching.
548         -- This is a pretty odd place to make the switch, but
549         -- it was easy to do.
550         ; let
551               unmangled_result = TuplePat pats' boxity arg_tys
552                                  -- pat_ty /= pat_ty iff coi /= IdCo
553               possibly_mangled_result
554                 | gopt Opt_IrrefutableTuples dflags &&
555                   isBoxed boxity            = LazyPat (noLoc unmangled_result)
556                 | otherwise                 = unmangled_result
557
558         ; ASSERT( length arg_tys == length pats )      -- Syntactically enforced
559           return (mkHsWrapPat coi possibly_mangled_result pat_ty, res)
560         }
561
562 ------------------------
563 -- Data constructors
564 tc_pat penv (ConPatIn con arg_pats) pat_ty thing_inside
565   = tcConPat penv con pat_ty arg_pats thing_inside
566
567 ------------------------
568 -- Literal patterns
569 tc_pat _ (LitPat simple_lit) pat_ty thing_inside
570   = do  { let lit_ty = hsLitType simple_lit
571         ; co <- unifyPatType lit_ty pat_ty
572                 -- coi is of kind: pat_ty ~ lit_ty
573         ; res <- thing_inside
574         ; return ( mkHsWrapPatCo co (LitPat simple_lit) pat_ty
575                  , res) }
576
577 ------------------------
578 -- Overloaded patterns: n, and n+k
579 tc_pat _ (NPat over_lit mb_neg eq) pat_ty thing_inside
580   = do  { let orig = LiteralOrigin over_lit
581         ; lit'    <- newOverloadedLit orig over_lit pat_ty
582         ; eq'     <- tcSyntaxOp orig eq (mkFunTys [pat_ty, pat_ty] boolTy)
583         ; mb_neg' <- case mb_neg of
584                         Nothing  -> return Nothing      -- Positive literal
585                         Just neg ->     -- Negative literal
586                                         -- The 'negate' is re-mappable syntax
587                             do { neg' <- tcSyntaxOp orig neg (mkFunTy pat_ty pat_ty)
588                                ; return (Just neg') }
589         ; res <- thing_inside
590         ; return (NPat lit' mb_neg' eq', res) }
591
592 tc_pat penv (NPlusKPat (L nm_loc name) lit ge minus) pat_ty thing_inside
593   = do  { (co, bndr_id) <- setSrcSpan nm_loc (tcPatBndr penv name pat_ty)
594         ; let pat_ty' = idType bndr_id
595               orig    = LiteralOrigin lit
596         ; lit' <- newOverloadedLit orig lit pat_ty'
597
598         -- The '>=' and '-' parts are re-mappable syntax
599         ; ge'    <- tcSyntaxOp orig ge    (mkFunTys [pat_ty', pat_ty'] boolTy)
600         ; minus' <- tcSyntaxOp orig minus (mkFunTys [pat_ty', pat_ty'] pat_ty')
601         ; let pat' = NPlusKPat (L nm_loc bndr_id) lit' ge' minus'
602
603         -- The Report says that n+k patterns must be in Integral
604         -- We may not want this when using re-mappable syntax, though (ToDo?)
605         ; icls <- tcLookupClass integralClassName
606         ; instStupidTheta orig [mkClassPred icls [pat_ty']]
607
608         ; res <- tcExtendIdEnv1 name bndr_id thing_inside
609         ; return (mkHsWrapPatCo co pat' pat_ty, res) }
610
611 tc_pat _ _other_pat _ _ = panic "tc_pat"        -- ConPatOut, SigPatOut
612
613 ----------------
614 unifyPatType :: TcType -> TcType -> TcM TcCoercion
615 -- In patterns we want a coercion from the
616 -- context type (expected) to the actual pattern type
617 -- But we don't want to reverse the args to unifyType because
618 -- that controls the actual/expected stuff in error messages
619 unifyPatType actual_ty expected_ty
620   = do { coi <- unifyType actual_ty expected_ty
621        ; return (mkTcSymCo coi) }
622 \end{code}
623
624 Note [Hopping the LIE in lazy patterns]
625 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
626 In a lazy pattern, we must *not* discharge constraints from the RHS
627 from dictionaries bound in the pattern.  E.g.
628         f ~(C x) = 3
629 We can't discharge the Num constraint from dictionaries bound by
630 the pattern C!
631
632 So we have to make the constraints from thing_inside "hop around"
633 the pattern.  Hence the captureConstraints and emitConstraints.
634
635 The same thing ensures that equality constraints in a lazy match
636 are not made available in the RHS of the match. For example
637         data T a where { T1 :: Int -> T Int; ... }
638         f :: T a -> Int -> a
639         f ~(T1 i) y = y
640 It's obviously not sound to refine a to Int in the right
641 hand side, because the arugment might not match T1 at all!
642
643 Finally, a lazy pattern should not bind any existential type variables
644 because they won't be in scope when we do the desugaring
645
646
647 %************************************************************************
648 %*                                                                      *
649         Most of the work for constructors is here
650         (the rest is in the ConPatIn case of tc_pat)
651 %*                                                                      *
652 %************************************************************************
653
654 [Pattern matching indexed data types]
655 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
656 Consider the following declarations:
657
658   data family Map k :: * -> *
659   data instance Map (a, b) v = MapPair (Map a (Pair b v))
660
661 and a case expression
662
663   case x :: Map (Int, c) w of MapPair m -> ...
664
665 As explained by [Wrappers for data instance tycons] in MkIds.lhs, the
666 worker/wrapper types for MapPair are
667
668   $WMapPair :: forall a b v. Map a (Map a b v) -> Map (a, b) v
669   $wMapPair :: forall a b v. Map a (Map a b v) -> :R123Map a b v
670
671 So, the type of the scrutinee is Map (Int, c) w, but the tycon of MapPair is
672 :R123Map, which means the straight use of boxySplitTyConApp would give a type
673 error.  Hence, the smart wrapper function boxySplitTyConAppWithFamily calls
674 boxySplitTyConApp with the family tycon Map instead, which gives us the family
675 type list {(Int, c), w}.  To get the correct split for :R123Map, we need to
676 unify the family type list {(Int, c), w} with the instance types {(a, b), v}
677 (provided by tyConFamInst_maybe together with the family tycon).  This
678 unification yields the substitution [a -> Int, b -> c, v -> w], which gives us
679 the split arguments for the representation tycon :R123Map as {Int, c, w}
680
681 In other words, boxySplitTyConAppWithFamily implicitly takes the coercion
682
683   Co123Map a b v :: {Map (a, b) v ~ :R123Map a b v}
684
685 moving between representation and family type into account.  To produce type
686 correct Core, this coercion needs to be used to case the type of the scrutinee
687 from the family to the representation type.  This is achieved by
688 unwrapFamInstScrutinee using a CoPat around the result pattern.
689
690 Now it might appear seem as if we could have used the previous GADT type
691 refinement infrastructure of refineAlt and friends instead of the explicit
692 unification and CoPat generation.  However, that would be wrong.  Why?  The
693 whole point of GADT refinement is that the refinement is local to the case
694 alternative.  In contrast, the substitution generated by the unification of
695 the family type list and instance types needs to be propagated to the outside.
696 Imagine that in the above example, the type of the scrutinee would have been
697 (Map x w), then we would have unified {x, w} with {(a, b), v}, yielding the
698 substitution [x -> (a, b), v -> w].  In contrast to GADT matching, the
699 instantiation of x with (a, b) must be global; ie, it must be valid in *all*
700 alternatives of the case expression, whereas in the GADT case it might vary
701 between alternatives.
702
703 RIP GADT refinement: refinements have been replaced by the use of explicit
704 equality constraints that are used in conjunction with implication constraints
705 to express the local scope of GADT refinements.
706
707 \begin{code}
708 --      Running example:
709 -- MkT :: forall a b c. (a~[b]) => b -> c -> T a
710 --       with scrutinee of type (T ty)
711
712 tcConPat :: PatEnv -> Located Name
713          -> TcRhoType           -- Type of the pattern
714          -> HsConPatDetails Name -> TcM a
715          -> TcM (Pat TcId, a)
716 tcConPat penv con_lname@(L _ con_name) pat_ty arg_pats thing_inside
717   = do  { con_like <- tcLookupConLike con_name
718         ; case con_like of
719             RealDataCon data_con -> tcDataConPat penv con_lname data_con
720                                                  pat_ty arg_pats thing_inside
721             PatSynCon pat_syn -> tcPatSynPat penv con_lname pat_syn
722                                              pat_ty arg_pats thing_inside
723         }
724
725 tcDataConPat :: PatEnv -> Located Name -> DataCon
726              -> TcRhoType               -- Type of the pattern
727              -> HsConPatDetails Name -> TcM a
728              -> TcM (Pat TcId, a)
729 tcDataConPat penv (L con_span con_name) data_con pat_ty arg_pats thing_inside
730   = do  { let tycon = dataConTyCon data_con
731                   -- For data families this is the representation tycon
732               (univ_tvs, ex_tvs, eq_spec, theta, arg_tys, _)
733                 = dataConFullSig data_con
734               header = L con_span (RealDataCon data_con)
735
736           -- Instantiate the constructor type variables [a->ty]
737           -- This may involve doing a family-instance coercion,
738           -- and building a wrapper
739         ; (wrap, ctxt_res_tys) <- matchExpectedPatTy (matchExpectedConTy tycon) pat_ty
740
741           -- Add the stupid theta
742         ; setSrcSpan con_span $ addDataConStupidTheta data_con ctxt_res_tys
743
744         ; checkExistentials ex_tvs penv
745         ; (tenv, ex_tvs') <- tcInstSuperSkolTyVarsX
746                                (zipTopTvSubst univ_tvs ctxt_res_tys) ex_tvs
747                      -- Get location from monad, not from ex_tvs
748
749         ; let -- pat_ty' = mkTyConApp tycon ctxt_res_tys
750               -- pat_ty' is type of the actual constructor application
751               -- pat_ty' /= pat_ty iff coi /= IdCo
752
753               arg_tys' = substTys tenv arg_tys
754
755         ; traceTc "tcConPat" (vcat [ ppr con_name, ppr univ_tvs, ppr ex_tvs, ppr eq_spec
756                                    , ppr ex_tvs', ppr ctxt_res_tys, ppr arg_tys' ])
757         ; if null ex_tvs && null eq_spec && null theta
758           then do { -- The common case; no class bindings etc
759                     -- (see Note [Arrows and patterns])
760                     (arg_pats', res) <- tcConArgs (RealDataCon data_con) arg_tys'
761                                                   arg_pats penv thing_inside
762                   ; let res_pat = ConPatOut { pat_con = header,
763                                               pat_tvs = [], pat_dicts = [],
764                                               pat_binds = emptyTcEvBinds,
765                                               pat_args = arg_pats',
766                                               pat_arg_tys = ctxt_res_tys,
767                                               pat_wrap = idHsWrapper }
768
769                   ; return (mkHsWrapPat wrap res_pat pat_ty, res) }
770
771           else do   -- The general case, with existential,
772                     -- and local equality constraints
773         { let theta'   = substTheta tenv (eqSpecPreds eq_spec ++ theta)
774                            -- order is *important* as we generate the list of
775                            -- dictionary binders from theta'
776               no_equalities = not (any isEqPred theta')
777               skol_info = case pe_ctxt penv of
778                             LamPat mc -> PatSkol (RealDataCon data_con) mc
779                             LetPat {} -> UnkSkol -- Doesn't matter
780
781         ; gadts_on    <- xoptM Opt_GADTs
782         ; families_on <- xoptM Opt_TypeFamilies
783         ; checkTc (no_equalities || gadts_on || families_on)
784                   (ptext (sLit "A pattern match on a GADT requires GADTs or TypeFamilies"))
785                   -- Trac #2905 decided that a *pattern-match* of a GADT
786                   -- should require the GADT language flag.
787                   -- Re TypeFamilies see also #7156
788
789         ; given <- newEvVars theta'
790         ; (ev_binds, (arg_pats', res))
791              <- checkConstraints skol_info ex_tvs' given $
792                 tcConArgs (RealDataCon data_con) arg_tys' arg_pats penv thing_inside
793
794         ; let res_pat = ConPatOut { pat_con   = header,
795                                     pat_tvs   = ex_tvs',
796                                     pat_dicts = given,
797                                     pat_binds = ev_binds,
798                                     pat_args  = arg_pats',
799                                     pat_arg_tys = ctxt_res_tys,
800                                     pat_wrap  = idHsWrapper }
801         ; return (mkHsWrapPat wrap res_pat pat_ty, res)
802         } }
803
804 tcPatSynPat :: PatEnv -> Located Name -> PatSyn
805             -> TcRhoType                -- Type of the pattern
806             -> HsConPatDetails Name -> TcM a
807             -> TcM (Pat TcId, a)
808 tcPatSynPat penv (L con_span _) pat_syn pat_ty arg_pats thing_inside
809   = do  { let (univ_tvs, ex_tvs, prov_theta, req_theta, arg_tys, ty) = patSynSig pat_syn
810
811         ; (subst, univ_tvs') <- tcInstTyVars univ_tvs
812
813         ; checkExistentials ex_tvs penv
814         ; (tenv, ex_tvs') <- tcInstSuperSkolTyVarsX subst ex_tvs
815         ; let ty' = substTy tenv ty
816               arg_tys' = substTys tenv arg_tys
817               prov_theta' = substTheta tenv prov_theta
818               req_theta' = substTheta tenv req_theta
819
820         ; wrap <- coToHsWrapper <$> unifyType ty' pat_ty
821         ; traceTc "tcPatSynPat" (ppr pat_syn $$
822                                  ppr pat_ty $$
823                                  ppr ty' $$
824                                  ppr ex_tvs' $$
825                                  ppr prov_theta' $$
826                                  ppr req_theta' $$
827                                  ppr arg_tys')
828
829         ; prov_dicts' <- newEvVars prov_theta'
830
831         ; let skol_info = case pe_ctxt penv of
832                             LamPat mc -> PatSkol (PatSynCon pat_syn) mc
833                             LetPat {} -> UnkSkol -- Doesn't matter
834
835         ; req_wrap <- instCall PatOrigin (mkTyVarTys univ_tvs') req_theta'
836         ; traceTc "instCall" (ppr req_wrap)
837
838         ; traceTc "checkConstraints {" Outputable.empty
839         ; (ev_binds, (arg_pats', res))
840              <- checkConstraints skol_info ex_tvs' prov_dicts' $
841                 tcConArgs (PatSynCon pat_syn) arg_tys' arg_pats penv thing_inside
842
843         ; traceTc "checkConstraints }" (ppr ev_binds)
844         ; let res_pat = ConPatOut { pat_con   = L con_span $ PatSynCon pat_syn,
845                                     pat_tvs   = ex_tvs',
846                                     pat_dicts = prov_dicts',
847                                     pat_binds = ev_binds,
848                                     pat_args  = arg_pats',
849                                     pat_arg_tys = mkTyVarTys univ_tvs',
850                                     pat_wrap  = req_wrap }
851         ; return (mkHsWrapPat wrap res_pat pat_ty, res) }
852
853 ----------------------------
854 matchExpectedPatTy :: (TcRhoType -> TcM (TcCoercion, a))
855                     -> TcRhoType -> TcM (HsWrapper, a)
856 -- See Note [Matching polytyped patterns]
857 -- Returns a wrapper : pat_ty ~ inner_ty
858 matchExpectedPatTy inner_match pat_ty
859   | null tvs && null theta
860   = do { (co, res) <- inner_match pat_ty
861        ; return (coToHsWrapper (mkTcSymCo co), res) }
862          -- The Sym is because the inner_match returns a coercion
863          -- that is the other way round to matchExpectedPatTy
864
865   | otherwise
866   = do { (subst, tvs') <- tcInstTyVars tvs
867        ; wrap1 <- instCall PatOrigin (mkTyVarTys tvs') (substTheta subst theta)
868        ; (wrap2, arg_tys) <- matchExpectedPatTy inner_match (TcType.substTy subst tau)
869        ; return (wrap2 <.> wrap1, arg_tys) }
870   where
871     (tvs, theta, tau) = tcSplitSigmaTy pat_ty
872
873 ----------------------------
874 matchExpectedConTy :: TyCon      -- The TyCon that this data
875                                  -- constructor actually returns
876                    -> TcRhoType  -- The type of the pattern
877                    -> TcM (TcCoercion, [TcSigmaType])
878 -- See Note [Matching constructor patterns]
879 -- Returns a coercion : T ty1 ... tyn ~ pat_ty
880 -- This is the same way round as matchExpectedListTy etc
881 -- but the other way round to matchExpectedPatTy
882 matchExpectedConTy data_tc pat_ty
883   | Just (fam_tc, fam_args, co_tc) <- tyConFamInstSig_maybe data_tc
884          -- Comments refer to Note [Matching constructor patterns]
885          -- co_tc :: forall a. T [a] ~ T7 a
886   = do { (subst, tvs') <- tcInstTyVars (tyConTyVars data_tc)
887              -- tys = [ty1,ty2]
888
889        ; traceTc "matchExpectedConTy" (vcat [ppr data_tc,
890                                              ppr (tyConTyVars data_tc),
891                                              ppr fam_tc, ppr fam_args])
892        ; co1 <- unifyType (mkTyConApp fam_tc (substTys subst fam_args)) pat_ty
893              -- co1 : T (ty1,ty2) ~ pat_ty
894
895        ; let tys' = mkTyVarTys tvs'
896              co2 = mkTcUnbranchedAxInstCo Nominal co_tc tys'
897              -- co2 : T (ty1,ty2) ~ T7 ty1 ty2
898
899        ; return (mkTcSymCo co2 `mkTcTransCo` co1, tys') }
900
901   | otherwise
902   = matchExpectedTyConApp data_tc pat_ty
903              -- coi : T tys ~ pat_ty
904 \end{code}
905
906 Note [Matching constructor patterns]
907 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
908 Suppose (coi, tys) = matchExpectedConType data_tc pat_ty
909
910  * In the simple case, pat_ty = tc tys
911
912  * If pat_ty is a polytype, we want to instantiate it
913    This is like part of a subsumption check.  Eg
914       f :: (forall a. [a]) -> blah
915       f [] = blah
916
917  * In a type family case, suppose we have
918           data family T a
919           data instance T (p,q) = A p | B q
920        Then we'll have internally generated
921               data T7 p q = A p | B q
922               axiom coT7 p q :: T (p,q) ~ T7 p q
923
924        So if pat_ty = T (ty1,ty2), we return (coi, [ty1,ty2]) such that
925            coi = coi2 . coi1 : T7 t ~ pat_ty
926            coi1 : T (ty1,ty2) ~ pat_ty
927            coi2 : T7 ty1 ty2 ~ T (ty1,ty2)
928
929    For families we do all this matching here, not in the unifier,
930    because we never want a whisper of the data_tycon to appear in
931    error messages; it's a purely internal thing
932
933 \begin{code}
934 tcConArgs :: ConLike -> [TcSigmaType]
935           -> Checker (HsConPatDetails Name) (HsConPatDetails Id)
936
937 tcConArgs con_like arg_tys (PrefixCon arg_pats) penv thing_inside
938   = do  { checkTc (con_arity == no_of_args)     -- Check correct arity
939                   (arityErr "Constructor" con_like con_arity no_of_args)
940         ; let pats_w_tys = zipEqual "tcConArgs" arg_pats arg_tys
941         ; (arg_pats', res) <- tcMultiple tcConArg pats_w_tys
942                                               penv thing_inside
943         ; return (PrefixCon arg_pats', res) }
944   where
945     con_arity  = conLikeArity con_like
946     no_of_args = length arg_pats
947
948 tcConArgs con_like arg_tys (InfixCon p1 p2) penv thing_inside
949   = do  { checkTc (con_arity == 2)      -- Check correct arity
950                   (arityErr "Constructor" con_like con_arity 2)
951         ; let [arg_ty1,arg_ty2] = arg_tys       -- This can't fail after the arity check
952         ; ([p1',p2'], res) <- tcMultiple tcConArg [(p1,arg_ty1),(p2,arg_ty2)]
953                                               penv thing_inside
954         ; return (InfixCon p1' p2', res) }
955   where
956     con_arity  = conLikeArity con_like
957
958 tcConArgs con_like arg_tys (RecCon (HsRecFields rpats dd)) penv thing_inside
959   = do  { (rpats', res) <- tcMultiple tc_field rpats penv thing_inside
960         ; return (RecCon (HsRecFields rpats' dd), res) }
961   where
962     tc_field :: Checker (LHsRecField FieldLabel (LPat Name))
963                         (LHsRecField TcId (LPat TcId))
964     tc_field (L l (HsRecField field_lbl pat pun)) penv thing_inside
965       = do { (sel_id, pat_ty) <- wrapLocFstM find_field_ty field_lbl
966            ; (pat', res) <- tcConArg (pat, pat_ty) penv thing_inside
967            ; return (L l (HsRecField sel_id pat' pun), res) }
968
969     find_field_ty :: FieldLabel -> TcM (Id, TcType)
970     find_field_ty field_lbl
971         = case [ty | (f,ty) <- field_tys, f == field_lbl] of
972
973                 -- No matching field; chances are this field label comes from some
974                 -- other record type (or maybe none).  If this happens, just fail,
975                 -- otherwise we get crashes later (Trac #8570), and similar:
976                 --      f (R { foo = (a,b) }) = a+b
977                 -- If foo isn't one of R's fields, we don't want to crash when
978                 -- typechecking the "a+b".
979            [] -> failWith (badFieldCon con_like field_lbl)
980
981                 -- The normal case, when the field comes from the right constructor
982            (pat_ty : extras) ->
983                 ASSERT( null extras )
984                 do { sel_id <- tcLookupField field_lbl
985                    ; return (sel_id, pat_ty) }
986
987     field_tys :: [(FieldLabel, TcType)]
988     field_tys = case con_like of
989         RealDataCon data_con -> zip (dataConFieldLabels data_con) arg_tys
990           -- Don't use zipEqual! If the constructor isn't really a record, then
991           -- dataConFieldLabels will be empty (and each field in the pattern
992           -- will generate an error below).
993         PatSynCon{} -> []
994
995 conLikeArity :: ConLike -> Arity
996 conLikeArity (RealDataCon data_con) = dataConSourceArity data_con
997 conLikeArity (PatSynCon   pat_syn)  = patSynArity pat_syn
998
999 tcConArg :: Checker (LPat Name, TcSigmaType) (LPat Id)
1000 tcConArg (arg_pat, arg_ty) penv thing_inside
1001   = tc_lpat arg_pat arg_ty penv thing_inside
1002 \end{code}
1003
1004 \begin{code}
1005 addDataConStupidTheta :: DataCon -> [TcType] -> TcM ()
1006 -- Instantiate the "stupid theta" of the data con, and throw
1007 -- the constraints into the constraint set
1008 addDataConStupidTheta data_con inst_tys
1009   | null stupid_theta = return ()
1010   | otherwise         = instStupidTheta origin inst_theta
1011   where
1012     origin = OccurrenceOf (dataConName data_con)
1013         -- The origin should always report "occurrence of C"
1014         -- even when C occurs in a pattern
1015     stupid_theta = dataConStupidTheta data_con
1016     tenv = mkTopTvSubst (dataConUnivTyVars data_con `zip` inst_tys)
1017          -- NB: inst_tys can be longer than the univ tyvars
1018          --     because the constructor might have existentials
1019     inst_theta = substTheta tenv stupid_theta
1020 \end{code}
1021
1022 Note [Arrows and patterns]
1023 ~~~~~~~~~~~~~~~~~~~~~~~~~~
1024 (Oct 07) Arrow noation has the odd property that it involves
1025 "holes in the scope". For example:
1026   expr :: Arrow a => a () Int
1027   expr = proc (y,z) -> do
1028           x <- term -< y
1029           expr' -< x
1030
1031 Here the 'proc (y,z)' binding scopes over the arrow tails but not the
1032 arrow body (e.g 'term').  As things stand (bogusly) all the
1033 constraints from the proc body are gathered together, so constraints
1034 from 'term' will be seen by the tcPat for (y,z).  But we must *not*
1035 bind constraints from 'term' here, because the desugarer will not make
1036 these bindings scope over 'term'.
1037
1038 The Right Thing is not to confuse these constraints together. But for
1039 now the Easy Thing is to ensure that we do not have existential or
1040 GADT constraints in a 'proc', and to short-cut the constraint
1041 simplification for such vanilla patterns so that it binds no
1042 constraints. Hence the 'fast path' in tcConPat; but it's also a good
1043 plan for ordinary vanilla patterns to bypass the constraint
1044 simplification step.
1045
1046 %************************************************************************
1047 %*                                                                      *
1048                 Note [Pattern coercions]
1049 %*                                                                      *
1050 %************************************************************************
1051
1052 In principle, these program would be reasonable:
1053
1054         f :: (forall a. a->a) -> Int
1055         f (x :: Int->Int) = x 3
1056
1057         g :: (forall a. [a]) -> Bool
1058         g [] = True
1059
1060 In both cases, the function type signature restricts what arguments can be passed
1061 in a call (to polymorphic ones).  The pattern type signature then instantiates this
1062 type.  For example, in the first case,  (forall a. a->a) <= Int -> Int, and we
1063 generate the translated term
1064         f = \x' :: (forall a. a->a).  let x = x' Int in x 3
1065
1066 From a type-system point of view, this is perfectly fine, but it's *very* seldom useful.
1067 And it requires a significant amount of code to implement, because we need to decorate
1068 the translated pattern with coercion functions (generated from the subsumption check
1069 by tcSub).
1070
1071 So for now I'm just insisting on type *equality* in patterns.  No subsumption.
1072
1073 Old notes about desugaring, at a time when pattern coercions were handled:
1074
1075 A SigPat is a type coercion and must be handled one at at time.  We can't
1076 combine them unless the type of the pattern inside is identical, and we don't
1077 bother to check for that.  For example:
1078
1079         data T = T1 Int | T2 Bool
1080         f :: (forall a. a -> a) -> T -> t
1081         f (g::Int->Int)   (T1 i) = T1 (g i)
1082         f (g::Bool->Bool) (T2 b) = T2 (g b)
1083
1084 We desugar this as follows:
1085
1086         f = \ g::(forall a. a->a) t::T ->
1087             let gi = g Int
1088             in case t of { T1 i -> T1 (gi i)
1089                            other ->
1090             let gb = g Bool
1091             in case t of { T2 b -> T2 (gb b)
1092                            other -> fail }}
1093
1094 Note that we do not treat the first column of patterns as a
1095 column of variables, because the coerced variables (gi, gb)
1096 would be of different types.  So we get rather grotty code.
1097 But I don't think this is a common case, and if it was we could
1098 doubtless improve it.
1099
1100 Meanwhile, the strategy is:
1101         * treat each SigPat coercion (always non-identity coercions)
1102                 as a separate block
1103         * deal with the stuff inside, and then wrap a binding round
1104                 the result to bind the new variable (gi, gb, etc)
1105
1106
1107 %************************************************************************
1108 %*                                                                      *
1109 \subsection{Errors and contexts}
1110 %*                                                                      *
1111 %************************************************************************
1112
1113 \begin{code}
1114 maybeWrapPatCtxt :: Pat Name -> (TcM a -> TcM b) -> TcM a -> TcM b
1115 -- Not all patterns are worth pushing a context
1116 maybeWrapPatCtxt pat tcm thing_inside
1117   | not (worth_wrapping pat) = tcm thing_inside
1118   | otherwise                = addErrCtxt msg $ tcm $ popErrCtxt thing_inside
1119                                -- Remember to pop before doing thing_inside
1120   where
1121    worth_wrapping (VarPat {}) = False
1122    worth_wrapping (ParPat {}) = False
1123    worth_wrapping (AsPat {})  = False
1124    worth_wrapping _           = True
1125    msg = hang (ptext (sLit "In the pattern:")) 2 (ppr pat)
1126
1127 -----------------------------------------------
1128 checkExistentials :: [TyVar] -> PatEnv -> TcM ()
1129           -- See Note [Arrows and patterns]
1130 checkExistentials [] _                                 = return ()
1131 checkExistentials _ (PE { pe_ctxt = LetPat {}})        = failWithTc existentialLetPat
1132 checkExistentials _ (PE { pe_ctxt = LamPat ProcExpr }) = failWithTc existentialProcPat
1133 checkExistentials _ (PE { pe_lazy = True })            = failWithTc existentialLazyPat
1134 checkExistentials _ _                                  = return ()
1135
1136 existentialLazyPat :: SDoc
1137 existentialLazyPat
1138   = hang (ptext (sLit "An existential or GADT data constructor cannot be used"))
1139        2 (ptext (sLit "inside a lazy (~) pattern"))
1140
1141 existentialProcPat :: SDoc
1142 existentialProcPat
1143   = ptext (sLit "Proc patterns cannot use existential or GADT data constructors")
1144
1145 existentialLetPat :: SDoc
1146 existentialLetPat
1147   = vcat [text "My brain just exploded",
1148           text "I can't handle pattern bindings for existential or GADT data constructors.",
1149           text "Instead, use a case-expression, or do-notation, to unpack the constructor."]
1150
1151 badFieldCon :: ConLike -> Name -> SDoc
1152 badFieldCon con field
1153   = hsep [ptext (sLit "Constructor") <+> quotes (ppr con),
1154           ptext (sLit "does not have field"), quotes (ppr field)]
1155
1156 polyPatSig :: TcType -> SDoc
1157 polyPatSig sig_ty
1158   = hang (ptext (sLit "Illegal polymorphic type signature in pattern:"))
1159        2 (ppr sig_ty)
1160
1161 lazyUnliftedPatErr :: OutputableBndr name => Pat name -> TcM ()
1162 lazyUnliftedPatErr pat
1163   = failWithTc $
1164     hang (ptext (sLit "A lazy (~) pattern cannot contain unlifted types:"))
1165        2 (ppr pat)
1166 \end{code}