TcPat.hs 44.9 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
import SrcLoc
46
import VarSet
47
import Util
sof's avatar
sof committed
48
import Outputable
49
import FastString
50
import Maybes( orElse )
51
import qualified GHC.LanguageExtensions as LangExt
Ian Lynagh's avatar
Ian Lynagh committed
52
import Control.Monad
53

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

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

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

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

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

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

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

105

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

data PatCtxt
  = LamPat   -- Used for lambdas, case etc
114
       (HsMatchContext Name)
115

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

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

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

130 131 132
makeLazy :: PatEnv -> PatEnv
makeLazy penv = penv { pe_lazy = True }

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

---------------
138
type TcPragEnv = NameEnv [LSig Name]
139
type TcSigFun  = Name -> Maybe TcSigInfo
140

141 142 143 144 145 146
emptyPragEnv :: TcPragEnv
emptyPragEnv = emptyNameEnv

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

147
{- *********************************************************************
Austin Seipp's avatar
Austin Seipp committed
148
*                                                                      *
149
                Binders
Austin Seipp's avatar
Austin Seipp committed
150
*                                                                      *
151
********************************************************************* -}
152

153
tcPatBndr :: PatEnv -> Name -> TcSigmaType -> TcM (TcCoercionN, TcId)
154 155 156 157
-- (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
158
          -- See Note [Typing patterns in pattern bindings]
159 160 161
  | LetGblBndr prags   <- no_gen
  , Just (TcIdSig sig) <- lookup_sig bndr_name
  , Just poly_id <- completeIdSigPolyId_maybe sig
162
  = do { bndr_id <- addInlinePrags poly_id (lookupPragEnv prags bndr_name)
163
       ; traceTc "tcPatBndr(gbl,sig)" (ppr bndr_id $$ ppr (idType bndr_id))
164
       ; co <- unifyPatType bndr_id (idType bndr_id) pat_ty
batterseapower's avatar
batterseapower committed
165
       ; return (co, bndr_id) }
166 167

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

tcPatBndr (PE { pe_ctxt = _lam_or_proc }) bndr_name pat_ty
173
  = return (mkTcNomReflCo pat_ty, mkLocalId bndr_name pat_ty)
174

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

----------
addInlinePrags :: TcId -> [LSig Name] -> TcM TcId
addInlinePrags poly_id prags
191 192 193 194 195 196
  | 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
197
  where
198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214
    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)
215

Austin Seipp's avatar
Austin Seipp committed
216
{-
217 218 219 220 221 222 223 224
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
225
     x :: forall a. a->a
226 227 228 229 230 231 232 233 234 235
     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
236
   generalisation step will do the checking and impedance matching
237 238 239 240 241 242 243 244
   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.

245

Austin Seipp's avatar
Austin Seipp committed
246 247
************************************************************************
*                                                                      *
248
                The main worker functions
Austin Seipp's avatar
Austin Seipp committed
249 250
*                                                                      *
************************************************************************
251

252 253
Note [Nesting]
~~~~~~~~~~~~~~
lennart@augustsson.net's avatar
lennart@augustsson.net committed
254
tcPat takes a "thing inside" over which the pattern scopes.  This is partly
255
so that tcPat can extend the environment for the thing_inside, but also
256 257 258 259
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
260
want the error-context for the pattern to scope over the RHS.
261
Hence the getErrCtxt/setErrCtxt stuff in tcMultiple
Austin Seipp's avatar
Austin Seipp committed
262
-}
263 264

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

tcMultiple :: Checker inp out -> Checker [inp] [out]
272
tcMultiple tc_pat args penv thing_inside
273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288
  = 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 }
289 290

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

