Safe Haskell	Safe-Inferred
Language	Haskell2010

KMonad.App.Types

Contents

Orphan instances

Synopsis

data AppCfg = AppCfg {
- _keySinkDev :: Acquire KeySink
- _keySourceDev :: Acquire KeySource
- _keymapCfg :: LMap Button
- _firstLayer :: LayerTag
- _fallThrough :: Bool
- _allowCmd :: Bool
- _startDelay :: Milliseconds
- _keyOutDelay :: Maybe Milliseconds
}
data AppEnv = AppEnv {
- _keAppCfg :: AppCfg
- _keLogFunc :: LogFunc
- _keySink :: KeySink
- _keySource :: KeySource
- _dispatch :: Dispatch
- _inHooks :: Hooks
- _sluice :: Sluice
- _keymap :: Keymap
- _outHooks :: Hooks
- _outVar :: TMVar KeyEvent
}
data KEnv = KEnv {
- _kAppEnv :: AppEnv
- _kBEnv :: BEnv
}
class HasAppCfg c where
- appCfg :: Lens' c AppCfg
- allowCmd :: Lens' c Bool
- fallThrough :: Lens' c Bool
- firstLayer :: Lens' c LayerTag
- keyOutDelay :: Lens' c (Maybe Milliseconds)
- keySinkDev :: Lens' c (Acquire KeySink)
- keySourceDev :: Lens' c (Acquire KeySource)
- keymapCfg :: Lens' c (LMap Button)
- startDelay :: Lens' c Milliseconds
class HasAppEnv c where
- appEnv :: Lens' c AppEnv
- dispatch :: Lens' c Dispatch
- inHooks :: Lens' c Hooks
- keAppCfg :: Lens' c AppCfg
- keLogFunc :: Lens' c LogFunc
- keySink :: Lens' c KeySink
- keySource :: Lens' c KeySource
- keymap :: Lens' c Keymap
- outHooks :: Lens' c Hooks
- outVar :: Lens' c (TMVar KeyEvent)
- sluice :: Lens' c Sluice
class HasKEnv c where
- kEnv :: Lens' c KEnv
- kAppEnv :: Lens' c AppEnv
- kBEnv :: Lens' c BEnv

Documentation

data AppCfg Source #

Record of all the configuration options required to run KMonad's core App loop.

Constructors

AppCfg

Fields

_keySinkDev :: Acquire KeySink
How to open a KeySink
_keySourceDev :: Acquire KeySource
How to open a KeySource
_keymapCfg :: LMap Button
The map defining the Button layout
_firstLayer :: LayerTag
Active layer when KMonad starts
_fallThrough :: Bool
Whether uncaught events should be emitted or not
_allowCmd :: Bool
Whether shell-commands are allowed
_startDelay :: Milliseconds
How long to wait before acquiring the input keyboard
_keyOutDelay :: Maybe Milliseconds
How long to wait after each key event outputted

Instances

Instances details

HasAppCfg AppCfg Source #

Instance details

Defined in KMonad.App.Types

Methods

appCfg :: Lens' AppCfg AppCfg Source #

allowCmd :: Lens' AppCfg Bool Source #

fallThrough :: Lens' AppCfg Bool Source #

firstLayer :: Lens' AppCfg LayerTag Source #

keyOutDelay :: Lens' AppCfg (Maybe Milliseconds) Source #

keySinkDev :: Lens' AppCfg (Acquire KeySink) Source #

keySourceDev :: Lens' AppCfg (Acquire KeySource) Source #

keymapCfg :: Lens' AppCfg (LMap Button) Source #

startDelay :: Lens' AppCfg Milliseconds Source #

data AppEnv Source #

Environment of a running KMonad app-loop

Constructors

AppEnv
Fields _keAppCfg :: AppCfg _keLogFunc :: LogFunc _keySink :: KeySink _keySource :: KeySource _dispatch :: Dispatch _inHooks :: Hooks _sluice :: Sluice _keymap :: Keymap _outHooks :: Hooks _outVar :: TMVar KeyEvent

Instances

Instances details

