ghc-7.10.1: The GHC API

Safe HaskellNone
LanguageHaskell2010

TyCon

Contents

Synopsis

Main TyCon data types

data TyCon Source

TyCons represent type constructors. Type constructors are introduced by things such as:

1) Data declarations: data Foo = ... creates the Foo type constructor of kind *

2) Type synonyms: type Foo = ... creates the Foo type constructor

3) Newtypes: newtype Foo a = MkFoo ... creates the Foo type constructor of kind * -> *

4) Class declarations: class Foo where creates the Foo type constructor of kind *

This data type also encodes a number of primitive, built in type constructors such as those for function and tuple types.

type FieldLabel = Name Source

Names of the fields in an algebraic record type

data AlgTyConRhs Source

Represents right-hand-sides of TyCons for algebraic types

Constructors

AbstractTyCon Bool

Says that we know nothing about this data type, except that it's represented by a pointer. Used when we export a data type abstractly into an .hi file.

DataFamilyTyCon

Represents an open type family without a fixed right hand side. Additional instances can appear at any time.

These are introduced by either a top level declaration:

data T a :: *

Or an associated data type declaration, within a class declaration:

class C a b where
  data T b :: *
DataTyCon

Information about those TyCons derived from a data declaration. This includes data types with no constructors at all.

Fields

data_cons :: [DataCon]

The data type constructors; can be empty if the user declares the type to have no constructors

INVARIANT: Kept in order of increasing DataCon tag (see the tag assignment in DataCon.mkDataCon)

is_enum :: Bool

Cached value: is this an enumeration type? See Note [Enumeration types]

NewTyCon

Information about those TyCons derived from a newtype declaration

Fields

data_con :: DataCon

The unique constructor for the newtype. It has no existentials

nt_rhs :: Type

Cached value: the argument type of the constructor, which is just the representation type of the TyCon (remember that newtypes do not exist at runtime so need a different representation type).

The free TyVars of this type are the tyConTyVars from the corresponding TyCon

nt_etad_rhs :: ([TyVar], Type)

Same as the nt_rhs, but this time eta-reduced. Hence the list of TyVars in this field may be shorter than the declared arity of the TyCon.

nt_co :: CoAxiom Unbranched
 

visibleDataCons :: AlgTyConRhs -> [DataCon] Source

Both type classes as well as family instances imply implicit type constructors. These implicit type constructors refer to their parent structure (ie, the class or family from which they derive) using a type of the following form. We use TyConParent for both algebraic and synonym types, but the variant ClassTyCon will only be used by algebraic TyCons.

Extract those DataCons that we are able to learn about. Note that visibility in this sense does not correspond to visibility in the context of any particular user program!

data TyConParent Source

Constructors

NoParentTyCon

An ordinary type constructor has no parent.

ClassTyCon Class

Type constructors representing a class dictionary. See Note [ATyCon for classes] in TypeRep

AssocFamilyTyCon Class

An *associated* type of a class.

FamInstTyCon (CoAxiom Unbranched) TyCon [Type]

Type constructors representing an instance of a *data* family. Parameters:

1) The type family in question

2) Instance types; free variables are the tyConTyVars of the current TyCon (not the family one). INVARIANT: the number of types matches the arity of the family TyCon

3) A CoTyCon identifying the representation type with the type instance family

data FamTyConFlav Source

Information pertaining to the expansion of a type synonym (type)

Constructors

OpenSynFamilyTyCon

An open type synonym family e.g. type family F x y :: * -> *

ClosedSynFamilyTyCon (CoAxiom Branched)

A closed type synonym family e.g. type family F x where { F Int = Bool }

AbstractClosedSynFamilyTyCon

A closed type synonym family declared in an hs-boot file with type family F a where ..

BuiltInSynFamTyCon BuiltInSynFamily

Built-in type family used by the TypeNats solver

Constructing TyCons

mkAlgTyCon Source

Arguments

:: Name 
-> Kind

Kind of the resulting TyCon

-> [TyVar]

TyVars scoped over: see tyConTyVars. Arity is inferred from the length of this list

-> [Role]

The roles for each TyVar

-> Maybe CType

The C type this type corresponds to when using the CAPI FFI

-> [PredType]

