Workflow.Keys

Documentation

press :: (MonadWorkflow m, MonadThrow m) => String -> m ()

Parses and executes a keyboard shortcut. (via readKeySequence and sendKeyChord).

• more convenient than manually constructing Modifiers and Keys.
• but, (safely) partial

e.g. compare:

press "H-S-t H-l"

to:

traverse_ sendKeyChord'
 [ KeyChord [HyperModifier, ShiftModifier] TKey
 , KeyChord [HyperModifier) LKey
 ]

(a keyboard shortcut to "re-open tab, then jump to url bar")

throwMs on a "syntax error"

The default syntax is inspired by Emacs:

press = press' defaultKeyChordSyntax

readEmacsKeySequence :: String -> Maybe KeySequence

>>> readEmacsKeySequence "H-S-t H-l"
Just [([HyperModifier,ShiftModifier],TKey),([HyperModifier],LKey)]

=readEmacsKeySequence emacsKeyChordSyntax

readEmacsKeyChord :: String -> Maybe KeySequence

>>> readEmacsKeyChord "H-S-t"
Just ([HyperModifier,ShiftModifier],TKey)

=readEmacsKeyChord emacsKeyChordSyntax

readEmacsModifier :: String -> Maybe Modifier

>>> readEmacsModifier "H"
Just HyperModifier

=readModifier emacsModifierSyntax

readEmacsKey :: String -> Maybe KeyChord

>>> readEmacsKey "<tab>"
Just TabKey

=readKey emacsKeySyntax

press' :: (MonadWorkflow m, MonadThrow m) => KeyChordSyntax -> String -> m ()

Build your own press. e.g.

import Workflow.Core hiding (press)

press = press' KeyChordSyntax{..}

modifierSyntax :: ModifierSyntax
modifierSyntax = defaultModifierSyntax -- defaulting

keySyntax :: KeySyntax     -- overriding
keySyntax = Map.fromList
 [ ...
 ]

readKeySequence :: KeyChordSyntax -> String -> Maybe KeySequence

readKeyChord :: KeyChordSyntax -> [String] -> Maybe KeyChord

readModifier :: ModifierSyntax -> String -> Maybe Modifier

surjective, non-injective.

readKey :: KeySyntax -> String -> Maybe KeyChord

data KeyChordSyntax

A table for parsing strings of modifiers and keys.

Constructors

KeyChordSyntax

Fields

• modifierSyntax :: ModifierSyntax
• keySyntax :: KeySyntax

Instances

Eq KeyChordSyntax

Methods

(==) :: KeyChordSyntax -> KeyChordSyntax -> Bool

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

Data KeyChordSyntax

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> KeyChordSyntax -> c KeyChordSyntax

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c KeyChordSyntax

toConstr :: KeyChordSyntax -> Constr

dataTypeOf :: KeyChordSyntax -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c KeyChordSyntax)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c KeyChordSyntax)

gmapT :: (forall b. Data b => b -> b) -> KeyChordSyntax -> KeyChordSyntax

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> KeyChordSyntax -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> KeyChordSyntax -> r

gmapQ :: (forall d. Data d => d -> u) -> KeyChordSyntax -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> KeyChordSyntax -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> KeyChordSyntax -> m KeyChordSyntax

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> KeyChordSyntax -> m KeyChordSyntax

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> KeyChordSyntax -> m KeyChordSyntax

Ord KeyChordSyntax

Methods

compare :: KeyChordSyntax -> KeyChordSyntax -> Ordering

(<) :: KeyChordSyntax -> KeyChordSyntax -> Bool

(<=) :: KeyChordSyntax -> KeyChordSyntax -> Bool

(>) :: KeyChordSyntax -> KeyChordSyntax -> Bool

(>=) :: KeyChordSyntax -> KeyChordSyntax -> Bool

max :: KeyChordSyntax -> KeyChordSyntax -> KeyChordSyntax

min :: KeyChordSyntax -> KeyChordSyntax -> KeyChordSyntax

Read KeyChordSyntax

Methods

readsPrec :: Int -> ReadS KeyChordSyntax

readList :: ReadS [KeyChordSyntax]

readPrec :: ReadPrec KeyChordSyntax

readListPrec :: ReadPrec [KeyChordSyntax]

Show KeyChordSyntax

Methods

showsPrec :: Int -> KeyChordSyntax -> ShowS

show :: KeyChordSyntax -> String

showList :: [KeyChordSyntax] -> ShowS

Generic KeyChordSyntax

Associated Types

type Rep KeyChordSyntax :: * -> *

Methods

from :: KeyChordSyntax -> Rep KeyChordSyntax x

to :: Rep KeyChordSyntax x -> KeyChordSyntax

Monoid KeyChordSyntax

<> overrides (i.e. right-biased i.e. pick the last).

Methods

mempty :: KeyChordSyntax

mappend :: KeyChordSyntax -> KeyChordSyntax -> KeyChordSyntax

mconcat :: [KeyChordSyntax] -> KeyChordSyntax

NFData KeyChordSyntax

Methods

rnf :: KeyChordSyntax -> ()

type Rep KeyChordSyntax

type Rep KeyChordSyntax = D1 (MetaData "KeyChordSyntax" "Workflow.Keys" "workflow-types-0.0.1-JGyare4oGoo9KhFQEKiUml" False) (C1 (MetaCons "KeyChordSyntax" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "modifierSyntax") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ModifierSyntax)) (S1 (MetaSel (Just Symbol "keySyntax") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 KeySyntax))))

type ModifierSyntax = Map String Modifier

type KeySyntax = Map String KeyChord

defaultKeyChordSyntax :: KeyChordSyntax

= emacsKeyChordSyntax

defaultModifierSyntax :: ModifierSyntax

= emacsModifierSyntax

defaultKeySyntax :: KeySyntax

= emacsKeySyntax

emacsKeyChordSyntax :: KeyChordSyntax

= KeyChordSyntax defaultModifierSyntax defaultKeySyntax

emacsModifierSyntax :: ModifierSyntax

(see source)

emacsKeySyntax :: KeySyntax

follows Emacs keybinding syntax, with some differences:

• non-modifier uppercase alphabetic characters are not shifted, for consistency:

  • e.g. use M-S-a, not M-A
  • e.g. but M-: and "M-S-;" can both be used

• non-alphanumeric characters can be in angle brackets:

  • e.g. use C-<tab>, not C-TAB
  • e.g. but C-\t can be used

(see source)

addMods :: [Modifier] -> KeyChord -> KeyChord

appends modifiers

addMod :: Modifier -> KeyChord -> KeyChord

appends a modifier

char2keychord :: MonadThrow m => Char -> m KeyChord