Yi.Keymap.Keys

Combinators for building keymaps.

Documentation

data Event

Constructors

Event Key [Modifier]

Instances

Eq Event

Defined in Yi.Event

Methods

(==) :: Event -> Event -> Bool

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

Ord Event

Defined in Yi.Event

Methods

compare :: Event -> Event -> Ordering

(<) :: Event -> Event -> Bool

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

(>) :: Event -> Event -> Bool

(>=) :: Event -> Event -> Bool

max :: Event -> Event -> Event

min :: Event -> Event -> Event

Show Event

Defined in Yi.Event

Methods

showsPrec :: Int -> Event -> ShowS

show :: Event -> String

showList :: [Event] -> ShowS

data Key

Constructors

KEsc

KFun Int

KPrtScr

KPause

KASCII Char

KBS

KIns

KHome

KPageUp

KDel

KEnd

KPageDown

KNP5

KUp

KMenu

KLeft

KDown

KRight

KEnter

KTab

Instances

Eq Key

Defined in Yi.Event

Methods

(==) :: Key -> Key -> Bool

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

Ord Key

Defined in Yi.Event

Methods

compare :: Key -> Key -> Ordering

(<) :: Key -> Key -> Bool

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

(>) :: Key -> Key -> Bool

(>=) :: Key -> Key -> Bool

max :: Key -> Key -> Key

min :: Key -> Key -> Key

Show Key

Defined in Yi.Event

Methods

showsPrec :: Int -> Key -> ShowS

show :: Key -> String

showList :: [Key] -> ShowS

data Modifier

Constructors

MShift

MCtrl

MMeta

MSuper

MHyper

Instances

Eq Modifier

Defined in Yi.Event

Methods

(==) :: Modifier -> Modifier -> Bool

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

Ord Modifier

Defined in Yi.Event

Methods

compare :: Modifier -> Modifier -> Ordering

(<) :: Modifier -> Modifier -> Bool

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

(>) :: Modifier -> Modifier -> Bool

(>=) :: Modifier -> Modifier -> Bool

max :: Modifier -> Modifier -> Modifier

min :: Modifier -> Modifier -> Modifier

Show Modifier

Defined in Yi.Event

Methods

showsPrec :: Int -> Modifier -> ShowS

show :: Modifier -> String

showList :: [Modifier] -> ShowS

prettyEvent :: Event -> String

eventToChar :: Event -> Char

Map an Event to a Char. This is used in the emacs keymap for Ctrl-Q and vim keymap insertSpecialChar

data InteractState event w

Abstraction of the automaton state.

Constructors

Ambiguous [(Int, w, P event w)]

Waiting

Dead

Running w (P event w)

Instances

Semigroup (InteractState event w)

Defined in Yi.Interact

Methods

(<>) :: InteractState event w -> InteractState event w -> InteractState event w

sconcat :: NonEmpty (InteractState event w) -> InteractState event w

stimes :: Integral b => b -> InteractState event w -> InteractState event w

Monoid (InteractState event w)

Defined in Yi.Interact

Methods

mempty :: InteractState event w

mappend :: InteractState event w -> InteractState event w -> InteractState event w

mconcat :: [InteractState event w] -> InteractState event w

data P event w

Operational representation of a process

Constructors

End

(Show mid, Eq mid) => Chain (P event mid) (P mid w)

Instances

(Show w, Show ev) => Show (P ev w)

Defined in Yi.Interact

Methods

showsPrec :: Int -> P ev w -> ShowS

show :: P ev w -> String

showList :: [P ev w] -> ShowS

data I ev w a

Interactive process description

Instances

Monad (I event w)

Defined in Yi.Interact

Methods

(>>=) :: I event w a -> (a -> I event w b) -> I event w b

(>>) :: I event w a -> I event w b -> I event w b

return :: a -> I event w a

fail :: String -> I event w a

Functor (I event w)

Defined in Yi.Interact

Methods

fmap :: (a -> b) -> I event w a -> I event w b

(<$) :: a -> I event w b -> I event w a

Applicative (I ev w)

Defined in Yi.Interact

Methods

pure :: a -> I ev w a

(<*>) :: I ev w (a -> b) -> I ev w a -> I ev w b

liftA2 :: (a -> b -> c) -> I ev w a -> I ev w b -> I ev w c

(*>) :: I ev w a -> I ev w b -> I ev w b

(<*) :: I ev w a -> I ev w b -> I ev w a

Alternative (I ev w)

Defined in Yi.Interact

Methods

empty :: I ev w a

