KMonad.Action

KMonad is implemented as an engine that is capable of running MonadK actions. The logic of various different buttons and keyboard operations are expressed in this MonadK. This module defines the basic types and operations that make up MonadK. The implementation of how KMonad implements MonadK can be found in the KMonad.App module.

NOTE: All of this is a bit muddled, and redoing the way hooks are handled, and the basic structuring of MonadK and MonadKIO are liable to change soon.

Documentation

type KeyPred = KeyEvent -> Bool

Predicate on KeyEvent's

data Catch

Boolean isomorph signalling wether an event should be caught or not

Constructors

Catch

NoCatch

Instances

Eq Catch

Defined in KMonad.Action

Methods

(==) :: Catch -> Catch -> Bool

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

Show Catch

Defined in KMonad.Action

Methods

showsPrec :: Int -> Catch -> ShowS

show :: Catch -> String

showList :: [Catch] -> ShowS

Semigroup Catch

Defined in KMonad.Action

Methods

(<>) :: Catch -> Catch -> Catch

sconcat :: NonEmpty Catch -> Catch

stimes :: Integral b => b -> Catch -> Catch

Monoid Catch

Defined in KMonad.Action

Methods

mempty :: Catch

mappend :: Catch -> Catch -> Catch

mconcat :: [Catch] -> Catch

data Trigger

The packet used to trigger a KeyFun, containing info about the event and how long since the Hook was registered.

Constructors

Trigger

Fields

• _elapsed :: Milliseconds

  Time elapsed since hook was registered

• _event :: KeyEvent

  The key event triggering this call

Instances

HasTrigger Trigger

Defined in KMonad.Action

Methods

trigger :: Lens' Trigger Trigger

elapsed :: Lens' Trigger Milliseconds

event :: Lens' Trigger KeyEvent

data Timeout m

A Timeout value describes how long to wait and what to do upon timeout

Constructors

Timeout

Fields

• _delay :: Milliseconds

  Delay before timeout action is triggered

• _action :: m ()

  Action to perform upon timeout

Instances

HasTimeout (Timeout m) m

Defined in KMonad.Action

Methods

timeout :: Lens' (Timeout m) (Timeout m)

action :: Lens' (Timeout m) (m ())

delay :: Lens' (Timeout m) Milliseconds

data HookLocation

ADT signalling where to install a hook

Constructors

InputHook

Install the hook immediately after receiving a KeyEvent

OutputHook

Install the hook just before emitting a KeyEvent

Instances

Eq HookLocation

Defined in KMonad.Action

Methods

(==) :: HookLocation -> HookLocation -> Bool

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

Show HookLocation

Defined in KMonad.Action

Methods

showsPrec :: Int -> HookLocation -> ShowS

show :: HookLocation -> String

showList :: [HookLocation] -> ShowS

data Hook m

The content for 1 key hook

Constructors

Hook

Fields

• _hTimeout :: Maybe (Timeout m)

  Optional timeout machinery

• _keyH :: Trigger -> m Catch

  The function to call on the next KeyEvent

Instances

HasHook (Hook m) m

Defined in KMonad.Action

Methods

hook :: Lens' (Hook m) (Hook m)

hTimeout :: Lens' (Hook m) (Maybe (Timeout m))

keyH :: Lens' (Hook m) (Trigger -> m Catch)

Lenses

class HasHook c m | c -> m where

Minimal complete definition

hook

Methods

hook :: Lens' c (Hook m)

hTimeout :: Lens' c (Maybe (Timeout m))

keyH :: Lens' c (Trigger -> m Catch)

Instances

HasHook (Hook m) m

Defined in KMonad.Action

Methods

hook :: Lens' (Hook m) (Hook m)

hTimeout :: Lens' (Hook m) (Maybe (Timeout m))

keyH :: Lens' (Hook m) (Trigger -> m Catch)

class HasTimeout c m | c -> m where

Minimal complete definition

timeout

Methods

timeout :: Lens' c (Timeout m)

action :: Lens' c (m ())

delay :: Lens' c Milliseconds

Instances

HasTimeout (Timeout m) m

Defined in KMonad.Action

Methods

timeout :: Lens' (Timeout m) (Timeout m)

action :: Lens' (Timeout m) (m ())

delay :: Lens' (Timeout m) Milliseconds

class HasTrigger c where

