Clash.Core.PartialEval.Monad

The monad for partial evaluation, and its API. This should contain all auxiliary functions needed to define new evaluator implementations. This module is only needed to define new evaluators, for calling an existing evaluator see Clash.Core.PartialEval.

Partial Evaluation Monad

data Eval a

The monad of partial evaluation. The inner monad is IO, as primitive evaluation can attempt to evaluate IO actions.

Instances

Monad Eval

Defined in Clash.Core.PartialEval.Monad

Methods

(>>=) :: Eval a -> (a -> Eval b) -> Eval b

(>>) :: Eval a -> Eval b -> Eval b

return :: a -> Eval a

Functor Eval

Defined in Clash.Core.PartialEval.Monad

Methods

fmap :: (a -> b) -> Eval a -> Eval b

(<$) :: a -> Eval b -> Eval a

MonadFail Eval

Defined in Clash.Core.PartialEval.Monad

Methods

fail :: String -> Eval a

Applicative Eval

Defined in Clash.Core.PartialEval.Monad

Methods

pure :: a -> Eval a

(<*>) :: Eval (a -> b) -> Eval a -> Eval b

liftA2 :: (a -> b -> c) -> Eval a -> Eval b -> Eval c

(*>) :: Eval a -> Eval b -> Eval b

(<*) :: Eval a -> Eval b -> Eval a

Alternative Eval

Defined in Clash.Core.PartialEval.Monad

Methods

empty :: Eval a

(<|>) :: Eval a -> Eval a -> Eval a

some :: Eval a -> Eval [a]

many :: Eval a -> Eval [a]

MonadIO Eval

Defined in Clash.Core.PartialEval.Monad

Methods

liftIO :: IO a -> Eval a

MonadThrow Eval

Defined in Clash.Core.PartialEval.Monad

Methods

throwM :: Exception e => e -> Eval a

MonadCatch Eval

Defined in Clash.Core.PartialEval.Monad

Methods

catch :: Exception e => Eval a -> (e -> Eval a) -> Eval a

MonadMask Eval

Defined in Clash.Core.PartialEval.Monad

Methods

mask :: ((forall a. Eval a -> Eval a) -> Eval b) -> Eval b

uninterruptibleMask :: ((forall a. Eval a -> Eval a) -> Eval b) -> Eval b

generalBracket :: Eval a -> (a -> ExitCase b -> Eval c) -> (a -> Eval b) -> Eval (b, c)

MonadReader LocalEnv Eval

Defined in Clash.Core.PartialEval.Monad

Methods

ask :: Eval LocalEnv

local :: (LocalEnv -> LocalEnv) -> Eval a -> Eval a

reader :: (LocalEnv -> a) -> Eval a

MonadState GlobalEnv Eval

Defined in Clash.Core.PartialEval.Monad

Methods

get :: Eval GlobalEnv

put :: GlobalEnv -> Eval ()

state :: (GlobalEnv -> (a, GlobalEnv)) -> Eval a

runEval :: GlobalEnv -> LocalEnv -> Eval a -> IO (a, GlobalEnv)

Evaluate an action in the partial evaluator, returning the result, and the final state of the global environment.

Local and Global Environments

getLocalEnv :: Eval LocalEnv

setLocalEnv :: LocalEnv -> Eval a -> Eval a

modifyLocalEnv :: (LocalEnv -> LocalEnv) -> Eval a -> Eval a

getGlobalEnv :: Eval GlobalEnv

modifyGlobalEnv :: (GlobalEnv -> GlobalEnv) -> Eval ()

Evaluation Context

getContext :: Eval Id

withContext :: Id -> Eval a -> Eval a

Local Type Bindings

getTvSubst :: Eval Subst

findTyVar :: TyVar -> Eval (Maybe Type)

withTyVar :: TyVar -> Type -> Eval a -> Eval a

withTyVars :: [(TyVar, Type)] -> Eval a -> Eval a

Local Term Bindings

findId :: Id -> Eval (Maybe Value)

withId :: Id -> Value -> Eval a -> Eval a

withIds :: [(Id, Value)] -> Eval a -> Eval a

withoutId :: Id -> Eval a -> Eval a

Global Term Bindings

findBinding :: Id -> Eval (Maybe (Binding Value))

replaceBinding :: Binding Value -> Eval ()

IO Heap Bindings

getRef :: Int -> Eval Value

setRef :: Int -> Value -> Eval ()

Lifted Data Constructors

isKeepingLifted :: Eval Bool

keepLifted :: Eval a -> Eval a

Fuel

getFuel :: Eval Word

withFuel :: Eval a -> Eval a

preserveFuel :: Eval a -> Eval a

Accessing Global State

getTyConMap :: Eval TyConMap

getInScope :: Eval InScopeSet

Fresh Variable Generation

getUniqueId :: OccName -> Type -> Eval Id

getUniqueTyVar :: OccName -> Kind -> Eval TyVar

Work free check

workFreeValue :: Value -> Eval Bool