3 TcId, TcIdSet, tcInstId,
6 TcEnv, ValueEnv, TyThing(..), TyThingDetails(..), tyThingKind,
8 initEnv, getEnvTyCons, getEnvClasses,
10 tcExtendUVarEnv, tcLookupUVar,
12 tcExtendKindEnv, tcExtendTyVarEnv,
13 tcExtendTyVarEnvForMeths, tcExtendTypeEnv, tcGetInScopeTyVars,
17 tcLookupClassByKey, tcLookupClassByKey_maybe,
19 tcExtendGlobalValEnv, tcExtendLocalValEnv,
20 tcGetValueEnv, tcSetValueEnv,
23 tcLookupValue, tcLookupValueMaybe,
24 tcLookupValueByKey, tcLookupValueByKeyMaybe,
25 explicitLookupValueByKey, explicitLookupValue,
28 newLocalId, newSpecPragmaId,
29 newDefaultMethodName, newDFunName,
30 tcGetGlobalTyVars, tcExtendGlobalTyVars,
32 InstEnv, emptyInstEnv, addToInstEnv,
33 lookupInstEnv, InstLookupResult(..),
34 tcGetInstEnv, tcSetInstEnv, classInstEnv,
39 #include "HsVersions.h"
41 import Id ( mkUserLocal, isDataConWrapId_maybe )
42 import MkId ( mkSpecPragmaId )
43 import Var ( TyVar, Id, setVarName,
44 idType, lazySetIdInfo, idInfo, tyVarKind, UVar,
46 import TcType ( TcType, TcTyVar, TcTyVarSet, TcThetaType,
47 tcInstTyVars, zonkTcTyVars,
51 import Type ( Kind, Type, superKind,
52 tyVarsOfType, tyVarsOfTypes,
53 splitForAllTys, splitRhoTy, splitFunTys,
54 splitAlgTyConApp_maybe, getTyVar, getDFunTyKey
56 import Subst ( substTy )
57 import UsageSPUtils ( unannotTy )
58 import DataCon ( DataCon )
59 import TyCon ( TyCon, tyConKind, tyConArity, isSynTyCon )
60 import Class ( Class, ClassOpItem, ClassContext, classTyCon )
64 import IdInfo ( vanillaIdInfo )
65 import Name ( Name, OccName, Provenance(..), ExportFlag(..), NamedThing(..),
66 nameOccName, nameModule, getSrcLoc, mkGlobalName,
67 maybeWiredInTyConName, maybeWiredInIdName, isLocallyDefined,
68 NameEnv, emptyNameEnv, lookupNameEnv, nameEnvElts,
69 extendNameEnv, extendNameEnvList
71 import OccName ( mkDFunOcc, mkDefaultMethodOcc, occNameString )
72 import Module ( Module )
73 import Unify ( unifyTyListsX, matchTys )
74 import Unique ( pprUnique10, Unique, Uniquable(..) )
76 import Unique ( Uniquable(..) )
77 import Util ( zipEqual, zipWith3Equal, mapAccumL )
78 import VarEnv ( TyVarSubstEnv )
79 import SrcLoc ( SrcLoc )
80 import FastString ( FastString )
85 %************************************************************************
89 %************************************************************************
93 type TcId = Id -- Type may be a TcType
96 tcLookupDataCon :: Name -> TcM s (DataCon, [TcType], TcType)
97 tcLookupDataCon con_name
98 = tcLookupValue con_name `thenNF_Tc` \ con_id ->
99 case isDataConWrapId_maybe con_id of {
100 Nothing -> failWithTc (badCon con_id);
103 tcInstId con_id `thenNF_Tc` \ (_, _, con_tau) ->
104 -- Ignore the con_theta; overloaded constructors only
105 -- behave differently when called, not when used for
108 (arg_tys, result_ty) = splitFunTys con_tau
110 ASSERT( maybeToBool (splitAlgTyConApp_maybe result_ty) )
111 returnTc (data_con, arg_tys, result_ty) }
113 -- A useful function that takes an occurrence of a global thing
114 -- and instantiates its type with fresh type variables
116 -> NF_TcM s ([TcTyVar], -- It's instantiated type
121 (tyvars, rho) = splitForAllTys (unannotTy (idType id))
123 tcInstTyVars tyvars `thenNF_Tc` \ (tyvars', arg_tys, tenv) ->
125 rho' = substTy tenv rho
126 (theta', tau') = splitRhoTy rho'
128 returnNF_Tc (tyvars', theta', tau')
131 Between the renamer and the first invocation of the UsageSP inference,
132 identifiers read from interface files will have usage information in
133 their types, whereas other identifiers will not. The unannotTy here
134 in @tcInstId@ prevents this information from pointlessly propagating
135 further prior to the first usage inference.
138 %************************************************************************
142 %************************************************************************
144 Data type declarations
145 ~~~~~~~~~~~~~~~~~~~~~
153 (TcTyVarSet, -- The in-scope TyVars
154 TcRef TcTyVarSet) -- Free type variables of the value env
155 -- ...why mutable? see notes with tcGetGlobalTyVars
156 -- Includes the in-scope tyvars
158 type UsageEnv = NameEnv UVar
159 type TypeEnv = NameEnv TyThing
160 type ValueEnv = NameEnv Id
162 valueEnvIds :: ValueEnv -> [Id]
163 valueEnvIds ve = nameEnvElts ve
165 data TyThing = ATyVar TyVar
168 | AThing TcKind -- Used temporarily, during kind checking
169 -- For example, when checking (forall a. T a Int):
170 -- 1. We first bind (a -> AThink kv), where kv is a kind variable.
171 -- 2. Then we kind-check the (T a Int) part.
172 -- 3. Then we zonk the kind variable.
173 -- 4. Now we know the kind for 'a', and we add (a -> ATyVar a::K) to the environment
175 tyThingKind :: TyThing -> TcKind
176 tyThingKind (ATyVar tv) = tyVarKind tv
177 tyThingKind (ATyCon tc) = tyConKind tc
178 tyThingKind (AClass cl) = tyConKind (classTyCon cl) -- For some odd reason,
179 -- a class doesn't include its kind
180 tyThingKind (AThing k) = k
182 data TyThingDetails = SynTyDetails Type
183 | DataTyDetails ClassContext [DataCon] [Class]
184 | ClassDetails ClassContext [Id] [ClassOpItem] DataCon
186 initEnv :: TcRef TcTyVarSet -> TcEnv
187 initEnv mut = TcEnv emptyNameEnv emptyNameEnv emptyNameEnv emptyInstEnv (emptyVarSet, mut)
189 getEnvClasses (TcEnv _ te _ _ _) = [cl | AClass cl <- nameEnvElts te]
190 getEnvTyCons (TcEnv _ te _ _ _) = [tc | ATyCon tc <- nameEnvElts te]
193 %************************************************************************
195 \subsection{The usage environment}
197 %************************************************************************
199 Extending the usage environment
202 tcExtendUVarEnv :: Name -> UVar -> TcM s r -> TcM s r
203 tcExtendUVarEnv uv_name uv scope
204 = tcGetEnv `thenNF_Tc` \ (TcEnv ue te ve ie gtvs) ->
205 tcSetEnv (TcEnv (extendNameEnv ue uv_name uv) te ve ie gtvs) scope
208 Looking up in the environments.
211 tcLookupUVar :: Name -> NF_TcM s UVar
213 = tcGetEnv `thenNF_Tc` \ (TcEnv ue te ve _ gtvs) ->
214 case lookupNameEnv ue uv_name of
215 Just uv -> returnNF_Tc uv
216 Nothing -> failWithTc (uvNameOutOfScope uv_name)
220 %************************************************************************
222 \subsection{The type environment}
224 %************************************************************************
227 tcExtendKindEnv :: [(Name,TcKind)] -> TcM s r -> TcM s r
228 tcExtendKindEnv pairs scope
229 = tcGetEnv `thenNF_Tc` \ (TcEnv ue te ve ie gtvs) ->
231 te' = extendNameEnvList te [(n, AThing k) | (n,k) <- pairs]
232 -- No need to extend global tyvars for kind checking
234 tcSetEnv (TcEnv ue te' ve ie gtvs) scope
236 tcExtendTyVarEnv :: [TyVar] -> TcM s r -> TcM s r
237 tcExtendTyVarEnv tyvars scope
238 = tcGetEnv `thenNF_Tc` \ (TcEnv ue te ve ie (in_scope_tvs, gtvs)) ->
240 te' = extendNameEnvList te [ (getName tv, ATyVar tv) | tv <- tyvars]
241 new_tv_set = mkVarSet tyvars
242 in_scope_tvs' = in_scope_tvs `unionVarSet` new_tv_set
244 -- It's important to add the in-scope tyvars to the global tyvar set
246 -- f (x::r) = let g y = y::r in ...
247 -- Here, g mustn't be generalised. This is also important during
248 -- class and instance decls, when we mustn't generalise the class tyvars
249 -- when typechecking the methods.
250 tc_extend_gtvs gtvs new_tv_set `thenNF_Tc` \ gtvs' ->
251 tcSetEnv (TcEnv ue te' ve ie (in_scope_tvs', gtvs')) scope
253 -- This variant, tcExtendTyVarEnvForMeths, takes *two* bunches of tyvars:
254 -- the signature tyvars contain the original names
255 -- the instance tyvars are what those names should be mapped to
256 -- It's needed when typechecking the method bindings of class and instance decls
257 -- It does *not* extend the global tyvars; tcMethodBind does that for itself
259 tcExtendTyVarEnvForMeths :: [TyVar] -> [TcTyVar] -> TcM s r -> TcM s r
260 tcExtendTyVarEnvForMeths sig_tyvars inst_tyvars thing_inside
261 = tcGetEnv `thenNF_Tc` \ (TcEnv ue te ve ie gtvs) ->
263 te' = extendNameEnvList te stuff
265 tcSetEnv (TcEnv ue te' ve ie gtvs) thing_inside
267 stuff = [ (getName sig_tv, ATyVar inst_tv)
268 | (sig_tv, inst_tv) <- zipEqual "tcMeth" sig_tyvars inst_tyvars
271 tcExtendGlobalTyVars extra_global_tvs scope
272 = tcGetEnv `thenNF_Tc` \ (TcEnv ue te ve ie (in_scope,gtvs)) ->
273 tc_extend_gtvs gtvs extra_global_tvs `thenNF_Tc` \ gtvs' ->
274 tcSetEnv (TcEnv ue te ve ie (in_scope,gtvs')) scope
276 tc_extend_gtvs gtvs extra_global_tvs
277 = tcReadMutVar gtvs `thenNF_Tc` \ global_tvs ->
279 new_global_tyvars = global_tvs `unionVarSet` extra_global_tvs
281 tcNewMutVar new_global_tyvars
284 @tcGetGlobalTyVars@ returns a fully-zonked set of tyvars free in the environment.
285 To improve subsequent calls to the same function it writes the zonked set back into
289 tcGetGlobalTyVars :: NF_TcM s TcTyVarSet
291 = tcGetEnv `thenNF_Tc` \ (TcEnv ue te ve ie (_,gtvs)) ->
292 tcReadMutVar gtvs `thenNF_Tc` \ global_tvs ->
293 zonkTcTyVars (varSetElems global_tvs) `thenNF_Tc` \ global_tys' ->
295 global_tvs' = (tyVarsOfTypes global_tys')
297 tcWriteMutVar gtvs global_tvs' `thenNF_Tc_`
298 returnNF_Tc global_tvs'
300 tcGetInScopeTyVars :: NF_TcM s [TcTyVar]
302 = tcGetEnv `thenNF_Tc` \ (TcEnv ue te ve ie (in_scope_tvs, gtvs)) ->
303 returnNF_Tc (varSetElems in_scope_tvs)
307 Type constructors and classes
310 tcExtendTypeEnv :: [(Name, TyThing)] -> TcM s r -> TcM s r
311 tcExtendTypeEnv bindings scope
312 = ASSERT( null [tv | (_, ATyVar tv) <- bindings] )
313 -- Not for tyvars; use tcExtendTyVarEnv
314 tcGetEnv `thenNF_Tc` \ (TcEnv ue te ve ie gtvs) ->
316 te' = extendNameEnvList te bindings
318 tcSetEnv (TcEnv ue te' ve ie gtvs) scope
322 Looking up in the environments.
325 tcLookupTy :: Name -> NF_TcM s TyThing
327 = tcGetEnv `thenNF_Tc` \ (TcEnv ue te ve ie gtvs) ->
328 case lookupNameEnv te name of {
329 Just thing -> returnNF_Tc thing ;
332 case maybeWiredInTyConName name of
333 Just tc -> returnNF_Tc (ATyCon tc)
335 Nothing -> -- This can happen if an interface-file
336 -- unfolding is screwed up
337 failWithTc (tyNameOutOfScope name)
340 tcLookupClassByKey :: Unique -> NF_TcM s Class
341 tcLookupClassByKey key
342 = tcGetEnv `thenNF_Tc` \ (TcEnv ue te ve ie gtvs) ->
343 case lookupUFM_Directly te key of
344 Just (AClass cl) -> returnNF_Tc cl
345 other -> pprPanic "tcLookupClassByKey:" (pprUnique10 key)
347 tcLookupClassByKey_maybe :: Unique -> NF_TcM s (Maybe Class)
348 tcLookupClassByKey_maybe key
349 = tcGetEnv `thenNF_Tc` \ (TcEnv ue te ve ie gtvs) ->
350 case lookupUFM_Directly te key of
351 Just (AClass cl) -> returnNF_Tc (Just cl)
352 other -> returnNF_Tc Nothing
354 tcLookupTyConByKey :: Unique -> NF_TcM s TyCon
355 tcLookupTyConByKey key
356 = tcGetEnv `thenNF_Tc` \ (TcEnv ue te ve ie gtvs) ->
357 case lookupUFM_Directly te key of
358 Just (ATyCon tc) -> returnNF_Tc tc
359 other -> pprPanic "tcLookupTyConByKey:" (pprUnique10 key)
365 %************************************************************************
367 \subsection{The value environment}
369 %************************************************************************
372 tcExtendGlobalValEnv :: [Id] -> TcM s a -> TcM s a
373 tcExtendGlobalValEnv ids scope
374 = tcGetEnv `thenNF_Tc` \ (TcEnv ue te ve ie gtvs) ->
376 ve' = addListToUFM_Directly ve [(getUnique id, id) | id <- ids]
378 tcSetEnv (TcEnv ue te ve' ie gtvs) scope
380 tcExtendLocalValEnv :: [(Name,TcId)] -> TcM s a -> TcM s a
381 tcExtendLocalValEnv names_w_ids scope
382 = tcGetEnv `thenNF_Tc` \ (TcEnv ue te ve ie (in_scope_tvs,gtvs)) ->
383 tcReadMutVar gtvs `thenNF_Tc` \ global_tvs ->
385 ve' = extendNameEnvList ve names_w_ids
386 extra_global_tyvars = tyVarsOfTypes (map (idType . snd) names_w_ids)
388 tc_extend_gtvs gtvs extra_global_tyvars `thenNF_Tc` \ gtvs' ->
389 tcSetEnv (TcEnv ue te ve' ie (in_scope_tvs,gtvs')) scope
394 tcLookupValue :: Name -> NF_TcM s Id -- Panics if not found
396 = case maybeWiredInIdName name of
397 Just id -> returnNF_Tc id
398 Nothing -> tcGetEnv `thenNF_Tc` \ (TcEnv ue te ve ie gtvs) ->
399 returnNF_Tc (lookupWithDefaultUFM ve def name)
401 wired_in = case maybeWiredInIdName name of
404 def = pprPanic "tcLookupValue:" (ppr name <+> ppr wired_in)
406 tcLookupValueMaybe :: Name -> NF_TcM s (Maybe Id)
407 tcLookupValueMaybe name
408 = case maybeWiredInIdName name of
409 Just id -> returnNF_Tc (Just id)
410 Nothing -> tcGetEnv `thenNF_Tc` \ (TcEnv ue te ve ie gtvs) ->
411 returnNF_Tc (lookupNameEnv ve name)
413 tcLookupValueByKey :: Unique -> NF_TcM s Id -- Panics if not found
414 tcLookupValueByKey key
415 = tcGetEnv `thenNF_Tc` \ (TcEnv ue te ve ie gtvs) ->
416 returnNF_Tc (explicitLookupValueByKey ve key)
418 tcLookupValueByKeyMaybe :: Unique -> NF_TcM s (Maybe Id)
419 tcLookupValueByKeyMaybe key
420 = tcGetEnv `thenNF_Tc` \ (TcEnv ue te ve ie gtvs) ->
421 returnNF_Tc (lookupUFM_Directly ve key)
423 tcGetValueEnv :: NF_TcM s ValueEnv
425 = tcGetEnv `thenNF_Tc` \ (TcEnv ue te ve ie gtvs) ->
429 tcSetValueEnv :: ValueEnv -> TcM s a -> TcM s a
430 tcSetValueEnv ve scope
431 = tcGetEnv `thenNF_Tc` \ (TcEnv ue te _ ie gtvs) ->
432 tcSetEnv (TcEnv ue te ve ie gtvs) scope
434 -- Non-monadic version, environment given explicitly
435 explicitLookupValueByKey :: ValueEnv -> Unique -> Id
436 explicitLookupValueByKey ve key
437 = lookupWithDefaultUFM_Directly ve def key
439 def = pprPanic "lookupValueByKey:" (pprUnique10 key)
441 explicitLookupValue :: ValueEnv -> Name -> Maybe Id
442 explicitLookupValue ve name
443 = case maybeWiredInIdName name of
445 Nothing -> lookupNameEnv ve name
447 -- Extract the IdInfo from an IfaceSig imported from an interface file
448 tcAddImportedIdInfo :: ValueEnv -> Id -> Id
449 tcAddImportedIdInfo unf_env id
450 | isLocallyDefined id -- Don't look up locally defined Ids, because they
451 -- have explicit local definitions, so we get a black hole!
454 = id `lazySetIdInfo` new_info
455 -- The Id must be returned without a data dependency on maybe_id
457 new_info = case explicitLookupValue unf_env (getName id) of
458 Nothing -> vanillaIdInfo
459 Just imported_id -> idInfo imported_id
460 -- ToDo: could check that types are the same
466 newLocalId :: OccName -> TcType -> SrcLoc -> NF_TcM s TcId
467 newLocalId name ty loc
468 = tcGetUnique `thenNF_Tc` \ uniq ->
469 returnNF_Tc (mkUserLocal name uniq ty loc)
471 newSpecPragmaId :: Name -> TcType -> NF_TcM s TcId
472 newSpecPragmaId name ty
473 = tcGetUnique `thenNF_Tc` \ uniq ->
474 returnNF_Tc (mkSpecPragmaId (nameOccName name) uniq ty (getSrcLoc name))
478 %************************************************************************
480 \subsection{The instance environment}
482 %************************************************************************
485 tcGetInstEnv :: NF_TcM s InstEnv
486 tcGetInstEnv = tcGetEnv `thenNF_Tc` \ (TcEnv ue te ve ie (_,gtvs)) ->
489 tcSetInstEnv :: InstEnv -> TcM s a -> TcM s a
490 tcSetInstEnv ie scope
491 = tcGetEnv `thenNF_Tc` \ (TcEnv ue te ve _ gtvs) ->
492 tcSetEnv (TcEnv ue te ve ie gtvs) scope
497 type InstEnv = UniqFM ClsInstEnv -- Maps Class to instances for that class
498 type ClsInstEnv = [(TyVarSet, [Type], Id)] -- The instances for a particular class
500 classInstEnv :: InstEnv -> Class -> ClsInstEnv
501 classInstEnv env cls = lookupWithDefaultUFM env [] cls
504 A @ClsInstEnv@ lives inside a class, and identifies all the instances
505 of that class. The @Id@ inside a ClsInstEnv mapping is the dfun for
508 If class C maps to a list containing the item ([a,b], [t1,t2,t3], dfun), then
510 forall a b, C t1 t2 t3 can be constructed by dfun
512 or, to put it another way, we have
514 instance (...) => C t1 t2 t3, witnessed by dfun
516 There is an important consistency constraint in the elements of a ClsInstEnv:
518 * [a,b] must be a superset of the free vars of [t1,t2,t3]
520 * The dfun must itself be quantified over [a,b]
522 Thus, the @ClassInstEnv@ for @Eq@ might contain the following entry:
523 [a] ===> dfun_Eq_List :: forall a. Eq a => Eq [a]
524 The "a" in the pattern must be one of the forall'd variables in
529 Notes on overlapping instances
530 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
531 In some ClsInstEnvs, overlap is prohibited; that is, no pair of templates unify.
533 In others, overlap is permitted, but only in such a way that one can make
534 a unique choice when looking up. That is, overlap is only permitted if
535 one template matches the other, or vice versa. So this is ok:
543 If overlap is permitted, the list is kept most specific first, so that
544 the first lookup is the right choice.
547 For now we just use association lists.
549 \subsection{Avoiding a problem with overlapping}
551 Consider this little program:
554 class C a where c :: a
555 class C a => D a where d :: a
557 instance C Int where c = 17
558 instance D Int where d = 13
560 instance C a => C [a] where c = [c]
561 instance ({- C [a], -} D a) => D [a] where d = c
563 instance C [Int] where c = [37]
565 main = print (d :: [Int])
568 What do you think `main' prints (assuming we have overlapping instances, and
569 all that turned on)? Well, the instance for `D' at type `[a]' is defined to
570 be `c' at the same type, and we've got an instance of `C' at `[Int]', so the
571 answer is `[37]', right? (the generic `C [a]' instance shouldn't apply because
572 the `C [Int]' instance is more specific).
574 Ghc-4.04 gives `[37]', while ghc-4.06 gives `[17]', so 4.06 is wrong. That
575 was easy ;-) Let's just consult hugs for good measure. Wait - if I use old
576 hugs (pre-September99), I get `[17]', and stranger yet, if I use hugs98, it
577 doesn't even compile! What's going on!?
579 What hugs complains about is the `D [a]' instance decl.
582 ERROR "mj.hs" (line 10): Cannot build superclass instance
584 *** Context supplied : D a
585 *** Required superclass : C [a]
588 You might wonder what hugs is complaining about. It's saying that you
589 need to add `C [a]' to the context of the `D [a]' instance (as appears
590 in comments). But there's that `C [a]' instance decl one line above
591 that says that I can reduce the need for a `C [a]' instance to the
592 need for a `C a' instance, and in this case, I already have the
593 necessary `C a' instance (since we have `D a' explicitly in the
594 context, and `C' is a superclass of `D').
596 Unfortunately, the above reasoning indicates a premature commitment to the
597 generic `C [a]' instance. I.e., it prematurely rules out the more specific
598 instance `C [Int]'. This is the mistake that ghc-4.06 makes. The fix is to
599 add the context that hugs suggests (uncomment the `C [a]'), effectively
600 deferring the decision about which instance to use.
602 Now, interestingly enough, 4.04 has this same bug, but it's covered up
603 in this case by a little known `optimization' that was disabled in
604 4.06. Ghc-4.04 silently inserts any missing superclass context into
605 an instance declaration. In this case, it silently inserts the `C
606 [a]', and everything happens to work out.
608 (See `basicTypes/MkId:mkDictFunId' for the code in question. Search for
609 `Mark Jones', although Mark claims no credit for the `optimization' in
610 question, and would rather it stopped being called the `Mark Jones
613 So, what's the fix? I think hugs has it right. Here's why. Let's try
614 something else out with ghc-4.04. Let's add the following line:
619 Everyone raise their hand who thinks that `d :: [Int]' should give a
620 different answer from `d' :: [Int]'. Well, in ghc-4.04, it does. The
621 `optimization' only applies to instance decls, not to regular
622 bindings, giving inconsistent behavior.
624 Old hugs had this same bug. Here's how we fixed it: like GHC, the
625 list of instances for a given class is ordered, so that more specific
626 instances come before more generic ones. For example, the instance
627 list for C might contain:
628 ..., C Int, ..., C a, ...
629 When we go to look for a `C Int' instance we'll get that one first.
630 But what if we go looking for a `C b' (`b' is unconstrained)? We'll
631 pass the `C Int' instance, and keep going. But if `b' is
632 unconstrained, then we don't know yet if the more specific instance
633 will eventually apply. GHC keeps going, and matches on the generic `C
634 a'. The fix is to, at each step, check to see if there's a reverse
635 match, and if so, abort the search. This prevents hugs from
636 prematurely chosing a generic instance when a more specific one
642 emptyInstEnv :: InstEnv
643 emptyInstEnv = emptyUFM
646 @lookupInstEnv@ looks up in a @InstEnv@, using a one-way match. Since
647 the env is kept ordered, the first match must be the only one. The
648 thing we are looking up can have an arbitrary "flexi" part.
651 lookupInstEnv :: InstEnv -- The envt
652 -> Class -> [Type] -- Key
655 data InstLookupResult
656 = FoundInst -- There is a (template,substitution) pair
657 -- that makes the template match the key,
658 -- and no template is an instance of the key
661 | NoMatch Bool -- Boolean is true iff there is at least one
662 -- template that matches the key.
663 -- (but there are other template(s) that are
664 -- instances of the key, so we don't report
666 -- The NoMatch True case happens when we look up
668 -- in an InstEnv that has entries for
671 -- Then which we choose would depend on the way in which 'a'
672 -- is instantiated. So we say there is no match, but identify
673 -- it as ambiguous case in the hope of giving a better error msg.
674 -- See the notes above from Jeff Lewis
676 lookupInstEnv env key_cls key_tys
677 = find (classInstEnv env key_cls)
679 key_vars = tyVarsOfTypes key_tys
681 find [] = NoMatch False
682 find ((tpl_tyvars, tpl, val) : rest)
683 = case matchTys tpl_tyvars tpl key_tys of
685 case matchTys key_vars key_tys tpl of
687 Just (_, _) -> NoMatch (any_match rest)
688 Just (subst, leftovers) -> ASSERT( null leftovers )
691 any_match rest = or [ maybeToBool (matchTys tvs tpl key_tys)
692 | (tvs,tpl,_) <- rest
696 @addToClsInstEnv@ extends a @ClsInstEnv@, checking for overlaps.
698 A boolean flag controls overlap reporting.
700 True => overlap is permitted, but only if one template matches the other;
701 not if they unify but neither is
704 addToInstEnv :: Bool -- True <=> overlap permitted
706 -> Class -> [TyVar] -> [Type] -> Id -- New item
707 -> MaybeErr InstEnv -- Success...
708 ([Type], Id) -- Failure: Offending overlap
710 addToInstEnv overlap_ok inst_env clas ins_tvs ins_tys value
711 = case insert_into (classInstEnv inst_env clas) of
712 Failed stuff -> Failed stuff
713 Succeeded new_env -> Succeeded (addToUFM inst_env clas new_env)
716 ins_tv_set = mkVarSet ins_tvs
717 ins_item = (ins_tv_set, ins_tys, value)
719 insert_into [] = returnMaB [ins_item]
720 insert_into env@(cur_item@(tpl_tvs, tpl_tys, val) : rest)
723 -- (a) they are the same, or
724 -- (b) they unify, and any sort of overlap is prohibited,
725 -- (c) they unify but neither is more specific than t'other
727 || (unifiable && not overlap_ok)
728 || (unifiable && not (ins_item_more_specific || cur_item_more_specific))
729 = failMaB (tpl_tys, val)
731 -- New item is an instance of current item, so drop it here
732 | ins_item_more_specific = returnMaB (ins_item : env)
734 -- Otherwise carry on
735 | otherwise = insert_into rest `thenMaB` \ rest' ->
736 returnMaB (cur_item : rest')
738 unifiable = maybeToBool (unifyTyListsX (ins_tv_set `unionVarSet` tpl_tvs) tpl_tys ins_tys)
739 ins_item_more_specific = maybeToBool (matchTys tpl_tvs tpl_tys ins_tys)
740 cur_item_more_specific = maybeToBool (matchTys ins_tv_set ins_tys tpl_tys)
741 identical = ins_item_more_specific && cur_item_more_specific
744 Make a name for the dict fun for an instance decl
747 newDFunName :: Module -> Class -> [Type] -> SrcLoc -> NF_TcM s Name
748 newDFunName mod clas (ty:_) loc
749 = tcGetDFunUniq dfun_string `thenNF_Tc` \ inst_uniq ->
750 tcGetUnique `thenNF_Tc` \ uniq ->
751 returnNF_Tc (mkGlobalName uniq mod
752 (mkDFunOcc dfun_string inst_uniq)
753 (LocalDef loc Exported))
755 -- Any string that is somewhat unique will do
756 dfun_string = occNameString (getOccName clas) ++ occNameString (getDFunTyKey ty)
758 newDefaultMethodName :: Name -> SrcLoc -> NF_TcM s Name
759 newDefaultMethodName op_name loc
760 = tcGetUnique `thenNF_Tc` \ uniq ->
761 returnNF_Tc (mkGlobalName uniq (nameModule op_name)
762 (mkDefaultMethodOcc (getOccName op_name))
763 (LocalDef loc Exported))
767 %************************************************************************
771 %************************************************************************
775 = quotes (ppr con_id) <+> ptext SLIT("is not a data constructor")
777 = quotes (ppr op) <+> ptext SLIT("is not a primop")
779 uvNameOutOfScope name
780 = ptext SLIT("UVar") <+> quotes (ppr name) <+> ptext SLIT("is not in scope")
782 tyNameOutOfScope name
783 = quotes (ppr name) <+> ptext SLIT("is not in scope")