TcPat.hs 43.8 KB
Newer Older
Austin Seipp's avatar
Austin Seipp committed
1 2 3 4
{-
(c) The University of Glasgow 2006
(c) The GRASP/AQUA Project, Glasgow University, 1992-1998

5 6

TcPat: Typechecking patterns
Austin Seipp's avatar
Austin Seipp committed
7
-}
8

9
{-# LANGUAGE CPP, RankNTypes #-}
Ian Lynagh's avatar
Ian Lynagh committed
10

11 12 13
module TcPat ( tcLetPat, TcSigFun
             , TcPragEnv, lookupPragEnv, emptyPragEnv
             , LetBndrSpec(..), addInlinePrags
14
             , tcPat, tcPats, newNoSigLetBndr
15
             , addDataConStupidTheta, badFieldCon, polyPatSig ) where
16

17
#include "HsVersions.h"
18

19
import {-# SOURCE #-}   TcExpr( tcSyntaxOp, tcInferRho)
20 21 22

import HsSyn
import TcHsSyn
23
import TcRnMonad
24 25 26 27
import Inst
import Id
import Var
import Name
28
import NameEnv
Adam Gundry's avatar
Adam Gundry committed
29
import RdrName
30 31
import TcEnv
import TcMType
32
import TcValidity( arityErr )
33 34 35 36
import TcType
import TcUnify
import TcHsType
import TysWiredIn
37
import TcEvidence
38 39
import TyCon
import DataCon
cactus's avatar
cactus committed
40 41
import PatSyn
import ConLike
42 43
import PrelNames
import BasicTypes hiding (SuccessFlag(..))
44
import DynFlags
45 46
import SrcLoc
import Util
sof's avatar
sof committed
47
import Outputable
48
import FastString
49
import Maybes( orElse )
Ian Lynagh's avatar
Ian Lynagh committed
50
import Control.Monad
51

Austin Seipp's avatar
Austin Seipp committed
52 53 54
{-
************************************************************************
*                                                                      *
55
                External interface
Austin Seipp's avatar
Austin Seipp committed
56 57 58
*                                                                      *
************************************************************************
-}
59

60
tcLetPat :: TcSigFun -> LetBndrSpec
61 62 63
         -> LPat Name -> TcSigmaType
         -> TcM a
         -> TcM (LPat TcId, a)
64
tcLetPat sig_fn no_gen pat pat_ty thing_inside
65
  = tc_lpat pat pat_ty penv thing_inside
66
  where
67
    penv = PE { pe_lazy = True
68
              , pe_ctxt = LetPat sig_fn no_gen }
69 70

-----------------
71
tcPats :: HsMatchContext Name
72 73
       -> [LPat Name]            -- Patterns,
       -> [TcSigmaType]          --   and their types
74
       -> TcM a                  --   and the checker for the body
75
       -> TcM ([LPat TcId], a)
76 77 78

-- This is the externally-callable wrapper function
-- Typecheck the patterns, extend the environment to bind the variables,
79
-- do the thing inside, use any existentially-bound dictionaries to
80 81 82 83 84
-- discharge parts of the returning LIE, and deal with pattern type
-- signatures

--   1. Initialise the PatState
--   2. Check the patterns
85 86
--   3. Check the body
--   4. Check that no existentials escape
87

88
tcPats ctxt pats pat_tys thing_inside
89 90
  = tc_lpats penv pats pat_tys thing_inside
  where
91
    penv = PE { pe_lazy = False, pe_ctxt = LamPat ctxt }
92

93
tcPat :: HsMatchContext Name
94
      -> LPat Name -> TcSigmaType
95 96
      -> TcM a                 -- Checker for body, given
                               -- its result type
97
      -> TcM (LPat TcId, a)
98
tcPat ctxt pat pat_ty thing_inside
99 100
  = tc_lpat pat pat_ty penv thing_inside
  where
101
    penv = PE { pe_lazy = False, pe_ctxt = LamPat ctxt }
102

103

104
-----------------
105
data PatEnv
106 107
  = PE { pe_lazy :: Bool        -- True <=> lazy context, so no existentials allowed
       , pe_ctxt :: PatCtxt     -- Context in which the whole pattern appears
108
       }
109 110 111

data PatCtxt
  = LamPat   -- Used for lambdas, case etc
112
       (HsMatchContext Name)
113

114
  | LetPat   -- Used only for let(rec) pattern bindings
115
             -- See Note [Typing patterns in pattern bindings]
116 117 118
       TcSigFun        -- Tells type sig if any
       LetBndrSpec     -- True <=> no generalisation of this let

119 120 121
data LetBndrSpec
  = LetLclBndr            -- The binder is just a local one;
                          -- an AbsBinds will provide the global version
122

123
  | LetGblBndr TcPragEnv  -- Generalisation plan is NoGen, so there isn't going
124
                          -- to be an AbsBinds; So we must bind the global version
125
                          -- of the binder right away.
126
                          -- Oh, and here is the inline-pragma information
127

128 129 130
makeLazy :: PatEnv -> PatEnv
makeLazy penv = penv { pe_lazy = True }

131 132 133
inPatBind :: PatEnv -> Bool
inPatBind (PE { pe_ctxt = LetPat {} }) = True
inPatBind (PE { pe_ctxt = LamPat {} }) = False
134 135

---------------
136
type TcPragEnv = NameEnv [LSig Name]
137
type TcSigFun  = Name -> Maybe TcSigInfo
138

139 140 141 142 143 144
emptyPragEnv :: TcPragEnv
emptyPragEnv = emptyNameEnv

lookupPragEnv :: TcPragEnv -> Name -> [LSig Name]
lookupPragEnv prag_fn n = lookupNameEnv prag_fn n `orElse` []

145
{- *********************************************************************
Austin Seipp's avatar
Austin Seipp committed
146
*                                                                      *
147
                Binders
Austin Seipp's avatar
Austin Seipp committed
148
*                                                                      *
149
********************************************************************* -}
150

151
tcPatBndr :: PatEnv -> Name -> TcSigmaType -> TcM (TcCoercionN, TcId)
152 153 154 155
-- (coi, xp) = tcPatBndr penv x pat_ty
-- Then coi : pat_ty ~ typeof(xp)
--
tcPatBndr (PE { pe_ctxt = LetPat lookup_sig no_gen}) bndr_name pat_ty
156
          -- See Note [Typing patterns in pattern bindings]
157 158 159
  | LetGblBndr prags   <- no_gen
  , Just (TcIdSig sig) <- lookup_sig bndr_name
  , Just poly_id <- completeIdSigPolyId_maybe sig
160
  = do { bndr_id <- addInlinePrags poly_id (lookupPragEnv prags bndr_name)
161
       ; traceTc "tcPatBndr(gbl,sig)" (ppr bndr_id $$ ppr (idType bndr_id))
batterseapower's avatar
batterseapower committed
162 163
       ; co <- unifyPatType (idType bndr_id) pat_ty
       ; return (co, bndr_id) }
164 165

  | otherwise
166
  = do { bndr_id <- newNoSigLetBndr no_gen bndr_name pat_ty
167
       ; traceTc "tcPatBndr(no-sig)" (ppr bndr_id $$ ppr (idType bndr_id))
168
       ; return (mkTcNomReflCo pat_ty, bndr_id) }
169 170

tcPatBndr (PE { pe_ctxt = _lam_or_proc }) bndr_name pat_ty
171
  = return (mkTcNomReflCo pat_ty, mkLocalId bndr_name pat_ty)
172

173 174
------------
newNoSigLetBndr :: LetBndrSpec -> Name -> TcType -> TcM TcId
175
-- In the polymorphic case (no_gen = LetLclBndr), generate a "monomorphic version"
176 177
--    of the Id; the original name will be bound to the polymorphic version
--    by the AbsBinds
178
-- In the monomorphic case (no_gen = LetBglBndr) there is no AbsBinds, and we
179
--    use the original name directly
180
newNoSigLetBndr LetLclBndr name ty
181
  =do  { mono_name <- newLocalName name
182
       ; return (mkLocalId mono_name ty) }
183
newNoSigLetBndr (LetGblBndr prags) name ty
184
  = addInlinePrags (mkLocalId name ty) (lookupPragEnv prags name)
185 186 187 188

----------
addInlinePrags :: TcId -> [LSig Name] -> TcM TcId
addInlinePrags poly_id prags
189 190 191 192 193 194
  | inl@(L _ prag) : inls <- inl_prags
  = do { traceTc "addInlinePrag" (ppr poly_id $$ ppr prag)
       ; unless (null inls) (warn_multiple_inlines inl inls)
       ; return (poly_id `setInlinePragma` prag) }
  | otherwise
  = return poly_id
195
  where
196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212
    inl_prags = [L loc prag | L loc (InlineSig _ prag) <- prags]

    warn_multiple_inlines _ [] = return ()

    warn_multiple_inlines inl1@(L loc prag1) (inl2@(L _ prag2) : inls)
       | inlinePragmaActivation prag1 == inlinePragmaActivation prag2
       , isEmptyInlineSpec (inlinePragmaSpec prag1)
       =    -- Tiresome: inl1 is put there by virtue of being in a hs-boot loop
            -- and inl2 is a user NOINLINE pragma; we don't want to complain
         warn_multiple_inlines inl2 inls
       | otherwise
       = setSrcSpan loc $
         addWarnTc (hang (ptext (sLit "Multiple INLINE pragmas for") <+> ppr poly_id)
                       2 (vcat (ptext (sLit "Ignoring all but the first")
                                : map pp_inl (inl1:inl2:inls))))

    pp_inl (L loc prag) = ppr prag <+> parens (ppr loc)
213

Austin Seipp's avatar
Austin Seipp committed
214
{-
215 216 217 218 219 220 221 222
Note [Typing patterns in pattern bindings]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Suppose we are typing a pattern binding
    pat = rhs
Then the PatCtxt will be (LetPat sig_fn let_bndr_spec).

There can still be signatures for the binders:
     data T = MkT (forall a. a->a) Int
223
     x :: forall a. a->a
224 225 226 227 228 229 230 231 232 233
     y :: Int
     MkT x y = <rhs>

Two cases, dealt with by the LetPat case of tcPatBndr

 * If we are generalising (generalisation plan is InferGen or
   CheckGen), then the let_bndr_spec will be LetLclBndr.  In that case
   we want to bind a cloned, local version of the variable, with the
   type given by the pattern context, *not* by the signature (even if
   there is one; see Trac #7268). The mkExport part of the
Gabor Greif's avatar
Gabor Greif committed
234
   generalisation step will do the checking and impedance matching
235 236 237 238 239 240 241 242
   against the signature.

 * If for some some reason we are not generalising (plan = NoGen), the
   LetBndrSpec will be LetGblBndr.  In that case we must bind the
   global version of the Id, and do so with precisely the type given
   in the signature.  (Then we unify with the type from the pattern
   context type.

243

Austin Seipp's avatar
Austin Seipp committed
244 245
************************************************************************
*                                                                      *
246
                The main worker functions
Austin Seipp's avatar
Austin Seipp committed
247 248
*                                                                      *
************************************************************************
249

250 251
Note [Nesting]
~~~~~~~~~~~~~~
lennart@augustsson.net's avatar
lennart@augustsson.net committed
252
tcPat takes a "thing inside" over which the pattern scopes.  This is partly
253
so that tcPat can extend the environment for the thing_inside, but also
254 255 256 257
so that constraints arising in the thing_inside can be discharged by the
pattern.

This does not work so well for the ErrCtxt carried by the monad: we don't
258
want the error-context for the pattern to scope over the RHS.
259
Hence the getErrCtxt/setErrCtxt stuff in tcMultiple
Austin Seipp's avatar
Austin Seipp committed
260
-}
261 262

--------------------
263
type Checker inp out =  forall r.
264 265 266 267
                          inp
                       -> PatEnv
                       -> TcM r
                       -> TcM (out, r)
268 269

tcMultiple :: Checker inp out -> Checker [inp] [out]
270
tcMultiple tc_pat args penv thing_inside
271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286
  = do  { err_ctxt <- getErrCtxt
        ; let loop _ []
                = do { res <- thing_inside
                     ; return ([], res) }

              loop penv (arg:args)
                = do { (p', (ps', res))
                                <- tc_pat arg penv $
                                   setErrCtxt err_ctxt $
                                   loop penv args
                -- setErrCtxt: restore context before doing the next pattern
                -- See note [Nesting] above

                     ; return (p':ps', res) }

        ; loop penv args }
287 288

--------------------
289 290 291 292 293
tc_lpat :: LPat Name
        -> TcSigmaType
        -> PatEnv
        -> TcM a
        -> TcM (LPat TcId, a)
294
tc_lpat (L span pat) pat_ty penv thing_inside
295
  = setSrcSpan span $
296
    do  { (pat', res) <- maybeWrapPatCtxt pat (tc_pat penv pat pat_ty)
297
                                          thing_inside
298
        ; return (L span pat', res) }
299 300

tc_lpats :: PatEnv
301 302 303 304
         -> [LPat Name] -> [TcSigmaType]
         -> TcM a
         -> TcM ([LPat TcId], a)
tc_lpats penv pats tys thing_inside
Simon Peyton Jones's avatar
Simon Peyton Jones committed
305
  = ASSERT2( equalLength pats tys, ppr pats $$ ppr tys )
306
    tcMultiple (\(p,t) -> tc_lpat p t)
307
                (zipEqual "tc_lpats" pats tys)
308
                penv thing_inside
309 310

--------------------
311 312 313 314 315 316
tc_pat  :: PatEnv
        -> Pat Name
        -> TcSigmaType  -- Fully refined result type
        -> TcM a                -- Thing inside
        -> TcM (Pat TcId,       -- Translated pattern
                a)              -- Result of thing inside
317

318
tc_pat penv (VarPat (L l name)) pat_ty thing_inside
319
  = do  { (co, id) <- tcPatBndr penv name pat_ty
batterseapower's avatar
batterseapower committed
320
        ; res <- tcExtendIdEnv1 name id thing_inside
321
        ; return (mkHsWrapPatCo co (VarPat (L l id)) pat_ty, res) }
322 323

tc_pat penv (ParPat pat) pat_ty thing_inside
324 325
  = do  { (pat', res) <- tc_lpat pat pat_ty penv thing_inside
        ; return (ParPat pat', res) }
326 327

tc_pat penv (BangPat pat) pat_ty thing_inside
328 329
  = do  { (pat', res) <- tc_lpat pat pat_ty penv thing_inside
        ; return (BangPat pat', res) }
330

331
tc_pat penv lpat@(LazyPat pat) pat_ty thing_inside
332 333 334 335
  = do  { (pat', (res, pat_ct))
                <- tc_lpat pat pat_ty (makeLazy penv) $
                   captureConstraints thing_inside
                -- Ignore refined penv', revert to penv
336

337 338
        ; emitConstraints pat_ct
        -- captureConstraints/extendConstraints:
339
        --   see Note [Hopping the LIE in lazy patterns]
340

341 342
        -- Check there are no unlifted types under the lazy pattern
        ; when (any (isUnLiftedType . idType) $ collectPatBinders pat') $
343 344
               lazyUnliftedPatErr lpat

345 346 347
        -- Check that the expected pattern type is itself lifted
        ; pat_ty' <- newFlexiTyVarTy liftedTypeKind
        ; _ <- unifyType pat_ty pat_ty'
348

349
        ; return (LazyPat pat', res) }
350

351
tc_pat _ (WildPat _) pat_ty thing_inside
352 353
  = do  { res <- thing_inside
        ; return (WildPat pat_ty, res) }
354

355
tc_pat penv (AsPat (L nm_loc name) pat) pat_ty thing_inside
356
  = do  { (co, bndr_id) <- setSrcSpan nm_loc (tcPatBndr penv name pat_ty)
batterseapower's avatar
batterseapower committed
357
        ; (pat', res) <- tcExtendIdEnv1 name bndr_id $
358 359 360 361 362 363 364 365 366 367 368 369 370
                         tc_lpat pat (idType bndr_id) penv thing_inside
            -- NB: if we do inference on:
            --          \ (y@(x::forall a. a->a)) = e
            -- we'll fail.  The as-pattern infers a monotype for 'y', which then
            -- fails to unify with the polymorphic type for 'x'.  This could
            -- perhaps be fixed, but only with a bit more work.
            --
            -- If you fix it, don't forget the bindInstsOfPatIds!
        ; return (mkHsWrapPatCo co (AsPat (L nm_loc bndr_id) pat') pat_ty, res) }

tc_pat penv (ViewPat expr pat _) overall_pat_ty thing_inside
  = do  {
         -- Morally, expr must have type `forall a1...aN. OPT' -> B`
371 372 373 374
         -- where overall_pat_ty is an instance of OPT'.
         -- Here, we infer a rho type for it,
         -- which replaces the leading foralls and constraints
         -- with fresh unification variables.
375 376
        ; (expr',expr'_inferred) <- tcInferRho expr

377
         -- next, we check that expr is coercible to `overall_pat_ty -> pat_ty`
378
         -- NOTE: this forces pat_ty to be a monotype (because we use a unification
379 380 381 382
         -- variable to find it).  this means that in an example like
         -- (view -> f)    where view :: _ -> forall b. b
         -- we will only be able to use view at one instantation in the
         -- rest of the view
383 384 385
        ; (expr_co, pat_ty) <- tcInfer $ \ pat_ty ->
                unifyType expr'_inferred (mkFunTy overall_pat_ty pat_ty)

386
         -- pattern must have pat_ty
387 388
        ; (pat', res) <- tc_lpat pat pat_ty penv thing_inside

389
        ; return (ViewPat (mkLHsWrapCo expr_co expr') pat' overall_pat_ty, res) }
390

391 392
-- Type signatures in patterns
-- See Note [Pattern coercions] below
393
tc_pat penv (SigPatIn pat sig_ty) pat_ty thing_inside
394
  = do  { (inner_ty, tv_binds, wcs, wrap) <- tcPatSig (inPatBind penv)
thomasw's avatar
thomasw committed
395
                                                            sig_ty pat_ty
396
        ; (pat', res) <- tcExtendTyVarEnv2 (wcs ++ tv_binds) $
397
                         tc_lpat pat inner_ty penv thing_inside
398
        ; return (mkHsWrapPat wrap (SigPatOut pat' inner_ty) pat_ty, res) }
399 400 401

------------------------
-- Lists, tuples, arrays
402
tc_pat penv (ListPat pats _ Nothing) pat_ty thing_inside
403
  = do  { (coi, elt_ty) <- matchExpectedPatTy matchExpectedListTyR pat_ty
404
        ; (pats', res) <- tcMultiple (\p -> tc_lpat p elt_ty)
405 406
                                     pats penv thing_inside
        ; return (mkHsWrapPat coi (ListPat pats' elt_ty Nothing) pat_ty, res)
407 408 409
        }

tc_pat penv (ListPat pats _ (Just (_,e))) pat_ty thing_inside
410
  = do  { list_pat_ty <- newFlexiTyVarTy liftedTypeKind
411
        ; e' <- tcSyntaxOp ListOrigin e (mkFunTy pat_ty list_pat_ty)
412
        ; (coi, elt_ty) <- matchExpectedPatTy matchExpectedListTyR list_pat_ty
413
        ; (pats', res) <- tcMultiple (\p -> tc_lpat p elt_ty)
414 415
                                     pats penv thing_inside
        ; return (mkHsWrapPat coi (ListPat pats' elt_ty (Just (pat_ty,e'))) list_pat_ty, res)
416
        }
417

418
tc_pat penv (PArrPat pats _) pat_ty thing_inside
419
  = do  { (coi, elt_ty) <- matchExpectedPatTy matchExpectedPArrTyR pat_ty
420 421 422
        ; (pats', res) <- tcMultiple (\p -> tc_lpat p elt_ty)
                                     pats penv thing_inside
        ; return (mkHsWrapPat coi (PArrPat pats' elt_ty) pat_ty, res)
423
        }
424

425
tc_pat penv (TuplePat pats boxity _) pat_ty thing_inside
426
  = do  { let tc = tupleTyCon boxity (length pats)
427
        ; (coi, arg_tys) <- matchExpectedPatTy (matchExpectedTyConAppR tc) pat_ty
428
        ; (pats', res) <- tc_lpats penv pats arg_tys thing_inside
429

430
        ; dflags <- getDynFlags
431

432 433 434 435 436
        -- Under flag control turn a pattern (x,y,z) into ~(x,y,z)
        -- so that we can experiment with lazy tuple-matching.
        -- This is a pretty odd place to make the switch, but
        -- it was easy to do.
        ; let
437 438
              unmangled_result = TuplePat pats' boxity arg_tys
                                 -- pat_ty /= pat_ty iff coi /= IdCo
439 440
              possibly_mangled_result
                | gopt Opt_IrrefutableTuples dflags &&
441
                  isBoxed boxity            = LazyPat (noLoc unmangled_result)
442
                | otherwise                 = unmangled_result
443

444 445
        ; ASSERT( length arg_tys == length pats )      -- Syntactically enforced
          return (mkHsWrapPat coi possibly_mangled_result pat_ty, res)
446
        }
447 448 449

------------------------
-- Data constructors
450 451
tc_pat penv (ConPatIn con arg_pats) pat_ty thing_inside
  = tcConPat penv con pat_ty arg_pats thing_inside
452 453 454

------------------------
-- Literal patterns
455
tc_pat _ (LitPat simple_lit) pat_ty thing_inside
456 457 458 459 460
  = do  { let lit_ty = hsLitType simple_lit
        ; co <- unifyPatType lit_ty pat_ty
                -- coi is of kind: pat_ty ~ lit_ty
        ; res <- thing_inside
        ; return ( mkHsWrapPatCo co (LitPat simple_lit) pat_ty
461
                 , res) }
462 463 464

------------------------
-- Overloaded patterns: n, and n+k
Alan Zimmerman's avatar
Alan Zimmerman committed
465
tc_pat _ (NPat (L l over_lit) mb_neg eq) pat_ty thing_inside
466 467 468 469 470 471 472 473 474 475
  = do  { let orig = LiteralOrigin over_lit
        ; lit'    <- newOverloadedLit orig over_lit pat_ty
        ; eq'     <- tcSyntaxOp orig eq (mkFunTys [pat_ty, pat_ty] boolTy)
        ; mb_neg' <- case mb_neg of
                        Nothing  -> return Nothing      -- Positive literal
                        Just neg ->     -- Negative literal
                                        -- The 'negate' is re-mappable syntax
                            do { neg' <- tcSyntaxOp orig neg (mkFunTy pat_ty pat_ty)
                               ; return (Just neg') }
        ; res <- thing_inside
Alan Zimmerman's avatar
Alan Zimmerman committed
476
        ; return (NPat (L l lit') mb_neg' eq', res) }
477

Alan Zimmerman's avatar
Alan Zimmerman committed
478
tc_pat penv (NPlusKPat (L nm_loc name) (L loc lit) ge minus) pat_ty thing_inside
479
  = do  { (co, bndr_id) <- setSrcSpan nm_loc (tcPatBndr penv name pat_ty)
batterseapower's avatar
batterseapower committed
480
        ; let pat_ty' = idType bndr_id
481 482
              orig    = LiteralOrigin lit
        ; lit' <- newOverloadedLit orig lit pat_ty'
483

484 485 486
        -- The '>=' and '-' parts are re-mappable syntax
        ; ge'    <- tcSyntaxOp orig ge    (mkFunTys [pat_ty', pat_ty'] boolTy)
        ; minus' <- tcSyntaxOp orig minus (mkFunTys [pat_ty', pat_ty'] pat_ty')
Alan Zimmerman's avatar
Alan Zimmerman committed
487
        ; let pat' = NPlusKPat (L nm_loc bndr_id) (L loc lit') ge' minus'
488

489 490 491 492
        -- The Report says that n+k patterns must be in Integral
        -- We may not want this when using re-mappable syntax, though (ToDo?)
        ; icls <- tcLookupClass integralClassName
        ; instStupidTheta orig [mkClassPred icls [pat_ty']]
493

494 495 496 497
        ; res <- tcExtendIdEnv1 name bndr_id thing_inside
        ; return (mkHsWrapPatCo co pat' pat_ty, res) }

tc_pat _ _other_pat _ _ = panic "tc_pat"        -- ConPatOut, SigPatOut
498 499

----------------
500
unifyPatType :: TcType -> TcType -> TcM TcCoercion
501 502 503 504 505 506
-- In patterns we want a coercion from the
-- context type (expected) to the actual pattern type
-- But we don't want to reverse the args to unifyType because
-- that controls the actual/expected stuff in error messages
unifyPatType actual_ty expected_ty
  = do { coi <- unifyType actual_ty expected_ty
507
       ; return (mkTcSymCo coi) }
508

Austin Seipp's avatar
Austin Seipp committed
509
{-
510 511 512 513
Note [Hopping the LIE in lazy patterns]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
In a lazy pattern, we must *not* discharge constraints from the RHS
from dictionaries bound in the pattern.  E.g.
514
        f ~(C x) = 3
515
We can't discharge the Num constraint from dictionaries bound by
516
the pattern C!
517

518
So we have to make the constraints from thing_inside "hop around"
519
the pattern.  Hence the captureConstraints and emitConstraints.
520 521 522

The same thing ensures that equality constraints in a lazy match
are not made available in the RHS of the match. For example
523 524 525
        data T a where { T1 :: Int -> T Int; ... }
        f :: T a -> Int -> a
        f ~(T1 i) y = y
526
It's obviously not sound to refine a to Int in the right
527
hand side, because the argument might not match T1 at all!
528 529 530 531

Finally, a lazy pattern should not bind any existential type variables
because they won't be in scope when we do the desugaring

532

Austin Seipp's avatar
Austin Seipp committed
533 534
************************************************************************
*                                                                      *
535 536
        Most of the work for constructors is here
        (the rest is in the ConPatIn case of tc_pat)
Austin Seipp's avatar
Austin Seipp committed
537 538
*                                                                      *
************************************************************************
539

540 541 542 543 544 545 546 547 548 549 550
[Pattern matching indexed data types]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Consider the following declarations:

  data family Map k :: * -> *
  data instance Map (a, b) v = MapPair (Map a (Pair b v))

and a case expression

  case x :: Map (Int, c) w of MapPair m -> ...

551
As explained by [Wrappers for data instance tycons] in MkIds.hs, the
552 553 554 555 556 557 558 559 560 561 562 563 564 565 566
worker/wrapper types for MapPair are

  $WMapPair :: forall a b v. Map a (Map a b v) -> Map (a, b) v
  $wMapPair :: forall a b v. Map a (Map a b v) -> :R123Map a b v

So, the type of the scrutinee is Map (Int, c) w, but the tycon of MapPair is
:R123Map, which means the straight use of boxySplitTyConApp would give a type
error.  Hence, the smart wrapper function boxySplitTyConAppWithFamily calls
boxySplitTyConApp with the family tycon Map instead, which gives us the family
type list {(Int, c), w}.  To get the correct split for :R123Map, we need to
unify the family type list {(Int, c), w} with the instance types {(a, b), v}
(provided by tyConFamInst_maybe together with the family tycon).  This
unification yields the substitution [a -> Int, b -> c, v -> w], which gives us
the split arguments for the representation tycon :R123Map as {Int, c, w}

567
In other words, boxySplitTyConAppWithFamily implicitly takes the coercion
568

569
  Co123Map a b v :: {Map (a, b) v ~ :R123Map a b v}
570 571 572 573 574 575

moving between representation and family type into account.  To produce type
correct Core, this coercion needs to be used to case the type of the scrutinee
from the family to the representation type.  This is achieved by
unwrapFamInstScrutinee using a CoPat around the result pattern.

576
Now it might appear seem as if we could have used the previous GADT type
577 578 579 580 581 582 583 584 585 586 587 588
refinement infrastructure of refineAlt and friends instead of the explicit
unification and CoPat generation.  However, that would be wrong.  Why?  The
whole point of GADT refinement is that the refinement is local to the case
alternative.  In contrast, the substitution generated by the unification of
the family type list and instance types needs to be propagated to the outside.
Imagine that in the above example, the type of the scrutinee would have been
(Map x w), then we would have unified {x, w} with {(a, b), v}, yielding the
substitution [x -> (a, b), v -> w].  In contrast to GADT matching, the
instantiation of x with (a, b) must be global; ie, it must be valid in *all*
alternatives of the case expression, whereas in the GADT case it might vary
between alternatives.

589 590 591
RIP GADT refinement: refinements have been replaced by the use of explicit
equality constraints that are used in conjunction with implication constraints
to express the local scope of GADT refinements.
Austin Seipp's avatar
Austin Seipp committed
592
-}
593

594
--      Running example:
595
-- MkT :: forall a b c. (a~[b]) => b -> c -> T a
596
--       with scrutinee of type (T ty)
597

598 599 600 601
tcConPat :: PatEnv -> Located Name
         -> TcRhoType           -- Type of the pattern
         -> HsConPatDetails Name -> TcM a
         -> TcM (Pat TcId, a)
cactus's avatar
cactus committed
602 603 604 605 606 607 608 609 610 611
tcConPat penv con_lname@(L _ con_name) pat_ty arg_pats thing_inside
  = do  { con_like <- tcLookupConLike con_name
        ; case con_like of
            RealDataCon data_con -> tcDataConPat penv con_lname data_con
                                                 pat_ty arg_pats thing_inside
            PatSynCon pat_syn -> tcPatSynPat penv con_lname pat_syn
                                             pat_ty arg_pats thing_inside
        }

tcDataConPat :: PatEnv -> Located Name -> DataCon
612 613 614
             -> TcRhoType               -- Type of the pattern
             -> HsConPatDetails Name -> TcM a
             -> TcM (Pat TcId, a)
cactus's avatar
cactus committed
615
tcDataConPat penv (L con_span con_name) data_con pat_ty arg_pats thing_inside
616 617 618
  = do  { let tycon = dataConTyCon data_con
                  -- For data families this is the representation tycon
              (univ_tvs, ex_tvs, eq_spec, theta, arg_tys, _)
619
                = dataConFullSig data_con
cactus's avatar
cactus committed
620
              header = L con_span (RealDataCon data_con)
621

622 623 624 625
          -- Instantiate the constructor type variables [a->ty]
          -- This may involve doing a family-instance coercion,
          -- and building a wrapper
        ; (wrap, ctxt_res_tys) <- matchExpectedPatTy (matchExpectedConTy tycon) pat_ty
626

627 628
          -- Add the stupid theta
        ; setSrcSpan con_span $ addDataConStupidTheta data_con ctxt_res_tys
629

630
        ; checkExistentials ex_tvs penv
631 632
        ; (tenv, ex_tvs') <- tcInstSuperSkolTyVarsX
                               (zipTopTvSubst univ_tvs ctxt_res_tys) ex_tvs
633 634
                     -- Get location from monad, not from ex_tvs

635
        ; let -- pat_ty' = mkTyConApp tycon ctxt_res_tys
636
              -- pat_ty' is type of the actual constructor application
637
              -- pat_ty' /= pat_ty iff coi /= IdCo
Simon Peyton Jones's avatar
Simon Peyton Jones committed
638

639
              arg_tys' = substTys tenv arg_tys
640

Simon Peyton Jones's avatar
Simon Peyton Jones committed
641
        ; traceTc "tcConPat" (vcat [ ppr con_name, ppr univ_tvs, ppr ex_tvs, ppr eq_spec
642
                                   , ppr ex_tvs', ppr ctxt_res_tys, ppr arg_tys' ])
643 644
        ; if null ex_tvs && null eq_spec && null theta
          then do { -- The common case; no class bindings etc
645
                    -- (see Note [Arrows and patterns])
646 647 648 649
                    (arg_pats', res) <- tcConArgs (RealDataCon data_con) arg_tys'
                                                  arg_pats penv thing_inside
                  ; let res_pat = ConPatOut { pat_con = header,
                                              pat_tvs = [], pat_dicts = [],
650
                                              pat_binds = emptyTcEvBinds,
651
                                              pat_args = arg_pats',
652
                                              pat_arg_tys = ctxt_res_tys,
cactus's avatar
cactus committed
653
                                              pat_wrap = idHsWrapper }
654

655
                  ; return (mkHsWrapPat wrap res_pat pat_ty, res) }
656

657
          else do   -- The general case, with existential,
658
                    -- and local equality constraints
659
        { let theta'   = substTheta tenv (eqSpecPreds eq_spec ++ theta)
660 661
                           -- order is *important* as we generate the list of
                           -- dictionary binders from theta'
662
              no_equalities = not (any isEqPred theta')
663
              skol_info = case pe_ctxt penv of
cactus's avatar
cactus committed
664
                            LamPat mc -> PatSkol (RealDataCon data_con) mc
665
                            LetPat {} -> UnkSkol -- Doesn't matter
666

667 668
        ; gadts_on    <- xoptM Opt_GADTs
        ; families_on <- xoptM Opt_TypeFamilies
669
        ; checkTc (no_equalities || gadts_on || families_on)
sivteck's avatar
sivteck committed
670 671
                  (text "A pattern match on a GADT requires the" <+>
                   text "GADTs or TypeFamilies language extension")
672 673 674
                  -- Trac #2905 decided that a *pattern-match* of a GADT
                  -- should require the GADT language flag.
                  -- Re TypeFamilies see also #7156
675

676
        ; given <- newEvVars theta'
677
        ; (ev_binds, (arg_pats', res))
678
             <- checkConstraints skol_info ex_tvs' given $
cactus's avatar
cactus committed
679
                tcConArgs (RealDataCon data_con) arg_tys' arg_pats penv thing_inside
680

cactus's avatar
cactus committed
681
        ; let res_pat = ConPatOut { pat_con   = header,
682 683 684 685
                                    pat_tvs   = ex_tvs',
                                    pat_dicts = given,
                                    pat_binds = ev_binds,
                                    pat_args  = arg_pats',
686
                                    pat_arg_tys = ctxt_res_tys,
cactus's avatar
cactus committed
687
                                    pat_wrap  = idHsWrapper }
688 689
        ; return (mkHsWrapPat wrap res_pat pat_ty, res)
        } }
690

cactus's avatar
cactus committed
691
tcPatSynPat :: PatEnv -> Located Name -> PatSyn
692 693 694
            -> TcRhoType                -- Type of the pattern
            -> HsConPatDetails Name -> TcM a
            -> TcM (Pat TcId, a)
cactus's avatar
cactus committed
695
tcPatSynPat penv (L con_span _) pat_syn pat_ty arg_pats thing_inside
696
  = do  { let (univ_tvs, req_theta, ex_tvs, prov_theta, arg_tys, ty) = patSynSig pat_syn
cactus's avatar
cactus committed
697

698
        ; (subst, univ_tvs') <- tcInstTyVars univ_tvs
cactus's avatar
cactus committed
699

700
        ; checkExistentials ex_tvs penv
cactus's avatar
cactus committed
701
        ; (tenv, ex_tvs') <- tcInstSuperSkolTyVarsX subst ex_tvs
702 703
        ; let ty'         = substTy tenv ty
              arg_tys'    = substTys tenv arg_tys
cactus's avatar
cactus committed
704
              prov_theta' = substTheta tenv prov_theta
705
              req_theta'  = substTheta tenv req_theta
cactus's avatar
cactus committed
706

707
        ; wrap <- mkWpCastN <$> unifyType ty' pat_ty
cactus's avatar
cactus committed
708 709 710 711 712 713 714 715 716 717 718 719 720 721
        ; traceTc "tcPatSynPat" (ppr pat_syn $$
                                 ppr pat_ty $$
                                 ppr ty' $$
                                 ppr ex_tvs' $$
                                 ppr prov_theta' $$
                                 ppr req_theta' $$
                                 ppr arg_tys')

        ; prov_dicts' <- newEvVars prov_theta'

        ; let skol_info = case pe_ctxt penv of
                            LamPat mc -> PatSkol (PatSynCon pat_syn) mc
                            LetPat {} -> UnkSkol -- Doesn't matter

722
        ; req_wrap <- instCall PatOrigin (mkTyVarTys univ_tvs') req_theta'
cactus's avatar
cactus committed
723 724
        ; traceTc "instCall" (ppr req_wrap)

725
        ; traceTc "checkConstraints {" Outputable.empty
cactus's avatar
cactus committed
726 727 728 729 730 731
        ; (ev_binds, (arg_pats', res))
             <- checkConstraints skol_info ex_tvs' prov_dicts' $
                tcConArgs (PatSynCon pat_syn) arg_tys' arg_pats penv thing_inside

        ; traceTc "checkConstraints }" (ppr ev_binds)
        ; let res_pat = ConPatOut { pat_con   = L con_span $ PatSynCon pat_syn,
732 733 734 735
                                    pat_tvs   = ex_tvs',
                                    pat_dicts = prov_dicts',
                                    pat_binds = ev_binds,
                                    pat_args  = arg_pats',
736
                                    pat_arg_tys = mkTyVarTys univ_tvs',
cactus's avatar
cactus committed
737
                                    pat_wrap  = req_wrap }
738
        ; return (mkHsWrapPat wrap res_pat pat_ty, res) }
cactus's avatar
cactus committed
739

740
----------------------------
741 742 743 744 745 746 747 748 749 750 751 752 753
downgrade :: (TcRhoType -> TcM (TcCoercionN, a))
          -> TcRhoType -> TcM (TcCoercionR, a)
downgrade f a = do { (co,res) <- f a; return (mkTcSubCo co, res) }

matchExpectedListTyR :: TcRhoType -> TcM (TcCoercionR, TcRhoType)
matchExpectedListTyR = downgrade matchExpectedListTy
matchExpectedPArrTyR :: TcRhoType -> TcM (TcCoercionR, TcRhoType)
matchExpectedPArrTyR = downgrade matchExpectedPArrTy
matchExpectedTyConAppR :: TyCon -> TcRhoType -> TcM (TcCoercionR, [TcSigmaType])
matchExpectedTyConAppR tc = downgrade (matchExpectedTyConApp tc)

----------------------------
matchExpectedPatTy :: (TcRhoType -> TcM (TcCoercionR, a))
754 755
                    -> TcRhoType            -- Type of the pattern
                    -> TcM (HsWrapper, a)
756
-- See Note [Matching polytyped patterns]
757
-- Returns a wrapper : pat_ty ~R inner_ty
758 759
matchExpectedPatTy inner_match pat_ty
  | null tvs && null theta
760 761
  = do { (co, res) <- inner_match pat_ty   -- 'co' is Representational
       ; traceTc "matchExpectedPatTy" (ppr pat_ty $$ ppr co $$ ppr (isTcReflCo co))
762
       ; return (mkWpCastR (mkTcSymCo co), res) }
763 764
         -- The Sym is because the inner_match returns a coercion
         -- that is the other way round to matchExpectedPatTy
765

766
  | otherwise
767 768
  = do { (subst, tvs') <- tcInstTyVars tvs
       ; wrap1 <- instCall PatOrigin (mkTyVarTys tvs') (substTheta subst theta)
769
       ; (wrap2, arg_tys) <- matchExpectedPatTy inner_match (TcType.substTy subst tau)
770
       ; return (wrap2 <.> wrap1, arg_tys) }
771
  where
772 773 774
    (tvs, theta, tau) = tcSplitSigmaTy pat_ty

----------------------------
775 776
matchExpectedConTy :: TyCon      -- The TyCon that this data
                                 -- constructor actually returns
777 778 779 780 781
                                 -- In the case of a data family this is
                                 -- the /representation/ TyCon
                   -> TcRhoType  -- The type of the pattern; in the case
                                 -- of a data family this would mention
                                 -- the /family/ TyCon
782
                   -> TcM (TcCoercionR, [TcSigmaType])
783
-- See Note [Matching constructor patterns]
784
-- Returns a coercion : T ty1 ... tyn ~R pat_ty
785 786 787 788
-- This is the same way round as matchExpectedListTy etc
-- but the other way round to matchExpectedPatTy
matchExpectedConTy data_tc pat_ty
  | Just (fam_tc, fam_args, co_tc) <- tyConFamInstSig_maybe data_tc
789 790
         -- Comments refer to Note [Matching constructor patterns]
         -- co_tc :: forall a. T [a] ~ T7 a
791
  = do { (subst, tvs') <- tcInstTyVars (tyConTyVars data_tc)
792
             -- tys = [ty1,ty2]
793

794
       ; traceTc "matchExpectedConTy" (vcat [ppr data_tc,
795 796
                                             ppr (tyConTyVars data_tc),
                                             ppr fam_tc, ppr fam_args])
batterseapower's avatar
batterseapower committed
797
       ; co1 <- unifyType (mkTyConApp fam_tc (substTys subst fam_args)) pat_ty
798
             -- co1 : T (ty1,ty2) ~N pat_ty
799

800
       ; let tys' = mkTyVarTys tvs'
801
             co2 = mkTcUnbranchedAxInstCo co_tc tys'