remove empty dir
[ghc-hetmet.git] / ghc / compiler / prelude / TysPrim.lhs
index df43faf..2f6168b 100644 (file)
@@ -3,9 +3,6 @@
 %
 \section[TysPrim]{Wired-in knowledge about primitive types}
 
-This module tracks the ``state interface'' document, ``GHC prelude:
-types and operations.''
-
 \begin{code}
 module TysPrim(
        alphaTyVars, betaTyVars, alphaTyVar, betaTyVar, gammaTyVar, deltaTyVar,
@@ -31,37 +28,36 @@ module TysPrim(
        mutVarPrimTyCon,                mkMutVarPrimTy,
 
        mVarPrimTyCon,                  mkMVarPrimTy,   
+        tVarPrimTyCon,                  mkTVarPrimTy,
        stablePtrPrimTyCon,             mkStablePtrPrimTy,
        stableNamePrimTyCon,            mkStableNamePrimTy,
        bcoPrimTyCon,                   bcoPrimTy,
        weakPrimTyCon,                  mkWeakPrimTy,
-       foreignObjPrimTyCon,            foreignObjPrimTy,
        threadIdPrimTyCon,              threadIdPrimTy,
        
        int32PrimTyCon,         int32PrimTy,
        word32PrimTyCon,        word32PrimTy,
 
        int64PrimTyCon,         int64PrimTy,
-       word64PrimTyCon,        word64PrimTy,
-
-       primRepTyCon
+       word64PrimTyCon,        word64PrimTy
   ) where
 
 #include "HsVersions.h"
 
 import Var             ( TyVar, mkTyVar )
-import Name            ( Name, mkInternalName )
-import OccName         ( mkVarOcc )
-import PrimRep         ( PrimRep(..) )
-import TyCon           ( TyCon, ArgVrcs, mkPrimTyCon, mkLiftedPrimTyCon )
+import Name            ( Name, BuiltInSyntax(..), mkInternalName, mkWiredInName )
+import OccName         ( mkOccNameFS, tcName, mkTyVarOcc )
+import TyCon           ( TyCon, ArgVrcs, mkPrimTyCon, mkLiftedPrimTyCon,
+                         PrimRep(..) )
 import Type            ( mkTyConApp, mkTyConTy, mkTyVarTys, mkTyVarTy,
                          unliftedTypeKind, liftedTypeKind, openTypeKind, 
-                         Kind, mkArrowKinds
+                         Kind, mkArrowKinds,
+                         TyThing(..)
                        )
 import SrcLoc          ( noSrcLoc )
 import Unique          ( mkAlphaTyVarUnique )
 import PrelNames
-import FastString      ( mkFastString )
+import FastString      ( FastString, mkFastString )
 import Outputable
 
 import Char            ( ord, chr )
@@ -85,12 +81,12 @@ primTyCons
     , intPrimTyCon
     , int32PrimTyCon
     , int64PrimTyCon
-    , foreignObjPrimTyCon
     , bcoPrimTyCon
     , weakPrimTyCon
     , mutableArrayPrimTyCon
     , mutableByteArrayPrimTyCon
     , mVarPrimTyCon
+    , tVarPrimTyCon
     , mutVarPrimTyCon
     , realWorldTyCon
     , stablePtrPrimTyCon
@@ -101,8 +97,40 @@ primTyCons
     , word32PrimTyCon
     , word64PrimTyCon
     ]
-\end{code}
 