tc_lpats :: PatEnv
303 304 305 306
         -> [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
307
  = ASSERT2( equalLength pats tys, ppr pats $$ ppr tys )
308
    tcMultiple (\(p,t) -> tc_lpat p t)
309
                (zipEqual "tc_lpats" pats tys)
310
                penv thing_inside
311 312

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

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

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

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

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

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

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

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

351
        ; return (LazyPat pat', res) }
352

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

357
tc_pat penv (AsPat (L nm_loc name) pat) pat_ty thing_inside
358
  = do  { (co, bndr_id) <- setSrcSpan nm_loc (tcPatBndr penv name pat_ty)
batterseapower's avatar
batterseapower committed
359
        ; (pat', res) <- tcExtendIdEnv1 name bndr_id $
360 361 362 363 364 365 366 367 368 369 370 371 372
                         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`
373 374 375 376
         -- 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.
377 378
        ; (expr',expr'_inferred) <- tcInferRho expr

379
         -- next, we check that expr is coercible to `overall_pat_ty -> pat_ty`
380
         -- NOTE: this forces pat_ty to be a monotype (because we use a unification
381 382 383 384
         -- 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
385
        ; (expr_co, pat_ty) <- tcInfer $ \ pat_ty ->
386
                unifyType (Just expr) expr'_inferred (mkFunTy overall_pat_ty pat_ty)
387

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

391
        ; return (ViewPat (mkLHsWrapCo expr_co expr') pat' overall_pat_ty, res) }
392

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

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

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

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

428
tc_pat penv (TuplePat pats boxity _) pat_ty thing_inside
429 430
  = do  { let arity = length pats
              tc = tupleTyCon boxity arity
431
        ; (coi, arg_tys) <- matchExpectedPatTy (matchExpectedTyConAppR tc) pat_ty
432 433 434 435 436
                     -- Unboxed tuples have levity vars, which we discard:
                     -- See Note [Unboxed tuple levity vars] in TyCon
        ; let con_arg_tys = case boxity of Unboxed -> drop arity arg_tys
                                           Boxed   -> arg_tys
        ; (pats', res) <- tc_lpats penv pats con_arg_tys thing_inside
437

438
        ; dflags <- getDynFlags
439

440 441 442 443 444
        -- 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
445
              unmangled_result = TuplePat pats' boxity con_arg_tys
446
                                 -- pat_ty /= pat_ty iff coi /= IdCo
447 448
              possibly_mangled_result
                | gopt Opt_IrrefutableTuples dflags &&
449
                  isBoxed boxity            = LazyPat (noLoc unmangled_result)
450
                | otherwise                 = unmangled_result
451

452
        ; ASSERT( length con_arg_tys == length pats ) -- Syntactically enforced
453
          return (mkHsWrapPat coi possibly_mangled_result pat_ty, res)
454
        }
455 456 457

------------------------
-- Data constructors
458 459
tc_pat penv (ConPatIn con arg_pats) pat_ty thing_inside
  = tcConPat penv con pat_ty arg_pats thing_inside
460 461 462

------------------------
-- Literal patterns
463
tc_pat _ (LitPat simple_lit) pat_ty thing_inside
464
  = do  { let lit_ty = hsLitType simple_lit
465
        ; co <- unifyPatType simple_lit lit_ty pat_ty
466 467 468
                -- coi is of kind: pat_ty ~ lit_ty
        ; res <- thing_inside
        ; return ( mkHsWrapPatCo co (LitPat simple_lit) pat_ty
469
                 , res) }
470 471 472

------------------------
-- Overloaded patterns: n, and n+k
Alan Zimmerman's avatar
Alan Zimmerman committed
473
tc_pat _ (NPat (L l over_lit) mb_neg eq) pat_ty thing_inside
474 475 476 477 478 479 480 481 482 483
  = 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
484
        ; return (NPat (L l lit') mb_neg' eq', res) }
485

Alan Zimmerman's avatar
Alan Zimmerman committed
486
tc_pat penv (NPlusKPat (L nm_loc name) (L loc lit) ge minus) pat_ty thing_inside
487
  = do  { (co, bndr_id) <- setSrcSpan nm_loc (tcPatBndr penv name pat_ty)
batterseapower's avatar
batterseapower committed
488
        ; let pat_ty' = idType bndr_id
489 490
              orig    = LiteralOrigin lit
        ; lit' <- newOverloadedLit orig lit pat_ty'
491

492 493 494
        -- 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
495
        ; let pat' = NPlusKPat (L nm_loc bndr_id) (L loc lit') ge' minus'
496

497 498 499 500
        -- 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']]
501

502 503 504 505
        ; res <- tcExtendIdEnv1 name bndr_id thing_inside
        ; return (mkHsWrapPatCo co pat' pat_ty, res) }

tc_pat _ _other_pat _ _ = panic "tc_pat"        -- ConPatOut, SigPatOut
506 507

----------------
508
unifyPatType :: Outputable a => a -> TcType -> TcType -> TcM TcCoercion
509 510 511 512
-- 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
513 514
unifyPatType thing actual_ty expected_ty
  = do { coi <- unifyType (Just thing) actual_ty expected_ty
515
       ; return (mkTcSymCo coi) }
516

Austin Seipp's avatar
Austin Seipp committed
517
{-
518 519 520 521
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.
522
        f ~(C x) = 3
523
We can't discharge the Num constraint from dictionaries bound by
524
the pattern C!
525

526
So we have to make the constraints from thing_inside "hop around"
527
the pattern.  Hence the captureConstraints and emitConstraints.
528 529 530

The same thing ensures that equality constraints in a lazy match
are not made available in the RHS of the match. For example
531 532 533
        data T a where { T1 :: Int -> T Int; ... }
        f :: T a -> Int -> a
        f ~(T1 i) y = y
534
It's obviously not sound to refine a to Int in the right
535
hand side, because the argument might not match T1 at all!
536 537 538 539

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

540

Austin Seipp's avatar
Austin Seipp committed
541 542
************************************************************************
*                                                                      *
543 544
        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
545 546
*                                                                      *
************************************************************************
547

548 549 550 551 552 553 554 555 556 557 558
[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 -> ...

559
As explained by [Wrappers for data instance tycons] in MkIds.hs, the
560 561 562 563 564 565 566 567 568 569 570 571 572 573 574
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}

575
In other words, boxySplitTyConAppWithFamily implicitly takes the coercion
576

577
  Co123Map a b v :: {Map (a, b) v ~ :R123Map a b v}
578 579 580 581 582 583

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.

584
Now it might appear seem as if we could have used the previous GADT type
585 586 587 588 589 590 591 592 593 594 595 596
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.

597 598 599
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
600
-}
601

602
--      Running example:
603
-- MkT :: forall a b c. (a~[b]) => b -> c -> T a
604
--       with scrutinee of type (T ty)
605

606 607 608 609
tcConPat :: PatEnv -> Located Name
         -> TcRhoType           -- Type of the pattern
         -> HsConPatDetails Name -> TcM a
         -> TcM (Pat TcId, a)
cactus's avatar
cactus committed
610 611 612 613 614 615 616 617 618 619
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
620 621 622
             -> TcRhoType               -- Type of the pattern
             -> HsConPatDetails Name -> TcM a
             -> TcM (Pat TcId, a)
cactus's avatar
cactus committed
623
tcDataConPat penv (L con_span con_name) data_con pat_ty arg_pats thing_inside
624 625 626
  = do  { let tycon = dataConTyCon data_con
                  -- For data families this is the representation tycon
              (univ_tvs, ex_tvs, eq_spec, theta, arg_tys, _)
627
                = dataConFullSig data_con
cactus's avatar
cactus committed
628
              header = L con_span (RealDataCon data_con)
629

630 631 632 633
          -- 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
634

635 636
          -- Add the stupid theta
        ; setSrcSpan con_span $ addDataConStupidTheta data_con ctxt_res_tys
637

638 639
        ; let all_arg_tys = eqSpecPreds eq_spec ++ theta ++ arg_tys
        ; checkExistentials ex_tvs all_arg_tys penv
640
        ; (tenv, ex_tvs') <- tcInstSuperSkolTyVarsX
641
                               (zipTopTCvSubst univ_tvs ctxt_res_tys) ex_tvs
642 643
                     -- Get location from monad, not from ex_tvs

644
        ; let -- pat_ty' = mkTyConApp tycon ctxt_res_tys
645
              -- pat_ty' is type of the actual constructor application
646
              -- pat_ty' /= pat_ty iff coi /= IdCo
Simon Peyton Jones's avatar
Simon Peyton Jones committed
647

648
              arg_tys' = substTys tenv arg_tys
649

650 651 652 653
        ; traceTc "tcConPat" (vcat [ ppr con_name, ppr univ_tvs, ppr ex_tvs
                                   , ppr eq_spec
                                   , ppr ex_tvs', ppr ctxt_res_tys, ppr arg_tys'
                                   , ppr arg_pats ])
654 655
        ; if null ex_tvs && null eq_spec && null theta
          then do { -- The common case; no class bindings etc
656
                    -- (see Note [Arrows and patterns])
657 658 659 660
                    (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 = [],
661
                                              pat_binds = emptyTcEvBinds,
662
                                              pat_args = arg_pats',
663
                                              pat_arg_tys = ctxt_res_tys,
cactus's avatar
cactus committed
664
                                              pat_wrap = idHsWrapper }
665

666
                  ; return (mkHsWrapPat wrap res_pat pat_ty, res) }
667

668
          else do   -- The general case, with existential,
669
                    -- and local equality constraints
670
        { let theta'     = substTheta tenv (eqSpecPreds eq_spec ++ theta)
671 672
                           -- order is *important* as we generate the list of
                           -- dictionary binders from theta'
673
              no_equalities = not (any isNomEqPred theta')
674
              skol_info = case pe_ctxt penv of
cactus's avatar
cactus committed
675
                            LamPat mc -> PatSkol (RealDataCon data_con) mc
676
                            LetPat {} -> UnkSkol -- Doesn't matter
677

678 679
        ; gadts_on    <- xoptM LangExt.GADTs
        ; families_on <- xoptM LangExt.TypeFamilies
680
        ; checkTc (no_equalities || gadts_on || families_on)
sivteck's avatar
sivteck committed
681 682
                  (text "A pattern match on a GADT requires the" <+>
                   text "GADTs or TypeFamilies language extension")
683 684 685
                  -- Trac #2905 decided that a *pattern-match* of a GADT
                  -- should require the GADT language flag.
                  -- Re TypeFamilies see also #7156
686

687
        ; given <- newEvVars theta'
688
        ; (ev_binds, (arg_pats', res))
689
             <- checkConstraints skol_info ex_tvs' given $
cactus's avatar
cactus committed
690
                tcConArgs (RealDataCon data_con) arg_tys' arg_pats penv thing_inside
691

cactus's avatar
cactus committed
692
        ; let res_pat = ConPatOut { pat_con   = header,
693 694 695 696
                                    pat_tvs   = ex_tvs',
                                    pat_dicts = given,
                                    pat_binds = ev_binds,
                                    pat_args  = arg_pats',
697
                                    pat_arg_tys = ctxt_res_tys,
cactus's avatar
cactus committed
698
                                    pat_wrap  = idHsWrapper }
699 700
        ; return (mkHsWrapPat wrap res_pat pat_ty, res)
        } }
701

cactus's avatar
cactus committed
702
tcPatSynPat :: PatEnv -> Located Name -> PatSyn
703 704 705
            -> TcRhoType                -- Type of the pattern
            -> HsConPatDetails Name -> TcM a
            -> TcM (Pat TcId, a)
cactus's avatar
cactus committed
706
tcPatSynPat penv (L con_span _) pat_syn pat_ty arg_pats thing_inside
707
  = do  { let (univ_tvs, req_theta, ex_tvs, prov_theta, arg_tys, ty) = patSynSig pat_syn
cactus's avatar
cactus committed
708

709
        ; (subst, univ_tvs') <- newMetaTyVars univ_tvs
cactus's avatar
cactus committed
710

711 712
        ; let all_arg_tys = ty : prov_theta ++ arg_tys
        ; checkExistentials ex_tvs all_arg_tys penv
cactus's avatar
cactus committed
713
        ; (tenv, ex_tvs') <- tcInstSuperSkolTyVarsX subst ex_tvs
714 715
        ; let ty'         = substTy tenv ty
              arg_tys'    = substTys tenv arg_tys
cactus's avatar
cactus committed
716
              prov_theta' = substTheta tenv prov_theta
717
              req_theta'  = substTheta tenv req_theta
cactus's avatar
cactus committed
718

719
        ; wrap <- mkWpCastN <$> unifyType noThing ty' pat_ty
cactus's avatar
cactus committed
720 721 722 723 724 725 726 727 728 729 730 731 732 733
        ; 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

734
        ; req_wrap <- instCall PatOrigin (mkTyVarTys univ_tvs') req_theta'
cactus's avatar
cactus committed
735 736
        ; traceTc "instCall" (ppr req_wrap)

737
        ; traceTc "checkConstraints {" Outputable.empty
cactus's avatar
cactus committed
738 739 740 741 742 743
        ; (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,
744 745 746 747
                                    pat_tvs   = ex_tvs',
                                    pat_dicts = prov_dicts',
                                    pat_binds = ev_binds,
                                    pat_args  = arg_pats',
748
                                    pat_arg_tys = mkTyVarTys univ_tvs',
cactus's avatar
cactus committed
749
                                    pat_wrap  = req_wrap }
750
        ; return (mkHsWrapPat wrap res_pat pat_ty, res) }
cactus's avatar
cactus committed
751

752
----------------------------
753 754 755 756 757 758 759 760 761 762 763 764 765
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))
766 767
                    -> TcRhoType            -- Type of the pattern
                    -> TcM (HsWrapper, a)
768
-- See Note [Matching polytyped patterns]
769
-- Returns a wrapper : pat_ty ~R inner_ty
770 771
matchExpectedPatTy inner_match pat_ty
  | null tvs && null theta
772 773
  = do { (co, res) <- inner_match pat_ty   -- 'co' is Representational
       ; traceTc "matchExpectedPatTy" (ppr pat_ty $$ ppr co $$ ppr (isTcReflCo co))
774
       ; return (mkWpCastR (mkTcSymCo co), res) }
775 776
         -- The Sym is because the inner_match returns a coercion
         -- that is the other way round to matchExpectedPatTy
777

778
  | otherwise
779
  = do { (subst, tvs') <- newMetaTyVars tvs
780
       ; wrap1 <- instCall PatOrigin (mkTyVarTys tvs') (substTheta subst theta)
781
       ; (wrap2, arg_tys) <- matchExpectedPatTy inner_match (TcType.substTy subst tau)
782
       ; return (wrap2 <.> wrap1, arg_tys) }
783
  where
784 785 786
    (tvs, theta, tau) = tcSplitSigmaTy pat_ty

----------------------------
787 788
matchExpectedConTy :: TyCon      -- The TyCon that this data
                                 -- constructor actually returns
789 790 791 792 793
                                 -- 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
794
                   -> TcM (TcCoercionR, [TcSigmaType])
795
-- See Note [Matching constructor patterns]
796
-- Returns a coercion : T ty1 ... tyn ~R pat_ty
797 798 799