Clash.Core.Type

Types in CoreHW

Documentation

data Type

Types in CoreHW: function and polymorphic types

Constructors

VarTy !TyVar

Type variable

ConstTy !ConstTy

Type constant

ForAllTy !TyVar !Type

Polymorphic Type

AppTy !Type !Type

Type Application

LitTy !LitTy

Type literal

AnnType [Attr'] !Type

Annotated type, see Clash.Annotations.SynthesisAttributes

Instances

Eq Type

Defined in Clash.Core.Subst

Methods

(==) :: Type -> Type -> Bool

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

Ord Type

Defined in Clash.Core.Subst

Methods

compare :: Type -> Type -> Ordering

(<) :: Type -> Type -> Bool

(<=) :: Type -> Type -> Bool

(>) :: Type -> Type -> Bool

(>=) :: Type -> Type -> Bool

max :: Type -> Type -> Type

min :: Type -> Type -> Type

Show Type

Defined in Clash.Core.Type

Methods

showsPrec :: Int -> Type -> ShowS

show :: Type -> String

showList :: [Type] -> ShowS

Generic Type

Defined in Clash.Core.Type

Associated Types

type Rep Type :: Type -> Type

Methods

from :: Type -> Rep Type x

to :: Rep Type x -> Type

Hashable Type

Defined in Clash.Core.Type

Methods

hashWithSalt :: Int -> Type -> Int

hash :: Type -> Int

Binary Type

Defined in Clash.Core.Type

Methods

put :: Type -> Put

get :: Get Type

putList :: [Type] -> Put

NFData Type

Defined in Clash.Core.Type

Methods

rnf :: Type -> ()

ClashPretty Type

Defined in Clash.Core.Pretty

Methods

clashPretty :: Type -> Doc ()

PrettyPrec Type

Defined in Clash.Core.Pretty

Methods

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

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

type Rep Type

Defined in Clash.Core.Type

type Rep Type = D1 ('MetaData "Type" "Clash.Core.Type" "clash-lib-0.9999-inplace" 'False) ((C1 ('MetaCons "VarTy" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 TyVar)) :+: (C1 ('MetaCons "ConstTy" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ConstTy)) :+: C1 ('MetaCons "ForAllTy" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 TyVar) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Type)))) :+: (C1 ('MetaCons "AppTy" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Type) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Type)) :+: (C1 ('MetaCons "LitTy" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 LitTy)) :+: C1 ('MetaCons "AnnType" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Attr']) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Type)))))

data TypeView

An easier view on types

Constructors

FunTy !Type !Type

Function type

TyConApp !TyConName [Type]

Applied TyCon

OtherType !Type

Neither of the above

Instances

Show TypeView

Defined in Clash.Core.Type

Methods

showsPrec :: Int -> TypeView -> ShowS

show :: TypeView -> String

showList :: [TypeView] -> ShowS

data ConstTy

Type Constants

Constructors

TyCon !TyConName

TyCon type

Arrow

Function type

Instances

Eq ConstTy

Defined in Clash.Core.Type

Methods

(==) :: ConstTy -> ConstTy -> Bool

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

Ord ConstTy

Defined in Clash.Core.Type

Methods

compare :: ConstTy -> ConstTy -> Ordering

(<) :: ConstTy -> ConstTy -> Bool

(<=) :: ConstTy -> ConstTy -> Bool

(>) :: ConstTy -> ConstTy -> Bool

(>=) :: ConstTy -> ConstTy -> Bool

max :: ConstTy -> ConstTy -> ConstTy

min :: ConstTy -> ConstTy -> ConstTy

Show ConstTy

Defined in Clash.Core.Type

Methods

showsPrec :: Int -> ConstTy -> ShowS

show :: ConstTy -> String

showList :: [ConstTy] -> ShowS

Generic ConstTy

Defined in Clash.Core.Type

Associated Types

type Rep ConstTy :: Type -> Type

Methods

from :: ConstTy -> Rep ConstTy x

to :: Rep ConstTy x -> ConstTy

Hashable ConstTy

Defined in Clash.Core.Type

Methods

hashWithSalt :: Int -> ConstTy -> Int

hash :: ConstTy -> Int

Binary ConstTy

Defined in Clash.Core.Type

Methods

put :: ConstTy -> Put

get :: Get ConstTy

putList :: [ConstTy] -> Put

NFData ConstTy

Defined in Clash.Core.Type

Methods

rnf :: ConstTy -> ()

type Rep ConstTy

Defined in Clash.Core.Type

type Rep ConstTy = D1 ('MetaData "ConstTy" "Clash.Core.Type" "clash-lib-0.9999-inplace" 'False) (C1 ('MetaCons "TyCon" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 TyConName)) :+: C1 ('MetaCons "Arrow" 'PrefixI 'False) (U1 :: Type -> Type))

data LitTy

Literal Types

Constructors

NumTy !Integer

SymTy !String

Instances

Eq LitTy

Defined in Clash.Core.Type

Methods

(==) :: LitTy -> LitTy -> Bool

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

Ord LitTy

Defined in Clash.Core.Type

Methods

compare :: LitTy -> LitTy -> Ordering

(<) :: LitTy -> LitTy -> Bool

(<=) :: LitTy -> LitTy -> Bool

(>) :: LitTy -> LitTy -> Bool

(>=) :: LitTy -> LitTy -> Bool

max :: LitTy -> LitTy -> LitTy

min :: LitTy -> LitTy -> LitTy

Show LitTy

Defined in Clash.Core.Type

Methods

showsPrec :: Int -> LitTy -> ShowS

show :: LitTy -> String

showList :: [LitTy] -> ShowS

Generic LitTy

Defined in Clash.Core.Type

Associated Types

type Rep LitTy :: Type -> Type

Methods

from :: LitTy -> Rep LitTy x

to :: Rep LitTy x -> LitTy

Hashable LitTy

Defined in Clash.Core.Type

Methods

hashWithSalt :: Int -> LitTy -> Int

hash :: LitTy -> Int

Binary LitTy

Defined in Clash.Core.Type

Methods

put :: LitTy -> Put

get :: Get LitTy

putList :: [LitTy] -> Put

NFData LitTy

Defined in Clash.Core.Type

Methods

rnf :: LitTy -> ()

Pretty LitTy

Defined in Clash.Core.Pretty

Methods

pretty :: LitTy -> Doc ann

prettyList :: [LitTy] -> Doc ann

PrettyPrec LitTy

Defined in Clash.Core.Pretty

Methods

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

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

type Rep LitTy

Defined in Clash.Core.Type

type Rep LitTy = D1 ('MetaData "LitTy" "Clash.Core.Type" "clash-lib-0.9999-inplace" 'False) (C1 ('MetaCons "NumTy" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Integer)) :+: C1 ('MetaCons "SymTy" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 String)))

type Kind = Type

The level above types

type KindOrType = Type

Either a Kind or a Type

type KiName = Name Kind

Reference to a Kind

type TyName = Name Type

Reference to a Type

type TyVar = Var Type

Type variable

tyView :: Type -> TypeView

An easier view on types

Note [Arrow arguments]

Clash' Arrow type can either have 2 or 4 arguments, depending on who created it. By default it has two arguments: the argument type of a function, and the result type of a function.

So when do we have 4 arguments? When in Haskell/GHC land the arrow was unsaturated. This can happen in instance heads, or in the eta-reduced representation of newtypes. So what are those additional 2 arguments compared to the "normal" function type? They're the kinds of argument and result type.

coreView :: TyConMap -> Type -> Type

A view on types in which newtypes are transparent, the Signal type is transparent, and type functions are evaluated to WHNF (when possible).

Strips away ALL layers. If no layers are found it returns the given type.

coreView1 :: TyConMap -> Type -> Maybe Type

A view on types in which newtypes are transparent, the Signal type is transparent, and type functions are evaluated to WHNF (when possible).

Only strips away one "layer".

typeKind :: TyConMap -> Type -> Kind

Determine the kind of a type

mkTyConTy :: TyConName -> Type

Make a Type out of a TyCon

mkFunTy :: Type -> Type -> Type

Make a function type of an argument and result type

mkTyConApp :: TyConName -> [Type] -> Type

Make a TyCon Application out of a TyCon and a list of argument types

splitFunTy :: TyConMap -> Type -> Maybe (Type, Type)

Split a function type in an argument and result type

splitFunTys :: TyConMap -> Type -> ([Type], Type)

splitFunForallTy :: Type -> ([Either TyVar Type], Type)

Split a poly-function type in a: list of type-binders and argument types, and the result type

splitCoreFunForallTy :: TyConMap -> Type -> ([Either TyVar Type], Type)

Split a poly-function type in a: list of type-binders and argument types, and the result type. Looks through Signal and type functions.

splitTyConAppM :: Type -> Maybe (TyConName, [Type])

Split a TyCon Application in a TyCon and its arguments

isPolyFunTy :: Type -> Bool

Is a type a polymorphic or function type?

isPolyFunCoreTy :: TyConMap -> Type -> Bool

Is a type a polymorphic or function type under coreView1?

isPolyTy :: Type -> Bool

Is a type polymorphic?

isTypeFamilyApplication :: TyConMap -> Type -> Bool

isFunTy :: TyConMap -> Type -> Bool

Is a type a function type?

isClassTy :: TyConMap -> Type -> Bool

applyFunTy :: TyConMap -> Type -> Type -> Type

Apply a function type to an argument type and get the result type

findFunSubst :: TyConMap -> [([Type], Type)] -> [Type] -> Maybe Type

reduceTypeFamily :: TyConMap -> Type -> Maybe Type

undefinedTy :: Type

The type forall a . a

isIntegerTy :: Type -> Bool

normalizeType :: TyConMap -> Type -> Type

Normalize a type, looking through Signals and newtypes

For example: Signal a (Vec (6-1) (Unsigned (3+1))) normalizes to Vec 5 (Unsigned 4)

varAttrs :: Var a -> [Attr']

typeAttrs :: Type -> [Attr']

Extract attributes from type. Will return an empty list if this is an AnnType with an empty list AND if this is not an AnnType at all.