Clash.Core.Term

Term representation in the CoreHW language: System F + LetRec + Case

Documentation

data Term

Term representation in the CoreHW language: System F + LetRec + Case

Constructors

Var !Id

Variable reference

Data !DataCon

Datatype constructor

Literal !Literal

Literal

Prim !PrimInfo

Primitive

Lam !Id Term

Term-abstraction

TyLam !TyVar Term

Type-abstraction

App !Term !Term

Application

TyApp !Term !Type

Type-application

Letrec [LetBinding] Term

Recursive let-binding

Case !Term !Type [Alt]

Case-expression: subject, type of alternatives, list of alternatives

Cast !Term !Type !Type

Cast a term from one type to another

Tick !TickInfo !Term

Annotated term

Instances

Eq Term

Defined in Clash.Core.Subst

Methods

(==) :: Term -> Term -> Bool

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

Ord Term

Defined in Clash.Core.Subst

Methods

compare :: Term -> Term -> Ordering

(<) :: Term -> Term -> Bool

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

(>) :: Term -> Term -> Bool

(>=) :: Term -> Term -> Bool

max :: Term -> Term -> Term

min :: Term -> Term -> Term

Show Term

Defined in Clash.Core.Term

Methods

showsPrec :: Int -> Term -> ShowS

show :: Term -> String

showList :: [Term] -> ShowS

Generic Term

Defined in Clash.Core.Term

Associated Types

type Rep Term :: Type -> Type

Methods

from :: Term -> Rep Term x

to :: Rep Term x -> Term

Hashable Term

Defined in Clash.Core.Term

Methods

hashWithSalt :: Int -> Term -> Int

hash :: Term -> Int

Binary Term

Defined in Clash.Core.Term

Methods

put :: Term -> Put

get :: Get Term

putList :: [Term] -> Put

NFData Term

Defined in Clash.Core.Term

Methods

rnf :: Term -> ()

ClashPretty Term

Defined in Clash.Core.Pretty

Methods

clashPretty :: Term -> Doc ()

PrettyPrec Term

Defined in Clash.Core.Pretty

Methods

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

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

TermLiteral Term

Defined in Clash.Core.TermLiteral

Methods

termToData :: Term -> Either Term Term

PrettyPrec (Id, Term)

Defined in Clash.Core.Pretty

Methods

pprPrec :: Monad m => Rational -> (Id, Term) -> m ClashDoc

pprPrec' :: Monad m => PrettyOptions -> Rational -> (Id, Term) -> m ClashDoc

type Rep Term

Defined in Clash.Core.Term

type Rep Term = D1 (MetaData "Term" "Clash.Core.Term" "clash-lib-1.2.1-inplace" False) (((C1 (MetaCons "Var" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Id)) :+: (C1 (MetaCons "Data" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 DataCon)) :+: C1 (MetaCons "Literal" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Literal)))) :+: (C1 (MetaCons "Prim" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 PrimInfo)) :+: (C1 (MetaCons "Lam" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Id) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Term)) :+: C1 (MetaCons "TyLam" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 TyVar) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Term))))) :+: ((C1 (MetaCons "App" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Term) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Term)) :+: (C1 (MetaCons "TyApp" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Term) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Type)) :+: C1 (MetaCons "Letrec" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [LetBinding]) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Term)))) :+: (C1 (MetaCons "Case" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Term) :*: (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Type) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Alt]))) :+: (C1 (MetaCons "Cast" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Term) :*: (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Type) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Type))) :+: C1 (MetaCons "Tick" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 TickInfo) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Term))))))

mkAbstraction :: Term -> [Either Id TyVar] -> Term

Abstract a term over a list of term and type variables

mkTyLams :: Term -> [TyVar] -> Term

Abstract a term over a list of term variables

mkLams :: Term -> [Id] -> Term

Abstract a term over a list of type variables

mkApps :: Term -> [Either Term Type] -> Term

Apply a list of types and terms to a term

mkTyApps :: Term -> [Type] -> Term

Apply a list of types to a term

mkTmApps :: Term -> [Term] -> Term

Apply a list of terms to a term

mkTicks :: Term -> [TickInfo] -> Term

type TmName = Name Term

Term reference

idToVar :: Id -> Term

Make variable reference out of term variable

varToId :: Term -> Id

Make a term variable out of a variable reference

type LetBinding = (Id, Term)

