2 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1996
4 \section[Unify]{Unifier}
6 The unifier is now squarely in the typechecker monad (because of the
7 updatable substitution).
10 #include "HsVersions.h"
12 module Unify ( unifyTauTy, unifyTauTyList, unifyTauTyLists, unifyFunTy ) where
18 import Type ( GenType(..), typeKind, mkFunTy, getFunTy_maybe )
19 import TyCon ( TyCon, mkFunTyCon )
20 import TyVar ( GenTyVar(..), TyVar(..), tyVarKind )
21 import TcType ( TcType(..), TcMaybe(..), TcTauType(..), TcTyVar(..),
22 newTyVarTy, tcReadTyVar, tcWriteTyVar, zonkTcType
25 import Kind ( Kind, hasMoreBoxityInfo, mkTypeKind )
26 import Usage ( duffUsage )
27 import PprType ( GenTyVar, GenType ) -- instances
29 import Unique ( Unique ) -- instances
34 %************************************************************************
36 \subsection[Unify-exported]{Exported unification functions}
38 %************************************************************************
40 The exported functions are all defined as versions of some
41 non-exported generic functions.
43 Unify two @TauType@s. Dead straightforward.
46 unifyTauTy :: TcTauType s -> TcTauType s -> TcM s ()
48 = tcAddErrCtxtM (unifyCtxt ty1 ty2) $
52 @unifyTauTyList@ unifies corresponding elements of two lists of
53 @TauType@s. It uses @uTys@ to do the real work. The lists should be
54 of equal length. We charge down the list explicitly so that we can
55 complain if their lengths differ.
58 unifyTauTyLists :: [TcTauType s] -> [TcTauType s] -> TcM s ()
59 unifyTauTyLists [] [] = returnTc ()
60 unifyTauTyLists (ty1:tys1) (ty2:tys2) = uTys ty1 ty1 ty2 ty2 `thenTc_`
61 unifyTauTyLists tys1 tys2
62 unifyTauTypeLists ty1s ty2s = panic "Unify.unifyTauTypeLists: mismatched type lists!"
65 @unifyTauTyList@ takes a single list of @TauType@s and unifies them
66 all together. It is used, for example, when typechecking explicit
67 lists, when all the elts should be of the same type.
70 unifyTauTyList :: [TcTauType s] -> TcM s ()
71 unifyTauTyList [] = returnTc ()
72 unifyTauTyList [ty] = returnTc ()
73 unifyTauTyList (ty1:tys@(ty2:_)) = unifyTauTy ty1 ty2 `thenTc_`
77 %************************************************************************
79 \subsection[Unify-uTys]{@uTys@: getting down to business}
81 %************************************************************************
83 @uTys@ is the heart of the unifier. Each arg happens twice, because
84 we want to report errors in terms of synomyms if poss. The first of
85 the pair is used in error messages only; it is always the same as the
86 second, except that if the first is a synonym then the second may be a
87 de-synonym'd version. This way we get better error messages.
89 We call the first one \tr{ps_ty1}, \tr{ps_ty2} for ``possible synomym''.
92 uTys :: TcTauType s -> TcTauType s -- Error reporting ty1 and real ty1
93 -> TcTauType s -> TcTauType s -- Error reporting ty2 and real ty2
96 -- Variables; go for uVar
97 uTys ps_ty1 (TyVarTy tyvar1) ps_ty2 ty2 = uVar tyvar1 ps_ty2 ty2
98 uTys ps_ty1 ty1 ps_ty2 (TyVarTy tyvar2) = uVar tyvar2 ps_ty1 ty1
100 -- Applications and functions; just check the two parts
101 uTys _ (FunTy fun1 arg1 _) _ (FunTy fun2 arg2 _)
102 = uTys fun1 fun1 fun2 fun2 `thenTc_` uTys arg1 arg1 arg2 arg2
103 uTys _ (AppTy s1 t1) _ (AppTy s2 t2)
104 = uTys s1 s1 s2 s2 `thenTc_` uTys t1 t1 t2 t2
106 -- Special case: converts a -> b to (->) a b
107 uTys _ (AppTy s1 t1) _ (FunTy fun2 arg2 _)
108 = uTys s1 s1 s2 s2 `thenTc_` uTys t1 t1 t2 t2
110 s2 = AppTy (TyConTy mkFunTyCon duffUsage) fun2
113 uTys _ (FunTy fun1 arg1 _) _ (AppTy s2 t2)
114 = uTys s1 s1 s2 s2 `thenTc_` uTys t1 t1 t2 t2
116 s1 = AppTy (TyConTy mkFunTyCon duffUsage) fun1
119 -- Type constructors must match
120 uTys ps_ty1 (TyConTy con1 _) ps_ty2 (TyConTy con2 _)
121 = checkTc (con1 == con2) (unifyMisMatch ps_ty1 ps_ty2)
123 -- Always expand synonyms (see notes at end)
124 uTys ps_ty1 (SynTy con1 args1 ty1) ps_ty2 ty2 = uTys ps_ty1 ty1 ps_ty2 ty2
125 uTys ps_ty1 ty1 ps_ty2 (SynTy con2 args2 ty2) = uTys ps_ty1 ty1 ps_ty2 ty2
127 -- Anything else fails
128 uTys ps_ty1 ty1 ps_ty2 ty2 = failTc (unifyMisMatch ps_ty1 ps_ty2)
133 If you are tempted to make a short cut on synonyms, as in this
137 uTys (SynTy con1 args1 ty1) (SynTy con2 args2 ty2)
138 = if (con1 == con2) then
139 -- Good news! Same synonym constructors, so we can shortcut
140 -- by unifying their arguments and ignoring their expansions.
141 unifyTauTypeLists args1 args2
143 -- Never mind. Just expand them and try again
147 then THINK AGAIN. Here is the whole story, as detected and reported
148 by Chris Okasaki \tr{<Chris_Okasaki@loch.mess.cs.cmu.edu>}:
150 Here's a test program that should detect the problem:
154 x = (1 :: Bogus Char) :: Bogus Bool
157 The problem with [the attempted shortcut code] is that
161 is not a sufficient condition to be able to use the shortcut!
162 You also need to know that the type synonym actually USES all
163 its arguments. For example, consider the following type synonym
164 which does not use all its arguments.
169 If you ever tried unifying, say, \tr{Bogus Char} with \tr{Bogus Bool},
170 the unifier would blithely try to unify \tr{Char} with \tr{Bool} and
171 would fail, even though the expanded forms (both \tr{Int}) should
174 Similarly, unifying \tr{Bogus Char} with \tr{Bogus t} would
175 unnecessarily bind \tr{t} to \tr{Char}.
177 ... You could explicitly test for the problem synonyms and mark them
178 somehow as needing expansion, perhaps also issuing a warning to the
183 %************************************************************************
185 \subsection[Unify-uVar]{@uVar@: unifying with a type variable}
187 %************************************************************************
189 @uVar@ is called when at least one of the types being unified is a
190 variable. It does {\em not} assume that the variable is a fixed point
191 of the substitution; rather, notice that @bindTo@ (defined below) nips
192 back into @uTys@ if it turns out that the variable is already bound.
194 There is a slight worry that one might try to @bindTo@ a (say) Poly
195 tyvar (as tv1) with an Open tyvar (as ty2) which is already unified to
196 an unboxed type. In fact this can't happen, because the Open ones are
197 always the ones which are unified away.
201 -> TcTauType s -> TcTauType s -- printing and real versions
205 = tcReadTyVar tv1 `thenNF_Tc` \ maybe_ty1 ->
207 BoundTo ty1 -> uTys ty1 ty1 ps_ty2 ty2
208 other -> uUnboundVar tv1 maybe_ty1 ps_ty2 ty2
211 uUnboundVar tv1 maybe_ty1 ps_ty2 (SynTy _ _ ty2)
212 = uUnboundVar tv1 maybe_ty1 ps_ty2 ty2
215 -- The both-type-variable case
216 uUnboundVar tv1@(TyVar uniq1 kind1 name1 box1)
219 ty2@(TyVarTy tv2@(TyVar uniq2 kind2 name2 box2))
221 -- Same type variable => no-op
225 -- Distinct type variables
226 -- ASSERT maybe_ty1 /= BoundTo
228 = tcReadTyVar tv2 `thenNF_Tc` \ maybe_ty2 ->
229 case (maybe_ty1, maybe_ty2) of
230 (_, BoundTo ty2') -> uUnboundVar tv1 maybe_ty1 ty2' ty2'
233 -> failTc (unifyDontBindErr tv1 ps_ty2)
235 (UnBound, _) | kind2 `hasMoreBoxityInfo` kind1
236 -> tcWriteTyVar tv1 ty2 `thenNF_Tc_` returnTc ()
238 (_, UnBound) | kind1 `hasMoreBoxityInfo` kind2
239 -> tcWriteTyVar tv2 (TyVarTy tv1) `thenNF_Tc_` returnTc ()
241 other -> failTc (unifyKindErr tv1 ps_ty2)
243 -- Second one isn't a type variable
244 uUnboundVar tv1@(TyVar uniq1 kind1 name1 box1) maybe_ty1 ps_ty2 non_var_ty2
246 DontBind -> failTc (unifyDontBindErr tv1 ps_ty2)
248 UnBound | typeKind non_var_ty2 `hasMoreBoxityInfo` kind1
249 -> occur_check non_var_ty2 `thenTc_`
250 tcWriteTyVar tv1 ps_ty2 `thenNF_Tc_`
253 other -> failTc (unifyKindErr tv1 ps_ty2)
255 occur_check (TyVarTy tv2@(TyVar uniq2 _ _ box2))
256 | uniq1 == uniq2 -- Same tyvar; fail
257 = failTc (unifyOccurCheck tv1 ps_ty2)
259 | otherwise -- A different tyvar
260 = tcReadTyVar tv2 `thenNF_Tc` \ maybe_ty2 ->
262 BoundTo ty2' -> occur_check ty2'
265 occur_check (AppTy fun arg) = occur_check fun `thenTc_` occur_check arg
266 occur_check (FunTy fun arg _) = occur_check fun `thenTc_` occur_check arg
267 occur_check (TyConTy _ _) = returnTc ()
268 occur_check (SynTy _ _ ty2) = occur_check ty2
269 occur_check other = panic "Unexpected Dict or ForAll in occurCheck"
272 %************************************************************************
274 \subsection[Unify-fun]{@unifyFunTy@}
276 %************************************************************************
278 @unifyFunTy@ is used to avoid the fruitless creation of type variables.
281 unifyFunTy :: TcType s -- Fail if ty isn't a function type
282 -> TcM s (TcType s, TcType s) -- otherwise return arg and result types
284 unifyFunTy ty@(TyVarTy tyvar)
285 = tcReadTyVar tyvar `thenNF_Tc` \ maybe_ty ->
287 BoundTo ty' -> unifyFunTy ty'
289 UnBound -> newTyVarTy mkTypeKind `thenNF_Tc` \ arg ->
290 newTyVarTy mkTypeKind `thenNF_Tc` \ res ->
291 tcWriteTyVar tyvar (mkFunTy arg res) `thenNF_Tc_`
294 DontBind -> failTc (expectedFunErr ty)
297 = case getFunTy_maybe other_ty of
298 Just arg_and_res -> returnTc arg_and_res
299 Nothing -> failTc (expectedFunErr other_ty)
303 %************************************************************************
305 \subsection[Unify-context]{Errors and contexts}
307 %************************************************************************
314 = zonkTcType ty1 `thenNF_Tc` \ ty1' ->
315 zonkTcType ty2 `thenNF_Tc` \ ty2' ->
316 returnNF_Tc (err ty1' ty2')
318 err ty1' ty2' sty = ppAboves [
319 ppCat [ppStr "When matching:", ppr sty ty1'],
320 ppCat [ppStr " against:", ppr sty ty2']
323 unifyMisMatch ty1 ty2 sty
324 = ppHang (ppStr "Couldn't match the type")
325 4 (ppSep [ppr sty ty1, ppStr "against", ppr sty ty2])
327 expectedFunErr ty sty
328 = ppHang (ppStr "Function type expected, but found the type")
331 unifyKindErr tyvar ty sty
332 = ppHang (ppStr "Compiler bug: kind mis-match between")
333 4 (ppSep [ppr sty tyvar, ppLparen, ppr sty (tyVarKind tyvar), ppRparen,
335 ppr sty ty, ppLparen, ppr sty (typeKind ty), ppRparen])
337 unifyDontBindErr tyvar ty sty
338 = ppHang (ppStr "Couldn't match the *signature/existential* type variable")
339 4 (ppSep [ppr sty tyvar,
340 ppStr "with the type",
343 unifyOccurCheck tyvar ty sty
344 = ppHang (ppStr "Cannot construct the infinite type (occur check)")
345 4 (ppSep [ppr sty tyvar, ppStr "=", ppr sty ty])