205ec9e03e49ee48f012a84447844d64ebccf479
[ghc.git] / compiler / typecheck / TcHsType.hs
1 {-
2 (c) The University of Glasgow 2006
3 (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
4
5 \section[TcMonoType]{Typechecking user-specified @MonoTypes@}
6 -}
7
8 {-# LANGUAGE CPP, TupleSections, MultiWayIf, RankNTypes #-}
9 {-# LANGUAGE ScopedTypeVariables #-}
10
11 module TcHsType (
12 -- Type signatures
13 kcHsSigType, tcClassSigType,
14 tcHsSigType, tcHsSigWcType,
15 tcHsPartialSigType,
16 funsSigCtxt, addSigCtxt, pprSigCtxt,
17
18 tcHsClsInstType,
19 tcHsDeriv, tcDerivStrategy,
20 tcHsTypeApp,
21 UserTypeCtxt(..),
22 tcImplicitTKBndrs, tcImplicitTKBndrsX,
23 tcExplicitTKBndrs,
24 kcExplicitTKBndrs, kcImplicitTKBndrs,
25
26 -- Type checking type and class decls
27 kcLookupTcTyCon, kcTyClTyVars, tcTyClTyVars,
28 tcDataKindSig,
29
30 -- tyvars
31 scopeTyVars, scopeTyVars2,
32
33 -- Kind-checking types
34 -- No kind generalisation, no checkValidType
35 kcLHsQTyVars, kcLHsTyVarBndrs,
36 tcWildCardBinders,
37 tcHsLiftedType, tcHsOpenType,
38 tcHsLiftedTypeNC, tcHsOpenTypeNC,
39 tcLHsType, tcLHsTypeUnsaturated, tcCheckLHsType,
40 tcHsMbContext, tcHsContext, tcLHsPredType, tcInferApps,
41 solveEqualities, -- useful re-export
42
43 typeLevelMode, kindLevelMode,
44
45 kindGeneralize, checkExpectedKindX, instantiateTyUntilN,
46 reportFloatingKvs,
47
48 -- Sort-checking kinds
49 tcLHsKindSig, badKindSig,
50
51 -- Zonking and promoting
52 zonkPromoteType,
53
54 -- Pattern type signatures
55 tcHsPatSigType, tcPatSig, funAppCtxt
56 ) where
57
58 #include "HsVersions.h"
59
60 import GhcPrelude
61
62 import HsSyn
63 import TcRnMonad
64 import TcEvidence
65 import TcEnv
66 import TcMType
67 import TcValidity
68 import TcUnify
69 import TcIface
70 import TcSimplify
71 import TcType
72 import TcHsSyn( zonkSigType )
73 import Inst ( tcInstTyBinders, tcInstTyBinder )
74 import TyCoRep( TyBinder(..) ) -- Used in tcDataKindSig
75 import Type
76 import Coercion
77 import Kind
78 import RdrName( lookupLocalRdrOcc )
79 import Var
80 import VarSet
81 import TyCon
82 import ConLike
83 import DataCon
84 import Class
85 import Name
86 import NameEnv
87 import NameSet
88 import VarEnv
89 import TysWiredIn
90 import BasicTypes
91 import SrcLoc
92 import Constants ( mAX_CTUPLE_SIZE )
93 import ErrUtils( MsgDoc )
94 import Unique
95 import Util
96 import UniqSupply
97 import Outputable
98 import FastString
99 import PrelNames hiding ( wildCardName )
100 import qualified GHC.LanguageExtensions as LangExt
101
102 import Maybes
103 import Data.List ( find, mapAccumR )
104 import Control.Monad
105
106 {-
107 ----------------------------
108 General notes
109 ----------------------------
110
111 Unlike with expressions, type-checking types both does some checking and
112 desugars at the same time. This is necessary because we often want to perform
113 equality checks on the types right away, and it would be incredibly painful
114 to do this on un-desugared types. Luckily, desugared types are close enough
115 to HsTypes to make the error messages sane.
116
117 During type-checking, we perform as little validity checking as possible.
118 This is because some type-checking is done in a mutually-recursive knot, and
119 if we look too closely at the tycons, we'll loop. This is why we always must
120 use mkNakedTyConApp and mkNakedAppTys, etc., which never look at a tycon.
121 The mkNamed... functions don't uphold Type invariants, but zonkTcTypeToType
122 will repair this for us. Note that zonkTcType *is* safe within a knot, and
123 can be done repeatedly with no ill effect: it just squeezes out metavariables.
124
125 Generally, after type-checking, you will want to do validity checking, say
126 with TcValidity.checkValidType.
127
128 Validity checking
129 ~~~~~~~~~~~~~~~~~
130 Some of the validity check could in principle be done by the kind checker,
131 but not all:
132
133 - During desugaring, we normalise by expanding type synonyms. Only
134 after this step can we check things like type-synonym saturation
135 e.g. type T k = k Int
136 type S a = a
137 Then (T S) is ok, because T is saturated; (T S) expands to (S Int);
138 and then S is saturated. This is a GHC extension.
139
140 - Similarly, also a GHC extension, we look through synonyms before complaining
141 about the form of a class or instance declaration
142
143 - Ambiguity checks involve functional dependencies, and it's easier to wait
144 until knots have been resolved before poking into them
145
146 Also, in a mutually recursive group of types, we can't look at the TyCon until we've
147 finished building the loop. So to keep things simple, we postpone most validity
148 checking until step (3).
149
150 Knot tying
151 ~~~~~~~~~~
152 During step (1) we might fault in a TyCon defined in another module, and it might
153 (via a loop) refer back to a TyCon defined in this module. So when we tie a big
154 knot around type declarations with ARecThing, so that the fault-in code can get
155 the TyCon being defined.
156
157 %************************************************************************
158 %* *
159 Check types AND do validity checking
160 * *
161 ************************************************************************
162 -}
163
164 funsSigCtxt :: [Located Name] -> UserTypeCtxt
165 -- Returns FunSigCtxt, with no redundant-context-reporting,
166 -- form a list of located names
167 funsSigCtxt (L _ name1 : _) = FunSigCtxt name1 False
168 funsSigCtxt [] = panic "funSigCtxt"
169
170 addSigCtxt :: UserTypeCtxt -> LHsType GhcRn -> TcM a -> TcM a
171 addSigCtxt ctxt hs_ty thing_inside
172 = setSrcSpan (getLoc hs_ty) $
173 addErrCtxt (pprSigCtxt ctxt hs_ty) $
174 thing_inside
175
176 pprSigCtxt :: UserTypeCtxt -> LHsType GhcRn -> SDoc
177 -- (pprSigCtxt ctxt <extra> <type>)
178 -- prints In the type signature for 'f':
179 -- f :: <type>
180 -- The <extra> is either empty or "the ambiguity check for"
181 pprSigCtxt ctxt hs_ty
182 | Just n <- isSigMaybe ctxt
183 = hang (text "In the type signature:")
184 2 (pprPrefixOcc n <+> dcolon <+> ppr hs_ty)
185
186 | otherwise
187 = hang (text "In" <+> pprUserTypeCtxt ctxt <> colon)
188 2 (ppr hs_ty)
189
190 tcHsSigWcType :: UserTypeCtxt -> LHsSigWcType GhcRn -> TcM Type
191 -- This one is used when we have a LHsSigWcType, but in
192 -- a place where wildards aren't allowed. The renamer has
193 -- already checked this, so we can simply ignore it.
194 tcHsSigWcType ctxt sig_ty = tcHsSigType ctxt (dropWildCards sig_ty)
195
196 kcHsSigType :: SkolemInfo -> [Located Name] -> LHsSigType GhcRn -> TcM ()
197 kcHsSigType skol_info names (HsIB { hsib_body = hs_ty
198 , hsib_ext = HsIBRn { hsib_vars = sig_vars }})
199 = addSigCtxt (funsSigCtxt names) hs_ty $
200 discardResult $
201 tcImplicitTKBndrs skol_info sig_vars $
202 tc_lhs_type typeLevelMode hs_ty liftedTypeKind
203 kcHsSigType _ _ (XHsImplicitBndrs _) = panic "kcHsSigType"
204
205 tcClassSigType :: SkolemInfo -> [Located Name] -> LHsSigType GhcRn -> TcM Type
206 -- Does not do validity checking; this must be done outside
207 -- the recursive class declaration "knot"
208 tcClassSigType skol_info names sig_ty
209 = addSigCtxt (funsSigCtxt names) (hsSigType sig_ty) $
210 tc_hs_sig_type_and_gen skol_info sig_ty liftedTypeKind
211
212 tcHsSigType :: UserTypeCtxt -> LHsSigType GhcRn -> TcM Type
213 -- Does validity checking
214 -- See Note [Recipe for checking a signature]
215 tcHsSigType ctxt sig_ty
216 = addSigCtxt ctxt (hsSigType sig_ty) $
217 do { traceTc "tcHsSigType {" (ppr sig_ty)
218 ; kind <- case expectedKindInCtxt ctxt of
219 AnythingKind -> newMetaKindVar
220 TheKind k -> return k
221 OpenKind -> newOpenTypeKind
222 -- The kind is checked by checkValidType, and isn't necessarily
223 -- of kind * in a Template Haskell quote eg [t| Maybe |]
224
225 -- Generalise here: see Note [Kind generalisation]
226 ; do_kind_gen <- decideKindGeneralisationPlan sig_ty
227 ; ty <- if do_kind_gen
228 then tc_hs_sig_type_and_gen skol_info sig_ty kind
229 else tc_hs_sig_type skol_info sig_ty kind
230
231 ; checkValidType ctxt ty
232 ; traceTc "end tcHsSigType }" (ppr ty)
233 ; return ty }
234 where
235 skol_info = SigTypeSkol ctxt
236
237 tc_hs_sig_type_and_gen :: SkolemInfo -> LHsSigType GhcRn -> Kind -> TcM Type
238 -- Kind-checks/desugars an 'LHsSigType',
239 -- solve equalities,
240 -- and then kind-generalizes.
241 -- This will never emit constraints, as it uses solveEqualities interally.
242 -- No validity checking, but it does zonk en route to generalization
243 tc_hs_sig_type_and_gen skol_info (HsIB { hsib_ext
244 = HsIBRn { hsib_vars = sig_vars }
245 , hsib_body = hs_ty }) kind
246 = do { (tkvs, ty) <- solveEqualities $
247 tcImplicitTKBndrs skol_info sig_vars $
248 tc_lhs_type typeLevelMode hs_ty kind
249 -- NB the call to solveEqualities, which unifies all those
250 -- kind variables floating about, immediately prior to
251 -- kind generalisation
252
253 -- We use the "InKnot" zonker, because this is called
254 -- on class method sigs in the knot
255 ; ty1 <- zonkPromoteTypeInKnot $ mkSpecForAllTys tkvs ty
256 ; kvs <- kindGeneralize ty1
257 ; zonkSigType (mkInvForAllTys kvs ty1) }
258
259 tc_hs_sig_type_and_gen _ (XHsImplicitBndrs _) _ = panic "tc_hs_sig_type_and_gen"
260
261 tc_hs_sig_type :: SkolemInfo -> LHsSigType GhcRn -> Kind -> TcM Type
262 -- Kind-check/desugar a 'LHsSigType', but does not solve
263 -- the equalities that arise from doing so; instead it may
264 -- emit kind-equality constraints into the monad
265 -- Zonking, but no validity checking
266 tc_hs_sig_type skol_info (HsIB { hsib_ext = HsIBRn { hsib_vars = sig_vars }
267 , hsib_body = hs_ty }) kind
268 = do { (tkvs, ty) <- tcImplicitTKBndrs skol_info sig_vars $
269 tc_lhs_type typeLevelMode hs_ty kind
270
271 -- need to promote any remaining metavariables; test case:
272 -- dependent/should_fail/T14066e.
273 ; zonkPromoteType (mkSpecForAllTys tkvs ty) }
274
275 tc_hs_sig_type _ (XHsImplicitBndrs _) _ = panic "tc_hs_sig_type"
276
277 -----------------
278 tcHsDeriv :: LHsSigType GhcRn -> TcM ([TyVar], (Class, [Type], [Kind]))
279 -- Like tcHsSigType, but for the ...deriving( C t1 ty2 ) clause
280 -- Returns the C, [ty1, ty2, and the kinds of C's remaining arguments
281 -- E.g. class C (a::*) (b::k->k)
282 -- data T a b = ... deriving( C Int )
283 -- returns ([k], C, [k, Int], [k->k])
284 tcHsDeriv hs_ty
285 = do { cls_kind <- newMetaKindVar
286 -- always safe to kind-generalize, because there
287 -- can be no covars in an outer scope
288 ; ty <- checkNoErrs $
289 -- avoid redundant error report with "illegal deriving", below
290 tc_hs_sig_type_and_gen (SigTypeSkol DerivClauseCtxt) hs_ty cls_kind
291 ; cls_kind <- zonkTcType cls_kind
292 ; let (tvs, pred) = splitForAllTys ty
293 ; let (args, _) = splitFunTys cls_kind
294 ; case getClassPredTys_maybe pred of
295 Just (cls, tys) -> return (tvs, (cls, tys, args))
296 Nothing -> failWithTc (text "Illegal deriving item" <+> quotes (ppr hs_ty)) }
297
298 -- | Typecheck something within the context of a deriving strategy.
299 -- This is of particular importance when the deriving strategy is @via@.
300 -- For instance:
301 --
302 -- @
303 -- deriving via (S a) instance C (T a)
304 -- @
305 --
306 -- We need to typecheck @S a@, and moreover, we need to extend the tyvar
307 -- environment with @a@ before typechecking @C (T a)@, since @S a@ quantified
308 -- the type variable @a@.
309 tcDerivStrategy
310 :: forall a.
311 UserTypeCtxt
312 -> Maybe (DerivStrategy GhcRn) -- ^ The deriving strategy
313 -> TcM ([TyVar], a) -- ^ The thing to typecheck within the context of the
314 -- deriving strategy, which might quantify some type
315 -- variables of its own.
316 -> TcM (Maybe (DerivStrategy GhcTc), [TyVar], a)
317 -- ^ The typechecked deriving strategy, all quantified tyvars, and
318 -- the payload of the typechecked thing.
319 tcDerivStrategy user_ctxt mds thing_inside
320 = case mds of
321 Nothing -> boring_case Nothing
322 Just ds -> do (ds', tvs, thing) <- tc_deriv_strategy ds
323 pure (Just ds', tvs, thing)
324 where
325 tc_deriv_strategy :: DerivStrategy GhcRn
326 -> TcM (DerivStrategy GhcTc, [TyVar], a)
327 tc_deriv_strategy StockStrategy = boring_case StockStrategy
328 tc_deriv_strategy AnyclassStrategy = boring_case AnyclassStrategy
329 tc_deriv_strategy NewtypeStrategy = boring_case NewtypeStrategy
330 tc_deriv_strategy (ViaStrategy ty) = do
331 cls_kind <- newMetaKindVar
332 ty' <- checkNoErrs $
333 tc_hs_sig_type_and_gen (SigTypeSkol user_ctxt) ty cls_kind
334 let (via_tvs, via_pred) = splitForAllTys ty'
335 tcExtendTyVarEnv via_tvs $ do
336 (thing_tvs, thing) <- thing_inside
337 pure (ViaStrategy via_pred, via_tvs ++ thing_tvs, thing)
338
339 boring_case :: mds -> TcM (mds, [TyVar], a)
340 boring_case mds = do
341 (thing_tvs, thing) <- thing_inside
342 pure (mds, thing_tvs, thing)
343
344 tcHsClsInstType :: UserTypeCtxt -- InstDeclCtxt or SpecInstCtxt
345 -> LHsSigType GhcRn
346 -> TcM ([TyVar], ThetaType, Class, [Type])
347 -- Like tcHsSigType, but for a class instance declaration
348 tcHsClsInstType user_ctxt hs_inst_ty
349 = setSrcSpan (getLoc (hsSigType hs_inst_ty)) $
350 do { inst_ty <- tc_hs_sig_type_and_gen (SigTypeSkol user_ctxt) hs_inst_ty constraintKind
351 ; checkValidInstance user_ctxt hs_inst_ty inst_ty }
352
353 ----------------------------------------------
354 -- | Type-check a visible type application
355 tcHsTypeApp :: LHsWcType GhcRn -> Kind -> TcM Type
356 -- See Note [Recipe for checking a signature] in TcHsType
357 tcHsTypeApp wc_ty kind
358 | HsWC { hswc_ext = sig_wcs, hswc_body = hs_ty } <- wc_ty
359 = do { ty <- tcWildCardBindersX newWildTyVar Nothing sig_wcs $ \ _ ->
360 tcCheckLHsType hs_ty kind
361 ; ty <- zonkPromoteType ty
362 ; checkValidType TypeAppCtxt ty
363 ; return ty }
364 -- NB: we don't call emitWildcardHoleConstraints here, because
365 -- we want any holes in visible type applications to be used
366 -- without fuss. No errors, warnings, extensions, etc.
367 tcHsTypeApp (XHsWildCardBndrs _) _ = panic "tcHsTypeApp"
368
369 {-
370 ************************************************************************
371 * *
372 The main kind checker: no validity checks here
373 * *
374 ************************************************************************
375
376 First a couple of simple wrappers for kcHsType
377 -}
378
379 ---------------------------
380 tcHsOpenType, tcHsLiftedType,
381 tcHsOpenTypeNC, tcHsLiftedTypeNC :: LHsType GhcRn -> TcM TcType
382 -- Used for type signatures
383 -- Do not do validity checking
384 tcHsOpenType ty = addTypeCtxt ty $ tcHsOpenTypeNC ty
385 tcHsLiftedType ty = addTypeCtxt ty $ tcHsLiftedTypeNC ty
386
387 tcHsOpenTypeNC ty = do { ek <- newOpenTypeKind
388 ; tc_lhs_type typeLevelMode ty ek }
389 tcHsLiftedTypeNC ty = tc_lhs_type typeLevelMode ty liftedTypeKind
390
391 -- Like tcHsType, but takes an expected kind
392 tcCheckLHsType :: LHsType GhcRn -> Kind -> TcM TcType
393 tcCheckLHsType hs_ty exp_kind
394 = addTypeCtxt hs_ty $
395 tc_lhs_type typeLevelMode hs_ty exp_kind
396
397 tcLHsType :: LHsType GhcRn -> TcM (TcType, TcKind)
398 -- Called from outside: set the context
399 tcLHsType ty = addTypeCtxt ty (tc_infer_lhs_type typeLevelMode ty)
400
401 -- Like tcLHsType, but use it in a context where type synonyms and type families
402 -- do not need to be saturated, like in a GHCi :kind call
403 tcLHsTypeUnsaturated :: LHsType GhcRn -> TcM (TcType, TcKind)
404 tcLHsTypeUnsaturated ty = addTypeCtxt ty (tc_infer_lhs_type mode ty)
405 where
406 mode = allowUnsaturated typeLevelMode
407
408 ---------------------------
409 -- | Should we generalise the kind of this type signature?
410 -- We *should* generalise if the type is closed
411 -- or if NoMonoLocalBinds is set. Otherwise, nope.
412 -- See Note [Kind generalisation plan]
413 decideKindGeneralisationPlan :: LHsSigType GhcRn -> TcM Bool
414 decideKindGeneralisationPlan sig_ty@(HsIB { hsib_ext
415 = HsIBRn { hsib_closed = closed } })
416 = do { mono_locals <- xoptM LangExt.MonoLocalBinds
417 ; let should_gen = not mono_locals || closed
418 ; traceTc "decideKindGeneralisationPlan"
419 (ppr sig_ty $$ text "should gen?" <+> ppr should_gen)
420 ; return should_gen }
421 decideKindGeneralisationPlan(XHsImplicitBndrs _)
422 = panic "decideKindGeneralisationPlan"
423
424 {- Note [Kind generalisation plan]
425 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
426 When should we do kind-generalisation for user-written type signature?
427 Answer: we use the same rule as for value bindings:
428
429 * We always kind-generalise if the type signature is closed
430 * Additionally, we attempt to generalise if we have NoMonoLocalBinds
431
432 Trac #13337 shows the problem if we kind-generalise an open type (i.e.
433 one that mentions in-scope type variable
434 foo :: forall k (a :: k) proxy. (Typeable k, Typeable a)
435 => proxy a -> String
436 foo _ = case eqT :: Maybe (k :~: Type) of
437 Nothing -> ...
438 Just Refl -> case eqT :: Maybe (a :~: Int) of ...
439
440 In the expression type sig on the last line, we have (a :: k)
441 but (Int :: Type). Since (:~:) is kind-homogeneous, this requires
442 k ~ *, which is true in the Refl branch of the outer case.
443
444 That equality will be solved if we allow it to float out to the
445 implication constraint for the Refl match, but not not if we aggressively
446 attempt to solve all equalities the moment they occur; that is, when
447 checking (Maybe (a :~: Int)). (NB: solveEqualities fails unless it
448 solves all the kind equalities, which is the right thing at top level.)
449
450 So here the right thing is simply not to do kind generalisation!
451
452 ************************************************************************
453 * *
454 Type-checking modes
455 * *
456 ************************************************************************
457
458 The kind-checker is parameterised by a TcTyMode, which contains some
459 information about where we're checking a type.
460
461 The renamer issues errors about what it can. All errors issued here must
462 concern things that the renamer can't handle.
463
464 -}
465
466 -- | Info about the context in which we're checking a type. Currently,
467 -- differentiates only between types and kinds, but this will likely
468 -- grow, at least to include the distinction between patterns and
469 -- not-patterns.
470 data TcTyMode
471 = TcTyMode { mode_level :: TypeOrKind
472 , mode_unsat :: Bool -- True <=> allow unsaturated type families
473 }
474 -- The mode_unsat field is solely so that type families/synonyms can be unsaturated
475 -- in GHCi :kind calls
476
477 typeLevelMode :: TcTyMode
478 typeLevelMode = TcTyMode { mode_level = TypeLevel, mode_unsat = False }
479
480 kindLevelMode :: TcTyMode
481 kindLevelMode = TcTyMode { mode_level = KindLevel, mode_unsat = False }
482
483 allowUnsaturated :: TcTyMode -> TcTyMode
484 allowUnsaturated mode = mode { mode_unsat = True }
485
486 -- switch to kind level
487 kindLevel :: TcTyMode -> TcTyMode
488 kindLevel mode = mode { mode_level = KindLevel }
489
490 instance Outputable TcTyMode where
491 ppr = ppr . mode_level
492
493 {-
494 Note [Bidirectional type checking]
495 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
496 In expressions, whenever we see a polymorphic identifier, say `id`, we are
497 free to instantiate it with metavariables, knowing that we can always
498 re-generalize with type-lambdas when necessary. For example:
499
500 rank2 :: (forall a. a -> a) -> ()
501 x = rank2 id
502
503 When checking the body of `x`, we can instantiate `id` with a metavariable.
504 Then, when we're checking the application of `rank2`, we notice that we really
505 need a polymorphic `id`, and then re-generalize over the unconstrained
506 metavariable.
507
508 In types, however, we're not so lucky, because *we cannot re-generalize*!
509 There is no lambda. So, we must be careful only to instantiate at the last
510 possible moment, when we're sure we're never going to want the lost polymorphism
511 again. This is done in calls to tcInstTyBinders.
512
513 To implement this behavior, we use bidirectional type checking, where we
514 explicitly think about whether we know the kind of the type we're checking
515 or not. Note that there is a difference between not knowing a kind and
516 knowing a metavariable kind: the metavariables are TauTvs, and cannot become
517 forall-quantified kinds. Previously (before dependent types), there were
518 no higher-rank kinds, and so we could instantiate early and be sure that
519 no types would have polymorphic kinds, and so we could always assume that
520 the kind of a type was a fresh metavariable. Not so anymore, thus the
521 need for two algorithms.
522
523 For HsType forms that can never be kind-polymorphic, we implement only the
524 "down" direction, where we safely assume a metavariable kind. For HsType forms
525 that *can* be kind-polymorphic, we implement just the "up" (functions with
526 "infer" in their name) version, as we gain nothing by also implementing the
527 "down" version.
528
529 Note [Future-proofing the type checker]
530 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
531 As discussed in Note [Bidirectional type checking], each HsType form is
532 handled in *either* tc_infer_hs_type *or* tc_hs_type. These functions
533 are mutually recursive, so that either one can work for any type former.
534 But, we want to make sure that our pattern-matches are complete. So,
535 we have a bunch of repetitive code just so that we get warnings if we're
536 missing any patterns.
537
538 Note [The tcType invariant]
539 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
540 If tc_ty = tc_hs_type hs_ty exp_kind
541 then
542 typeKind tc_ty = exp_kind
543 without any zonking needed. The reason for this is that in
544 tcInferApps we see (F ty), and we kind-check 'ty' with an
545 expected-kind coming from F. Then, to make the resulting application
546 well kinded --- see Note [Ensure well-kinded types] in TcType --- we
547 need the kind-checked 'ty' to have exactly the kind that F expects,
548 with no funny zonking nonsense in between.
549
550 The tcType invariant also applies to checkExpectedKind: if
551 (tc_ty, _, _) = checkExpectedKind ty act_ki exp_ki
552 then
553 typeKind tc_ty = exp_ki
554 -}
555
556 ------------------------------------------
557 -- | Check and desugar a type, returning the core type and its
558 -- possibly-polymorphic kind. Much like 'tcInferRho' at the expression
559 -- level.
560 tc_infer_lhs_type :: TcTyMode -> LHsType GhcRn -> TcM (TcType, TcKind)
561 tc_infer_lhs_type mode (L span ty)
562 = setSrcSpan span $
563 do { (ty', kind) <- tc_infer_hs_type mode ty
564 ; return (ty', kind) }
565
566 -- | Infer the kind of a type and desugar. This is the "up" type-checker,
567 -- as described in Note [Bidirectional type checking]
568 tc_infer_hs_type :: TcTyMode -> HsType GhcRn -> TcM (TcType, TcKind)
569 tc_infer_hs_type mode (HsParTy _ t) = tc_infer_lhs_type mode t
570 tc_infer_hs_type mode (HsTyVar _ _ (L _ tv)) = tcTyVar mode tv
571
572 tc_infer_hs_type mode (HsAppTy _ ty1 ty2)
573 = do { let (hs_fun_ty, hs_arg_tys) = splitHsAppTys ty1 [ty2]
574 ; (fun_ty, fun_kind) <- tc_infer_lhs_type mode hs_fun_ty
575 -- A worry: what if fun_kind needs zoonking?
576 -- We used to zonk it here, but that got fun_ty and fun_kind
577 -- out of sync (see the precondition to tcTyApps), which caused
578 -- Trac #14873. So I'm now zonking in tcTyVar, and not here.
579 -- Is that enough? Seems so, but I can't see how to be certain.
580 ; tcTyApps mode hs_fun_ty fun_ty fun_kind hs_arg_tys }
581
582 tc_infer_hs_type mode (HsOpTy _ lhs lhs_op@(L _ hs_op) rhs)
583 | not (hs_op `hasKey` funTyConKey)
584 = do { (op, op_kind) <- tcTyVar mode hs_op
585 -- See "A worry" in the HsApp case
586 ; tcTyApps mode (noLoc $ HsTyVar noExt NotPromoted lhs_op) op op_kind
587 [lhs, rhs] }
588
589 tc_infer_hs_type mode (HsKindSig _ ty sig)
590 = do { sig' <- tcLHsKindSig KindSigCtxt sig
591 -- We must typecheck the kind signature, and solve all
592 -- its equalities etc; from this point on we may do
593 -- things like instantiate its foralls, so it needs
594 -- to be fully determined (Trac #14904)
595 ; traceTc "tc_infer_hs_type:sig" (ppr ty $$ ppr sig')
596 ; ty' <- tc_lhs_type mode ty sig'
597 ; return (ty', sig') }
598
599 -- HsSpliced is an annotation produced by 'RnSplice.rnSpliceType' to communicate
600 -- the splice location to the typechecker. Here we skip over it in order to have
601 -- the same kind inferred for a given expression whether it was produced from
602 -- splices or not.
603 --
604 -- See Note [Delaying modFinalizers in untyped splices].
605 tc_infer_hs_type mode (HsSpliceTy _ (HsSpliced _ _ (HsSplicedTy ty)))
606 = tc_infer_hs_type mode ty
607
608 tc_infer_hs_type mode (HsDocTy _ ty _) = tc_infer_lhs_type mode ty
609 tc_infer_hs_type _ (XHsType (NHsCoreTy ty)) = return (ty, typeKind ty)
610 tc_infer_hs_type mode other_ty
611 = do { kv <- newMetaKindVar
612 ; ty' <- tc_hs_type mode other_ty kv
613 ; return (ty', kv) }
614
615 ------------------------------------------
616 tc_lhs_type :: TcTyMode -> LHsType GhcRn -> TcKind -> TcM TcType
617 tc_lhs_type mode (L span ty) exp_kind
618 = setSrcSpan span $
619 tc_hs_type mode ty exp_kind
620
621 ------------------------------------------
622 tc_fun_type :: TcTyMode -> LHsType GhcRn -> LHsType GhcRn -> TcKind
623 -> TcM TcType
624 tc_fun_type mode ty1 ty2 exp_kind = case mode_level mode of
625 TypeLevel ->
626 do { arg_k <- newOpenTypeKind
627 ; res_k <- newOpenTypeKind
628 ; ty1' <- tc_lhs_type mode ty1 arg_k
629 ; ty2' <- tc_lhs_type mode ty2 res_k
630 ; checkExpectedKind (HsFunTy noExt ty1 ty2) (mkFunTy ty1' ty2')
631 liftedTypeKind exp_kind }
632 KindLevel -> -- no representation polymorphism in kinds. yet.
633 do { ty1' <- tc_lhs_type mode ty1 liftedTypeKind
634 ; ty2' <- tc_lhs_type mode ty2 liftedTypeKind
635 ; checkExpectedKind (HsFunTy noExt ty1 ty2) (mkFunTy ty1' ty2')
636 liftedTypeKind exp_kind }
637
638 ------------------------------------------
639 tc_hs_type :: TcTyMode -> HsType GhcRn -> TcKind -> TcM TcType
640 -- See Note [The tcType invariant]
641 -- See Note [Bidirectional type checking]
642
643 tc_hs_type mode (HsParTy _ ty) exp_kind = tc_lhs_type mode ty exp_kind
644 tc_hs_type mode (HsDocTy _ ty _) exp_kind = tc_lhs_type mode ty exp_kind
645 tc_hs_type _ ty@(HsBangTy _ bang _) _
646 -- While top-level bangs at this point are eliminated (eg !(Maybe Int)),
647 -- other kinds of bangs are not (eg ((!Maybe) Int)). These kinds of
648 -- bangs are invalid, so fail. (#7210, #14761)
649 = do { let bangError err = failWith $
650 text "Unexpected" <+> text err <+> text "annotation:" <+> ppr ty $$
651 text err <+> text "annotation cannot appear nested inside a type"
652 ; case bang of
653 HsSrcBang _ SrcUnpack _ -> bangError "UNPACK"
654 HsSrcBang _ SrcNoUnpack _ -> bangError "NOUNPACK"
655 HsSrcBang _ NoSrcUnpack SrcLazy -> bangError "laziness"
656 HsSrcBang _ _ _ -> bangError "strictness" }
657 tc_hs_type _ ty@(HsRecTy {}) _
658 -- Record types (which only show up temporarily in constructor
659 -- signatures) should have been removed by now
660 = failWithTc (text "Record syntax is illegal here:" <+> ppr ty)
661
662 -- HsSpliced is an annotation produced by 'RnSplice.rnSpliceType'.
663 -- Here we get rid of it and add the finalizers to the global environment
664 -- while capturing the local environment.
665 --
666 -- See Note [Delaying modFinalizers in untyped splices].
667 tc_hs_type mode (HsSpliceTy _ (HsSpliced _ mod_finalizers (HsSplicedTy ty)))
668 exp_kind
669 = do addModFinalizersWithLclEnv mod_finalizers
670 tc_hs_type mode ty exp_kind
671
672 -- This should never happen; type splices are expanded by the renamer
673 tc_hs_type _ ty@(HsSpliceTy {}) _exp_kind
674 = failWithTc (text "Unexpected type splice:" <+> ppr ty)
675
676 ---------- Functions and applications
677 tc_hs_type mode (HsFunTy _ ty1 ty2) exp_kind
678 = tc_fun_type mode ty1 ty2 exp_kind
679
680 tc_hs_type mode (HsOpTy _ ty1 (L _ op) ty2) exp_kind
681 | op `hasKey` funTyConKey
682 = tc_fun_type mode ty1 ty2 exp_kind
683
684 --------- Foralls
685 tc_hs_type mode forall@(HsForAllTy { hst_bndrs = hs_tvs, hst_body = ty }) exp_kind
686 = do { (tvs', ty') <- tcExplicitTKBndrs (ForAllSkol (ppr forall)) hs_tvs $
687 tc_lhs_type mode ty exp_kind
688 -- Do not kind-generalise here! See Note [Kind generalisation]
689 -- Why exp_kind? See Note [Body kind of HsForAllTy]
690 ; let bndrs = mkTyVarBinders Specified tvs'
691 ; return (mkForAllTys bndrs ty') }
692
693 tc_hs_type mode (HsQualTy { hst_ctxt = ctxt, hst_body = ty }) exp_kind
694 | null (unLoc ctxt)
695 = tc_lhs_type mode ty exp_kind
696
697 | otherwise
698 = do { ctxt' <- tc_hs_context mode ctxt
699
700 -- See Note [Body kind of a HsQualTy]
701 ; ty' <- if isConstraintKind exp_kind
702 then tc_lhs_type mode ty constraintKind
703 else do { ek <- newOpenTypeKind
704 -- The body kind (result of the function)
705 -- can be * or #, hence newOpenTypeKind
706 ; ty' <- tc_lhs_type mode ty ek
707 ; checkExpectedKind (unLoc ty) ty' liftedTypeKind exp_kind }
708
709 ; return (mkPhiTy ctxt' ty') }
710
711 --------- Lists, arrays, and tuples
712 tc_hs_type mode rn_ty@(HsListTy _ elt_ty) exp_kind
713 = do { tau_ty <- tc_lhs_type mode elt_ty liftedTypeKind
714 ; checkWiredInTyCon listTyCon
715 ; checkExpectedKind rn_ty (mkListTy tau_ty) liftedTypeKind exp_kind }
716
717 -- See Note [Distinguishing tuple kinds] in HsTypes
718 -- See Note [Inferring tuple kinds]
719 tc_hs_type mode rn_ty@(HsTupleTy _ HsBoxedOrConstraintTuple hs_tys) exp_kind
720 -- (NB: not zonking before looking at exp_k, to avoid left-right bias)
721 | Just tup_sort <- tupKindSort_maybe exp_kind
722 = traceTc "tc_hs_type tuple" (ppr hs_tys) >>
723 tc_tuple rn_ty mode tup_sort hs_tys exp_kind
724 | otherwise
725 = do { traceTc "tc_hs_type tuple 2" (ppr hs_tys)
726 ; (tys, kinds) <- mapAndUnzipM (tc_infer_lhs_type mode) hs_tys
727 ; kinds <- mapM zonkTcType kinds
728 -- Infer each arg type separately, because errors can be
729 -- confusing if we give them a shared kind. Eg Trac #7410
730 -- (Either Int, Int), we do not want to get an error saying
731 -- "the second argument of a tuple should have kind *->*"
732
733 ; let (arg_kind, tup_sort)
734 = case [ (k,s) | k <- kinds
735 , Just s <- [tupKindSort_maybe k] ] of
736 ((k,s) : _) -> (k,s)
737 [] -> (liftedTypeKind, BoxedTuple)
738 -- In the [] case, it's not clear what the kind is, so guess *
739
740 ; tys' <- sequence [ setSrcSpan loc $
741 checkExpectedKind hs_ty ty kind arg_kind
742 | ((L loc hs_ty),ty,kind) <- zip3 hs_tys tys kinds ]
743
744 ; finish_tuple rn_ty tup_sort tys' (map (const arg_kind) tys') exp_kind }
745
746
747 tc_hs_type mode rn_ty@(HsTupleTy _ hs_tup_sort tys) exp_kind
748 = tc_tuple rn_ty mode tup_sort tys exp_kind
749 where
750 tup_sort = case hs_tup_sort of -- Fourth case dealt with above
751 HsUnboxedTuple -> UnboxedTuple
752 HsBoxedTuple -> BoxedTuple
753 HsConstraintTuple -> ConstraintTuple
754 _ -> panic "tc_hs_type HsTupleTy"
755
756 tc_hs_type mode rn_ty@(HsSumTy _ hs_tys) exp_kind
757 = do { let arity = length hs_tys
758 ; arg_kinds <- mapM (\_ -> newOpenTypeKind) hs_tys
759 ; tau_tys <- zipWithM (tc_lhs_type mode) hs_tys arg_kinds
760 ; let arg_reps = map getRuntimeRepFromKind arg_kinds
761 arg_tys = arg_reps ++ tau_tys
762 ; checkExpectedKind rn_ty
763 (mkTyConApp (sumTyCon arity) arg_tys)
764 (unboxedSumKind arg_reps)
765 exp_kind
766 }
767
768 --------- Promoted lists and tuples
769 tc_hs_type mode rn_ty@(HsExplicitListTy _ _ tys) exp_kind
770 = do { tks <- mapM (tc_infer_lhs_type mode) tys
771 ; (taus', kind) <- unifyKinds tys tks
772 ; let ty = (foldr (mk_cons kind) (mk_nil kind) taus')
773 ; checkExpectedKind rn_ty ty (mkListTy kind) exp_kind }
774 where
775 mk_cons k a b = mkTyConApp (promoteDataCon consDataCon) [k, a, b]
776 mk_nil k = mkTyConApp (promoteDataCon nilDataCon) [k]
777
778 tc_hs_type mode rn_ty@(HsExplicitTupleTy _ tys) exp_kind
779 -- using newMetaKindVar means that we force instantiations of any polykinded
780 -- types. At first, I just used tc_infer_lhs_type, but that led to #11255.
781 = do { ks <- replicateM arity newMetaKindVar
782 ; taus <- zipWithM (tc_lhs_type mode) tys ks
783 ; let kind_con = tupleTyCon Boxed arity
784 ty_con = promotedTupleDataCon Boxed arity
785 tup_k = mkTyConApp kind_con ks
786 ; checkExpectedKind rn_ty (mkTyConApp ty_con (ks ++ taus)) tup_k exp_kind }
787 where
788 arity = length tys
789
790 --------- Constraint types
791 tc_hs_type mode rn_ty@(HsIParamTy _ (L _ n) ty) exp_kind
792 = do { MASSERT( isTypeLevel (mode_level mode) )
793 ; ty' <- tc_lhs_type mode ty liftedTypeKind
794 ; let n' = mkStrLitTy $ hsIPNameFS n
795 ; ipClass <- tcLookupClass ipClassName
796 ; checkExpectedKind rn_ty (mkClassPred ipClass [n',ty'])
797 constraintKind exp_kind }
798
799 tc_hs_type _ rn_ty@(HsStarTy _ _) exp_kind
800 -- Desugaring 'HsStarTy' to 'Data.Kind.Type' here means that we don't have to
801 -- handle it in 'coreView' and 'tcView'.
802 = checkExpectedKind rn_ty liftedTypeKind liftedTypeKind exp_kind
803
804 --------- Literals
805 tc_hs_type _ rn_ty@(HsTyLit _ (HsNumTy _ n)) exp_kind
806 = do { checkWiredInTyCon typeNatKindCon
807 ; checkExpectedKind rn_ty (mkNumLitTy n) typeNatKind exp_kind }
808
809 tc_hs_type _ rn_ty@(HsTyLit _ (HsStrTy _ s)) exp_kind
810 = do { checkWiredInTyCon typeSymbolKindCon
811 ; checkExpectedKind rn_ty (mkStrLitTy s) typeSymbolKind exp_kind }
812
813 --------- Potentially kind-polymorphic types: call the "up" checker
814 -- See Note [Future-proofing the type checker]
815 tc_hs_type mode ty@(HsTyVar {}) ek = tc_infer_hs_type_ek mode ty ek
816 tc_hs_type mode ty@(HsAppTy {}) ek = tc_infer_hs_type_ek mode ty ek
817 tc_hs_type mode ty@(HsOpTy {}) ek = tc_infer_hs_type_ek mode ty ek
818 tc_hs_type mode ty@(HsKindSig {}) ek = tc_infer_hs_type_ek mode ty ek
819 tc_hs_type mode ty@(XHsType (NHsCoreTy{})) ek = tc_infer_hs_type_ek mode ty ek
820
821 tc_hs_type _ (HsWildCardTy wc) exp_kind
822 = do { wc_ty <- tcWildCardOcc wc exp_kind
823 ; return (mkNakedCastTy wc_ty (mkTcNomReflCo exp_kind))
824 -- Take care here! Even though the coercion is Refl,
825 -- we still need it to establish Note [The tcType invariant]
826 }
827
828 tcWildCardOcc :: HsWildCardInfo -> Kind -> TcM TcType
829 tcWildCardOcc wc_info exp_kind
830 = do { wc_tv <- tcLookupTyVar (wildCardName wc_info)
831 -- The wildcard's kind should be an un-filled-in meta tyvar
832 ; checkExpectedKind (HsWildCardTy wc_info) (mkTyVarTy wc_tv)
833 (tyVarKind wc_tv) exp_kind }
834
835 ---------------------------
836 -- | Call 'tc_infer_hs_type' and check its result against an expected kind.
837 tc_infer_hs_type_ek :: TcTyMode -> HsType GhcRn -> TcKind -> TcM TcType
838 tc_infer_hs_type_ek mode hs_ty ek
839 = do { (ty, k) <- tc_infer_hs_type mode hs_ty
840 ; checkExpectedKind hs_ty ty k ek }
841
842 ---------------------------
843 tupKindSort_maybe :: TcKind -> Maybe TupleSort
844 tupKindSort_maybe k
845 | Just (k', _) <- splitCastTy_maybe k = tupKindSort_maybe k'
846 | Just k' <- tcView k = tupKindSort_maybe k'
847 | isConstraintKind k = Just ConstraintTuple
848 | isLiftedTypeKind k = Just BoxedTuple
849 | otherwise = Nothing
850
851 tc_tuple :: HsType GhcRn -> TcTyMode -> TupleSort -> [LHsType GhcRn] -> TcKind -> TcM TcType
852 tc_tuple rn_ty mode tup_sort tys exp_kind
853 = do { arg_kinds <- case tup_sort of
854 BoxedTuple -> return (nOfThem arity liftedTypeKind)
855 UnboxedTuple -> mapM (\_ -> newOpenTypeKind) tys
856 ConstraintTuple -> return (nOfThem arity constraintKind)
857 ; tau_tys <- zipWithM (tc_lhs_type mode) tys arg_kinds
858 ; finish_tuple rn_ty tup_sort tau_tys arg_kinds exp_kind }
859 where
860 arity = length tys
861
862 finish_tuple :: HsType GhcRn
863 -> TupleSort
864 -> [TcType] -- ^ argument types
865 -> [TcKind] -- ^ of these kinds
866 -> TcKind -- ^ expected kind of the whole tuple
867 -> TcM TcType
868 finish_tuple rn_ty tup_sort tau_tys tau_kinds exp_kind
869 = do { traceTc "finish_tuple" (ppr res_kind $$ ppr tau_kinds $$ ppr exp_kind)
870 ; let arg_tys = case tup_sort of
871 -- See also Note [Unboxed tuple RuntimeRep vars] in TyCon
872 UnboxedTuple -> tau_reps ++ tau_tys
873 BoxedTuple -> tau_tys
874 ConstraintTuple -> tau_tys
875 ; tycon <- case tup_sort of
876 ConstraintTuple
877 | arity > mAX_CTUPLE_SIZE
878 -> failWith (bigConstraintTuple arity)
879 | otherwise -> tcLookupTyCon (cTupleTyConName arity)
880 BoxedTuple -> do { let tc = tupleTyCon Boxed arity
881 ; checkWiredInTyCon tc
882 ; return tc }
883 UnboxedTuple -> return (tupleTyCon Unboxed arity)
884 ; checkExpectedKind rn_ty (mkTyConApp tycon arg_tys) res_kind exp_kind }
885 where
886 arity = length tau_tys
887 tau_reps = map getRuntimeRepFromKind tau_kinds
888 res_kind = case tup_sort of
889 UnboxedTuple -> unboxedTupleKind tau_reps
890 BoxedTuple -> liftedTypeKind
891 ConstraintTuple -> constraintKind
892
893 bigConstraintTuple :: Arity -> MsgDoc
894 bigConstraintTuple arity
895 = hang (text "Constraint tuple arity too large:" <+> int arity
896 <+> parens (text "max arity =" <+> int mAX_CTUPLE_SIZE))
897 2 (text "Instead, use a nested tuple")
898
899 ---------------------------
900 -- | Apply a type of a given kind to a list of arguments. This instantiates
901 -- invisible parameters as necessary. Always consumes all the arguments,
902 -- using matchExpectedFunKind as necessary.
903 -- This takes an optional @VarEnv Kind@ which maps kind variables to kinds.
904 -- These kinds should be used to instantiate invisible kind variables;
905 -- they come from an enclosing class for an associated type/data family.
906 tcInferApps :: TcTyMode
907 -> Maybe (VarEnv Kind) -- ^ Possibly, kind info (see above)
908 -> LHsType GhcRn -- ^ Function (for printing only)
909 -> TcType -- ^ Function (could be knot-tied)
910 -> TcKind -- ^ Function kind (zonked)
911 -> [LHsType GhcRn] -- ^ Args
912 -> TcM (TcType, [TcType], TcKind) -- ^ (f args, args, result kind)
913 -- Precondition: typeKind fun_ty = fun_ki
914 -- Reason: we will return a type application like (fun_ty arg1 ... argn),
915 -- and that type must be well-kinded
916 -- See Note [The tcType invariant]
917 tcInferApps mode mb_kind_info orig_hs_ty fun_ty fun_ki orig_hs_args
918 = do { traceTc "tcInferApps {" (ppr orig_hs_ty $$ ppr orig_hs_args $$ ppr fun_ki)
919 ; stuff <- go 1 [] empty_subst fun_ty orig_ki_binders orig_inner_ki orig_hs_args
920 ; traceTc "tcInferApps }" empty
921 ; return stuff }
922 where
923 empty_subst = mkEmptyTCvSubst $ mkInScopeSet $
924 tyCoVarsOfType fun_ki
925 (orig_ki_binders, orig_inner_ki) = tcSplitPiTys fun_ki
926
927 go :: Int -- the # of the next argument
928 -> [TcType] -- already type-checked args, in reverse order
929 -> TCvSubst -- instantiating substitution
930 -> TcType -- function applied to some args, could be knot-tied
931 -> [TyBinder] -- binders in function kind (both vis. and invis.)
932 -> TcKind -- function kind body (not a Pi-type)
933 -> [LHsType GhcRn] -- un-type-checked args
934 -> TcM (TcType, [TcType], TcKind) -- same as overall return type
935
936 -- no user-written args left. We're done!
937 go _ acc_args subst fun ki_binders inner_ki []
938 = return (fun, reverse acc_args, substTy subst $ mkPiTys ki_binders inner_ki)
939
940 -- The function's kind has a binder. Is it visible or invisible?
941 go n acc_args subst fun (ki_binder:ki_binders) inner_ki
942 all_args@(arg:args)
943 | isInvisibleBinder ki_binder
944 -- It's invisible. Instantiate.
945 = do { traceTc "tcInferApps (invis)" (ppr ki_binder $$ ppr subst)
946 ; (subst', arg') <- tcInstTyBinder mb_kind_info subst ki_binder
947 ; go n (arg' : acc_args) subst' (mkNakedAppTy fun arg')
948 ki_binders inner_ki all_args }
949
950 | otherwise
951 -- It's visible. Check the next user-written argument
952 = do { traceTc "tcInferApps (vis)" (vcat [ ppr ki_binder, ppr arg
953 , ppr (tyBinderType ki_binder)
954 , ppr subst ])
955 ; arg' <- addErrCtxt (funAppCtxt orig_hs_ty arg n) $
956 tc_lhs_type mode arg (substTy subst $ tyBinderType ki_binder)
957 ; let subst' = extendTvSubstBinderAndInScope subst ki_binder arg'
958 ; go (n+1) (arg' : acc_args) subst'
959 (mkNakedAppTy fun arg')
960 ki_binders inner_ki args }
961
962 -- We've run out of known binders in the functions's kind.
963 go n acc_args subst fun [] inner_ki all_args
964 | not (null new_ki_binders)
965 -- But, after substituting, we have more binders.
966 = go n acc_args zapped_subst fun new_ki_binders new_inner_ki all_args
967
968 | otherwise
969 -- Even after substituting, still no binders. Use matchExpectedFunKind
970 = do { traceTc "tcInferApps (no binder)" (ppr new_inner_ki $$ ppr zapped_subst)
971 ; (co, arg_k, res_k) <- matchExpectedFunKind hs_ty substed_inner_ki
972 ; let new_in_scope = tyCoVarsOfTypes [arg_k, res_k]
973 subst' = zapped_subst `extendTCvInScopeSet` new_in_scope
974 ; go n acc_args subst'
975 (fun `mkNakedCastTy` co)
976 [mkAnonBinder arg_k]
977 res_k all_args }
978 where
979 substed_inner_ki = substTy subst inner_ki
980 (new_ki_binders, new_inner_ki) = tcSplitPiTys substed_inner_ki
981 zapped_subst = zapTCvSubst subst
982 hs_ty = mkHsAppTys orig_hs_ty (take (n-1) orig_hs_args)
983
984
985 -- | Applies a type to a list of arguments.
986 -- Always consumes all the arguments, using 'matchExpectedFunKind' as
987 -- necessary. If you wish to apply a type to a list of HsTypes, this is
988 -- your function.
989 -- Used for type-checking types only.
990 tcTyApps :: TcTyMode
991 -> LHsType GhcRn -- ^ Function (for printing only)
992 -> TcType -- ^ Function (could be knot-tied)
993 -> TcKind -- ^ Function kind (zonked)
994 -> [LHsType GhcRn] -- ^ Args
995 -> TcM (TcType, TcKind) -- ^ (f args, result kind)
996 -- Precondition: see precondition for tcInferApps
997 tcTyApps mode orig_hs_ty fun_ty fun_ki args
998 = do { (ty', _args, ki') <- tcInferApps mode Nothing orig_hs_ty fun_ty fun_ki args
999 ; return (ty', ki') }
1000
1001 --------------------------
1002 -- Like checkExpectedKindX, but returns only the final type; convenient wrapper
1003 -- Obeys Note [The tcType invariant]
1004 checkExpectedKind :: HsType GhcRn -- type we're checking (for printing)
1005 -> TcType -- type we're checking (might be knot-tied)
1006 -> TcKind -- the known kind of that type
1007 -> TcKind -- the expected kind
1008 -> TcM TcType
1009 checkExpectedKind hs_ty ty act exp
1010 = fstOf3 <$> checkExpectedKindX Nothing (ppr hs_ty) ty act exp
1011
1012 checkExpectedKindX :: Maybe (VarEnv Kind) -- Possibly, instantiations for kind vars
1013 -> SDoc -- HsType whose kind we're checking
1014 -> TcType -- the type whose kind we're checking
1015 -> TcKind -- the known kind of that type, k
1016 -> TcKind -- the expected kind, exp_kind
1017 -> TcM (TcType, [TcType], TcCoercionN)
1018 -- (the new args, the coercion)
1019 -- Instantiate a kind (if necessary) and then call unifyType
1020 -- (checkExpectedKind ty act_kind exp_kind)
1021 -- checks that the actual kind act_kind is compatible
1022 -- with the expected kind exp_kind
1023 checkExpectedKindX mb_kind_env pp_hs_ty ty act_kind exp_kind
1024 = do { -- We need to make sure that both kinds have the same number of implicit
1025 -- foralls out front. If the actual kind has more, instantiate accordingly.
1026 -- Otherwise, just pass the type & kind through: the errors are caught
1027 -- in unifyType.
1028 let (exp_bndrs, _) = splitPiTysInvisible exp_kind
1029 n_exp = length exp_bndrs
1030 ; (new_args, act_kind') <- instantiateTyUntilN mb_kind_env n_exp act_kind
1031
1032 ; let origin = TypeEqOrigin { uo_actual = act_kind'
1033 , uo_expected = exp_kind
1034 , uo_thing = Just pp_hs_ty
1035 , uo_visible = True } -- the hs_ty is visible
1036 ty' = mkNakedAppTys ty new_args
1037
1038 ; traceTc "checkExpectedKind" $
1039 vcat [ pp_hs_ty
1040 , text "act_kind:" <+> ppr act_kind
1041 , text "act_kind':" <+> ppr act_kind'
1042 , text "exp_kind:" <+> ppr exp_kind ]
1043
1044 ; if act_kind' `tcEqType` exp_kind
1045 then return (ty', new_args, mkTcNomReflCo exp_kind) -- This is very common
1046 else do { co_k <- uType KindLevel origin act_kind' exp_kind
1047 ; traceTc "checkExpectedKind" (vcat [ ppr act_kind
1048 , ppr exp_kind
1049 , ppr co_k ])
1050 ; let result_ty = ty' `mkNakedCastTy` co_k
1051 -- See Note [The tcType invariant]
1052 ; return (result_ty, new_args, co_k) } }
1053
1054 -- | Instantiate @n@ invisible arguments to a type. If @n <= 0@, no instantiation
1055 -- occurs. If @n@ is too big, then all available invisible arguments are instantiated.
1056 -- (In other words, this function is very forgiving about bad values of @n@.)
1057 instantiateTyN :: Maybe (VarEnv Kind) -- ^ Predetermined instantiations
1058 -- (for assoc. type patterns)
1059 -> Int -- ^ @n@
1060 -> [TyBinder] -> TcKind -- ^ its kind
1061 -> TcM ([TcType], TcKind) -- ^ The inst'ed type, new args, kind
1062 instantiateTyN mb_kind_env n bndrs inner_ki
1063 | n <= 0
1064 = return ([], ki)
1065
1066 | otherwise
1067 = do { (subst, inst_args) <- tcInstTyBinders empty_subst mb_kind_env inst_bndrs
1068 ; let rebuilt_ki = mkPiTys leftover_bndrs inner_ki
1069 ki' = substTy subst rebuilt_ki
1070 ; traceTc "instantiateTyN" (vcat [ ppr ki
1071 , ppr n
1072 , ppr subst
1073 , ppr rebuilt_ki
1074 , ppr ki' ])
1075 ; return (inst_args, ki') }
1076 where
1077 -- NB: splitAt is forgiving with invalid numbers
1078 (inst_bndrs, leftover_bndrs) = splitAt n bndrs
1079 ki = mkPiTys bndrs inner_ki
1080 empty_subst = mkEmptyTCvSubst (mkInScopeSet (tyCoVarsOfType ki))
1081
1082 -- | Instantiate a type to have at most @n@ invisible arguments.
1083 instantiateTyUntilN :: Maybe (VarEnv Kind) -- ^ Possibly, instantiations for vars
1084 -> Int -- ^ @n@
1085 -> TcKind -- ^ its kind
1086 -> TcM ([TcType], TcKind) -- ^ The new args, final kind
1087 instantiateTyUntilN mb_kind_env n ki
1088 = let (bndrs, inner_ki) = splitPiTysInvisible ki
1089 num_to_inst = length bndrs - n
1090 in
1091 instantiateTyN mb_kind_env num_to_inst bndrs inner_ki
1092
1093 ---------------------------
1094 tcHsMbContext :: Maybe (LHsContext GhcRn) -> TcM [PredType]
1095 tcHsMbContext Nothing = return []
1096 tcHsMbContext (Just cxt) = tcHsContext cxt
1097
1098 tcHsContext :: LHsContext GhcRn -> TcM [PredType]
1099 tcHsContext = tc_hs_context typeLevelMode
1100
1101 tcLHsPredType :: LHsType GhcRn -> TcM PredType
1102 tcLHsPredType = tc_lhs_pred typeLevelMode
1103
1104 tc_hs_context :: TcTyMode -> LHsContext GhcRn -> TcM [PredType]
1105 tc_hs_context mode ctxt = mapM (tc_lhs_pred mode) (unLoc ctxt)
1106
1107 tc_lhs_pred :: TcTyMode -> LHsType GhcRn -> TcM PredType
1108 tc_lhs_pred mode pred = tc_lhs_type mode pred constraintKind
1109
1110 ---------------------------
1111 tcTyVar :: TcTyMode -> Name -> TcM (TcType, TcKind)
1112 -- See Note [Type checking recursive type and class declarations]
1113 -- in TcTyClsDecls
1114 tcTyVar mode name -- Could be a tyvar, a tycon, or a datacon
1115 = do { traceTc "lk1" (ppr name)
1116 ; thing <- tcLookup name
1117 ; case thing of
1118 ATyVar _ tv -> -- Important: zonk before returning
1119 -- We may have the application ((a::kappa) b)
1120 -- where kappa is already unified to (k1 -> k2)
1121 -- Then we want to see that arrow. Best done
1122 -- here because we are also maintaining
1123 -- Note [The tcType invariant], so we don't just
1124 -- want to zonk the kind, leaving the TyVar
1125 -- un-zonked (Trac #114873)
1126 do { ty <- zonkTcTyVar tv
1127 ; return (ty, typeKind ty) }
1128
1129 ATcTyCon tc_tc -> do { -- See Note [GADT kind self-reference]
1130 unless
1131 (isTypeLevel (mode_level mode))
1132 (promotionErr name TyConPE)
1133 ; check_tc tc_tc
1134 ; tc <- get_loopy_tc name tc_tc
1135 ; handle_tyfams tc tc_tc }
1136 -- mkNakedTyConApp: see Note [Type-checking inside the knot]
1137
1138 AGlobal (ATyCon tc)
1139 -> do { check_tc tc
1140 ; handle_tyfams tc tc }
1141
1142 AGlobal (AConLike (RealDataCon dc))
1143 -> do { data_kinds <- xoptM LangExt.DataKinds
1144 ; unless (data_kinds || specialPromotedDc dc) $
1145 promotionErr name NoDataKindsDC
1146 ; when (isFamInstTyCon (dataConTyCon dc)) $
1147 -- see Trac #15245
1148 promotionErr name FamDataConPE
1149 ; let (_, _, _, theta, _, _) = dataConFullSig dc
1150 ; case dc_theta_illegal_constraint theta of
1151 Just pred -> promotionErr name $
1152 ConstrainedDataConPE pred
1153 Nothing -> pure ()
1154 ; let tc = promoteDataCon dc
1155 ; return (mkNakedTyConApp tc [], tyConKind tc) }
1156
1157 APromotionErr err -> promotionErr name err
1158
1159 _ -> wrongThingErr "type" thing name }
1160 where
1161 check_tc :: TyCon -> TcM ()
1162 check_tc tc = do { data_kinds <- xoptM LangExt.DataKinds
1163 ; unless (isTypeLevel (mode_level mode) ||
1164 data_kinds ||
1165 isKindTyCon tc) $
1166 promotionErr name NoDataKindsTC }
1167
1168 -- if we are type-checking a type family tycon, we must instantiate
1169 -- any invisible arguments right away. Otherwise, we get #11246
1170 handle_tyfams :: TyCon -- the tycon to instantiate (might be loopy)
1171 -> TcTyCon -- a non-loopy version of the tycon
1172 -> TcM (TcType, TcKind)
1173 handle_tyfams tc tc_tc
1174 | mightBeUnsaturatedTyCon tc_tc || mode_unsat mode
1175 -- This is where mode_unsat is used
1176 = do { traceTc "tcTyVar2a" (ppr tc_tc $$ ppr tc_kind)
1177 ; return (mkNakedTyConApp tc [], tc_kind) }
1178
1179 | otherwise
1180 = do { (tc_args, kind) <- instantiateTyN Nothing (length (tyConBinders tc_tc))
1181 tc_kind_bndrs tc_inner_ki
1182 ; let tc_ty = mkNakedTyConApp tc tc_args
1183 -- tc and tc_ty must not be traced here, because that would
1184 -- force the evaluation of a potentially knot-tied variable (tc),
1185 -- and the typechecker would hang, as per #11708
1186 ; traceTc "tcTyVar2b" (vcat [ ppr tc_tc <+> dcolon <+> ppr tc_kind
1187 , ppr kind ])
1188 ; return (tc_ty, kind) }
1189 where
1190 tc_kind = tyConKind tc_tc
1191 (tc_kind_bndrs, tc_inner_ki) = splitPiTysInvisible tc_kind
1192
1193 get_loopy_tc :: Name -> TyCon -> TcM TyCon
1194 -- Return the knot-tied global TyCon if there is one
1195 -- Otherwise the local TcTyCon; we must be doing kind checking
1196 -- but we still want to return a TyCon of some sort to use in
1197 -- error messages
1198 get_loopy_tc name tc_tc
1199 = do { env <- getGblEnv
1200 ; case lookupNameEnv (tcg_type_env env) name of
1201 Just (ATyCon tc) -> return tc
1202 _ -> do { traceTc "lk1 (loopy)" (ppr name)
1203 ; return tc_tc } }
1204
1205 -- We cannot promote a data constructor with a context that contains
1206 -- constraints other than equalities, so error if we find one.
1207 -- See Note [Don't promote data constructors with non-equality contexts]
1208 dc_theta_illegal_constraint :: ThetaType -> Maybe PredType
1209 dc_theta_illegal_constraint = find go
1210 where
1211 go :: PredType -> Bool
1212 go pred | Just tc <- tyConAppTyCon_maybe pred
1213 = not $ tc `hasKey` eqTyConKey
1214 || tc `hasKey` heqTyConKey
1215 | otherwise = True
1216
1217 {-
1218 Note [Type-checking inside the knot]
1219 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1220 Suppose we are checking the argument types of a data constructor. We
1221 must zonk the types before making the DataCon, because once built we
1222 can't change it. So we must traverse the type.
1223
1224 BUT the parent TyCon is knot-tied, so we can't look at it yet.
1225
1226 So we must be careful not to use "smart constructors" for types that
1227 look at the TyCon or Class involved.
1228
1229 * Hence the use of mkNakedXXX functions. These do *not* enforce
1230 the invariants (for example that we use (FunTy s t) rather
1231 than (TyConApp (->) [s,t])).
1232
1233 * The zonking functions establish invariants (even zonkTcType, a change from
1234 previous behaviour). So we must never inspect the result of a
1235 zonk that might mention a knot-tied TyCon. This is generally OK
1236 because we zonk *kinds* while kind-checking types. And the TyCons
1237 in kinds shouldn't be knot-tied, because they come from a previous
1238 mutually recursive group.
1239
1240 * TcHsSyn.zonkTcTypeToType also can safely check/establish
1241 invariants.
1242
1243 This is horribly delicate. I hate it. A good example of how
1244 delicate it is can be seen in Trac #7903.
1245
1246 Note [GADT kind self-reference]
1247 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1248
1249 A promoted type cannot be used in the body of that type's declaration.
1250 Trac #11554 shows this example, which made GHC loop:
1251
1252 import Data.Kind
1253 data P (x :: k) = Q
1254 data A :: Type where
1255 B :: forall (a :: A). P a -> A
1256
1257 In order to check the constructor B, we need to have the promoted type A, but in
1258 order to get that promoted type, B must first be checked. To prevent looping, a
1259 TyConPE promotion error is given when tcTyVar checks an ATcTyCon in kind mode.
1260 Any ATcTyCon is a TyCon being defined in the current recursive group (see data
1261 type decl for TcTyThing), and all such TyCons are illegal in kinds.
1262
1263 Trac #11962 proposes checking the head of a data declaration separately from
1264 its constructors. This would allow the example above to pass.
1265
1266 Note [Body kind of a HsForAllTy]
1267 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1268 The body of a forall is usually a type, but in principle
1269 there's no reason to prohibit *unlifted* types.
1270 In fact, GHC can itself construct a function with an
1271 unboxed tuple inside a for-all (via CPR analysis; see
1272 typecheck/should_compile/tc170).
1273
1274 Moreover in instance heads we get forall-types with
1275 kind Constraint.
1276
1277 It's tempting to check that the body kind is either * or #. But this is
1278 wrong. For example:
1279
1280 class C a b
1281 newtype N = Mk Foo deriving (C a)
1282
1283 We're doing newtype-deriving for C. But notice how `a` isn't in scope in
1284 the predicate `C a`. So we quantify, yielding `forall a. C a` even though
1285 `C a` has kind `* -> Constraint`. The `forall a. C a` is a bit cheeky, but
1286 convenient. Bottom line: don't check for * or # here.
1287
1288 Note [Body kind of a HsQualTy]
1289 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1290 If ctxt is non-empty, the HsQualTy really is a /function/, so the
1291 kind of the result really is '*', and in that case the kind of the
1292 body-type can be lifted or unlifted.
1293
1294 However, consider
1295 instance Eq a => Eq [a] where ...
1296 or
1297 f :: (Eq a => Eq [a]) => blah
1298 Here both body-kind of the HsQualTy is Constraint rather than *.
1299 Rather crudely we tell the difference by looking at exp_kind. It's
1300 very convenient to typecheck instance types like any other HsSigType.
1301
1302 Admittedly the '(Eq a => Eq [a]) => blah' case is erroneous, but it's
1303 better to reject in checkValidType. If we say that the body kind
1304 should be '*' we risk getting TWO error messages, one saying that Eq
1305 [a] doens't have kind '*', and one saying that we need a Constraint to
1306 the left of the outer (=>).
1307
1308 How do we figure out the right body kind? Well, it's a bit of a
1309 kludge: I just look at the expected kind. If it's Constraint, we
1310 must be in this instance situation context. It's a kludge because it
1311 wouldn't work if any unification was involved to compute that result
1312 kind -- but it isn't. (The true way might be to use the 'mode'
1313 parameter, but that seemed like a sledgehammer to crack a nut.)
1314
1315 Note [Inferring tuple kinds]
1316 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1317 Give a tuple type (a,b,c), which the parser labels as HsBoxedOrConstraintTuple,
1318 we try to figure out whether it's a tuple of kind * or Constraint.
1319 Step 1: look at the expected kind
1320 Step 2: infer argument kinds
1321
1322 If after Step 2 it's not clear from the arguments that it's
1323 Constraint, then it must be *. Once having decided that we re-check
1324 the Check the arguments again to give good error messages
1325 in eg. `(Maybe, Maybe)`
1326
1327 Note that we will still fail to infer the correct kind in this case:
1328
1329 type T a = ((a,a), D a)
1330 type family D :: Constraint -> Constraint
1331
1332 While kind checking T, we do not yet know the kind of D, so we will default the
1333 kind of T to * -> *. It works if we annotate `a` with kind `Constraint`.
1334
1335 Note [Desugaring types]
1336 ~~~~~~~~~~~~~~~~~~~~~~~
1337 The type desugarer is phase 2 of dealing with HsTypes. Specifically:
1338
1339 * It transforms from HsType to Type
1340
1341 * It zonks any kinds. The returned type should have no mutable kind
1342 or type variables (hence returning Type not TcType):
1343 - any unconstrained kind variables are defaulted to (Any *) just
1344 as in TcHsSyn.
1345 - there are no mutable type variables because we are
1346 kind-checking a type
1347 Reason: the returned type may be put in a TyCon or DataCon where
1348 it will never subsequently be zonked.
1349
1350 You might worry about nested scopes:
1351 ..a:kappa in scope..
1352 let f :: forall b. T '[a,b] -> Int
1353 In this case, f's type could have a mutable kind variable kappa in it;
1354 and we might then default it to (Any *) when dealing with f's type
1355 signature. But we don't expect this to happen because we can't get a
1356 lexically scoped type variable with a mutable kind variable in it. A
1357 delicate point, this. If it becomes an issue we might need to
1358 distinguish top-level from nested uses.
1359
1360 Moreover
1361 * it cannot fail,
1362 * it does no unifications
1363 * it does no validity checking, except for structural matters, such as
1364 (a) spurious ! annotations.
1365 (b) a class used as a type
1366
1367 Note [Kind of a type splice]
1368 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1369 Consider these terms, each with TH type splice inside:
1370 [| e1 :: Maybe $(..blah..) |]
1371 [| e2 :: $(..blah..) |]
1372 When kind-checking the type signature, we'll kind-check the splice
1373 $(..blah..); we want to give it a kind that can fit in any context,
1374 as if $(..blah..) :: forall k. k.
1375
1376 In the e1 example, the context of the splice fixes kappa to *. But
1377 in the e2 example, we'll desugar the type, zonking the kind unification
1378 variables as we go. When we encounter the unconstrained kappa, we
1379 want to default it to '*', not to (Any *).
1380
1381 Note [Don't promote data constructors with non-equality contexts]
1382 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1383 With -XTypeInType, one can promote almost any data constructor. There is a
1384 notable exception to this rule, however: data constructors that contain
1385 non-equality constraints, such as:
1386
1387 data Foo a where
1388 MkFoo :: Show a => Foo a
1389
1390 MkFoo cannot be promoted since GHC cannot produce evidence for (Show a) at the
1391 kind level. Therefore, we check the context of each data constructor before
1392 promotion, and give a sensible error message if the context contains an illegal
1393 constraint.
1394
1395 Note that equality constraints (i.e, (~) and (~~)) /are/
1396 permitted inside data constructor contexts. All other constraints are
1397 off-limits, however (and likely will remain off-limits until dependent types
1398 become a reality in GHC).
1399
1400 Help functions for type applications
1401 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1402 -}
1403
1404 addTypeCtxt :: LHsType GhcRn -> TcM a -> TcM a
1405 -- Wrap a context around only if we want to show that contexts.
1406 -- Omit invisible ones and ones user's won't grok
1407 addTypeCtxt (L _ ty) thing
1408 = addErrCtxt doc thing
1409 where
1410 doc = text "In the type" <+> quotes (ppr ty)
1411
1412 {-
1413 ************************************************************************
1414 * *
1415 Type-variable binders
1416 %* *
1417 %************************************************************************
1418
1419 Note [Dependent LHsQTyVars]
1420 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
1421 We track (in the renamer) which explicitly bound variables in a
1422 LHsQTyVars are manifestly dependent; only precisely these variables
1423 may be used within the LHsQTyVars. We must do this so that kcLHsQTyVars
1424 can produce the right TyConBinders, and tell Anon vs. Required.
1425
1426 Example data T k1 (a:k1) (b:k2) c
1427 = MkT (Proxy a) (Proxy b) (Proxy c)
1428
1429 Here
1430 (a:k1),(b:k2),(c:k3)
1431 are Anon (explicitly specified as a binder, not used
1432 in the kind of any other binder
1433 k1 is Required (explicitly specifed as a binder, but used
1434 in the kind of another binder i.e. dependently)
1435 k2 is Specified (not explicitly bound, but used in the kind
1436 of another binder)
1437 k3 in Inferred (not lexically in scope at all, but inferred
1438 by kind inference)
1439 and
1440 T :: forall {k3} k1. forall k3 -> k1 -> k2 -> k3 -> *
1441
1442 See Note [TyVarBndrs, TyVarBinders, TyConBinders, and visibility]
1443 in TyCoRep.
1444
1445 kcLHsQTyVars uses the hsq_dependent field to decide whether
1446 k1, a, b, c should be Required or Anon.
1447
1448 Earlier, thought it would work simply to do a free-variable check
1449 during kcLHsQTyVars, but this is bogus, because there may be
1450 unsolved equalities about. And we don't want to eagerly solve the
1451 equalities, because we may get further information after
1452 kcLHsQTyVars is called. (Recall that kcLHsQTyVars is called
1453 only from getInitialKind.)
1454 This is what implements the rule that all variables intended to be
1455 dependent must be manifestly so.
1456
1457 Sidenote: It's quite possible that later, we'll consider (t -> s)
1458 as a degenerate case of some (pi (x :: t) -> s) and then this will
1459 all get more permissive.
1460
1461 Note [Kind generalisation and SigTvs]
1462 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1463 Consider
1464 data T (a :: k1) x = MkT (S a ())
1465 data S (b :: k2) y = MkS (T b ())
1466
1467 While we are doing kind inference for the mutually-recursive S,T,
1468 we will end up unifying k1 and k2 together. So they can't be skolems.
1469 We therefore make them SigTvs, which can unify with type variables,
1470 but not with general types. All this is very similar at the level
1471 of terms: see Note [Quantified variables in partial type signatures]
1472 in TcBinds.
1473
1474 There are some wrinkles
1475
1476 * We always want to kind-generalise over SigTvs, and /not/ default
1477 them to Type. Another way to say this is: a SigTV should /never/
1478 stand for a type, even via defaulting. Hence the check in
1479 TcSimplify.defaultTyVarTcS, and TcMType.defaultTyVar. Here's
1480 another example (Trac #14555):
1481 data Exp :: [TYPE rep] -> TYPE rep -> Type where
1482 Lam :: Exp (a:xs) b -> Exp xs (a -> b)
1483 We want to kind-generalise over the 'rep' variable.
1484 Trac #14563 is another example.
1485
1486 * Consider Trac #11203
1487 data SameKind :: k -> k -> *
1488 data Q (a :: k1) (b :: k2) c = MkQ (SameKind a b)
1489 Here we will unify k1 with k2, but this time doing so is an error,
1490 because k1 and k2 are bound in the same delcaration.
1491
1492 We sort this out using findDupSigTvs, in TcTyClTyVars; very much
1493 as we do with partial type signatures in mk_psig_qtvs in
1494 TcBinds.chooseInferredQuantifiers
1495
1496 Note [Keeping scoped variables in order: Explicit]
1497 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1498 When the user writes `forall a b c. blah`, we bring a, b, and c into
1499 scope and then check blah. In the process of checking blah, we might
1500 learn the kinds of a, b, and c, and these kinds might indicate that
1501 b depends on c, and thus that we should reject the user-written type.
1502
1503 One approach to doing this would be to bring each of a, b, and c into
1504 scope, one at a time, creating an implication constraint and
1505 bumping the TcLevel for each one. This would work, because the kind
1506 of, say, b would be untouchable when c is in scope (and the constraint
1507 couldn't float out because c blocks it). However, it leads to terrible
1508 error messages, complaining about skolem escape. While it is indeed
1509 a problem of skolem escape, we can do better.
1510
1511 Instead, our approach is to bring the block of variables into scope
1512 all at once, creating one implication constraint for the lot. The
1513 user-written variables are skolems in the implication constraint. In
1514 TcSimplify.setImplicationStatus, we check to make sure that the ordering
1515 is correct, choosing ImplicationStatus IC_BadTelescope if they aren't.
1516 Then, in TcErrors, we report if there is a bad telescope. This way,
1517 we can report a suggested ordering to the user if there is a problem.
1518
1519 Note [Keeping scoped variables in order: Implicit]
1520 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1521 When the user implicitly quantifies over variables (say, in a type
1522 signature), we need to come up with some ordering on these variables.
1523 This is done by bumping the TcLevel, bringing the tyvars into scope,
1524 and then type-checking the thing_inside. The constraints are all
1525 wrapped in an implication, which is then solved. Finally, we can
1526 zonk all the binders and then order them with toposortTyVars.
1527
1528 It's critical to solve before zonking and ordering in order to uncover
1529 any unifications. You might worry that this eager solving could cause
1530 trouble elsewhere. I don't think it will. Because it will solve only
1531 in an increased TcLevel, it can't unify anything that was mentioned
1532 elsewhere. Additionally, we require that the order of implicitly
1533 quantified variables is manifest by the scope of these variables, so
1534 we're not going to learn more information later that will help order
1535 these variables.
1536
1537 Note [Recipe for checking a signature]
1538 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1539 Checking a user-written signature requires several steps:
1540
1541 1. Generate constraints.
1542 2. Solve constraints.
1543 3. Zonk and promote tyvars.
1544 4. (Optional) Kind-generalize.
1545 5. Check validity.
1546
1547 There may be some surprises in here:
1548
1549 Step 2 is necessary for two reasons: most signatures also bring
1550 implicitly quantified variables into scope, and solving is necessary
1551 to get these in the right order (see Note [Keeping scoped variables in
1552 order: Implicit]). Additionally, solving is necessary in order to
1553 kind-generalize correctly.
1554
1555 Step 3 requires *promoting* type variables. If there are any foralls
1556 in a type, the TcLevel will be bumped within the forall. This might
1557 lead to the generation of matavars with a high level. If we don't promote,
1558 we violate MetaTvInv of Note [TcLevel and untouchable type variables]
1559 in TcType.
1560
1561 -}
1562
1563 tcWildCardBinders :: SkolemInfo
1564 -> [Name]
1565 -> ([(Name, TcTyVar)] -> TcM a)
1566 -> TcM a
1567 tcWildCardBinders info = tcWildCardBindersX new_tv (Just info)
1568 where
1569 new_tv name = do { kind <- newMetaKindVar
1570 ; newSkolemTyVar name kind }
1571
1572 tcWildCardBindersX :: (Name -> TcM TcTyVar)
1573 -> Maybe SkolemInfo -- Just <=> we're bringing fresh vars
1574 -- into scope; use scopeTyVars
1575 -> [Name]
1576 -> ([(Name, TcTyVar)] -> TcM a)
1577 -> TcM a
1578 tcWildCardBindersX new_wc maybe_skol_info wc_names thing_inside
1579 = do { wcs <- mapM new_wc wc_names
1580 ; let wc_prs = wc_names `zip` wcs
1581 ; scope_tvs wc_prs $
1582 thing_inside wc_prs }
1583 where
1584 scope_tvs
1585 | Just info <- maybe_skol_info = scopeTyVars2 info
1586 | otherwise = tcExtendNameTyVarEnv
1587
1588 -- | Kind-check a 'LHsQTyVars'. If the decl under consideration has a complete,
1589 -- user-supplied kind signature (CUSK), generalise the result.
1590 -- Used in 'getInitialKind' (for tycon kinds and other kinds)
1591 -- and in kind-checking (but not for tycon kinds, which are checked with
1592 -- tcTyClDecls). See also Note [Complete user-supplied kind signatures] in
1593 -- HsDecls.
1594 --
1595 -- This function does not do telescope checking.
1596 kcLHsQTyVars :: Name -- ^ of the thing being checked
1597 -> TyConFlavour -- ^ What sort of 'TyCon' is being checked
1598 -> Bool -- ^ True <=> the decl being checked has a CUSK
1599 -> LHsQTyVars GhcRn
1600 -> TcM (Kind, r) -- ^ The result kind, possibly with other info
1601 -> TcM (TcTyCon, r) -- ^ A suitably-kinded TcTyCon
1602 kcLHsQTyVars name flav cusk
1603 user_tyvars@(HsQTvs { hsq_ext = HsQTvsRn { hsq_implicit = kv_ns
1604 , hsq_dependent = dep_names }
1605 , hsq_explicit = hs_tvs }) thing_inside
1606 | cusk
1607 = do { (scoped_kvs, (tc_tvs, (res_kind, stuff)))
1608 <- solveEqualities $
1609 tcImplicitTKBndrsX newSkolemTyVar skol_info kv_ns $
1610 kcLHsTyVarBndrs cusk open_fam skol_info hs_tvs thing_inside
1611
1612 -- Now, because we're in a CUSK, quantify over the mentioned
1613 -- kind vars, in dependency order.
1614 ; let tc_binders_unzonked = zipWith mk_tc_binder hs_tvs tc_tvs
1615 ; dvs <- zonkTcTypeAndSplitDepVars (mkSpecForAllTys scoped_kvs $
1616 mkTyConKind tc_binders_unzonked res_kind)
1617 ; qkvs <- quantifyTyVars emptyVarSet dvs
1618 -- don't call tcGetGlobalTyCoVars. For associated types, it gets the
1619 -- tyvars from the enclosing class -- but that's wrong. We *do* want
1620 -- to quantify over those tyvars.
1621
1622 ; scoped_kvs <- mapM zonkTcTyVarToTyVar scoped_kvs
1623 ; tc_tvs <- mapM zonkTcTyVarToTyVar tc_tvs
1624 ; res_kind <- zonkTcType res_kind
1625 ; let tc_binders = zipWith mk_tc_binder hs_tvs tc_tvs
1626
1627 -- If any of the scoped_kvs aren't actually mentioned in a binder's
1628 -- kind (or the return kind), then we're in the CUSK case from
1629 -- Note [Free-floating kind vars]
1630 ; let all_tc_tvs = scoped_kvs ++ tc_tvs
1631 all_mentioned_tvs = mapUnionVarSet (tyCoVarsOfType . tyVarKind)
1632 all_tc_tvs
1633 `unionVarSet` tyCoVarsOfType res_kind
1634 unmentioned_kvs = filterOut (`elemVarSet` all_mentioned_tvs)
1635 scoped_kvs
1636 ; reportFloatingKvs name flav all_tc_tvs unmentioned_kvs
1637
1638 ; let final_binders = map (mkNamedTyConBinder Inferred) qkvs
1639 ++ map (mkNamedTyConBinder Specified) scoped_kvs
1640 ++ tc_binders
1641 tycon = mkTcTyCon name (ppr user_tyvars) final_binders res_kind
1642 (mkTyVarNamePairs (scoped_kvs ++ tc_tvs))
1643 flav
1644 -- the tvs contain the binders already
1645 -- in scope from an enclosing class, but
1646 -- re-adding tvs to the env't doesn't cause
1647 -- harm
1648
1649 ; traceTc "kcLHsQTyVars: cusk" $
1650 vcat [ ppr name, ppr kv_ns, ppr hs_tvs, ppr dep_names
1651 , ppr tc_tvs, ppr (mkTyConKind final_binders res_kind)
1652 , ppr qkvs, ppr final_binders ]
1653
1654 ; return (tycon, stuff) }
1655
1656 | otherwise
1657 = do { (scoped_kvs, (tc_tvs, (res_kind, stuff)))
1658 -- Why kcImplicitTKBndrs which uses newSigTyVar?
1659 -- See Note [Kind generalisation and sigTvs]
1660 <- kcImplicitTKBndrs kv_ns $
1661 kcLHsTyVarBndrs cusk open_fam skol_info hs_tvs thing_inside
1662
1663 ; let -- NB: Don't add scoped_kvs to tyConTyVars, because they
1664 -- must remain lined up with the binders
1665 tc_binders = zipWith mk_tc_binder hs_tvs tc_tvs
1666 tycon = mkTcTyCon name (ppr user_tyvars) tc_binders res_kind
1667 (mkTyVarNamePairs (scoped_kvs ++ tc_tvs))
1668 flav
1669
1670 ; traceTc "kcLHsQTyVars: not-cusk" $
1671 vcat [ ppr name, ppr kv_ns, ppr hs_tvs, ppr dep_names
1672 , ppr tc_tvs, ppr (mkTyConKind tc_binders res_kind) ]
1673 ; return (tycon, stuff) }
1674 where
1675 open_fam = tcFlavourIsOpen flav
1676 skol_info = TyConSkol flav name
1677
1678 mk_tc_binder :: LHsTyVarBndr GhcRn -> TyVar -> TyConBinder
1679 -- See Note [Dependent LHsQTyVars]
1680 mk_tc_binder hs_tv tv
1681 | hsLTyVarName hs_tv `elemNameSet` dep_names
1682 = mkNamedTyConBinder Required tv
1683 | otherwise
1684 = mkAnonTyConBinder tv
1685
1686 kcLHsQTyVars _ _ _ (XLHsQTyVars _) _ = panic "kcLHsQTyVars"
1687
1688 kcLHsTyVarBndrs :: Bool -- True <=> bump the TcLevel when bringing vars into scope
1689 -> Bool -- True <=> Default un-annotated tyvar
1690 -- binders to kind *
1691 -> SkolemInfo
1692 -> [LHsTyVarBndr GhcRn]
1693 -> TcM r
1694 -> TcM ([TyVar], r)
1695 -- There may be dependency between the explicit "ty" vars.
1696 -- So, we have to handle them one at a time.
1697 kcLHsTyVarBndrs _ _ _ [] thing
1698 = do { stuff <- thing; return ([], stuff) }
1699
1700 kcLHsTyVarBndrs cusk open_fam skol_info (L _ hs_tv : hs_tvs) thing
1701 = do { tv_pair@(tv, _) <- kc_hs_tv hs_tv
1702 -- NB: Bring all tvs into scope, even non-dependent ones,
1703 -- as they're needed in type synonyms, data constructors, etc.
1704
1705 ; (tvs, stuff) <- bind_unless_scoped tv_pair $
1706 kcLHsTyVarBndrs cusk open_fam skol_info hs_tvs $
1707 thing
1708
1709 ; return ( tv : tvs, stuff ) }
1710 where
1711 -- | Bind the tyvar in the env't unless the bool is True
1712 bind_unless_scoped :: (TcTyVar, Bool) -> TcM a -> TcM a
1713 bind_unless_scoped (_, True) thing_inside = thing_inside
1714 bind_unless_scoped (tv, False) thing_inside
1715 | cusk = scopeTyVars skol_info [tv] thing_inside
1716 | otherwise = tcExtendTyVarEnv [tv] thing_inside
1717 -- These variables haven't settled down yet, so we don't want to bump
1718 -- the TcLevel. If we do, then we'll have metavars of too high a level
1719 -- floating about. Changing this causes many, many failures in the
1720 -- `dependent` testsuite directory.
1721
1722 kc_hs_tv :: HsTyVarBndr GhcRn -> TcM (TcTyVar, Bool)
1723 kc_hs_tv (UserTyVar _ lname@(L _ name))
1724 = do { tv_pair@(tv, in_scope) <- tcHsTyVarName newSkolemTyVar Nothing name
1725
1726 -- Open type/data families default their variables to kind *.
1727 -- But don't default in-scope class tyvars, of course
1728 ; when (open_fam && not in_scope) $
1729 discardResult $ unifyKind (Just (HsTyVar noExt NotPromoted lname))
1730 liftedTypeKind (tyVarKind tv)
1731
1732 ; return tv_pair }
1733
1734 kc_hs_tv (KindedTyVar _ (L _ name) lhs_kind)
1735 = do { kind <- tcLHsKindSig (TyVarBndrKindCtxt name) lhs_kind
1736 ; tcHsTyVarName newSkolemTyVar (Just kind) name }
1737
1738 kc_hs_tv (XTyVarBndr{}) = panic "kc_hs_tv"
1739
1740 tcImplicitTKBndrs :: SkolemInfo
1741 -> [Name]
1742 -> TcM a
1743 -> TcM ([TcTyVar], a)
1744 tcImplicitTKBndrs = tcImplicitTKBndrsX newSkolemTyVar
1745
1746 -- | Like 'tcImplicitTKBndrs', but uses 'newSigTyVar' to create tyvars
1747 tcImplicitTKBndrsSig :: SkolemInfo
1748 -> [Name]
1749 -> TcM a
1750 -> TcM ([TcTyVar], a)
1751 tcImplicitTKBndrsSig = tcImplicitTKBndrsX newSigTyVar
1752
1753 tcImplicitTKBndrsX :: (Name -> Kind -> TcM TcTyVar) -- new_tv function
1754 -> SkolemInfo
1755 -> [Name]
1756 -> TcM a
1757 -> TcM ([TcTyVar], a) -- these tyvars are dependency-ordered
1758 -- * Guarantees to call solveLocalEqualities to unify
1759 -- all constraints from thing_inside.
1760 --
1761 -- * Returned TcTyVars have the supplied HsTyVarBndrs,
1762 -- but may be in different order to the original [Name]
1763 -- (because of sorting to respect dependency)
1764 --
1765 -- * Returned TcTyVars have zonked kinds
1766 -- See Note [Keeping scoped variables in order: Implicit]
1767 tcImplicitTKBndrsX new_tv skol_info tv_names thing_inside
1768 | null tv_names -- Short cut for the common case where there
1769 -- are no implicit type variables to bind
1770 = do { result <- solveLocalEqualities thing_inside
1771 ; return ([], result) }
1772
1773 | otherwise
1774 = do { (skol_tvs, result)
1775 <- solveLocalEqualities $
1776 checkTvConstraints skol_info Nothing $
1777 do { tv_pairs <- mapM (tcHsTyVarName new_tv Nothing) tv_names
1778 ; let must_scope_tvs = [ tv | (tv, False) <- tv_pairs ]
1779 ; result <- tcExtendTyVarEnv must_scope_tvs $
1780 thing_inside
1781 ; return (map fst tv_pairs, result) }
1782
1783
1784 ; skol_tvs <- mapM zonkTcTyCoVarBndr skol_tvs
1785 -- use zonkTcTyCoVarBndr because a skol_tv might be a SigTv
1786
1787 ; let final_tvs = toposortTyVars skol_tvs
1788 ; traceTc "tcImplicitTKBndrs" (ppr tv_names $$ ppr final_tvs)
1789 ; return (final_tvs, result) }
1790
1791 -- | Bring implicitly quantified type/kind variables into scope during
1792 -- kind checking. Uses SigTvs, as per Note [Use SigTvs in kind-checking pass]
1793 -- in TcTyClsDecls.
1794 kcImplicitTKBndrs :: [Name] -- of the vars
1795 -> TcM a
1796 -> TcM ([TcTyVar], a) -- returns the tyvars created
1797 -- these are *not* dependency ordered
1798 kcImplicitTKBndrs var_ns thing_inside
1799 = do { tkvs_pairs <- mapM (tcHsTyVarName newSigTyVar Nothing) var_ns
1800 ; let must_scope_tkvs = [ tkv | (tkv, False) <- tkvs_pairs ]
1801 ; result <- tcExtendTyVarEnv must_scope_tkvs $
1802 thing_inside
1803 ; return (map fst tkvs_pairs, result) }
1804
1805 tcExplicitTKBndrs :: SkolemInfo
1806 -> [LHsTyVarBndr GhcRn]
1807 -> TcM a
1808 -> TcM ([TcTyVar], a)
1809 -- See also Note [Associated type tyvar names] in Class
1810 tcExplicitTKBndrs skol_info hs_tvs thing_inside
1811 -- This function brings into scope a telescope of binders as written by
1812 -- the user. At first blush, it would then seem that we should bring
1813 -- them into scope one at a time, bumping the TcLevel each time.
1814 -- (Recall that we bump the level to prevent skolem escape from happening.)
1815 -- However, this leads to terrible error messages, because we end up
1816 -- failing to unify with some `k0`. Better would be to allow type inference
1817 -- to work, potentially creating a skolem-escape problem, and then to
1818 -- notice that the telescope is out of order. That's what we do here,
1819 -- following the logic of tcImplicitTKBndrsX.
1820 -- See also Note [Keeping scoped variables in order: Explicit]
1821 --
1822 -- No cloning: returned TyVars have the same Name as the incoming LHsTyVarBndrs
1823 | null hs_tvs -- Short cut that avoids creating an implication
1824 -- constraint in the common case where none is needed
1825 = do { result <- thing_inside
1826 ; return ([], result) }
1827
1828 | otherwise
1829 = do { (skol_tvs, result) <- checkTvConstraints skol_info (Just doc) $
1830 bind_tvbs hs_tvs
1831
1832 ; traceTc "tcExplicitTKBndrs" $
1833 vcat [ text "Hs vars:" <+> ppr hs_tvs
1834 , text "tvs:" <+> pprTyVars skol_tvs ]
1835
1836 ; return (skol_tvs, result) }
1837
1838 where
1839 bind_tvbs [] = do { result <- thing_inside
1840 ; return ([], result) }
1841 bind_tvbs (L _ tvb : tvbs)
1842 = do { (tv, in_scope) <- tcHsTyVarBndr newSkolemTyVar tvb
1843 ; (if in_scope then id else tcExtendTyVarEnv [tv]) $
1844 do { (tvs, result) <- bind_tvbs tvbs
1845 ; return (tv : tvs, result) }}
1846
1847 doc = sep (map ppr hs_tvs)
1848
1849 -- | Used during the "kind-checking" pass in TcTyClsDecls only.
1850 -- See Note [Use SigTvs in kind-checking pass] in TcTyClsDecls
1851 kcExplicitTKBndrs :: [LHsTyVarBndr GhcRn]
1852 -> TcM a
1853 -> TcM a
1854 kcExplicitTKBndrs [] thing_inside = thing_inside
1855 kcExplicitTKBndrs (L _ hs_tv : hs_tvs) thing_inside
1856 = do { (tv, _) <- tcHsTyVarBndr newSigTyVar hs_tv
1857 ; tcExtendTyVarEnv [tv] $
1858 kcExplicitTKBndrs hs_tvs thing_inside }
1859
1860 tcHsTyVarBndr :: (Name -> Kind -> TcM TyVar)
1861 -> HsTyVarBndr GhcRn -> TcM (TcTyVar, Bool)
1862 -- Return a TcTyVar, built using the provided function
1863 -- Typically the Kind inside the HsTyVarBndr will be a tyvar
1864 -- with a mutable kind in it.
1865 --
1866 -- These variables might be in scope already (with associated types, for example).
1867 -- This function then checks that the kind annotation (if any) matches the
1868 -- kind of the in-scope type variable.
1869 --
1870 -- Returned TcTyVar has the same name; no cloning
1871 --
1872 -- See also Note [Associated type tyvar names] in Class
1873 --
1874 -- Returns True iff the tyvar was already in scope
1875 tcHsTyVarBndr new_tv (UserTyVar _ (L _ tv_nm))
1876 = tcHsTyVarName new_tv Nothing tv_nm
1877 tcHsTyVarBndr new_tv (KindedTyVar _ (L _ tv_nm) lhs_kind)
1878 = do { kind <- tcLHsKindSig (TyVarBndrKindCtxt tv_nm) lhs_kind
1879 ; tcHsTyVarName new_tv (Just kind) tv_nm }
1880 tcHsTyVarBndr _ (XTyVarBndr _) = panic "tcHsTyVarBndr"
1881
1882 newWildTyVar :: Name -> TcM TcTyVar
1883 -- ^ New unification variable for a wildcard
1884 newWildTyVar _name
1885 = do { kind <- newMetaKindVar
1886 ; uniq <- newUnique
1887 ; details <- newMetaDetails TauTv
1888 ; let name = mkSysTvName uniq (fsLit "w")
1889 tyvar = (mkTcTyVar name kind details)
1890 ; traceTc "newWildTyVar" (ppr tyvar)
1891 ; return tyvar }
1892
1893 -- | Produce a tyvar of the given name (with the kind provided, or
1894 -- otherwise a meta-var kind). If
1895 -- the name is already in scope, return the scoped variable, checking
1896 -- to make sure the known kind matches any kind provided. The
1897 -- second return value says whether the variable is in scope (True)
1898 -- or not (False). (Use this for associated types, for example.)
1899 tcHsTyVarName :: (Name -> Kind -> TcM TcTyVar) -- new_tv function
1900 -> Maybe Kind -- Just k <=> use k as the variable's kind
1901 -- Nothing <=> use a meta-tyvar
1902 -> Name -> TcM (TcTyVar, Bool)
1903 tcHsTyVarName new_tv m_kind name
1904 = do { mb_tv <- tcLookupLcl_maybe name
1905 ; case mb_tv of
1906 Just (ATyVar _ tv)
1907 -> do { whenIsJust m_kind $ \ kind ->
1908 discardResult $
1909 unifyKind (Just (HsTyVar noExt NotPromoted (noLoc name)))
1910 kind (tyVarKind tv)
1911 ; return (tv, True) }
1912 _ -> do { kind <- case m_kind of
1913 Just kind -> return kind
1914 Nothing -> newMetaKindVar
1915 ; tv <- new_tv name kind
1916 ; return (tv, False) }}
1917
1918 --------------------------
1919 -- Bringing tyvars into scope
1920 --------------------------
1921
1922 -- | Bring tyvars into scope, wrapping the thing_inside in an implication
1923 -- constraint. The implication constraint is necessary to provide SkolemInfo
1924 -- for the tyvars and to ensure that no unification variables made outside
1925 -- the scope of these tyvars (i.e. lower TcLevel) unify with the locally-scoped
1926 -- tyvars (i.e. higher TcLevel).
1927 --
1928 -- INVARIANT: The thing_inside must check only types, never terms.
1929 --
1930 -- Use this (not tcExtendTyVarEnv) wherever you expect a Λ or ∀ in Core.
1931 -- Use tcExtendTyVarEnv otherwise.
1932 scopeTyVars :: SkolemInfo -> [TcTyVar] -> TcM a -> TcM a
1933 scopeTyVars skol_info tvs = scopeTyVars2 skol_info [(tyVarName tv, tv) | tv <- tvs]
1934
1935 -- | Like 'scopeTyVars', but allows you to specify different scoped names
1936 -- than the Names stored within the tyvars.
1937 scopeTyVars2 :: SkolemInfo -> [(Name, TcTyVar)] -> TcM a -> TcM a
1938 scopeTyVars2 skol_info prs thing_inside
1939 = fmap snd $ -- discard the TcEvBinds, which will always be empty
1940 checkConstraints skol_info (map snd prs) [{- no EvVars -}] $
1941 tcExtendNameTyVarEnv prs $
1942 thing_inside
1943
1944 ------------------
1945 kindGeneralize :: TcType -> TcM [KindVar]
1946 -- Quantify the free kind variables of a kind or type
1947 -- In the latter case the type is closed, so it has no free
1948 -- type variables. So in both cases, all the free vars are kind vars
1949 -- Input must be zonked.
1950 -- NB: You must call solveEqualities or solveLocalEqualities before
1951 -- kind generalization
1952 kindGeneralize kind_or_type
1953 = do { let kvs = tyCoVarsOfTypeDSet kind_or_type
1954 dvs = DV { dv_kvs = kvs, dv_tvs = emptyDVarSet }
1955 ; gbl_tvs <- tcGetGlobalTyCoVars -- Already zonked
1956 ; quantifyTyVars gbl_tvs dvs }
1957
1958 {-
1959 Note [Kind generalisation]
1960 ~~~~~~~~~~~~~~~~~~~~~~~~~~
1961 We do kind generalisation only at the outer level of a type signature.
1962 For example, consider
1963 T :: forall k. k -> *
1964 f :: (forall a. T a -> Int) -> Int
1965 When kind-checking f's type signature we generalise the kind at
1966 the outermost level, thus:
1967 f1 :: forall k. (forall (a:k). T k a -> Int) -> Int -- YES!
1968 and *not* at the inner forall:
1969 f2 :: (forall k. forall (a:k). T k a -> Int) -> Int -- NO!
1970 Reason: same as for HM inference on value level declarations,
1971 we want to infer the most general type. The f2 type signature
1972 would be *less applicable* than f1, because it requires a more
1973 polymorphic argument.
1974
1975 NB: There are no explicit kind variables written in f's signature.
1976 When there are, the renamer adds these kind variables to the list of
1977 variables bound by the forall, so you can indeed have a type that's
1978 higher-rank in its kind. But only by explicit request.
1979
1980 Note [Kinds of quantified type variables]
1981 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1982 tcTyVarBndrsGen quantifies over a specified list of type variables,
1983 *and* over the kind variables mentioned in the kinds of those tyvars.
1984
1985 Note that we must zonk those kinds (obviously) but less obviously, we
1986 must return type variables whose kinds are zonked too. Example
1987 (a :: k7) where k7 := k9 -> k9
1988 We must return
1989 [k9, a:k9->k9]
1990 and NOT
1991 [k9, a:k7]
1992 Reason: we're going to turn this into a for-all type,
1993 forall k9. forall (a:k7). blah
1994 which the type checker will then instantiate, and instantiate does not
1995 look through unification variables!
1996
1997 Hence using zonked_kinds when forming tvs'.
1998
1999 Note [Free-floating kind vars]
2000 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2001 Consider
2002
2003 data T = MkT (forall (a :: k). Proxy a)
2004 -- from test ghci/scripts/T7873
2005
2006 This is not an existential datatype, but a higher-rank one (the forall
2007 to the right of MkT). Also consider
2008
2009 data S a = MkS (Proxy (a :: k))
2010
2011 According to the rules around implicitly-bound kind variables, in both
2012 cases those k's scope over the whole declaration. The renamer grabs
2013 it and adds it to the hsq_implicits field of the HsQTyVars of the
2014 tycon. So it must be in scope during type-checking, but we want to
2015 reject T while accepting S.
2016
2017 Why reject T? Because the kind variable isn't fixed by anything. For
2018 a variable like k to be implicit, it needs to be mentioned in the kind
2019 of a tycon tyvar. But it isn't.
2020
2021 Why accept S? Because kind inference tells us that a has kind k, so it's
2022 all OK.
2023
2024 Our approach depends on whether or not the datatype has a CUSK.
2025
2026 Non-CUSK: In the first pass (kcTyClTyVars) we just bring
2027 k into scope. In the second pass (tcTyClTyVars),
2028 we check to make sure that k has been unified with some other variable
2029 (or generalized over, making k into a skolem). If it hasn't been, then
2030 it must be a free-floating kind var. Error.
2031
2032 CUSK: When we determine the tycon's final, never-to-be-changed kind
2033 in kcLHsQTyVars, we check to make sure all implicitly-bound kind
2034 vars are indeed mentioned in a kind somewhere. If not, error.
2035
2036 We also perform free-floating kind var analysis for type family instances
2037 (see #13985). Here is an interesting example:
2038
2039 type family T :: k
2040 type instance T = (Nothing :: Maybe a)
2041
2042 Upon a cursory glance, it may appear that the kind variable `a` is
2043 free-floating above, since there are no (visible) LHS patterns in `T`. However,
2044 there is an *invisible* pattern due to the return kind, so inside of GHC, the
2045 instance looks closer to this:
2046
2047 type family T @k :: k
2048 type instance T @(Maybe a) = (Nothing :: Maybe a)
2049
2050 Here, we can see that `a` really is bound by a LHS type pattern, so `a` is in
2051 fact not free-floating. Contrast that with this example:
2052
2053 type instance T = Proxy (Nothing :: Maybe a)
2054
2055 This would looks like this inside of GHC:
2056
2057 type instance T @(*) = Proxy (Nothing :: Maybe a)
2058
2059 So this time, `a` is neither bound by a visible nor invisible type pattern on
2060 the LHS, so it would be reported as free-floating.
2061
2062 Finally, here's one more brain-teaser (from #9574). In the example below:
2063
2064 class Funct f where
2065 type Codomain f :: *
2066 instance Funct ('KProxy :: KProxy o) where
2067 type Codomain 'KProxy = NatTr (Proxy :: o -> *)
2068
2069 As it turns out, `o` is not free-floating in this example. That is because `o`
2070 bound by the kind signature of the LHS type pattern 'KProxy. To make this more
2071 obvious, one can also write the instance like so:
2072
2073 instance Funct ('KProxy :: KProxy o) where
2074 type Codomain ('KProxy :: KProxy o) = NatTr (Proxy :: o -> *)
2075
2076 -}
2077
2078 --------------------
2079 -- getInitialKind has made a suitably-shaped kind for the type or class
2080 -- Look it up in the local environment. This is used only for tycons
2081 -- that we're currently type-checking, so we're sure to find a TcTyCon.
2082 kcLookupTcTyCon :: Name -> TcM TcTyCon
2083 kcLookupTcTyCon nm
2084 = do { tc_ty_thing <- tcLookup nm
2085 ; return $ case tc_ty_thing of
2086 ATcTyCon tc -> tc
2087 _ -> pprPanic "kcLookupTcTyCon" (ppr tc_ty_thing) }
2088
2089 -----------------------
2090 -- | Bring tycon tyvars into scope. This is used during the "kind-checking"
2091 -- pass in TcTyClsDecls. (Never in getInitialKind, never in the
2092 -- "type-checking"/desugaring pass.)
2093 -- Never emits constraints, though the thing_inside might.
2094 kcTyClTyVars :: Name -> TcM a -> TcM a
2095 kcTyClTyVars tycon_name thing_inside
2096 -- See Note [Use SigTvs in kind-checking pass] in TcTyClsDecls
2097 = do { tycon <- kcLookupTcTyCon tycon_name
2098 ; tcExtendNameTyVarEnv (tcTyConScopedTyVars tycon) $ thing_inside }
2099
2100 tcTyClTyVars :: Name
2101 -> ([TyConBinder] -> Kind -> TcM a) -> TcM a
2102 -- ^ Used for the type variables of a type or class decl
2103 -- on the second full pass (type-checking/desugaring) in TcTyClDecls.
2104 -- This is *not* used in the initial-kind run, nor in the "kind-checking" pass.
2105 -- Accordingly, everything passed to the continuation is fully zonked.
2106 --
2107 -- (tcTyClTyVars T [a,b] thing_inside)
2108 -- where T : forall k1 k2 (a:k1 -> *) (b:k1). k2 -> *
2109 -- calls thing_inside with arguments
2110 -- [k1,k2,a,b] [k1:*, k2:*, Anon (k1 -> *), Anon k1] (k2 -> *)
2111 -- having also extended the type environment with bindings
2112 -- for k1,k2,a,b
2113 --
2114 -- Never emits constraints.
2115 --
2116 -- The LHsTyVarBndrs is always user-written, and the full, generalised
2117 -- kind of the tycon is available in the local env.
2118 tcTyClTyVars tycon_name thing_inside
2119 = do { tycon <- kcLookupTcTyCon tycon_name
2120
2121 -- Do checks on scoped tyvars
2122 -- See Note [Free-floating kind vars]
2123 ; let flav = tyConFlavour tycon
2124 scoped_prs = tcTyConScopedTyVars tycon
2125 scoped_tvs = map snd scoped_prs
2126 still_sig_tvs = filter isSigTyVar scoped_tvs
2127
2128 ; mapM_ report_sig_tv_err (findDupSigTvs scoped_prs)
2129
2130 ; checkNoErrs $ reportFloatingKvs tycon_name flav
2131 scoped_tvs still_sig_tvs
2132
2133 ; let res_kind = tyConResKind tycon
2134 binders = correct_binders (tyConBinders tycon) res_kind
2135 ; traceTc "tcTyClTyVars" (ppr tycon_name <+> ppr binders)
2136 ; scopeTyVars2 (TyConSkol flav tycon_name) scoped_prs $
2137 thing_inside binders res_kind }
2138 where
2139 report_sig_tv_err (n1, n2)
2140 = setSrcSpan (getSrcSpan n2) $
2141 addErrTc (text "Couldn't match" <+> quotes (ppr n1)
2142 <+> text "with" <+> quotes (ppr n2))
2143
2144 -- Given some TyConBinders and a TyCon's result kind, make sure that the
2145 -- correct any wrong Named/Anon choices. For example, consider
2146 -- type Syn k = forall (a :: k). Proxy a
2147 -- At first, it looks like k should be named -- after all, it appears on the RHS.
2148 -- However, the correct kind for Syn is (* -> *).
2149 -- (Why? Because k is the kind of a type, so k's kind is *. And the RHS also has
2150 -- kind *.) See also #13963.
2151 correct_binders :: [TyConBinder] -> Kind -> [TyConBinder]
2152 correct_binders binders kind
2153 = binders'
2154 where
2155 (_, binders') = mapAccumR go (tyCoVarsOfType kind) binders
2156
2157 go :: TyCoVarSet -> TyConBinder -> (TyCoVarSet, TyConBinder)
2158 go fvs binder
2159 | isNamedTyConBinder binder
2160 , not (tv `elemVarSet` fvs)
2161 = (new_fvs, mkAnonTyConBinder tv)
2162
2163 | not (isNamedTyConBinder binder)
2164 , tv `elemVarSet` fvs
2165 = (new_fvs, mkNamedTyConBinder Required tv)
2166 -- always Required, because it was anonymous (i.e. visible) previously
2167
2168 | otherwise
2169 = (new_fvs, binder)
2170
2171 where
2172 tv = binderVar binder
2173 new_fvs = fvs `delVarSet` tv `unionVarSet` tyCoVarsOfType (tyVarKind tv)
2174
2175 -----------------------------------
2176 tcDataKindSig :: [TyConBinder]
2177 -> Kind
2178 -> TcM ([TyConBinder], Kind)
2179 -- GADT decls can have a (perhaps partial) kind signature
2180 -- e.g. data T a :: * -> * -> * where ...
2181 -- This function makes up suitable (kinded) TyConBinders for the
2182 -- argument kinds. E.g. in this case it might return
2183 -- ([b::*, c::*], *)
2184 -- Never emits constraints.
2185 -- It's a little trickier than you might think: see
2186 -- Note [TyConBinders for the result kind signature of a data type]
2187 tcDataKindSig tc_bndrs kind
2188 = do { loc <- getSrcSpanM
2189 ; uniqs <- newUniqueSupply
2190 ; rdr_env <- getLocalRdrEnv
2191 ; let new_occs = [ occ
2192 | str <- allNameStrings
2193 , let occ = mkOccName tvName str
2194 , isNothing (lookupLocalRdrOcc rdr_env occ)
2195 -- Note [Avoid name clashes for associated data types]
2196 , not (occ `elem` lhs_occs) ]
2197 new_uniqs = uniqsFromSupply uniqs
2198 subst = mkEmptyTCvSubst (mkInScopeSet (mkVarSet lhs_tvs))
2199 ; return (go loc new_occs new_uniqs subst [] kind) }
2200 where
2201 lhs_tvs = map binderVar tc_bndrs
2202 lhs_occs = map getOccName lhs_tvs
2203
2204 go loc occs uniqs subst acc kind
2205 = case splitPiTy_maybe kind of
2206 Nothing -> (reverse acc, substTy subst kind)
2207
2208 Just (Anon arg, kind')
2209 -> go loc occs' uniqs' subst' (tcb : acc) kind'
2210 where
2211 arg' = substTy subst arg
2212 tv = mkTyVar (mkInternalName uniq occ loc) arg'
2213 subst' = extendTCvInScope subst tv
2214 tcb = TvBndr tv AnonTCB
2215 (uniq:uniqs') = uniqs
2216 (occ:occs') = occs
2217
2218 Just (Named (TvBndr tv vis), kind')
2219 -> go loc occs uniqs subst' (tcb : acc) kind'
2220 where
2221 (subst', tv') = substTyVarBndr subst tv
2222 tcb = TvBndr tv' (NamedTCB vis)
2223
2224 badKindSig :: Bool -> Kind -> SDoc
2225 badKindSig check_for_type kind
2226 = hang (sep [ text "Kind signature on data type declaration has non-*"
2227 , (if check_for_type then empty else text "and non-variable") <+>
2228 text "return kind" ])
2229 2 (ppr kind)
2230
2231 {- Note [TyConBinders for the result kind signature of a data type]
2232 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2233 Given
2234 data T (a::*) :: * -> forall k. k -> *
2235 we want to generate the extra TyConBinders for T, so we finally get
2236 (a::*) (b::*) (k::*) (c::k)
2237 The function tcDataKindSig generates these extra TyConBinders from
2238 the result kind signature.
2239
2240 We need to take care to give the TyConBinders
2241 (a) OccNames that are fresh (because the TyConBinders of a TyCon
2242 must have distinct OccNames
2243
2244 (b) Uniques that are fresh (obviously)
2245
2246 For (a) we need to avoid clashes with the tyvars declared by
2247 the user before the "::"; in the above example that is 'a'.
2248 And also see Note [Avoid name clashes for associated data types].
2249
2250 For (b) suppose we have
2251 data T :: forall k. k -> forall k. k -> *
2252 where the two k's are identical even up to their uniques. Surprisingly,
2253 this can happen: see Trac #14515.
2254
2255 It's reasonably easy to solve all this; just run down the list with a
2256 substitution; hence the recursive 'go' function. But it has to be
2257 done.
2258
2259 Note [Avoid name clashes for associated data types]
2260 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2261 Consider class C a b where
2262 data D b :: * -> *
2263 When typechecking the decl for D, we'll invent an extra type variable
2264 for D, to fill out its kind. Ideally we don't want this type variable
2265 to be 'a', because when pretty printing we'll get
2266 class C a b where
2267 data D b a0
2268 (NB: the tidying happens in the conversion to IfaceSyn, which happens
2269 as part of pretty-printing a TyThing.)
2270
2271 That's why we look in the LocalRdrEnv to see what's in scope. This is
2272 important only to get nice-looking output when doing ":info C" in GHCi.
2273 It isn't essential for correctness.
2274
2275
2276 ************************************************************************
2277 * *
2278 Partial signatures
2279 * *
2280 ************************************************************************
2281
2282 -}
2283
2284 tcHsPartialSigType
2285 :: UserTypeCtxt
2286 -> LHsSigWcType GhcRn -- The type signature
2287 -> TcM ( [(Name, TcTyVar)] -- Wildcards
2288 , Maybe TcType -- Extra-constraints wildcard
2289 , [Name] -- Original tyvar names, in correspondence with ...
2290 , [TcTyVar] -- ... Implicitly and explicitly bound type variables
2291 , TcThetaType -- Theta part
2292 , TcType ) -- Tau part
2293 -- See Note [Recipe for checking a signature]
2294 tcHsPartialSigType ctxt sig_ty
2295 | HsWC { hswc_ext = sig_wcs, hswc_body = ib_ty } <- sig_ty
2296 , HsIB { hsib_ext = HsIBRn { hsib_vars = implicit_hs_tvs }
2297 , hsib_body = hs_ty } <- ib_ty
2298 , (explicit_hs_tvs, L _ hs_ctxt, hs_tau) <- splitLHsSigmaTy hs_ty
2299 = addSigCtxt ctxt hs_ty $
2300 do { (implicit_tvs, (explicit_tvs, (wcs, wcx, theta, tau)))
2301 <- tcWildCardBindersX newWildTyVar Nothing sig_wcs $ \ wcs ->
2302 tcImplicitTKBndrsSig skol_info implicit_hs_tvs $
2303 tcExplicitTKBndrs skol_info explicit_hs_tvs $
2304 do { -- Instantiate the type-class context; but if there
2305 -- is an extra-constraints wildcard, just discard it here
2306 (theta, wcx) <- tcPartialContext hs_ctxt
2307
2308 ; tau <- tcHsOpenType hs_tau
2309
2310 ; return (wcs, wcx, theta, tau) }
2311
2312 -- We must return these separately, because all the zonking below
2313 -- might change the name of a SigTv. This, in turn, causes trouble
2314 -- in partial type signatures that bind scoped type variables, as
2315 -- we bring the wrong name into scope in the function body.
2316 -- Test case: partial-sigs/should_compile/LocalDefinitionBug
2317 ; let tv_names = map tyVarName (implicit_tvs ++ explicit_tvs)
2318
2319 -- Spit out the wildcards (including the extra-constraints one)
2320 -- as "hole" constraints, so that they'll be reported if necessary
2321 -- See Note [Extra-constraint holes in partial type signatures]
2322 ; emitWildCardHoleConstraints wcs
2323
2324 -- The SigTvs created above will sometimes have too high a TcLevel
2325 -- (note that they are generated *after* bumping the level in
2326 -- the tc{Im,Ex}plicitTKBndrsSig functions. Bumping the level
2327 -- is still important here, because the kinds of these variables
2328 -- do indeed need to have the higher level, so they can unify
2329 -- with other local type variables. But, now that we've type-checked
2330 -- everything (and solved equalities in the tcImplicit call)
2331 -- we need to promote the SigTvs so we don't violate the TcLevel
2332 -- invariant
2333 ; all_tvs <- mapM zonkPromoteTyCoVarBndr (implicit_tvs ++ explicit_tvs)
2334 -- zonkPromoteTyCoVarBndr deals well with SigTvs
2335
2336 ; theta <- mapM zonkPromoteType theta
2337 ; tau <- zonkPromoteType tau
2338
2339 ; checkValidType ctxt (mkSpecForAllTys all_tvs $ mkPhiTy theta tau)
2340
2341 ; traceTc "tcHsPartialSigType" (ppr all_tvs)
2342 ; return (wcs, wcx, tv_names, all_tvs, theta, tau) }
2343 where
2344 skol_info = SigTypeSkol ctxt
2345 tcHsPartialSigType _ (HsWC _ (XHsImplicitBndrs _)) = panic "tcHsPartialSigType"
2346 tcHsPartialSigType _ (XHsWildCardBndrs _) = panic "tcHsPartialSigType"
2347
2348 tcPartialContext :: HsContext GhcRn -> TcM (TcThetaType, Maybe TcType)
2349 tcPartialContext hs_theta
2350 | Just (hs_theta1, hs_ctxt_last) <- snocView hs_theta
2351 , L _ (HsWildCardTy wc) <- ignoreParens hs_ctxt_last
2352 = do { wc_tv_ty <- tcWildCardOcc wc constraintKind
2353 ; theta <- mapM tcLHsPredType hs_theta1
2354 ; return (theta, Just wc_tv_ty) }
2355 | otherwise
2356 = do { theta <- mapM tcLHsPredType hs_theta
2357 ; return (theta, Nothing) }
2358
2359 {- Note [Extra-constraint holes in partial type signatures]
2360 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2361 Consider
2362 f :: (_) => a -> a
2363 f x = ...
2364
2365 * The renamer makes a wildcard name for the "_", and puts it in
2366 the hswc_wcs field.
2367
2368 * Then, in tcHsPartialSigType, we make a new hole TcTyVar, in
2369 tcWildCardBindersX.
2370
2371 * TcBinds.chooseInferredQuantifiers fills in that hole TcTyVar
2372 with the inferred constraints, e.g. (Eq a, Show a)
2373
2374 * TcErrors.mkHoleError finally reports the error.
2375
2376 An annoying difficulty happens if there are more than 62 inferred
2377 constraints. Then we need to fill in the TcTyVar with (say) a 70-tuple.
2378 Where do we find the TyCon? For good reasons we only have constraint
2379 tuples up to 62 (see Note [How tuples work] in TysWiredIn). So how
2380 can we make a 70-tuple? This was the root cause of Trac #14217.
2381
2382 It's incredibly tiresome, because we only need this type to fill
2383 in the hole, to communicate to the error reporting machinery. Nothing
2384 more. So I use a HACK:
2385
2386 * I make an /ordinary/ tuple of the constraints, in
2387 TcBinds.chooseInferredQuantifiers. This is ill-kinded because
2388 ordinary tuples can't contain constraints, but it works fine. And for
2389 ordinary tuples we don't have the same limit as for constraint
2390 tuples (which need selectors and an assocated class).
2391
2392 * Because it is ill-kinded, it trips an assert in writeMetaTyVar,
2393 so now I disable the assertion if we are writing a type of
2394 kind Constraint. (That seldom/never normally happens so we aren't
2395 losing much.)
2396
2397 Result works fine, but it may eventually bite us.
2398
2399
2400 ************************************************************************
2401 * *
2402 Pattern signatures (i.e signatures that occur in patterns)
2403 * *
2404 ********************************************************************* -}
2405
2406 tcHsPatSigType :: UserTypeCtxt
2407 -> LHsSigWcType GhcRn -- The type signature
2408 -> TcM ( [(Name, TcTyVar)] -- Wildcards
2409 , [(Name, TcTyVar)] -- The new bit of type environment, binding
2410 -- the scoped type variables
2411 , TcType) -- The type
2412 -- Used for type-checking type signatures in
2413 -- (a) patterns e.g f (x::Int) = e
2414 -- (b) RULE forall bndrs e.g. forall (x::Int). f x = x
2415 --
2416 -- This may emit constraints
2417 -- See Note [Recipe for checking a signature]
2418 tcHsPatSigType ctxt sig_ty
2419 | HsWC { hswc_ext = sig_wcs, hswc_body = ib_ty } <- sig_ty
2420 , HsIB { hsib_ext = HsIBRn { hsib_vars = sig_vars}
2421 , hsib_body = hs_ty } <- ib_ty
2422 = addSigCtxt ctxt hs_ty $
2423 do { sig_tkvs <- mapM new_implicit_tv sig_vars
2424 ; (wcs, sig_ty)
2425 <- tcWildCardBindersX newWildTyVar Nothing sig_wcs $ \ wcs ->
2426 tcExtendTyVarEnv sig_tkvs $
2427 do { sig_ty <- tcHsOpenType hs_ty
2428 ; return (wcs, sig_ty) }
2429
2430 ; emitWildCardHoleConstraints wcs
2431
2432 -- sig_ty might have tyvars that are at a higher TcLevel (if hs_ty
2433 -- contains a forall). Promote these.
2434 ; sig_ty <- zonkPromoteType sig_ty
2435 ; checkValidType ctxt sig_ty
2436
2437 ; tv_pairs <- mapM mk_tv_pair sig_tkvs
2438
2439 ; traceTc "tcHsPatSigType" (ppr sig_vars)
2440 ; return (wcs, tv_pairs, sig_ty) }
2441 where
2442 new_implicit_tv name = do { kind <- newMetaKindVar
2443 ; new_tv name kind }
2444
2445 new_tv = case ctxt of
2446 RuleSigCtxt {} -> newSkolemTyVar
2447 _ -> newSigTyVar
2448 -- See Note [Pattern signature binders]
2449 -- See Note [Unifying SigTvs]
2450
2451 mk_tv_pair tv = do { tv' <- zonkTcTyVarToTyVar tv
2452 ; return (tyVarName tv, tv') }
2453 -- The Name is one of sig_vars, the lexically scoped name
2454 -- But if it's a SigTyVar, it might have been unified
2455 -- with an existing in-scope skolem, so we must zonk
2456 -- here. See Note [Pattern signature binders]
2457 tcHsPatSigType _ (HsWC _ (XHsImplicitBndrs _)) = panic "tcHsPatSigType"
2458 tcHsPatSigType _ (XHsWildCardBndrs _) = panic "tcHsPatSigType"
2459
2460 tcPatSig :: Bool -- True <=> pattern binding
2461 -> LHsSigWcType GhcRn
2462 -> ExpSigmaType
2463 -> TcM (TcType, -- The type to use for "inside" the signature
2464 [(Name,TcTyVar)], -- The new bit of type environment, binding
2465 -- the scoped type variables
2466 [(Name,TcTyVar)], -- The wildcards
2467 HsWrapper) -- Coercion due to unification with actual ty
2468 -- Of shape: res_ty ~ sig_ty
2469 tcPatSig in_pat_bind sig res_ty
2470 = do { (sig_wcs, sig_tvs, sig_ty) <- tcHsPatSigType PatSigCtxt sig
2471 -- sig_tvs are the type variables free in 'sig',
2472 -- and not already in scope. These are the ones
2473 -- that should be brought into scope
2474
2475 ; if null sig_tvs then do {
2476 -- Just do the subsumption check and return
2477 wrap <- addErrCtxtM (mk_msg sig_ty) $
2478 tcSubTypeET PatSigOrigin PatSigCtxt res_ty sig_ty
2479 ; return (sig_ty, [], sig_wcs, wrap)
2480 } else do
2481 -- Type signature binds at least one scoped type variable
2482
2483 -- A pattern binding cannot bind scoped type variables
2484 -- It is more convenient to make the test here
2485 -- than in the renamer
2486 { when in_pat_bind (addErr (patBindSigErr sig_tvs))
2487
2488 -- Check that all newly-in-scope tyvars are in fact
2489 -- constrained by the pattern. This catches tiresome
2490 -- cases like
2491 -- type T a = Int
2492 -- f :: Int -> Int
2493 -- f (x :: T a) = ...
2494 -- Here 'a' doesn't get a binding. Sigh
2495 ; let bad_tvs = [ tv | (_,tv) <- sig_tvs
2496 , not (tv `elemVarSet` exactTyCoVarsOfType sig_ty) ]
2497 ; checkTc (null bad_tvs) (badPatSigTvs sig_ty bad_tvs)
2498
2499 -- Now do a subsumption check of the pattern signature against res_ty
2500 ; wrap <- addErrCtxtM (mk_msg sig_ty) $
2501 tcSubTypeET PatSigOrigin PatSigCtxt res_ty sig_ty
2502
2503 -- Phew!
2504 ; return (sig_ty, sig_tvs, sig_wcs, wrap)
2505 } }
2506 where
2507 mk_msg sig_ty tidy_env
2508 = do { (tidy_env, sig_ty) <- zonkTidyTcType tidy_env sig_ty
2509 ; res_ty <- readExpType res_ty -- should be filled in by now
2510 ; (tidy_env, res_ty) <- zonkTidyTcType tidy_env res_ty
2511 ; let msg = vcat [ hang (text "When checking that the pattern signature:")
2512 4 (ppr sig_ty)
2513 , nest 2 (hang (text "fits the type of its context:")
2514 2 (ppr res_ty)) ]
2515 ; return (tidy_env, msg) }
2516
2517 patBindSigErr :: [(Name,TcTyVar)] -> SDoc
2518 patBindSigErr sig_tvs
2519 = hang (text "You cannot bind scoped type variable" <> plural sig_tvs
2520 <+> pprQuotedList (map fst sig_tvs))
2521 2 (text "in a pattern binding signature")
2522
2523 {- Note [Pattern signature binders]
2524 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2525 Consider
2526 data T = forall a. T a (a->Int)
2527 f (T x (f :: b->Int)) = blah
2528
2529 Here
2530 * The pattern (T p1 p2) creates a *skolem* type variable 'a_sk',
2531 It must be a skolem so that that it retains its identity, and
2532 TcErrors.getSkolemInfo can thereby find the binding site for the skolem.
2533
2534 * The type signature pattern (f :: b->Int) makes a fresh meta-tyvar b_sig
2535 (a SigTv), and binds "b" :-> b_sig in the envt
2536
2537 * Then unification makes b_sig := a_sk
2538 That's why we must make b_sig a MetaTv (albeit a SigTv),
2539 not a SkolemTv, so that it can unify to a_sk.
2540
2541 * Finally, in 'blah' we must have the envt "b" :-> a_sk. The pair
2542 ("b" :-> a_sk) is returned by tcHsPatSigType, constructed by
2543 mk_tv_pair in that function.
2544
2545 Another example (Trac #13881):
2546 fl :: forall (l :: [a]). Sing l -> Sing l
2547 fl (SNil :: Sing (l :: [y])) = SNil
2548 When we reach the pattern signature, 'l' is in scope from the
2549 outer 'forall':
2550 "a" :-> a_sk :: *
2551 "l" :-> l_sk :: [a_sk]
2552 We make up a fresh meta-SigTv, y_sig, for 'y', and kind-check
2553 the pattern signature
2554 Sing (l :: [y])
2555 That unifies y_sig := a_sk. We return from tcHsPatSigType with
2556 the pair ("y" :-> a_sk).
2557
2558 For RULE binders, though, things are a bit different (yuk).
2559 RULE "foo" forall (x::a) (y::[a]). f x y = ...
2560 Here this really is the binding site of the type variable so we'd like
2561 to use a skolem, so that we get a complaint if we unify two of them
2562 together.
2563
2564 Note [Unifying SigTvs]
2565 ~~~~~~~~~~~~~~~~~~~~~~
2566 ALAS we have no decent way of avoiding two SigTvs getting unified.
2567 Consider
2568 f (x::(a,b)) (y::c)) = [fst x, y]
2569 Here we'd really like to complain that 'a' and 'c' are unified. But
2570 for the reasons above we can't make a,b,c into skolems, so they
2571 are just SigTvs that can unify. And indeed, this would be ok,
2572 f x (y::c) = case x of
2573 (x1 :: a1, True) -> [x,y]
2574 (x1 :: a2, False) -> [x,y,y]
2575 Here the type of x's first component is called 'a1' in one branch and
2576 'a2' in the other. We could try insisting on the same OccName, but
2577 they definitely won't have the sane lexical Name.
2578
2579 I think we could solve this by recording in a SigTv a list of all the
2580 in-scope variables that it should not unify with, but it's fiddly.
2581
2582
2583 ************************************************************************
2584 * *
2585 Checking kinds
2586 * *
2587 ************************************************************************
2588
2589 -}
2590
2591 unifyKinds :: [LHsType GhcRn] -> [(TcType, TcKind)] -> TcM ([TcType], TcKind)
2592 unifyKinds rn_tys act_kinds
2593 = do { kind <- newMetaKindVar
2594 ; let check rn_ty (ty, act_kind) = checkExpectedKind (unLoc rn_ty) ty act_kind kind
2595 ; tys' <- zipWithM check rn_tys act_kinds
2596 ; return (tys', kind) }
2597
2598 {-
2599 ************************************************************************
2600 * *
2601 Promotion
2602 * *
2603 ************************************************************************
2604 -}
2605
2606 -- | Whenever a type is about to be added to the environment, it's necessary
2607 -- to make sure that any free meta-tyvars in the type are promoted to the
2608 -- current TcLevel. (They might be at a higher level due to the level-bumping
2609 -- in tcExplicitTKBndrs, for example.) This function both zonks *and*
2610 -- promotes.
2611 zonkPromoteType :: TcType -> TcM TcType
2612 zonkPromoteType = mapType zonkPromoteMapper ()
2613
2614 -- cf. TcMType.zonkTcTypeMapper
2615 zonkPromoteMapper :: TyCoMapper () TcM
2616 zonkPromoteMapper = TyCoMapper { tcm_smart = True
2617 , tcm_tyvar = const zonkPromoteTcTyVar
2618 , tcm_covar = const covar
2619 , tcm_hole = const hole
2620 , tcm_tybinder = const tybinder }
2621 where
2622 covar cv
2623 = mkCoVarCo <$> zonkPromoteTyCoVarKind cv
2624
2625 hole :: CoercionHole -> TcM Coercion
2626 hole h
2627 = do { contents <- unpackCoercionHole_maybe h
2628 ; case contents of
2629 Just co -> do { co <- zonkPromoteCoercion co
2630 ; checkCoercionHole cv co }
2631 Nothing -> do { cv' <- zonkPromoteTyCoVarKind cv
2632 ; return $ mkHoleCo (setCoHoleCoVar h cv') } }
2633 where
2634 cv = coHoleCoVar h
2635
2636 tybinder :: TyVar -> ArgFlag -> TcM ((), TyVar)
2637 tybinder tv _flag = ((), ) <$> zonkPromoteTyCoVarKind tv
2638
2639 zonkPromoteTcTyVar :: TyCoVar -> TcM TcType
2640 zonkPromoteTcTyVar tv
2641 | isMetaTyVar tv
2642 = do { let ref = metaTyVarRef tv
2643 ; contents <- readTcRef ref
2644 ; case contents of
2645 Flexi -> do { promoted <- promoteTyVar tv
2646 ; if promoted
2647 then zonkPromoteTcTyVar tv -- read it again
2648 else mkTyVarTy <$> zonkPromoteTyCoVarKind tv }
2649 Indirect ty -> zonkPromoteType ty }
2650
2651 | isTcTyVar tv && isSkolemTyVar tv -- NB: isSkolemTyVar says "True" to pure TyVars
2652 = do { tc_lvl <- getTcLevel
2653 ; mkTyVarTy <$> zonkPromoteTyCoVarKind (promoteSkolem tc_lvl tv) }
2654
2655 | otherwise
2656 = mkTyVarTy <$> zonkPromoteTyCoVarKind tv
2657
2658 zonkPromoteTyCoVarKind :: TyCoVar -> TcM TyCoVar
2659 zonkPromoteTyCoVarKind = updateTyVarKindM zonkPromoteType
2660
2661 zonkPromoteTyCoVarBndr :: TyCoVar -> TcM TyCoVar
2662 zonkPromoteTyCoVarBndr tv
2663 | isSigTyVar tv
2664 = tcGetTyVar "zonkPromoteTyCoVarBndr SigTv" <$> zonkPromoteTcTyVar tv
2665
2666 | isTcTyVar tv && isSkolemTyVar tv
2667 = do { tc_lvl <- getTcLevel
2668 ; zonkPromoteTyCoVarKind (promoteSkolem tc_lvl tv) }
2669
2670 | otherwise
2671 = zonkPromoteTyCoVarKind tv
2672
2673 zonkPromoteCoercion :: Coercion -> TcM Coercion
2674 zonkPromoteCoercion = mapCoercion zonkPromoteMapper ()
2675
2676 zonkPromoteTypeInKnot :: TcType -> TcM TcType
2677 zonkPromoteTypeInKnot = mapType (zonkPromoteMapper { tcm_smart = False }) ()
2678 -- NB: Just changing smart to False will still use the smart zonker (not suitable
2679 -- for in-the-knot) for kinds. But that's OK, because kinds aren't knot-tied.
2680
2681 {-
2682 ************************************************************************
2683 * *
2684 Sort checking kinds
2685 * *
2686 ************************************************************************
2687
2688 tcLHsKindSig converts a user-written kind to an internal, sort-checked kind.
2689 It does sort checking and desugaring at the same time, in one single pass.
2690 -}
2691
2692 tcLHsKindSig :: UserTypeCtxt -> LHsKind GhcRn -> TcM Kind
2693 tcLHsKindSig ctxt hs_kind
2694 -- See Note [Recipe for checking a signature] in TcHsType
2695 = do { kind <- solveLocalEqualities $
2696 tc_lhs_kind kindLevelMode hs_kind
2697 ; kind <- zonkPromoteType kind
2698 -- This zonk is very important in the case of higher rank kinds
2699 -- E.g. Trac #13879 f :: forall (p :: forall z (y::z). <blah>).
2700 -- <more blah>
2701 -- When instantiating p's kind at occurrences of p in <more blah>
2702 -- it's crucial that the kind we instantiate is fully zonked,
2703 -- else we may fail to substitute properly
2704
2705 ; checkValidType ctxt kind
2706 ; return kind }
2707
2708 tc_lhs_kind :: TcTyMode -> LHsKind GhcRn -> TcM Kind
2709 tc_lhs_kind mode k
2710 = addErrCtxt (text "In the kind" <+> quotes (ppr k)) $
2711 tc_lhs_type (kindLevel mode) k liftedTypeKind
2712
2713 promotionErr :: Name -> PromotionErr -> TcM a
2714 promotionErr name err
2715 = failWithTc (hang (pprPECategory err <+> quotes (ppr name) <+> text "cannot be used here")
2716 2 (parens reason))
2717 where
2718 reason = case err of
2719 ConstrainedDataConPE pred
2720 -> text "it has an unpromotable context"
2721 <+> quotes (ppr pred)
2722 FamDataConPE -> text "it comes from a data family instance"
2723 NoDataKindsTC -> text "perhaps you intended to use DataKinds"
2724 NoDataKindsDC -> text "perhaps you intended to use DataKinds"
2725 PatSynPE -> text "pattern synonyms cannot be promoted"
2726 PatSynExPE -> sep [ text "the existential variables of a pattern synonym"
2727 , text "signature do not scope over the pattern" ]
2728 _ -> text "it is defined and used in the same recursive group"
2729
2730 {-
2731 ************************************************************************
2732 * *
2733 Scoped type variables
2734 * *
2735 ************************************************************************
2736 -}
2737
2738 badPatSigTvs :: TcType -> [TyVar] -> SDoc
2739 badPatSigTvs sig_ty bad_tvs
2740 = vcat [ fsep [text "The type variable" <> plural bad_tvs,
2741 quotes (pprWithCommas ppr bad_tvs),
2742 text "should be bound by the pattern signature" <+> quotes (ppr sig_ty),
2743 text "but are actually discarded by a type synonym" ]
2744 , text "To fix this, expand the type synonym"
2745 , text "[Note: I hope to lift this restriction in due course]" ]
2746
2747 {-
2748 ************************************************************************
2749 * *
2750 Error messages and such
2751 * *
2752 ************************************************************************
2753 -}
2754
2755 -- | Make an appropriate message for an error in a function argument.
2756 -- Used for both expressions and types.
2757 funAppCtxt :: (Outputable fun, Outputable arg) => fun -> arg -> Int -> SDoc
2758 funAppCtxt fun arg arg_no
2759 = hang (hsep [ text "In the", speakNth arg_no, ptext (sLit "argument of"),
2760 quotes (ppr fun) <> text ", namely"])
2761 2 (quotes (ppr arg))
2762
2763 -- See Note [Free-floating kind vars]
2764 reportFloatingKvs :: Name -- of the tycon
2765 -> TyConFlavour -- What sort of TyCon it is
2766 -> [TcTyVar] -- all tyvars, not necessarily zonked
2767 -> [TcTyVar] -- floating tyvars
2768 -> TcM ()
2769 reportFloatingKvs tycon_name flav all_tvs bad_tvs
2770 = unless (null bad_tvs) $ -- don't bother zonking if there's no error
2771 do { all_tvs <- mapM zonkTcTyVarToTyVar all_tvs
2772 ; bad_tvs <- mapM zonkTcTyVarToTyVar bad_tvs
2773 ; let (tidy_env, tidy_all_tvs) = tidyOpenTyCoVars emptyTidyEnv all_tvs
2774 tidy_bad_tvs = map (tidyTyVarOcc tidy_env) bad_tvs
2775 ; mapM_ (report tidy_all_tvs) tidy_bad_tvs }
2776 where
2777 report tidy_all_tvs tidy_bad_tv
2778 = addErr $
2779 vcat [ text "Kind variable" <+> quotes (ppr tidy_bad_tv) <+>
2780 text "is implicitly bound in" <+> ppr flav
2781 , quotes (ppr tycon_name) <> comma <+>
2782 text "but does not appear as the kind of any"
2783 , text "of its type variables. Perhaps you meant"
2784 , text "to bind it explicitly somewhere?"
2785 , ppWhen (not (null tidy_all_tvs)) $
2786 hang (text "Type variables with inferred kinds:")
2787 2 (ppr_tv_bndrs tidy_all_tvs) ]
2788
2789 ppr_tv_bndrs tvs = sep (map pp_tv tvs)
2790 pp_tv tv = parens (ppr tv <+> dcolon <+> ppr (tyVarKind tv))