Trac #11554 fix loopy GADTs
[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 #-}
9
10 module TcHsType (
11 -- Type signatures
12 kcHsSigType, tcClassSigType,
13 tcHsSigType, tcHsSigWcType,
14 tcHsPartialSigType,
15 funsSigCtxt, addSigCtxt, pprSigCtxt,
16
17 tcHsClsInstType,
18 tcHsDeriv, tcHsVectInst,
19 tcHsTypeApp,
20 UserTypeCtxt(..),
21 tcImplicitTKBndrs, tcImplicitTKBndrsType, tcExplicitTKBndrs,
22
23 -- Type checking type and class decls
24 kcLookupTcTyCon, kcTyClTyVars, tcTyClTyVars,
25 tcHsConArgType, tcDataKindSig,
26
27 -- Kind-checking types
28 -- No kind generalisation, no checkValidType
29 tcWildCardBinders,
30 kcHsTyVarBndrs,
31 tcHsLiftedType, tcHsOpenType,
32 tcHsLiftedTypeNC, tcHsOpenTypeNC,
33 tcLHsType, tcCheckLHsType,
34 tcHsContext, tcLHsPredType, tcInferApps, tcInferArgs,
35 solveEqualities, -- useful re-export
36
37 kindGeneralize,
38
39 -- Sort-checking kinds
40 tcLHsKind,
41
42 -- Pattern type signatures
43 tcHsPatSigType, tcPatSig, funAppCtxt
44 ) where
45
46 #include "HsVersions.h"
47
48 import HsSyn
49 import TcRnMonad
50 import TcEvidence
51 import TcEnv
52 import TcMType
53 import TcValidity
54 import TcUnify
55 import TcIface
56 import TcSimplify ( solveEqualities )
57 import TcType
58 import Inst ( tcInstBinders, tcInstBindersX, tcInstBinderX )
59 import Type
60 import Kind
61 import RdrName( lookupLocalRdrOcc )
62 import Var
63 import VarSet
64 import TyCon
65 import ConLike
66 import DataCon
67 import TysPrim ( tYPE )
68 import Class
69 import Name
70 import NameEnv
71 import NameSet
72 import VarEnv
73 import TysWiredIn
74 import BasicTypes
75 import SrcLoc
76 import Constants ( mAX_CTUPLE_SIZE )
77 import ErrUtils( MsgDoc )
78 import Unique
79 import Util
80 import UniqSupply
81 import Outputable
82 import FastString
83 import PrelNames hiding ( wildCardName )
84 import qualified GHC.LanguageExtensions as LangExt
85
86 import Maybes
87 import Data.List ( partition, zipWith4 )
88 import Control.Monad
89
90 {-
91 ----------------------------
92 General notes
93 ----------------------------
94
95 Unlike with expressions, type-checking types both does some checking and
96 desugars at the same time. This is necessary because we often want to perform
97 equality checks on the types right away, and it would be incredibly painful
98 to do this on un-desugared types. Luckily, desugared types are close enough
99 to HsTypes to make the error messages sane.
100
101 During type-checking, we perform as little validity checking as possible.
102 This is because some type-checking is done in a mutually-recursive knot, and
103 if we look too closely at the tycons, we'll loop. This is why we always must
104 use mkNakedTyConApp and mkNakedAppTys, etc., which never look at a tycon.
105 The mkNamed... functions don't uphold Type invariants, but zonkTcTypeToType
106 will repair this for us. Note that zonkTcType *is* safe within a knot, and
107 can be done repeatedly with no ill effect: it just squeezes out metavariables.
108
109 Generally, after type-checking, you will want to do validity checking, say
110 with TcValidity.checkValidType.
111
112 Validity checking
113 ~~~~~~~~~~~~~~~~~
114 Some of the validity check could in principle be done by the kind checker,
115 but not all:
116
117 - During desugaring, we normalise by expanding type synonyms. Only
118 after this step can we check things like type-synonym saturation
119 e.g. type T k = k Int
120 type S a = a
121 Then (T S) is ok, because T is saturated; (T S) expands to (S Int);
122 and then S is saturated. This is a GHC extension.
123
124 - Similarly, also a GHC extension, we look through synonyms before complaining
125 about the form of a class or instance declaration
126
127 - Ambiguity checks involve functional dependencies, and it's easier to wait
128 until knots have been resolved before poking into them
129
130 Also, in a mutually recursive group of types, we can't look at the TyCon until we've
131 finished building the loop. So to keep things simple, we postpone most validity
132 checking until step (3).
133
134 Knot tying
135 ~~~~~~~~~~
136 During step (1) we might fault in a TyCon defined in another module, and it might
137 (via a loop) refer back to a TyCon defined in this module. So when we tie a big
138 knot around type declarations with ARecThing, so that the fault-in code can get
139 the TyCon being defined.
140
141 %************************************************************************
142 %* *
143 Check types AND do validity checking
144 * *
145 ************************************************************************
146 -}
147
148 funsSigCtxt :: [Located Name] -> UserTypeCtxt
149 -- Returns FunSigCtxt, with no redundant-context-reporting,
150 -- form a list of located names
151 funsSigCtxt (L _ name1 : _) = FunSigCtxt name1 False
152 funsSigCtxt [] = panic "funSigCtxt"
153
154 addSigCtxt :: UserTypeCtxt -> LHsType Name -> TcM a -> TcM a
155 addSigCtxt ctxt hs_ty thing_inside
156 = setSrcSpan (getLoc hs_ty) $
157 addErrCtxt (pprSigCtxt ctxt hs_ty) $
158 thing_inside
159
160 pprSigCtxt :: UserTypeCtxt -> LHsType Name -> SDoc
161 -- (pprSigCtxt ctxt <extra> <type>)
162 -- prints In the type signature for 'f':
163 -- f :: <type>
164 -- The <extra> is either empty or "the ambiguity check for"
165 pprSigCtxt ctxt hs_ty
166 | Just n <- isSigMaybe ctxt
167 = hang (text "In the type signature:")
168 2 (pprPrefixOcc n <+> dcolon <+> ppr hs_ty)
169
170 | otherwise
171 = hang (text "In" <+> pprUserTypeCtxt ctxt <> colon)
172 2 (ppr hs_ty)
173
174 tcHsSigWcType :: UserTypeCtxt -> LHsSigWcType Name -> TcM Type
175 -- This one is used when we have a LHsSigWcType, but in
176 -- a place where wildards aren't allowed. The renamer has
177 -- alrady checked this, so we can simply ignore it.
178 tcHsSigWcType ctxt sig_ty = tcHsSigType ctxt (dropWildCards sig_ty)
179
180 kcHsSigType :: [Located Name] -> LHsSigType Name -> TcM ()
181 kcHsSigType names (HsIB { hsib_body = hs_ty
182 , hsib_vars = sig_vars })
183 = addSigCtxt (funsSigCtxt names) hs_ty $
184 discardResult $
185 tcImplicitTKBndrsType sig_vars $
186 tc_lhs_type typeLevelMode hs_ty liftedTypeKind
187
188 tcClassSigType :: [Located Name] -> LHsSigType Name -> TcM Type
189 -- Does not do validity checking; this must be done outside
190 -- the recursive class declaration "knot"
191 tcClassSigType names sig_ty
192 = addSigCtxt (funsSigCtxt names) (hsSigType sig_ty) $
193 do { ty <- tc_hs_sig_type sig_ty liftedTypeKind
194 ; kindGeneralizeType ty }
195
196 tcHsSigType :: UserTypeCtxt -> LHsSigType Name -> TcM Type
197 -- Does validity checking
198 tcHsSigType ctxt sig_ty
199 = addSigCtxt ctxt (hsSigType sig_ty) $
200 do { kind <- case expectedKindInCtxt ctxt of
201 AnythingKind -> newMetaKindVar
202 TheKind k -> return k
203 OpenKind -> do { rr <- newFlexiTyVarTy runtimeRepTy
204 ; return $ tYPE rr }
205 -- The kind is checked by checkValidType, and isn't necessarily
206 -- of kind * in a Template Haskell quote eg [t| Maybe |]
207
208 ; ty <- tc_hs_sig_type sig_ty kind
209
210 -- Generalise here: see Note [Kind generalisation]
211 ; do_kind_gen <- decideKindGeneralisationPlan ty
212 ; ty <- if do_kind_gen
213 then kindGeneralizeType ty
214 else zonkTcType ty
215
216 ; checkValidType ctxt ty
217 ; return ty }
218
219 tc_hs_sig_type :: LHsSigType Name -> Kind -> TcM Type
220 -- Does not do validity checking or zonking
221 tc_hs_sig_type (HsIB { hsib_body = hs_ty
222 , hsib_vars = sig_vars }) kind
223 = do { (tkvs, ty) <- solveEqualities $
224 tcImplicitTKBndrsType sig_vars $
225 tc_lhs_type typeLevelMode hs_ty kind
226 ; return (mkSpecForAllTys tkvs ty) }
227
228 -----------------
229 tcHsDeriv :: LHsSigType Name -> TcM ([TyVar], Class, [Type], Kind)
230 -- Like tcHsSigType, but for the ...deriving( C t1 ty2 ) clause
231 -- Returns the C, [ty1, ty2, and the kind of C's *next* argument
232 -- E.g. class C (a::*) (b::k->k)
233 -- data T a b = ... deriving( C Int )
234 -- returns ([k], C, [k, Int], k->k)
235 -- Also checks that (C ty1 ty2 arg) :: Constraint
236 -- if arg has a suitable kind
237 tcHsDeriv hs_ty
238 = do { arg_kind <- newMetaKindVar
239 -- always safe to kind-generalize, because there
240 -- can be no covars in an outer scope
241 ; ty <- checkNoErrs $
242 -- avoid redundant error report with "illegal deriving", below
243 tc_hs_sig_type hs_ty (mkFunTy arg_kind constraintKind)
244 ; ty <- kindGeneralizeType ty -- also zonks
245 ; arg_kind <- zonkTcType arg_kind
246 ; let (tvs, pred) = splitForAllTys ty
247 ; case getClassPredTys_maybe pred of
248 Just (cls, tys) -> return (tvs, cls, tys, arg_kind)
249 Nothing -> failWithTc (text "Illegal deriving item" <+> quotes (ppr hs_ty)) }
250
251 tcHsClsInstType :: UserTypeCtxt -- InstDeclCtxt or SpecInstCtxt
252 -> LHsSigType Name
253 -> TcM ([TyVar], ThetaType, Class, [Type])
254 -- Like tcHsSigType, but for a class instance declaration
255 tcHsClsInstType user_ctxt hs_inst_ty
256 = setSrcSpan (getLoc (hsSigType hs_inst_ty)) $
257 do { inst_ty <- tc_hs_sig_type hs_inst_ty constraintKind
258 ; inst_ty <- kindGeneralizeType inst_ty
259 ; checkValidInstance user_ctxt hs_inst_ty inst_ty }
260
261 -- Used for 'VECTORISE [SCALAR] instance' declarations
262 tcHsVectInst :: LHsSigType Name -> TcM (Class, [Type])
263 tcHsVectInst ty
264 | Just (L _ cls_name, tys) <- hsTyGetAppHead_maybe (hsSigType ty)
265 -- Ignoring the binders looks pretty dodgy to me
266 = do { (cls, cls_kind) <- tcClass cls_name
267 ; (applied_class, _res_kind)
268 <- tcInferApps typeLevelMode cls_name (mkClassPred cls []) cls_kind tys
269 ; case tcSplitTyConApp_maybe applied_class of
270 Just (_tc, args) -> ASSERT( _tc == classTyCon cls )
271 return (cls, args)
272 _ -> failWithTc (text "Too many arguments passed to" <+> ppr cls_name) }
273 | otherwise
274 = failWithTc $ text "Malformed instance type"
275
276 ----------------------------------------------
277 -- | Type-check a visible type application
278 tcHsTypeApp :: LHsWcType Name -> Kind -> TcM Type
279 tcHsTypeApp wc_ty kind
280 | HsWC { hswc_wcs = sig_wcs, hswc_body = hs_ty } <- wc_ty
281 = do { ty <- solveEqualities $
282 tcWildCardBindersX newWildTyVar sig_wcs $ \ _ ->
283 tcCheckLHsType hs_ty kind
284 ; ty <- zonkTcType ty
285 ; checkValidType TypeAppCtxt ty
286 ; return ty }
287 -- NB: we don't call emitWildcardHoleConstraints here, because
288 -- we want any holes in visible type applications to be used
289 -- without fuss. No errors, warnings, extensions, etc.
290
291 {-
292 ************************************************************************
293 * *
294 The main kind checker: no validity checks here
295 %* *
296 %************************************************************************
297
298 First a couple of simple wrappers for kcHsType
299 -}
300
301 tcHsConArgType :: NewOrData -> LHsType Name -> TcM Type
302 -- Permit a bang, but discard it
303 tcHsConArgType NewType bty = tcHsLiftedType (getBangType bty)
304 -- Newtypes can't have bangs, but we don't check that
305 -- until checkValidDataCon, so do not want to crash here
306
307 tcHsConArgType DataType bty = tcHsOpenType (getBangType bty)
308 -- Can't allow an unlifted type for newtypes, because we're effectively
309 -- going to remove the constructor while coercing it to a lifted type.
310 -- And newtypes can't be bang'd
311
312 ---------------------------
313 tcHsOpenType, tcHsLiftedType,
314 tcHsOpenTypeNC, tcHsLiftedTypeNC :: LHsType Name -> TcM TcType
315 -- Used for type signatures
316 -- Do not do validity checking
317 tcHsOpenType ty = addTypeCtxt ty $ tcHsOpenTypeNC ty
318 tcHsLiftedType ty = addTypeCtxt ty $ tcHsLiftedTypeNC ty
319
320 tcHsOpenTypeNC ty = do { ek <- ekOpen
321 ; tc_lhs_type typeLevelMode ty ek }
322 tcHsLiftedTypeNC ty = tc_lhs_type typeLevelMode ty liftedTypeKind
323
324 -- Like tcHsType, but takes an expected kind
325 tcCheckLHsType :: LHsType Name -> Kind -> TcM Type
326 tcCheckLHsType hs_ty exp_kind
327 = addTypeCtxt hs_ty $
328 tc_lhs_type typeLevelMode hs_ty exp_kind
329
330 tcLHsType :: LHsType Name -> TcM (TcType, TcKind)
331 -- Called from outside: set the context
332 tcLHsType ty = addTypeCtxt ty (tc_infer_lhs_type typeLevelMode ty)
333
334 ---------------------------
335 -- | Should we generalise the kind of this type signature?
336 -- We *should* generalise if the type is mentions no scoped type variables
337 -- or if NoMonoLocalBinds is set. Otherwise, nope.
338 decideKindGeneralisationPlan :: Type -> TcM Bool
339 decideKindGeneralisationPlan ty
340 = do { mono_locals <- xoptM LangExt.MonoLocalBinds
341 ; in_scope <- getInLocalScope
342 ; let fvs = tyCoVarsOfTypeList ty
343 should_gen = not mono_locals || all (not . in_scope . getName) fvs
344 ; traceTc "decideKindGeneralisationPlan"
345 (vcat [ text "type:" <+> ppr ty
346 , text "ftvs:" <+> ppr fvs
347 , text "should gen?" <+> ppr should_gen ])
348 ; return should_gen }
349
350 {-
351 ************************************************************************
352 * *
353 Type-checking modes
354 * *
355 ************************************************************************
356
357 The kind-checker is parameterised by a TcTyMode, which contains some
358 information about where we're checking a type.
359
360 The renamer issues errors about what it can. All errors issued here must
361 concern things that the renamer can't handle.
362
363 -}
364
365 -- | Info about the context in which we're checking a type. Currently,
366 -- differentiates only between types and kinds, but this will likely
367 -- grow, at least to include the distinction between patterns and
368 -- not-patterns.
369 newtype TcTyMode
370 = TcTyMode { mode_level :: TypeOrKind -- True <=> type, False <=> kind
371 }
372
373 typeLevelMode :: TcTyMode
374 typeLevelMode = TcTyMode { mode_level = TypeLevel }
375
376 kindLevelMode :: TcTyMode
377 kindLevelMode = TcTyMode { mode_level = KindLevel }
378
379 -- switch to kind level
380 kindLevel :: TcTyMode -> TcTyMode
381 kindLevel mode = mode { mode_level = KindLevel }
382
383 instance Outputable TcTyMode where
384 ppr = ppr . mode_level
385
386 {-
387 Note [Bidirectional type checking]
388 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
389 In expressions, whenever we see a polymorphic identifier, say `id`, we are
390 free to instantiate it with metavariables, knowing that we can always
391 re-generalize with type-lambdas when necessary. For example:
392
393 rank2 :: (forall a. a -> a) -> ()
394 x = rank2 id
395
396 When checking the body of `x`, we can instantiate `id` with a metavariable.
397 Then, when we're checking the application of `rank2`, we notice that we really
398 need a polymorphic `id`, and then re-generalize over the unconstrained
399 metavariable.
400
401 In types, however, we're not so lucky, because *we cannot re-generalize*!
402 There is no lambda. So, we must be careful only to instantiate at the last
403 possible moment, when we're sure we're never going to want the lost polymorphism
404 again. This is done in calls to tcInstBinders and tcInstBindersX.
405
406 To implement this behavior, we use bidirectional type checking, where we
407 explicitly think about whether we know the kind of the type we're checking
408 or not. Note that there is a difference between not knowing a kind and
409 knowing a metavariable kind: the metavariables are TauTvs, and cannot become
410 forall-quantified kinds. Previously (before dependent types), there were
411 no higher-rank kinds, and so we could instantiate early and be sure that
412 no types would have polymorphic kinds, and so we could always assume that
413 the kind of a type was a fresh metavariable. Not so anymore, thus the
414 need for two algorithms.
415
416 For HsType forms that can never be kind-polymorphic, we implement only the
417 "down" direction, where we safely assume a metavariable kind. For HsType forms
418 that *can* be kind-polymorphic, we implement just the "up" (functions with
419 "infer" in their name) version, as we gain nothing by also implementing the
420 "down" version.
421
422 Note [Future-proofing the type checker]
423 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
424 As discussed in Note [Bidirectional type checking], each HsType form is
425 handled in *either* tc_infer_hs_type *or* tc_hs_type. These functions
426 are mutually recursive, so that either one can work for any type former.
427 But, we want to make sure that our pattern-matches are complete. So,
428 we have a bunch of repetitive code just so that we get warnings if we're
429 missing any patterns.
430 -}
431
432 ------------------------------------------
433 -- | Check and desugar a type, returning the core type and its
434 -- possibly-polymorphic kind. Much like 'tcInferRho' at the expression
435 -- level.
436 tc_infer_lhs_type :: TcTyMode -> LHsType Name -> TcM (TcType, TcKind)
437 tc_infer_lhs_type mode (L span ty)
438 = setSrcSpan span $
439 do { (ty', kind) <- tc_infer_hs_type mode ty
440 ; return (ty', kind) }
441
442 -- | Infer the kind of a type and desugar. This is the "up" type-checker,
443 -- as described in Note [Bidirectional type checking]
444 tc_infer_hs_type :: TcTyMode -> HsType Name -> TcM (TcType, TcKind)
445 tc_infer_hs_type mode (HsTyVar (L _ tv)) = tcTyVar mode tv
446 tc_infer_hs_type mode (HsAppTy ty1 ty2)
447 = do { let (fun_ty, arg_tys) = splitHsAppTys ty1 [ty2]
448 ; (fun_ty', fun_kind) <- tc_infer_lhs_type mode fun_ty
449 ; fun_kind' <- zonkTcType fun_kind
450 ; tcInferApps mode fun_ty fun_ty' fun_kind' arg_tys }
451 tc_infer_hs_type mode (HsParTy t) = tc_infer_lhs_type mode t
452 tc_infer_hs_type mode (HsOpTy lhs (L _ op) rhs)
453 | not (op `hasKey` funTyConKey)
454 = do { (op', op_kind) <- tcTyVar mode op
455 ; op_kind' <- zonkTcType op_kind
456 ; tcInferApps mode op op' op_kind' [lhs, rhs] }
457 tc_infer_hs_type mode (HsKindSig ty sig)
458 = do { sig' <- tc_lhs_kind (kindLevel mode) sig
459 ; ty' <- tc_lhs_type mode ty sig'
460 ; return (ty', sig') }
461 tc_infer_hs_type mode (HsDocTy ty _) = tc_infer_lhs_type mode ty
462 tc_infer_hs_type _ (HsCoreTy ty) = return (ty, typeKind ty)
463 tc_infer_hs_type mode other_ty
464 = do { kv <- newMetaKindVar
465 ; ty' <- tc_hs_type mode other_ty kv
466 ; return (ty', kv) }
467
468 ------------------------------------------
469 tc_lhs_type :: TcTyMode -> LHsType Name -> TcKind -> TcM TcType
470 tc_lhs_type mode (L span ty) exp_kind
471 = setSrcSpan span $
472 do { ty' <- tc_hs_type mode ty exp_kind
473 ; return ty' }
474
475 ------------------------------------------
476 tc_fun_type :: TcTyMode -> LHsType Name -> LHsType Name -> TcKind -> TcM TcType
477 tc_fun_type mode ty1 ty2 exp_kind = case mode_level mode of
478 TypeLevel ->
479 do { arg_rr <- newFlexiTyVarTy runtimeRepTy
480 ; res_rr <- newFlexiTyVarTy runtimeRepTy
481 ; ty1' <- tc_lhs_type mode ty1 (tYPE arg_rr)
482 ; ty2' <- tc_lhs_type mode ty2 (tYPE res_rr)
483 ; checkExpectedKind (mkFunTy ty1' ty2') liftedTypeKind exp_kind }
484 KindLevel -> -- no representation polymorphism in kinds. yet.
485 do { ty1' <- tc_lhs_type mode ty1 liftedTypeKind
486 ; ty2' <- tc_lhs_type mode ty2 liftedTypeKind
487 ; checkExpectedKind (mkFunTy ty1' ty2') liftedTypeKind exp_kind }
488
489 ------------------------------------------
490 -- See also Note [Bidirectional type checking]
491 tc_hs_type :: TcTyMode -> HsType Name -> TcKind -> TcM TcType
492 tc_hs_type mode (HsParTy ty) exp_kind = tc_lhs_type mode ty exp_kind
493 tc_hs_type mode (HsDocTy ty _) exp_kind = tc_lhs_type mode ty exp_kind
494 tc_hs_type _ ty@(HsBangTy {}) _
495 -- While top-level bangs at this point are eliminated (eg !(Maybe Int)),
496 -- other kinds of bangs are not (eg ((!Maybe) Int)). These kinds of
497 -- bangs are invalid, so fail. (#7210)
498 = failWithTc (text "Unexpected strictness annotation:" <+> ppr ty)
499 tc_hs_type _ ty@(HsRecTy _) _
500 -- Record types (which only show up temporarily in constructor
501 -- signatures) should have been removed by now
502 = failWithTc (text "Record syntax is illegal here:" <+> ppr ty)
503
504 -- This should never happen; type splices are expanded by the renamer
505 tc_hs_type _ ty@(HsSpliceTy {}) _exp_kind
506 = failWithTc (text "Unexpected type splice:" <+> ppr ty)
507
508 ---------- Functions and applications
509 tc_hs_type mode (HsFunTy ty1 ty2) exp_kind
510 = tc_fun_type mode ty1 ty2 exp_kind
511
512 tc_hs_type mode (HsOpTy ty1 (L _ op) ty2) exp_kind
513 | op `hasKey` funTyConKey
514 = tc_fun_type mode ty1 ty2 exp_kind
515
516 --------- Foralls
517 tc_hs_type mode (HsForAllTy { hst_bndrs = hs_tvs, hst_body = ty }) exp_kind
518 = fmap fst $
519 tcExplicitTKBndrs hs_tvs $ \ tvs' ->
520 -- Do not kind-generalise here! See Note [Kind generalisation]
521 -- Why exp_kind? See Note [Body kind of HsForAllTy]
522 do { ty' <- tc_lhs_type mode ty exp_kind
523 ; let bound_vars = allBoundVariables ty'
524 bndrs = mkTyVarBinders Specified tvs'
525 ; return (mkForAllTys bndrs ty', bound_vars) }
526
527 tc_hs_type mode (HsQualTy { hst_ctxt = ctxt, hst_body = ty }) exp_kind
528 | null (unLoc ctxt)
529 = tc_lhs_type mode ty exp_kind
530
531 | otherwise
532 = do { ctxt' <- tc_hs_context mode ctxt
533
534 -- See Note [Body kind of a HsQualTy]
535 ; ty' <- if isConstraintKind exp_kind
536 then tc_lhs_type mode ty constraintKind
537 else do { ek <- ekOpen -- The body kind (result of the
538 -- function) can be * or #, hence ekOpen
539 ; ty <- tc_lhs_type mode ty ek
540 ; checkExpectedKind ty liftedTypeKind exp_kind }
541
542 ; return (mkPhiTy ctxt' ty') }
543
544 --------- Lists, arrays, and tuples
545 tc_hs_type mode (HsListTy elt_ty) exp_kind
546 = do { tau_ty <- tc_lhs_type mode elt_ty liftedTypeKind
547 ; checkWiredInTyCon listTyCon
548 ; checkExpectedKind (mkListTy tau_ty) liftedTypeKind exp_kind }
549
550 tc_hs_type mode (HsPArrTy elt_ty) exp_kind
551 = do { MASSERT( isTypeLevel (mode_level mode) )
552 ; tau_ty <- tc_lhs_type mode elt_ty liftedTypeKind
553 ; checkWiredInTyCon parrTyCon
554 ; checkExpectedKind (mkPArrTy tau_ty) liftedTypeKind exp_kind }
555
556 -- See Note [Distinguishing tuple kinds] in HsTypes
557 -- See Note [Inferring tuple kinds]
558 tc_hs_type mode (HsTupleTy HsBoxedOrConstraintTuple hs_tys) exp_kind
559 -- (NB: not zonking before looking at exp_k, to avoid left-right bias)
560 | Just tup_sort <- tupKindSort_maybe exp_kind
561 = traceTc "tc_hs_type tuple" (ppr hs_tys) >>
562 tc_tuple mode tup_sort hs_tys exp_kind
563 | otherwise
564 = do { traceTc "tc_hs_type tuple 2" (ppr hs_tys)
565 ; (tys, kinds) <- mapAndUnzipM (tc_infer_lhs_type mode) hs_tys
566 ; kinds <- mapM zonkTcType kinds
567 -- Infer each arg type separately, because errors can be
568 -- confusing if we give them a shared kind. Eg Trac #7410
569 -- (Either Int, Int), we do not want to get an error saying
570 -- "the second argument of a tuple should have kind *->*"
571
572 ; let (arg_kind, tup_sort)
573 = case [ (k,s) | k <- kinds
574 , Just s <- [tupKindSort_maybe k] ] of
575 ((k,s) : _) -> (k,s)
576 [] -> (liftedTypeKind, BoxedTuple)
577 -- In the [] case, it's not clear what the kind is, so guess *
578
579 ; tys' <- sequence [ setSrcSpan loc $
580 checkExpectedKind ty kind arg_kind
581 | ((L loc _),ty,kind) <- zip3 hs_tys tys kinds ]
582
583 ; finish_tuple tup_sort tys' (map (const arg_kind) tys') exp_kind }
584
585
586 tc_hs_type mode (HsTupleTy hs_tup_sort tys) exp_kind
587 = tc_tuple mode tup_sort tys exp_kind
588 where
589 tup_sort = case hs_tup_sort of -- Fourth case dealt with above
590 HsUnboxedTuple -> UnboxedTuple
591 HsBoxedTuple -> BoxedTuple
592 HsConstraintTuple -> ConstraintTuple
593 _ -> panic "tc_hs_type HsTupleTy"
594
595
596 --------- Promoted lists and tuples
597 tc_hs_type mode (HsExplicitListTy _k tys) exp_kind
598 = do { tks <- mapM (tc_infer_lhs_type mode) tys
599 ; (taus', kind) <- unifyKinds tks
600 ; let ty = (foldr (mk_cons kind) (mk_nil kind) taus')
601 ; checkExpectedKind ty (mkListTy kind) exp_kind }
602 where
603 mk_cons k a b = mkTyConApp (promoteDataCon consDataCon) [k, a, b]
604 mk_nil k = mkTyConApp (promoteDataCon nilDataCon) [k]
605
606 tc_hs_type mode (HsExplicitTupleTy _ tys) exp_kind
607 -- using newMetaKindVar means that we force instantiations of any polykinded
608 -- types. At first, I just used tc_infer_lhs_type, but that led to #11255.
609 = do { ks <- replicateM arity newMetaKindVar
610 ; taus <- zipWithM (tc_lhs_type mode) tys ks
611 ; let kind_con = tupleTyCon Boxed arity
612 ty_con = promotedTupleDataCon Boxed arity
613 tup_k = mkTyConApp kind_con ks
614 ; checkExpectedKind (mkTyConApp ty_con (ks ++ taus)) tup_k exp_kind }
615 where
616 arity = length tys
617
618 --------- Constraint types
619 tc_hs_type mode (HsIParamTy n ty) exp_kind
620 = do { MASSERT( isTypeLevel (mode_level mode) )
621 ; ty' <- tc_lhs_type mode ty liftedTypeKind
622 ; let n' = mkStrLitTy $ hsIPNameFS n
623 ; ipClass <- tcLookupClass ipClassName
624 ; checkExpectedKind (mkClassPred ipClass [n',ty'])
625 constraintKind exp_kind }
626
627 tc_hs_type mode (HsEqTy ty1 ty2) exp_kind
628 = do { (ty1', kind1) <- tc_infer_lhs_type mode ty1
629 ; (ty2', kind2) <- tc_infer_lhs_type mode ty2
630 ; ty2'' <- checkExpectedKind ty2' kind2 kind1
631 ; eq_tc <- tcLookupTyCon eqTyConName
632 ; let ty' = mkNakedTyConApp eq_tc [kind1, ty1', ty2'']
633 ; checkExpectedKind ty' constraintKind exp_kind }
634
635 --------- Literals
636 tc_hs_type _ (HsTyLit (HsNumTy _ n)) exp_kind
637 = do { checkWiredInTyCon typeNatKindCon
638 ; checkExpectedKind (mkNumLitTy n) typeNatKind exp_kind }
639
640 tc_hs_type _ (HsTyLit (HsStrTy _ s)) exp_kind
641 = do { checkWiredInTyCon typeSymbolKindCon
642 ; checkExpectedKind (mkStrLitTy s) typeSymbolKind exp_kind }
643
644 --------- Potentially kind-polymorphic types: call the "up" checker
645 -- See Note [Future-proofing the type checker]
646 tc_hs_type mode ty@(HsTyVar {}) ek = tc_infer_hs_type_ek mode ty ek
647 tc_hs_type mode ty@(HsAppTy {}) ek = tc_infer_hs_type_ek mode ty ek
648 tc_hs_type mode ty@(HsOpTy {}) ek = tc_infer_hs_type_ek mode ty ek
649 tc_hs_type mode ty@(HsKindSig {}) ek = tc_infer_hs_type_ek mode ty ek
650 tc_hs_type mode ty@(HsCoreTy {}) ek = tc_infer_hs_type_ek mode ty ek
651
652 tc_hs_type _ (HsWildCardTy wc) exp_kind
653 = do { wc_tv <- tcWildCardOcc wc exp_kind
654 ; return (mkTyVarTy wc_tv) }
655
656 -- disposed of by renamer
657 tc_hs_type _ ty@(HsAppsTy {}) _
658 = pprPanic "tc_hs_tyep HsAppsTy" (ppr ty)
659
660 tcWildCardOcc :: HsWildCardInfo Name -> Kind -> TcM TcTyVar
661 tcWildCardOcc wc_info exp_kind
662 = do { wc_tv <- tcLookupTyVar (wildCardName wc_info)
663 -- The wildcard's kind should be an un-filled-in meta tyvar
664 ; let Just wc_kind_var = tcGetTyVar_maybe (tyVarKind wc_tv)
665 ; writeMetaTyVar wc_kind_var exp_kind
666 ; return wc_tv }
667
668 ---------------------------
669 -- | Call 'tc_infer_hs_type' and check its result against an expected kind.
670 tc_infer_hs_type_ek :: TcTyMode -> HsType Name -> TcKind -> TcM TcType
671 tc_infer_hs_type_ek mode ty ek
672 = do { (ty', k) <- tc_infer_hs_type mode ty
673 ; checkExpectedKind ty' k ek }
674
675 ---------------------------
676 tupKindSort_maybe :: TcKind -> Maybe TupleSort
677 tupKindSort_maybe k
678 | Just (k', _) <- splitCastTy_maybe k = tupKindSort_maybe k'
679 | Just k' <- coreView k = tupKindSort_maybe k'
680 | isConstraintKind k = Just ConstraintTuple
681 | isLiftedTypeKind k = Just BoxedTuple
682 | otherwise = Nothing
683
684 tc_tuple :: TcTyMode -> TupleSort -> [LHsType Name] -> TcKind -> TcM TcType
685 tc_tuple mode tup_sort tys exp_kind
686 = do { arg_kinds <- case tup_sort of
687 BoxedTuple -> return (nOfThem arity liftedTypeKind)
688 UnboxedTuple -> do { rrs <- newFlexiTyVarTys arity runtimeRepTy
689 ; return $ map tYPE rrs }
690 ConstraintTuple -> return (nOfThem arity constraintKind)
691 ; tau_tys <- zipWithM (tc_lhs_type mode) tys arg_kinds
692 ; finish_tuple tup_sort tau_tys arg_kinds exp_kind }
693 where
694 arity = length tys
695
696 finish_tuple :: TupleSort
697 -> [TcType] -- ^ argument types
698 -> [TcKind] -- ^ of these kinds
699 -> TcKind -- ^ expected kind of the whole tuple
700 -> TcM TcType
701 finish_tuple tup_sort tau_tys tau_kinds exp_kind
702 = do { traceTc "finish_tuple" (ppr res_kind $$ ppr tau_kinds $$ ppr exp_kind)
703 ; let arg_tys = case tup_sort of
704 -- See also Note [Unboxed tuple RuntimeRep vars] in TyCon
705 UnboxedTuple -> map (getRuntimeRepFromKind "finish_tuple") tau_kinds
706 ++ tau_tys
707 BoxedTuple -> tau_tys
708 ConstraintTuple -> tau_tys
709 ; tycon <- case tup_sort of
710 ConstraintTuple
711 | arity > mAX_CTUPLE_SIZE
712 -> failWith (bigConstraintTuple arity)
713 | otherwise -> tcLookupTyCon (cTupleTyConName arity)
714 BoxedTuple -> do { let tc = tupleTyCon Boxed arity
715 ; checkWiredInTyCon tc
716 ; return tc }
717 UnboxedTuple -> return (tupleTyCon Unboxed arity)
718 ; checkExpectedKind (mkTyConApp tycon arg_tys) res_kind exp_kind }
719 where
720 arity = length tau_tys
721 res_kind = case tup_sort of
722 UnboxedTuple -> unboxedTupleKind
723 BoxedTuple -> liftedTypeKind
724 ConstraintTuple -> constraintKind
725
726 bigConstraintTuple :: Arity -> MsgDoc
727 bigConstraintTuple arity
728 = hang (text "Constraint tuple arity too large:" <+> int arity
729 <+> parens (text "max arity =" <+> int mAX_CTUPLE_SIZE))
730 2 (text "Instead, use a nested tuple")
731
732 ---------------------------
733 -- | Apply a type of a given kind to a list of arguments. This instantiates
734 -- invisible parameters as necessary. However, it does *not* necessarily
735 -- apply all the arguments, if the kind runs out of binders.
736 -- Never calls 'matchExpectedFunKind'; when the kind runs out of binders,
737 -- this stops processing.
738 -- This takes an optional @VarEnv Kind@ which maps kind variables to kinds.
739 -- These kinds should be used to instantiate invisible kind variables;
740 -- they come from an enclosing class for an associated type/data family.
741 -- This version will instantiate all invisible arguments left over after
742 -- the visible ones. Used only when typechecking type/data family patterns
743 -- (where we need to instantiate all remaining invisible parameters; for
744 -- example, consider @type family F :: k where F = Int; F = Maybe@. We
745 -- need to instantiate the @k@.)
746 tcInferArgs :: Outputable fun
747 => fun -- ^ the function
748 -> [TyConBinder] -- ^ function kind's binders
749 -> Maybe (VarEnv Kind) -- ^ possibly, kind info (see above)
750 -> [LHsType Name] -- ^ args
751 -> TcM (TCvSubst, [TyBinder], [TcType], [LHsType Name], Int)
752 -- ^ (instantiating subst, un-insted leftover binders,
753 -- typechecked args, untypechecked args, n)
754 tcInferArgs fun tc_binders mb_kind_info args
755 = do { let binders = tyConBindersTyBinders tc_binders -- UGH!
756 ; (subst, leftover_binders, args', leftovers, n)
757 <- tc_infer_args typeLevelMode fun binders mb_kind_info args 1
758 -- now, we need to instantiate any remaining invisible arguments
759 ; let (invis_bndrs, other_binders) = break isVisibleBinder leftover_binders
760 ; (subst', invis_args)
761 <- tcInstBindersX subst mb_kind_info invis_bndrs
762 ; return ( subst'
763 , other_binders
764 , args' `chkAppend` invis_args
765 , leftovers, n ) }
766
767 -- | See comments for 'tcInferArgs'. But this version does not instantiate
768 -- any remaining invisible arguments.
769 tc_infer_args :: Outputable fun
770 => TcTyMode
771 -> fun -- ^ the function
772 -> [TyBinder] -- ^ function kind's binders (zonked)
773 -> Maybe (VarEnv Kind) -- ^ possibly, kind info (see above)
774 -> [LHsType Name] -- ^ args
775 -> Int -- ^ number to start arg counter at
776 -> TcM (TCvSubst, [TyBinder], [TcType], [LHsType Name], Int)
777 tc_infer_args mode orig_ty binders mb_kind_info orig_args n0
778 = go emptyTCvSubst binders orig_args n0 []
779 where
780 go subst binders [] n acc
781 = return ( subst, binders, reverse acc, [], n )
782 -- when we call this when checking type family patterns, we really
783 -- do want to instantiate all invisible arguments. During other
784 -- typechecking, we don't.
785
786 go subst (binder:binders) all_args@(arg:args) n acc
787 | isInvisibleBinder binder
788 = do { traceTc "tc_infer_args (invis)" (ppr binder)
789 ; (subst', arg') <- tcInstBinderX mb_kind_info subst binder
790 ; go subst' binders all_args n (arg' : acc) }
791
792 | otherwise
793 = do { traceTc "tc_infer_args (vis)" (ppr binder $$ ppr arg)
794 ; arg' <- addErrCtxt (funAppCtxt orig_ty arg n) $
795 tc_lhs_type mode arg (substTyUnchecked subst $
796 tyBinderType binder)
797 ; let subst' = extendTvSubstBinder subst binder arg'
798 ; go subst' binders args (n+1) (arg' : acc) }
799
800 go subst [] all_args n acc
801 = return (subst, [], reverse acc, all_args, n)
802
803 -- | Applies a type to a list of arguments.
804 -- Always consumes all the arguments, using 'matchExpectedFunKind' as
805 -- necessary. If you wish to apply a type to a list of HsTypes, this is
806 -- your function.
807 -- Used for type-checking types only.
808 tcInferApps :: Outputable fun
809 => TcTyMode
810 -> fun -- ^ Function (for printing only)
811 -> TcType -- ^ Function (could be knot-tied)
812 -> TcKind -- ^ Function kind (zonked)
813 -> [LHsType Name] -- ^ Args
814 -> TcM (TcType, TcKind) -- ^ (f args, result kind)
815 tcInferApps mode orig_ty ty ki args = go ty ki args 1
816 where
817 go fun fun_kind [] _ = return (fun, fun_kind)
818 go fun fun_kind args n
819 | let (binders, res_kind) = splitPiTys fun_kind
820 , not (null binders)
821 = do { (subst, leftover_binders, args', leftover_args, n')
822 <- tc_infer_args mode orig_ty binders Nothing args n
823 ; let fun_kind' = substTyUnchecked subst $
824 mkPiTys leftover_binders res_kind
825 ; go (mkNakedAppTys fun args') fun_kind' leftover_args n' }
826
827 go fun fun_kind all_args@(arg:args) n
828 = do { (co, arg_k, res_k) <- matchExpectedFunKind (length all_args)
829 fun fun_kind
830 ; arg' <- addErrCtxt (funAppCtxt orig_ty arg n) $
831 tc_lhs_type mode arg arg_k
832 ; go (mkNakedAppTy (fun `mkNakedCastTy` co) arg')
833 res_k args (n+1) }
834
835 --------------------------
836 checkExpectedKind :: TcType -- the type whose kind we're checking
837 -> TcKind -- the known kind of that type, k
838 -> TcKind -- the expected kind, exp_kind
839 -> TcM TcType -- a possibly-inst'ed, casted type :: exp_kind
840 -- Instantiate a kind (if necessary) and then call unifyType
841 -- (checkExpectedKind ty act_kind exp_kind)
842 -- checks that the actual kind act_kind is compatible
843 -- with the expected kind exp_kind
844 checkExpectedKind ty act_kind exp_kind
845 = do { (ty', act_kind') <- instantiate ty act_kind exp_kind
846 ; let origin = TypeEqOrigin { uo_actual = act_kind'
847 , uo_expected = mkCheckExpType exp_kind
848 , uo_thing = Just $ mkTypeErrorThing ty'
849 }
850 ; co_k <- uType origin KindLevel act_kind' exp_kind
851 ; traceTc "checkExpectedKind" (vcat [ ppr act_kind
852 , ppr exp_kind
853 , ppr co_k ])
854 ; let result_ty = ty' `mkNakedCastTy` co_k
855 ; return result_ty }
856 where
857 -- we need to make sure that both kinds have the same number of implicit
858 -- foralls out front. If the actual kind has more, instantiate accordingly.
859 -- Otherwise, just pass the type & kind through -- the errors are caught
860 -- in unifyType.
861 instantiate :: TcType -- the type
862 -> TcKind -- of this kind
863 -> TcKind -- but expected to be of this one
864 -> TcM ( TcType -- the inst'ed type
865 , TcKind ) -- its new kind
866 instantiate ty act_ki exp_ki
867 = let (exp_bndrs, _) = splitPiTysInvisible exp_ki in
868 instantiateTyN (length exp_bndrs) ty act_ki
869
870 -- | Instantiate a type to have at most @n@ invisible arguments.
871 instantiateTyN :: Int -- ^ @n@
872 -> TcType -- ^ the type
873 -> TcKind -- ^ its kind
874 -> TcM (TcType, TcKind) -- ^ The inst'ed type with kind
875 instantiateTyN n ty ki
876 = let (bndrs, inner_ki) = splitPiTysInvisible ki
877 num_to_inst = length bndrs - n
878 -- NB: splitAt is forgiving with invalid numbers
879 (inst_bndrs, leftover_bndrs) = splitAt num_to_inst bndrs
880 in
881 if num_to_inst <= 0 then return (ty, ki) else
882 do { (subst, inst_args) <- tcInstBinders inst_bndrs
883 ; let rebuilt_ki = mkPiTys leftover_bndrs inner_ki
884 ki' = substTy subst rebuilt_ki
885 ; return (mkNakedAppTys ty inst_args, ki') }
886
887 ---------------------------
888 tcHsContext :: LHsContext Name -> TcM [PredType]
889 tcHsContext = tc_hs_context typeLevelMode
890
891 tcLHsPredType :: LHsType Name -> TcM PredType
892 tcLHsPredType = tc_lhs_pred typeLevelMode
893
894 tc_hs_context :: TcTyMode -> LHsContext Name -> TcM [PredType]
895 tc_hs_context mode ctxt = mapM (tc_lhs_pred mode) (unLoc ctxt)
896
897 tc_lhs_pred :: TcTyMode -> LHsType Name -> TcM PredType
898 tc_lhs_pred mode pred = tc_lhs_type mode pred constraintKind
899
900 ---------------------------
901 tcTyVar :: TcTyMode -> Name -> TcM (TcType, TcKind)
902 -- See Note [Type checking recursive type and class declarations]
903 -- in TcTyClsDecls
904 tcTyVar mode name -- Could be a tyvar, a tycon, or a datacon
905 = do { traceTc "lk1" (ppr name)
906 ; thing <- tcLookup name
907 ; case thing of
908 ATyVar _ tv -> return (mkTyVarTy tv, tyVarKind tv)
909
910 ATcTyCon tc_tc -> do { -- See Note [GADT kind self-reference]
911 unless
912 (isTypeLevel (mode_level mode))
913 (promotionErr name TyConPE)
914 ; check_tc tc_tc
915 ; tc <- get_loopy_tc name tc_tc
916 ; handle_tyfams tc tc_tc }
917 -- mkNakedTyConApp: see Note [Type-checking inside the knot]
918 -- NB: we really should check if we're at the kind level
919 -- and if the tycon is promotable if -XNoTypeInType is set.
920 -- But this is a terribly large amount of work! Not worth it.
921
922 AGlobal (ATyCon tc)
923 -> do { check_tc tc
924 ; handle_tyfams tc tc }
925
926 AGlobal (AConLike (RealDataCon dc))
927 -> do { data_kinds <- xoptM LangExt.DataKinds
928 ; unless (data_kinds || specialPromotedDc dc) $
929 promotionErr name NoDataKindsDC
930 ; type_in_type <- xoptM LangExt.TypeInType
931 ; unless ( type_in_type ||
932 ( isTypeLevel (mode_level mode) &&
933 isLegacyPromotableDataCon dc ) ||
934 ( isKindLevel (mode_level mode) &&
935 specialPromotedDc dc ) ) $
936 promotionErr name NoTypeInTypeDC
937 ; let tc = promoteDataCon dc
938 ; return (mkNakedTyConApp tc [], tyConKind tc) }
939
940 APromotionErr err -> promotionErr name err
941
942 _ -> wrongThingErr "type" thing name }
943 where
944 check_tc :: TyCon -> TcM ()
945 check_tc tc = do { type_in_type <- xoptM LangExt.TypeInType
946 ; data_kinds <- xoptM LangExt.DataKinds
947 ; unless (isTypeLevel (mode_level mode) ||
948 data_kinds ||
949 isKindTyCon tc) $
950 promotionErr name NoDataKindsTC
951 ; unless (isTypeLevel (mode_level mode) ||
952 type_in_type ||
953 isLegacyPromotableTyCon tc) $
954 promotionErr name NoTypeInTypeTC }
955
956 -- if we are type-checking a type family tycon, we must instantiate
957 -- any invisible arguments right away. Otherwise, we get #11246
958 handle_tyfams :: TyCon -- the tycon to instantiate (might be loopy)
959 -> TyCon -- a non-loopy version of the tycon
960 -> TcM (TcType, TcKind)
961 handle_tyfams tc tc_tc
962 | mightBeUnsaturatedTyCon tc_tc
963 = do { traceTc "tcTyVar2a" (ppr tc_tc $$ ppr tc_kind)
964 ; return (ty, tc_kind) }
965
966 | otherwise
967 = do { (tc_ty, kind) <- instantiateTyN 0 ty tc_kind
968 -- tc and tc_ty must not be traced here, because that would
969 -- force the evaluation of a potentially knot-tied variable (tc),
970 -- and the typechecker would hang, as per #11708
971 ; traceTc "tcTyVar2b" (vcat [ ppr tc_tc <+> dcolon <+> ppr tc_kind
972 , ppr kind ])
973 ; return (tc_ty, kind) }
974 where
975 ty = mkNakedTyConApp tc []
976 tc_kind = tyConKind tc_tc
977
978 get_loopy_tc :: Name -> TyCon -> TcM TyCon
979 -- Return the knot-tied global TyCon if there is one
980 -- Otherwise the local TcTyCon; we must be doing kind checking
981 -- but we still want to return a TyCon of some sort to use in
982 -- error messages
983 get_loopy_tc name tc_tc
984 = do { env <- getGblEnv
985 ; case lookupNameEnv (tcg_type_env env) name of
986 Just (ATyCon tc) -> return tc
987 _ -> do { traceTc "lk1 (loopy)" (ppr name)
988 ; return tc_tc } }
989
990 tcClass :: Name -> TcM (Class, TcKind)
991 tcClass cls -- Must be a class
992 = do { thing <- tcLookup cls
993 ; case thing of
994 ATcTyCon tc -> return (aThingErr "tcClass" cls, tyConKind tc)
995 AGlobal (ATyCon tc)
996 | Just cls <- tyConClass_maybe tc
997 -> return (cls, tyConKind tc)
998 _ -> wrongThingErr "class" thing cls }
999
1000
1001 aThingErr :: String -> Name -> b
1002 -- The type checker for types is sometimes called simply to
1003 -- do *kind* checking; and in that case it ignores the type
1004 -- returned. Which is a good thing since it may not be available yet!
1005 aThingErr str x = pprPanic "AThing evaluated unexpectedly" (text str <+> ppr x)
1006
1007 {-
1008 Note [Type-checking inside the knot]
1009 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1010 Suppose we are checking the argument types of a data constructor. We
1011 must zonk the types before making the DataCon, because once built we
1012 can't change it. So we must traverse the type.
1013
1014 BUT the parent TyCon is knot-tied, so we can't look at it yet.
1015
1016 So we must be careful not to use "smart constructors" for types that
1017 look at the TyCon or Class involved.
1018
1019 * Hence the use of mkNakedXXX functions. These do *not* enforce
1020 the invariants (for example that we use (FunTy s t) rather
1021 than (TyConApp (->) [s,t])).
1022
1023 * The zonking functions establish invariants (even zonkTcType, a change from
1024 previous behaviour). So we must never inspect the result of a
1025 zonk that might mention a knot-tied TyCon. This is generally OK
1026 because we zonk *kinds* while kind-checking types. And the TyCons
1027 in kinds shouldn't be knot-tied, because they come from a previous
1028 mutually recursive group.
1029
1030 * TcHsSyn.zonkTcTypeToType also can safely check/establish
1031 invariants.
1032
1033 This is horribly delicate. I hate it. A good example of how
1034 delicate it is can be seen in Trac #7903.
1035
1036 Note [GADT kind self-reference]
1037 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1038
1039 A promoted type cannot be used in the body of that type's declaration.
1040 Trac #11554 shows this example, which made GHC loop:
1041
1042 import Data.Kind
1043 data P (x :: k) = Q
1044 data A :: Type where
1045 B :: forall (a :: A). P a -> A
1046
1047 In order to check the constructor B, we need have the promoted type A, but in
1048 order to get that promoted type, B must first be checked. To prevent looping, a
1049 TyConPE promotion error is given when tcTyVar checks an ATcTyCon in kind mode.
1050 Any ATcTyCon is a TyCon being defined in the current recursive group (see data
1051 type decl for TcTyThing), and all such TyCons are illegal in kinds.
1052
1053 Trac #11962 proposes checking the head of a data declaration separately from
1054 its constructors. This would allow the example above to pass.
1055
1056 Note [Body kind of a HsForAllTy]
1057 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1058 The body of a forall is usually a type, but in principle
1059 there's no reason to prohibit *unlifted* types.
1060 In fact, GHC can itself construct a function with an
1061 unboxed tuple inside a for-all (via CPR analyis; see
1062 typecheck/should_compile/tc170).
1063
1064 Moreover in instance heads we get forall-types with
1065 kind Constraint.
1066
1067 It's tempting to check that the body kind is either * or #. But this is
1068 wrong. For example:
1069
1070 class C a b
1071 newtype N = Mk Foo deriving (C a)
1072
1073 We're doing newtype-deriving for C. But notice how `a` isn't in scope in
1074 the predicate `C a`. So we quantify, yielding `forall a. C a` even though
1075 `C a` has kind `* -> Constraint`. The `forall a. C a` is a bit cheeky, but
1076 convenient. Bottom line: don't check for * or # here.
1077
1078 Note [Body kind of a HsQualTy]
1079 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1080 If ctxt is non-empty, the HsQualTy really is a /function/, so the
1081 kind of the result really is '*', and in that case the kind of the
1082 body-type can be lifted or unlifted.
1083
1084 However, consider
1085 instance Eq a => Eq [a] where ...
1086 or
1087 f :: (Eq a => Eq [a]) => blah
1088 Here both body-kind of the HsQualTy is Constraint rather than *.
1089 Rather crudely we tell the difference by looking at exp_kind. It's
1090 very convenient to typecheck instance types like any other HsSigType.
1091
1092 Admittedly the '(Eq a => Eq [a]) => blah' case is erroneous, but it's
1093 better to reject in checkValidType. If we say that the body kind
1094 should be '*' we risk getting TWO error messages, one saying that Eq
1095 [a] doens't have kind '*', and one saying that we need a Constraint to
1096 the left of the outer (=>).
1097
1098 How do we figure out the right body kind? Well, it's a bit of a
1099 kludge: I just look at the expected kind. If it's Constraint, we
1100 must be in this instance situation context. It's a kludge because it
1101 wouldn't work if any unification was involved to compute that result
1102 kind -- but it isn't. (The true way might be to use the 'mode'
1103 parameter, but that seemed like a sledgehammer to crack a nut.)
1104
1105 Note [Inferring tuple kinds]
1106 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1107 Give a tuple type (a,b,c), which the parser labels as HsBoxedOrConstraintTuple,
1108 we try to figure out whether it's a tuple of kind * or Constraint.
1109 Step 1: look at the expected kind
1110 Step 2: infer argument kinds
1111
1112 If after Step 2 it's not clear from the arguments that it's
1113 Constraint, then it must be *. Once having decided that we re-check
1114 the Check the arguments again to give good error messages
1115 in eg. `(Maybe, Maybe)`
1116
1117 Note that we will still fail to infer the correct kind in this case:
1118
1119 type T a = ((a,a), D a)
1120 type family D :: Constraint -> Constraint
1121
1122 While kind checking T, we do not yet know the kind of D, so we will default the
1123 kind of T to * -> *. It works if we annotate `a` with kind `Constraint`.
1124
1125 Note [Desugaring types]
1126 ~~~~~~~~~~~~~~~~~~~~~~~
1127 The type desugarer is phase 2 of dealing with HsTypes. Specifically:
1128
1129 * It transforms from HsType to Type
1130
1131 * It zonks any kinds. The returned type should have no mutable kind
1132 or type variables (hence returning Type not TcType):
1133 - any unconstrained kind variables are defaulted to (Any *) just
1134 as in TcHsSyn.
1135 - there are no mutable type variables because we are
1136 kind-checking a type
1137 Reason: the returned type may be put in a TyCon or DataCon where
1138 it will never subsequently be zonked.
1139
1140 You might worry about nested scopes:
1141 ..a:kappa in scope..
1142 let f :: forall b. T '[a,b] -> Int
1143 In this case, f's type could have a mutable kind variable kappa in it;
1144 and we might then default it to (Any *) when dealing with f's type
1145 signature. But we don't expect this to happen because we can't get a
1146 lexically scoped type variable with a mutable kind variable in it. A
1147 delicate point, this. If it becomes an issue we might need to
1148 distinguish top-level from nested uses.
1149
1150 Moreover
1151 * it cannot fail,
1152 * it does no unifications
1153 * it does no validity checking, except for structural matters, such as
1154 (a) spurious ! annotations.
1155 (b) a class used as a type
1156
1157 Note [Kind of a type splice]
1158 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1159 Consider these terms, each with TH type splice inside:
1160 [| e1 :: Maybe $(..blah..) |]
1161 [| e2 :: $(..blah..) |]
1162 When kind-checking the type signature, we'll kind-check the splice
1163 $(..blah..); we want to give it a kind that can fit in any context,
1164 as if $(..blah..) :: forall k. k.
1165
1166 In the e1 example, the context of the splice fixes kappa to *. But
1167 in the e2 example, we'll desugar the type, zonking the kind unification
1168 variables as we go. When we encounter the unconstrained kappa, we
1169 want to default it to '*', not to (Any *).
1170
1171
1172 Help functions for type applications
1173 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1174 -}
1175
1176 addTypeCtxt :: LHsType Name -> TcM a -> TcM a
1177 -- Wrap a context around only if we want to show that contexts.
1178 -- Omit invisble ones and ones user's won't grok
1179 addTypeCtxt (L _ ty) thing
1180 = addErrCtxt doc thing
1181 where
1182 doc = text "In the type" <+> quotes (ppr ty)
1183
1184 {-
1185 ************************************************************************
1186 * *
1187 Type-variable binders
1188 %* *
1189 %************************************************************************
1190
1191 Note [Scope-check inferred kinds]
1192 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1193 Consider
1194
1195 data SameKind :: k -> k -> *
1196 foo :: forall a (b :: Proxy a) (c :: Proxy d). SameKind b c
1197
1198 d has no binding site. So it gets bound implicitly, at the top. The
1199 problem is that d's kind mentions `a`. So it's all ill-scoped.
1200
1201 The way we check for this is to gather all variables *bound* in a
1202 type variable's scope. The type variable's kind should not mention
1203 any of these variables. That is, d's kind can't mention a, b, or c.
1204 We can't just check to make sure that d's kind is in scope, because
1205 we might be about to kindGeneralize.
1206
1207 A little messy, but it works.
1208
1209 Note [Dependent LHsQTyVars]
1210 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
1211 We track (in the renamer) which explicitly bound variables in a
1212 LHsQTyVars are manifestly dependent; only precisely these variables
1213 may be used within the LHsQTyVars. We must do this so that kcHsTyVarBndrs
1214 can produce the right TcTyBinders, and tell Anon vs. Named. Earlier,
1215 I thought it would work simply to do a free-variable check during
1216 kcHsTyVarBndrs, but this is bogus, because there may be unsolved
1217 equalities about. And we don't want to eagerly solve the equalities,
1218 because we may get further information after kcHsTyVarBndrs is called.
1219 (Recall that kcHsTyVarBndrs is usually called from getInitialKind.
1220 The only other case is in kcConDecl.) This is what implements the rule
1221 that all variables intended to be dependent must be manifestly so.
1222
1223 Sidenote: It's quite possible that later, we'll consider (t -> s)
1224 as a degenerate case of some (pi (x :: t) -> s) and then this will
1225 all get more permissive.
1226
1227 -}
1228
1229 tcWildCardBinders :: [Name]
1230 -> ([(Name, TcTyVar)] -> TcM a)
1231 -> TcM a
1232 tcWildCardBinders = tcWildCardBindersX new_tv
1233 where
1234 new_tv name = do { kind <- newMetaKindVar
1235 ; newSkolemTyVar name kind }
1236
1237 tcWildCardBindersX :: (Name -> TcM TcTyVar)
1238 -> [Name]
1239 -> ([(Name, TcTyVar)] -> TcM a)
1240 -> TcM a
1241 tcWildCardBindersX new_wc wc_names thing_inside
1242 = do { wcs <- mapM new_wc wc_names
1243 ; let wc_prs = wc_names `zip` wcs
1244 ; tcExtendTyVarEnv2 wc_prs $
1245 thing_inside wc_prs }
1246
1247 -- | Kind-check a 'LHsQTyVars'. If the decl under consideration has a complete,
1248 -- user-supplied kind signature (CUSK), generalise the result.
1249 -- Used in 'getInitialKind' (for tycon kinds and other kinds)
1250 -- and in kind-checking (but not for tycon kinds, which are checked with
1251 -- tcTyClDecls). See also Note [Complete user-supplied kind signatures] in
1252 -- HsDecls.
1253 --
1254 -- This function does not do telescope checking.
1255 kcHsTyVarBndrs :: Name -- ^ of the thing being checked
1256 -> Bool -- ^ True <=> the decl being checked has a CUSK
1257 -> Bool -- ^ True <=> the decl is an open type/data family
1258 -> Bool -- ^ True <=> all the hsq_implicit are *kind* vars
1259 -- (will give these kind * if -XNoTypeInType)
1260 -> LHsQTyVars Name
1261 -> TcM (Kind, r) -- ^ the result kind, possibly with other info
1262 -> TcM (Bool -> TcTyCon, r)
1263 -- ^ a way to make a TcTyCon, with the other info.
1264 -- The Bool says whether the tycon can be unsaturated.
1265 kcHsTyVarBndrs name cusk open_fam all_kind_vars
1266 (HsQTvs { hsq_implicit = kv_ns, hsq_explicit = hs_tvs
1267 , hsq_dependent = dep_names }) thing_inside
1268 | cusk
1269 = do { kv_kinds <- mk_kv_kinds
1270 ; let scoped_kvs = zipWith mk_skolem_tv kv_ns kv_kinds
1271 ; tcExtendTyVarEnv2 (kv_ns `zip` scoped_kvs) $
1272 do { (tc_binders, res_kind, stuff) <- solveEqualities $
1273 bind_telescope hs_tvs thing_inside
1274
1275 -- Now, because we're in a CUSK, quantify over the mentioned
1276 -- kind vars, in dependency order.
1277 ; tc_binders <- mapM zonkTyConBinder tc_binders
1278 ; res_kind <- zonkTcType res_kind
1279 ; let tc_tvs = binderVars tc_binders
1280 qkvs = tyCoVarsOfTypeWellScoped (mkTyConKind tc_binders res_kind)
1281 -- the visibility of tvs doesn't matter here; we just
1282 -- want the free variables not to include the tvs
1283
1284 -- If there are any meta-tvs left, the user has
1285 -- lied about having a CUSK. Error.
1286 ; let (meta_tvs, good_tvs) = partition isMetaTyVar qkvs
1287 ; when (not (null meta_tvs)) $
1288 report_non_cusk_tvs (qkvs ++ tc_tvs)
1289
1290 -- If any of the scoped_kvs aren't actually mentioned in a binder's
1291 -- kind (or the return kind), then we're in the CUSK case from
1292 -- Note [Free-floating kind vars]
1293 ; let all_tc_tvs = good_tvs ++ tc_tvs
1294 all_mentioned_tvs = mapUnionVarSet (tyCoVarsOfType . tyVarKind)
1295 all_tc_tvs
1296 `unionVarSet` tyCoVarsOfType res_kind
1297 unmentioned_kvs = filterOut (`elemVarSet` all_mentioned_tvs)
1298 scoped_kvs
1299 ; reportFloatingKvs name all_tc_tvs unmentioned_kvs
1300
1301 ; let final_binders = map (mkNamedTyConBinder Specified) good_tvs
1302 ++ tc_binders
1303 mk_tctc unsat = mkTcTyCon name final_binders res_kind
1304 unsat (scoped_kvs ++ tc_tvs)
1305 -- the tvs contain the binders already
1306 -- in scope from an enclosing class, but
1307 -- re-adding tvs to the env't doesn't cause
1308 -- harm
1309 ; return ( mk_tctc, stuff ) }}
1310
1311 | otherwise
1312 = do { kv_kinds <- mk_kv_kinds
1313 ; scoped_kvs <- zipWithM newSigTyVar kv_ns kv_kinds
1314 -- the names must line up in splitTelescopeTvs
1315 ; (binders, res_kind, stuff)
1316 <- tcExtendTyVarEnv2 (kv_ns `zip` scoped_kvs) $
1317 bind_telescope hs_tvs thing_inside
1318 ; let -- NB: Don't add scoped_kvs to tyConTyVars, because they
1319 -- must remain lined up with the binders
1320 mk_tctc unsat = mkTcTyCon name binders res_kind unsat
1321 (scoped_kvs ++ binderVars binders)
1322 ; return (mk_tctc, stuff) }
1323 where
1324 -- if -XNoTypeInType and we know all the implicits are kind vars,
1325 -- just give the kind *. This prevents test
1326 -- dependent/should_fail/KindLevelsB from compiling, as it should
1327 mk_kv_kinds :: TcM [Kind]
1328 mk_kv_kinds = do { typeintype <- xoptM LangExt.TypeInType
1329 ; if not typeintype && all_kind_vars
1330 then return (map (const liftedTypeKind) kv_ns)
1331 else mapM (const newMetaKindVar) kv_ns }
1332
1333 -- there may be dependency between the explicit "ty" vars. So, we have
1334 -- to handle them one at a time.
1335 bind_telescope :: [LHsTyVarBndr Name]
1336 -> TcM (Kind, r)
1337 -> TcM ([TyConBinder], TcKind, r)
1338 bind_telescope [] thing
1339 = do { (res_kind, stuff) <- thing
1340 ; return ([], res_kind, stuff) }
1341 bind_telescope (L _ hs_tv : hs_tvs) thing
1342 = do { tv_pair@(tv, _) <- kc_hs_tv hs_tv
1343 -- NB: Bring all tvs into scope, even non-dependent ones,
1344 -- as they're needed in type synonyms, data constructors, etc.
1345 ; (binders, res_kind, stuff) <- bind_unless_scoped tv_pair $
1346 bind_telescope hs_tvs $
1347 thing
1348 -- See Note [Dependent LHsQTyVars]
1349 ; let new_binder | hsTyVarName hs_tv `elemNameSet` dep_names
1350 = mkNamedTyConBinder Required tv
1351 | otherwise
1352 = mkAnonTyConBinder tv
1353 ; return ( new_binder : binders
1354 , res_kind, stuff ) }
1355
1356 -- | Bind the tyvar in the env't unless the bool is True
1357 bind_unless_scoped :: (TcTyVar, Bool) -> TcM a -> TcM a
1358 bind_unless_scoped (_, True) thing_inside = thing_inside
1359 bind_unless_scoped (tv, False) thing_inside
1360 = tcExtendTyVarEnv [tv] thing_inside
1361
1362 kc_hs_tv :: HsTyVarBndr Name -> TcM (TcTyVar, Bool)
1363 kc_hs_tv (UserTyVar (L _ name))
1364 = do { tv_pair@(tv, scoped) <- tcHsTyVarName Nothing name
1365
1366 -- Open type/data families default their variables to kind *.
1367 ; when (open_fam && not scoped) $ -- (don't default class tyvars)
1368 discardResult $ unifyKind (Just (mkTyVarTy tv)) liftedTypeKind
1369 (tyVarKind tv)
1370
1371 ; return tv_pair }
1372
1373 kc_hs_tv (KindedTyVar (L _ name) lhs_kind)
1374 = do { kind <- tcLHsKind lhs_kind
1375 ; tcHsTyVarName (Just kind) name }
1376
1377 report_non_cusk_tvs all_tvs
1378 = do { all_tvs <- mapM zonkTyCoVarKind all_tvs
1379 ; let (_, tidy_tvs) = tidyOpenTyCoVars emptyTidyEnv all_tvs
1380 (meta_tvs, other_tvs) = partition isMetaTyVar tidy_tvs
1381
1382 ; addErr $
1383 vcat [ text "You have written a *complete user-suppled kind signature*,"
1384 , hang (text "but the following variable" <> plural meta_tvs <+>
1385 isOrAre meta_tvs <+> text "undetermined:")
1386 2 (vcat (map pp_tv meta_tvs))
1387 , text "Perhaps add a kind signature."
1388 , hang (text "Inferred kinds of user-written variables:")
1389 2 (vcat (map pp_tv other_tvs)) ] }
1390 where
1391 pp_tv tv = ppr tv <+> dcolon <+> ppr (tyVarKind tv)
1392
1393
1394 tcImplicitTKBndrs :: [Name]
1395 -> TcM (a, TyVarSet) -- vars are bound somewhere in the scope
1396 -- see Note [Scope-check inferred kinds]
1397 -> TcM ([TcTyVar], a)
1398 tcImplicitTKBndrs = tcImplicitTKBndrsX (tcHsTyVarName Nothing)
1399
1400 -- | Convenient specialization
1401 tcImplicitTKBndrsType :: [Name]
1402 -> TcM Type
1403 -> TcM ([TcTyVar], Type)
1404 tcImplicitTKBndrsType var_ns thing_inside
1405 = tcImplicitTKBndrs var_ns $
1406 do { res_ty <- thing_inside
1407 ; return (res_ty, allBoundVariables res_ty) }
1408
1409 -- this more general variant is needed in tcHsPatSigType.
1410 -- See Note [Pattern signature binders]
1411 tcImplicitTKBndrsX :: (Name -> TcM (TcTyVar, Bool)) -- new_tv function
1412 -> [Name]
1413 -> TcM (a, TyVarSet)
1414 -> TcM ([TcTyVar], a)
1415 -- Returned TcTyVars have the supplied Names
1416 -- i.e. no cloning of fresh names
1417 tcImplicitTKBndrsX new_tv var_ns thing_inside
1418 = do { tkvs_pairs <- mapM new_tv var_ns
1419 ; let must_scope_tkvs = [ tkv | (tkv, False) <- tkvs_pairs ]
1420 tkvs = map fst tkvs_pairs
1421 ; (result, bound_tvs) <- tcExtendTyVarEnv must_scope_tkvs $
1422 thing_inside
1423
1424 -- it's possible that we guessed the ordering of variables
1425 -- wrongly. Adjust.
1426 ; tkvs <- mapM zonkTyCoVarKind tkvs
1427 ; let extra = text "NB: Implicitly-bound variables always come" <+>
1428 text "before other ones."
1429 ; checkValidInferredKinds tkvs bound_tvs extra
1430
1431 ; let final_tvs = toposortTyVars tkvs
1432 ; traceTc "tcImplicitTKBndrs" (ppr var_ns $$ ppr final_tvs)
1433
1434 ; return (final_tvs, result) }
1435
1436 tcExplicitTKBndrs :: [LHsTyVarBndr Name]
1437 -> ([TyVar] -> TcM (a, TyVarSet))
1438 -- ^ Thing inside returns the set of variables bound
1439 -- in the scope. See Note [Scope-check inferred kinds]
1440 -> TcM (a, TyVarSet) -- ^ returns augmented bound vars
1441 -- No cloning: returned TyVars have the same Name as the incoming LHsTyVarBndrs
1442 tcExplicitTKBndrs orig_hs_tvs thing_inside
1443 = tcExplicitTKBndrsX newSkolemTyVar orig_hs_tvs thing_inside
1444
1445 tcExplicitTKBndrsX :: (Name -> Kind -> TcM TyVar)
1446 -> [LHsTyVarBndr Name]
1447 -> ([TyVar] -> TcM (a, TyVarSet))
1448 -- ^ Thing inside returns the set of variables bound
1449 -- in the scope. See Note [Scope-check inferred kinds]
1450 -> TcM (a, TyVarSet) -- ^ returns augmented bound vars
1451 tcExplicitTKBndrsX new_tv orig_hs_tvs thing_inside
1452 = go orig_hs_tvs $ \ tvs ->
1453 do { (result, bound_tvs) <- thing_inside tvs
1454
1455 -- Issue an error if the ordering is bogus.
1456 -- See Note [Bad telescopes] in TcValidity.
1457 ; tvs <- checkZonkValidTelescope (interppSP orig_hs_tvs) tvs empty
1458 ; checkValidInferredKinds tvs bound_tvs empty
1459
1460 ; traceTc "tcExplicitTKBndrs" $
1461 vcat [ text "Hs vars:" <+> ppr orig_hs_tvs
1462 , text "tvs:" <+> sep (map pprTvBndr tvs) ]
1463
1464 ; return (result, bound_tvs `unionVarSet` mkVarSet tvs)
1465 }
1466 where
1467 go [] thing = thing []
1468 go (L _ hs_tv : hs_tvs) thing
1469 = do { tv <- tcHsTyVarBndr new_tv hs_tv
1470 ; tcExtendTyVarEnv [tv] $
1471 go hs_tvs $ \ tvs ->
1472 thing (tv : tvs) }
1473
1474 tcHsTyVarBndr :: (Name -> Kind -> TcM TyVar)
1475 -> HsTyVarBndr Name -> TcM TcTyVar
1476 -- Return a SkolemTv TcTyVar, initialised with a kind variable.
1477 -- Typically the Kind inside the HsTyVarBndr will be a tyvar
1478 -- with a mutable kind in it.
1479 -- NB: These variables must not be in scope. This function
1480 -- is not appropriate for use with associated types, for example.
1481 --
1482 -- Returned TcTyVar has the same name; no cloning
1483 --
1484 -- See also Note [Associated type tyvar names] in Class
1485 --
1486 tcHsTyVarBndr new_tv (UserTyVar (L _ name))
1487 = do { kind <- newMetaKindVar
1488 ; new_tv name kind }
1489
1490 tcHsTyVarBndr new_tv (KindedTyVar (L _ name) kind)
1491 = do { kind <- tcLHsKind kind
1492 ; new_tv name kind }
1493
1494 newWildTyVar :: Name -> TcM TcTyVar
1495 -- ^ New unification variable for a wildcard
1496 newWildTyVar _name
1497 = do { kind <- newMetaKindVar
1498 ; uniq <- newUnique
1499 ; details <- newMetaDetails TauTv
1500 ; let name = mkSysTvName uniq (fsLit "w")
1501 ; return (mkTcTyVar name kind details) }
1502
1503 -- | Produce a tyvar of the given name (with the kind provided, or
1504 -- otherwise a meta-var kind). If
1505 -- the name is already in scope, return the scoped variable, checking
1506 -- to make sure the known kind matches any kind provided. The
1507 -- second return value says whether the variable is in scope (True)
1508 -- or not (False). (Use this for associated types, for example.)
1509 tcHsTyVarName :: Maybe Kind -> Name -> TcM (TcTyVar, Bool)
1510 tcHsTyVarName m_kind name
1511 = do { mb_tv <- tcLookupLcl_maybe name
1512 ; case mb_tv of
1513 Just (ATyVar _ tv)
1514 -> do { whenIsJust m_kind $ \ kind ->
1515 discardResult $
1516 unifyKind (Just (mkTyVarTy tv)) kind (tyVarKind tv)
1517 ; return (tv, True) }
1518 _ -> do { kind <- case m_kind of
1519 Just kind -> return kind
1520 Nothing -> newMetaKindVar
1521 ; return (mk_skolem_tv name kind, False) }}
1522
1523 -- makes a new skolem tv
1524 newSkolemTyVar :: Name -> Kind -> TcM TcTyVar
1525 newSkolemTyVar name kind = return (mk_skolem_tv name kind)
1526
1527 mk_skolem_tv :: Name -> Kind -> TcTyVar
1528 mk_skolem_tv n k = mkTcTyVar n k vanillaSkolemTv
1529
1530 ------------------
1531 kindGeneralizeType :: Type -> TcM Type
1532 -- Result is zonked
1533 kindGeneralizeType ty
1534 = do { kvs <- kindGeneralize ty
1535 ; zonkTcType (mkInvForAllTys kvs ty) }
1536
1537 kindGeneralize :: TcType -> TcM [KindVar]
1538 -- Quantify the free kind variables of a kind or type
1539 -- In the latter case the type is closed, so it has no free
1540 -- type variables. So in both cases, all the free vars are kind vars
1541 kindGeneralize kind_or_type
1542 = do { kvs <- zonkTcTypeAndFV kind_or_type
1543 ; let dvs = DV { dv_kvs = kvs, dv_tvs = emptyDVarSet }
1544 ; gbl_tvs <- tcGetGlobalTyCoVars -- Already zonked
1545 ; quantifyZonkedTyVars gbl_tvs dvs }
1546
1547 {-
1548 Note [Kind generalisation]
1549 ~~~~~~~~~~~~~~~~~~~~~~~~~~
1550 We do kind generalisation only at the outer level of a type signature.
1551 For example, consider
1552 T :: forall k. k -> *
1553 f :: (forall a. T a -> Int) -> Int
1554 When kind-checking f's type signature we generalise the kind at
1555 the outermost level, thus:
1556 f1 :: forall k. (forall (a:k). T k a -> Int) -> Int -- YES!
1557 and *not* at the inner forall:
1558 f2 :: (forall k. forall (a:k). T k a -> Int) -> Int -- NO!
1559 Reason: same as for HM inference on value level declarations,
1560 we want to infer the most general type. The f2 type signature
1561 would be *less applicable* than f1, because it requires a more
1562 polymorphic argument.
1563
1564 NB: There are no explicit kind variables written in f's signature.
1565 When there are, the renamer adds these kind variables to the list of
1566 variables bound by the forall, so you can indeed have a type that's
1567 higher-rank in its kind. But only by explicit request.
1568
1569 Note [Kinds of quantified type variables]
1570 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1571 tcTyVarBndrsGen quantifies over a specified list of type variables,
1572 *and* over the kind variables mentioned in the kinds of those tyvars.
1573
1574 Note that we must zonk those kinds (obviously) but less obviously, we
1575 must return type variables whose kinds are zonked too. Example
1576 (a :: k7) where k7 := k9 -> k9
1577 We must return
1578 [k9, a:k9->k9]
1579 and NOT
1580 [k9, a:k7]
1581 Reason: we're going to turn this into a for-all type,
1582 forall k9. forall (a:k7). blah
1583 which the type checker will then instantiate, and instantiate does not
1584 look through unification variables!
1585
1586 Hence using zonked_kinds when forming tvs'.
1587
1588 Note [Free-floating kind vars]
1589 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1590 Consider
1591
1592 data T = MkT (forall (a :: k). Proxy a)
1593 -- from test ghci/scripts/T7873
1594
1595 This is not an existential datatype, but a higher-rank one. Note that
1596 the forall to the right of MkT. Also consider
1597
1598 data S a = MkS (Proxy (a :: k))
1599
1600 According to the rules around implicitly-bound kind variables, those
1601 k's scope over the whole declarations. The renamer grabs it and adds it
1602 to the hsq_implicits field of the HsQTyVars of the tycon. So it must
1603 be in scope during type-checking, but we want to reject T while accepting
1604 S.
1605
1606 Why reject T? Because the kind variable isn't fixed by anything. For
1607 a variable like k to be implicit, it needs to be mentioned in the kind
1608 of a tycon tyvar. But it isn't.
1609
1610 Why accept S? Because kind inference tells us that a has kind k, so it's
1611 all OK.
1612
1613 Our approach depends on whether or not the datatype has a CUSK.
1614
1615 Non-CUSK: In the first pass (kcTyClTyVars) we just bring
1616 k into scope. In the second pass (tcTyClTyVars),
1617 we check to make sure that k has been unified with some other variable
1618 (or generalized over, making k into a skolem). If it hasn't been, then
1619 it must be a free-floating kind var. Error.
1620
1621 CUSK: When we determine the tycon's final, never-to-be-changed kind
1622 in kcHsTyVarBndrs, we check to make sure all implicitly-bound kind
1623 vars are indeed mentioned in a kind somewhere. If not, error.
1624
1625 -}
1626
1627 --------------------
1628 -- getInitialKind has made a suitably-shaped kind for the type or class
1629 -- Look it up in the local environment. This is used only for tycons
1630 -- that we're currently type-checking, so we're sure to find a TcTyCon.
1631 kcLookupTcTyCon :: Name -> TcM TcTyCon
1632 kcLookupTcTyCon nm
1633 = do { tc_ty_thing <- tcLookup nm
1634 ; return $ case tc_ty_thing of
1635 ATcTyCon tc -> tc
1636 _ -> pprPanic "kcLookupTcTyCon" (ppr tc_ty_thing) }
1637
1638 -----------------------
1639 -- | Bring tycon tyvars into scope. This is used during the "kind-checking"
1640 -- pass in TcTyClsDecls. (Never in getInitialKind, never in the
1641 -- "type-checking"/desugaring pass.)
1642 -- Never emits constraints, though the thing_inside might.
1643 kcTyClTyVars :: Name -> TcM a -> TcM a
1644 kcTyClTyVars tycon_name thing_inside
1645 = do { tycon <- kcLookupTcTyCon tycon_name
1646 ; tcExtendTyVarEnv (tcTyConScopedTyVars tycon) $ thing_inside }
1647
1648 tcTyClTyVars :: Name
1649 -> ([TyConBinder] -> Kind -> TcM a) -> TcM a
1650 -- ^ Used for the type variables of a type or class decl
1651 -- on the second full pass (type-checking/desugaring) in TcTyClDecls.
1652 -- This is *not* used in the initial-kind run, nor in the "kind-checking" pass.
1653 -- Accordingly, everything passed to the continuation is fully zonked.
1654 --
1655 -- (tcTyClTyVars T [a,b] thing_inside)
1656 -- where T : forall k1 k2 (a:k1 -> *) (b:k1). k2 -> *
1657 -- calls thing_inside with arguments
1658 -- [k1,k2,a,b] [k1:*, k2:*, Anon (k1 -> *), Anon k1] (k2 -> *)
1659 -- having also extended the type environment with bindings
1660 -- for k1,k2,a,b
1661 --
1662 -- Never emits constraints.
1663 --
1664 -- The LHsTyVarBndrs is always user-written, and the full, generalised
1665 -- kind of the tycon is available in the local env.
1666 tcTyClTyVars tycon_name thing_inside
1667 = do { tycon <- kcLookupTcTyCon tycon_name
1668
1669 ; let scoped_tvs = tcTyConScopedTyVars tycon
1670 -- these are all zonked:
1671 binders = tyConBinders tycon
1672 res_kind = tyConResKind tycon
1673
1674 -- See Note [Free-floating kind vars]
1675 ; zonked_scoped_tvs <- mapM zonkTcTyVarToTyVar scoped_tvs
1676 ; let still_sig_tvs = filter isSigTyVar zonked_scoped_tvs
1677 ; checkNoErrs $ reportFloatingKvs tycon_name
1678 zonked_scoped_tvs still_sig_tvs
1679
1680 -- Add the *unzonked* tyvars to the env't, because those
1681 -- are the ones mentioned in the source.
1682 ; tcExtendTyVarEnv scoped_tvs $
1683 thing_inside binders res_kind }
1684 where
1685
1686 -----------------------------------
1687 tcDataKindSig :: Kind -> TcM ([TyConBinder], Kind)
1688 -- GADT decls can have a (perhaps partial) kind signature
1689 -- e.g. data T :: * -> * -> * where ...
1690 -- This function makes up suitable (kinded) type variables for
1691 -- the argument kinds, and checks that the result kind is indeed *.
1692 -- We use it also to make up argument type variables for for data instances.
1693 -- Never emits constraints.
1694 -- Returns the new TyVars, the extracted TyBinders, and the new, reduced
1695 -- result kind (which should always be Type or a synonym thereof)
1696 tcDataKindSig kind
1697 = do { checkTc (isLiftedTypeKind res_kind) (badKindSig kind)
1698 ; span <- getSrcSpanM
1699 ; us <- newUniqueSupply
1700 ; rdr_env <- getLocalRdrEnv
1701 ; let uniqs = uniqsFromSupply us
1702 occs = [ occ | str <- allNameStrings
1703 , let occ = mkOccName tvName str
1704 , isNothing (lookupLocalRdrOcc rdr_env occ) ]
1705 -- Note [Avoid name clashes for associated data types]
1706
1707 -- NB: Use the tv from a binder if there is one. Otherwise,
1708 -- we end up inventing a new Unique for it, and any other tv
1709 -- that mentions the first ends up with the wrong kind.
1710 extra_bndrs = zipWith4 mkTyBinderTyConBinder
1711 tv_bndrs (repeat span) uniqs occs
1712
1713 ; return (extra_bndrs, res_kind) }
1714 where
1715 (tv_bndrs, res_kind) = splitPiTys kind
1716
1717 badKindSig :: Kind -> SDoc
1718 badKindSig kind
1719 = hang (text "Kind signature on data type declaration has non-* return kind")
1720 2 (ppr kind)
1721
1722 {-
1723 Note [Avoid name clashes for associated data types]
1724 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1725 Consider class C a b where
1726 data D b :: * -> *
1727 When typechecking the decl for D, we'll invent an extra type variable
1728 for D, to fill out its kind. Ideally we don't want this type variable
1729 to be 'a', because when pretty printing we'll get
1730 class C a b where
1731 data D b a0
1732 (NB: the tidying happens in the conversion to IfaceSyn, which happens
1733 as part of pretty-printing a TyThing.)
1734
1735 That's why we look in the LocalRdrEnv to see what's in scope. This is
1736 important only to get nice-looking output when doing ":info C" in GHCi.
1737 It isn't essential for correctness.
1738
1739
1740 ************************************************************************
1741 * *
1742 Partial signatures and pattern signatures
1743 * *
1744 ************************************************************************
1745
1746
1747 Note [Solving equalities in partial type signatures]
1748 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1749 We treat a partial type signature as a "shape constraint" to impose on
1750 the term:
1751 * We make no attempt to kind-generalise it
1752 * We instantiate the explicit and implicit foralls with SigTvs
1753 * We instantiate the wildcards with meta tyvars
1754
1755 We /do/ call solveEqualities, and then zonk to propage the result of
1756 solveEqualities, mainly so that functions like matchExpectedFunTys will
1757 be able to decompose the type, and hence higher-rank signatures will
1758 work. Ugh! For example
1759 f :: (forall a. a->a) -> _
1760 f x = (x True, x 'c')
1761
1762 -}
1763
1764 tcHsPartialSigType
1765 :: UserTypeCtxt
1766 -> LHsSigWcType Name -- The type signature
1767 -> TcM ( [(Name, TcTyVar)] -- Wildcards
1768 , Maybe TcTyVar -- Extra-constraints wildcard
1769 , [TcTyVar] -- Implicitly and explicitly bound type varialbes
1770 , TcThetaType -- Theta part
1771 , TcType ) -- Tau part
1772 tcHsPartialSigType ctxt sig_ty
1773 | HsWC { hswc_wcs = sig_wcs, hswc_body = ib_ty } <- sig_ty
1774 , HsIB { hsib_vars = implicit_hs_tvs, hsib_body = hs_ty } <- ib_ty
1775 , (explicit_hs_tvs, L _ hs_ctxt, hs_tau) <- splitLHsSigmaTy hs_ty
1776 = addSigCtxt ctxt hs_ty $
1777 do { (implicit_tvs, (wcs, wcx, explicit_tvs, theta, tau))
1778 <- -- See Note [Solving equalities in partial type signatures]
1779 solveEqualities $
1780 tcWildCardBindersX newWildTyVar sig_wcs $ \ wcs ->
1781 tcImplicitTKBndrsX new_implicit_tv implicit_hs_tvs $
1782 tcExplicitTKBndrsX newSigTyVar explicit_hs_tvs $ \ explicit_tvs ->
1783 do { -- Instantiate the type-class context; but if there
1784 -- is an extra-constraints wildcard, just discard it here
1785 (theta, wcx) <- tcPartialContext hs_ctxt
1786
1787 ; tau <- tcHsOpenType hs_tau
1788
1789 ; let bound_tvs = unionVarSets [ allBoundVariables tau
1790 , mkVarSet explicit_tvs
1791 , mkVarSet (map snd wcs) ]
1792
1793 ; return ( (wcs, wcx, explicit_tvs, theta, tau)
1794 , bound_tvs) }
1795
1796 ; emitWildCardHoleConstraints wcs
1797
1798 -- See Note [Solving equalities in partial type signatures]
1799 ; all_tvs <- mapM (updateTyVarKindM zonkTcType)
1800 (implicit_tvs ++ explicit_tvs)
1801 ; theta <- mapM zonkTcType theta
1802 ; tau <- zonkTcType tau
1803 ; checkValidType ctxt (mkSpecForAllTys all_tvs $ mkPhiTy theta tau)
1804
1805 ; traceTc "tcHsPatSigType" (ppr all_tvs)
1806 ; return (wcs, wcx, all_tvs, theta, tau) }
1807 where
1808 new_implicit_tv name = do { kind <- newMetaKindVar
1809 ; tv <- newSigTyVar name kind
1810 ; return (tv, False) }
1811
1812 tcPartialContext :: HsContext Name -> TcM (TcThetaType, Maybe TcTyVar)
1813 tcPartialContext hs_theta
1814 | Just (hs_theta1, hs_ctxt_last) <- snocView hs_theta
1815 , L _ (HsWildCardTy wc) <- ignoreParens hs_ctxt_last
1816 = do { wc_tv <- tcWildCardOcc wc constraintKind
1817 ; theta <- mapM tcLHsPredType hs_theta1
1818 ; return (theta, Just wc_tv) }
1819 | otherwise
1820 = do { theta <- mapM tcLHsPredType hs_theta
1821 ; return (theta, Nothing) }
1822
1823 tcHsPatSigType :: UserTypeCtxt
1824 -> LHsSigWcType Name -- The type signature
1825 -> TcM ( [(Name, TcTyVar)] -- Wildcards
1826 , [TcTyVar] -- The new bit of type environment, binding
1827 -- the scoped type variables
1828 , TcType) -- The type
1829 -- Used for type-checking type signatures in
1830 -- (a) patterns e.g f (x::Int) = e
1831 -- (b) RULE forall bndrs e.g. forall (x::Int). f x = x
1832 --
1833 -- This may emit constraints
1834
1835 tcHsPatSigType ctxt sig_ty
1836 | HsWC { hswc_wcs = sig_wcs, hswc_body = ib_ty } <- sig_ty
1837 , HsIB { hsib_vars = sig_vars, hsib_body = hs_ty } <- ib_ty
1838 = addSigCtxt ctxt hs_ty $
1839 do { (implicit_tvs, (wcs, sig_ty))
1840 <- -- See Note [Solving equalities in partial type signatures]
1841 solveEqualities $
1842 tcWildCardBindersX newWildTyVar sig_wcs $ \ wcs ->
1843 tcImplicitTKBndrsX new_implicit_tv sig_vars $
1844 do { sig_ty <- tcHsOpenType hs_ty
1845 ; return ((wcs, sig_ty), allBoundVariables sig_ty) }
1846
1847 ; emitWildCardHoleConstraints wcs
1848
1849 ; sig_ty <- zonkTcType sig_ty
1850 ; checkValidType ctxt sig_ty
1851
1852 ; traceTc "tcHsPatSigType" (ppr sig_vars)
1853 ; return (wcs, implicit_tvs, sig_ty) }
1854 where
1855 new_implicit_tv name = do { kind <- newMetaKindVar
1856 ; tv <- new_tv name kind
1857 ; return (tv, False) }
1858 -- "False" means that these tyvars aren't yet in scope
1859 new_tv = case ctxt of
1860 RuleSigCtxt {} -> newSkolemTyVar
1861 _ -> newSigTyVar
1862 -- See Note [Pattern signature binders]
1863 -- See Note [Unifying SigTvs]
1864
1865
1866 tcPatSig :: Bool -- True <=> pattern binding
1867 -> LHsSigWcType Name
1868 -> ExpSigmaType
1869 -> TcM (TcType, -- The type to use for "inside" the signature
1870 [TcTyVar], -- The new bit of type environment, binding
1871 -- the scoped type variables
1872 [(Name,TcTyVar)], -- The wildcards
1873 HsWrapper) -- Coercion due to unification with actual ty
1874 -- Of shape: res_ty ~ sig_ty
1875 tcPatSig in_pat_bind sig res_ty
1876 = do { (sig_wcs, sig_tvs, sig_ty) <- tcHsPatSigType PatSigCtxt sig
1877 -- sig_tvs are the type variables free in 'sig',
1878 -- and not already in scope. These are the ones
1879 -- that should be brought into scope
1880
1881 ; if null sig_tvs then do {
1882 -- Just do the subsumption check and return
1883 wrap <- addErrCtxtM (mk_msg sig_ty) $
1884 tcSubTypeET_NC PatSigCtxt res_ty sig_ty
1885 ; return (sig_ty, [], sig_wcs, wrap)
1886 } else do
1887 -- Type signature binds at least one scoped type variable
1888
1889 -- A pattern binding cannot bind scoped type variables
1890 -- It is more convenient to make the test here
1891 -- than in the renamer
1892 { when in_pat_bind (addErr (patBindSigErr sig_tvs))
1893
1894 -- Check that all newly-in-scope tyvars are in fact
1895 -- constrained by the pattern. This catches tiresome
1896 -- cases like
1897 -- type T a = Int
1898 -- f :: Int -> Int
1899 -- f (x :: T a) = ...
1900 -- Here 'a' doesn't get a binding. Sigh
1901 ; let bad_tvs = [ tv | tv <- sig_tvs
1902 , not (tv `elemVarSet` exactTyCoVarsOfType sig_ty) ]
1903 ; checkTc (null bad_tvs) (badPatSigTvs sig_ty bad_tvs)
1904
1905 -- Now do a subsumption check of the pattern signature against res_ty
1906 ; wrap <- addErrCtxtM (mk_msg sig_ty) $
1907 tcSubTypeET_NC PatSigCtxt res_ty sig_ty
1908
1909 -- Phew!
1910 ; return (sig_ty, sig_tvs, sig_wcs, wrap)
1911 } }
1912 where
1913 mk_msg sig_ty tidy_env
1914 = do { (tidy_env, sig_ty) <- zonkTidyTcType tidy_env sig_ty
1915 ; res_ty <- readExpType res_ty -- should be filled in by now
1916 ; (tidy_env, res_ty) <- zonkTidyTcType tidy_env res_ty
1917 ; let msg = vcat [ hang (text "When checking that the pattern signature:")
1918 4 (ppr sig_ty)
1919 , nest 2 (hang (text "fits the type of its context:")
1920 2 (ppr res_ty)) ]
1921 ; return (tidy_env, msg) }
1922
1923 patBindSigErr :: [TcTyVar] -> SDoc
1924 patBindSigErr sig_tvs
1925 = hang (text "You cannot bind scoped type variable" <> plural sig_tvs
1926 <+> pprQuotedList sig_tvs)
1927 2 (text "in a pattern binding signature")
1928
1929 {-
1930 Note [Pattern signature binders]
1931 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1932 Consider
1933 data T = forall a. T a (a->Int)
1934 f (T x (f :: a->Int) = blah)
1935
1936 Here
1937 * The pattern (T p1 p2) creates a *skolem* type variable 'a_sk',
1938 It must be a skolem so that that it retains its identity, and
1939 TcErrors.getSkolemInfo can thereby find the binding site for the skolem.
1940
1941 * The type signature pattern (f :: a->Int) binds "a" -> a_sig in the envt
1942
1943 * Then unification makes a_sig := a_sk
1944
1945 That's why we must make a_sig a MetaTv (albeit a SigTv),
1946 not a SkolemTv, so that it can unify to a_sk.
1947
1948 For RULE binders, though, things are a bit different (yuk).
1949 RULE "foo" forall (x::a) (y::[a]). f x y = ...
1950 Here this really is the binding site of the type variable so we'd like
1951 to use a skolem, so that we get a complaint if we unify two of them
1952 together.
1953
1954 Note [Unifying SigTvs]
1955 ~~~~~~~~~~~~~~~~~~~~~~
1956 ALAS we have no decent way of avoiding two SigTvs getting unified.
1957 Consider
1958 f (x::(a,b)) (y::c)) = [fst x, y]
1959 Here we'd really like to complain that 'a' and 'c' are unified. But
1960 for the reasons above we can't make a,b,c into skolems, so they
1961 are just SigTvs that can unify. And indeed, this would be ok,
1962 f x (y::c) = case x of
1963 (x1 :: a1, True) -> [x,y]
1964 (x1 :: a2, False) -> [x,y,y]
1965 Here the type of x's first component is called 'a1' in one branch and
1966 'a2' in the other. We could try insisting on the same OccName, but
1967 they definitely won't have the sane lexical Name.
1968
1969 I think we could solve this by recording in a SigTv a list of all the
1970 in-scope variables that it should not unify with, but it's fiddly.
1971
1972
1973 ************************************************************************
1974 * *
1975 Checking kinds
1976 * *
1977 ************************************************************************
1978
1979 -}
1980
1981 -- | Produce an 'TcKind' suitable for a checking a type that can be * or #.
1982 ekOpen :: TcM TcKind
1983 ekOpen = do { rr <- newFlexiTyVarTy runtimeRepTy
1984 ; return (tYPE rr) }
1985
1986 unifyKinds :: [(TcType, TcKind)] -> TcM ([TcType], TcKind)
1987 unifyKinds act_kinds
1988 = do { kind <- newMetaKindVar
1989 ; let check (ty, act_kind) = checkExpectedKind ty act_kind kind
1990 ; tys' <- mapM check act_kinds
1991 ; return (tys', kind) }
1992
1993 {-
1994 ************************************************************************
1995 * *
1996 Sort checking kinds
1997 * *
1998 ************************************************************************
1999
2000 tcLHsKind converts a user-written kind to an internal, sort-checked kind.
2001 It does sort checking and desugaring at the same time, in one single pass.
2002 -}
2003
2004 tcLHsKind :: LHsKind Name -> TcM Kind
2005 tcLHsKind = tc_lhs_kind kindLevelMode
2006
2007 tc_lhs_kind :: TcTyMode -> LHsKind Name -> TcM Kind
2008 tc_lhs_kind mode k
2009 = addErrCtxt (text "In the kind" <+> quotes (ppr k)) $
2010 tc_lhs_type (kindLevel mode) k liftedTypeKind
2011
2012 promotionErr :: Name -> PromotionErr -> TcM a
2013 promotionErr name err
2014 = failWithTc (hang (pprPECategory err <+> quotes (ppr name) <+> text "cannot be used here")
2015 2 (parens reason))
2016 where
2017 reason = case err of
2018 FamDataConPE -> text "it comes from a data family instance"
2019 NoDataKindsTC -> text "Perhaps you intended to use DataKinds"
2020 NoDataKindsDC -> text "Perhaps you intended to use DataKinds"
2021 NoTypeInTypeTC -> text "Perhaps you intended to use TypeInType"
2022 NoTypeInTypeDC -> text "Perhaps you intended to use TypeInType"
2023 PatSynPE -> text "Pattern synonyms cannot be promoted"
2024 _ -> text "it is defined and used in the same recursive group"
2025
2026 {-
2027 ************************************************************************
2028 * *
2029 Scoped type variables
2030 * *
2031 ************************************************************************
2032 -}
2033
2034 badPatSigTvs :: TcType -> [TyVar] -> SDoc
2035 badPatSigTvs sig_ty bad_tvs
2036 = vcat [ fsep [text "The type variable" <> plural bad_tvs,
2037 quotes (pprWithCommas ppr bad_tvs),
2038 text "should be bound by the pattern signature" <+> quotes (ppr sig_ty),
2039 text "but are actually discarded by a type synonym" ]
2040 , text "To fix this, expand the type synonym"
2041 , text "[Note: I hope to lift this restriction in due course]" ]
2042
2043 {-
2044 ************************************************************************
2045 * *
2046 Error messages and such
2047 * *
2048 ************************************************************************
2049 -}
2050
2051 -- | Make an appropriate message for an error in a function argument.
2052 -- Used for both expressions and types.
2053 funAppCtxt :: (Outputable fun, Outputable arg) => fun -> arg -> Int -> SDoc
2054 funAppCtxt fun arg arg_no
2055 = hang (hsep [ text "In the", speakNth arg_no, ptext (sLit "argument of"),
2056 quotes (ppr fun) <> text ", namely"])
2057 2 (quotes (ppr arg))
2058
2059 -- See Note [Free-floating kind vars]
2060 reportFloatingKvs :: Name -- of the tycon
2061 -> [TcTyVar] -- all tyvars, not necessarily zonked
2062 -> [TcTyVar] -- floating tyvars
2063 -> TcM ()
2064 reportFloatingKvs tycon_name all_tvs bad_tvs
2065 = unless (null bad_tvs) $ -- don't bother zonking if there's no error
2066 do { all_tvs <- mapM zonkTcTyVarToTyVar all_tvs
2067 ; bad_tvs <- mapM zonkTcTyVarToTyVar bad_tvs
2068 ; let (tidy_env, tidy_all_tvs) = tidyOpenTyCoVars emptyTidyEnv all_tvs
2069 tidy_bad_tvs = map (tidyTyVarOcc tidy_env) bad_tvs
2070 ; typeintype <- xoptM LangExt.TypeInType
2071 ; mapM_ (report typeintype tidy_all_tvs) tidy_bad_tvs }
2072 where
2073 report typeintype tidy_all_tvs tidy_bad_tv
2074 = addErr $
2075 vcat [ text "Kind variable" <+> quotes (ppr tidy_bad_tv) <+>
2076 text "is implicitly bound in datatype"
2077 , quotes (ppr tycon_name) <> comma <+>
2078 text "but does not appear as the kind of any"
2079 , text "of its type variables. Perhaps you meant"
2080 , text "to bind it" <+> ppWhen (not typeintype)
2081 (text "(with TypeInType)") <+>
2082 text "explicitly somewhere?"
2083 , ppWhen (not (null tidy_all_tvs)) $
2084 hang (text "Type variables with inferred kinds:")
2085 2 (ppr_tv_bndrs tidy_all_tvs) ]
2086
2087 ppr_tv_bndrs tvs = sep (map pp_tv tvs)
2088 pp_tv tv = parens (ppr tv <+> dcolon <+> ppr (tyVarKind tv))