TcType.lhs 38.8 KB
Newer Older
1
2
3
4
5
%
% (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
%
\section[TcType]{Types used in the typechecker}

6
7
This module provides the Type interface for front-end parts of the 
compiler.  These parts 
8

9
10
11
	* treat "source types" as opaque: 
		newtypes, and predicates are meaningful. 
	* look through usage types
12

13
14
The "tc" prefix is for "typechechecker", because the type checker
is the principal client.
15

16
17
\begin{code}
module TcType (
18
  --------------------------------
19
  -- Types 
20
  TcType, TcSigmaType, TcRhoType, TcTauType, TcPredType, TcThetaType, 
21
  TcTyVar, TcTyVarSet, TcKind, 
22
23
24

  --------------------------------
  -- TyVarDetails
25
26
  TyVarDetails(..), isUserTyVar, isSkolemTyVar, isHoleTyVar, 
  tyVarBindingInfo,
27
28

  --------------------------------
29
  -- Builders
30
  mkPhiTy, mkSigmaTy, 
31

32
33
34
  --------------------------------
  -- Splitters  
  -- These are important because they do not look through newtypes
35
  tcSplitForAllTys, tcSplitPhiTy, 
36
37
  tcSplitFunTy_maybe, tcSplitFunTys, tcFunArgTy, tcFunResultTy,
  tcSplitTyConApp, tcSplitTyConApp_maybe, tcTyConAppTyCon, tcTyConAppArgs,
38
  tcSplitAppTy_maybe, tcSplitAppTy, tcSplitAppTys, tcSplitSigmaTy,
39
40
41
42
43
  tcSplitMethodTy, tcGetTyVar_maybe, tcGetTyVar,

  ---------------------------------
  -- Predicates. 
  -- Again, newtypes are opaque
44
  tcEqType, tcEqTypes, tcEqPred, tcCmpType, tcCmpTypes, tcCmpPred,
45
  isSigmaTy, isOverloadedTy, 
46
  isDoubleTy, isFloatTy, isIntTy,
47
  isIntegerTy, isAddrTy, isBoolTy, isUnitTy,
48
  isTauTy, tcIsTyVarTy, tcIsForAllTy,
49
  allDistinctTyVars,
50
51
52

  ---------------------------------
  -- Misc type manipulators
53
54
  deNoteType, classNamesOfTheta,
  tyClsNamesOfType, tyClsNamesOfDFunHead, 
55
56
57
58
  getDFunTyKey,

  ---------------------------------
  -- Predicate types  
59
  getClassPredTys_maybe, getClassPredTys, 
60
  isPredTy, isClassPred, isTyVarClassPred, predHasFDs,
61
  mkDictTy, tcSplitPredTy_maybe, 
62
  isDictTy, tcSplitDFunTy, predTyUnique, 
63
  mkClassPred, isInheritablePred, isLinearPred, isIPPred, mkPredName, 
64

65
66
67
68
69
70
71
72
73
74
  ---------------------------------
  -- Foreign import and export
  isFFIArgumentTy,     -- :: DynFlags -> Safety -> Type -> Bool
  isFFIImportResultTy, -- :: DynFlags -> Type -> Bool
  isFFIExportResultTy, -- :: Type -> Bool
  isFFIExternalTy,     -- :: Type -> Bool
  isFFIDynArgumentTy,  -- :: Type -> Bool
  isFFIDynResultTy,    -- :: Type -> Bool
  isFFILabelTy,        -- :: Type -> Bool

75
76
77
78
  ---------------------------------
  -- Unifier and matcher  
  unifyTysX, unifyTyListsX, unifyExtendTysX,
  matchTy, matchTys, match,
79

80
81
  --------------------------------
  -- Rexported from Type
82
83
84
  Kind, 	-- Stuff to do with kinds is insensitive to pre/post Tc
  unliftedTypeKind, liftedTypeKind, openTypeKind, mkArrowKind, mkArrowKinds, 
  superBoxity, liftedBoxity, hasMoreBoxityInfo, defaultKind, superKind,
85
  isTypeKind, isAnyTypeKind,
86
87

  Type, SourceType(..), PredType, ThetaType, 
88
89
  mkForAllTy, mkForAllTys, 
  mkFunTy, mkFunTys, zipFunTys, 
90
  mkTyConApp, mkGenTyConApp, mkAppTy, mkAppTys, mkSynTy, applyTy, applyTys,
91
  mkTyVarTy, mkTyVarTys, mkTyConTy, mkPredTy, mkPredTys, 
92

93
94
  isUnLiftedType,	-- Source types are always lifted
  isUnboxedTupleType,	-- Ditto
95
  isPrimitiveType, isTyVarTy,
96

97
  tidyTopType, tidyType, tidyPred, tidyTypes, tidyFreeTyVars, tidyOpenType, tidyOpenTypes,
98
  tidyTyVarBndr, tidyOpenTyVar, tidyOpenTyVars,
99
  typeKind, eqKind,
100
101

  tyVarsOfType, tyVarsOfTypes, tyVarsOfPred, tyVarsOfTheta
102
103
  ) where

104
#include "HsVersions.h"
105
106


107
import {-# SOURCE #-} PprType( pprType )
108
-- PprType imports TcType so that it can print intelligently
109

110
-- friends:
111
112
113
import TypeRep		( Type(..), TyNote(..), funTyCon )  -- friend

import Type		(	-- Re-exports
114
115
116
117
118
119
			  tyVarsOfType, tyVarsOfTypes, tyVarsOfPred,
			  tyVarsOfTheta, Kind, Type, SourceType(..),
			  PredType, ThetaType, unliftedTypeKind,
			  liftedTypeKind, openTypeKind, mkArrowKind,
			  mkArrowKinds, mkForAllTy, mkForAllTys,
			  defaultKind, isTypeKind, isAnyTypeKind,
120
			  mkFunTy, mkFunTys, zipFunTys, isTyVarTy,
121
122
123
124
125
			  mkTyConApp, mkGenTyConApp, mkAppTy,
			  mkAppTys, mkSynTy, applyTy, applyTys,
			  mkTyVarTy, mkTyVarTys, mkTyConTy, mkPredTy,
			  mkPredTys, isUnLiftedType,
			  isUnboxedTupleType, isPrimitiveType,
126
			  splitNewType_maybe, splitTyConApp_maybe,
127
128
129
			  tidyTopType, tidyType, tidyPred, tidyTypes,
			  tidyFreeTyVars, tidyOpenType, tidyOpenTypes,
			  tidyTyVarBndr, tidyOpenTyVar,
130
			  tidyOpenTyVars, eqKind, 
131
132
			  hasMoreBoxityInfo, liftedBoxity,
			  superBoxity, typeKind, superKind, repType
133
			)
134
135
import TyCon		( TyCon, isUnLiftedTyCon )
import Class		( classHasFDs, Class )
136
import Var		( TyVar, tyVarKind, isMutTyVar, mutTyVarDetails )
137
import ForeignCall	( Safety, playSafe )
138
139
import VarEnv
import VarSet
140
141

-- others:
142
import CmdLineOpts	( DynFlags, DynFlag( Opt_GlasgowExts ), dopt )
143
import Name		( Name, NamedThing(..), mkInternalName, getSrcLoc )
144
145
import OccName		( OccName, mkDictOcc )
import NameSet
146
import PrelNames	-- Lots (e.g. in isFFIArgumentTy)
147
import TysWiredIn	( ptrTyCon, funPtrTyCon, addrTyCon, unitTyCon )
148
import BasicTypes	( IPName(..), ipNameName )
149
import Unique		( Unique, Uniquable(..) )
150
import SrcLoc		( SrcLoc )
151
import Util		( cmpList, thenCmp, equalLength, snocView )
152
import Maybes		( maybeToBool, expectJust )
153
import Outputable
154
155
156
\end{code}


157
158
%************************************************************************
%*									*
159
160
161
162
\subsection{Types}
%*									*
%************************************************************************

163
164
165
The type checker divides the generic Type world into the 
following more structured beasts:

166
sigma ::= forall tyvars. phi
167
168
169
170
171
172
173
174
175
176
	-- A sigma type is a qualified type
	--
	-- Note that even if 'tyvars' is empty, theta
	-- may not be: e.g.   (?x::Int) => Int

	-- Note that 'sigma' is in prenex form:
	-- all the foralls are at the front.
	-- A 'phi' type has no foralls to the right of
	-- an arrow

177
178
179
phi :: theta => rho

rho ::= sigma -> rho
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
     |  tau

-- A 'tau' type has no quantification anywhere
-- Note that the args of a type constructor must be taus
tau ::= tyvar
     |  tycon tau_1 .. tau_n
     |  tau_1 tau_2
     |  tau_1 -> tau_2

-- In all cases, a (saturated) type synonym application is legal,
-- provided it expands to the required form.


\begin{code}
type SigmaType = Type
195
type RhoType   = Type
196
197
198
type TauType   = Type
\end{code}

199
200
201
202
203
204
205
206
207
208
209
210
\begin{code}
type TcTyVar    = TyVar		-- Might be a mutable tyvar
type TcTyVarSet = TyVarSet

type TcType = Type 		-- A TcType can have mutable type variables
	-- Invariant on ForAllTy in TcTypes:
	-- 	forall a. T
	-- a cannot occur inside a MutTyVar in T; that is,
	-- T is "flattened" before quantifying over a

type TcPredType     = PredType
type TcThetaType    = ThetaType
211
type TcSigmaType    = TcType
212
type TcRhoType      = TcType
213
type TcTauType      = TcType
214
215
216
217
218
219
220
type TcKind         = TcType
\end{code}


%************************************************************************
%*									*
\subsection{TyVarDetails}
221
222
223
%*									*
%************************************************************************

224
225
TyVarDetails gives extra info about type variables, used during type
checking.  It's attached to mutable type variables only.
226
227
It's knot-tied back to Var.lhs.  There is no reason in principle
why Var.lhs shouldn't actually have the definition, but it "belongs" here.
228

229
\begin{code}
230
data TyVarDetails
231
232
233
234
235
236
  = HoleTv	-- Used *only* by the type checker when passing in a type
		-- variable that should be side-effected to the result type.
		-- Always has kind openTypeKind.
		-- Never appears in types

  | SigTv	-- Introduced when instantiating a type signature,
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
		-- prior to checking that the defn of a fn does 
		-- have the expected type.  Should not be instantiated.
		--
		-- 	f :: forall a. a -> a
		-- 	f = e
		-- When checking e, with expected type (a->a), we 
		-- should not instantiate a

   | ClsTv	-- Scoped type variable introduced by a class decl
		--	class C a where ...

   | InstTv	-- Ditto, but instance decl

   | PatSigTv	-- Scoped type variable, introduced by a pattern
		-- type signature
		--	\ x::a -> e

   | VanillaTv	-- Everything else

256
257
258
259
260
261
262
isUserTyVar :: TcTyVar -> Bool	-- Avoid unifying these if possible
isUserTyVar tv = case mutTyVarDetails tv of
		   VanillaTv -> False
		   other     -> True

isSkolemTyVar :: TcTyVar -> Bool
isSkolemTyVar tv = case mutTyVarDetails tv of
263
264
265
		      SigTv  -> True
		      ClsTv  -> True
		      InstTv -> True
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
		      oteher -> False

isHoleTyVar :: TcTyVar -> Bool
-- NB:  the hole might be filled in by now, and this
--	function does not check for that
isHoleTyVar tv = ASSERT( isMutTyVar tv )
		 case mutTyVarDetails tv of
			HoleTv -> True
			other  -> False

tyVarBindingInfo :: TyVar -> SDoc	-- Used in checkSigTyVars
tyVarBindingInfo tv
  | isMutTyVar tv
  = sep [ptext SLIT("is bound by the") <+> details (mutTyVarDetails tv),
	 ptext SLIT("at") <+> ppr (getSrcLoc tv)]
  | otherwise
  = empty
  where
    details SigTv     = ptext SLIT("type signature")
    details ClsTv     = ptext SLIT("class declaration")
    details InstTv    = ptext SLIT("instance declaration")
    details PatSigTv  = ptext SLIT("pattern type signature")
    details HoleTv    = ptext SLIT("//hole//")		-- Should not happen
    details VanillaTv = ptext SLIT("//vanilla//")	-- Ditto
290
\end{code}
291

292
293
294
295
296
297
298
299

%************************************************************************
%*									*
\subsection{Tau, sigma and rho}
%*									*
%************************************************************************

\begin{code}
300
mkSigmaTy tyvars theta tau = mkForAllTys tyvars (mkPhiTy theta tau)
sof's avatar
sof committed
301

302
303
mkPhiTy :: [SourceType] -> Type -> Type
mkPhiTy theta ty = foldr (\p r -> FunTy (mkPredTy p) r) ty theta
304
305
306
307
\end{code}


@isTauTy@ tests for nested for-alls.
sof's avatar
sof committed
308

309
\begin{code}
310
311
312
313
314
isTauTy :: Type -> Bool
isTauTy (TyVarTy v)	 = True
isTauTy (TyConApp _ tys) = all isTauTy tys
isTauTy (AppTy a b)	 = isTauTy a && isTauTy b
isTauTy (FunTy a b)	 = isTauTy a && isTauTy b
315
isTauTy (SourceTy p)	 = True		-- Don't look through source types
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
isTauTy (NoteTy _ ty)	 = isTauTy ty
isTauTy other		 = False
\end{code}

\begin{code}
getDFunTyKey :: Type -> OccName	-- Get some string from a type, to be used to 
				-- construct a dictionary function name
getDFunTyKey (TyVarTy tv)    	     = getOccName tv
getDFunTyKey (TyConApp tc _) 	     = getOccName tc
getDFunTyKey (AppTy fun _)   	     = getDFunTyKey fun
getDFunTyKey (NoteTy _ t)    	     = getDFunTyKey t
getDFunTyKey (FunTy arg _)   	     = getOccName funTyCon
getDFunTyKey (ForAllTy _ t)  	     = getDFunTyKey t
getDFunTyKey (SourceTy (NType tc _)) = getOccName tc	-- Newtypes are quite reasonable
getDFunTyKey ty		     	     = pprPanic "getDFunTyKey" (pprType ty)
-- SourceTy shouldn't happen
sof's avatar
sof committed
332
333
334
\end{code}


335
336
%************************************************************************
%*									*
337
\subsection{Expanding and splitting}
338
339
%*									*
%************************************************************************
340

341
342
343
344
345
346
347
348
These tcSplit functions are like their non-Tc analogues, but
	a) they do not look through newtypes
	b) they do not look through PredTys
	c) [future] they ignore usage-type annotations

