ghc-7.8.20140130: The GHC API

Safe HaskellNone
LanguageHaskell98

Kind

Contents

Synopsis

Main data type

type SuperKind = TypeSource

"Super kinds", used to help encode Kinds as types. Invariant: a super kind is always of this form:

 TyConApp SuperKindTyCon ...

type Kind = TypeSource

The key type representing kinds in the compiler. Invariant: a kind is always in one of these forms:

 FunTy k1 k2
 TyConApp PrimTyCon [...]
 TyVar kv   -- (during inference only)
 ForAll ... -- (for top-level coercions)

anyKind :: KindSource

See "Type#kind_subtyping" for details of the distinction between these Kinds

liftedTypeKind :: KindSource

See "Type#kind_subtyping" for details of the distinction between these Kinds

unliftedTypeKind :: KindSource

See "Type#kind_subtyping" for details of the distinction between these Kinds

openTypeKind :: KindSource

See "Type#kind_subtyping" for details of the distinction between these Kinds

constraintKind :: KindSource

See "Type#kind_subtyping" for details of the distinction between these Kinds

mkArrowKind :: Kind -> Kind -> KindSource

Given two kinds k1 and k2, creates the Kind k1 -> k2

mkArrowKinds :: [Kind] -> Kind -> KindSource

Iterated application of mkArrowKind

anyKindTyCon :: TyConSource

See "Type#kind_subtyping" for details of the distinction between the Kind TyCons

liftedTypeKindTyCon :: TyConSource

See "Type#kind_subtyping" for details of the distinction between the Kind TyCons

openTypeKindTyCon :: TyConSource

See "Type#kind_subtyping" for details of the distinction between the Kind TyCons

unliftedTypeKindTyCon :: TyConSource

See "Type#kind_subtyping" for details of the distinction between the Kind TyCons

constraintKindTyCon :: TyConSource

See "Type#kind_subtyping" for details of the distinction between the Kind TyCons

superKind :: KindSource

See "Type#kind_subtyping" for details of the distinction between these Kinds

superKindTyCon :: TyConSource

See "Type#kind_subtyping" for details of the distinction between the Kind TyCons

Deconstructing Kinds

synTyConResKind :: TyCon -> KindSource

Find the result Kind of a type synonym, after applying it to its arity number of type variables Actually this function works fine on data types too, but they'd always return *, so we never need to ask

splitKindFunTys :: Kind -> ([Kind], Kind)Source

Essentially splitFunTys on kinds

splitKindFunTysN :: Int -> Kind -> ([Kind], Kind)Source

Essentially splitFunTysN on kinds

Predicates on Kinds

isUnliftedTypeKind :: Kind -> BoolSource

See "Type#kind_subtyping" for details of the distinction between these Kinds

isOpenTypeKind :: Kind -> BoolSource

See "Type#kind_subtyping" for details of the distinction between these Kinds

isConstraintKind :: Kind -> BoolSource

See "Type#kind_subtyping" for details of the distinction between these Kinds

isConstraintOrLiftedKind :: Kind -> BoolSource

See "Type#kind_subtyping" for details of the distinction between these Kinds

isKind :: Kind -> BoolSource

Is this a kind (i.e. a type-of-types)?

isSuperKind :: Type -> BoolSource

Is this a super-kind (i.e. a type-of-kinds)?

isAnyKind :: Kind -> BoolSource

See "Type#kind_subtyping" for details of the distinction between these Kinds

isSubOpenTypeKind :: Kind -> BoolSource

True of any sub-kind of OpenTypeKind

isSubKind :: Kind -> Kind -> BoolSource

k1 `isSubKind` k2 checks that k1 <: k2 Sub-kinding is extremely simple and does not look under arrrows or type constructors

isSubKindCon :: TyCon -> TyCon -> BoolSource

kc1 `isSubKindCon` kc2 checks that kc1 <: kc2

defaultKind_maybe :: Kind -> Maybe KindSource

Used when generalising: default OpenKind and ArgKind to *. See "Type#kind_subtyping" for more information on what that means

Functions on variables