Copyright	(C) 2020-2021 QBayLogic B.V.
License	BSD2 (see the file LICENSE)
Maintainer	QBayLogic B.V. <devops@qbaylogic.com>
Safe Haskell	None
Language	Haskell2010

Clash.Core.PartialEval.Monad

Contents

Partial Evaluation Monad
Local and Global Environments
Evaluation Context
Local Type Bindings
Local Term Bindings
Global Term Bindings
IO Heap Bindings
Lifted Data Constructors
Fuel
Accessing Global State
Fresh Variable Generation
Work free check

Description

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.

Synopsis

data Eval a
runEval :: GlobalEnv -> LocalEnv -> Eval a -> IO (a, GlobalEnv)
getLocalEnv :: Eval LocalEnv
setLocalEnv :: LocalEnv -> Eval a -> Eval a
modifyLocalEnv :: (LocalEnv -> LocalEnv) -> Eval a -> Eval a
getGlobalEnv :: Eval GlobalEnv
modifyGlobalEnv :: (GlobalEnv -> GlobalEnv) -> Eval ()
getContext :: Eval Id
withContext :: Id -> Eval a -> Eval a
getTvSubst :: Eval Subst
findTyVar :: TyVar -> Eval (Maybe Type)
withTyVar :: TyVar -> Type -> Eval a -> Eval a
withTyVars :: [(TyVar, Type)] -> Eval a -> Eval a
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
findBinding :: Id -> Eval (Maybe (Binding Value))
replaceBinding :: Binding Value -> Eval ()
getRef :: Int -> Eval Value
setRef :: Int -> Value -> Eval ()
isKeepingLifted :: Eval Bool
keepLifted :: Eval a -> Eval a
getFuel :: Eval Word
withFuel :: Eval a -> Eval a
preserveFuel :: Eval a -> Eval a
getTyConMap :: Eval TyConMap
getInScope :: Eval InScopeSet
getUniqueId :: OccName -> Type -> Eval Id
getUniqueTyVar :: OccName -> Kind -> Eval TyVar
workFreeValue :: Value -> Eval Bool

Partial Evaluation Monad

data Eval a Source #

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

Instances

Instances details

Monad Eval Source #
Instance details 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 Source #
Instance details Defined in Clash.Core.PartialEval.Monad Methods fmap :: (a -> b) -> Eval a -> Eval b # (<$) :: a -> Eval b -> Eval a #
MonadFail Eval Source #
Instance details Defined in Clash.Core.PartialEval.Monad Methods fail :: String -> Eval a #
Applicative Eval Source #
Instance details 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 Source #
Instance details 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 Source #
Instance details Defined in Clash.Core.PartialEval.Monad Methods liftIO :: IO a -> Eval a #
MonadThrow Eval Source #
Instance details Defined in Clash.Core.PartialEval.Monad Methods throwM :: Exception e => e -> Eval a #
MonadCatch Eval Source #
Instance details Defined in Clash.Core.PartialEval.Monad Methods catch :: Exception e => Eval a -> (e -> Eval a) -> Eval a #
MonadMask Eval Source #
Instance details 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 Source #
Instance details 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 Source #
Instance details Defined in Clash.Core.PartialEval.Monad Methods get :: Eval GlobalEnv # put :: GlobalEnv -> Eval () # state :: (GlobalEnv -> (a, GlobalEnv)) -> Eval a #