Minimal complete definition

trigger

Methods

trigger :: Lens' c Trigger

elapsed :: Lens' c Milliseconds

event :: Lens' c KeyEvent

Instances

HasTrigger Trigger

Defined in KMonad.Action

Methods

trigger :: Lens' Trigger Trigger

elapsed :: Lens' Trigger Milliseconds

event :: Lens' Trigger KeyEvent

Layer operations

Operations that manipulate the layer-stack

data LayerOp

LayerOp describes all the different layer-manipulations that KMonad supports.

Constructors

PushLayer LayerTag

Add a layer to the top of the stack

PopLayer LayerTag

Remove the first occurence of a layer

SetBaseLayer LayerTag

Change the base-layer

MonadK

The fundamental components that make up any Button operation.

class Monad m => MonadKIO m where

MonadK contains all the operations used to constitute button actions. It encapsulates all the side-effects required to get everything running.

Methods

emit :: KeyEvent -> m ()

Emit a KeyEvent to the OS

pause :: Milliseconds -> m ()

Pause the current thread for n milliseconds

hold :: Bool -> m ()

Pause or unpause event processing

register :: HookLocation -> Hook m -> m ()

Register a callback hook

layerOp :: LayerOp -> m ()

Run a layer-stack manipulation

inject :: KeyEvent -> m ()

Insert an event in the input queue

shellCmd :: Text -> m ()

Run a shell-command

Instances

(HasAppEnv e, HasAppCfg e, HasLogFunc e) => MonadKIO (RIO e)

Defined in KMonad.App

Methods

emit :: KeyEvent -> RIO e ()

pause :: Milliseconds -> RIO e ()

hold :: Bool -> RIO e ()

register :: HookLocation -> Hook (RIO e) -> RIO e ()

layerOp :: LayerOp -> RIO e ()

inject :: KeyEvent -> RIO e ()

shellCmd :: Text -> RIO e ()

class MonadKIO m => MonadK m where

MonadKIO contains the additional bindings that get added when we are currently processing a button.

Methods

myBinding :: m Keycode

Access the keycode to which the current button is bound

type AnyK a = forall m. MonadK m => m a

Type alias for `any monad that can perform MonadK actions`

newtype Action

A newtype wrapper used to construct MonadK actions

Constructors

Action

Fields

• runAction :: AnyK ()

Constituted actions

my :: MonadK m => Switch -> m KeyEvent

Create a KeyEvent matching pressing or releasing of the current button.

matchMy :: MonadK m => Switch -> m KeyPred

Create a KeyPred that matches the Press or Release of the current button.

after :: MonadK m => Milliseconds -> m () -> m ()

Perform an action after a period of time has elapsed

This is essentially just a way to perform async actions using the KMonad hook system.

whenDone :: MonadK m => m () -> m ()

Perform an action immediately after the current action is finished. NOTE: there is no guarantee that another event doesn't outrace this, only that it will happen as soon as the CPU gets to it.

await :: MonadKIO m => KeyPred -> (KeyEvent -> m Catch) -> m ()

Wait for an event to match a predicate and then execute an action

awaitMy :: MonadK m => Switch -> m Catch -> m ()

Execute an action on the detection of the Switch of the active button.

tHookF

Arguments

:: MonadK m

=> HookLocation

Where to install the hook

-> Milliseconds

The timeout delay for the hook

-> m ()

The action to perform on timeout

-> (Trigger -> m Catch)

The action to perform on trigger

-> m ()

The resulting action

Register a hook with a timeout

hookF :: MonadKIO m => HookLocation -> (KeyEvent -> m Catch) -> m ()

Register a simple hook without a timeout

within

Arguments

:: MonadK m

=> Milliseconds

The time within which this filter is active

-> m KeyPred

The predicate used to find a match

-> m ()

The action to call on timeout

-> (Trigger -> m Catch)

The action to call on a succesful match

-> m ()

The resulting action

Try to call a function on a succesful match of a predicate within a certain time period. On a timeout, perform an action.

withinHeld

Arguments

:: MonadK m

=> Milliseconds

The time within which this filter is active

-> m KeyPred

The predicate used to find a match

-> m ()

The action to call on timeout

-> (Trigger -> m Catch)

The action to call on a succesful match

-> m ()

The resulting action

Like within, but acquires a hold when starting, and releases when done