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