(<|>) :: I ev w a -> I ev w a -> I ev w a

some :: I ev w a -> I ev w [a]

many :: I ev w a -> I ev w [a]

Eq w => MonadPlus (I event w)

Defined in Yi.Interact

Methods

mzero :: I event w a

mplus :: I event w a -> I event w a -> I event w a

Eq w => MonadInteract (I event w) w event

Defined in Yi.Interact

Methods

write :: w -> I event w ()

eventBounds :: Maybe event -> Maybe event -> I event w event

adjustPriority :: Int -> I event w ()

class (Eq w, Monad m, Alternative m, Applicative m, MonadPlus m) => MonadInteract m w e | m -> w e where

Abstraction of monadic interactive processes

Minimal complete definition

write, eventBounds, adjustPriority

Methods

eventBounds :: Ord e => Maybe e -> Maybe e -> m e

Consumes and returns the next character. Fails if there is no input left, or outside the given bounds.

adjustPriority :: Int -> m ()

Instances

MonadInteract m w e => MonadInteract (StateT s m) w e

Defined in Yi.Interact

Methods

write :: w -> StateT s m ()

eventBounds :: Maybe e -> Maybe e -> StateT s m e

adjustPriority :: Int -> StateT s m ()

Eq w => MonadInteract (I event w) w event

Defined in Yi.Interact

Methods

write :: w -> I event w ()

eventBounds :: Maybe event -> Maybe event -> I event w event

adjustPriority :: Int -> I event w ()

deprioritize :: MonadInteract f w e => f ()

(<||) :: MonadInteract f w e => f a -> f a -> f a infixl 3

(||>) :: MonadInteract f w e => f a -> f a -> f a

important :: MonadInteract f w e => f a -> f a -> f a

Just like '(<||)' but in prefix form. It deprioritizes the second argument.

accepted :: Show ev => Int -> P ev w -> [[Text]]

runWrite :: Eq w => P event w -> [event] -> [w]

processOneEvent :: Eq w => P event w -> event -> ([w], P event w)

computeState :: Eq w => P event w -> InteractState event w

oneOf :: (Ord event, MonadInteract m w event) => [event] -> m event

anyEvent :: (Ord event, MonadInteract m w event) => m event

eventBetween :: (Ord e, MonadInteract m w e) => e -> e -> m e

event :: (Ord event, MonadInteract m w event) => event -> m event

Parses and returns the specified character.

events :: (Ord event, MonadInteract m w event) => [event] -> m [event]

Parses and returns the specified list of events (lazily).

choice :: MonadInteract m w e => [m a] -> m a

Combines all parsers in the specified list.

option :: MonadInteract m w e => a -> m a -> m a

option x p will either parse p or return x without consuming any input.

mkAutomaton :: Eq w => I ev w a -> P ev w

idAutomaton :: (Ord a, Eq a) => P a a

printableChar :: MonadInteract m w Event => m Char

textChar :: KeymapM Char

Parse any character that can be inserted in the text.

charOf :: MonadInteract m w Event => (Event -> Event) -> Char -> Char -> m Char

shift :: Event -> Event

meta :: Event -> Event

ctrl :: Event -> Event

super :: Event -> Event

hyper :: Event -> Event

spec :: Key -> Event

Convert a special key into an event

char :: Char -> Event

(>>!) :: (MonadInteract m Action Event, YiAction a x, Show x) => m b -> a -> m () infixl 1

p >>! act = p >> 'write' act

(>>=!) :: (MonadInteract m Action Event, YiAction a x, Show x) => m b -> (b -> a) -> m () infixl 1

p >>=! act = p >>= 'write' . act

(?>>) :: MonadInteract m action Event => Event -> m a -> m a infixr 0

 ev ?>> proc = event ev >> proc

(?>>!) :: (MonadInteract m Action Event, YiAction a x, Show x) => Event -> a -> m () infixr 0

 ev ?>>! act = event ev >> write act

(?*>>) :: MonadInteract m action Event => [Event] -> m a -> m a infixr 0

 ev ?*>> proc = events ev >> proc

(?*>>!) :: (MonadInteract m Action Event, YiAction a x, Show x) => [Event] -> a -> m () infixr 0

 ev ?*>>! act = events ev >> write act

ctrlCh :: Char -> Event

metaCh :: Char -> Event

hyperCh :: Char -> Event

optMod :: MonadInteract m w Event => (Event -> Event) -> Event -> m Event

optMod f ev produces a MonadInteract that consumes ev or f ev

pString :: MonadInteract m w Event => String -> m [Event]