vty-5.0.0: A simple terminal UI library

Safe HaskellNone
LanguageHaskell2010

Graphics.Vty.Input.Loop

Description

The input layer used to be a single function that correctly accounted for the non-threaded runtime by emulating the terminal VMIN adn VTIME handling. This has been removed and replace with a more straightforward parser. The non-threaded runtime is no longer supported.

This is an example of an algorithm where code coverage could be high, even 100%, but the behavior is still under tested. I should collect more of these examples...

Documentation

data Input Source

Constructors

Input 

Fields

_eventChannel :: Chan Event

Channel of events direct from input processing. Unlike nextEvent this will not refresh the display if the next event is an EvResize.

shutdownInput :: IO ()

Shuts down the input processing. This should return the terminal input state to before the input initialized.

_configRef :: IORef Config

Changes to this value are reflected after the next event.

_inputFd :: Fd

File descriptor used for input.

_inputDebug :: Maybe Handle

input debug log

inputFd :: Lens' Input Fd Source

inputDebug :: Lens' Input (Maybe Handle) Source

eventChannel :: Lens' Input (Chan Event) Source

configRef :: Lens' Input (IORef Config) Source

data InputBuffer Source

Constructors

InputBuffer 

Fields

_ptr :: Ptr Word8
 
_size :: Int
 

size :: Lens' InputBuffer Int Source

ptr :: Lens' InputBuffer (Ptr Word8) Source

data InputState Source

Constructors

InputState 

Fields

_unprocessedBytes :: String
 
_appliedConfig :: Config
 
_inputBuffer :: InputBuffer
 
_stopRequestRef :: IORef Bool
 
_classifier :: String -> KClass
 

unprocessedBytes :: Lens' InputState String Source

stopRequestRef :: Lens' InputState (IORef Bool) Source

inputBuffer :: Lens' InputState InputBuffer Source

classifier :: Lens' InputState (String -> KClass) Source

appliedConfig :: Lens' InputState Config Source

type InputM a = StateT InputState (ReaderT Input IO) a Source

logMsg :: String -> InputM () Source

loopInputProcessor :: InputM () Source

addBytesToProcess :: String -> InputM () Source

emit :: Event -> InputM () Source

readFromDevice :: InputM String Source

applyTimingConfig :: Fd -> Config -> IO () Source

parseEvent :: InputM Event Source

dropInvalid :: InputM () Source

stopIfRequested :: InputM () Source

runInputProcessorLoop :: ClassifyMap -> Input -> IORef Bool -> IO () Source

attributeControl :: Fd -> IO (IO (), IO ()) Source

logClassifyMap :: Input -> String -> ClassifyMap -> IO () Source

initInputForFd :: Config -> String -> ClassifyMap -> Fd -> IO Input Source

setTermTiming :: Fd -> Int -> Int -> IO () Source