However, they are non-monadic and do not follow through mutable type
variables.  It's up to you to make sure this doesn't matter.

349
\begin{code}
350
351
352
353
354
355
356
357
358
359
360
tcSplitForAllTys :: Type -> ([TyVar], Type)
tcSplitForAllTys ty = split ty ty []
   where
     split orig_ty (ForAllTy tv ty) tvs = split ty ty (tv:tvs)
     split orig_ty (NoteTy n  ty)   tvs = split orig_ty ty tvs
     split orig_ty t		    tvs = (reverse tvs, orig_ty)

tcIsForAllTy (ForAllTy tv ty) = True
tcIsForAllTy (NoteTy n ty)    = tcIsForAllTy ty
tcIsForAllTy t		      = False

361
362
tcSplitPhiTy :: Type -> ([PredType], Type)
tcSplitPhiTy ty = split ty ty []
363
364
365
366
367
368
369
370
 where
  split orig_ty (FunTy arg res) ts = case tcSplitPredTy_maybe arg of
					Just p  -> split res res (p:ts)
					Nothing -> (reverse ts, orig_ty)
  split orig_ty (NoteTy n ty)	ts = split orig_ty ty ts
  split orig_ty ty		ts = (reverse ts, orig_ty)

tcSplitSigmaTy ty = case tcSplitForAllTys ty of
371
			(tvs, rho) -> case tcSplitPhiTy rho of
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
					(theta, tau) -> (tvs, theta, tau)