Stupid theta: see algTcStupidTheta

-> AlgTyConRhs

Information about dat aconstructors

-> TyConParent 
-> RecFlag

Is the TyCon recursive?

-> Bool

Was the TyCon declared with GADT syntax?

-> Maybe TyCon

Promoted version

-> TyCon 

This is the making of an algebraic TyCon. Notably, you have to pass in the generic (in the -XGenerics sense) information about the type constructor - you can get hold of it easily (see Generics module)

mkClassTyCon :: Name -> Kind -> [TyVar] -> [Role] -> AlgTyConRhs -> Class -> RecFlag -> TyCon Source

Simpler specialization of mkAlgTyCon for classes

mkFunTyCon :: Name -> Kind -> TyCon Source

Given the name of the function type constructor and it's kind, create the corresponding TyCon. It is reccomended to use funTyCon if you want this functionality

mkPrimTyCon :: Name -> Kind -> [Role] -> PrimRep -> TyCon Source

Create an unlifted primitive TyCon, such as Int#

mkKindTyCon :: Name -> Kind -> TyCon Source

Kind constructors

mkLiftedPrimTyCon :: Name -> Kind -> [Role] -> PrimRep -> TyCon Source

Create a lifted primitive TyCon such as RealWorld

mkTupleTyCon Source

Arguments

:: Name 
-> Kind

Kind of the resulting TyCon

-> Arity

Arity of the tuple

-> [TyVar]

TyVars scoped over: see tyConTyVars

-> DataCon 
-> TupleSort

Whether the tuple is boxed or unboxed

-> Maybe TyCon

Promoted version

-> TyCon 

mkSynonymTyCon :: Name -> Kind -> [TyVar] -> [Role] -> Type -> TyCon Source

Create a type synonym TyCon

mkFamilyTyCon :: Name -> Kind -> [TyVar] -> FamTyConFlav -> TyConParent -> TyCon Source

Create a type family TyCon

mkPromotedDataCon :: DataCon -> Name -> Unique -> Kind -> [Role] -> TyCon Source

Create a promoted data constructor TyCon Somewhat dodgily, we give it the same Name as the data constructor itself; when we pretty-print the TyCon we add a quote; see the Outputable TyCon instance

mkPromotedTyCon :: TyCon -> Kind -> TyCon Source

Create a promoted type constructor TyCon Somewhat dodgily, we give it the same Name as the type constructor itself

Predicates on TyCons

isAlgTyCon :: TyCon -> Bool Source

Returns True if the supplied TyCon resulted from either a data or newtype declaration

isClassTyCon :: TyCon -> Bool Source

Is this TyCon that for a class instance?

isFamInstTyCon :: TyCon -> Bool Source

Is this TyCon that for a data family instance?

isPrimTyCon :: TyCon -> Bool Source

Does this TyCon represent something that cannot be defined in Haskell?

isTupleTyCon :: TyCon -> Bool Source

Does this TyCon represent a tuple?

NB: when compiling Data.Tuple, the tycons won't reply True to isTupleTyCon, because they are built as AlgTyCons. However they get spat into the interface file as tuple tycons, so I don't think it matters.

isUnboxedTupleTyCon :: TyCon -> Bool Source

Is this the TyCon for an unboxed tuple?

isBoxedTupleTyCon :: TyCon -> Bool Source

Is this the TyCon for a boxed tuple?

isTypeSynonymTyCon :: TyCon -> Bool Source

Is this a TyCon representing a regular H98 type synonym (type)?

isPromotedDataCon :: TyCon -> Bool Source

Is this a PromotedDataCon?

isPromotedTyCon :: TyCon -> Bool Source

Is this a PromotedTyCon?

isPromotedDataCon_maybe :: TyCon -> Maybe DataCon Source

Retrieves the promoted DataCon if this is a PromotedDataCon;

isPromotedTyCon_maybe :: TyCon -> Maybe TyCon Source

Retrieves the promoted TyCon if this is a PromotedTyCon;

isDataTyCon :: TyCon -> Bool Source

Returns True for data types that are definitely represented by heap-allocated constructors. These are scrutinised by Core-level case expressions, and they get info tables allocated for them.