Binding in a LetRec construct

data Pat

Patterns in the LHS of a case-decomposition

Constructors

DataPat !DataCon [TyVar] [Id]

Datatype pattern, '[TyVar]' bind existentially-quantified type-variables of a DataCon

LitPat !Literal

Literal pattern

DefaultPat

Default pattern

Instances

Eq Pat

Defined in Clash.Core.Term

Methods

(==) :: Pat -> Pat -> Bool

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

Ord Pat

Defined in Clash.Core.Term

Methods

compare :: Pat -> Pat -> Ordering

(<) :: Pat -> Pat -> Bool

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

(>) :: Pat -> Pat -> Bool

(>=) :: Pat -> Pat -> Bool

max :: Pat -> Pat -> Pat

min :: Pat -> Pat -> Pat

Show Pat

Defined in Clash.Core.Term

Methods

showsPrec :: Int -> Pat -> ShowS

show :: Pat -> String

showList :: [Pat] -> ShowS

Generic Pat

Defined in Clash.Core.Term

Associated Types

type Rep Pat :: Type -> Type

Methods

from :: Pat -> Rep Pat x

to :: Rep Pat x -> Pat

Hashable Pat

Defined in Clash.Core.Term

Methods

hashWithSalt :: Int -> Pat -> Int

hash :: Pat -> Int

Binary Pat

Defined in Clash.Core.Term

Methods

put :: Pat -> Put

get :: Get Pat

putList :: [Pat] -> Put

NFData Pat

Defined in Clash.Core.Term

Methods

rnf :: Pat -> ()

PrettyPrec Pat

Defined in Clash.Core.Pretty

Methods

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

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

type Rep Pat

Defined in Clash.Core.Term

type Rep Pat = D1 (MetaData "Pat" "Clash.Core.Term" "clash-lib-1.2.1-inplace" False) (C1 (MetaCons "DataPat" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 DataCon) :*: (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [TyVar]) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Id]))) :+: (C1 (MetaCons "LitPat" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Literal)) :+: C1 (MetaCons "DefaultPat" PrefixI False) (U1 :: Type -> Type)))

patIds :: Pat -> ([TyVar], [Id])

Get the list of term-binders out of a DataType pattern

patVars :: Pat -> [Var a]

type Alt = (Pat, Term)

data TickInfo

Constructors

SrcSpan !SrcSpan

Source tick, will get added by GHC by running clash with `-g`

NameMod !NameMod !Type

Modifier for naming module instantiations and registers, are added by the user by using the functions Clash.Magic.[prefixName,suffixName,setName]

DeDup

Deduplicate, i.e. try to share expressions between multiple branches.

NoDeDup

Do not deduplicate, i.e. keep, an expression inside a case-alternative; do not try to share expressions between multiple branches.

Instances

Eq TickInfo

Defined in Clash.Core.Term

Methods

(==) :: TickInfo -> TickInfo -> Bool

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

Show TickInfo

Defined in Clash.Core.Term

Methods

showsPrec :: Int -> TickInfo -> ShowS

show :: TickInfo -> String

showList :: [TickInfo] -> ShowS

Generic TickInfo

Defined in Clash.Core.Term

Associated Types

type Rep TickInfo :: Type -> Type

Methods

from :: TickInfo -> Rep TickInfo x

to :: Rep TickInfo x -> TickInfo

Hashable TickInfo

Defined in Clash.Core.Term

Methods

hashWithSalt :: Int -> TickInfo -> Int

hash :: TickInfo -> Int

Binary TickInfo

Defined in Clash.Core.Term

Methods

put :: TickInfo -> Put

get :: Get TickInfo

putList :: [TickInfo] -> Put

NFData TickInfo

Defined in Clash.Core.Term

Methods

rnf :: TickInfo -> ()

PrettyPrec TickInfo

Defined in Clash.Core.Pretty

Methods

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

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

type Rep TickInfo

Defined in Clash.Core.Term

type Rep TickInfo = D1 (MetaData "TickInfo" "Clash.Core.Term" "clash-lib-1.2.1-inplace" False) ((C1 (MetaCons "SrcSpan" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 SrcSpan)) :+: C1 (MetaCons "NameMod" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 NameMod) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Type))) :+: (C1 (MetaCons "DeDup" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "NoDeDup" PrefixI False) (U1 :: Type -> Type)))

stripTicks :: Term -> Term