HasAppCfg AppEnv Source #
Instance details Defined in KMonad.App.Types Methods appCfg :: Lens' AppEnv AppCfg Source # allowCmd :: Lens' AppEnv Bool Source # fallThrough :: Lens' AppEnv Bool Source # firstLayer :: Lens' AppEnv LayerTag Source # keyOutDelay :: Lens' AppEnv (Maybe Milliseconds) Source # keySinkDev :: Lens' AppEnv (Acquire KeySink) Source # keySourceDev :: Lens' AppEnv (Acquire KeySource) Source # keymapCfg :: Lens' AppEnv (LMap Button) Source # startDelay :: Lens' AppEnv Milliseconds Source #
HasAppEnv AppEnv Source #
Instance details Defined in KMonad.App.Types Methods appEnv :: Lens' AppEnv AppEnv Source # dispatch :: Lens' AppEnv Dispatch Source # inHooks :: Lens' AppEnv Hooks Source # keAppCfg :: Lens' AppEnv AppCfg Source # keLogFunc :: Lens' AppEnv LogFunc Source # keySink :: Lens' AppEnv KeySink Source # keySource :: Lens' AppEnv KeySource Source # keymap :: Lens' AppEnv Keymap Source # outHooks :: Lens' AppEnv Hooks Source # outVar :: Lens' AppEnv (TMVar KeyEvent) Source # sluice :: Lens' AppEnv Sluice Source #
HasLogFunc AppEnv Source #
Instance details Defined in KMonad.App.Types Methods logFuncL :: Lens' AppEnv LogFunc #

data KEnv Source #

The complete environment capable of satisfying MonadK

Constructors

KEnv
Fields _kAppEnv :: AppEnv The app environment containing all the components _kBEnv :: BEnv The environment describing the currently active button

Instances

Instances details

HasAppCfg KEnv Source #
Instance details Defined in KMonad.App.Types Methods appCfg :: Lens' KEnv AppCfg Source # allowCmd :: Lens' KEnv Bool Source # fallThrough :: Lens' KEnv Bool Source # firstLayer :: Lens' KEnv LayerTag Source # keyOutDelay :: Lens' KEnv (Maybe Milliseconds) Source # keySinkDev :: Lens' KEnv (Acquire KeySink) Source # keySourceDev :: Lens' KEnv (Acquire KeySource) Source # keymapCfg :: Lens' KEnv (LMap Button) Source # startDelay :: Lens' KEnv Milliseconds Source #
HasAppEnv KEnv Source #
Instance details Defined in KMonad.App.Types Methods appEnv :: Lens' KEnv AppEnv Source # dispatch :: Lens' KEnv Dispatch Source # inHooks :: Lens' KEnv Hooks Source # keAppCfg :: Lens' KEnv AppCfg Source # keLogFunc :: Lens' KEnv LogFunc Source # keySink :: Lens' KEnv KeySink Source # keySource :: Lens' KEnv KeySource Source # keymap :: Lens' KEnv Keymap Source # outHooks :: Lens' KEnv Hooks Source # outVar :: Lens' KEnv (TMVar KeyEvent) Source # sluice :: Lens' KEnv Sluice Source #
HasKEnv KEnv Source #
Instance details Defined in KMonad.App.Types Methods kEnv :: Lens' KEnv KEnv Source # kAppEnv :: Lens' KEnv AppEnv Source # kBEnv :: Lens' KEnv BEnv Source #
HasBEnv KEnv Source #
Instance details Defined in KMonad.App.Types Methods bEnv :: Lens' KEnv BEnv Source # beButton :: Lens' KEnv Button Source # binding :: Lens' KEnv Keycode Source # lastSwitch :: Lens' KEnv (MVar Switch) Source #
HasLogFunc KEnv Source #
Instance details Defined in KMonad.App.Types Methods logFuncL :: Lens' KEnv LogFunc #
MonadK (RIO KEnv) Source #	Hook up all the components to the different `MonadK` functionalities
Instance details Defined in KMonad.App.Types Methods myBinding :: RIO KEnv Keycode Source #

class HasAppCfg c where Source #

Minimal complete definition

appCfg

Methods

appCfg :: Lens' c AppCfg Source #

allowCmd :: Lens' c Bool Source #

fallThrough :: Lens' c Bool Source #

firstLayer :: Lens' c LayerTag Source #

keyOutDelay :: Lens' c (Maybe Milliseconds) Source #

keySinkDev :: Lens' c (Acquire KeySink) Source #

keySourceDev :: Lens' c (Acquire KeySource) Source #

keymapCfg :: Lens' c (LMap Button) Source #

startDelay :: Lens' c Milliseconds Source #

Instances

Instances details

