| |||||||||||||||||||||||

| |||||||||||||||||||||||

| |||||||||||||||||||||||

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, Some primitive types are unboxed, such as 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 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. | |||||||||||||||||||||||

| |||||||||||||||||||||||

| |||||||||||||||||||||||

| |||||||||||||||||||||||

| |||||||||||||||||||||||

| |||||||||||||||||||||||

| |||||||||||||||||||||||

| |||||||||||||||||||||||

A collection of PredTypes
| |||||||||||||||||||||||

Constructing and deconstructing types | |||||||||||||||||||||||

| |||||||||||||||||||||||

| |||||||||||||||||||||||

| |||||||||||||||||||||||

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
| |||||||||||||||||||||||

| |||||||||||||||||||||||

Attempts to obtain the type variable underlying a Type
| |||||||||||||||||||||||

| |||||||||||||||||||||||

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

| |||||||||||||||||||||||

| |||||||||||||||||||||||

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

| |||||||||||||||||||||||

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. | |||||||||||||||||||||||

| |||||||||||||||||||||||

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! | |||||||||||||||||||||||

| |||||||||||||||||||||||

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

| |||||||||||||||||||||||

Creates a function type from the given argument and result type | |||||||||||||||||||||||

| |||||||||||||||||||||||

| |||||||||||||||||||||||

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

| |||||||||||||||||||||||

Attempts to extract the argument and result types from a type | |||||||||||||||||||||||

| |||||||||||||||||||||||

| |||||||||||||||||||||||

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

| |||||||||||||||||||||||

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

| |||||||||||||||||||||||

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

| |||||||||||||||||||||||

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. | |||||||||||||||||||||||

| |||||||||||||||||||||||

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

| |||||||||||||||||||||||

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

| |||||||||||||||||||||||

The same as fst . splitTyConApp
| |||||||||||||||||||||||

| |||||||||||||||||||||||

The same as snd . splitTyConApp
| |||||||||||||||||||||||

| |||||||||||||||||||||||

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

| |||||||||||||||||||||||

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
| |||||||||||||||||||||||

| |||||||||||||||||||||||

| |||||||||||||||||||||||

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

| |||||||||||||||||||||||

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

| |||||||||||||||||||||||

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
| |||||||||||||||||||||||

| |||||||||||||||||||||||

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 | |||||||||||||||||||||||

| |||||||||||||||||||||||

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 () | |||||||||||||||||||||||

| |||||||||||||||||||||||

| |||||||||||||||||||||||

| |||||||||||||||||||||||

Equivalent to snd . splitForAllTys
| |||||||||||||||||||||||

| |||||||||||||||||||||||

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

| |||||||||||||||||||||||

| |||||||||||||||||||||||

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

| |||||||||||||||||||||||

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

| |||||||||||||||||||||||

| |||||||||||||||||||||||

| |||||||||||||||||||||||

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 | |||||||||||||||||||||||

| |||||||||||||||||||||||

| |||||||||||||||||||||||

| |||||||||||||||||||||||

See Type for what an unlifted type is | |||||||||||||||||||||||

| |||||||||||||||||||||||

| |||||||||||||||||||||||

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

| |||||||||||||||||||||||

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
| |||||||||||||||||||||||

| |||||||||||||||||||||||

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 | |||||||||||||||||||||||

| |||||||||||||||||||||||

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)
| |||||||||||||||||||||||

| |||||||||||||||||||||||

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 | |||||||||||||||||||||||

| |||||||||||||||||||||||

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) | |||||||||||||||||||||||

| |||||||||||||||||||||||

| |||||||||||||||||||||||

Deconstructing Kinds | |||||||||||||||||||||||

| |||||||||||||||||||||||

Essentially funResultTy on kinds
| |||||||||||||||||||||||

| |||||||||||||||||||||||

Essentially splitFunTys on kinds
| |||||||||||||||||||||||

| |||||||||||||||||||||||

Essentially splitFunTysN on kinds
| |||||||||||||||||||||||

Common Kinds and SuperKinds | |||||||||||||||||||||||

| |||||||||||||||||||||||

| |||||||||||||||||||||||

See Type for details of the distinction between these Kinds
| |||||||||||||||||||||||

| |||||||||||||||||||||||

| |||||||||||||||||||||||

| |||||||||||||||||||||||

| |||||||||||||||||||||||

| |||||||||||||||||||||||

Common Kind type constructors | |||||||||||||||||||||||

| |||||||||||||||||||||||

| |||||||||||||||||||||||

| |||||||||||||||||||||||

| |||||||||||||||||||||||

| |||||||||||||||||||||||

Predicates on Kinds | |||||||||||||||||||||||

| |||||||||||||||||||||||

| |||||||||||||||||||||||

| |||||||||||||||||||||||

See Type for details of the distinction between these Kinds
| |||||||||||||||||||||||

| |||||||||||||||||||||||

| |||||||||||||||||||||||

| |||||||||||||||||||||||

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

| |||||||||||||||||||||||

| |||||||||||||||||||||||

| |||||||||||||||||||||||

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

| |||||||||||||||||||||||

| |||||||||||||||||||||||

| |||||||||||||||||||||||

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

| |||||||||||||||||||||||

Iterated application of mkArrowKind
| |||||||||||||||||||||||

| |||||||||||||||||||||||

True of any sub-kind of ArgTypeKind | |||||||||||||||||||||||

| |||||||||||||||||||||||