+mkPrimTc :: FastString -> Unique -> TyCon -> Name
+mkPrimTc fs uniq tycon
+  = mkWiredInName gHC_PRIM (mkOccNameFS tcName fs) 
+                 uniq
+                 Nothing               -- No parent object
+                 (ATyCon tycon)        -- Relevant TyCon
+                 UserSyntax            -- None are built-in syntax
+
+charPrimTyConName            = mkPrimTc FSLIT("Char#") charPrimTyConKey charPrimTyCon
+intPrimTyConName             = mkPrimTc FSLIT("Int#") intPrimTyConKey  intPrimTyCon
+int32PrimTyConName           = mkPrimTc FSLIT("Int32#") int32PrimTyConKey int32PrimTyCon
+int64PrimTyConName           = mkPrimTc FSLIT("Int64#") int64PrimTyConKey int64PrimTyCon
+wordPrimTyConName            = mkPrimTc FSLIT("Word#") wordPrimTyConKey wordPrimTyCon
+word32PrimTyConName          = mkPrimTc FSLIT("Word32#") word32PrimTyConKey word32PrimTyCon
+word64PrimTyConName          = mkPrimTc FSLIT("Word64#") word64PrimTyConKey word64PrimTyCon
+addrPrimTyConName            = mkPrimTc FSLIT("Addr#") addrPrimTyConKey addrPrimTyCon
+floatPrimTyConName           = mkPrimTc FSLIT("Float#") floatPrimTyConKey floatPrimTyCon
+doublePrimTyConName          = mkPrimTc FSLIT("Double#") doublePrimTyConKey doublePrimTyCon
+statePrimTyConName           = mkPrimTc FSLIT("State#") statePrimTyConKey statePrimTyCon
+realWorldTyConName           = mkPrimTc FSLIT("RealWorld") realWorldTyConKey realWorldTyCon
+arrayPrimTyConName           = mkPrimTc FSLIT("Array#") arrayPrimTyConKey arrayPrimTyCon
+byteArrayPrimTyConName       = mkPrimTc FSLIT("ByteArray#") byteArrayPrimTyConKey byteArrayPrimTyCon
+mutableArrayPrimTyConName     = mkPrimTc FSLIT("MutableArray#") mutableArrayPrimTyConKey mutableArrayPrimTyCon
+mutableByteArrayPrimTyConName = mkPrimTc FSLIT("MutableByteArray#") mutableByteArrayPrimTyConKey mutableByteArrayPrimTyCon
+mutVarPrimTyConName          = mkPrimTc FSLIT("MutVar#") mutVarPrimTyConKey mutVarPrimTyCon
+mVarPrimTyConName            = mkPrimTc FSLIT("MVar#") mVarPrimTyConKey mVarPrimTyCon
+tVarPrimTyConName            = mkPrimTc FSLIT("TVar#") tVarPrimTyConKey tVarPrimTyCon
+stablePtrPrimTyConName        = mkPrimTc FSLIT("StablePtr#") stablePtrPrimTyConKey stablePtrPrimTyCon
+stableNamePrimTyConName       = mkPrimTc FSLIT("StableName#") stableNamePrimTyConKey stableNamePrimTyCon
+bcoPrimTyConName             = mkPrimTc FSLIT("BCO#") bcoPrimTyConKey bcoPrimTyCon
+weakPrimTyConName            = mkPrimTc FSLIT("Weak#") weakPrimTyConKey weakPrimTyCon
+threadIdPrimTyConName                = mkPrimTc FSLIT("ThreadId#") threadIdPrimTyConKey threadIdPrimTyCon
+\end{code}
 
 %************************************************************************
 %*                                                                     *
