Yi.Interact

This is a library of interactive processes combinators, usable to define extensible keymaps.

(Inspired by the Parsec library, written by Koen Claessen)

The processes are:

• composable: in parallel using <|>, in sequence using monadic bind.
• extensible: it is always possible to override a behaviour by combination of adjustPriority and <|>. (See also <|| for a convenient combination of the two.)
• monadic: sequencing is done via monadic bind. (leveraging the whole battery of monadic tools that Haskell provides)

The processes can parse input, and write output that depends on it.

The semantics are quite obvious; only disjunction deserve a bit more explanation:

in p = (a <|> b), what happens if a and b recognize the same input (prefix), but produce conflicting output?

• if the output is the same (as by the Eq class), then the processes (prefixes) are "merged"
• if a Write is more prioritized than the other, the one with low priority will be discarded
• otherwise, the output will be delayed until one of the branches can be discarded.
• if there is no way to disambiguate, then no output will be generated anymore. This situation can be detected by using possibleActions however.

Documentation

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 ()

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 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

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

write :: w -> m ()

Outputs a result.

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 ()

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

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

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

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

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

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

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

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

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

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.

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

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

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

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

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

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