2 % (c) The AQUA Project, Glasgow University, 1994-1998
4 \section[TysPrim]{Wired-in knowledge about primitive types}
8 alphaTyVars, betaTyVars, alphaTyVar, betaTyVar, gammaTyVar, deltaTyVar,
9 alphaTy, betaTy, gammaTy, deltaTy,
10 openAlphaTy, openBetaTy, openAlphaTyVar, openBetaTyVar, openAlphaTyVars,
14 charPrimTyCon, charPrimTy,
15 intPrimTyCon, intPrimTy,
16 wordPrimTyCon, wordPrimTy,
17 addrPrimTyCon, addrPrimTy,
18 floatPrimTyCon, floatPrimTy,
19 doublePrimTyCon, doublePrimTy,
21 statePrimTyCon, mkStatePrimTy,
22 realWorldTyCon, realWorldTy, realWorldStatePrimTy,
24 arrayPrimTyCon, mkArrayPrimTy,
25 byteArrayPrimTyCon, byteArrayPrimTy,
26 mutableArrayPrimTyCon, mkMutableArrayPrimTy,
27 mutableByteArrayPrimTyCon, mkMutableByteArrayPrimTy,
28 mutVarPrimTyCon, mkMutVarPrimTy,
30 mVarPrimTyCon, mkMVarPrimTy,
31 tVarPrimTyCon, mkTVarPrimTy,
32 stablePtrPrimTyCon, mkStablePtrPrimTy,
33 stableNamePrimTyCon, mkStableNamePrimTy,
34 bcoPrimTyCon, bcoPrimTy,
35 weakPrimTyCon, mkWeakPrimTy,
36 threadIdPrimTyCon, threadIdPrimTy,
38 int32PrimTyCon, int32PrimTy,
39 word32PrimTyCon, word32PrimTy,
41 int64PrimTyCon, int64PrimTy,
42 word64PrimTyCon, word64PrimTy,
44 anyPrimTyCon, anyPrimTy, anyPrimTyCon1, mkAnyPrimTyCon
47 #include "HsVersions.h"
49 import Var ( TyVar, mkTyVar )
50 import Name ( Name, BuiltInSyntax(..), mkInternalName, mkWiredInName )
51 import OccName ( mkTyVarOccFS, mkTcOccFS )
52 import TyCon ( TyCon, mkPrimTyCon, mkLiftedPrimTyCon )
55 import Unique ( mkAlphaTyVarUnique, pprUnique )
61 import Char ( ord, chr )
64 %************************************************************************
66 \subsection{Primitive type constructors}
68 %************************************************************************
84 , mutableArrayPrimTyCon
85 , mutableByteArrayPrimTyCon
97 , anyPrimTyCon, anyPrimTyCon1
100 mkPrimTc :: FastString -> Unique -> TyCon -> Name
101 mkPrimTc fs unique tycon
102 = mkWiredInName gHC_PRIM (mkTcOccFS fs)
104 (ATyCon tycon) -- Relevant TyCon
105 UserSyntax -- None are built-in syntax
107 charPrimTyConName, intPrimTyConName, int32PrimTyConName, int64PrimTyConName, wordPrimTyConName, word32PrimTyConName, word64PrimTyConName, addrPrimTyConName, floatPrimTyConName, doublePrimTyConName, statePrimTyConName, realWorldTyConName, arrayPrimTyConName, byteArrayPrimTyConName, mutableArrayPrimTyConName, mutableByteArrayPrimTyConName, mutVarPrimTyConName, mVarPrimTyConName, tVarPrimTyConName, stablePtrPrimTyConName, stableNamePrimTyConName, bcoPrimTyConName, weakPrimTyConName, threadIdPrimTyConName, anyPrimTyConName, anyPrimTyCon1Name :: Name
108 charPrimTyConName = mkPrimTc (fsLit "Char#") charPrimTyConKey charPrimTyCon
109 intPrimTyConName = mkPrimTc (fsLit "Int#") intPrimTyConKey intPrimTyCon
110 int32PrimTyConName = mkPrimTc (fsLit "Int32#") int32PrimTyConKey int32PrimTyCon
111 int64PrimTyConName = mkPrimTc (fsLit "Int64#") int64PrimTyConKey int64PrimTyCon
112 wordPrimTyConName = mkPrimTc (fsLit "Word#") wordPrimTyConKey wordPrimTyCon
113 word32PrimTyConName = mkPrimTc (fsLit "Word32#") word32PrimTyConKey word32PrimTyCon
114 word64PrimTyConName = mkPrimTc (fsLit "Word64#") word64PrimTyConKey word64PrimTyCon
115 addrPrimTyConName = mkPrimTc (fsLit "Addr#") addrPrimTyConKey addrPrimTyCon
116 floatPrimTyConName = mkPrimTc (fsLit "Float#") floatPrimTyConKey floatPrimTyCon
117 doublePrimTyConName = mkPrimTc (fsLit "Double#") doublePrimTyConKey doublePrimTyCon
118 statePrimTyConName = mkPrimTc (fsLit "State#") statePrimTyConKey statePrimTyCon
119 realWorldTyConName = mkPrimTc (fsLit "RealWorld") realWorldTyConKey realWorldTyCon
120 arrayPrimTyConName = mkPrimTc (fsLit "Array#") arrayPrimTyConKey arrayPrimTyCon
121 byteArrayPrimTyConName = mkPrimTc (fsLit "ByteArray#") byteArrayPrimTyConKey byteArrayPrimTyCon
122 mutableArrayPrimTyConName = mkPrimTc (fsLit "MutableArray#") mutableArrayPrimTyConKey mutableArrayPrimTyCon
123 mutableByteArrayPrimTyConName = mkPrimTc (fsLit "MutableByteArray#") mutableByteArrayPrimTyConKey mutableByteArrayPrimTyCon
124 mutVarPrimTyConName = mkPrimTc (fsLit "MutVar#") mutVarPrimTyConKey mutVarPrimTyCon
125 mVarPrimTyConName = mkPrimTc (fsLit "MVar#") mVarPrimTyConKey mVarPrimTyCon
126 tVarPrimTyConName = mkPrimTc (fsLit "TVar#") tVarPrimTyConKey tVarPrimTyCon
127 stablePtrPrimTyConName = mkPrimTc (fsLit "StablePtr#") stablePtrPrimTyConKey stablePtrPrimTyCon
128 stableNamePrimTyConName = mkPrimTc (fsLit "StableName#") stableNamePrimTyConKey stableNamePrimTyCon
129 bcoPrimTyConName = mkPrimTc (fsLit "BCO#") bcoPrimTyConKey bcoPrimTyCon
130 weakPrimTyConName = mkPrimTc (fsLit "Weak#") weakPrimTyConKey weakPrimTyCon
131 threadIdPrimTyConName = mkPrimTc (fsLit "ThreadId#") threadIdPrimTyConKey threadIdPrimTyCon
132 anyPrimTyConName = mkPrimTc (fsLit "Any") anyPrimTyConKey anyPrimTyCon
133 anyPrimTyCon1Name = mkPrimTc (fsLit "Any1") anyPrimTyCon1Key anyPrimTyCon
136 %************************************************************************
138 \subsection{Support code}
140 %************************************************************************
142 alphaTyVars is a list of type variables for use in templates:
143 ["a", "b", ..., "z", "t1", "t2", ... ]
146 tyVarList :: Kind -> [TyVar]
147 tyVarList kind = [ mkTyVar (mkInternalName (mkAlphaTyVarUnique u)
148 (mkTyVarOccFS (mkFastString name))
151 let name | c <= 'z' = [c]
152 | otherwise = 't':show u
153 where c = chr (u-2 + ord 'a')
156 alphaTyVars :: [TyVar]
157 alphaTyVars = tyVarList liftedTypeKind
159 betaTyVars :: [TyVar]
160 betaTyVars = tail alphaTyVars
162 alphaTyVar, betaTyVar, gammaTyVar, deltaTyVar :: TyVar
163 (alphaTyVar:betaTyVar:gammaTyVar:deltaTyVar:_) = alphaTyVars
166 alphaTys = mkTyVarTys alphaTyVars
167 alphaTy, betaTy, gammaTy, deltaTy :: Type
168 (alphaTy:betaTy:gammaTy:deltaTy:_) = alphaTys
170 -- openAlphaTyVar is prepared to be instantiated
171 -- to a lifted or unlifted type variable. It's used for the
172 -- result type for "error", so that we can have (error Int# "Help")
173 openAlphaTyVars :: [TyVar]
174 openAlphaTyVar, openBetaTyVar :: TyVar
175 openAlphaTyVars@(openAlphaTyVar:openBetaTyVar:_) = tyVarList openTypeKind
177 openAlphaTy, openBetaTy :: Type
178 openAlphaTy = mkTyVarTy openAlphaTyVar
179 openBetaTy = mkTyVarTy openBetaTyVar
183 %************************************************************************
185 \subsection[TysPrim-basic]{Basic primitive types (@Char#@, @Int#@, etc.)}
187 %************************************************************************
191 pcPrimTyCon :: Name -> Int -> PrimRep -> TyCon
192 pcPrimTyCon name arity rep
193 = mkPrimTyCon name kind arity rep
195 kind = mkArrowKinds (replicate arity liftedTypeKind) result_kind
196 result_kind = unliftedTypeKind
198 pcPrimTyCon0 :: Name -> PrimRep -> TyCon
199 pcPrimTyCon0 name rep
200 = mkPrimTyCon name result_kind 0 rep
202 result_kind = unliftedTypeKind
205 charPrimTy = mkTyConTy charPrimTyCon
206 charPrimTyCon :: TyCon
207 charPrimTyCon = pcPrimTyCon0 charPrimTyConName WordRep
210 intPrimTy = mkTyConTy intPrimTyCon
211 intPrimTyCon :: TyCon
212 intPrimTyCon = pcPrimTyCon0 intPrimTyConName IntRep
215 int32PrimTy = mkTyConTy int32PrimTyCon
216 int32PrimTyCon :: TyCon
217 int32PrimTyCon = pcPrimTyCon0 int32PrimTyConName IntRep
220 int64PrimTy = mkTyConTy int64PrimTyCon
221 int64PrimTyCon :: TyCon
222 int64PrimTyCon = pcPrimTyCon0 int64PrimTyConName Int64Rep
225 wordPrimTy = mkTyConTy wordPrimTyCon
226 wordPrimTyCon :: TyCon
227 wordPrimTyCon = pcPrimTyCon0 wordPrimTyConName WordRep
230 word32PrimTy = mkTyConTy word32PrimTyCon
231 word32PrimTyCon :: TyCon
232 word32PrimTyCon = pcPrimTyCon0 word32PrimTyConName WordRep
235 word64PrimTy = mkTyConTy word64PrimTyCon
236 word64PrimTyCon :: TyCon
237 word64PrimTyCon = pcPrimTyCon0 word64PrimTyConName Word64Rep
240 addrPrimTy = mkTyConTy addrPrimTyCon
241 addrPrimTyCon :: TyCon
242 addrPrimTyCon = pcPrimTyCon0 addrPrimTyConName AddrRep
245 floatPrimTy = mkTyConTy floatPrimTyCon
246 floatPrimTyCon :: TyCon
247 floatPrimTyCon = pcPrimTyCon0 floatPrimTyConName FloatRep
250 doublePrimTy = mkTyConTy doublePrimTyCon
251 doublePrimTyCon :: TyCon
252 doublePrimTyCon = pcPrimTyCon0 doublePrimTyConName DoubleRep
256 %************************************************************************
258 \subsection[TysPrim-state]{The @State#@ type (and @_RealWorld@ types)}
260 %************************************************************************
262 State# is the primitive, unlifted type of states. It has one type parameter,
268 where s is a type variable. The only purpose of the type parameter is to
269 keep different state threads separate. It is represented by nothing at all.
272 mkStatePrimTy :: Type -> Type
273 mkStatePrimTy ty = mkTyConApp statePrimTyCon [ty]
274 statePrimTyCon :: TyCon
275 statePrimTyCon = pcPrimTyCon statePrimTyConName 1 VoidRep
278 RealWorld is deeply magical. It is *primitive*, but it is not
279 *unlifted* (hence ptrArg). We never manipulate values of type
280 RealWorld; it's only used in the type system, to parameterise State#.
283 realWorldTyCon :: TyCon
284 realWorldTyCon = mkLiftedPrimTyCon realWorldTyConName liftedTypeKind 0 PtrRep
286 realWorldTy = mkTyConTy realWorldTyCon
287 realWorldStatePrimTy :: Type
288 realWorldStatePrimTy = mkStatePrimTy realWorldTy -- State# RealWorld
291 Note: the ``state-pairing'' types are not truly primitive, so they are
292 defined in \tr{TysWiredIn.lhs}, not here.
295 %************************************************************************
299 %************************************************************************
301 The type constructor Any is type to which you can unsafely coerce any
302 lifted type, and back.
304 * It is lifted, and hence represented by a pointer
306 * It does not claim to be a *data* type, and that's important for
307 the code generator, because the code gen may *enter* a data value
308 but never enters a function value.
310 It's also used to instantiate un-constrained type variables after type
311 checking. For example
313 Annoyingly, we sometimes need Anys of other kinds, such as (*->*) etc.
314 This is a bit like tuples. We define a couple of useful ones here,
315 and make others up on the fly. If any of these others end up being exported
316 into interface files, we'll get a crash; at least until we add interface-file
317 syntax to support them.
321 anyPrimTy = mkTyConApp anyPrimTyCon []
323 anyPrimTyCon :: TyCon -- Kind *
324 anyPrimTyCon = mkLiftedPrimTyCon anyPrimTyConName liftedTypeKind 0 PtrRep
326 anyPrimTyCon1 :: TyCon -- Kind *->*
327 anyPrimTyCon1 = mkLiftedPrimTyCon anyPrimTyCon1Name kind 0 PtrRep
329 kind = mkArrowKind liftedTypeKind liftedTypeKind
331 mkAnyPrimTyCon :: Unique -> Kind -> TyCon
332 -- Grotesque hack alert: the client gives the unique; so equality won't work
333 mkAnyPrimTyCon unique kind
334 = WARN( opt_PprStyle_Debug, ptext (sLit "Urk! Inventing strangely-kinded Any TyCon:") <+> ppr unique <+> ppr kind )
335 -- See Note [Strangely-kinded void TyCons] in TcHsSyn
338 name = mkPrimTc (mkFastString ("Any" ++ showSDoc (pprUnique unique))) unique tycon
339 tycon = mkLiftedPrimTyCon name kind 0 PtrRep
343 %************************************************************************
345 \subsection[TysPrim-arrays]{The primitive array types}
347 %************************************************************************
350 arrayPrimTyCon, mutableArrayPrimTyCon, mutableByteArrayPrimTyCon,
351 byteArrayPrimTyCon :: TyCon
352 arrayPrimTyCon = pcPrimTyCon arrayPrimTyConName 1 PtrRep
353 mutableArrayPrimTyCon = pcPrimTyCon mutableArrayPrimTyConName 2 PtrRep
354 mutableByteArrayPrimTyCon = pcPrimTyCon mutableByteArrayPrimTyConName 1 PtrRep
355 byteArrayPrimTyCon = pcPrimTyCon0 byteArrayPrimTyConName PtrRep
357 mkArrayPrimTy :: Type -> Type
358 mkArrayPrimTy elt = mkTyConApp arrayPrimTyCon [elt]
359 byteArrayPrimTy :: Type
360 byteArrayPrimTy = mkTyConTy byteArrayPrimTyCon
361 mkMutableArrayPrimTy :: Type -> Type -> Type
362 mkMutableArrayPrimTy s elt = mkTyConApp mutableArrayPrimTyCon [s, elt]
363 mkMutableByteArrayPrimTy :: Type -> Type
364 mkMutableByteArrayPrimTy s = mkTyConApp mutableByteArrayPrimTyCon [s]
367 %************************************************************************
369 \subsection[TysPrim-mut-var]{The mutable variable type}
371 %************************************************************************
374 mutVarPrimTyCon :: TyCon
375 mutVarPrimTyCon = pcPrimTyCon mutVarPrimTyConName 2 PtrRep
377 mkMutVarPrimTy :: Type -> Type -> Type
378 mkMutVarPrimTy s elt = mkTyConApp mutVarPrimTyCon [s, elt]
381 %************************************************************************
383 \subsection[TysPrim-synch-var]{The synchronizing variable type}
385 %************************************************************************
388 mVarPrimTyCon :: TyCon
389 mVarPrimTyCon = pcPrimTyCon mVarPrimTyConName 2 PtrRep
391 mkMVarPrimTy :: Type -> Type -> Type
392 mkMVarPrimTy s elt = mkTyConApp mVarPrimTyCon [s, elt]
395 %************************************************************************
397 \subsection[TysPrim-stm-var]{The transactional variable type}
399 %************************************************************************
402 tVarPrimTyCon :: TyCon
403 tVarPrimTyCon = pcPrimTyCon tVarPrimTyConName 2 PtrRep
405 mkTVarPrimTy :: Type -> Type -> Type
406 mkTVarPrimTy s elt = mkTyConApp tVarPrimTyCon [s, elt]
409 %************************************************************************
411 \subsection[TysPrim-stable-ptrs]{The stable-pointer type}
413 %************************************************************************
416 stablePtrPrimTyCon :: TyCon
417 stablePtrPrimTyCon = pcPrimTyCon stablePtrPrimTyConName 1 AddrRep
419 mkStablePtrPrimTy :: Type -> Type
420 mkStablePtrPrimTy ty = mkTyConApp stablePtrPrimTyCon [ty]
423 %************************************************************************
425 \subsection[TysPrim-stable-names]{The stable-name type}
427 %************************************************************************
430 stableNamePrimTyCon :: TyCon
431 stableNamePrimTyCon = pcPrimTyCon stableNamePrimTyConName 1 PtrRep
433 mkStableNamePrimTy :: Type -> Type
434 mkStableNamePrimTy ty = mkTyConApp stableNamePrimTyCon [ty]
437 %************************************************************************
439 \subsection[TysPrim-BCOs]{The ``bytecode object'' type}
441 %************************************************************************
445 bcoPrimTy = mkTyConTy bcoPrimTyCon
446 bcoPrimTyCon :: TyCon
447 bcoPrimTyCon = pcPrimTyCon0 bcoPrimTyConName PtrRep
450 %************************************************************************
452 \subsection[TysPrim-Weak]{The ``weak pointer'' type}
454 %************************************************************************
457 weakPrimTyCon :: TyCon
458 weakPrimTyCon = pcPrimTyCon weakPrimTyConName 1 PtrRep
460 mkWeakPrimTy :: Type -> Type
461 mkWeakPrimTy v = mkTyConApp weakPrimTyCon [v]
464 %************************************************************************
466 \subsection[TysPrim-thread-ids]{The ``thread id'' type}
468 %************************************************************************
470 A thread id is represented by a pointer to the TSO itself, to ensure
471 that they are always unique and we can always find the TSO for a given
472 thread id. However, this has the unfortunate consequence that a
473 ThreadId# for a given thread is treated as a root by the garbage
474 collector and can keep TSOs around for too long.
476 Hence the programmer API for thread manipulation uses a weak pointer
477 to the thread id internally.
480 threadIdPrimTy :: Type
481 threadIdPrimTy = mkTyConTy threadIdPrimTyCon
482 threadIdPrimTyCon :: TyCon
483 threadIdPrimTyCon = pcPrimTyCon0 threadIdPrimTyConName PtrRep