TcPatSyn.hs 35 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

cactus's avatar
cactus committed
5
\section[TcPatSyn]{Typechecking pattern synonym declarations}
Austin Seipp's avatar
Austin Seipp committed
6
-}
cactus's avatar
cactus committed
7

8
{-# LANGUAGE CPP #-}
9
{-# LANGUAGE FlexibleContexts #-}
10

11
module TcPatSyn ( tcInferPatSynDecl, tcCheckPatSynDecl
Matthew Pickering's avatar
Matthew Pickering committed
12
                , tcPatSynBuilderBind, tcPatSynBuilderOcc, nonBidirectionalErr
13
  ) where
cactus's avatar
cactus committed
14 15 16

import HsSyn
import TcPat
17 18
import Type( mkTyVarBinders, mkEmptyTCvSubst
           , tidyTyVarBinders, tidyTypes, tidyType )
cactus's avatar
cactus committed
19
import TcRnMonad
20
import TcSigs( emptyPragEnv, completeSigFromId )
cactus's avatar
cactus committed
21 22 23
import TcEnv
import TcMType
import TysPrim
24
import TysWiredIn  ( runtimeRepTy )
cactus's avatar
cactus committed
25 26 27 28 29 30 31 32
import Name
import SrcLoc
import PatSyn
import NameSet
import Panic
import Outputable
import FastString
import Var
33
import VarEnv( emptyTidyEnv, mkInScopeSet )
cactus's avatar
cactus committed
34
import Id
35
import IdInfo( RecSelParent(..))
cactus's avatar
cactus committed
36 37 38
import TcBinds
import BasicTypes
import TcSimplify
39
import TcUnify
cactus's avatar
cactus committed
40
import TcType
41 42
import TcEvidence
import BuildTyCl
cactus's avatar
cactus committed
43
import VarSet
44
import MkId
45
import TcTyDecls
Matthew Pickering's avatar
Matthew Pickering committed
46 47
import ConLike
import FieldLabel
cactus's avatar
cactus committed
48
import Bag
49
import Util
50
import ErrUtils
51
import FV
52
import Control.Monad ( zipWithM )
53
import Data.List( partition )
cactus's avatar
cactus committed
54 55 56

#include "HsVersions.h"

Austin Seipp's avatar
Austin Seipp committed
57 58 59
{-
************************************************************************
*                                                                      *
60
                    Type checking a pattern synonym
Austin Seipp's avatar
Austin Seipp committed
61 62 63
*                                                                      *
************************************************************************
-}
64

65
tcInferPatSynDecl :: PatSynBind Name Name
66
                  -> TcM (LHsBinds Id, TcGblEnv)
67
tcInferPatSynDecl PSB{ psb_id = lname@(L _ name), psb_args = details,
68
                       psb_def = lpat, psb_dir = dir }
69
  = addPatSynCtxt lname $
70
    do { traceTc "tcInferPatSynDecl {" $ ppr name
71
       ; tcCheckPatSynPat lpat
cactus's avatar
cactus committed
72

Matthew Pickering's avatar
Matthew Pickering committed
73
       ; let (arg_names, rec_fields, is_infix) = collectPatSynArgInfo details
74
       ; (tclvl, wanted, ((lpat', args), pat_ty))
75
            <- pushLevelAndCaptureConstraints  $
76 77 78 79 80
               do { pat_ty <- newOpenInferExpType
                  ; stuff <- tcPat PatSyn lpat pat_ty $
                             mapM tcLookupId arg_names
                  ; pat_ty <- readExpType pat_ty
                  ; return (stuff, pat_ty) }
81 82

       ; let named_taus = (name, pat_ty) : map (\arg -> (getName arg, varType arg)) args
cactus's avatar
cactus committed
83

84 85
       ; (qtvs, req_dicts, ev_binds) <- simplifyInfer tclvl NoRestrictions []
                                                      named_taus wanted
cactus's avatar
cactus committed
86

87
       ; let ((ex_tvs, ex_vars), prov_dicts) = tcCollectEx lpat'
88
             univ_tvs   = filter (not . (`elemVarSet` ex_vars)) qtvs
89 90
             prov_theta = map evVarPred prov_dicts
             req_theta  = map evVarPred req_dicts
cactus's avatar
cactus committed
91

92
       ; traceTc "tcInferPatSynDecl }" $ ppr name
93
       ; tc_patsyn_finish lname dir is_infix lpat'
Simon Peyton Jones's avatar
Simon Peyton Jones committed
94
                          (mkTyVarBinders Invisible univ_tvs
95
                            , req_theta,  ev_binds, req_dicts)
Simon Peyton Jones's avatar
Simon Peyton Jones committed
96
                          (mkTyVarBinders Invisible ex_tvs
97
                            , mkTyVarTys ex_tvs, prov_theta, map EvId prov_dicts)
98
                          (map nlHsVar args, map idType args)
Matthew Pickering's avatar
Matthew Pickering committed
99 100
                          pat_ty rec_fields }

101 102 103

tcCheckPatSynDecl :: PatSynBind Name Name
                  -> TcPatSynInfo
104
                  -> TcM (LHsBinds Id, TcGblEnv)
105 106
tcCheckPatSynDecl psb@PSB{ psb_id = lname@(L _ name), psb_args = details
                         , psb_def = lpat, psb_dir = dir }
107 108 109 110
                  TPSI{ patsig_implicit_bndrs = implicit_tvs
                      , patsig_univ_bndrs = explicit_univ_tvs, patsig_prov = prov_theta
                      , patsig_ex_bndrs   = explicit_ex_tvs,   patsig_req  = req_theta
                      , patsig_body_ty    = sig_body_ty }
111
  = addPatSynCtxt lname $
112
    do { let decl_arity = length arg_names
113 114 115
             (arg_names, rec_fields, is_infix) = collectPatSynArgInfo details

       ; traceTc "tcCheckPatSynDecl" $
116 117
         vcat [ ppr implicit_tvs, ppr explicit_univ_tvs, ppr req_theta
              , ppr explicit_ex_tvs, ppr prov_theta, ppr sig_body_ty ]
118

119 120
       ; tcCheckPatSynPat lpat

121 122 123 124 125 126 127 128 129 130 131 132 133 134 135
       ; (arg_tys, pat_ty) <- case tcSplitFunTysN decl_arity sig_body_ty of
                                 Right stuff  -> return stuff
                                 Left missing -> wrongNumberOfParmsErr name decl_arity missing

       -- Complain about:  pattern P :: () => forall x. x -> P x
       -- The existential 'x' should not appear in the result type
       -- Can't check this until we know P's arity
       ; let bad_tvs = filter (`elemVarSet` tyCoVarsOfType pat_ty) explicit_ex_tvs
       ; checkTc (null bad_tvs) $
         hang (sep [ text "The result type of the signature for" <+> quotes (ppr name) <> comma
                   , text "namely" <+> quotes (ppr pat_ty) ])
            2 (text "mentions existential type variable" <> plural bad_tvs
               <+> pprQuotedList bad_tvs)

         -- See Note [The pattern-synonym signature splitting rule]
136
       ; let univ_fvs = closeOverKinds $
137
                        (tyCoVarsOfTypes (pat_ty : req_theta) `extendVarSetList` explicit_univ_tvs)
138 139 140 141 142
             (extra_univ, extra_ex) = partition ((`elemVarSet` univ_fvs) . binderVar) implicit_tvs
             univ_bndrs = extra_univ ++ mkTyVarBinders Specified explicit_univ_tvs
             ex_bndrs   = extra_ex   ++ mkTyVarBinders Specified explicit_ex_tvs
             univ_tvs   = binderVars univ_bndrs
             ex_tvs     = binderVars ex_bndrs
143

144 145
       -- Right!  Let's check the pattern against the signature
       -- See Note [Checking against a pattern signature]
146
       ; req_dicts <- newEvVars req_theta
147 148
       ; (tclvl, wanted, (lpat', (ex_tvs', prov_dicts, args'))) <-
           ASSERT2( equalLength arg_names arg_tys, ppr name $$ ppr arg_names $$ ppr arg_tys )
149 150 151
           pushLevelAndCaptureConstraints            $
           tcExtendTyVarEnv univ_tvs                 $
           tcPat PatSyn lpat (mkCheckExpType pat_ty) $
152 153 154 155 156
           do { let new_tv | isUnidirectional dir = newMetaTyVarX
                           | otherwise            = newMetaSigTyVarX
                    in_scope    = mkInScopeSet (mkVarSet univ_tvs)
                    empty_subst = mkEmptyTCvSubst in_scope
              ; (subst, ex_tvs') <- mapAccumLM new_tv empty_subst ex_tvs
Rik Steenkamp's avatar
Rik Steenkamp committed
157
                    -- See the "Existential type variables" part of
158
                    -- Note [Checking against a pattern signature]
159 160
              ; traceTc "tcpatsyn1" (vcat [ ppr v <+> dcolon <+> ppr (tyVarKind v) | v <- ex_tvs])
              ; traceTc "tcpatsyn2" (vcat [ ppr v <+> dcolon <+> ppr (tyVarKind v) | v <- ex_tvs'])
161
              ; let prov_theta' = substTheta subst prov_theta
162
                  -- Add univ_tvs to the in_scope set to
163 164 165 166
                  -- satisfy the substition invariant. There's no need to
                  -- add 'ex_tvs' as they are already in the domain of the
                  -- substitution.
                  -- See also Note [The substitution invariant] in TyCoRep.
167
              ; prov_dicts <- mapM (emitWanted (ProvCtxtOrigin psb)) prov_theta'
168 169 170
              ; args'      <- zipWithM (tc_arg subst) arg_names arg_tys
              ; return (ex_tvs', prov_dicts, args') }

171 172 173 174
       ; let skol_info = SigSkol (PatSynCtxt name) (mkPhiTy req_theta pat_ty)
                         -- The type here is a bit bogus, but we do not print
                         -- the type for PatSynCtxt, so it doesn't matter
                         -- See TcRnTypes Note [Skolem info for pattern synonyms]
175
       ; (implics, ev_binds) <- buildImplicationFor tclvl skol_info univ_tvs req_dicts wanted
176

177 178 179
       -- Solve the constraints now, because we are about to make a PatSyn,
       -- which should not contain unification variables and the like (Trac #10997)
       -- Since all the inputs are implications the returned bindings will be empty
180
       ; _ <- simplifyTop (mkImplicWC implics)
181 182 183 184

       -- ToDo: in the bidirectional case, check that the ex_tvs' are all distinct
       -- Otherwise we may get a type error when typechecking the builder,
       -- when that should be impossible
185

186
       ; traceTc "tcCheckPatSynDecl }" $ ppr name
187
       ; tc_patsyn_finish lname dir is_infix lpat'
Simon Peyton Jones's avatar
Simon Peyton Jones committed
188 189
                          (univ_bndrs, req_theta, ev_binds, req_dicts)
                          (ex_bndrs, mkTyVarTys ex_tvs', prov_theta, prov_dicts)
190
                          (args', arg_tys)
191
                          pat_ty rec_fields }
192
  where
193 194 195 196 197 198 199
    tc_arg :: TCvSubst -> Name -> Type -> TcM (LHsExpr TcId)
    tc_arg subst arg_name arg_ty
      = do {   -- Look up the variable actually bound by lpat
               -- and check that it has the expected type
             arg_id <- tcLookupId arg_name
           ; coi <- unifyType (Just arg_id)
                              (idType arg_id)
200
                              (substTyUnchecked subst arg_ty)
201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217
           ; return (mkLHsWrapCo coi $ nlHsVar arg_id) }

{- Note [Checking against a pattern signature]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
When checking the actual supplied pattern against the pattern synonym
signature, we need to be quite careful.

----- Provided constraints
Example

    data T a where
      MkT :: Ord a => a -> T a

    pattern P :: () => Eq a => a -> [T a]
    pattern P x = [MkT x]

We must check that the (Eq a) that P claims to bind (and to
Rik Steenkamp's avatar
Rik Steenkamp committed
218 219
make available to matches against P), is derivable from the
actual pattern.  For example:
220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250
    f (P (x::a)) = ...here (Eq a) should be available...
And yes, (Eq a) is derivable from the (Ord a) bound by P's rhs.

----- Existential type variables
Unusually, we instantiate the existential tyvars of the pattern with
*meta* type variables.  For example

    data S where
      MkS :: Eq a => [a] -> S

    pattern P :: () => Eq x => x -> S
    pattern P x <- MkS x

The pattern synonym conceals from its client the fact that MkS has a
list inside it.  The client just thinks it's a type 'x'.  So we must
unify x := [a] during type checking, and then use the instantiating type
[a] (called ex_tys) when building the matcher.  In this case we'll get

   $mP :: S -> (forall x. Ex x => x -> r) -> r -> r
   $mP x k = case x of
               MkS a (d:Eq a) (ys:[a]) -> let dl :: Eq [a]
                                              dl = $dfunEqList d
                                          in k [a] dl ys

This "concealing" story works for /uni-directional/ pattern synonmys,
but obviously not for bidirectional ones.  So in the bidirectional case
we use SigTv, rather than a generic TauTv, meta-tyvar so that.  And
we should really check that those SigTvs don't get unified with each
other.

-}
251

Matthew Pickering's avatar
Matthew Pickering committed
252 253 254 255 256 257 258 259 260 261 262 263 264 265 266
collectPatSynArgInfo :: HsPatSynDetails (Located Name) -> ([Name], [Name], Bool)
collectPatSynArgInfo details =
  case details of
    PrefixPatSyn names      -> (map unLoc names, [], False)
    InfixPatSyn name1 name2 -> (map unLoc [name1, name2], [], True)
    RecordPatSyn names ->
      let (vars, sels) = unzip (map splitRecordPatSyn names)
      in (vars, sels, False)

  where
    splitRecordPatSyn :: RecordPatSynField (Located Name) -> (Name, Name)
    splitRecordPatSyn (RecordPatSynField { recordPatSynPatVar = L _ patVar
                                         , recordPatSynSelectorId = L _ selId })
      = (patVar, selId)

267 268 269
addPatSynCtxt :: Located Name -> TcM a -> TcM a
addPatSynCtxt (L loc name) thing_inside
  = setSrcSpan loc $
270
    addErrCtxt (text "In the declaration for pattern synonym"
271 272 273
                <+> quotes (ppr name)) $
    thing_inside

274 275 276 277
wrongNumberOfParmsErr :: Name -> Arity -> Arity -> TcM a
wrongNumberOfParmsErr name decl_arity missing
  = failWithTc $
    hang (text "Pattern synonym" <+> quotes (ppr name) <+> ptext (sLit "has")
278
          <+> speakNOf decl_arity (text "argument"))
279
       2 (text "but its type signature has" <+> int missing <+> text "fewer arrows")
280

281 282
-------------------------
-- Shared by both tcInferPatSyn and tcCheckPatSyn
Matthew Pickering's avatar
Matthew Pickering committed
283 284 285 286
tc_patsyn_finish :: Located Name  -- ^ PatSyn Name
                 -> HsPatSynDir Name  -- ^ PatSyn type (Uni/Bidir/ExplicitBidir)
                 -> Bool              -- ^ Whether infix
                 -> LPat Id           -- ^ Pattern of the PatSyn
Simon Peyton Jones's avatar
Simon Peyton Jones committed
287 288
                 -> ([TcTyVarBinder], [PredType], TcEvBinds, [EvVar])
                 -> ([TcTyVarBinder], [TcType], [PredType], [EvTerm])
289
                 -> ([LHsExpr TcId], [TcType])   -- ^ Pattern arguments and types
Matthew Pickering's avatar
Matthew Pickering committed
290 291 292
                 -> TcType              -- ^ Pattern type
                 -> [Name]              -- ^ Selector names
                 -- ^ Whether fields, empty if not record PatSyn
293
                 -> TcM (LHsBinds Id, TcGblEnv)
294
tc_patsyn_finish lname dir is_infix lpat'
Simon Peyton Jones's avatar
Simon Peyton Jones committed
295 296
                 (univ_bndrs, req_theta, req_ev_binds, req_dicts)
                 (ex_bndrs, ex_tys, prov_theta, prov_dicts)
297
                 (args, arg_tys)
Matthew Pickering's avatar
Matthew Pickering committed
298
                 pat_ty field_labels
299 300
  = do { -- Zonk everything.  We are about to build a final PatSyn
         -- so there had better be no unification variables in there
Simon Peyton Jones's avatar
Simon Peyton Jones committed
301 302
         univ_tvs'    <- mapMaybeM zonk_qtv univ_bndrs
       ; ex_tvs'      <- mapMaybeM zonk_qtv ex_bndrs
303 304 305 306 307
       ; prov_theta'  <- zonkTcTypes prov_theta
       ; req_theta'   <- zonkTcTypes req_theta
       ; pat_ty'      <- zonkTcType pat_ty
       ; arg_tys'     <- zonkTcTypes arg_tys

Simon Peyton Jones's avatar
Simon Peyton Jones committed
308 309
       ; let (env1, univ_tvs) = tidyTyVarBinders emptyTidyEnv univ_tvs'
             (env2, ex_tvs)   = tidyTyVarBinders env1 ex_tvs'
310 311 312 313
             req_theta  = tidyTypes env2 req_theta'
             prov_theta = tidyTypes env2 prov_theta'
             arg_tys    = tidyTypes env2 arg_tys'
             pat_ty     = tidyType  env2 pat_ty'
314

315
       ; traceTc "tc_patsyn_finish {" $
316
           ppr (unLoc lname) $$ ppr (unLoc lpat') $$
Simon Peyton Jones's avatar
Simon Peyton Jones committed
317 318
           ppr (univ_tvs, req_theta, req_ev_binds, req_dicts) $$
           ppr (ex_tvs, prov_theta, prov_dicts) $$
319 320
           ppr args $$
           ppr arg_tys $$
321
           ppr pat_ty
322 323

       -- Make the 'matcher'
324
       ; (matcher_id, matcher_bind) <- tcPatSynMatcher lname lpat'
325 326
                                         (binderVars univ_tvs, req_theta, req_ev_binds, req_dicts)
                                         (binderVars ex_tvs, ex_tys, prov_theta, prov_dicts)
327
                                         (args, arg_tys)
cactus's avatar
cactus committed
328
                                         pat_ty
329

Matthew Pickering's avatar
Matthew Pickering committed
330

331
       -- Make the 'builder'
332
       ; builder_id <- mkPatSynBuilderId dir lname
Simon Peyton Jones's avatar
Simon Peyton Jones committed
333 334
                                         univ_tvs req_theta
                                         ex_tvs   prov_theta
Matthew Pickering's avatar
Matthew Pickering committed
335
                                         arg_tys pat_ty
Matthew Pickering's avatar
Matthew Pickering committed
336 337

         -- TODO: Make this have the proper information
338 339 340 341
       ; let mkFieldLabel name = FieldLabel { flLabel = occNameFS (nameOccName name)
                                            , flIsOverloaded = False
                                            , flSelector = name }
             field_labels' = map mkFieldLabel field_labels
Matthew Pickering's avatar
Matthew Pickering committed
342

343
       -- Make the PatSyn itself
Matthew Pickering's avatar
Matthew Pickering committed
344
       ; let patSyn = mkPatSyn (unLoc lname) is_infix
Simon Peyton Jones's avatar
Simon Peyton Jones committed
345 346
                        (univ_tvs, req_theta)
                        (ex_tvs, prov_theta)
347
                        arg_tys
cactus's avatar
cactus committed
348
                        pat_ty
349
                        matcher_id builder_id
Matthew Pickering's avatar
Matthew Pickering committed
350 351 352
                        field_labels'

       -- Selectors
353 354 355 356
       ; let rn_rec_sel_binds = mkPatSynRecSelBinds patSyn (patSynFieldLabels patSyn)
             tything = AConLike (PatSynCon patSyn)
       ; tcg_env <- tcExtendGlobalEnv [tything] $
                    tcRecSelBinds rn_rec_sel_binds
Matthew Pickering's avatar
Matthew Pickering committed
357

358
       ; traceTc "tc_patsyn_finish }" empty
359
       ; return (matcher_bind, tcg_env) }
Simon Peyton Jones's avatar
Simon Peyton Jones committed
360 361 362 363 364 365 366 367
  where
    -- This is a bit of an odd functions; why does it not occur elsewhere
    zonk_qtv :: TcTyVarBinder -> TcM (Maybe TcTyVarBinder)
    zonk_qtv (TvBndr tv vis)
      = do { mb_tv' <- zonkQuantifiedTyVar False tv
                    -- ToDo: The False means that we behave here as if
                    -- -XPolyKinds was always on, which isn't right.
           ; return (fmap (\tv' -> TvBndr tv' vis) mb_tv') }
368

Austin Seipp's avatar
Austin Seipp committed
369 370 371
{-
************************************************************************
*                                                                      *
372
         Constructing the "matcher" Id and its binding
Austin Seipp's avatar
Austin Seipp committed
373 374 375
*                                                                      *
************************************************************************
-}
376

377
tcPatSynMatcher :: Located Name
cactus's avatar
cactus committed
378
                -> LPat Id
379
                -> ([TcTyVar], ThetaType, TcEvBinds, [EvVar])
380 381
                -> ([TcTyVar], [TcType], ThetaType, [EvTerm])
                -> ([LHsExpr TcId], [TcType])
cactus's avatar
cactus committed
382
                -> TcType
383 384
                -> TcM ((Id, Bool), LHsBinds Id)
-- See Note [Matchers and builders for pattern synonyms] in PatSyn
385
tcPatSynMatcher (L loc name) lpat
386
                (univ_tvs, req_theta, req_ev_binds, req_dicts)
387 388
                (ex_tvs, ex_tys, prov_theta, prov_dicts)
                (args, arg_tys) pat_ty
389 390 391
  = do { rr_name <- newNameAt (mkTyVarOcc "rep") loc
       ; tv_name <- newNameAt (mkTyVarOcc "r")   loc
       ; let rr_tv    = mkTcTyVar rr_name runtimeRepTy (SkolemTv False)
392 393
             rr       = mkTyVarTy rr_tv
             res_tv   = mkTcTyVar tv_name  (tYPE rr) (SkolemTv False)
394
             is_unlifted = null args && null prov_dicts
395
             res_ty = mkTyVarTy res_tv
396 397 398
             (cont_args, cont_arg_tys)
               | is_unlifted = ([nlHsVar voidPrimId], [voidPrimTy])
               | otherwise   = (args,                 arg_tys)
399
             cont_ty = mkInvSigmaTy ex_tvs prov_theta $
400 401
                       mkFunTys cont_arg_tys res_ty

eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
402
             fail_ty  = mkFunTy voidPrimTy res_ty
403

404
       ; matcher_name <- newImplicitBinder name mkMatcherOcc
405 406 407 408 409
       ; scrutinee    <- newSysLocalId (fsLit "scrut") pat_ty
       ; cont         <- newSysLocalId (fsLit "cont")  cont_ty
       ; fail         <- newSysLocalId (fsLit "fail")  fail_ty

       ; let matcher_tau   = mkFunTys [pat_ty, cont_ty, fail_ty] res_ty
410
             matcher_sigma = mkInvSigmaTy (rr_tv:res_tv:univ_tvs) req_theta matcher_tau
411
             matcher_id    = mkExportedVanillaId matcher_name matcher_sigma
412
                             -- See Note [Exported LocalIds] in Id
413

414 415
             inst_wrap = mkWpEvApps prov_dicts <.> mkWpTyApps ex_tys
             cont' = foldl nlHsApp (mkLHsWrap inst_wrap (nlHsVar cont)) cont_args
cactus's avatar
cactus committed
416

417
             fail' = nlHsApps fail [nlHsVar voidPrimId]
cactus's avatar
cactus committed
418

419
             args = map nlVarPat [scrutinee, cont, fail]
cactus's avatar
cactus committed
420 421
             lwpat = noLoc $ WildPat pat_ty
             cases = if isIrrefutableHsPat lpat
422 423 424
                     then [mkHsCaseAlt lpat  cont']
                     else [mkHsCaseAlt lpat  cont',
                           mkHsCaseAlt lwpat fail']
425
             body = mkLHsWrap (mkWpLet req_ev_binds) $
cactus's avatar
cactus committed
426 427
                    L (getLoc lpat) $
                    HsCase (nlHsVar scrutinee) $
428
                    MG{ mg_alts = L (getLoc lpat) cases
cactus's avatar
cactus committed
429 430
                      , mg_arg_tys = [pat_ty]
                      , mg_res_ty = res_ty
431
                      , mg_origin = Generated
cactus's avatar
cactus committed
432 433 434
                      }
             body' = noLoc $
                     HsLam $
435 436
                     MG{ mg_alts = noLoc [mkSimpleMatch LambdaExpr
                                                        args body]
cactus's avatar
cactus committed
437 438
                       , mg_arg_tys = [pat_ty, cont_ty, res_ty]
                       , mg_res_ty = res_ty
439
                       , mg_origin = Generated
cactus's avatar
cactus committed
440
                       }
441 442 443
             match = mkMatch (FunRhs (L loc name) Prefix) []
                             (mkHsLams (rr_tv:res_tv:univ_tvs)
                             req_dicts body')
444 445
                             (noLoc EmptyLocalBinds)
             mg = MG{ mg_alts = L (getLoc match) [match]
cactus's avatar
cactus committed
446 447
                    , mg_arg_tys = []
                    , mg_res_ty = res_ty
448
                    , mg_origin = Generated
cactus's avatar
cactus committed
449 450
                    }

451
       ; let bind = FunBind{ fun_id = L loc matcher_id
cactus's avatar
cactus committed
452 453 454
                           , fun_matches = mg
                           , fun_co_fn = idHsWrapper
                           , bind_fvs = emptyNameSet
455
                           , fun_tick = [] }
456
             matcher_bind = unitBag (noLoc bind)
cactus's avatar
cactus committed
457

458
       ; traceTc "tcPatSynMatcher" (ppr name $$ ppr (idType matcher_id))
cactus's avatar
cactus committed
459 460
       ; traceTc "tcPatSynMatcher" (ppr matcher_bind)

461 462
       ; return ((matcher_id, is_unlifted), matcher_bind) }

Matthew Pickering's avatar
Matthew Pickering committed
463
mkPatSynRecSelBinds :: PatSyn
464 465 466 467
                    -> [FieldLabel]  -- ^ Visible field labels
                    -> HsValBinds Name
mkPatSynRecSelBinds ps fields
  = ValBindsOut selector_binds sigs
468
  where
469 470
    (sigs, selector_binds) = unzip (map mkRecSel fields)
    mkRecSel fld_lbl = mkOneRecordSelector [PatSynCon ps] (RecSelPatSyn ps) fld_lbl
471 472 473 474 475 476

isUnidirectional :: HsPatSynDir a -> Bool
isUnidirectional Unidirectional          = True
isUnidirectional ImplicitBidirectional   = False
isUnidirectional ExplicitBidirectional{} = False

Austin Seipp's avatar
Austin Seipp committed
477 478 479
{-
************************************************************************
*                                                                      *
480
         Constructing the "builder" Id
Austin Seipp's avatar
Austin Seipp committed
481 482 483
*                                                                      *
************************************************************************
-}
484

485
mkPatSynBuilderId :: HsPatSynDir a -> Located Name
Simon Peyton Jones's avatar
Simon Peyton Jones committed
486 487
                  -> [TyVarBinder] -> ThetaType
                  -> [TyVarBinder] -> ThetaType
488
                  -> [Type] -> Type
489
                  -> TcM (Maybe (Id, Bool))
490 491
mkPatSynBuilderId dir (L _ name)
                  univ_bndrs req_theta ex_bndrs prov_theta
492
                  arg_tys pat_ty
493 494 495
  | isUnidirectional dir
  = return Nothing
  | otherwise
496
  = do { builder_name <- newImplicitBinder name mkBuilderOcc
497
       ; let theta          = req_theta ++ prov_theta
498
             need_dummy_arg = isUnliftedType pat_ty && null arg_tys && null theta
499
             builder_sigma  = add_void need_dummy_arg $
500 501 502 503 504
                              mkForAllTys univ_bndrs $
                              mkForAllTys ex_bndrs $
                              mkFunTys theta $
                              mkFunTys arg_tys $
                              pat_ty
505
             builder_id     = mkExportedVanillaId builder_name builder_sigma
Matthew Pickering's avatar
Matthew Pickering committed
506
              -- See Note [Exported LocalIds] in Id
507

508
       ; return (Just (builder_id, need_dummy_arg)) }
509
  where
510

511
tcPatSynBuilderBind :: PatSynBind Name Name
512 513
                    -> TcM (LHsBinds Id)
-- See Note [Matchers and builders for pattern synonyms] in PatSyn
514 515
tcPatSynBuilderBind (PSB { psb_id = L loc name, psb_def = lpat
                         , psb_dir = dir, psb_args = details })
516 517 518
  | isUnidirectional dir
  = return emptyBag

519
  | Left why <- mb_match_group       -- Can't invert the pattern
520
  = setSrcSpan (getLoc lpat) $ failWithTc $
521 522 523 524
    vcat [ hang (text "Invalid right-hand side of bidirectional pattern synonym"
                 <+> quotes (ppr name) <> colon)
              2 why
         , text "RHS pattern:" <+> ppr lpat ]
525

526
  | Right match_group <- mb_match_group  -- Bidirectional
527
  = do { patsyn <- tcLookupPatSyn name
528
       ; traceTc "tcPatSynBuilderBind {" $ ppr patsyn
529
       ; let Just (builder_id, need_dummy_arg) = patSynBuilder patsyn
530 531 532 533 534
                   -- Bidirectional, so patSynBuilder returns Just

             match_group' | need_dummy_arg = add_dummy_arg match_group
                          | otherwise      = match_group

535
             bind = FunBind { fun_id      = L loc (idName builder_id)
536 537 538 539 540
                            , fun_matches = match_group'
                            , fun_co_fn   = idHsWrapper
                            , bind_fvs    = placeHolderNamesTc
                            , fun_tick    = [] }

541
             sig = completeSigFromId (PatSynCtxt name) builder_id
542

543
       ; (builder_binds, _) <- tcPolyCheck emptyPragEnv sig (noLoc bind)
544 545
       ; traceTc "tcPatSynBuilderBind }" $ ppr builder_binds
       ; return builder_binds }
546 547

  | otherwise = panic "tcPatSynBuilderBind"  -- Both cases dealt with
548
  where
549
    mb_match_group
550
       = case dir of
551
           ExplicitBidirectional explicit_mg -> Right explicit_mg
552
           ImplicitBidirectional             -> fmap mk_mg (tcPatToExpr args lpat)
553
           Unidirectional -> panic "tcPatSynBuilderBind"
554 555

    mk_mg :: LHsExpr Name -> MatchGroup Name (LHsExpr Name)
556
    mk_mg body = mkMatchGroupName Generated [builder_match]
557
             where
558
               builder_args  = [L loc (VarPat (L loc n)) | L loc n <- args]
559 560 561
               builder_match = mkMatch (FunRhs (L loc name) Prefix)
                                       builder_args body
                                       (noLoc EmptyLocalBinds)
562 563

    args = case details of
564
              PrefixPatSyn args     -> args
565
              InfixPatSyn arg1 arg2 -> [arg1, arg2]
Matthew Pickering's avatar
Matthew Pickering committed
566
              RecordPatSyn args     -> map recordPatSynPatVar args
567

eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
568 569
    add_dummy_arg :: MatchGroup Name (LHsExpr Name)
                  -> MatchGroup Name (LHsExpr Name)
570 571
    add_dummy_arg mg@(MG { mg_alts = L l [L loc match@(Match { m_pats = pats })] })
      = mg { mg_alts = L l [L loc (match { m_pats = nlWildPatName : pats })] }
572
    add_dummy_arg other_mg = pprPanic "add_dummy_arg" $
573
                             pprMatches other_mg
574

eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
575 576 577
tcPatSynBuilderOcc :: PatSyn -> TcM (HsExpr TcId, TcSigmaType)
-- monadic only for failure
tcPatSynBuilderOcc ps
578
  | Just (builder_id, add_void_arg) <- builder
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
579 580 581 582 583 584 585
  , let builder_expr = HsVar (noLoc builder_id)
        builder_ty   = idType builder_id
  = return $
    if add_void_arg
    then ( HsApp (noLoc $ builder_expr) (nlHsVar voidPrimId)
         , tcFunResultTy builder_ty )
    else (builder_expr, builder_ty)
586 587

  | otherwise  -- Unidirectional
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
588
  = nonBidirectionalErr name
589 590 591
  where
    name    = patSynName ps
    builder = patSynBuilder ps
cactus's avatar
cactus committed
592

593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681
add_void :: Bool -> Type -> Type
add_void need_dummy_arg ty
  | need_dummy_arg = mkFunTy voidPrimTy ty
  | otherwise      = ty

tcPatToExpr :: [Located Name] -> LPat Name -> Either MsgDoc (LHsExpr Name)
-- Given a /pattern/, return an /expression/ that builds a value
-- that matches the pattern.  E.g. if the pattern is (Just [x]),
-- the expression is (Just [x]).  They look the same, but the
-- input uses constructors from HsPat and the output uses constructors
-- from HsExpr.
--
-- Returns (Left r) if the pattern is not invertible, for reason r.
-- See Note [Builder for a bidirectional pattern synonym]
tcPatToExpr args pat = go pat
  where
    lhsVars = mkNameSet (map unLoc args)

    -- Make a prefix con for prefix and infix patterns for simplicity
    mkPrefixConExpr :: Located Name -> [LPat Name] -> Either MsgDoc (HsExpr Name)
    mkPrefixConExpr lcon@(L loc _) pats
      = do { exprs <- mapM go pats
           ; return (foldl (\x y -> HsApp (L loc x) y)
                           (HsVar lcon) exprs) }

    mkRecordConExpr :: Located Name -> HsRecFields Name (LPat Name)
                    -> Either MsgDoc (HsExpr Name)
    mkRecordConExpr con fields
      = do { exprFields <- mapM go fields
           ; return (RecordCon con PlaceHolder noPostTcExpr exprFields) }

    go :: LPat Name -> Either MsgDoc (LHsExpr Name)
    go (L loc p) = L loc <$> go1 p

    go1 :: Pat Name -> Either MsgDoc (HsExpr Name)
    go1 (ConPatIn con info)
      = case info of
          PrefixCon ps  -> mkPrefixConExpr con ps
          InfixCon l r  -> mkPrefixConExpr con [l,r]
          RecCon fields -> mkRecordConExpr con fields

    go1 (SigPatIn pat _) = go1 (unLoc pat)
        -- See Note [Type signatures and the builder expression]

    go1 (VarPat (L l var))
        | var `elemNameSet` lhsVars
        = return $ HsVar (L l var)
        | otherwise
        = Left (quotes (ppr var) <+> text "is not bound by the LHS of the pattern synonym")
    go1 (ParPat pat)                = fmap HsPar $ go pat
    go1 (LazyPat pat)               = go1 (unLoc pat)
    go1 (BangPat pat)               = go1 (unLoc pat)
    go1 (PArrPat pats ptt)          = do { exprs <- mapM go pats
                                         ; return $ ExplicitPArr ptt exprs }
    go1 (ListPat pats ptt reb)      = do { exprs <- mapM go pats
                                         ; return $ ExplicitList ptt (fmap snd reb) exprs }
    go1 (TuplePat pats box _)       = do { exprs <- mapM go pats
                                         ; return $ ExplicitTuple
                                              (map (noLoc . Present) exprs) box }
    go1 (LitPat lit)                = return $ HsLit lit
    go1 (NPat (L _ n) mb_neg _ _)
        | Just neg <- mb_neg        = return $ unLoc $ nlHsSyntaxApps neg [noLoc (HsOverLit n)]
        | otherwise                 = return $ HsOverLit n
    go1 (ConPatOut{})               = panic "ConPatOut in output of renamer"
    go1 (SigPatOut{})               = panic "SigPatOut in output of renamer"
    go1 (CoPat{})                   = panic "CoPat in output of renamer"
    go1 p = Left (text "pattern" <+> quotes (ppr p) <+> text "is not invertible")

{- Note [Builder for a bidirectional pattern synonym]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
For a bidirectional pattern synonym we need to produce an /expression/
that matches the supplied /pattern/, given values for the arguments
of the pattern synoymy.  For example
  pattern F x y = (Just x, [y])
The 'builder' for F looks like
  $builderF x y = (Just x, [y])

We can't always do this:
 * Some patterns aren't invertible; e.g. view patterns
      pattern F x = (reverse -> x:_)

 * The RHS pattern might bind more variables than the pattern
   synonym, so again we can't invert it
      pattern F x = (x,y)

 * Ditto wildcards
      pattern F x = (x,_)


682 683 684 685 686 687
Note [Redundant constraints for builder]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The builder can have redundant constraints, which are awkard to eliminate.
Consider
   pattern P = Just 34
To match against this pattern we need (Eq a, Num a).  But to build
688 689
(Just 34) we need only (Num a).  Fortunately instTcSigFromId sets
sig_warn_redundant to False.
690

Austin Seipp's avatar
Austin Seipp committed
691 692
************************************************************************
*                                                                      *
693
         Helper functions
Austin Seipp's avatar
Austin Seipp committed
694 695
*                                                                      *
************************************************************************
696

697 698
Note [As-patterns in pattern synonym definitions]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
699 700 701
The rationale for rejecting as-patterns in pattern synonym definitions
is that an as-pattern would introduce nonindependent pattern synonym
arguments, e.g. given a pattern synonym like:
702 703 704 705 706 707

        pattern K x y = x@(Just y)

one could write a nonsensical function like

        f (K Nothing x) = ...
cactus's avatar
cactus committed
708

709 710
or
        g (K (Just True) False) = ...
711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730

Note [Type signatures and the builder expression]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Consider
   pattern L x = Left x :: Either [a] [b]

In tc{Infer/Check}PatSynDecl we will check that the pattern has the
specified type.  We check the pattern *as a pattern*, so the type
signature is a pattern signature, and so brings 'a' and 'b' into
scope.  But we don't have a way to bind 'a, b' in the LHS, as we do
'x', say.  Nevertheless, the sigature may be useful to constrain
the type.

When making the binding for the *builder*, though, we don't want
  $buildL x = Left x :: Either [a] [b]
because that wil either mean (forall a b. Either [a] [b]), or we'll
get a complaint that 'a' and 'b' are out of scope. (Actually the
latter; Trac #9867.)  No, the job of the signature is done, so when
converting the pattern to an expression (for the builder RHS) we
simply discard the signature.
Matthew Pickering's avatar
Matthew Pickering committed
731 732 733 734 735 736 737 738

Note [Record PatSyn Desugaring]
-------------------------------
It is important that prov_theta comes before req_theta as this ordering is used
when desugaring record pattern synonym updates.

Any change to this ordering should make sure to change deSugar/DsExpr.hs if you
want to avoid difficult to decipher core lint errors!
739
 -}
740

741 742 743 744 745 746 747 748 749 750
tcCheckPatSynPat :: LPat Name -> TcM ()
tcCheckPatSynPat = go
  where
    go :: LPat Name -> TcM ()
    go = addLocM go1

    go1 :: Pat Name -> TcM ()
    go1   (ConPatIn _ info)   = mapM_ go (hsConPatArgs info)
    go1   VarPat{}            = return ()
    go1   WildPat{}           = return ()
751
    go1 p@(AsPat _ _)         = asPatInPatSynErr p
752 753 754 755 756 757
    go1   (LazyPat pat)       = go pat
    go1   (ParPat pat)        = go pat
    go1   (BangPat pat)       = go pat
    go1   (PArrPat pats _)    = mapM_ go pats
    go1   (ListPat pats _ _)  = mapM_ go pats
    go1   (TuplePat pats _ _) = mapM_ go pats
758 759
    go1   LitPat{}            = return ()
    go1   NPat{}              = return ()
760 761 762 763 764 765 766 767
    go1   (SigPatIn pat _)    = go pat
    go1   (ViewPat _ pat _)   = go pat
    go1 p@SplicePat{}         = thInPatSynErr p
    go1 p@NPlusKPat{}         = nPlusKPatInPatSynErr p
    go1   ConPatOut{}         = panic "ConPatOut in output of renamer"
    go1   SigPatOut{}         = panic "SigPatOut in output of renamer"
    go1   CoPat{}             = panic "CoPat in output of renamer"

768
asPatInPatSynErr :: (OutputableBndrId name) => Pat name -> TcM a
769 770
asPatInPatSynErr pat
  = failWithTc $
771
    hang (text "Pattern synonym definition cannot contain as-patterns (@):")
772 773
       2 (ppr pat)

774
thInPatSynErr :: (OutputableBndrId name) => Pat name -> TcM a
775 776
thInPatSynErr pat
  = failWithTc $
777
    hang (text "Pattern synonym definition cannot contain Template Haskell:")
778 779
       2 (ppr pat)

780
nPlusKPatInPatSynErr :: (OutputableBndrId name) => Pat name -> TcM a
781 782
nPlusKPatInPatSynErr pat
  = failWithTc $
783
    hang (text "Pattern synonym definition cannot contain n+k-pattern:")
784 785
       2 (ppr pat)

Matthew Pickering's avatar
Matthew Pickering committed
786 787
nonBidirectionalErr :: Outputable name => name -> TcM a
nonBidirectionalErr name = failWithTc $
788 789
    text "non-bidirectional pattern synonym"
    <+> quotes (ppr name) <+> text "used in an expression"
Matthew Pickering's avatar
Matthew Pickering committed
790

791 792 793 794 795 796
-- Walk the whole pattern and for all ConPatOuts, collect the
-- existentially-bound type variables and evidence binding variables.
--
-- These are used in computing the type of a pattern synonym and also
-- in generating matcher functions, since success continuations need
-- to be passed these pattern-bound evidences.
797 798 799 800 801 802 803 804
tcCollectEx
  :: LPat Id
  -> ( ([Var], VarSet) -- Existentially-bound type variables as a
                       -- deterministically ordered list and a set.
                       -- See Note [Deterministic FV] in FV
     , [EvVar]
     )
tcCollectEx pat = let (fv, evs) = go pat in (fvVarListVarSet fv, evs)
cactus's avatar
cactus committed
805
  where
806
    go :: LPat Id -> (FV, [EvVar])
cactus's avatar
cactus committed
807 808
    go = go1 . unLoc

809
    go1 :: Pat Id -> (FV, [EvVar])
cactus's avatar
cactus committed
810 811 812 813
    go1 (LazyPat p)         = go p
    go1 (AsPat _ p)         = go p
    go1 (ParPat p)          = go p
    go1 (BangPat p)         = go p
814 815 816
    go1 (ListPat ps _ _)    = mergeMany . map go $ ps
    go1 (TuplePat ps _ _)   = mergeMany . map go $ ps
    go1 (PArrPat ps _)      = mergeMany . map go $ ps
cactus's avatar
cactus committed
817
    go1 (ViewPat _ p _)     = go p
818
    go1 con@ConPatOut{}     = merge (FV.mkFVs (pat_tvs con), pat_dicts con) $
cactus's avatar
cactus committed
819 820 821
                                 goConDetails $ pat_args con
    go1 (SigPatOut p _)     = go p
    go1 (CoPat _ p _)       = go1 p
822
    go1 (NPlusKPat n k _ geq subtract _)
cactus's avatar
cactus committed
823
      = pprPanic "TODO: NPlusKPat" $ ppr n $$ ppr k $$ ppr geq $$ ppr subtract
824
    go1 _                   = empty
cactus's avatar
cactus committed
825

826 827 828
    goConDetails :: HsConPatDetails Id -> (FV, [EvVar])
    goConDetails (PrefixCon ps) = mergeMany . map go $ ps
    goConDetails (InfixCon p1 p2) = go p1 `merge` go p2
cactus's avatar
cactus committed
829
    goConDetails (RecCon HsRecFields{ rec_flds = flds })
830
      = mergeMany . map goRecFd $ flds
cactus's avatar
cactus committed
831

832
    goRecFd :: LHsRecField Id (LPat Id) -> (FV, [EvVar])
833
    goRecFd (L _ HsRecField{ hsRecFieldArg = p }) = go p
834 835 836 837

    merge (vs1, evs1) (vs2, evs2) = (vs1 `unionFV` vs2, evs1 ++ evs2)
    mergeMany = foldr merge empty
    empty = (emptyFV, [])