True of any sub-kind of OpenTypeKind (i.e. anything except arrow) | |||||||||||||||||||||||

| |||||||||||||||||||||||

k1 `isSubKind` k2 checks that k1 <: k2
| |||||||||||||||||||||||

| |||||||||||||||||||||||

Used when generalising: default kind ? and ?? to *. See Type for more information on what that means | |||||||||||||||||||||||

| |||||||||||||||||||||||

| |||||||||||||||||||||||

kc1 `isSubKindCon` kc2 checks that kc1 <: kc2
| |||||||||||||||||||||||

Type free variables | |||||||||||||||||||||||

| |||||||||||||||||||||||

NB: for type synonyms tyVarsOfType does not expand the synonym
| |||||||||||||||||||||||

| |||||||||||||||||||||||

| |||||||||||||||||||||||

| |||||||||||||||||||||||

| |||||||||||||||||||||||

| |||||||||||||||||||||||

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. | |||||||||||||||||||||||

Tidying type related things up for printing | |||||||||||||||||||||||

| |||||||||||||||||||||||

| |||||||||||||||||||||||

| |||||||||||||||||||||||

Grabs the free type variables, tidies them
and then uses tidyType to work over the type itself
| |||||||||||||||||||||||

| |||||||||||||||||||||||

| |||||||||||||||||||||||

This tidies up a type for printing in an error message, or in an interface file. It doesn't change the uniques at all, just the print names. | |||||||||||||||||||||||

| |||||||||||||||||||||||

Add the free TyVars to the env in tidy form,
so that we can tidy the type they are free in
| |||||||||||||||||||||||

| |||||||||||||||||||||||

Treat a new TyVar as a binder, and give it a fresh tidy name
using the environment if one has not already been allocated. See
also tidyTyVarBndr
| |||||||||||||||||||||||

| |||||||||||||||||||||||

| |||||||||||||||||||||||

Calls tidyType on a top-level type (i.e. with an empty tidying environment)
| |||||||||||||||||||||||

| |||||||||||||||||||||||

| |||||||||||||||||||||||

Type comparison | |||||||||||||||||||||||

| |||||||||||||||||||||||

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

| |||||||||||||||||||||||

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

| |||||||||||||||||||||||

| |||||||||||||||||||||||

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

| |||||||||||||||||||||||

| |||||||||||||||||||||||

| |||||||||||||||||||||||

| |||||||||||||||||||||||

| |||||||||||||||||||||||

| |||||||||||||||||||||||

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 | |||||||||||||||||||||||

| |||||||||||||||||||||||

| |||||||||||||||||||||||

Other views onto Types | |||||||||||||||||||||||

| |||||||||||||||||||||||

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 In the case of 1) A vanilla 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)
| |||||||||||||||||||||||

| |||||||||||||||||||||||

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

| |||||||||||||||||||||||

Similar to coreView or tcView, but works on Kinds
| |||||||||||||||||||||||

| |||||||||||||||||||||||

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 | |||||||||||||||||||||||

| |||||||||||||||||||||||

| |||||||||||||||||||||||

| |||||||||||||||||||||||

Discovers the primitive representation of a more abstract Type
| |||||||||||||||||||||||

| |||||||||||||||||||||||

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 | |||||||||||||||||||||||

| |||||||||||||||||||||||

A substitition of Types for TyVars
| |||||||||||||||||||||||

| |||||||||||||||||||||||

| |||||||||||||||||||||||

Manipulating type substitutions | |||||||||||||||||||||||

| |||||||||||||||||||||||

| |||||||||||||||||||||||

| |||||||||||||||||||||||

| |||||||||||||||||||||||

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

| |||||||||||||||||||||||

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

| |||||||||||||||||||||||

| |||||||||||||||||||||||

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

| |||||||||||||||||||||||

| |||||||||||||||||||||||

| |||||||||||||||||||||||

| |||||||||||||||||||||||

| |||||||||||||||||||||||

| |||||||||||||||||||||||

| |||||||||||||||||||||||

| |||||||||||||||||||||||

| |||||||||||||||||||||||

(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 | |||||||||||||||||||||||

| |||||||||||||||||||||||

Substitute within a Type
| |||||||||||||||||||||||

| |||||||||||||||||||||||

Substitute within several Types
| |||||||||||||||||||||||

| |||||||||||||||||||||||

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

| |||||||||||||||||||||||

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

| |||||||||||||||||||||||

Substitute within a ThetaType
| |||||||||||||||||||||||

| |||||||||||||||||||||||

Substitute within a PredType
| |||||||||||||||||||||||

| |||||||||||||||||||||||

| |||||||||||||||||||||||

| |||||||||||||||||||||||

| |||||||||||||||||||||||

Remove any nested binders mentioning the TyVars in the TyVarSet
| |||||||||||||||||||||||

| |||||||||||||||||||||||

Pretty-printing | |||||||||||||||||||||||

| |||||||||||||||||||||||

| |||||||||||||||||||||||

| |||||||||||||||||||||||

| |||||||||||||||||||||||

| |||||||||||||||||||||||

| |||||||||||||||||||||||

| |||||||||||||||||||||||

| |||||||||||||||||||||||

| |||||||||||||||||||||||

| |||||||||||||||||||||||

| |||||||||||||||||||||||

| |||||||||||||||||||||||

| |||||||||||||||||||||||

Pretty prints a data T [a] = ... In that case we want to print | |||||||||||||||||||||||

Produced by Haddock version 2.6.1 |