yi-0.12.0: The Haskell-Scriptable Editor

Safe HaskellSafe-Inferred
  • UndecidableInstances
  • MonoLocalBinds
  • ScopedTypeVariables
  • OverloadedStrings
  • GADTs
  • GADTSyntax
  • TypeSynonymInstances
  • FlexibleInstances
  • MultiParamTypeClasses
  • FunctionalDependencies
  • ExplicitForAll
  • NondecreasingIndentation



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.



data I ev w a Source

Interactive process description


Alternative (I ev w) 
Monad (I event w) 
Functor (I event w) 
Eq w => MonadPlus (I event w) 
Applicative (I ev w) 
Eq w => MonadInteract (I event w) w event 

data P event w Source

Operational representation of a process


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


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

data InteractState event w Source

Abstraction of the automaton state.


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


Monoid (InteractState event w) 

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

Abstraction of monadic interactive processes


write :: w -> m () Source

Outputs a result.

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

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

adjustPriority :: Int -> m () Source


MonadInteract m w e => MonadInteract (StateT s m) w e 
Eq w => MonadInteract (I event w) w event 

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

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

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

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

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

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

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

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

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

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

Parses and returns the specified character.

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

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

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

Combines all parsers in the specified list.

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

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

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

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

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

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