Generally, the function will be true for all data types and false for newtypes, unboxed tuples and type family TyCons. But it is not guaranteed to return True in all cases that it could.

NB: for a data type family, only the instance TyCons get an info table. The family declaration TyCon does not

isEnumerationTyCon :: TyCon -> Bool Source

Is this an algebraic TyCon which is just an enumeration of values?

isNewTyCon :: TyCon -> Bool Source

Is this TyCon that for a newtype

isAbstractTyCon :: TyCon -> Bool Source

Test if the TyCon is algebraic but abstract (invisible data constructors)

isFamilyTyCon :: TyCon -> Bool Source

Is this a TyCon, synonym or otherwise, that defines a family?

isOpenFamilyTyCon :: TyCon -> Bool Source

Is this a TyCon, synonym or otherwise, that defines a family with instances?

isTypeFamilyTyCon :: TyCon -> Bool Source

Is this a synonym TyCon that can have may have further instances appear?

isDataFamilyTyCon :: TyCon -> Bool Source

Is this a synonym TyCon that can have may have further instances appear?

isUnLiftedTyCon :: TyCon -> Bool Source

Is this TyCon unlifted (i.e. cannot contain bottom)? Note that this can only be true for primitive and unboxed-tuple TyCons

isGadtSyntaxTyCon :: TyCon -> Bool Source

Is this an algebraic TyCon declared with the GADT syntax?

isDistinctTyCon :: TyCon -> Bool Source

isDistinctTyCon is true of TyCons that are equal only to themselves, even via coercions (except for unsafeCoerce). This excludes newtypes, type functions, type synonyms. It relates directly to the FC consistency story: If the axioms are consistent, and co : S tys ~ T tys, and S,T are "distinct" TyCons, then S=T. Cf Note [Pruning dead case alternatives] in Unify

isTyConAssoc :: TyCon -> Bool Source

Are we able to extract informationa TyVar to class argument list mappping from a given TyCon?

isRecursiveTyCon :: TyCon -> Bool Source

Is this a recursive TyCon?

isImplicitTyCon :: TyCon -> Bool Source

Identifies implicit tycons that, in particular, do not go into interface files (because they are implicitly reconstructed when the interface is read).

Note that:

  • Associated families are implicit, as they are re-constructed from the class declaration in which they reside, and
  • Family instances are not implicit as they represent the instance body (similar to a dfun does that for a class instance).

Extracting information out of TyCons

tyConName :: TyCon -> Name Source

Name of the constructor

tyConKind :: TyCon -> Kind Source

Kind of this TyCon (full kind, not just the return kind)

tyConUnique :: TyCon -> Unique Source

A Unique of this TyCon. Invariant: identical to Unique of Name stored in tyConName field.

tyConTyVars :: TyCon -> [TyVar] Source

The kind and type variables used in the type constructor. Invariant: length tyvars = arity Precisely, this list scopes over:

  1. The algTcStupidTheta
  2. The cached types in algTyConRhs.NewTyCon
  3. The family instance types if present

Note that it does not scope over the data constructors.

tyConCType :: TyCon -> Maybe CType Source

The C type that should be used for this type when using the FFI and CAPI

tyConDataCons :: TyCon -> [DataCon] Source

As tyConDataCons_maybe, but returns the empty list of constructors if no constructors could be found

tyConDataCons_maybe :: TyCon -> Maybe [DataCon] Source

Determine the DataCons originating from the given TyCon, if the TyCon is the sort that can have any constructors (note: this does not include abstract algebraic types)

tyConSingleDataCon_maybe :: TyCon -> Maybe DataCon Source

If the given TyCon has a single data constructor, i.e. it is a data type with one alternative, a tuple type or a newtype then that constructor is returned. If the TyCon has more than one constructor, or represents a primitive or function type constructor then Nothing is returned. In any other case, the function panics

tyConFamilySize :: TyCon -> Int Source

Determine the number of value constructors a TyCon has. Panics if the TyCon is not algebraic or a tuple

tyConStupidTheta :: TyCon -> [PredType] Source

Find the "stupid theta" of the TyCon. A "stupid theta" is the context to the left of an algebraic type declaration, e.g. Eq a in the declaration data Eq a => T a ...

tyConArity :: TyCon -> Arity Source