HasAppCfg AppCfg Source #
Instance details Defined in KMonad.App.Types Methods appCfg :: Lens' AppCfg AppCfg Source # allowCmd :: Lens' AppCfg Bool Source # fallThrough :: Lens' AppCfg Bool Source # firstLayer :: Lens' AppCfg LayerTag Source # keyOutDelay :: Lens' AppCfg (Maybe Milliseconds) Source # keySinkDev :: Lens' AppCfg (Acquire KeySink) Source # keySourceDev :: Lens' AppCfg (Acquire KeySource) Source # keymapCfg :: Lens' AppCfg (LMap Button) Source # startDelay :: Lens' AppCfg Milliseconds Source #
HasAppCfg AppEnv Source #
Instance details Defined in KMonad.App.Types Methods appCfg :: Lens' AppEnv AppCfg Source # allowCmd :: Lens' AppEnv Bool Source # fallThrough :: Lens' AppEnv Bool Source # firstLayer :: Lens' AppEnv LayerTag Source # keyOutDelay :: Lens' AppEnv (Maybe Milliseconds) Source # keySinkDev :: Lens' AppEnv (Acquire KeySink) Source # keySourceDev :: Lens' AppEnv (Acquire KeySource) Source # keymapCfg :: Lens' AppEnv (LMap Button) Source # startDelay :: Lens' AppEnv Milliseconds Source #
HasAppCfg KEnv Source #
Instance details Defined in KMonad.App.Types Methods appCfg :: Lens' KEnv AppCfg Source # allowCmd :: Lens' KEnv Bool Source # fallThrough :: Lens' KEnv Bool Source # firstLayer :: Lens' KEnv LayerTag Source # keyOutDelay :: Lens' KEnv (Maybe Milliseconds) Source # keySinkDev :: Lens' KEnv (Acquire KeySink) Source # keySourceDev :: Lens' KEnv (Acquire KeySource) Source # keymapCfg :: Lens' KEnv (LMap Button) Source # startDelay :: Lens' KEnv Milliseconds Source #

class HasAppEnv c where Source #

Minimal complete definition

appEnv

Methods

appEnv :: Lens' c AppEnv Source #

dispatch :: Lens' c Dispatch Source #

inHooks :: Lens' c Hooks Source #

keAppCfg :: Lens' c AppCfg Source #

keLogFunc :: Lens' c LogFunc Source #

keySink :: Lens' c KeySink Source #

keySource :: Lens' c KeySource Source #

keymap :: Lens' c Keymap Source #

outHooks :: Lens' c Hooks Source #

outVar :: Lens' c (TMVar KeyEvent) Source #

sluice :: Lens' c Sluice Source #

Instances

Instances details

HasAppEnv AppEnv Source #
Instance details Defined in KMonad.App.Types Methods appEnv :: Lens' AppEnv AppEnv Source # dispatch :: Lens' AppEnv Dispatch Source # inHooks :: Lens' AppEnv Hooks Source # keAppCfg :: Lens' AppEnv AppCfg Source # keLogFunc :: Lens' AppEnv LogFunc Source # keySink :: Lens' AppEnv KeySink Source # keySource :: Lens' AppEnv KeySource Source # keymap :: Lens' AppEnv Keymap Source # outHooks :: Lens' AppEnv Hooks Source # outVar :: Lens' AppEnv (TMVar KeyEvent) Source # sluice :: Lens' AppEnv Sluice Source #
HasAppEnv KEnv Source #
Instance details Defined in KMonad.App.Types Methods appEnv :: Lens' KEnv AppEnv Source # dispatch :: Lens' KEnv Dispatch Source # inHooks :: Lens' KEnv Hooks Source # keAppCfg :: Lens' KEnv AppCfg Source # keLogFunc :: Lens' KEnv LogFunc Source # keySink :: Lens' KEnv KeySink Source # keySource :: Lens' KEnv KeySource Source # keymap :: Lens' KEnv Keymap Source # outHooks :: Lens' KEnv Hooks Source # outVar :: Lens' KEnv (TMVar KeyEvent) Source # sluice :: Lens' KEnv Sluice Source #

class HasKEnv c where Source #

Minimal complete definition

kEnv

Methods

kEnv :: Lens' c KEnv Source #

kAppEnv :: Lens' c AppEnv Source #

kBEnv :: Lens' c BEnv Source #

Instances

Instances details

HasKEnv KEnv Source #
Instance details Defined in KMonad.App.Types Methods kEnv :: Lens' KEnv KEnv Source # kAppEnv :: Lens' KEnv AppEnv Source # kBEnv :: Lens' KEnv BEnv Source #

Orphan instances

(HasAppEnv e, HasAppCfg e, HasLogFunc e) => MonadKIO (RIO e) Source #
Instance details Methods emit :: KeyEvent -> RIO e () Source # pause :: Milliseconds -> RIO e () Source # hold :: Bool -> RIO e () Source # register :: HookLocation -> Hook (RIO e) -> RIO e () Source # layerOp :: LayerOp -> RIO e () Source # inject :: KeyEvent -> RIO e () Source # shellCmd :: Text -> RIO e () Source #