ghc-7.0.1: The GHC API

Type

Contents

Description

Main functions for manipulating types and type-related things

Synopsis

Main data types representing Types

Types are one of:

Unboxed
Iff its representation is other than a pointer Unboxed types are also unlifted.
Lifted
Iff it has bottom as an element. Closures always have lifted types: i.e. any let-bound identifier in Core must have a lifted type. Operationally, a lifted object is one that can be entered. Only lifted types may be unified with a type variable.
Algebraic
Iff it is a type with one or more constructors, whether declared with data or newtype. An algebraic type is one that can be deconstructed with a case expression. This is not the same as lifted types, because we also include unboxed tuples in this classification.
Data
Iff it is a type declared with data, or a boxed tuple.
Primitive
Iff it is a built-in type that can't be expressed in Haskell.

Currently, all primitive types are unlifted, but that's not necessarily the case: for example, Int could be primitive.

Some primitive types are unboxed, such as Int#, whereas some are boxed but unlifted (such as ByteArray#). The only primitive types that we classify as algebraic are the unboxed tuples.

Some examples of type classifications that may make this a bit clearer are:

 Type         primitive       boxed           lifted          algebraic
 -----------------------------------------------------------------------------
 Int#         Yes             No              No              No
 ByteArray#   Yes             Yes             No              No
 (# a, b #)   Yes             No              No              Yes
 (  a, b  )   No              Yes             Yes             Yes
 [a]          No              Yes             Yes             Yes

A source type is a type that is a separate type as far as the type checker is concerned, but which has a more low-level representation as far as Core-to-Core passes and the rest of the back end is concerned. Notably, PredTys are removed from the representation type while they do exist in the source types.

You don't normally have to worry about this, as the utility functions in this module will automatically convert a source into a representation type if they are spotted, to the best of it's abilities. If you don't want this to happen, use the equivalent functions from the TcType module.

data TyThing Source

A typecheckable-thing, essentially anything that has a name

data Type Source

The key representation of types within the compiler

data PredType Source

A type of the form PredTy p represents a value whose type is the Haskell predicate p, where a predicate is what occurs before the => in a Haskell type. It can be expanded into its representation, but:

  • The type checker must treat it as opaque
  • The rest of the compiler treats it as transparent

Consider these examples:

 f :: (Eq a) => a -> Int
 g :: (?x :: Int -> Int) => a -> Int
 h :: (r\l) => {r} => {l::Int | r}

Here the Eq a and ?x :: Int -> Int and rl are all called "predicates"

Constructors

ClassP Class [Type]

Class predicate e.g. Eq a

IParam (IPName Name) Type

Implicit parameter e.g. ?x :: Int

EqPred Type Type

Equality predicate e.g ty1 ~ ty2

type ThetaType = [PredType]Source

A collection of PredTypes

Constructing and deconstructing types

getTyVar :: String -> Type -> TyVarSource

Attempts to obtain the type variable underlying a Type, and panics with the given message if this is not a type variable type. See also getTyVar_maybe

getTyVar_maybe :: Type -> Maybe TyVarSource

Attempts to obtain the type variable underlying a Type

mkAppTy :: Type -> Type -> TypeSource

Applies a type to another, as in e.g. k a

splitAppTy :: Type -> (Type, Type)Source

Attempts to take a type application apart, as in splitAppTy_maybe, and panics if this is not possible

splitAppTys :: Type -> (Type, [Type])Source

Recursively splits a type as far as is possible, leaving a residual type being applied to and the type arguments applied to it. Never fails, even if that means returning an empty list of type applications.

splitAppTy_maybe :: Type -> Maybe (Type, Type)Source

Attempt to take a type application apart, whether it is a function, type constructor, or plain type application. Note that type family applications are NEVER unsaturated by this!

repSplitAppTy_maybe :: Type -> Maybe (Type, Type)Source

Does the AppTy split as in splitAppTy_maybe, but assumes that any Core view stuff is already done

mkFunTy :: Type -> Type -> TypeSource

Creates a function type from the given argument and result type

splitFunTy :: Type -> (Type, Type)Source

Attempts to extract the argument and result types from a type, and panics if that is not possible. See also splitFunTy_maybe

splitFunTy_maybe :: Type -> Maybe (Type, Type)Source

Attempts to extract the argument and result types from a type

splitFunTysN :: Int -> Type -> ([Type], Type)Source

Split off exactly the given number argument types, and panics if that is not possible

funResultTy :: Type -> TypeSource

Extract the function result type and panic if that is not possible

funArgTy :: Type -> TypeSource

Extract the function argument type and panic if that is not possible

zipFunTys :: Outputable a => [a] -> Type -> ([(a, Type)], Type)Source

Splits off argument types from the given type and associating them with the things in the input list from left to right. The final result type is returned, along with the resulting pairs of objects and types, albeit with the list of pairs in reverse order. Panics if there are not enough argument types for the input list.

mkTyConApp :: TyCon -> [Type] -> TypeSource

A key function: builds a TyConApp or FunTy as apppropriate to its arguments. Applies its arguments to the constructor from left to right

mkTyConTy :: TyCon -> TypeSource

Create the plain type constructor type which has been applied to no type arguments at all.

tyConAppTyCon :: Type -> TyConSource

The same as fst . splitTyConApp

tyConAppArgs :: Type -> [Type]Source

The same as snd . splitTyConApp

splitTyConApp_maybe :: Type -> Maybe (TyCon, [Type])Source

Attempts to tease a type apart into a type constructor and the application of a number of arguments to that constructor

splitTyConApp :: Type -> (TyCon, [Type])Source

Attempts to tease a type apart into a type constructor and the application of a number of arguments to that constructor. Panics if that is not possible. See also splitTyConApp_maybe

mkForAllTys :: [TyVar] -> Type -> TypeSource

Wraps foralls over the type using the provided TyVars from left to right

splitForAllTy_maybe :: Type -> Maybe (TyVar, Type)Source

Attempts to take a forall type apart, returning the bound type variable and the remainder of the type

splitForAllTys :: Type -> ([TyVar], Type)Source

Attempts to take a forall type apart, returning all the immediate such bound type variables and the remainder of the type. Always suceeds, even if that means returning an empty list of TyVars

applyTy :: Type -> Type -> TypeSource

Instantiate a forall type with one or more type arguments. Used when we have a polymorphic function applied to type args:

 f t1 t2

We use applyTys type-of-f [t1,t2] to compute the type of the expression. Panics if no application is possible.

applyTys :: Type -> [Type] -> TypeSource

This function is interesting because:

  1. The function may have more for-alls than there are args
  2. Less obviously, it may have fewer for-alls

For case 2. think of:

 applyTys (forall a.a) [forall b.b, Int]

This really can happen, via dressing up polymorphic types with newtype clothing. Here's an example:

 newtype R = R (forall a. a->a)
 foo = case undefined :: R of
            R f -> f ()

dropForAlls :: Type -> TypeSource

Equivalent to snd . splitForAllTys

newTyConInstRhs :: TyCon -> [Type] -> TypeSource

Unwrap one layer of newtype on a type constructor and its arguments, using an eta-reduced version of the newtype if possible

tyFamInsts :: Type -> [(TyCon, [Type])]Source

Finds type family instances occuring in a type after expanding synonyms.

predFamInsts :: PredType -> [(TyCon, [Type])]Source

Finds type family instances occuring in a predicate type after expanding synonyms.

mkFamilyTyConApp :: TyCon -> [Type] -> TypeSource

Given a family instance TyCon and its arg types, return the corresponding family type. E.g:

 data family T a
 data instance T (Maybe b) = MkT b

Where the instance tycon is :RTL, so:

 mkFamilyTyConApp :RTL Int  =  T (Maybe Int)

Common type constructors

Predicates on types

isUnLiftedType :: Type -> BoolSource

See Type for what an unlifted type is

isAlgType :: Type -> BoolSource

See Type for what an algebraic type is. Should only be applied to types, as opposed to e.g. partially saturated type constructors

isClosedAlgType :: Type -> BoolSource

See Type for what an algebraic type is. Should only be applied to types, as opposed to e.g. partially saturated type constructors. Closed type constructors are those with a fixed right hand side, as opposed to e.g. associated types

isPrimitiveType :: Type -> BoolSource

Returns true of types that are opaque to Haskell. Most of these are unlifted, but now that we interact with .NET, we may have primtive (foreign-imported) types that are lifted

isStrictType :: Type -> BoolSource

Computes whether an argument (or let right hand side) should be computed strictly or lazily, based only on its type. Works just like isUnLiftedType, except that it has a special case for dictionaries (i.e. does not work purely on representation types)

isStrictPred :: PredType -> BoolSource

We may be strict in dictionary types, but only if it has more than one component.

(Being strict in a single-component dictionary risks poking the dictionary component, which is wrong.)

Main data types representing Kinds

There's a little subtyping at the kind level:

               ?
              / \
             /   \
            ??   (#)
           /  \
          *    #
 .
 Where:        *    [LiftedTypeKind]   means boxed type
              #    [UnliftedTypeKind] means unboxed type
              (#)  [UbxTupleKind]     means unboxed tuple
              ??   [ArgTypeKind]      is the lub of {*, #}
              ?    [OpenTypeKind]	means any type at all

In particular:

 error :: forall a:?. String -> a
 (->)  :: ?? -> ? -> \*
 (\\(x::t) -> ...)

Where in the last example t :: ?? (i.e. is not an unboxed tuple)

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)

Common Kinds and SuperKinds

unliftedTypeKind :: KindSource

See Type for details of the distinction between these Kinds

tySuperKind :: SuperKindSource

coSuperKind :: SuperKindSource

Common Kind type constructors

Type free variables

tyVarsOfType :: Type -> TyVarSetSource

NB: for type synonyms tyVarsOfType does not expand the synonym

expandTypeSynonyms :: Type -> TypeSource

Expand out all type synonyms. Actually, it'd suffice to expand out just the ones that discard type variables (e.g. type Funny a = Int) But we don't know which those are currently, so we just expand all.

Type comparison

coreEqType :: Type -> Type -> BoolSource

Type equality test for Core types (i.e. ignores predicate-types, synonyms etc.)

tcEqType :: Type -> Type -> BoolSource

Type equality on source types. Does not look through newtypes or PredTypes, but it does look through type synonyms.

tcCmpType :: Type -> Type -> OrderingSource

Type ordering on source types. Does not look through newtypes or PredTypes, but it does look through type synonyms.

tcPartOfType :: Type -> Type -> BoolSource

Checks whether the second argument is a subterm of the first. (We don't care about binders, as we are only interested in syntactic subterms.)

Forcing evaluation of types

seqTypes :: [Type] -> ()Source

Other views onto Types

coreView :: Type -> Maybe TypeSource

In Core, we "look through" non-recursive newtypes and PredTypes: this function tries to obtain a different view of the supplied type given this

Strips off the top layer only of a type to give its underlying representation type. Returns Nothing if there is nothing to look through.

In the case of newtypes, it returns one of:

1) A vanilla TyConApp (recursive newtype, or non-saturated)

2) The newtype representation (otherwise), meaning the type written in the RHS of the newtype declaration, which may itself be a newtype

For example, with:

 newtype R = MkR S
 newtype S = MkS T
 newtype T = MkT (T -> T)

expandNewTcApp on:

  • R gives Just S * S gives Just T * T gives Nothing (no expansion)

tcView :: Type -> Maybe TypeSource

Similar to coreView, but for the type checker, which just looks through synonyms

kindView :: Kind -> Maybe KindSource

Similar to coreView or tcView, but works on Kinds

repType :: Type -> TypeSource

Looks through:

  1. For-alls 2. Synonyms 3. Predicates 4. All newtypes, including recursive ones, but not newtype families

It's useful in the back end of the compiler.

Type representation for the code generator

data PrimRep Source

A PrimRep is an abstraction of a type. It contains information that the code generator needs in order to pass arguments, return results, and store values of this type.

Constructors

VoidRep 
PtrRep 
IntRep

Signed, word-sized value

WordRep

Unsigned, word-sized value

Int64Rep

Signed, 64 bit value (with 32-bit words only)

Word64Rep

Unsigned, 64 bit value (with 32-bit words only)

AddrRep

A pointer, but not to a Haskell value (use PtrRep)

FloatRep 
DoubleRep 

typePrimRep :: Type -> PrimRepSource

Discovers the primitive representation of a more abstract Type

predTypeRep :: PredType -> TypeSource

Convert a PredType to its representation type. However, it unwraps only the outermost level; for example, the result might be a newtype application

Main type substitution data types

type TvSubstEnv = TyVarEnv TypeSource

A substitition of Types for TyVars

data TvSubst Source

Type substitution

The following invariants must hold of a TvSubst:

  1. The in-scope set is needed only to guide the generation of fresh uniques
  2. In particular, the kind of the type variables in the in-scope set is not relevant
  3. The substition is only applied ONCE! This is because in general such application will not reached a fixed point.

Instances

Manipulating type substitutions

mkOpenTvSubst :: TvSubstEnv -> TvSubstSource

Generates the in-scope set for the TvSubst from the types in the incoming environment, hence open

zipOpenTvSubst :: [TyVar] -> [Type] -> TvSubstSource

Generates the in-scope set for the TvSubst from the types in the incoming environment, hence open

mkTopTvSubst :: [(TyVar, Type)] -> TvSubstSource

Called when doing top-level substitutions. Here we expect that the free vars of the range of the substitution will be empty.

composeTvSubst :: InScopeSet -> TvSubstEnv -> TvSubstEnv -> TvSubstEnvSource

(compose env1 env2)(x) is env1(env2(x)); i.e. apply env2 then env1. It assumes that both are idempotent. Typically, env1 is the refinement to a base substitution env2

Performing substitution on types

substTy :: TvSubst -> Type -> TypeSource

Substitute within a Type

substTys :: TvSubst -> [Type] -> [Type]Source

Substitute within several Types

substTyWith :: [TyVar] -> [Type] -> Type -> TypeSource

Type substitution making use of an TvSubst that is assumed to be open, see zipOpenTvSubst

substTysWith :: [TyVar] -> [Type] -> [Type] -> [Type]Source

Type substitution making use of an TvSubst that is assumed to be open, see zipOpenTvSubst

substPred :: TvSubst -> PredType -> PredTypeSource

Substitute within a PredType

deShadowTy :: TyVarSet -> Type -> TypeSource

Remove any nested binders mentioning the TyVars in the TyVarSet

Pretty-printing

pprSourceTyCon :: TyCon -> SDocSource

Pretty prints a TyCon, using the family instance in case of a representation tycon. For example:

 data T [a] = ...

In that case we want to print T [a], where T is the family TyCon