{-
(c) The AQUA Project, Glasgow University, 1994-1998


\section[TysPrim]{Wired-in knowledge about primitive types}
-}

{-# LANGUAGE CPP #-}

-- | This module defines TyCons that can't be expressed in Haskell.
--   They are all, therefore, wired-in TyCons.  C.f module TysWiredIn
module TysPrim(
        mkPrimTyConName, -- For implicit parameters in TysWiredIn only

        mkTemplateKindVars, mkTemplateTyVars, mkTemplateTyVarsFrom,
        mkTemplateKiTyVars,

        mkTemplateTyConBinders, mkTemplateKindTyConBinders,
        mkTemplateAnonTyConBinders,

        alphaTyVars, alphaTyVar, betaTyVar, gammaTyVar, deltaTyVar,
        alphaTys, alphaTy, betaTy, gammaTy, deltaTy,
        alphaTyVarsUnliftedRep, alphaTyVarUnliftedRep,
        alphaTysUnliftedRep, alphaTyUnliftedRep,
        runtimeRep1TyVar, runtimeRep2TyVar, runtimeRep1Ty, runtimeRep2Ty,
        openAlphaTy, openBetaTy, openAlphaTyVar, openBetaTyVar,

        -- Kind constructors...
        tYPETyCon, tYPETyConName,

        -- Kinds
        tYPE, primRepToRuntimeRep,

        funTyCon, funTyConName,
        unexposedPrimTyCons, exposedPrimTyCons, primTyCons,

        charPrimTyCon,          charPrimTy, charPrimTyConName,
        intPrimTyCon,           intPrimTy, intPrimTyConName,
        wordPrimTyCon,          wordPrimTy, wordPrimTyConName,
        addrPrimTyCon,          addrPrimTy, addrPrimTyConName,
        floatPrimTyCon,         floatPrimTy, floatPrimTyConName,
        doublePrimTyCon,        doublePrimTy, doublePrimTyConName,

        voidPrimTyCon,          voidPrimTy,
        statePrimTyCon,         mkStatePrimTy,
        realWorldTyCon,         realWorldTy, realWorldStatePrimTy,

        proxyPrimTyCon,         mkProxyPrimTy,

        arrayPrimTyCon, mkArrayPrimTy,
        byteArrayPrimTyCon,     byteArrayPrimTy,
        arrayArrayPrimTyCon, mkArrayArrayPrimTy,
        smallArrayPrimTyCon, mkSmallArrayPrimTy,
        mutableArrayPrimTyCon, mkMutableArrayPrimTy,
        mutableByteArrayPrimTyCon, mkMutableByteArrayPrimTy,
        mutableArrayArrayPrimTyCon, mkMutableArrayArrayPrimTy,
        smallMutableArrayPrimTyCon, mkSmallMutableArrayPrimTy,
        mutVarPrimTyCon, mkMutVarPrimTy,

        mVarPrimTyCon,                  mkMVarPrimTy,
        tVarPrimTyCon,                  mkTVarPrimTy,
        stablePtrPrimTyCon,             mkStablePtrPrimTy,
        stableNamePrimTyCon,            mkStableNamePrimTy,
        compactPrimTyCon,               compactPrimTy,
        bcoPrimTyCon,                   bcoPrimTy,
        weakPrimTyCon,                  mkWeakPrimTy,
        threadIdPrimTyCon,              threadIdPrimTy,

        int8PrimTyCon,          int8PrimTy, int8PrimTyConName,
        word8PrimTyCon,         word8PrimTy, word8PrimTyConName,

        int16PrimTyCon,         int16PrimTy, int16PrimTyConName,
        word16PrimTyCon,        word16PrimTy, word16PrimTyConName,

        int32PrimTyCon,         int32PrimTy, int32PrimTyConName,
        word32PrimTyCon,        word32PrimTy, word32PrimTyConName,

        int64PrimTyCon,         int64PrimTy, int64PrimTyConName,
        word64PrimTyCon,        word64PrimTy, word64PrimTyConName,

        eqPrimTyCon,            -- ty1 ~# ty2
        eqReprPrimTyCon,        -- ty1 ~R# ty2  (at role Representational)
        eqPhantPrimTyCon,       -- ty1 ~P# ty2  (at role Phantom)

        -- * SIMD
#include "primop-vector-tys-exports.hs-incl"
  ) where

#include "HsVersions.h"

import GhcPrelude

import {-# SOURCE #-} TysWiredIn
  ( runtimeRepTy, unboxedTupleKind, liftedTypeKind
  , vecRepDataConTyCon, tupleRepDataConTyCon
  , liftedRepDataConTy, unliftedRepDataConTy, intRepDataConTy, int8RepDataConTy
  , int16RepDataConTy, word16RepDataConTy
  , wordRepDataConTy, int64RepDataConTy, word8RepDataConTy, word64RepDataConTy
  , addrRepDataConTy
  , floatRepDataConTy, doubleRepDataConTy
  , vec2DataConTy, vec4DataConTy, vec8DataConTy, vec16DataConTy, vec32DataConTy
  , vec64DataConTy
  , int8ElemRepDataConTy, int16ElemRepDataConTy, int32ElemRepDataConTy
  , int64ElemRepDataConTy, word8ElemRepDataConTy, word16ElemRepDataConTy
  , word32ElemRepDataConTy, word64ElemRepDataConTy, floatElemRepDataConTy
  , doubleElemRepDataConTy
  , mkPromotedListTy )

import Var              ( TyVar, VarBndr(Bndr), mkTyVar )
import Name
import TyCon
import SrcLoc
import Unique
import PrelNames
import FastString
import Outputable
import TyCoRep   -- Doesn't need special access, but this is easier to avoid
                 -- import loops which show up if you import Type instead

import Data.Char

{-
************************************************************************
*                                                                      *
\subsection{Primitive type constructors}
*                                                                      *
************************************************************************
-}

primTyCons :: [TyCon]
primTyCons :: [TyCon]
primTyCons = [TyCon]
unexposedPrimTyCons [TyCon] -> [TyCon] -> [TyCon]
forall a. [a] -> [a] -> [a]
++ [TyCon]
exposedPrimTyCons

-- | Primitive 'TyCon's that are defined in "GHC.Prim" but not exposed.
-- It's important to keep these separate as we don't want users to be able to
-- write them (see Trac #15209) or see them in GHCi's @:browse@ output
-- (see Trac #12023).
unexposedPrimTyCons :: [TyCon]
unexposedPrimTyCons :: [TyCon]
unexposedPrimTyCons
  = [ TyCon
eqPrimTyCon
    , TyCon
eqReprPrimTyCon
    , TyCon
eqPhantPrimTyCon
    ]

-- | Primitive 'TyCon's that are defined in, and exported from, "GHC.Prim".
exposedPrimTyCons :: [TyCon]
exposedPrimTyCons :: [TyCon]
exposedPrimTyCons
  = [ TyCon
addrPrimTyCon
    , TyCon
arrayPrimTyCon
    , TyCon
byteArrayPrimTyCon
    , TyCon
arrayArrayPrimTyCon
    , TyCon
smallArrayPrimTyCon
    , TyCon
charPrimTyCon
    , TyCon
doublePrimTyCon
    , TyCon
floatPrimTyCon
    , TyCon
intPrimTyCon
    , TyCon
int8PrimTyCon
    , TyCon
int16PrimTyCon
    , TyCon
int32PrimTyCon
    , TyCon
int64PrimTyCon
    , TyCon
bcoPrimTyCon
    , TyCon
weakPrimTyCon
    , TyCon
mutableArrayPrimTyCon
    , TyCon
mutableByteArrayPrimTyCon
    , TyCon
mutableArrayArrayPrimTyCon
    , TyCon
smallMutableArrayPrimTyCon
    , TyCon
mVarPrimTyCon
    , TyCon
tVarPrimTyCon
    , TyCon
mutVarPrimTyCon
    , TyCon
realWorldTyCon
    , TyCon
stablePtrPrimTyCon
    , TyCon
stableNamePrimTyCon
    , TyCon
compactPrimTyCon
    , TyCon
statePrimTyCon
    , TyCon
voidPrimTyCon
    , TyCon
proxyPrimTyCon
    , TyCon
threadIdPrimTyCon
    , TyCon
wordPrimTyCon
    , TyCon
word8PrimTyCon
    , TyCon
word16PrimTyCon
    , TyCon
word32PrimTyCon
    , TyCon
word64PrimTyCon

    , TyCon
tYPETyCon

#include "primop-vector-tycons.hs-incl"
    ]

mkPrimTc :: FastString -> Unique -> TyCon -> Name
mkPrimTc :: FastString -> Unique -> TyCon -> Name
mkPrimTc fs :: FastString
fs unique :: Unique
unique tycon :: TyCon
tycon
  = Module -> OccName -> Unique -> TyThing -> BuiltInSyntax -> Name
mkWiredInName Module
gHC_PRIM (FastString -> OccName
mkTcOccFS FastString
fs)
                  Unique
unique
                  (TyCon -> TyThing
ATyCon TyCon
tycon)        -- Relevant TyCon
                  BuiltInSyntax
UserSyntax

mkBuiltInPrimTc :: FastString -> Unique -> TyCon -> Name
mkBuiltInPrimTc :: FastString -> Unique -> TyCon -> Name
mkBuiltInPrimTc fs :: FastString
fs unique :: Unique
unique tycon :: TyCon
tycon
  = Module -> OccName -> Unique -> TyThing -> BuiltInSyntax -> Name
mkWiredInName Module
gHC_PRIM (FastString -> OccName
mkTcOccFS FastString
fs)
                  Unique
unique
                  (TyCon -> TyThing
ATyCon TyCon
tycon)        -- Relevant TyCon
                  BuiltInSyntax
BuiltInSyntax


charPrimTyConName, intPrimTyConName, int8PrimTyConName, int16PrimTyConName, int32PrimTyConName, int64PrimTyConName, wordPrimTyConName, word32PrimTyConName, word8PrimTyConName, word16PrimTyConName, word64PrimTyConName, addrPrimTyConName, floatPrimTyConName, doublePrimTyConName, statePrimTyConName, proxyPrimTyConName, realWorldTyConName, arrayPrimTyConName, arrayArrayPrimTyConName, smallArrayPrimTyConName, byteArrayPrimTyConName, mutableArrayPrimTyConName, mutableByteArrayPrimTyConName, mutableArrayArrayPrimTyConName, smallMutableArrayPrimTyConName, mutVarPrimTyConName, mVarPrimTyConName, tVarPrimTyConName, stablePtrPrimTyConName, stableNamePrimTyConName, compactPrimTyConName, bcoPrimTyConName, weakPrimTyConName, threadIdPrimTyConName, eqPrimTyConName, eqReprPrimTyConName, eqPhantPrimTyConName, voidPrimTyConName :: Name
charPrimTyConName :: Name
charPrimTyConName             = FastString -> Unique -> TyCon -> Name
mkPrimTc (String -> FastString
fsLit "Char#") Unique
charPrimTyConKey TyCon
charPrimTyCon
intPrimTyConName :: Name
intPrimTyConName              = FastString -> Unique -> TyCon -> Name
mkPrimTc (String -> FastString
fsLit "Int#") Unique
intPrimTyConKey  TyCon
intPrimTyCon
int8PrimTyConName :: Name
int8PrimTyConName             = FastString -> Unique -> TyCon -> Name
mkPrimTc (String -> FastString
fsLit "Int8#") Unique
int8PrimTyConKey TyCon
int8PrimTyCon
int16PrimTyConName :: Name
int16PrimTyConName            = FastString -> Unique -> TyCon -> Name
mkPrimTc (String -> FastString
fsLit "Int16#") Unique
int16PrimTyConKey TyCon
int16PrimTyCon
int32PrimTyConName :: Name
int32PrimTyConName            = FastString -> Unique -> TyCon -> Name
mkPrimTc (String -> FastString
fsLit "Int32#") Unique
int32PrimTyConKey TyCon
int32PrimTyCon
int64PrimTyConName :: Name
int64PrimTyConName            = FastString -> Unique -> TyCon -> Name
mkPrimTc (String -> FastString
fsLit "Int64#") Unique
int64PrimTyConKey TyCon
int64PrimTyCon
wordPrimTyConName :: Name
wordPrimTyConName             = FastString -> Unique -> TyCon -> Name
mkPrimTc (String -> FastString
fsLit "Word#") Unique
wordPrimTyConKey TyCon
wordPrimTyCon
word8PrimTyConName :: Name
word8PrimTyConName            = FastString -> Unique -> TyCon -> Name
mkPrimTc (String -> FastString
fsLit "Word8#") Unique
word8PrimTyConKey TyCon
word8PrimTyCon
word16PrimTyConName :: Name
word16PrimTyConName           = FastString -> Unique -> TyCon -> Name
mkPrimTc (String -> FastString
fsLit "Word16#") Unique
word16PrimTyConKey TyCon
word16PrimTyCon
word32PrimTyConName :: Name
word32PrimTyConName           = FastString -> Unique -> TyCon -> Name
mkPrimTc (String -> FastString
fsLit "Word32#") Unique
word32PrimTyConKey TyCon
word32PrimTyCon
word64PrimTyConName :: Name
word64PrimTyConName           = FastString -> Unique -> TyCon -> Name
mkPrimTc (String -> FastString
fsLit "Word64#") Unique
word64PrimTyConKey TyCon
word64PrimTyCon
addrPrimTyConName :: Name
addrPrimTyConName             = FastString -> Unique -> TyCon -> Name
mkPrimTc (String -> FastString
fsLit "Addr#") Unique
addrPrimTyConKey TyCon
addrPrimTyCon
floatPrimTyConName :: Name
floatPrimTyConName            = FastString -> Unique -> TyCon -> Name
mkPrimTc (String -> FastString
fsLit "Float#") Unique
floatPrimTyConKey TyCon
floatPrimTyCon
doublePrimTyConName :: Name
doublePrimTyConName           = FastString -> Unique -> TyCon -> Name
mkPrimTc (String -> FastString
fsLit "Double#") Unique
doublePrimTyConKey TyCon
doublePrimTyCon
statePrimTyConName :: Name
statePrimTyConName            = FastString -> Unique -> TyCon -> Name
mkPrimTc (String -> FastString
fsLit "State#") Unique
statePrimTyConKey TyCon
statePrimTyCon
voidPrimTyConName :: Name
voidPrimTyConName             = FastString -> Unique -> TyCon -> Name
mkPrimTc (String -> FastString
fsLit "Void#") Unique
voidPrimTyConKey TyCon
voidPrimTyCon
proxyPrimTyConName :: Name
proxyPrimTyConName            = FastString -> Unique -> TyCon -> Name
mkPrimTc (String -> FastString
fsLit "Proxy#") Unique
proxyPrimTyConKey TyCon
proxyPrimTyCon
eqPrimTyConName :: Name
eqPrimTyConName               = FastString -> Unique -> TyCon -> Name
mkPrimTc (String -> FastString
fsLit "~#") Unique
eqPrimTyConKey TyCon
eqPrimTyCon
eqReprPrimTyConName :: Name
eqReprPrimTyConName           = FastString -> Unique -> TyCon -> Name
mkBuiltInPrimTc (String -> FastString
fsLit "~R#") Unique
eqReprPrimTyConKey TyCon
eqReprPrimTyCon
eqPhantPrimTyConName :: Name
eqPhantPrimTyConName          = FastString -> Unique -> TyCon -> Name
mkBuiltInPrimTc (String -> FastString
fsLit "~P#") Unique
eqPhantPrimTyConKey TyCon
eqPhantPrimTyCon
realWorldTyConName :: Name
realWorldTyConName            = FastString -> Unique -> TyCon -> Name
mkPrimTc (String -> FastString
fsLit "RealWorld") Unique
realWorldTyConKey TyCon
realWorldTyCon
arrayPrimTyConName :: Name
arrayPrimTyConName            = FastString -> Unique -> TyCon -> Name
mkPrimTc (String -> FastString
fsLit "Array#") Unique
arrayPrimTyConKey TyCon
arrayPrimTyCon
byteArrayPrimTyConName :: Name
byteArrayPrimTyConName        = FastString -> Unique -> TyCon -> Name
mkPrimTc (String -> FastString
fsLit "ByteArray#") Unique
byteArrayPrimTyConKey TyCon
byteArrayPrimTyCon
arrayArrayPrimTyConName :: Name
arrayArrayPrimTyConName           = FastString -> Unique -> TyCon -> Name
mkPrimTc (String -> FastString
fsLit "ArrayArray#") Unique
arrayArrayPrimTyConKey TyCon
arrayArrayPrimTyCon
smallArrayPrimTyConName :: Name
smallArrayPrimTyConName       = FastString -> Unique -> TyCon -> Name
mkPrimTc (String -> FastString
fsLit "SmallArray#") Unique
smallArrayPrimTyConKey TyCon
smallArrayPrimTyCon
mutableArrayPrimTyConName :: Name
mutableArrayPrimTyConName     = FastString -> Unique -> TyCon -> Name
mkPrimTc (String -> FastString
fsLit "MutableArray#") Unique
mutableArrayPrimTyConKey TyCon
mutableArrayPrimTyCon
mutableByteArrayPrimTyConName :: Name
mutableByteArrayPrimTyConName = FastString -> Unique -> TyCon -> Name
mkPrimTc (String -> FastString
fsLit "MutableByteArray#") Unique
mutableByteArrayPrimTyConKey TyCon
mutableByteArrayPrimTyCon
mutableArrayArrayPrimTyConName :: Name
mutableArrayArrayPrimTyConName= FastString -> Unique -> TyCon -> Name
mkPrimTc (String -> FastString
fsLit "MutableArrayArray#") Unique
mutableArrayArrayPrimTyConKey TyCon
mutableArrayArrayPrimTyCon
smallMutableArrayPrimTyConName :: Name
smallMutableArrayPrimTyConName= FastString -> Unique -> TyCon -> Name
mkPrimTc (String -> FastString
fsLit "SmallMutableArray#") Unique
smallMutableArrayPrimTyConKey TyCon
smallMutableArrayPrimTyCon
mutVarPrimTyConName :: Name
mutVarPrimTyConName           = FastString -> Unique -> TyCon -> Name
mkPrimTc (String -> FastString
fsLit "MutVar#") Unique
mutVarPrimTyConKey TyCon
mutVarPrimTyCon
mVarPrimTyConName :: Name
mVarPrimTyConName             = FastString -> Unique -> TyCon -> Name
mkPrimTc (String -> FastString
fsLit "MVar#") Unique
mVarPrimTyConKey TyCon
mVarPrimTyCon
tVarPrimTyConName :: Name
tVarPrimTyConName             = FastString -> Unique -> TyCon -> Name
mkPrimTc (String -> FastString
fsLit "TVar#") Unique
tVarPrimTyConKey TyCon
tVarPrimTyCon
stablePtrPrimTyConName :: Name
stablePtrPrimTyConName        = FastString -> Unique -> TyCon -> Name
mkPrimTc (String -> FastString
fsLit "StablePtr#") Unique
stablePtrPrimTyConKey TyCon
stablePtrPrimTyCon
stableNamePrimTyConName :: Name
stableNamePrimTyConName       = FastString -> Unique -> TyCon -> Name
mkPrimTc (String -> FastString
fsLit "StableName#") Unique
stableNamePrimTyConKey TyCon
stableNamePrimTyCon
compactPrimTyConName :: Name
compactPrimTyConName          = FastString -> Unique -> TyCon -> Name
mkPrimTc (String -> FastString
fsLit "Compact#") Unique
compactPrimTyConKey TyCon
compactPrimTyCon
bcoPrimTyConName :: Name
bcoPrimTyConName              = FastString -> Unique -> TyCon -> Name
mkPrimTc (String -> FastString
fsLit "BCO#") Unique
bcoPrimTyConKey TyCon
bcoPrimTyCon
weakPrimTyConName :: Name
weakPrimTyConName             = FastString -> Unique -> TyCon -> Name
mkPrimTc (String -> FastString
fsLit "Weak#") Unique
weakPrimTyConKey TyCon
weakPrimTyCon
threadIdPrimTyConName :: Name
threadIdPrimTyConName         = FastString -> Unique -> TyCon -> Name
mkPrimTc (String -> FastString
fsLit "ThreadId#") Unique
threadIdPrimTyConKey TyCon
threadIdPrimTyCon

{-
************************************************************************
*                                                                      *
\subsection{Support code}
*                                                                      *
************************************************************************

alphaTyVars is a list of type variables for use in templates:
        ["a", "b", ..., "z", "t1", "t2", ... ]
-}

mkTemplateKindVars :: [Kind] -> [TyVar]
-- k0  with unique (mkAlphaTyVarUnique 0)
-- k1  with unique (mkAlphaTyVarUnique 1)
-- ... etc
mkTemplateKindVars :: [Type] -> [TyVar]
mkTemplateKindVars [kind :: Type
kind]
  = [Name -> Type -> TyVar
mkTyVar (Int -> String -> Name
mk_tv_name 0 "k") Type
kind]
    -- Special case for one kind: just "k"

mkTemplateKindVars kinds :: [Type]
kinds
  = [ Name -> Type -> TyVar
mkTyVar (Int -> String -> Name
mk_tv_name Int
u ('k' Char -> String -> String
forall a. a -> [a] -> [a]
: Int -> String
forall a. Show a => a -> String
show Int
u)) Type
kind
    | (kind :: Type
kind, u :: Int
u) <- [Type]
kinds [Type] -> [Int] -> [(Type, Int)]
forall a b. [a] -> [b] -> [(a, b)]
`zip` [0..] ]
mk_tv_name :: Int -> String -> Name
mk_tv_name :: Int -> String -> Name
mk_tv_name u :: Int
u s :: String
s = Unique -> OccName -> SrcSpan -> Name
mkInternalName (Int -> Unique
mkAlphaTyVarUnique Int
u)
                                (FastString -> OccName
mkTyVarOccFS (String -> FastString
mkFastString String
s))
                                SrcSpan
noSrcSpan

mkTemplateTyVarsFrom :: Int -> [Kind] -> [TyVar]
-- a  with unique (mkAlphaTyVarUnique n)
-- b  with unique (mkAlphaTyVarUnique n+1)
-- ... etc
-- Typically called as
--   mkTemplateTyVarsFrom (length kv_bndrs) kinds
-- where kv_bndrs are the kind-level binders of a TyCon
mkTemplateTyVarsFrom :: Int -> [Type] -> [TyVar]
mkTemplateTyVarsFrom n :: Int
n kinds :: [Type]
kinds
  = [ Name -> Type -> TyVar
mkTyVar Name
name Type
kind
    | (kind :: Type
kind, index :: Int
index) <- [Type] -> [Int] -> [(Type, Int)]
forall a b. [a] -> [b] -> [(a, b)]
zip [Type]
kinds [0..],
      let ch_ord :: Int
ch_ord = Int
index Int -> Int -> Int
forall a. Num a => a -> a -> a
+ Char -> Int
ord 'a'
          name_str :: String
name_str | Int
ch_ord Int -> Int -> Bool
forall a. Ord a => a -> a -> Bool
<= Char -> Int
ord 'z' = [Int -> Char
chr Int
ch_ord]
                   | Bool
otherwise         = 't'Char -> String -> String
forall a. a -> [a] -> [a]
:Int -> String
forall a. Show a => a -> String
show Int
index
          name :: Name
name = Int -> String -> Name
mk_tv_name (Int
index Int -> Int -> Int
forall a. Num a => a -> a -> a
+ Int
n) String
name_str
    ]

mkTemplateTyVars :: [Kind] -> [TyVar]
mkTemplateTyVars :: [Type] -> [TyVar]
mkTemplateTyVars = Int -> [Type] -> [TyVar]
mkTemplateTyVarsFrom 1

mkTemplateTyConBinders
    :: [Kind]                -- [k1, .., kn]   Kinds of kind-forall'd vars
    -> ([Kind] -> [Kind])    -- Arg is [kv1:k1, ..., kvn:kn]
                             --     same length as first arg
                             -- Result is anon arg kinds
    -> [TyConBinder]
mkTemplateTyConBinders :: [Type] -> ([Type] -> [Type]) -> [TyConBinder]
mkTemplateTyConBinders kind_var_kinds :: [Type]
kind_var_kinds mk_anon_arg_kinds :: [Type] -> [Type]
mk_anon_arg_kinds
  = [TyConBinder]
kv_bndrs [TyConBinder] -> [TyConBinder] -> [TyConBinder]
forall a. [a] -> [a] -> [a]
++ [TyConBinder]
tv_bndrs
  where
    kv_bndrs :: [TyConBinder]
kv_bndrs   = [Type] -> [TyConBinder]
mkTemplateKindTyConBinders [Type]
kind_var_kinds
    anon_kinds :: [Type]
anon_kinds = [Type] -> [Type]
mk_anon_arg_kinds ([TyVar] -> [Type]
mkTyVarTys ([TyConBinder] -> [TyVar]
forall tv argf. [VarBndr tv argf] -> [tv]
binderVars [TyConBinder]
kv_bndrs))
    tv_bndrs :: [TyConBinder]
tv_bndrs   = Int -> [Type] -> [TyConBinder]
mkTemplateAnonTyConBindersFrom ([TyConBinder] -> Int
forall (t :: * -> *) a. Foldable t => t a -> Int
length [TyConBinder]
kv_bndrs) [Type]
anon_kinds

mkTemplateKiTyVars
    :: [Kind]                -- [k1, .., kn]   Kinds of kind-forall'd vars
    -> ([Kind] -> [Kind])    -- Arg is [kv1:k1, ..., kvn:kn]
                             --     same length as first arg
                             -- Result is anon arg kinds [ak1, .., akm]
    -> [TyVar]   -- [kv1:k1, ..., kvn:kn, av1:ak1, ..., avm:akm]
-- Example: if you want the tyvars for
--   forall (r:RuntimeRep) (a:TYPE r) (b:*). blah
-- call mkTemplateKiTyVars [RuntimeRep] (\[r]. [TYPE r, *)
mkTemplateKiTyVars :: [Type] -> ([Type] -> [Type]) -> [TyVar]
mkTemplateKiTyVars kind_var_kinds :: [Type]
kind_var_kinds mk_arg_kinds :: [Type] -> [Type]
mk_arg_kinds
  = [TyVar]
kv_bndrs [TyVar] -> [TyVar] -> [TyVar]
forall a. [a] -> [a] -> [a]
++ [TyVar]
tv_bndrs
  where
    kv_bndrs :: [TyVar]
kv_bndrs   = [Type] -> [TyVar]
mkTemplateKindVars [Type]
kind_var_kinds
    anon_kinds :: [Type]
anon_kinds = [Type] -> [Type]
mk_arg_kinds ([TyVar] -> [Type]
mkTyVarTys [TyVar]
kv_bndrs)
    tv_bndrs :: [TyVar]
tv_bndrs   = Int -> [Type] -> [TyVar]
mkTemplateTyVarsFrom ([TyVar] -> Int
forall (t :: * -> *) a. Foldable t => t a -> Int
length [TyVar]
kv_bndrs) [Type]
anon_kinds

mkTemplateKindTyConBinders :: [Kind] -> [TyConBinder]
-- Makes named, Specified binders
mkTemplateKindTyConBinders :: [Type] -> [TyConBinder]
mkTemplateKindTyConBinders kinds :: [Type]
kinds = [ArgFlag -> TyVar -> TyConBinder
mkNamedTyConBinder ArgFlag
Specified TyVar
tv | TyVar
tv <- [Type] -> [TyVar]
mkTemplateKindVars [Type]
kinds]

mkTemplateAnonTyConBinders :: [Kind] -> [TyConBinder]
mkTemplateAnonTyConBinders :: [Type] -> [TyConBinder]
mkTemplateAnonTyConBinders kinds :: [Type]
kinds = (TyVar -> TyConBinder) -> [TyVar] -> [TyConBinder]
forall a b. (a -> b) -> [a] -> [b]
map TyVar -> TyConBinder
mkAnonTyConBinder ([Type] -> [TyVar]
mkTemplateTyVars [Type]
kinds)

mkTemplateAnonTyConBindersFrom :: Int -> [Kind] -> [TyConBinder]
mkTemplateAnonTyConBindersFrom :: Int -> [Type] -> [TyConBinder]
mkTemplateAnonTyConBindersFrom n :: Int
n kinds :: [Type]
kinds = (TyVar -> TyConBinder) -> [TyVar] -> [TyConBinder]
forall a b. (a -> b) -> [a] -> [b]
map TyVar -> TyConBinder
mkAnonTyConBinder (Int -> [Type] -> [TyVar]
mkTemplateTyVarsFrom Int
n [Type]
kinds)

alphaTyVars :: [TyVar]
alphaTyVars :: [TyVar]
alphaTyVars = [Type] -> [TyVar]
mkTemplateTyVars ([Type] -> [TyVar]) -> [Type] -> [TyVar]
forall a b. (a -> b) -> a -> b
$ Type -> [Type]
forall a. a -> [a]
repeat Type
liftedTypeKind

alphaTyVar, betaTyVar, gammaTyVar, deltaTyVar :: TyVar
(alphaTyVar :: TyVar
alphaTyVar:betaTyVar :: TyVar
betaTyVar:gammaTyVar :: TyVar
gammaTyVar:deltaTyVar :: TyVar
deltaTyVar:_) = [TyVar]
alphaTyVars

alphaTys :: [Type]
alphaTys :: [Type]
alphaTys = [TyVar] -> [Type]
mkTyVarTys [TyVar]
alphaTyVars
alphaTy, betaTy, gammaTy, deltaTy :: Type
(alphaTy :: Type
alphaTy:betaTy :: Type
betaTy:gammaTy :: Type
gammaTy:deltaTy :: Type
deltaTy:_) = [Type]
alphaTys

alphaTyVarsUnliftedRep :: [TyVar]
alphaTyVarsUnliftedRep :: [TyVar]
alphaTyVarsUnliftedRep = [Type] -> [TyVar]
mkTemplateTyVars ([Type] -> [TyVar]) -> [Type] -> [TyVar]
forall a b. (a -> b) -> a -> b
$ Type -> [Type]
forall a. a -> [a]
repeat (Type -> Type
tYPE Type
unliftedRepDataConTy)

alphaTyVarUnliftedRep :: TyVar
(alphaTyVarUnliftedRep :: TyVar
alphaTyVarUnliftedRep:_) = [TyVar]
alphaTyVarsUnliftedRep

alphaTysUnliftedRep :: [Type]
alphaTysUnliftedRep :: [Type]
alphaTysUnliftedRep = [TyVar] -> [Type]
mkTyVarTys [TyVar]
alphaTyVarsUnliftedRep
alphaTyUnliftedRep :: Type
(alphaTyUnliftedRep :: Type
alphaTyUnliftedRep:_) = [Type]
alphaTysUnliftedRep

runtimeRep1TyVar, runtimeRep2TyVar :: TyVar
(runtimeRep1TyVar :: TyVar
runtimeRep1TyVar : runtimeRep2TyVar :: TyVar
runtimeRep2TyVar : _)
  = Int -> [TyVar] -> [TyVar]
forall a. Int -> [a] -> [a]
drop 16 ([Type] -> [TyVar]
mkTemplateTyVars (Type -> [Type]
forall a. a -> [a]
repeat Type
runtimeRepTy))  -- selects 'q','r'

runtimeRep1Ty, runtimeRep2Ty :: Type
runtimeRep1Ty :: Type
runtimeRep1Ty = TyVar -> Type
mkTyVarTy TyVar
runtimeRep1TyVar
runtimeRep2Ty :: Type
runtimeRep2Ty = TyVar -> Type
mkTyVarTy TyVar
runtimeRep2TyVar

openAlphaTyVar, openBetaTyVar :: TyVar
[openAlphaTyVar :: TyVar
openAlphaTyVar,openBetaTyVar :: TyVar
openBetaTyVar]
  = [Type] -> [TyVar]
mkTemplateTyVars [Type -> Type
tYPE Type
runtimeRep1Ty, Type -> Type
tYPE Type
runtimeRep2Ty]

openAlphaTy, openBetaTy :: Type
openAlphaTy :: Type
openAlphaTy = TyVar -> Type
mkTyVarTy TyVar
openAlphaTyVar
openBetaTy :: Type
openBetaTy  = TyVar -> Type
mkTyVarTy TyVar
openBetaTyVar

{-
************************************************************************
*                                                                      *
                FunTyCon
*                                                                      *
************************************************************************
-}

funTyConName :: Name
funTyConName :: Name
funTyConName = FastString -> Unique -> TyCon -> Name
mkPrimTyConName (String -> FastString
fsLit "->") Unique
funTyConKey TyCon
funTyCon

-- | The @(->)@ type constructor.
--
-- @
-- (->) :: forall (rep1 :: RuntimeRep) (rep2 :: RuntimeRep).
--         TYPE rep1 -> TYPE rep2 -> *
-- @
funTyCon :: TyCon
funTyCon :: TyCon
funTyCon = Name -> [TyConBinder] -> Name -> TyCon
mkFunTyCon Name
funTyConName [TyConBinder]
tc_bndrs Name
tc_rep_nm
  where
    tc_bndrs :: [TyConBinder]
tc_bndrs = [ TyVar -> TyConBndrVis -> TyConBinder
forall var argf. var -> argf -> VarBndr var argf
Bndr TyVar
runtimeRep1TyVar (ArgFlag -> TyConBndrVis
NamedTCB ArgFlag
Inferred)
               , TyVar -> TyConBndrVis -> TyConBinder
forall var argf. var -> argf -> VarBndr var argf
Bndr TyVar
runtimeRep2TyVar (ArgFlag -> TyConBndrVis
NamedTCB ArgFlag
Inferred)
               ]
               [TyConBinder] -> [TyConBinder] -> [TyConBinder]
forall a. [a] -> [a] -> [a]
++ [Type] -> [TyConBinder]
mkTemplateAnonTyConBinders [ Type -> Type
tYPE Type
runtimeRep1Ty
                                             , Type -> Type
tYPE Type
runtimeRep2Ty
                                             ]
    tc_rep_nm :: Name
tc_rep_nm = Name -> Name
mkPrelTyConRepName Name
funTyConName

{-
************************************************************************
*                                                                      *
                Kinds
*                                                                      *
************************************************************************

Note [TYPE and RuntimeRep]
~~~~~~~~~~~~~~~~~~~~~~~~~~
All types that classify values have a kind of the form (TYPE rr), where

    data RuntimeRep     -- Defined in ghc-prim:GHC.Types
      = LiftedRep
      | UnliftedRep
      | IntRep
      | FloatRep
      .. etc ..

    rr :: RuntimeRep

    TYPE :: RuntimeRep -> TYPE 'LiftedRep  -- Built in

So for example:
    Int        :: TYPE 'LiftedRep
    Array# Int :: TYPE 'UnliftedRep
    Int#       :: TYPE 'IntRep
    Float#     :: TYPE 'FloatRep
    Maybe      :: TYPE 'LiftedRep -> TYPE 'LiftedRep
    (# , #)    :: TYPE r1 -> TYPE r2 -> TYPE (TupleRep [r1, r2])

We abbreviate '*' specially:
    type * = TYPE 'LiftedRep

The 'rr' parameter tells us how the value is represented at runime.

Generally speaking, you can't be polymorphic in 'rr'.  E.g
   f :: forall (rr:RuntimeRep) (a:TYPE rr). a -> [a]
   f = /\(rr:RuntimeRep) (a:rr) \(a:rr). ...
This is no good: we could not generate code code for 'f', because the
calling convention for 'f' varies depending on whether the argument is
a a Int, Int#, or Float#.  (You could imagine generating specialised
code, one for each instantiation of 'rr', but we don't do that.)

Certain functions CAN be runtime-rep-polymorphic, because the code
generator never has to manipulate a value of type 'a :: TYPE rr'.

* error :: forall (rr:RuntimeRep) (a:TYPE rr). String -> a
  Code generator never has to manipulate the return value.

* unsafeCoerce#, defined in MkId.unsafeCoerceId:
  Always inlined to be a no-op
     unsafeCoerce# :: forall (r1 :: RuntimeRep) (r2 :: RuntimeRep)
                             (a :: TYPE r1) (b :: TYPE r2).
                             a -> b

* Unboxed tuples, and unboxed sums, defined in TysWiredIn
  Always inlined, and hence specialised to the call site
     (#,#) :: forall (r1 :: RuntimeRep) (r2 :: RuntimeRep)
                     (a :: TYPE r1) (b :: TYPE r2).
                     a -> b -> TYPE ('TupleRep '[r1, r2])

Note [PrimRep and kindPrimRep]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
As part of its source code, in TyCon, GHC has
  data PrimRep = LiftedRep | UnliftedRep | IntRep | FloatRep | ...etc...

Notice that
 * RuntimeRep is part of the syntax tree of the program being compiled
     (defined in a library: ghc-prim:GHC.Types)
 * PrimRep is part of GHC's source code.
     (defined in TyCon)

We need to get from one to the other; that is what kindPrimRep does.
Suppose we have a value
   (v :: t) where (t :: k)
Given this kind
    k = TyConApp "TYPE" [rep]
GHC needs to be able to figure out how 'v' is represented at runtime.
It expects 'rep' to be form
    TyConApp rr_dc args
where 'rr_dc' is a promoteed data constructor from RuntimeRep. So
now we need to go from 'dc' to the corresponding PrimRep.  We store this
PrimRep in the promoted data constructor itself: see TyCon.promDcRepInfo.

-}

tYPETyCon :: TyCon
tYPETyConName :: Name

tYPETyCon :: TyCon
tYPETyCon = Name -> [TyConBinder] -> Type -> [Role] -> Name -> TyCon
mkKindTyCon Name
tYPETyConName
                        ([Type] -> [TyConBinder]
mkTemplateAnonTyConBinders [Type
runtimeRepTy])
                        Type
liftedTypeKind
                        [Role
Nominal]
                        (Name -> Name
mkPrelTyConRepName Name
tYPETyConName)

--------------------------
-- ... and now their names

-- If you edit these, you may need to update the GHC formalism
-- See Note [GHC Formalism] in coreSyn/CoreLint.hs
tYPETyConName :: Name
tYPETyConName             = FastString -> Unique -> TyCon -> Name
mkPrimTyConName (String -> FastString
fsLit "TYPE") Unique
tYPETyConKey TyCon
tYPETyCon

mkPrimTyConName :: FastString -> Unique -> TyCon -> Name
mkPrimTyConName :: FastString -> Unique -> TyCon -> Name
mkPrimTyConName = BuiltInSyntax -> FastString -> Unique -> TyCon -> Name
mkPrimTcName BuiltInSyntax
BuiltInSyntax
  -- All of the super kinds and kinds are defined in Prim,
  -- and use BuiltInSyntax, because they are never in scope in the source

mkPrimTcName :: BuiltInSyntax -> FastString -> Unique -> TyCon -> Name
mkPrimTcName :: BuiltInSyntax -> FastString -> Unique -> TyCon -> Name
mkPrimTcName built_in_syntax :: BuiltInSyntax
built_in_syntax occ :: FastString
occ key :: Unique
key tycon :: TyCon
tycon
  = Module -> OccName -> Unique -> TyThing -> BuiltInSyntax -> Name
mkWiredInName Module
gHC_PRIM (FastString -> OccName
mkTcOccFS FastString
occ) Unique
key (TyCon -> TyThing
ATyCon TyCon
tycon) BuiltInSyntax
built_in_syntax

-----------------------------
-- | Given a RuntimeRep, applies TYPE to it.
-- see Note [TYPE and RuntimeRep]
tYPE :: Type -> Type
tYPE :: Type -> Type
tYPE rr :: Type
rr = TyCon -> [Type] -> Type
TyConApp TyCon
tYPETyCon [Type
rr]

{-
************************************************************************
*                                                                      *
\subsection[TysPrim-basic]{Basic primitive types (@Char#@, @Int#@, etc.)}
*                                                                      *
************************************************************************
-}

-- only used herein
pcPrimTyCon :: Name -> [Role] -> PrimRep -> TyCon
pcPrimTyCon :: Name -> [Role] -> PrimRep -> TyCon
pcPrimTyCon name :: Name
name roles :: [Role]
roles rep :: PrimRep
rep
  = Name -> [TyConBinder] -> Type -> [Role] -> TyCon
mkPrimTyCon Name
name [TyConBinder]
binders Type
result_kind [Role]
roles
  where
    binders :: [TyConBinder]
binders     = [Type] -> [TyConBinder]
mkTemplateAnonTyConBinders ((Role -> Type) -> [Role] -> [Type]
forall a b. (a -> b) -> [a] -> [b]
map (Type -> Role -> Type
forall a b. a -> b -> a
const Type
liftedTypeKind) [Role]
roles)
    result_kind :: Type
result_kind = Type -> Type
tYPE (PrimRep -> Type
primRepToRuntimeRep PrimRep
rep)

-- | Convert a 'PrimRep' to a 'Type' of kind RuntimeRep
-- Defined here to avoid (more) module loops
primRepToRuntimeRep :: PrimRep -> Type
primRepToRuntimeRep :: PrimRep -> Type
primRepToRuntimeRep rep :: PrimRep
rep = case PrimRep
rep of
  VoidRep       -> TyCon -> [Type] -> Type
TyConApp TyCon
tupleRepDataConTyCon [Type -> [Type] -> Type
mkPromotedListTy Type
runtimeRepTy []]
  LiftedRep     -> Type
liftedRepDataConTy
  UnliftedRep   -> Type
unliftedRepDataConTy
  IntRep        -> Type
intRepDataConTy
  Int8Rep       -> Type
int8RepDataConTy
  Int16Rep      -> Type
int16RepDataConTy
  WordRep       -> Type
wordRepDataConTy
  Int64Rep      -> Type
int64RepDataConTy
  Word8Rep      -> Type
word8RepDataConTy
  Word16Rep     -> Type
word16RepDataConTy
  Word64Rep     -> Type
word64RepDataConTy
  AddrRep       -> Type
addrRepDataConTy
  FloatRep      -> Type
floatRepDataConTy
  DoubleRep     -> Type
doubleRepDataConTy
  VecRep n :: Int
n elem :: PrimElemRep
elem -> TyCon -> [Type] -> Type
TyConApp TyCon
vecRepDataConTyCon [Type
n', Type
elem']
    where
      n' :: Type
n' = case Int
n of
        2  -> Type
vec2DataConTy
        4  -> Type
vec4DataConTy
        8  -> Type
vec8DataConTy
        16 -> Type
vec16DataConTy
        32 -> Type
vec32DataConTy
        64 -> Type
vec64DataConTy
        _  -> String -> SDoc -> Type
forall a. HasCallStack => String -> SDoc -> a
pprPanic "Disallowed VecCount" (Int -> SDoc
forall a. Outputable a => a -> SDoc
ppr Int
n)

      elem' :: Type
elem' = case PrimElemRep
elem of
        Int8ElemRep   -> Type
int8ElemRepDataConTy
        Int16ElemRep  -> Type
int16ElemRepDataConTy
        Int32ElemRep  -> Type
int32ElemRepDataConTy
        Int64ElemRep  -> Type
int64ElemRepDataConTy
        Word8ElemRep  -> Type
word8ElemRepDataConTy
        Word16ElemRep -> Type
word16ElemRepDataConTy
        Word32ElemRep -> Type
word32ElemRepDataConTy
        Word64ElemRep -> Type
word64ElemRepDataConTy
        FloatElemRep  -> Type
floatElemRepDataConTy
        DoubleElemRep -> Type
doubleElemRepDataConTy

pcPrimTyCon0 :: Name -> PrimRep -> TyCon
pcPrimTyCon0 :: Name -> PrimRep -> TyCon
pcPrimTyCon0 name :: Name
name rep :: PrimRep
rep
  = Name -> [Role] -> PrimRep -> TyCon
pcPrimTyCon Name
name [] PrimRep
rep

charPrimTy :: Type
charPrimTy :: Type
charPrimTy      = TyCon -> Type
mkTyConTy TyCon
charPrimTyCon
charPrimTyCon :: TyCon
charPrimTyCon :: TyCon
charPrimTyCon   = Name -> PrimRep -> TyCon
pcPrimTyCon0 Name
charPrimTyConName PrimRep
WordRep

intPrimTy :: Type
intPrimTy :: Type
intPrimTy       = TyCon -> Type
mkTyConTy TyCon
intPrimTyCon
intPrimTyCon :: TyCon
intPrimTyCon :: TyCon
intPrimTyCon    = Name -> PrimRep -> TyCon
pcPrimTyCon0 Name
intPrimTyConName PrimRep
IntRep

int8PrimTy :: Type
int8PrimTy :: Type
int8PrimTy     = TyCon -> Type
mkTyConTy TyCon
int8PrimTyCon
int8PrimTyCon :: TyCon
int8PrimTyCon :: TyCon
int8PrimTyCon  = Name -> PrimRep -> TyCon
pcPrimTyCon0 Name
int8PrimTyConName PrimRep
Int8Rep

int16PrimTy :: Type
int16PrimTy :: Type
int16PrimTy    = TyCon -> Type
mkTyConTy TyCon
int16PrimTyCon
int16PrimTyCon :: TyCon
int16PrimTyCon :: TyCon
int16PrimTyCon = Name -> PrimRep -> TyCon
pcPrimTyCon0 Name
int16PrimTyConName PrimRep
Int16Rep

int32PrimTy :: Type
int32PrimTy :: Type
int32PrimTy     = TyCon -> Type
mkTyConTy TyCon
int32PrimTyCon
int32PrimTyCon :: TyCon
int32PrimTyCon :: TyCon
int32PrimTyCon  = Name -> PrimRep -> TyCon
pcPrimTyCon0 Name
int32PrimTyConName PrimRep
IntRep

int64PrimTy :: Type
int64PrimTy :: Type
int64PrimTy     = TyCon -> Type
mkTyConTy TyCon
int64PrimTyCon
int64PrimTyCon :: TyCon
int64PrimTyCon :: TyCon
int64PrimTyCon  = Name -> PrimRep -> TyCon
pcPrimTyCon0 Name
int64PrimTyConName PrimRep
Int64Rep

wordPrimTy :: Type
wordPrimTy :: Type
wordPrimTy      = TyCon -> Type
mkTyConTy TyCon
wordPrimTyCon
wordPrimTyCon :: TyCon
wordPrimTyCon :: TyCon
wordPrimTyCon   = Name -> PrimRep -> TyCon
pcPrimTyCon0 Name
wordPrimTyConName PrimRep
WordRep

word8PrimTy :: Type
word8PrimTy :: Type
word8PrimTy     = TyCon -> Type
mkTyConTy TyCon
word8PrimTyCon
word8PrimTyCon :: TyCon
word8PrimTyCon :: TyCon
word8PrimTyCon  = Name -> PrimRep -> TyCon
pcPrimTyCon0 Name
word8PrimTyConName PrimRep
Word8Rep

word16PrimTy :: Type
word16PrimTy :: Type
word16PrimTy    = TyCon -> Type
mkTyConTy TyCon
word16PrimTyCon
word16PrimTyCon :: TyCon
word16PrimTyCon :: TyCon
word16PrimTyCon = Name -> PrimRep -> TyCon
pcPrimTyCon0 Name
word16PrimTyConName PrimRep
Word16Rep

word32PrimTy :: Type
word32PrimTy :: Type
word32PrimTy    = TyCon -> Type
mkTyConTy TyCon
word32PrimTyCon
word32PrimTyCon :: TyCon
word32PrimTyCon :: TyCon
word32PrimTyCon = Name -> PrimRep -> TyCon
pcPrimTyCon0 Name
word32PrimTyConName PrimRep
WordRep

word64PrimTy :: Type
word64PrimTy :: Type
word64PrimTy    = TyCon -> Type
mkTyConTy TyCon
word64PrimTyCon
word64PrimTyCon :: TyCon
word64PrimTyCon :: TyCon
word64PrimTyCon = Name -> PrimRep -> TyCon
pcPrimTyCon0 Name
word64PrimTyConName PrimRep
Word64Rep

addrPrimTy :: Type
addrPrimTy :: Type
addrPrimTy      = TyCon -> Type
mkTyConTy TyCon
addrPrimTyCon
addrPrimTyCon :: TyCon
addrPrimTyCon :: TyCon
addrPrimTyCon   = Name -> PrimRep -> TyCon
pcPrimTyCon0 Name
addrPrimTyConName PrimRep
AddrRep

floatPrimTy     :: Type
floatPrimTy :: Type
floatPrimTy     = TyCon -> Type
mkTyConTy TyCon
floatPrimTyCon
floatPrimTyCon :: TyCon
floatPrimTyCon :: TyCon
floatPrimTyCon  = Name -> PrimRep -> TyCon
pcPrimTyCon0 Name
floatPrimTyConName PrimRep
FloatRep

doublePrimTy :: Type
doublePrimTy :: Type
doublePrimTy    = TyCon -> Type
mkTyConTy TyCon
doublePrimTyCon
doublePrimTyCon :: TyCon
doublePrimTyCon :: TyCon
doublePrimTyCon = Name -> PrimRep -> TyCon
pcPrimTyCon0 Name
doublePrimTyConName PrimRep
DoubleRep

{-
************************************************************************
*                                                                      *
\subsection[TysPrim-state]{The @State#@ type (and @_RealWorld@ types)}
*                                                                      *
************************************************************************

Note [The equality types story]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
GHC sports a veritable menagerie of equality types:

         Type or  Lifted?  Hetero?  Role      Built in         Defining module
         class?    L/U                        TyCon
-----------------------------------------------------------------------------------------
~#         T        U      hetero   nominal   eqPrimTyCon      GHC.Prim
~~         C        L      hetero   nominal   heqTyCon         GHC.Types
~          C        L      homo     nominal   eqTyCon          GHC.Types
:~:        T        L      homo     nominal   (not built-in)   Data.Type.Equality
:~~:       T        L      hetero   nominal   (not built-in)   Data.Type.Equality

~R#        T        U      hetero   repr      eqReprPrimTy     GHC.Prim
Coercible  C        L      homo     repr      coercibleTyCon   GHC.Types
Coercion   T        L      homo     repr      (not built-in)   Data.Type.Coercion
~P#        T        U      hetero   phantom   eqPhantPrimTyCon GHC.Prim

Recall that "hetero" means the equality can related types of different
kinds. Knowing that (t1 ~# t2) or (t1 ~R# t2) or even that (t1 ~P# t2)
also means that (k1 ~# k2), where (t1 :: k1) and (t2 :: k2).

To produce less confusion for end users, when not dumping and without
-fprint-equality-relations, each of these groups is printed as the bottommost
listed equality. That is, (~#) and (~~) are both rendered as (~) in
error messages, and (~R#) is rendered as Coercible.

Let's take these one at a time:

    --------------------------
    (~#) :: forall k1 k2. k1 -> k2 -> #
    --------------------------
This is The Type Of Equality in GHC. It classifies nominal coercions.
This type is used in the solver for recording equality constraints.
It responds "yes" to Type.isEqPred and classifies as an EqPred in
Type.classifyPredType.

All wanted constraints of this type are built with coercion holes.
(See Note [Coercion holes] in TyCoRep.) But see also
Note [Deferred errors for coercion holes] in TcErrors to see how
equality constraints are deferred.

Within GHC, ~# is called eqPrimTyCon, and it is defined in TysPrim.


    --------------------------
    (~~) :: forall k1 k2. k1 -> k2 -> Constraint
    --------------------------
This is (almost) an ordinary class, defined as if by
  class a ~# b => a ~~ b
  instance a ~# b => a ~~ b
Here's what's unusual about it:

 * We can't actually declare it that way because we don't have syntax for ~#.
   And ~# isn't a constraint, so even if we could write it, it wouldn't kind
   check.

 * Users cannot write instances of it.

 * It is "naturally coherent". This means that the solver won't hesitate to
   solve a goal of type (a ~~ b) even if there is, say (Int ~~ c) in the
   context. (Normally, it waits to learn more, just in case the given
   influences what happens next.) See Note [Naturally coherent classes]
   in TcInteract.

 * It always terminates. That is, in the UndecidableInstances checks, we
   don't worry if a (~~) constraint is too big, as we know that solving
   equality terminates.

On the other hand, this behaves just like any class w.r.t. eager superclass
unpacking in the solver. So a lifted equality given quickly becomes an unlifted
equality given. This is good, because the solver knows all about unlifted
equalities. There is some special-casing in TcInteract.matchClassInst to
pretend that there is an instance of this class, as we can't write the instance
in Haskell.

Within GHC, ~~ is called heqTyCon, and it is defined in TysWiredIn.


    --------------------------
    (~) :: forall k. k -> k -> Constraint
    --------------------------
This is /exactly/ like (~~), except with a homogeneous kind.
It is an almost-ordinary class defined as if by
  class a ~# b => (a :: k) ~ (b :: k)
  instance a ~# b => a ~ b

 * All the bullets for (~~) apply

 * In addition (~) is magical syntax, as ~ is a reserved symbol.
   It cannot be exported or imported.

Within GHC, ~ is called eqTyCon, and it is defined in TysWiredIn.

Historical note: prior to July 18 (~) was defined as a
  more-ordinary class with (~~) as a superclass.  But that made it
  special in different ways; and the extra superclass selections to
  get from (~) to (~#) via (~~) were tiresome.  Now it's defined
  uniformly with (~~) and Coercible; much nicer.)


    --------------------------
    (:~:) :: forall k. k -> k -> *
    (:~~:) :: forall k1 k2. k1 -> k2 -> *
    --------------------------
These are perfectly ordinary GADTs, wrapping (~) and (~~) resp.
They are not defined within GHC at all.


    --------------------------
    (~R#) :: forall k1 k2. k1 -> k2 -> #
    --------------------------
The is the representational analogue of ~#. This is the type of representational
equalities that the solver works on. All wanted constraints of this type are
built with coercion holes.

Within GHC, ~R# is called eqReprPrimTyCon, and it is defined in TysPrim.


    --------------------------
    Coercible :: forall k. k -> k -> Constraint
    --------------------------
This is quite like (~~) in the way it's defined and treated within GHC, but
it's homogeneous. Homogeneity helps with type inference (as GHC can solve one
kind from the other) and, in my (Richard's) estimation, will be more intuitive
for users.

An alternative design included HCoercible (like (~~)) and Coercible (like (~)).
One annoyance was that we want `coerce :: Coercible a b => a -> b`, and
we need the type of coerce to be fully wired-in. So the HCoercible/Coercible
split required that both types be fully wired-in. Instead of doing this,
I just got rid of HCoercible, as I'm not sure who would use it, anyway.

Within GHC, Coercible is called coercibleTyCon, and it is defined in
TysWiredIn.


    --------------------------
    Coercion :: forall k. k -> k -> *
    --------------------------
This is a perfectly ordinary GADT, wrapping Coercible. It is not defined
within GHC at all.


    --------------------------
    (~P#) :: forall k1 k2. k1 -> k2 -> #
    --------------------------
This is the phantom analogue of ~# and it is barely used at all.
(The solver has no idea about this one.) Here is the motivation:

    data Phant a = MkPhant
    type role Phant phantom

    Phant <Int, Bool>_P :: Phant Int ~P# Phant Bool

We just need to have something to put on that last line. You probably
don't need to worry about it.



Note [The State# TyCon]
~~~~~~~~~~~~~~~~~~~~~~~
State# is the primitive, unlifted type of states.  It has one type parameter,
thus
        State# RealWorld
or
        State# s

where s is a type variable. The only purpose of the type parameter is to
keep different state threads separate.  It is represented by nothing at all.

The type parameter to State# is intended to keep separate threads separate.
Even though this parameter is not used in the definition of State#, it is
given role Nominal to enforce its intended use.
-}

mkStatePrimTy :: Type -> Type
mkStatePrimTy :: Type -> Type
mkStatePrimTy ty :: Type
ty = TyCon -> [Type] -> Type
TyConApp TyCon
statePrimTyCon [Type
ty]

statePrimTyCon :: TyCon   -- See Note [The State# TyCon]
statePrimTyCon :: TyCon
statePrimTyCon   = Name -> [Role] -> PrimRep -> TyCon
pcPrimTyCon Name
statePrimTyConName [Role
Nominal] PrimRep
VoidRep

{-
RealWorld is deeply magical.  It is *primitive*, but it is not
*unlifted* (hence ptrArg).  We never manipulate values of type
RealWorld; it's only used in the type system, to parameterise State#.
-}

realWorldTyCon :: TyCon
realWorldTyCon :: TyCon
realWorldTyCon = Name -> [TyConBinder] -> Type -> [Role] -> TyCon
mkLiftedPrimTyCon Name
realWorldTyConName [] Type
liftedTypeKind []
realWorldTy :: Type
realWorldTy :: Type
realWorldTy          = TyCon -> Type
mkTyConTy TyCon
realWorldTyCon
realWorldStatePrimTy :: Type
realWorldStatePrimTy :: Type
realWorldStatePrimTy = Type -> Type
mkStatePrimTy Type
realWorldTy        -- State# RealWorld

-- Note: the ``state-pairing'' types are not truly primitive,
-- so they are defined in \tr{TysWiredIn.hs}, not here.


voidPrimTy :: Type
voidPrimTy :: Type
voidPrimTy = TyCon -> [Type] -> Type
TyConApp TyCon
voidPrimTyCon []

voidPrimTyCon :: TyCon
voidPrimTyCon :: TyCon
voidPrimTyCon    = Name -> [Role] -> PrimRep -> TyCon
pcPrimTyCon Name
voidPrimTyConName [] PrimRep
VoidRep

mkProxyPrimTy :: Type -> Type -> Type
mkProxyPrimTy :: Type -> Type -> Type
mkProxyPrimTy k :: Type
k ty :: Type
ty = TyCon -> [Type] -> Type
TyConApp TyCon
proxyPrimTyCon [Type
k, Type
ty]

proxyPrimTyCon :: TyCon
proxyPrimTyCon :: TyCon
proxyPrimTyCon = Name -> [TyConBinder] -> Type -> [Role] -> TyCon
mkPrimTyCon Name
proxyPrimTyConName [TyConBinder]
binders Type
res_kind [Role
Nominal,Role
Nominal]
  where
     -- Kind: forall k. k -> Void#
     binders :: [TyConBinder]
binders = [Type] -> ([Type] -> [Type]) -> [TyConBinder]
mkTemplateTyConBinders [Type
liftedTypeKind] [Type] -> [Type]
forall a. a -> a
id
     res_kind :: Type
res_kind = [Type] -> Type
unboxedTupleKind []


{- *********************************************************************
*                                                                      *
                Primitive equality constraints
    See Note [The equality types story]
*                                                                      *
********************************************************************* -}

eqPrimTyCon :: TyCon  -- The representation type for equality predicates
                      -- See Note [The equality types story]
eqPrimTyCon :: TyCon
eqPrimTyCon  = Name -> [TyConBinder] -> Type -> [Role] -> TyCon
mkPrimTyCon Name
eqPrimTyConName [TyConBinder]
binders Type
res_kind [Role]
roles
  where
    -- Kind :: forall k1 k2. k1 -> k2 -> Void#
    binders :: [TyConBinder]
binders  = [Type] -> ([Type] -> [Type]) -> [TyConBinder]
mkTemplateTyConBinders [Type
liftedTypeKind, Type
liftedTypeKind] [Type] -> [Type]
forall a. a -> a
id
    res_kind :: Type
res_kind = [Type] -> Type
unboxedTupleKind []
    roles :: [Role]
roles    = [Role
Nominal, Role
Nominal, Role
Nominal, Role
Nominal]

-- like eqPrimTyCon, but the type for *Representational* coercions
-- this should only ever appear as the type of a covar. Its role is
-- interpreted in coercionRole
eqReprPrimTyCon :: TyCon   -- See Note [The equality types story]
eqReprPrimTyCon :: TyCon
eqReprPrimTyCon = Name -> [TyConBinder] -> Type -> [Role] -> TyCon
mkPrimTyCon Name
eqReprPrimTyConName [TyConBinder]
binders Type
res_kind [Role]
roles
  where
    -- Kind :: forall k1 k2. k1 -> k2 -> Void#
    binders :: [TyConBinder]
binders  = [Type] -> ([Type] -> [Type]) -> [TyConBinder]
mkTemplateTyConBinders [Type
liftedTypeKind, Type
liftedTypeKind] [Type] -> [Type]
forall a. a -> a
id
    res_kind :: Type
res_kind = [Type] -> Type
unboxedTupleKind []
    roles :: [Role]
roles    = [Role
Nominal, Role
Nominal, Role
Representational, Role
Representational]

-- like eqPrimTyCon, but the type for *Phantom* coercions.
-- This is only used to make higher-order equalities. Nothing
-- should ever actually have this type!
eqPhantPrimTyCon :: TyCon
eqPhantPrimTyCon :: TyCon
eqPhantPrimTyCon = Name -> [TyConBinder] -> Type -> [Role] -> TyCon
mkPrimTyCon Name
eqPhantPrimTyConName [TyConBinder]
binders Type
res_kind [Role]
roles
  where
    -- Kind :: forall k1 k2. k1 -> k2 -> Void#
    binders :: [TyConBinder]
binders  = [Type] -> ([Type] -> [Type]) -> [TyConBinder]
mkTemplateTyConBinders [Type
liftedTypeKind, Type
liftedTypeKind] [Type] -> [Type]
forall a. a -> a
id
    res_kind :: Type
res_kind = [Type] -> Type
unboxedTupleKind []
    roles :: [Role]
roles    = [Role
Nominal, Role
Nominal, Role
Phantom, Role
Phantom]

{- *********************************************************************
*                                                                      *
             The primitive array types
*                                                                      *
********************************************************************* -}

arrayPrimTyCon, mutableArrayPrimTyCon, mutableByteArrayPrimTyCon,
    byteArrayPrimTyCon, arrayArrayPrimTyCon, mutableArrayArrayPrimTyCon,
    smallArrayPrimTyCon, smallMutableArrayPrimTyCon :: TyCon
arrayPrimTyCon :: TyCon
arrayPrimTyCon             = Name -> [Role] -> PrimRep -> TyCon
pcPrimTyCon Name
arrayPrimTyConName             [Role
Representational] PrimRep
UnliftedRep
mutableArrayPrimTyCon :: TyCon
mutableArrayPrimTyCon      = Name -> [Role] -> PrimRep -> TyCon
pcPrimTyCon  Name
mutableArrayPrimTyConName     [Role
Nominal, Role
Representational] PrimRep
UnliftedRep
mutableByteArrayPrimTyCon :: TyCon
mutableByteArrayPrimTyCon  = Name -> [Role] -> PrimRep -> TyCon
pcPrimTyCon Name
mutableByteArrayPrimTyConName  [Role
Nominal] PrimRep
UnliftedRep
byteArrayPrimTyCon :: TyCon
byteArrayPrimTyCon         = Name -> PrimRep -> TyCon
pcPrimTyCon0 Name
byteArrayPrimTyConName        PrimRep
UnliftedRep
arrayArrayPrimTyCon :: TyCon
arrayArrayPrimTyCon        = Name -> PrimRep -> TyCon
pcPrimTyCon0 Name
arrayArrayPrimTyConName       PrimRep
UnliftedRep
mutableArrayArrayPrimTyCon :: TyCon
mutableArrayArrayPrimTyCon = Name -> [Role] -> PrimRep -> TyCon
pcPrimTyCon Name
mutableArrayArrayPrimTyConName [Role
Nominal] PrimRep
UnliftedRep
smallArrayPrimTyCon :: TyCon
smallArrayPrimTyCon        = Name -> [Role] -> PrimRep -> TyCon
pcPrimTyCon Name
smallArrayPrimTyConName        [Role
Representational] PrimRep
UnliftedRep
smallMutableArrayPrimTyCon :: TyCon
smallMutableArrayPrimTyCon = Name -> [Role] -> PrimRep -> TyCon
pcPrimTyCon Name
smallMutableArrayPrimTyConName [Role
Nominal, Role
Representational] PrimRep
UnliftedRep

mkArrayPrimTy :: Type -> Type
mkArrayPrimTy :: Type -> Type
mkArrayPrimTy elt :: Type
elt           = TyCon -> [Type] -> Type
TyConApp TyCon
arrayPrimTyCon [Type
elt]
byteArrayPrimTy :: Type
byteArrayPrimTy :: Type
byteArrayPrimTy             = TyCon -> Type
mkTyConTy TyCon
byteArrayPrimTyCon
mkArrayArrayPrimTy :: Type
mkArrayArrayPrimTy :: Type
mkArrayArrayPrimTy = TyCon -> Type
mkTyConTy TyCon
arrayArrayPrimTyCon
mkSmallArrayPrimTy :: Type -> Type
mkSmallArrayPrimTy :: Type -> Type
mkSmallArrayPrimTy elt :: Type
elt = TyCon -> [Type] -> Type
TyConApp TyCon
smallArrayPrimTyCon [Type
elt]
mkMutableArrayPrimTy :: Type -> Type -> Type
mkMutableArrayPrimTy :: Type -> Type -> Type
mkMutableArrayPrimTy s :: Type
s elt :: Type
elt  = TyCon -> [Type] -> Type
TyConApp TyCon
mutableArrayPrimTyCon [Type
s, Type
elt]
mkMutableByteArrayPrimTy :: Type -> Type
mkMutableByteArrayPrimTy :: Type -> Type
mkMutableByteArrayPrimTy s :: Type
s  = TyCon -> [Type] -> Type
TyConApp TyCon
mutableByteArrayPrimTyCon [Type
s]
mkMutableArrayArrayPrimTy :: Type -> Type
mkMutableArrayArrayPrimTy :: Type -> Type
mkMutableArrayArrayPrimTy s :: Type
s = TyCon -> [Type] -> Type
TyConApp TyCon
mutableArrayArrayPrimTyCon [Type
s]
mkSmallMutableArrayPrimTy :: Type -> Type -> Type
mkSmallMutableArrayPrimTy :: Type -> Type -> Type
mkSmallMutableArrayPrimTy s :: Type
s elt :: Type
elt = TyCon -> [Type] -> Type
TyConApp TyCon
smallMutableArrayPrimTyCon [Type
s, Type
elt]


{- *********************************************************************
*                                                                      *
                The mutable variable type
*                                                                      *
********************************************************************* -}

mutVarPrimTyCon :: TyCon
mutVarPrimTyCon :: TyCon
mutVarPrimTyCon = Name -> [Role] -> PrimRep -> TyCon
pcPrimTyCon Name
mutVarPrimTyConName [Role
Nominal, Role
Representational] PrimRep
UnliftedRep

mkMutVarPrimTy :: Type -> Type -> Type
mkMutVarPrimTy :: Type -> Type -> Type
mkMutVarPrimTy s :: Type
s elt :: Type
elt        = TyCon -> [Type] -> Type
TyConApp TyCon
mutVarPrimTyCon [Type
s, Type
elt]

{-
************************************************************************
*                                                                      *
\subsection[TysPrim-synch-var]{The synchronizing variable type}
*                                                                      *
************************************************************************
-}

mVarPrimTyCon :: TyCon
mVarPrimTyCon :: TyCon
mVarPrimTyCon = Name -> [Role] -> PrimRep -> TyCon
pcPrimTyCon Name
mVarPrimTyConName [Role
Nominal, Role
Representational] PrimRep
UnliftedRep

mkMVarPrimTy :: Type -> Type -> Type
mkMVarPrimTy :: Type -> Type -> Type
mkMVarPrimTy s :: Type
s elt :: Type
elt          = TyCon -> [Type] -> Type
TyConApp TyCon
mVarPrimTyCon [Type
s, Type
elt]

{-
************************************************************************
*                                                                      *
\subsection[TysPrim-stm-var]{The transactional variable type}
*                                                                      *
************************************************************************
-}

tVarPrimTyCon :: TyCon
tVarPrimTyCon :: TyCon
tVarPrimTyCon = Name -> [Role] -> PrimRep -> TyCon
pcPrimTyCon Name
tVarPrimTyConName [Role
Nominal, Role
Representational] PrimRep
UnliftedRep

mkTVarPrimTy :: Type -> Type -> Type
mkTVarPrimTy :: Type -> Type -> Type
mkTVarPrimTy s :: Type
s elt :: Type
elt = TyCon -> [Type] -> Type
TyConApp TyCon
tVarPrimTyCon [Type
s, Type
elt]

{-
************************************************************************
*                                                                      *
\subsection[TysPrim-stable-ptrs]{The stable-pointer type}
*                                                                      *
************************************************************************
-}

stablePtrPrimTyCon :: TyCon
stablePtrPrimTyCon :: TyCon
stablePtrPrimTyCon = Name -> [Role] -> PrimRep -> TyCon
pcPrimTyCon Name
stablePtrPrimTyConName [Role
Representational] PrimRep
AddrRep

mkStablePtrPrimTy :: Type -> Type
mkStablePtrPrimTy :: Type -> Type
mkStablePtrPrimTy ty :: Type
ty = TyCon -> [Type] -> Type
TyConApp TyCon
stablePtrPrimTyCon [Type
ty]

{-
************************************************************************
*                                                                      *
\subsection[TysPrim-stable-names]{The stable-name type}
*                                                                      *
************************************************************************
-}

stableNamePrimTyCon :: TyCon
stableNamePrimTyCon :: TyCon
stableNamePrimTyCon = Name -> [Role] -> PrimRep -> TyCon
pcPrimTyCon Name
stableNamePrimTyConName [Role
Phantom] PrimRep
UnliftedRep

mkStableNamePrimTy :: Type -> Type
mkStableNamePrimTy :: Type -> Type
mkStableNamePrimTy ty :: Type
ty = TyCon -> [Type] -> Type
TyConApp TyCon
stableNamePrimTyCon [Type
ty]

{-
************************************************************************
*                                                                      *
\subsection[TysPrim-compact-nfdata]{The Compact NFData (CNF) type}
*                                                                      *
************************************************************************
-}

compactPrimTyCon :: TyCon
compactPrimTyCon :: TyCon
compactPrimTyCon = Name -> PrimRep -> TyCon
pcPrimTyCon0 Name
compactPrimTyConName PrimRep
UnliftedRep

compactPrimTy :: Type
compactPrimTy :: Type
compactPrimTy = TyCon -> Type
mkTyConTy TyCon
compactPrimTyCon

{-
************************************************************************
*                                                                      *
\subsection[TysPrim-BCOs]{The ``bytecode object'' type}
*                                                                      *
************************************************************************
-}

bcoPrimTy    :: Type
bcoPrimTy :: Type
bcoPrimTy    = TyCon -> Type
mkTyConTy TyCon
bcoPrimTyCon
bcoPrimTyCon :: TyCon
bcoPrimTyCon :: TyCon
bcoPrimTyCon = Name -> PrimRep -> TyCon
pcPrimTyCon0 Name
bcoPrimTyConName PrimRep
UnliftedRep

{-
************************************************************************
*                                                                      *
\subsection[TysPrim-Weak]{The ``weak pointer'' type}
*                                                                      *
************************************************************************
-}

weakPrimTyCon :: TyCon
weakPrimTyCon :: TyCon
weakPrimTyCon = Name -> [Role] -> PrimRep -> TyCon
pcPrimTyCon Name
weakPrimTyConName [Role
Representational] PrimRep
UnliftedRep

mkWeakPrimTy :: Type -> Type
mkWeakPrimTy :: Type -> Type
mkWeakPrimTy v :: Type
v = TyCon -> [Type] -> Type
TyConApp TyCon
weakPrimTyCon [Type
v]

{-
************************************************************************
*                                                                      *
\subsection[TysPrim-thread-ids]{The ``thread id'' type}
*                                                                      *
************************************************************************

A thread id is represented by a pointer to the TSO itself, to ensure
that they are always unique and we can always find the TSO for a given
thread id.  However, this has the unfortunate consequence that a
ThreadId# for a given thread is treated as a root by the garbage
collector and can keep TSOs around for too long.

Hence the programmer API for thread manipulation uses a weak pointer
to the thread id internally.
-}

threadIdPrimTy :: Type
threadIdPrimTy :: Type
threadIdPrimTy    = TyCon -> Type
mkTyConTy TyCon
threadIdPrimTyCon
threadIdPrimTyCon :: TyCon
threadIdPrimTyCon :: TyCon
threadIdPrimTyCon = Name -> PrimRep -> TyCon
pcPrimTyCon0 Name
threadIdPrimTyConName PrimRep
UnliftedRep

{-
************************************************************************
*                                                                      *
\subsection{SIMD vector types}
*                                                                      *
************************************************************************
-}

#include "primop-vector-tys.hs-incl"