Clash.Core.TyCon

Type Constructors in CoreHW

Documentation

data TyCon

Type Constructor

Constructors

AlgTyCon

Algorithmic DataCons

Fields

• tyConUniq :: !Unique
• tyConName :: !TyConName

  Name of the TyCon

• tyConKind :: !Kind

  Kind of the TyCon

• tyConArity :: !Int

  Number of type arguments

• algTcRhs :: !AlgTyConRhs

  DataCon definitions

• isClassTc :: !Bool

  Is this a class dictionary?

FunTyCon

Function TyCons (e.g. type families)

Fields

• tyConUniq :: !Unique
• tyConName :: !TyConName

  Name of the TyCon

• tyConKind :: !Kind

  Kind of the TyCon

• tyConArity :: !Int

  Number of type arguments

• tyConSubst :: [([Type], Type)]

  List of: ([LHS match types], RHS type)

PrimTyCon

Primitive TyCons

Fields

• tyConUniq :: !Unique
• tyConName :: !TyConName

  Name of the TyCon

• tyConKind :: !Kind

  Kind of the TyCon

• tyConArity :: !Int

  Number of type arguments

SuperKindTyCon

To close the loop on the type hierarchy

Fields

• tyConUniq :: !Unique
• tyConName :: !TyConName

  Name of the TyCon

Instances

Eq TyCon

Defined in Clash.Core.TyCon

Methods

(==) :: TyCon -> TyCon -> Bool

(/=) :: TyCon -> TyCon -> Bool

Show TyCon

Defined in Clash.Core.TyCon

Methods

showsPrec :: Int -> TyCon -> ShowS

show :: TyCon -> String

showList :: [TyCon] -> ShowS

Generic TyCon

Defined in Clash.Core.TyCon

Associated Types

type Rep TyCon :: Type -> Type

Methods

from :: TyCon -> Rep TyCon x

to :: Rep TyCon x -> TyCon

Binary TyCon

Defined in Clash.Core.TyCon

Methods

put :: TyCon -> Put

get :: Get TyCon

putList :: [TyCon] -> Put

NFData TyCon

Defined in Clash.Core.TyCon

Methods

rnf :: TyCon -> ()

Uniquable TyCon

Defined in Clash.Core.TyCon

Methods

getUnique :: TyCon -> Unique

setUnique :: TyCon -> Unique -> TyCon

PrettyPrec TyCon

Defined in Clash.Core.Pretty

Methods

pprPrec :: Monad m => Rational -> TyCon -> m ClashDoc

pprPrec' :: Monad m => PrettyOptions -> Rational -> TyCon -> m ClashDoc

type Rep TyCon

Defined in Clash.Core.TyCon

type Rep TyCon = D1 ('MetaData "TyCon" "Clash.Core.TyCon" "clash-lib-1.2.2-inplace" 'False) ((C1 ('MetaCons "AlgTyCon" 'PrefixI 'True) ((S1 ('MetaSel ('Just "tyConUniq") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Unique) :*: (S1 ('MetaSel ('Just "tyConName") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 TyConName) :*: S1 ('MetaSel ('Just "tyConKind") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Kind))) :*: (S1 ('MetaSel ('Just "tyConArity") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Int) :*: (S1 ('MetaSel ('Just "algTcRhs") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 AlgTyConRhs) :*: S1 ('MetaSel ('Just "isClassTc") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bool)))) :+: C1 ('MetaCons "FunTyCon" 'PrefixI 'True) ((S1 ('MetaSel ('Just "tyConUniq") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Unique) :*: S1 ('MetaSel ('Just "tyConName") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 TyConName)) :*: (S1 ('MetaSel ('Just "tyConKind") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Kind) :*: (S1 ('MetaSel ('Just "tyConArity") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "tyConSubst") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [([Type], Type)]))))) :+: (C1 ('MetaCons "PrimTyCon" 'PrefixI 'True) ((S1 ('MetaSel ('Just "tyConUniq") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Unique) :*: S1 ('MetaSel ('Just "tyConName") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 TyConName)) :*: (S1 ('MetaSel ('Just "tyConKind") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Kind) :*: S1 ('MetaSel ('Just "tyConArity") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Int))) :+: C1 ('MetaCons "SuperKindTyCon" 'PrefixI 'True) (S1 ('MetaSel ('Just "tyConUniq") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Unique) :*: S1 ('MetaSel ('Just "tyConName") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 TyConName))))

type TyConName = Name TyCon

TyCon reference

type TyConMap = UniqMap TyCon

data AlgTyConRhs

The RHS of an Algebraic Datatype

Constructors

DataTyCon

Fields

• dataCons :: [DataCon]

  The DataCons of a TyCon

NewTyCon

Fields

• dataCon :: !DataCon

  The newtype DataCon

• ntEtadRhs :: ([TyVar], Type)

  The argument type of the newtype DataCon in eta-reduced form, which is just the representation of the TyCon. The TyName's are the type-variables from the corresponding TyCon.

Instances

Show AlgTyConRhs

Defined in Clash.Core.TyCon

Methods

showsPrec :: Int -> AlgTyConRhs -> ShowS

show :: AlgTyConRhs -> String

showList :: [AlgTyConRhs] -> ShowS

Generic AlgTyConRhs

Defined in Clash.Core.TyCon

Associated Types

type Rep AlgTyConRhs :: Type -> Type

Methods

from :: AlgTyConRhs -> Rep AlgTyConRhs x

to :: Rep AlgTyConRhs x -> AlgTyConRhs

Binary AlgTyConRhs

Defined in Clash.Core.TyCon

Methods

put :: AlgTyConRhs -> Put

get :: Get AlgTyConRhs

putList :: [AlgTyConRhs] -> Put

NFData AlgTyConRhs

Defined in Clash.Core.TyCon

Methods

rnf :: AlgTyConRhs -> ()

type Rep AlgTyConRhs

Defined in Clash.Core.TyCon

type Rep AlgTyConRhs = D1 ('MetaData "AlgTyConRhs" "Clash.Core.TyCon" "clash-lib-1.2.2-inplace" 'False) (C1 ('MetaCons "DataTyCon" 'PrefixI 'True) (S1 ('MetaSel ('Just "dataCons") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [DataCon])) :+: C1 ('MetaCons "NewTyCon" 'PrefixI 'True) (S1 ('MetaSel ('Just "dataCon") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 DataCon) :*: S1 ('MetaSel ('Just "ntEtadRhs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ([TyVar], Type))))

mkKindTyCon :: TyConName -> Kind -> TyCon

Create a Kind out of a TyConName

isTupleTyConLike :: TyConName -> Bool

Does the TyCon look like a tuple TyCon

isNewTypeTc :: TyCon -> Bool

tyConDataCons :: TyCon -> [DataCon]

Get the DataCons belonging to a TyCon