Number of arguments this TyCon must receive to be considered saturated (including implicit kind variables)

tyConRoles :: TyCon -> [Role] Source

Get the list of roles for the type parameters of a TyCon

tyConClass_maybe :: TyCon -> Maybe Class Source

If this TyCon is that for a class instance, return the class it is for. Otherwise returns Nothing

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

If this TyCon is that of a family instance, return the family in question and the instance types. Otherwise, return Nothing

tyConFamilyCoercion_maybe :: TyCon -> Maybe (CoAxiom Unbranched) Source

If this TyCon is that of a family instance, return a TyCon which represents a coercion identifying the representation type with the type instance family. Otherwise, return Nothing

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

Extract the TyVars bound by a vanilla type synonym and the corresponding (unsubstituted) right hand side.

synTyConRhs_maybe :: TyCon -> Maybe Type Source

Extract the information pertaining to the right hand side of a type synonym (type) declaration.

famTyConFlav_maybe :: TyCon -> Maybe FamTyConFlav Source

Extract the flavour of a type family (with all the extra information that it carries)

algTyConRhs :: TyCon -> AlgTyConRhs Source

Extract an AlgTyConRhs with information about data constructors from an algebraic or tuple TyCon. Panics for any other sort of TyCon

newTyConRhs :: TyCon -> ([TyVar], Type) Source

Extract the bound type variables and type expansion of a type synonym TyCon. Panics if the TyCon is not a synonym

newTyConEtadArity :: TyCon -> Int Source

The number of type parameters that need to be passed to a newtype to resolve it. May be less than in the definition if it can be eta-contracted.

newTyConEtadRhs :: TyCon -> ([TyVar], Type) Source

Extract the bound type variables and type expansion of an eta-contracted type synonym TyCon. Panics if the TyCon is not a synonym

unwrapNewTyCon_maybe :: TyCon -> Maybe ([TyVar], Type, CoAxiom Unbranched) Source

Take a TyCon apart into the TyVars it scopes over, the Type it expands into, and (possibly) a coercion from the representation type to the newtype. Returns Nothing if this is not possible.

tupleTyConBoxity :: TyCon -> Boxity Source

Extract the boxity of the given TyCon, if it is a TupleTyCon. Panics otherwise

tupleTyConSort :: TyCon -> TupleSort Source

Extract the TupleSort of the given TyCon, if it is a TupleTyCon. Panics otherwise

tupleTyConArity :: TyCon -> Arity Source

Extract the arity of the given TyCon, if it is a TupleTyCon. Panics otherwise

Manipulating TyCons

tcExpandTyCon_maybe Source

Arguments

:: TyCon 
-> [tyco]

Arguments to TyCon

-> Maybe ([(TyVar, tyco)], Type, [tyco])

Returns a TyVar substitution, the body type of the synonym (not yet substituted) and any arguments remaining from the application

Used to create the view Core has on TyCons. We expand not only closed synonyms like tcExpandTyCon_maybe, but also non-recursive newtypes

Used to create the view the typechecker has on TyCons. We expand (closed) synonyms only, cf. coreExpandTyCon_maybe

coreExpandTyCon_maybe Source

Arguments

:: TyCon 
-> [tyco]

Arguments to TyCon

-> Maybe ([(TyVar, tyco)], Type, [tyco])

Returns a TyVar substitution, the body type of the synonym (not yet substituted) and any arguments remaining from the application

Used to create the view the typechecker has on TyCons. We expand (closed) synonyms only, cf. coreExpandTyCon_maybe

makeTyConAbstract :: TyCon -> TyCon Source

Make an algebraic TyCon abstract. Panics if the supplied TyCon is not algebraic

newTyConCo_maybe :: TyCon -> Maybe (CoAxiom Unbranched) Source

Extracts the newtype coercion from such a TyCon, which can be used to construct something with the newtypes type from its representation type (right hand side). If the supplied TyCon is not a newtype, returns Nothing

Primitive representations of Types

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 
VecRep Int PrimElemRep

A vector

tyConPrimRep :: TyCon -> PrimRep Source

Find the primitive representation of a TyCon

primRepSizeW :: DynFlags -> PrimRep -> Int Source

Find the size of a PrimRep, in words

Recursion breaking