partitionTicks

Arguments

:: [TickInfo]

-> ([TickInfo], [TickInfo])

(source ticks, nameMod ticks)

Partition ticks in source ticks and nameMod ticks

data NameMod

Tag to indicate which instance/register name modifier was used

Constructors

PrefixName

Clash.Magic.prefixName

SuffixName

Clash.Magic.suffixName

SuffixNameP

Clash.Magic.suffixNameP

SetName

Clash.Magic.setName

Instances

Eq NameMod

Defined in Clash.Core.Term

Methods

(==) :: NameMod -> NameMod -> Bool

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

Show NameMod

Defined in Clash.Core.Term

Methods

showsPrec :: Int -> NameMod -> ShowS

show :: NameMod -> String

showList :: [NameMod] -> ShowS

Generic NameMod

Defined in Clash.Core.Term

Associated Types

type Rep NameMod :: Type -> Type

Methods

from :: NameMod -> Rep NameMod x

to :: Rep NameMod x -> NameMod

Hashable NameMod

Defined in Clash.Core.Term

Methods

hashWithSalt :: Int -> NameMod -> Int

hash :: NameMod -> Int

Binary NameMod

Defined in Clash.Core.Term

Methods

put :: NameMod -> Put

get :: Get NameMod

putList :: [NameMod] -> Put

NFData NameMod

Defined in Clash.Core.Term

Methods

rnf :: NameMod -> ()

type Rep NameMod

Defined in Clash.Core.Term

type Rep NameMod = D1 (MetaData "NameMod" "Clash.Core.Term" "clash-lib-1.2.1-inplace" False) ((C1 (MetaCons "PrefixName" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "SuffixName" PrefixI False) (U1 :: Type -> Type)) :+: (C1 (MetaCons "SuffixNameP" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "SetName" PrefixI False) (U1 :: Type -> Type)))

data PrimInfo

Constructors

PrimInfo

Fields

• primName :: !Text
• primType :: !Type
• primWorkInfo :: !WorkInfo

Instances

Show PrimInfo

Defined in Clash.Core.Term

Methods

showsPrec :: Int -> PrimInfo -> ShowS

show :: PrimInfo -> String

showList :: [PrimInfo] -> ShowS

Generic PrimInfo

Defined in Clash.Core.Term

Associated Types

type Rep PrimInfo :: Type -> Type

Methods

from :: PrimInfo -> Rep PrimInfo x

to :: Rep PrimInfo x -> PrimInfo

Hashable PrimInfo

Defined in Clash.Core.Term

Methods

hashWithSalt :: Int -> PrimInfo -> Int

hash :: PrimInfo -> Int

Binary PrimInfo

Defined in Clash.Core.Term

Methods

put :: PrimInfo -> Put

get :: Get PrimInfo

putList :: [PrimInfo] -> Put

NFData PrimInfo

Defined in Clash.Core.Term

Methods

rnf :: PrimInfo -> ()

type Rep PrimInfo

Defined in Clash.Core.Term

type Rep PrimInfo = D1 (MetaData "PrimInfo" "Clash.Core.Term" "clash-lib-1.2.1-inplace" False) (C1 (MetaCons "PrimInfo" PrefixI True) (S1 (MetaSel (Just "primName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: (S1 (MetaSel (Just "primType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Type) :*: S1 (MetaSel (Just "primWorkInfo") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 WorkInfo))))

data WorkInfo

Constructors

WorkConstant

Ignores its arguments, and outputs a constant

WorkNever

Never adds any work

WorkVariable

Does work when the arguments are variable

WorkAlways

Performs work regardless of whether the variables are constant or variable; these are things like clock or reset generators

Instances

Show WorkInfo

Defined in Clash.Core.Term

Methods

showsPrec :: Int -> WorkInfo -> ShowS

show :: WorkInfo -> String

showList :: [WorkInfo] -> ShowS

Generic WorkInfo

Defined in Clash.Core.Term

Associated Types

type Rep WorkInfo :: Type -> Type

Methods

from :: WorkInfo -> Rep WorkInfo x

to :: Rep WorkInfo x -> WorkInfo

Hashable WorkInfo

Defined in Clash.Core.Term

Methods

hashWithSalt :: Int -> WorkInfo -> Int

hash :: WorkInfo -> Int

Binary WorkInfo

Defined in Clash.Core.Term

Methods

