compiler/prelude/TysPrim.lhs

   1 %
   2 % (c) The AQUA Project, Glasgow University, 1994-1998
   3 %
   4 \section[TysPrim]{Wired-in knowledge about primitive types}
   5
   6 \begin{code}
   7 module TysPrim(
   8         alphaTyVars, betaTyVars, alphaTyVar, betaTyVar, gammaTyVar, deltaTyVar,
   9         alphaTy, betaTy, gammaTy, deltaTy,
  10         openAlphaTy, openAlphaTyVar, openAlphaTyVars,
  11
  12         primTyCons,
  13
  14         charPrimTyCon,          charPrimTy,
  15         intPrimTyCon,           intPrimTy,
  16         wordPrimTyCon,          wordPrimTy,
  17         addrPrimTyCon,          addrPrimTy,
  18         floatPrimTyCon,         floatPrimTy,
  19         doublePrimTyCon,        doublePrimTy,
  20
  21         statePrimTyCon,         mkStatePrimTy,
  22         realWorldTyCon,         realWorldTy, realWorldStatePrimTy,
  23
  24         arrayPrimTyCon,                 mkArrayPrimTy,
  25         byteArrayPrimTyCon,             byteArrayPrimTy,
  26         mutableArrayPrimTyCon,          mkMutableArrayPrimTy,
  27         mutableByteArrayPrimTyCon,      mkMutableByteArrayPrimTy,
  28         mutVarPrimTyCon,                mkMutVarPrimTy,
  29
  30         mVarPrimTyCon,                  mkMVarPrimTy,
  31         tVarPrimTyCon,                  mkTVarPrimTy,
  32         stablePtrPrimTyCon,             mkStablePtrPrimTy,
  33         stableNamePrimTyCon,            mkStableNamePrimTy,
  34         bcoPrimTyCon,                   bcoPrimTy,
  35         weakPrimTyCon,                  mkWeakPrimTy,
  36         threadIdPrimTyCon,              threadIdPrimTy,
  37
  38         int32PrimTyCon,         int32PrimTy,
  39         word32PrimTyCon,        word32PrimTy,
  40
  41         int64PrimTyCon,         int64PrimTy,
  42         word64PrimTyCon,        word64PrimTy
  43   ) where
  44
  45 #include "HsVersions.h"
  46
  47 import Var              ( TyVar, mkTyVar )
  48 import Name             ( Name, BuiltInSyntax(..), mkInternalName, mkWiredInName )
  49 import OccName          ( mkOccNameFS, tcName, mkTyVarOcc )
  50 import TyCon            ( TyCon, mkPrimTyCon, mkLiftedPrimTyCon,
  51                           PrimRep(..) )
  52 import Type             ( mkTyConApp, mkTyConTy, mkTyVarTys, mkTyVarTy,
  53                           unliftedTypeKind, unboxedTypeKind,
  54                           liftedTypeKind, openTypeKind,
  55                           Kind, mkArrowKinds,
  56                           TyThing(..)
  57                         )
  58 import SrcLoc           ( noSrcLoc )
  59 import Unique           ( mkAlphaTyVarUnique )
  60 import PrelNames
  61 import FastString       ( FastString, mkFastString )
  62 import Outputable
  63
  64 import Char             ( ord, chr )
  65 \end{code}
  66
  67 %************************************************************************
  68 %*                                                                      *
  69 \subsection{Primitive type constructors}
  70 %*                                                                      *
  71 %************************************************************************
  72
  73 \begin{code}
  74 primTyCons :: [TyCon]
  75 primTyCons
  76   = [ addrPrimTyCon
  77     , arrayPrimTyCon
  78     , byteArrayPrimTyCon
  79     , charPrimTyCon
  80     , doublePrimTyCon
  81     , floatPrimTyCon
  82     , intPrimTyCon
  83     , int32PrimTyCon
  84     , int64PrimTyCon
  85     , bcoPrimTyCon
  86     , weakPrimTyCon
  87     , mutableArrayPrimTyCon
  88     , mutableByteArrayPrimTyCon
  89     , mVarPrimTyCon
  90     , tVarPrimTyCon
  91     , mutVarPrimTyCon
  92     , realWorldTyCon
  93     , stablePtrPrimTyCon
  94     , stableNamePrimTyCon
  95     , statePrimTyCon
  96     , threadIdPrimTyCon
  97     , wordPrimTyCon
  98     , word32PrimTyCon
  99     , word64PrimTyCon
 100     ]
 101
 102 mkPrimTc :: FastString -> Unique -> TyCon -> Name
 103 mkPrimTc fs uniq tycon
 104   = mkWiredInName gHC_PRIM (mkOccNameFS tcName fs)
 105                   uniq
 106                   Nothing               -- No parent object
 107                   (ATyCon tycon)        -- Relevant TyCon
 108                   UserSyntax            -- None are built-in syntax
 109
 110 charPrimTyConName             = mkPrimTc FSLIT("Char#") charPrimTyConKey charPrimTyCon
 111 intPrimTyConName              = mkPrimTc FSLIT("Int#") intPrimTyConKey  intPrimTyCon
 112 int32PrimTyConName            = mkPrimTc FSLIT("Int32#") int32PrimTyConKey int32PrimTyCon
 113 int64PrimTyConName            = mkPrimTc FSLIT("Int64#") int64PrimTyConKey int64PrimTyCon
 114 wordPrimTyConName             = mkPrimTc FSLIT("Word#") wordPrimTyConKey wordPrimTyCon
 115 word32PrimTyConName           = mkPrimTc FSLIT("Word32#") word32PrimTyConKey word32PrimTyCon
 116 word64PrimTyConName           = mkPrimTc FSLIT("Word64#") word64PrimTyConKey word64PrimTyCon
 117 addrPrimTyConName             = mkPrimTc FSLIT("Addr#") addrPrimTyConKey addrPrimTyCon
 118 floatPrimTyConName            = mkPrimTc FSLIT("Float#") floatPrimTyConKey floatPrimTyCon
 119 doublePrimTyConName           = mkPrimTc FSLIT("Double#") doublePrimTyConKey doublePrimTyCon
 120 statePrimTyConName            = mkPrimTc FSLIT("State#") statePrimTyConKey statePrimTyCon
 121 realWorldTyConName            = mkPrimTc FSLIT("RealWorld") realWorldTyConKey realWorldTyCon
 122 arrayPrimTyConName            = mkPrimTc FSLIT("Array#") arrayPrimTyConKey arrayPrimTyCon
 123 byteArrayPrimTyConName        = mkPrimTc FSLIT("ByteArray#") byteArrayPrimTyConKey byteArrayPrimTyCon
 124 mutableArrayPrimTyConName     = mkPrimTc FSLIT("MutableArray#") mutableArrayPrimTyConKey mutableArrayPrimTyCon
 125 mutableByteArrayPrimTyConName = mkPrimTc FSLIT("MutableByteArray#") mutableByteArrayPrimTyConKey mutableByteArrayPrimTyCon
 126 mutVarPrimTyConName           = mkPrimTc FSLIT("MutVar#") mutVarPrimTyConKey mutVarPrimTyCon
 127 mVarPrimTyConName             = mkPrimTc FSLIT("MVar#") mVarPrimTyConKey mVarPrimTyCon
 128 tVarPrimTyConName             = mkPrimTc FSLIT("TVar#") tVarPrimTyConKey tVarPrimTyCon
 129 stablePtrPrimTyConName        = mkPrimTc FSLIT("StablePtr#") stablePtrPrimTyConKey stablePtrPrimTyCon
 130 stableNamePrimTyConName       = mkPrimTc FSLIT("StableName#") stableNamePrimTyConKey stableNamePrimTyCon
 131 bcoPrimTyConName              = mkPrimTc FSLIT("BCO#") bcoPrimTyConKey bcoPrimTyCon
 132 weakPrimTyConName             = mkPrimTc FSLIT("Weak#") weakPrimTyConKey weakPrimTyCon
 133 threadIdPrimTyConName         = mkPrimTc FSLIT("ThreadId#") threadIdPrimTyConKey threadIdPrimTyCon
 134 \end{code}
 135
 136 %************************************************************************
 137 %*                                                                      *
 138 \subsection{Support code}
 139 %*                                                                      *
 140 %************************************************************************
 141
 142 alphaTyVars is a list of type variables for use in templates:
 143         ["a", "b", ..., "z", "t1", "t2", ... ]
 144
 145 \begin{code}
 146 tyVarList :: Kind -> [TyVar]
 147 tyVarList kind = [ mkTyVar (mkInternalName (mkAlphaTyVarUnique u)
 148                                 (mkTyVarOcc (mkFastString name))
 149                                 noSrcLoc) kind
 150                  | u <- [2..],
 151                    let name | c <= 'z'  = [c]
 152                             | otherwise = 't':show u
 153                             where c = chr (u-2 + ord 'a')
 154                  ]
 155
 156 alphaTyVars :: [TyVar]
 157 alphaTyVars = tyVarList liftedTypeKind
 158
 159 betaTyVars = tail alphaTyVars
 160
 161 alphaTyVar, betaTyVar, gammaTyVar :: TyVar
 162 (alphaTyVar:betaTyVar:gammaTyVar:deltaTyVar:_) = alphaTyVars
 163
 164 alphaTys = mkTyVarTys alphaTyVars
 165 (alphaTy:betaTy:gammaTy:deltaTy:_) = alphaTys
 166
 167         -- openAlphaTyVar is prepared to be instantiated
 168         -- to a lifted or unlifted type variable.  It's used for the
 169         -- result type for "error", so that we can have (error Int# "Help")
 170 openAlphaTyVars :: [TyVar]
 171 openAlphaTyVars@(openAlphaTyVar:_) = tyVarList openTypeKind
 172
 173 openAlphaTy = mkTyVarTy openAlphaTyVar
 174 \end{code}
 175
 176
 177 %************************************************************************
 178 %*                                                                      *
 179 \subsection[TysPrim-basic]{Basic primitive types (@Char#@, @Int#@, etc.)}
 180 %*                                                                      *
 181 %************************************************************************
 182
 183 \begin{code}
 184 -- only used herein
 185 pcPrimTyCon :: Name -> Int -> PrimRep -> TyCon
 186 pcPrimTyCon name arity rep
 187   = mkPrimTyCon name kind arity rep
 188   where
 189     kind        = mkArrowKinds (replicate arity liftedTypeKind) result_kind
 190     result_kind = case rep of
 191                     PtrRep -> unliftedTypeKind
 192                     _other -> unboxedTypeKind
 193
 194 pcPrimTyCon0 :: Name -> PrimRep -> TyCon
 195 pcPrimTyCon0 name rep
 196   = mkPrimTyCon name result_kind 0 rep
 197   where
 198     result_kind = case rep of
 199                     PtrRep -> unliftedTypeKind
 200                     _other -> unboxedTypeKind
 201
 202 charPrimTy      = mkTyConTy charPrimTyCon
 203 charPrimTyCon   = pcPrimTyCon0 charPrimTyConName WordRep
 204
 205 intPrimTy       = mkTyConTy intPrimTyCon
 206 intPrimTyCon    = pcPrimTyCon0 intPrimTyConName IntRep
 207
 208 int32PrimTy     = mkTyConTy int32PrimTyCon
 209 int32PrimTyCon  = pcPrimTyCon0 int32PrimTyConName IntRep
 210
 211 int64PrimTy     = mkTyConTy int64PrimTyCon
 212 int64PrimTyCon  = pcPrimTyCon0 int64PrimTyConName Int64Rep
 213
 214 wordPrimTy      = mkTyConTy wordPrimTyCon
 215 wordPrimTyCon   = pcPrimTyCon0 wordPrimTyConName WordRep
 216
 217 word32PrimTy    = mkTyConTy word32PrimTyCon
 218 word32PrimTyCon = pcPrimTyCon0 word32PrimTyConName WordRep
 219
 220 word64PrimTy    = mkTyConTy word64PrimTyCon
 221 word64PrimTyCon = pcPrimTyCon0 word64PrimTyConName Word64Rep
 222
 223 addrPrimTy      = mkTyConTy addrPrimTyCon
 224 addrPrimTyCon   = pcPrimTyCon0 addrPrimTyConName AddrRep
 225
 226 floatPrimTy     = mkTyConTy floatPrimTyCon
 227 floatPrimTyCon  = pcPrimTyCon0 floatPrimTyConName FloatRep
 228
 229 doublePrimTy    = mkTyConTy doublePrimTyCon
 230 doublePrimTyCon = pcPrimTyCon0 doublePrimTyConName DoubleRep
 231 \end{code}
 232
 233
 234 %************************************************************************
 235 %*                                                                      *
 236 \subsection[TysPrim-state]{The @State#@ type (and @_RealWorld@ types)}
 237 %*                                                                      *
 238 %************************************************************************
 239
 240 State# is the primitive, unlifted type of states.  It has one type parameter,
 241 thus
 242         State# RealWorld
 243 or
 244         State# s
 245
 246 where s is a type variable. The only purpose of the type parameter is to
 247 keep different state threads separate.  It is represented by nothing at all.
 248
 249 \begin{code}
 250 mkStatePrimTy ty = mkTyConApp statePrimTyCon [ty]
 251 statePrimTyCon   = pcPrimTyCon statePrimTyConName 1 VoidRep
 252 \end{code}
 253
 254 RealWorld is deeply magical.  It is *primitive*, but it is not
 255 *unlifted* (hence ptrArg).  We never manipulate values of type
 256 RealWorld; it's only used in the type system, to parameterise State#.
 257
 258 \begin{code}
 259 realWorldTyCon = mkLiftedPrimTyCon realWorldTyConName liftedTypeKind 0 PtrRep
 260 realWorldTy          = mkTyConTy realWorldTyCon
 261 realWorldStatePrimTy = mkStatePrimTy realWorldTy        -- State# RealWorld
 262 \end{code}
 263
 264 Note: the ``state-pairing'' types are not truly primitive, so they are
 265 defined in \tr{TysWiredIn.lhs}, not here.
 266
 267
 268 %************************************************************************
 269 %*                                                                      *
 270 \subsection[TysPrim-arrays]{The primitive array types}
 271 %*                                                                      *
 272 %************************************************************************
 273
 274 \begin{code}
 275 arrayPrimTyCon            = pcPrimTyCon  arrayPrimTyConName            1 PtrRep
 276 mutableArrayPrimTyCon     = pcPrimTyCon  mutableArrayPrimTyConName     2 PtrRep
 277 mutableByteArrayPrimTyCon = pcPrimTyCon  mutableByteArrayPrimTyConName 1 PtrRep
 278 byteArrayPrimTyCon        = pcPrimTyCon0 byteArrayPrimTyConName          PtrRep
 279
 280 mkArrayPrimTy elt           = mkTyConApp arrayPrimTyCon [elt]
 281 byteArrayPrimTy             = mkTyConTy byteArrayPrimTyCon
 282 mkMutableArrayPrimTy s elt  = mkTyConApp mutableArrayPrimTyCon [s, elt]
 283 mkMutableByteArrayPrimTy s  = mkTyConApp mutableByteArrayPrimTyCon [s]
 284 \end{code}
 285
 286 %************************************************************************
 287 %*                                                                      *
 288 \subsection[TysPrim-mut-var]{The mutable variable type}
 289 %*                                                                      *
 290 %************************************************************************
 291
 292 \begin{code}
 293 mutVarPrimTyCon = pcPrimTyCon mutVarPrimTyConName 2 PtrRep
 294
 295 mkMutVarPrimTy s elt        = mkTyConApp mutVarPrimTyCon [s, elt]
 296 \end{code}
 297
 298 %************************************************************************
 299 %*                                                                      *
 300 \subsection[TysPrim-synch-var]{The synchronizing variable type}
 301 %*                                                                      *
 302 %************************************************************************
 303
 304 \begin{code}
 305 mVarPrimTyCon = pcPrimTyCon mVarPrimTyConName 2 PtrRep
 306
 307 mkMVarPrimTy s elt          = mkTyConApp mVarPrimTyCon [s, elt]
 308 \end{code}
 309
 310 %************************************************************************
 311 %*                                                                      *
 312 \subsection[TysPrim-stm-var]{The transactional variable type}
 313 %*                                                                      *
 314 %************************************************************************
 315
 316 \begin{code}
 317 tVarPrimTyCon = pcPrimTyCon tVarPrimTyConName 2 PtrRep
 318
 319 mkTVarPrimTy s elt          = mkTyConApp tVarPrimTyCon [s, elt]
 320 \end{code}
 321
 322 %************************************************************************
 323 %*                                                                      *
 324 \subsection[TysPrim-stable-ptrs]{The stable-pointer type}
 325 %*                                                                      *
 326 %************************************************************************
 327
 328 \begin{code}
 329 stablePtrPrimTyCon = pcPrimTyCon stablePtrPrimTyConName 1 AddrRep
 330
 331 mkStablePtrPrimTy ty = mkTyConApp stablePtrPrimTyCon [ty]
 332 \end{code}
 333
 334 %************************************************************************
 335 %*                                                                      *
 336 \subsection[TysPrim-stable-names]{The stable-name type}
 337 %*                                                                      *
 338 %************************************************************************
 339
 340 \begin{code}
 341 stableNamePrimTyCon = pcPrimTyCon stableNamePrimTyConName 1 PtrRep
 342
 343 mkStableNamePrimTy ty = mkTyConApp stableNamePrimTyCon [ty]
 344 \end{code}
 345
 346 %************************************************************************
 347 %*                                                                      *
 348 \subsection[TysPrim-BCOs]{The ``bytecode object'' type}
 349 %*                                                                      *
 350 %************************************************************************
 351
 352 \begin{code}
 353 bcoPrimTy    = mkTyConTy bcoPrimTyCon
 354 bcoPrimTyCon = pcPrimTyCon0 bcoPrimTyConName PtrRep
 355 \end{code}
 356
 357 %************************************************************************
 358 %*                                                                      *
 359 \subsection[TysPrim-Weak]{The ``weak pointer'' type}
 360 %*                                                                      *
 361 %************************************************************************
 362
 363 \begin{code}
 364 weakPrimTyCon = pcPrimTyCon weakPrimTyConName 1 PtrRep
 365
 366 mkWeakPrimTy v = mkTyConApp weakPrimTyCon [v]
 367 \end{code}
 368
 369 %************************************************************************
 370 %*                                                                      *
 371 \subsection[TysPrim-thread-ids]{The ``thread id'' type}
 372 %*                                                                      *
 373 %************************************************************************
 374
 375 A thread id is represented by a pointer to the TSO itself, to ensure
 376 that they are always unique and we can always find the TSO for a given
 377 thread id.  However, this has the unfortunate consequence that a
 378 ThreadId# for a given thread is treated as a root by the garbage
 379 collector and can keep TSOs around for too long.
 380
 381 Hence the programmer API for thread manipulation uses a weak pointer
 382 to the thread id internally.
 383
 384 \begin{code}
 385 threadIdPrimTy    = mkTyConTy threadIdPrimTyCon
 386 threadIdPrimTyCon = pcPrimTyCon0 threadIdPrimTyConName PtrRep
 387 \end{code}