KMonad.Args.Types

$bsc

type Parser = Parsec Void Text

Parser's operate on Text and carry no state

newtype PErrors

The type of errors returned by the Megaparsec parsers

Constructors

PErrors (ParseErrorBundle Text Void)

Instances

Show PErrors

Defined in KMonad.Args.Types

Methods

showsPrec :: Int -> PErrors -> ShowS

show :: PErrors -> String

showList :: [PErrors] -> ShowS

Exception PErrors

Defined in KMonad.Args.Types

Methods

toException :: PErrors -> SomeException

fromException :: SomeException -> Maybe PErrors

displayException :: PErrors -> String

$cfg

data CfgToken

The CfgToken contains all the data needed to construct an AppCfg.

Constructors

CfgToken

Fields

• _src :: LogFunc -> IO (Acquire KeySource)

  How to grab the source keyboard

• _snk :: LogFunc -> IO (Acquire KeySink)

  How to construct the out keybboard

• _km :: LMap Button

  An LMap of Button actions

• _fstL :: LayerTag

  Name of initial layer

• _flt :: Bool

  How to deal with unhandled events

• _allow :: Bool

  Whether to allow shell commands

$but

data DefButton

Button ADT

Constructors

KRef Text

Reference a named button

KEmit Keycode

Emit a keycode

KLayerToggle Text

Toggle to a layer when held

KLayerSwitch Text

Switch base-layer when pressed

KLayerAdd Text

Add a layer when pressed

KLayerRem Text

Remove top instance of a layer when pressed

KTapNext DefButton DefButton

Do 2 things based on behavior

KTapHold Int DefButton DefButton

Do 2 things based on behavior and delay

KTapHoldNext Int DefButton DefButton

Mixture between KTapNext and KTapHold

KTapNextRelease DefButton DefButton

Do 2 things based on behavior

KTapHoldNextRelease Int DefButton DefButton

Like KTapNextRelease but with a timeout

KAroundNext DefButton

Surround a future button

KMultiTap [(Int, DefButton)] DefButton

Do things depending on tap-count

KAround DefButton DefButton

Wrap 1 button around another

KTapMacro [DefButton]

Sequence of buttons to tap

KComposeSeq [DefButton]

Compose-key sequence

KPause Milliseconds

Pause for a period of time

KLayerDelay Int LayerTag

Switch to a layer for a period of time

KLayerNext LayerTag

Perform next button in different layer

KCommand Text

Execute a shell command

KTrans

Transparent button that does nothing

KBlock

Button that catches event

Instances

Show DefButton

Defined in KMonad.Args.Types

Methods

showsPrec :: Int -> DefButton -> ShowS

show :: DefButton -> String

showList :: [DefButton] -> ShowS

$tls

data DefSetting

All possible single settings

Constructors

SIToken IToken

SOToken OToken

SCmpSeq DefButton

SInitStr Text

SFallThrough Bool

SAllowCmd Bool

Instances

Show DefSetting

Defined in KMonad.Args.Types

Methods

showsPrec :: Int -> DefSetting -> ShowS

show :: DefSetting -> String

showList :: [DefSetting] -> ShowS

AsDefSetting DefSetting

Defined in KMonad.Args.Types

Methods

_DefSetting :: Prism' DefSetting DefSetting

_SIToken :: Prism' DefSetting IToken

_SOToken :: Prism' DefSetting OToken

_SCmpSeq :: Prism' DefSetting DefButton

_SInitStr :: Prism' DefSetting Text

_SFallThrough :: Prism' DefSetting Bool

_SAllowCmd :: Prism' DefSetting Bool

type DefSettings = [DefSetting]

A list of different DefSetting values

type DefAlias = [(Text, DefButton)]

A mapping from names to button tokens

data DefLayer

A layer of buttons

Constructors

DefLayer

Fields

• _layerName :: Text

  A unique name used to refer to this layer

• _buttons :: [DefButton]

  A list of button tokens

Instances

Show DefLayer

Defined in KMonad.Args.Types

Methods

showsPrec :: Int -> DefLayer -> ShowS

show :: DefLayer -> String

showList :: [DefLayer] -> ShowS

type DefSrc = [Keycode]

A list of keycodes describing the ordering of all the other layers

data KExpr

Any statement in a config-file must parse to a KExpr

Constructors

KDefCfg DefSettings

KDefSrc DefSrc

KDefLayer DefLayer

KDefAlias DefAlias

Instances

Show KExpr

Defined in KMonad.Args.Types

Methods

showsPrec :: Int -> KExpr -> ShowS

show :: KExpr -> String

showList :: [KExpr] -> ShowS

AsKExpr KExpr

Defined in KMonad.Args.Types

Methods

_KExpr :: Prism' KExpr KExpr

_KDefCfg :: Prism' KExpr DefSettings

_KDefSrc :: Prism' KExpr DefSrc

_KDefLayer :: Prism' KExpr DefLayer

_KDefAlias :: Prism' KExpr DefAlias

$defio

data IToken

All different input-tokens KMonad can take

Constructors

KDeviceSource FilePath

KLowLevelHookSource

KIOKitSource (Maybe Text)

Instances

Show IToken

Defined in KMonad.Args.Types

Methods

showsPrec :: Int -> IToken -> ShowS

show :: IToken -> String

showList :: [IToken] -> ShowS

data OToken

All different output-tokens KMonad can take

Constructors

KUinputSink Text (Maybe Text)

KSendEventSink

KKextSink

Instances

Show OToken

Defined in KMonad.Args.Types

Methods

showsPrec :: Int -> OToken -> ShowS

show :: OToken -> String

showList :: [OToken] -> ShowS

$lenses

class AsKExpr r where

Minimal complete definition

_KExpr

Methods

_KExpr :: Prism' r KExpr

_KDefCfg :: Prism' r DefSettings

_KDefSrc :: Prism' r DefSrc

_KDefLayer :: Prism' r DefLayer

_KDefAlias :: Prism' r DefAlias

Instances

AsKExpr KExpr

Defined in KMonad.Args.Types

Methods

_KExpr :: Prism' KExpr KExpr

_KDefCfg :: Prism' KExpr DefSettings

_KDefSrc :: Prism' KExpr DefSrc

_KDefLayer :: Prism' KExpr DefLayer

_KDefAlias :: Prism' KExpr DefAlias

class AsDefSetting r where

Minimal complete definition

_DefSetting

Methods

_DefSetting :: Prism' r DefSetting

_SIToken :: Prism' r IToken

_SOToken :: Prism' r OToken

_SCmpSeq :: Prism' r DefButton

_SInitStr :: Prism' r Text

_SFallThrough :: Prism' r Bool

_SAllowCmd :: Prism' r Bool

Instances

AsDefSetting DefSetting

Defined in KMonad.Args.Types

Methods

_DefSetting :: Prism' DefSetting DefSetting

_SIToken :: Prism' DefSetting IToken

_SOToken :: Prism' DefSetting OToken

_SCmpSeq :: Prism' DefSetting DefButton

_SInitStr :: Prism' DefSetting Text

_SFallThrough :: Prism' DefSetting Bool

_SAllowCmd :: Prism' DefSetting Bool

Reexports

module Text.Megaparsec

module Text.Megaparsec.Char