@@ -116,7 +144,7 @@ alphaTyVars is a list of type variables for use in templates:
 \begin{code}
 tyVarList :: Kind -> [TyVar]
 tyVarList kind = [ mkTyVar (mkInternalName (mkAlphaTyVarUnique u) 
-                               (mkVarOcc (mkFastString name))
+                               (mkTyVarOcc (mkFastString name))
                                noSrcLoc) kind
                 | u <- [2..],
                   let name | c <= 'z'  = [c]
@@ -177,13 +205,13 @@ pcPrimTyCon0 name rep
     result_kind = unliftedTypeKind -- all primitive types are unlifted
 
 charPrimTy     = mkTyConTy charPrimTyCon
-charPrimTyCon  = pcPrimTyCon0 charPrimTyConName CharRep
+charPrimTyCon  = pcPrimTyCon0 charPrimTyConName WordRep
 
 intPrimTy      = mkTyConTy intPrimTyCon
 intPrimTyCon   = pcPrimTyCon0 intPrimTyConName IntRep
 
 int32PrimTy    = mkTyConTy int32PrimTyCon
-int32PrimTyCon = pcPrimTyCon0 int32PrimTyConName Int32Rep
+int32PrimTyCon = pcPrimTyCon0 int32PrimTyConName IntRep
 
 int64PrimTy    = mkTyConTy int64PrimTyCon
 int64PrimTyCon = pcPrimTyCon0 int64PrimTyConName Int64Rep
@@ -192,7 +220,7 @@ wordPrimTy  = mkTyConTy wordPrimTyCon
 wordPrimTyCon  = pcPrimTyCon0 wordPrimTyConName WordRep
 
 word32PrimTy   = mkTyConTy word32PrimTyCon
-word32PrimTyCon        = pcPrimTyCon0 word32PrimTyConName Word32Rep
+word32PrimTyCon        = pcPrimTyCon0 word32PrimTyConName WordRep
 
 word64PrimTy   = mkTyConTy word64PrimTyCon
 word64PrimTyCon        = pcPrimTyCon0 word64PrimTyConName Word64Rep
@@ -229,11 +257,11 @@ statePrimTyCon     = pcPrimTyCon statePrimTyConName vrcsZ VoidRep
 \end{code}
 
 RealWorld is deeply magical.  It is *primitive*, but it is not
-*unlifted* (hence PrimPtrRep).  We never manipulate values of type
+*unlifted* (hence ptrArg).  We never manipulate values of type
 RealWorld; it's only used in the type system, to parameterise State#.
 
 \begin{code}
-realWorldTyCon = mkLiftedPrimTyCon realWorldTyConName liftedTypeKind 0 [] PrimPtrRep
+realWorldTyCon = mkLiftedPrimTyCon realWorldTyConName liftedTypeKind 0 [] PtrRep
 realWorldTy         = mkTyConTy realWorldTyCon
 realWorldStatePrimTy = mkStatePrimTy realWorldTy       -- State# RealWorld
 \end{code}
@@ -249,10 +277,10 @@ defined in \tr{TysWiredIn.lhs}, not here.
 %************************************************************************
 
 \begin{code}
-arrayPrimTyCon           = pcPrimTyCon  arrayPrimTyConName            vrcsP  ArrayRep
-mutableArrayPrimTyCon    = pcPrimTyCon  mutableArrayPrimTyConName     vrcsZP ArrayRep
-mutableByteArrayPrimTyCon = pcPrimTyCon  mutableByteArrayPrimTyConName vrcsZ  ByteArrayRep
-byteArrayPrimTyCon       = pcPrimTyCon0 byteArrayPrimTyConName               ByteArrayRep
+arrayPrimTyCon           = pcPrimTyCon  arrayPrimTyConName            vrcsP  PtrRep
+mutableArrayPrimTyCon    = pcPrimTyCon  mutableArrayPrimTyConName     vrcsZP PtrRep
+mutableByteArrayPrimTyCon = pcPrimTyCon  mutableByteArrayPrimTyConName vrcsZ  PtrRep
+byteArrayPrimTyCon       = pcPrimTyCon0 byteArrayPrimTyConName               PtrRep
 
 mkArrayPrimTy elt          = mkTyConApp arrayPrimTyCon [elt]
 byteArrayPrimTy                    = mkTyConTy byteArrayPrimTyCon
@@ -267,7 +295,7 @@ mkMutableByteArrayPrimTy s  = mkTyConApp mutableByteArrayPrimTyCon [s]
 %************************************************************************
 
 \begin{code}
-mutVarPrimTyCon = pcPrimTyCon mutVarPrimTyConName vrcsZP PrimPtrRep
+mutVarPrimTyCon = pcPrimTyCon mutVarPrimTyConName vrcsZP PtrRep
 
 mkMutVarPrimTy s elt       = mkTyConApp mutVarPrimTyCon [s, elt]
 \end{code}
@@ -279,56 +307,47 @@ mkMutVarPrimTy s elt          = mkTyConApp mutVarPrimTyCon [s, elt]
 %************************************************************************
 
 \begin{code}
-mVarPrimTyCon = pcPrimTyCon mVarPrimTyConName vrcsZP PrimPtrRep
+mVarPrimTyCon = pcPrimTyCon mVarPrimTyConName vrcsZP PtrRep
 
 mkMVarPrimTy s elt         = mkTyConApp mVarPrimTyCon [s, elt]
 \end{code}
 
 %************************************************************************
 %*                                                                     *
-\subsection[TysPrim-stable-ptrs]{The stable-pointer type}
+\subsection[TysPrim-stm-var]{The transactional variable type}
 %*                                                                     *
 %************************************************************************
 
 \begin{code}
-stablePtrPrimTyCon = pcPrimTyCon stablePtrPrimTyConName vrcsP StablePtrRep
+tVarPrimTyCon = pcPrimTyCon tVarPrimTyConName vrcsZP PtrRep
 
-mkStablePtrPrimTy ty = mkTyConApp stablePtrPrimTyCon [ty]
+mkTVarPrimTy s elt         = mkTyConApp tVarPrimTyCon [s, elt]
 \end{code}
 
 %************************************************************************
 %*                                                                     *
-\subsection[TysPrim-stable-names]{The stable-name type}
+\subsection[TysPrim-stable-ptrs]{The stable-pointer type}
 %*                                                                     *
 %************************************************************************
 
 \begin{code}
-stableNamePrimTyCon = pcPrimTyCon stableNamePrimTyConName vrcsP StableNameRep
+stablePtrPrimTyCon = pcPrimTyCon stablePtrPrimTyConName vrcsP AddrRep
 
-mkStableNamePrimTy ty = mkTyConApp stableNamePrimTyCon [ty]
+mkStablePtrPrimTy ty = mkTyConApp stablePtrPrimTyCon [ty]
 \end{code}
 
 %************************************************************************
 %*                                                                     *
-\subsection[TysPrim-foreign-objs]{The ``foreign object'' type}
+\subsection[TysPrim-stable-names]{The stable-name type}
 %*                                                                     *
 %************************************************************************
 
-A Foreign Object is just a boxed, unlifted, Addr#.  They're needed
-because finalisers (weak pointers) can't watch Addr#s, they can only
-watch heap-resident objects.  
-
-We can't use a lifted Addr# (such as Addr) because race conditions
-could bite us.  For example, if the program deconstructed the Addr
-before passing its contents to a ccall, and a weak pointer was
-watching the Addr, the weak pointer might deduce that the Addr was
-dead before it really was.
-
 \begin{code}
-foreignObjPrimTy    = mkTyConTy foreignObjPrimTyCon
-foreignObjPrimTyCon = pcPrimTyCon0 foreignObjPrimTyConName ForeignObjRep
+stableNamePrimTyCon = pcPrimTyCon stableNamePrimTyConName vrcsP PtrRep
+
+mkStableNamePrimTy ty = mkTyConApp stableNamePrimTyCon [ty]
 \end{code}
-  
+
 %************************************************************************
 %*                                                                     *
 \subsection[TysPrim-BCOs]{The ``bytecode object'' type}
@@ -337,7 +356,7 @@ foreignObjPrimTyCon = pcPrimTyCon0 foreignObjPrimTyConName ForeignObjRep
 
 \begin{code}
 bcoPrimTy    = mkTyConTy bcoPrimTyCon
-bcoPrimTyCon = pcPrimTyCon0 bcoPrimTyConName BCORep
+bcoPrimTyCon = pcPrimTyCon0 bcoPrimTyConName PtrRep
 \end{code}
   
 %************************************************************************
@@ -347,7 +366,7 @@ bcoPrimTyCon = pcPrimTyCon0 bcoPrimTyConName BCORep
 %************************************************************************
 
 \begin{code}
-weakPrimTyCon = pcPrimTyCon weakPrimTyConName vrcsP WeakPtrRep
+weakPrimTyCon = pcPrimTyCon weakPrimTyConName vrcsP PtrRep
 
 mkWeakPrimTy v = mkTyConApp weakPrimTyCon [v]
 \end{code}
@@ -369,33 +388,5 @@ to the thread id internally.
 
 \begin{code}
 threadIdPrimTy    = mkTyConTy threadIdPrimTyCon
-threadIdPrimTyCon = pcPrimTyCon0 threadIdPrimTyConName ThreadIdRep
-\end{code}
-
-%************************************************************************
-%*                                                                     *
-\subsection[TysPrim-PrimRep]{Making types from PrimReps}
-%*                                                                     *
-%************************************************************************
-
-Each of the primitive types from this module is equivalent to a
-PrimRep (see PrimRep.lhs).  The following function returns the
-primitive TyCon for a given PrimRep.
-
-\begin{code}
-primRepTyCon CharRep       = charPrimTyCon
-primRepTyCon Int8Rep       = charPrimTyCon
-primRepTyCon IntRep        = intPrimTyCon
-primRepTyCon WordRep       = wordPrimTyCon
-primRepTyCon Int32Rep      = int32PrimTyCon
-primRepTyCon Int64Rep      = int64PrimTyCon
-primRepTyCon Word32Rep     = word32PrimTyCon
-primRepTyCon Word64Rep     = word64PrimTyCon
-primRepTyCon AddrRep       = addrPrimTyCon
-primRepTyCon FloatRep      = floatPrimTyCon
-primRepTyCon DoubleRep     = doublePrimTyCon
-primRepTyCon StablePtrRep  = stablePtrPrimTyCon
-primRepTyCon ForeignObjRep = foreignObjPrimTyCon
-primRepTyCon WeakPtrRep    = weakPrimTyCon
-primRepTyCon other         = pprPanic "primRepTyCon" (ppr other)
+threadIdPrimTyCon = pcPrimTyCon0 threadIdPrimTyConName PtrRep
 \end{code}