Copyright	(C) 2012-2016 University of Twente 2016 Myrtle Software Ltd 2017 Google Inc.
License	BSD2 (see the file LICENSE)
Maintainer	Christiaan Baaij <christiaan.baaij@gmail.com>
Safe Haskell	None
Language	Haskell2010

Clash.Rewrite.Types

Description

Type and instance definitions for Rewrite modules

Synopsis

data CoreContext
- = AppFun
- | AppArg
- | TyAppC
- | LetBinding Id [Id]
- | LetBody [Id]
- | LamBody Id
- | TyLamBody TyVar
- | CaseAlt [TyVar] [Id]
- | CaseScrut
- | CastBody
data RewriteState extra = RewriteState {
- _transformCounter :: !Int
- _bindings :: !BindingMap
- _uniqSupply :: !Supply
- _curFun :: (TmName, SrcSpan)
- _nameCounter :: !Int
- _globalHeap :: GlobalHeap
- _extra :: !extra
}
uniqSupply :: forall extra. Lens' (RewriteState extra) Supply
transformCounter :: forall extra. Lens' (RewriteState extra) Int
nameCounter :: forall extra. Lens' (RewriteState extra) Int
globalHeap :: forall extra. Lens' (RewriteState extra) GlobalHeap
extra :: forall extra extra. Lens (RewriteState extra) (RewriteState extra) extra extra
curFun :: forall extra. Lens' (RewriteState extra) (TmName, SrcSpan)
bindings :: forall extra. Lens' (RewriteState extra) BindingMap
data RewriteEnv = RewriteEnv {
- _dbgLevel :: DebugLevel
- _typeTranslator :: HashMap TyConOccName TyCon -> Bool -> Type -> Maybe (Either String HWType)
- _tcCache :: HashMap TyConOccName TyCon
- _tupleTcCache :: IntMap TyConName
- _evaluator :: PrimEvaluator
- _allowZero :: Bool
- _topEntities :: HashSet TmOccName
}
typeTranslator :: Lens' RewriteEnv (HashMap TyConOccName TyCon -> Bool -> Type -> Maybe (Either String HWType))
tupleTcCache :: Lens' RewriteEnv (IntMap TyConName)
topEntities :: Lens' RewriteEnv (HashSet TmOccName)
tcCache :: Lens' RewriteEnv (HashMap TyConOccName TyCon)
evaluator :: Lens' RewriteEnv PrimEvaluator
dbgLevel :: Lens' RewriteEnv DebugLevel
allowZero :: Lens' RewriteEnv Bool
newtype RewriteMonad extra a = R {
- runR :: RewriteEnv -> RewriteState extra -> (a, RewriteState extra, Any)
}
type Transform m = [CoreContext] -> Term -> m Term
type Rewrite extra = Transform (RewriteMonad extra)

Documentation

data CoreContext Source #

Context in which a term appears

Constructors

AppFun	Function position of an application
AppArg	Argument position of an application
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 [TyVar] [Id]	RHS of a case-alternative with the variables bound by the pattern on the LHS
CaseScrut	Subject of a case-decomposition
CastBody	Body of a Cast

Instances

Eq CoreContext Source #
Instance details Methods (==) :: CoreContext -> CoreContext -> Bool # (/=) :: CoreContext -> CoreContext -> Bool #
Show CoreContext Source #
Instance details Methods showsPrec :: Int -> CoreContext -> ShowS # show :: CoreContext -> String # showList :: [CoreContext] -> ShowS #

data RewriteState extra Source #

State of a rewriting session

Constructors

RewriteState
Fields _transformCounter :: !Int Number of applied transformations _bindings :: !BindingMap Global binders _uniqSupply :: !Supply Supply of unique numbers _curFun :: (TmName, SrcSpan) Function which is currently normalized _nameCounter :: !Int Used for `Fresh` _globalHeap :: GlobalHeap Used as a heap for compile-time evaluation of primitives that live in I/O _extra :: !extra Additional state

Instances

MonadState (RewriteState extra) (RewriteMonad extra) Source #
Instance details Methods get :: RewriteMonad extra (RewriteState extra) # put :: RewriteState extra -> RewriteMonad extra () # state :: (RewriteState extra -> (a, RewriteState extra)) -> RewriteMonad extra a #

uniqSupply :: forall extra. Lens' (RewriteState extra) Supply Source #

transformCounter :: forall extra. Lens' (RewriteState extra) Int Source #

nameCounter :: forall extra. Lens' (RewriteState extra) Int Source #

globalHeap :: forall extra. Lens' (RewriteState extra) GlobalHeap Source #

extra :: forall extra extra. Lens (RewriteState extra) (RewriteState extra) extra extra Source #

curFun :: forall extra. Lens' (RewriteState extra) (TmName, SrcSpan) Source #