tcTyConAppTyCon :: Type -> TyCon
tcTyConAppTyCon ty = fst (tcSplitTyConApp ty)

tcTyConAppArgs :: Type -> [Type]
tcTyConAppArgs ty = snd (tcSplitTyConApp ty)

tcSplitTyConApp :: Type -> (TyCon, [Type])
tcSplitTyConApp ty = case tcSplitTyConApp_maybe ty of
			Just stuff -> stuff
			Nothing	   -> pprPanic "tcSplitTyConApp" (pprType ty)

tcSplitTyConApp_maybe :: Type -> Maybe (TyCon, [Type])
tcSplitTyConApp_maybe (TyConApp tc tys) 	= Just (tc, tys)
387
tcSplitTyConApp_maybe (FunTy arg res)   	= Just (funTyCon, [arg,res])
388
389
tcSplitTyConApp_maybe (NoteTy n ty)     	= tcSplitTyConApp_maybe ty
tcSplitTyConApp_maybe (SourceTy (NType tc tys)) = Just (tc,tys)
390
	-- Newtypes are opaque, so they may be split
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
	-- However, predicates are not treated
	-- as tycon applications by the type checker
tcSplitTyConApp_maybe other	        	= Nothing

tcSplitFunTys :: Type -> ([Type], Type)
tcSplitFunTys ty = case tcSplitFunTy_maybe ty of
			Nothing	       -> ([], ty)
			Just (arg,res) -> (arg:args, res')
				       where
					  (args,res') = tcSplitFunTys res

tcSplitFunTy_maybe :: Type -> Maybe (Type, Type)
tcSplitFunTy_maybe (FunTy arg res)  = Just (arg, res)
tcSplitFunTy_maybe (NoteTy n ty)    = tcSplitFunTy_maybe ty
tcSplitFunTy_maybe other	    = Nothing

tcFunArgTy    ty = case tcSplitFunTy_maybe ty of { Just (arg,res) -> arg }
tcFunResultTy ty = case tcSplitFunTy_maybe ty of { Just (arg,res) -> res }


tcSplitAppTy_maybe :: Type -> Maybe (Type, Type)
412
tcSplitAppTy_maybe (FunTy ty1 ty2)   	     = Just (TyConApp funTyCon [ty1], ty2)
413
414
tcSplitAppTy_maybe (AppTy ty1 ty2)   	     = Just (ty1, ty2)
tcSplitAppTy_maybe (NoteTy n ty)     	     = tcSplitAppTy_maybe ty
415
tcSplitAppTy_maybe (SourceTy (NType tc tys)) = tc_split_app tc tys	--- Don't forget that newtype!
416
417
418
tcSplitAppTy_maybe (TyConApp tc tys)	     = tc_split_app tc tys
tcSplitAppTy_maybe other	  	     = Nothing

419
420
421
tc_split_app tc tys = case snocView tys of
			Just (tys',ty') -> Just (TyConApp tc tys', ty')
			Nothing		-> Nothing
422
423
424
425
426

tcSplitAppTy ty = case tcSplitAppTy_maybe ty of
		    Just stuff -> stuff
		    Nothing    -> pprPanic "tcSplitAppTy" (pprType ty)

427
428
429
430
431
432
433
434
tcSplitAppTys :: Type -> (Type, [Type])
tcSplitAppTys ty
  = go ty []
  where
    go ty args = case tcSplitAppTy_maybe ty of
		   Just (ty', arg) -> go ty' (arg:args)
		   Nothing	   -> (ty,args)

435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
tcGetTyVar_maybe :: Type -> Maybe TyVar
tcGetTyVar_maybe (TyVarTy tv) 	= Just tv
tcGetTyVar_maybe (NoteTy _ t) 	= tcGetTyVar_maybe t
tcGetTyVar_maybe other	        = Nothing

tcGetTyVar :: String -> Type -> TyVar
tcGetTyVar msg ty = expectJust msg (tcGetTyVar_maybe ty)

tcIsTyVarTy :: Type -> Bool
tcIsTyVarTy ty = maybeToBool (tcGetTyVar_maybe ty)
\end{code}

The type of a method for class C is always of the form:
	Forall a1..an. C a1..an => sig_ty
where sig_ty is the type given by the method's signature, and thus in general
is a ForallTy.  At the point that splitMethodTy is called, it is expected
that the outer Forall has already been stripped off.  splitMethodTy then
452
returns (C a1..an, sig_ty') where sig_ty' is sig_ty with any Notes stripped off.
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469

\begin{code}
tcSplitMethodTy :: Type -> (PredType, Type)
tcSplitMethodTy ty = split ty
 where
  split (FunTy arg res) = case tcSplitPredTy_maybe arg of
			    Just p  -> (p, res)
			    Nothing -> panic "splitMethodTy"
  split (NoteTy n ty)	= split ty
  split _               = panic "splitMethodTy"

tcSplitDFunTy :: Type -> ([TyVar], [SourceType], Class, [Type])
-- Split the type of a dictionary function
tcSplitDFunTy ty 
  = case tcSplitSigmaTy ty       of { (tvs, theta, tau) ->
    case tcSplitPredTy_maybe tau of { Just (ClassP clas tys) -> 
    (tvs, theta, clas, tys) }}
470
471
\end{code}

472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
(allDistinctTyVars tys tvs) = True 
	iff 
all the types tys are type variables, 
distinct from each other and from tvs.

This is useful when checking that unification hasn't unified signature
type variables.  For example, if the type sig is
	f :: forall a b. a -> b -> b
we want to check that 'a' and 'b' havn't 
	(a) been unified with a non-tyvar type
	(b) been unified with each other (all distinct)
	(c) been unified with a variable free in the environment

\begin{code}
allDistinctTyVars :: [Type] -> TyVarSet -> Bool

allDistinctTyVars []       acc
  = True
allDistinctTyVars (ty:tys) acc 
  = case tcGetTyVar_maybe ty of
	Nothing 		      -> False 	-- (a)
	Just tv | tv `elemVarSet` acc -> False	-- (b) or (c)
		| otherwise           -> allDistinctTyVars tys (acc `extendVarSet` tv)
\end{code}    

497
498
499

%************************************************************************
%*									*
500
\subsection{Predicate types}
501
502
%*									*
%************************************************************************
503

504
"Predicates" are particular source types, namelyClassP or IParams
505

506
\begin{code}
507
508
509
isPred :: SourceType -> Bool
isPred (ClassP _ _) = True
isPred (IParam _ _) = True
510
isPred (NType _ _)  = False
511
512
513
514
515
516
517
518
519
520
521

isPredTy :: Type -> Bool
isPredTy (NoteTy _ ty)  = isPredTy ty
isPredTy (SourceTy sty) = isPred sty
isPredTy _	        = False

tcSplitPredTy_maybe :: Type -> Maybe PredType
   -- Returns Just for predicates only
tcSplitPredTy_maybe (NoteTy _ ty)  	    = tcSplitPredTy_maybe ty
tcSplitPredTy_maybe (SourceTy p) | isPred p = Just p
tcSplitPredTy_maybe other	      	    = Nothing
522
	
523
predTyUnique :: PredType -> Unique
524
predTyUnique (IParam n _)      = getUnique (ipNameName n)
525
526
527
528
529
530
531
532
533
predTyUnique (ClassP clas tys) = getUnique clas

predHasFDs :: PredType -> Bool
-- True if the predicate has functional depenencies; 
-- I.e. should participate in improvement
predHasFDs (IParam _ _)   = True
predHasFDs (ClassP cls _) = classHasFDs cls

mkPredName :: Unique -> SrcLoc -> SourceType -> Name
534
535
mkPredName uniq loc (ClassP cls tys) = mkInternalName uniq (mkDictOcc (getOccName cls)) loc
mkPredName uniq loc (IParam ip ty)   = mkInternalName uniq (getOccName (ipNameName ip)) loc
536
537
\end{code}

538
539

--------------------- Dictionary types ---------------------------------
540
541

\begin{code}
542
mkClassPred clas tys = ClassP clas tys
543
544
545
546
547

isClassPred :: SourceType -> Bool
isClassPred (ClassP clas tys) = True
isClassPred other	      = False

548
isTyVarClassPred (ClassP clas tys) = all tcIsTyVarTy tys
549
550
551
552
553
554
555
556
557
558
isTyVarClassPred other		   = False

getClassPredTys_maybe :: SourceType -> Maybe (Class, [Type])
getClassPredTys_maybe (ClassP clas tys) = Just (clas, tys)
getClassPredTys_maybe _		        = Nothing

getClassPredTys :: PredType -> (Class, [Type])
getClassPredTys (ClassP clas tys) = (clas, tys)

mkDictTy :: Class -> [Type] -> Type
559
mkDictTy clas tys = mkPredTy (ClassP clas tys)
560
561
562
563
564

isDictTy :: Type -> Bool
isDictTy (SourceTy p)   = isClassPred p
isDictTy (NoteTy _ ty)	= isDictTy ty
isDictTy other		= False
565
\end{code}
566

567
568
569
570
571
572
573
--------------------- Implicit parameters ---------------------------------

\begin{code}
isIPPred :: SourceType -> Bool
isIPPred (IParam _ _) = True
isIPPred other	      = False

574
isInheritablePred :: PredType -> Bool
575
576
577
578
579
580
581
582
-- Can be inherited by a context.  For example, consider
--	f x = let g y = (?v, y+x)
--	      in (g 3 with ?v = 8, 
--		  g 4 with ?v = 9)
-- The point is that g's type must be quantifed over ?v:
--	g :: (?v :: a) => a -> a
-- but it doesn't need to be quantified over the Num a dictionary
-- which can be free in g's rhs, and shared by both calls to g
583
584
585
586
587
588
isInheritablePred (ClassP _ _) = True
isInheritablePred other	     = False

isLinearPred :: TcPredType -> Bool
isLinearPred (IParam (Linear n) _) = True
isLinearPred other		   = False
589
\end{code}
590
591


592
593
%************************************************************************
%*									*
594
\subsection{Comparison}
595
596
%*									*
%************************************************************************
597

598
599
600
Comparison, taking note of newtypes, predicates, etc,
But ignoring usage types

601
\begin{code}
602
603
604
tcEqType :: Type -> Type -> Bool
tcEqType ty1 ty2 = case ty1 `tcCmpType` ty2 of { EQ -> True; other -> False }

605
606
607
tcEqTypes :: [Type] -> [Type] -> Bool
tcEqTypes ty1 ty2 = case ty1 `tcCmpTypes` ty2 of { EQ -> True; other -> False }

608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
tcEqPred :: PredType -> PredType -> Bool
tcEqPred p1 p2 = case p1 `tcCmpPred` p2 of { EQ -> True; other -> False }

-------------
tcCmpType :: Type -> Type -> Ordering
tcCmpType ty1 ty2 = cmpTy emptyVarEnv ty1 ty2

tcCmpTypes tys1 tys2 = cmpTys emptyVarEnv tys1 tys2

tcCmpPred p1 p2 = cmpSourceTy emptyVarEnv p1 p2
-------------
cmpTys env tys1 tys2 = cmpList (cmpTy env) tys1 tys2

-------------
cmpTy :: TyVarEnv TyVar -> Type -> Type -> Ordering
  -- The "env" maps type variables in ty1 to type variables in ty2
  -- So when comparing for-alls.. (forall tv1 . t1) (forall tv2 . t2)
  -- we in effect substitute tv2 for tv1 in t1 before continuing

627
    -- Look through NoteTy
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
cmpTy env (NoteTy _ ty1) ty2 = cmpTy env ty1 ty2
cmpTy env ty1 (NoteTy _ ty2) = cmpTy env ty1 ty2

    -- Deal with equal constructors
cmpTy env (TyVarTy tv1) (TyVarTy tv2) = case lookupVarEnv env tv1 of
					  Just tv1a -> tv1a `compare` tv2
					  Nothing   -> tv1  `compare` tv2

cmpTy env (SourceTy p1) (SourceTy p2) = cmpSourceTy env p1 p2
cmpTy env (AppTy f1 a1) (AppTy f2 a2) = cmpTy env f1 f2 `thenCmp` cmpTy env a1 a2
cmpTy env (FunTy f1 a1) (FunTy f2 a2) = cmpTy env f1 f2 `thenCmp` cmpTy env a1 a2
cmpTy env (TyConApp tc1 tys1) (TyConApp tc2 tys2) = (tc1 `compare` tc2) `thenCmp` (cmpTys env tys1 tys2)
cmpTy env (ForAllTy tv1 t1)   (ForAllTy tv2 t2)   = cmpTy (extendVarEnv env tv1 tv2) t1 t2
    
    -- Deal with the rest: TyVarTy < AppTy < FunTy < TyConApp < ForAllTy < SourceTy
cmpTy env (AppTy _ _) (TyVarTy _) = GT
    
cmpTy env (FunTy _ _) (TyVarTy _) = GT
cmpTy env (FunTy _ _) (AppTy _ _) = GT
    
cmpTy env (TyConApp _ _) (TyVarTy _) = GT
cmpTy env (TyConApp _ _) (AppTy _ _) = GT
cmpTy env (TyConApp _ _) (FunTy _ _) = GT
    
cmpTy env (ForAllTy _ _) (TyVarTy _)    = GT
cmpTy env (ForAllTy _ _) (AppTy _ _)    = GT
cmpTy env (ForAllTy _ _) (FunTy _ _)    = GT
cmpTy env (ForAllTy _ _) (TyConApp _ _) = GT

cmpTy env (SourceTy _)   t2		= GT

cmpTy env _ _ = LT
660
661
662
\end{code}

\begin{code}
663
cmpSourceTy :: TyVarEnv TyVar -> SourceType -> SourceType -> Ordering
664
cmpSourceTy env (IParam n1 ty1) (IParam n2 ty2) = (n1 `compare` n2) `thenCmp` (cmpTy env ty1 ty2)
665
666
667
668
669
670
671
672
673
674
675
676
	-- Compare types as well as names for implicit parameters
	-- This comparison is used exclusively (I think) for the
	-- finite map built in TcSimplify
cmpSourceTy env (IParam _ _)     sty		  = LT

cmpSourceTy env (ClassP _ _)     (IParam _ _)     = GT
cmpSourceTy env (ClassP c1 tys1) (ClassP c2 tys2) = (c1 `compare` c2) `thenCmp` (cmpTys env tys1 tys2)
cmpSourceTy env (ClassP _ _)     (NType _ _)      = LT

cmpSourceTy env (NType tc1 tys1) (NType tc2 tys2) = (tc1 `compare` tc2) `thenCmp` (cmpTys env tys1 tys2)
cmpSourceTy env (NType _ _)	 sty		  = GT
\end{code}
677

678
679
680
681
682
683
PredTypes are used as a FM key in TcSimplify, 
so we take the easy path and make them an instance of Ord

\begin{code}
instance Eq  SourceType where { (==)    = tcEqPred }
instance Ord SourceType where { compare = tcCmpPred }
684
685
\end{code}

686

687
688
689
690
691
%************************************************************************
%*									*
\subsection{Predicates}
%*									*
%************************************************************************
692

693
isSigmaTy returns true of any qualified type.  It doesn't *necessarily* have 
694
695
any foralls.  E.g.
	f :: (?x::Int) => Int -> Int
696

697
\begin{code}
698
699
700
701
702
isSigmaTy :: Type -> Bool
isSigmaTy (ForAllTy tyvar ty) = True
isSigmaTy (FunTy a b)	      = isPredTy a
isSigmaTy (NoteTy n ty)	      = isSigmaTy ty
isSigmaTy _		      = False
703
704
705
706
707
708
709

isOverloadedTy :: Type -> Bool
isOverloadedTy (ForAllTy tyvar ty) = isOverloadedTy ty
isOverloadedTy (FunTy a b)	   = isPredTy a
isOverloadedTy (NoteTy n ty)	   = isOverloadedTy ty
isOverloadedTy _		   = False
\end{code}
710
711

\begin{code}
712
713
714
715
716
717
isFloatTy      = is_tc floatTyConKey
isDoubleTy     = is_tc doubleTyConKey
isIntegerTy    = is_tc integerTyConKey
isIntTy        = is_tc intTyConKey
isAddrTy       = is_tc addrTyConKey
isBoolTy       = is_tc boolTyConKey
718
isUnitTy       = is_tc unitTyConKey
719
720
721
722
723
724
725

is_tc :: Unique -> Type -> Bool
-- Newtypes are opaque to this
is_tc uniq ty = case tcSplitTyConApp_maybe ty of
			Just (tc, _) -> uniq == getUnique tc
			Nothing	     -> False
\end{code}
726

727

728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
%************************************************************************
%*									*
\subsection{Misc}
%*									*
%************************************************************************

\begin{code}
deNoteType :: Type -> Type
	-- Remove synonyms, but not source types
deNoteType ty@(TyVarTy tyvar)	= ty
deNoteType (TyConApp tycon tys) = TyConApp tycon (map deNoteType tys)
deNoteType (SourceTy p)		= SourceTy (deNoteSourceType p)
deNoteType (NoteTy _ ty)	= deNoteType ty
deNoteType (AppTy fun arg)	= AppTy (deNoteType fun) (deNoteType arg)
deNoteType (FunTy fun arg)	= FunTy (deNoteType fun) (deNoteType arg)
deNoteType (ForAllTy tv ty)	= ForAllTy tv (deNoteType ty)

deNoteSourceType :: SourceType -> SourceType
746
747
748
deNoteSourceType (ClassP c tys)   = ClassP c (map deNoteType tys)
deNoteSourceType (IParam n ty)    = IParam n (deNoteType ty)
deNoteSourceType (NType tc tys)   = NType tc (map deNoteType tys)
749
750
\end{code}

751
752
Find the free tycons and classes of a type.  This is used in the front
end of the compiler.
753

754
\begin{code}
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
tyClsNamesOfType :: Type -> NameSet
tyClsNamesOfType (TyVarTy tv)		    = emptyNameSet
tyClsNamesOfType (TyConApp tycon tys)	    = unitNameSet (getName tycon) `unionNameSets` tyClsNamesOfTypes tys
tyClsNamesOfType (NoteTy (SynNote ty1) ty2) = tyClsNamesOfType ty1
tyClsNamesOfType (NoteTy other_note    ty2) = tyClsNamesOfType ty2
tyClsNamesOfType (SourceTy (IParam n ty))   = tyClsNamesOfType ty
tyClsNamesOfType (SourceTy (ClassP cl tys)) = unitNameSet (getName cl) `unionNameSets` tyClsNamesOfTypes tys
tyClsNamesOfType (SourceTy (NType tc tys))  = unitNameSet (getName tc) `unionNameSets` tyClsNamesOfTypes tys
tyClsNamesOfType (FunTy arg res)	    = tyClsNamesOfType arg `unionNameSets` tyClsNamesOfType res
tyClsNamesOfType (AppTy fun arg)	    = tyClsNamesOfType fun `unionNameSets` tyClsNamesOfType arg
tyClsNamesOfType (ForAllTy tyvar ty)	    = tyClsNamesOfType ty

tyClsNamesOfTypes tys = foldr (unionNameSets . tyClsNamesOfType) emptyNameSet tys

tyClsNamesOfDFunHead :: Type -> NameSet
770
771
772
773
774
775
-- Find the free type constructors and classes 
-- of the head of the dfun instance type
-- The 'dfun_head_type' is because of
--	instance Foo a => Baz T where ...
-- The decl is an orphan if Baz and T are both not locally defined,
--	even if Foo *is* locally defined
776
777
778
779
780
781
782
tyClsNamesOfDFunHead dfun_ty 
  = case tcSplitSigmaTy dfun_ty of
	(tvs,_,head_ty) -> tyClsNamesOfType head_ty

classNamesOfTheta :: ThetaType -> [Name]
-- Looks just for ClassP things; maybe it should check
classNamesOfTheta preds = [ getName c | ClassP c _ <- preds ]
783
784
785
\end{code}


786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
%************************************************************************
%*									*
\subsection[TysWiredIn-ext-type]{External types}
%*									*
%************************************************************************

The compiler's foreign function interface supports the passing of a
restricted set of types as arguments and results (the restricting factor
being the )

\begin{code}
isFFIArgumentTy :: DynFlags -> Safety -> Type -> Bool
-- Checks for valid argument type for a 'foreign import'
isFFIArgumentTy dflags safety ty 
   = checkRepTyCon (legalOutgoingTyCon dflags safety) ty

isFFIExternalTy :: Type -> Bool
-- Types that are allowed as arguments of a 'foreign export'
isFFIExternalTy ty = checkRepTyCon legalFEArgTyCon ty

isFFIImportResultTy :: DynFlags -> Type -> Bool
isFFIImportResultTy dflags ty 
  = checkRepTyCon (legalFIResultTyCon dflags) ty

isFFIExportResultTy :: Type -> Bool
isFFIExportResultTy ty = checkRepTyCon legalFEResultTyCon ty

isFFIDynArgumentTy :: Type -> Bool
-- The argument type of a foreign import dynamic must be Ptr, FunPtr, Addr,
-- or a newtype of either.
isFFIDynArgumentTy = checkRepTyCon (\tc -> tc == ptrTyCon || tc == funPtrTyCon || tc == addrTyCon)

isFFIDynResultTy :: Type -> Bool
-- The result type of a foreign export dynamic must be Ptr, FunPtr, Addr,
-- or a newtype of either.
isFFIDynResultTy = checkRepTyCon (\tc -> tc == ptrTyCon || tc == funPtrTyCon || tc == addrTyCon)

isFFILabelTy :: Type -> Bool
-- The type of a foreign label must be Ptr, FunPtr, Addr,
-- or a newtype of either.
isFFILabelTy = checkRepTyCon (\tc -> tc == ptrTyCon || tc == funPtrTyCon || tc == addrTyCon)

checkRepTyCon :: (TyCon -> Bool) -> Type -> Bool
	-- Look through newtypes
	-- Non-recursive ones are transparent to splitTyConApp,
	-- but recursive ones aren't; hence the splitNewType_maybe
checkRepTyCon check_tc ty 
833
834
  | Just (tc,_) <- splitTyConApp_maybe (repType ty) = check_tc tc
  | otherwise				  	    = False
835
836
837
838
839
840
841
842
843
844
845
846
\end{code}

----------------------------------------------
These chaps do the work; they are not exported
----------------------------------------------

\begin{code}
legalFEArgTyCon :: TyCon -> Bool
-- It's illegal to return foreign objects and (mutable)
-- bytearrays from a _ccall_ / foreign declaration
-- (or be passed them as arguments in foreign exported functions).
legalFEArgTyCon tc
847
  | getUnique tc `elem` [ byteArrayTyConKey, mutableByteArrayTyConKey ] 
848
849
850
851
852
853
854
855
856
  = False
  -- It's also illegal to make foreign exports that take unboxed
  -- arguments.  The RTS API currently can't invoke such things.  --SDM 7/2000
  | otherwise
  = boxedMarshalableTyCon tc

legalFIResultTyCon :: DynFlags -> TyCon -> Bool
legalFIResultTyCon dflags tc
  | getUnique tc `elem`
857
	[ byteArrayTyConKey, mutableByteArrayTyConKey ]  = False
858
859
860
861
862
863
  | tc == unitTyCon = True
  | otherwise	    = marshalableTyCon dflags tc

legalFEResultTyCon :: TyCon -> Bool
legalFEResultTyCon tc
  | getUnique tc `elem` 
864
	[ byteArrayTyConKey, mutableByteArrayTyConKey ]  = False
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
  | tc == unitTyCon = True
  | otherwise       = boxedMarshalableTyCon tc

legalOutgoingTyCon :: DynFlags -> Safety -> TyCon -> Bool
-- Checks validity of types going from Haskell -> external world
legalOutgoingTyCon dflags safety tc
  | playSafe safety && getUnique tc `elem` [byteArrayTyConKey, mutableByteArrayTyConKey]
  = False
  | otherwise
  = marshalableTyCon dflags tc

marshalableTyCon dflags tc
  =  (dopt Opt_GlasgowExts dflags && isUnLiftedTyCon tc)
  || boxedMarshalableTyCon tc

boxedMarshalableTyCon tc
   = getUnique tc `elem` [ intTyConKey, int8TyConKey, int16TyConKey
			 , int32TyConKey, int64TyConKey
			 , wordTyConKey, word8TyConKey, word16TyConKey
			 , word32TyConKey, word64TyConKey
			 , floatTyConKey, doubleTyConKey
			 , addrTyConKey, ptrTyConKey, funPtrTyConKey
887
			 , charTyConKey
888
889
890
891
892
893
894
			 , stablePtrTyConKey
			 , byteArrayTyConKey, mutableByteArrayTyConKey
			 , boolTyConKey
			 ]
\end{code}


895
896
897
898
899
900
901
902
%************************************************************************
%*									*
\subsection{Unification with an explicit substitution}
%*									*
%************************************************************************

Unify types with an explicit substitution and no monad.
Ignore usage annotations.
903
904

\begin{code}
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
type MySubst
   = (TyVarSet,		-- Set of template tyvars
      TyVarSubstEnv)	-- Not necessarily idempotent

unifyTysX :: TyVarSet		-- Template tyvars
	  -> Type
          -> Type
          -> Maybe TyVarSubstEnv
unifyTysX tmpl_tyvars ty1 ty2
  = uTysX ty1 ty2 (\(_,s) -> Just s) (tmpl_tyvars, emptySubstEnv)

unifyExtendTysX :: TyVarSet		-- Template tyvars
		-> TyVarSubstEnv	-- Substitution to start with
		-> Type
	        -> Type
        	-> Maybe TyVarSubstEnv	-- Extended substitution
unifyExtendTysX tmpl_tyvars subst ty1 ty2
  = uTysX ty1 ty2 (\(_,s) -> Just s) (tmpl_tyvars, subst)

unifyTyListsX :: TyVarSet -> [Type] -> [Type]
              -> Maybe TyVarSubstEnv
unifyTyListsX tmpl_tyvars tys1 tys2
  = uTyListsX tys1 tys2 (\(_,s) -> Just s) (tmpl_tyvars, emptySubstEnv)


uTysX :: Type
      -> Type
      -> (MySubst -> Maybe result)
      -> MySubst
      -> Maybe result

uTysX (NoteTy _ ty1) ty2 k subst = uTysX ty1 ty2 k subst
uTysX ty1 (NoteTy _ ty2) k subst = uTysX ty1 ty2 k subst

	-- Variables; go for uVar
uTysX (TyVarTy tyvar1) (TyVarTy tyvar2) k subst 
  | tyvar1 == tyvar2
  = k subst
uTysX (TyVarTy tyvar1) ty2 k subst@(tmpls,_)
  | tyvar1 `elemVarSet` tmpls
  = uVarX tyvar1 ty2 k subst
uTysX ty1 (TyVarTy tyvar2) k subst@(tmpls,_)
  | tyvar2 `elemVarSet` tmpls
  = uVarX tyvar2 ty1 k subst

950
951
952
953
954
955
956
957
	-- Predicates
uTysX (SourceTy (IParam n1 t1)) (SourceTy (IParam n2 t2)) k subst
  | n1 == n2 = uTysX t1 t2 k subst
uTysX (SourceTy (ClassP c1 tys1)) (SourceTy (ClassP c2 tys2)) k subst
  | c1 == c2 = uTyListsX tys1 tys2 k subst
uTysX (SourceTy (NType tc1 tys1)) (SourceTy (NType tc2 tys2)) k subst
  | tc1 == tc2 = uTyListsX tys1 tys2 k subst

958
959
960
961
962
963
	-- Functions; just check the two parts
uTysX (FunTy fun1 arg1) (FunTy fun2 arg2) k subst
  = uTysX fun1 fun2 (uTysX arg1 arg2 k) subst

	-- Type constructors must match
uTysX (TyConApp con1 tys1) (TyConApp con2 tys2) k subst
sof's avatar
sof committed
964
  | (con1 == con2 && equalLength tys1 tys2)
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
  = uTyListsX tys1 tys2 k subst

	-- Applications need a bit of care!
	-- They can match FunTy and TyConApp, so use splitAppTy_maybe
	-- NB: we've already dealt with type variables and Notes,
	-- so if one type is an App the other one jolly well better be too
uTysX (AppTy s1 t1) ty2 k subst
  = case tcSplitAppTy_maybe ty2 of
      Just (s2, t2) -> uTysX s1 s2 (uTysX t1 t2 k) subst
      Nothing       -> Nothing    -- Fail

uTysX ty1 (AppTy s2 t2) k subst
  = case tcSplitAppTy_maybe ty1 of
      Just (s1, t1) -> uTysX s1 s2 (uTysX t1 t2 k) subst
      Nothing       -> Nothing    -- Fail

	-- Not expecting for-alls in unification
#ifdef DEBUG
uTysX (ForAllTy _ _) ty2 k subst = panic "Unify.uTysX subst:ForAllTy (1st arg)"
uTysX ty1 (ForAllTy _ _) k subst = panic "Unify.uTysX subst:ForAllTy (2nd arg)"
#endif

	-- Anything else fails
uTysX ty1 ty2 k subst = Nothing


uTyListsX []         []         k subst = k subst
uTyListsX (ty1:tys1) (ty2:tys2) k subst = uTysX ty1 ty2 (uTyListsX tys1 tys2 k) subst
uTyListsX tys1	     tys2       k subst = Nothing   -- Fail if the lists are different lengths
994
\end{code}
995

996
\begin{code}
997
998
999
1000
-- Invariant: tv1 is a unifiable variable
uVarX tv1 ty2 k subst@(tmpls, env)
  = case lookupSubstEnv env tv1 of
      Just (DoneTy ty1) ->    -- Already bound