put :: WorkInfo -> Put

get :: Get WorkInfo

putList :: [WorkInfo] -> Put

NFData WorkInfo

Defined in Clash.Core.Term

Methods

rnf :: WorkInfo -> ()

type Rep WorkInfo

Defined in Clash.Core.Term

type Rep WorkInfo = D1 (MetaData "WorkInfo" "Clash.Core.Term" "clash-lib-1.2.1-inplace" False) ((C1 (MetaCons "WorkConstant" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "WorkNever" PrefixI False) (U1 :: Type -> Type)) :+: (C1 (MetaCons "WorkVariable" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "WorkAlways" PrefixI False) (U1 :: Type -> Type)))

data CoreContext

Context in which a term appears

Constructors

AppFun

Function position of an application

AppArg (Maybe (Text, Int, Int))

Argument position of an application. If this is an argument applied to a primitive, a tuple is defined containing (name of the primitive, #type args, #term args)

TyAppC

Function position of a type application

LetBinding Id [Id]

RHS of a Let-binder with the sibling LHS'

LetBody [Id]

Body of a Let-binding with the bound LHS'

LamBody Id

Body of a lambda-term with the abstracted variable

TyLamBody TyVar

Body of a TyLambda-term with the abstracted type-variable

CaseAlt Pat

RHS of a case-alternative with the bound pattern on the LHS

CaseScrut

Subject of a case-decomposition

CastBody

Body of a Cast

TickC TickInfo

Body of a Tick

Instances

Eq CoreContext

Defined in Clash.Core.Term

Methods

(==) :: CoreContext -> CoreContext -> Bool

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

Show CoreContext

Defined in Clash.Core.Term

Methods

showsPrec :: Int -> CoreContext -> ShowS

show :: CoreContext -> String

showList :: [CoreContext] -> ShowS

Generic CoreContext

Defined in Clash.Core.Term

Associated Types

type Rep CoreContext :: Type -> Type

Methods

from :: CoreContext -> Rep CoreContext x

to :: Rep CoreContext x -> CoreContext

Hashable CoreContext

Defined in Clash.Core.Term

Methods

hashWithSalt :: Int -> CoreContext -> Int

hash :: CoreContext -> Int

Binary CoreContext

Defined in Clash.Core.Term

Methods

put :: CoreContext -> Put

get :: Get CoreContext

putList :: [CoreContext] -> Put

NFData CoreContext

Defined in Clash.Core.Term

Methods

rnf :: CoreContext -> ()

type Rep CoreContext

Defined in Clash.Core.Term

type Rep CoreContext = D1 (MetaData "CoreContext" "Clash.Core.Term" "clash-lib-1.2.1-inplace" False) (((C1 (MetaCons "AppFun" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "AppArg" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (Text, Int, Int))))) :+: (C1 (MetaCons "TyAppC" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "LetBinding" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Id) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Id])) :+: C1 (MetaCons "LetBody" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Id]))))) :+: ((C1 (MetaCons "LamBody" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Id)) :+: (C1 (MetaCons "TyLamBody" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 TyVar)) :+: C1 (MetaCons "CaseAlt" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Pat)))) :+: (C1 (MetaCons "CaseScrut" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "CastBody" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "TickC" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 TickInfo))))))

type Context = [CoreContext]

A list of CoreContext describes the complete navigation path from the top-level to a specific sub-expression.

isLambdaBodyCtx :: CoreContext -> Bool

Is the Context a Lambda/Term-abstraction context?

isTickCtx :: CoreContext -> Bool

Is the Context a Tick context?

walkTerm :: forall a. (Term -> Maybe a) -> Term -> [a]

Visit all terms in a term, testing it with a predicate, and returning a list of predicate yields.

collectArgs :: Term -> (Term, [Either Term Type])

Split a (Type)Application in the applied term and it arguments

collectArgsTicks :: Term -> (Term, [Either Term Type], [TickInfo])

collectTicks :: Term -> (Term, [TickInfo])

collectTermIds :: Term -> [Id]

collectBndrs :: Term -> ([Either Id TyVar], Term)

Split a (Type)Abstraction in the bound variables and the abstracted term

primArg

Arguments

:: Term

Function application

-> Maybe (Text, Int, Int)

If Term was a primitive: (name of primitive, term args)

Given a function application, find the primitive it's applied. Yields Nothing if given term is not an application or if it is not a primitive.