bindings :: forall extra. Lens' (RewriteState extra) BindingMap Source #

data RewriteEnv Source #

Read-only environment of a rewriting session

Constructors

RewriteEnv

Fields

_dbgLevel :: DebugLevel
Lvl at which we print debugging messages
_typeTranslator :: HashMap TyConOccName TyCon -> Bool -> Type -> Maybe (Either String HWType)
Hardcode Type -> HWType translator
_tcCache :: HashMap TyConOccName TyCon
TyCon cache
_tupleTcCache :: IntMap TyConName
Tuple TyCon cache
_evaluator :: PrimEvaluator
Hardcoded evaluator (delta-reduction)}
_allowZero :: Bool
Zero bit wide things are representable
_topEntities :: HashSet TmOccName
Functions that are considered TopEntities

Instances

MonadReader RewriteEnv (RewriteMonad extra) Source #
Instance details Methods ask :: RewriteMonad extra RewriteEnv # local :: (RewriteEnv -> RewriteEnv) -> RewriteMonad extra a -> RewriteMonad extra a # reader :: (RewriteEnv -> a) -> RewriteMonad extra a #

typeTranslator :: Lens' RewriteEnv (HashMap TyConOccName TyCon -> Bool -> Type -> Maybe (Either String HWType)) Source #

tupleTcCache :: Lens' RewriteEnv (IntMap TyConName) Source #

topEntities :: Lens' RewriteEnv (HashSet TmOccName) Source #

tcCache :: Lens' RewriteEnv (HashMap TyConOccName TyCon) Source #

evaluator :: Lens' RewriteEnv PrimEvaluator Source #

dbgLevel :: Lens' RewriteEnv DebugLevel Source #

allowZero :: Lens' RewriteEnv Bool Source #

newtype RewriteMonad extra a Source #

Monad that keeps track how many transformations have been applied and can generate fresh variables and unique identifiers. In addition, it keeps track if a transformation/rewrite has been successfully applied.

Constructors

R
Fields runR :: RewriteEnv -> RewriteState extra -> (a, RewriteState extra, Any)

Instances

MonadReader RewriteEnv (RewriteMonad extra) Source #
Instance details Methods ask :: RewriteMonad extra RewriteEnv # local :: (RewriteEnv -> RewriteEnv) -> RewriteMonad extra a -> RewriteMonad extra a # reader :: (RewriteEnv -> a) -> RewriteMonad extra a #
MonadWriter Any (RewriteMonad extra) Source #
Instance details Methods writer :: (a, Any) -> RewriteMonad extra a # tell :: Any -> RewriteMonad extra () # listen :: RewriteMonad extra a -> RewriteMonad extra (a, Any) # pass :: RewriteMonad extra (a, Any -> Any) -> RewriteMonad extra a #
Monad (RewriteMonad extra) Source #
Instance details Methods (>>=) :: RewriteMonad extra a -> (a -> RewriteMonad extra b) -> RewriteMonad extra b # (>>) :: RewriteMonad extra a -> RewriteMonad extra b -> RewriteMonad extra b # return :: a -> RewriteMonad extra a # fail :: String -> RewriteMonad extra a #
Functor (RewriteMonad extra) Source #
Instance details Methods fmap :: (a -> b) -> RewriteMonad extra a -> RewriteMonad extra b # (<$) :: a -> RewriteMonad extra b -> RewriteMonad extra a #
MonadFix (RewriteMonad extra) Source #
Instance details Methods mfix :: (a -> RewriteMonad extra a) -> RewriteMonad extra a #
Applicative (RewriteMonad extra) Source #
Instance details Methods pure :: a -> RewriteMonad extra a # (<>) :: RewriteMonad extra (a -> b) -> RewriteMonad extra a -> RewriteMonad extra b # liftA2 :: (a -> b -> c) -> RewriteMonad extra a -> RewriteMonad extra b -> RewriteMonad extra c # (>) :: RewriteMonad extra a -> RewriteMonad extra b -> RewriteMonad extra b # (<*) :: RewriteMonad extra a -> RewriteMonad extra b -> RewriteMonad extra a #
Fresh (RewriteMonad extra) Source #
Instance details Methods fresh :: Name a -> RewriteMonad extra (Name a) #
MonadUnique (RewriteMonad extra) Source #
Instance details Methods getUniqueM :: RewriteMonad extra Int Source #
MonadState (RewriteState extra) (RewriteMonad extra) Source #
Instance details Methods get :: RewriteMonad extra (RewriteState extra) # put :: RewriteState extra -> RewriteMonad extra () # state :: (RewriteState extra -> (a, RewriteState extra)) -> RewriteMonad extra a #

type Transform m = [CoreContext] -> Term -> m Term Source #

Monadic action that transforms a term given a certain context

type Rewrite extra = Transform (RewriteMonad extra) Source #

A Transform action in the context of the RewriteMonad