Safe Haskell | Safe-Inferred |
---|---|
Language | Haskell2010 |
This module provides a reactive-banana
FRP interface to termbox
, a simple C library for writing text-based user
interfaces: https://github.com/termbox/termbox
See also:
termbox-tea
, an Elm Architecture interface.
👉 Quick start example
This termbox
program displays the number of keys pressed.
{-# LANGUAGE BlockArguments #-} {-# LANGUAGE DuplicateRecordFields #-} {-# LANGUAGE ImportQualifiedPost #-} {-# LANGUAGE LambdaCase #-} {-# LANGUAGE OverloadedRecordDot #-} module Main (main) where import Data.Foldable (fold) import Data.Function ((&)) import Reactive.Banana ((<@>)) import Reactive.Banana qualified as Banana import Termbox.Banana qualified as Termbox main :: IO () main = do result <- Termbox.run
network putStrLn case result of Left err -> "Termbox program failed to initialize: " ++ show err Right state -> "Final state: " ++ show state network :: (Banana.MonadMoment m) => Termbox.Inputs
-> m (Termbox.Outputs
Int) network inputs = do keysPressed <- Banana.accumB 0 ((+ 1) <$ inputs.keys) pure Termbox.Outputs
{ scene = render <$> keysPressed, done = Banana.filterJust (isDone <$> keysPressed <@> inputs.keys) } where isDone :: Int -> Termbox.Key
-> Maybe Int isDone n = \case Termbox.KeyEsc
-> Just n _ -> Nothing render :: Int -> Termbox.Scene
render keysPressed = fold [ string ("Number of keys pressed: " ++ show keysPressed), fold [ string "Press", string "Esc" & Termbox.bold
& Termbox.atCol
6, string "to quit." & Termbox.atCol
10 ] & Termbox.atRow
2 ] & Termbox.at
Termbox.Pos
{row = 2, col = 4} & Termbox.image
string :: [Char] -> Termbox.Image
string chars = zip [0 ..] chars & foldMap \(i, char) -> Termbox.char
char & Termbox.atCol
i
Synopsis
- data Inputs = Inputs {}
- data Outputs a = Outputs {}
- run :: (Inputs -> MomentIO (Outputs a)) -> IO (Either InitError a)
- data InitError
- data Scene
- image :: Image -> Scene
- fill :: Color -> Scene -> Scene
- cursor :: Pos -> Scene -> Scene
- data Image
- char :: Char -> Image
- fg :: Color -> Image -> Image
- bg :: Color -> Image -> Image
- bold :: Image -> Image
- underline :: Image -> Image
- blink :: Image -> Image
- at :: Pos -> Image -> Image
- atRow :: Int -> Image -> Image
- atCol :: Int -> Image -> Image
- data Color
- defaultColor :: Color
- red :: Color
- green :: Color
- yellow :: Color
- blue :: Color
- magenta :: Color
- cyan :: Color
- white :: Color
- bright :: Color -> Color
- color :: Int -> Color
- gray :: Int -> Color
- data Key where
- KeyChar !Char
- KeyArrowDown
- KeyArrowLeft
- KeyArrowRight
- KeyArrowUp
- KeyBackspace
- KeyCtrlBackspace
- KeyCtrl6
- KeyCtrl8
- KeyCtrlA
- KeyCtrlB
- KeyCtrlBackslash
- KeyCtrlC
- KeyCtrlD
- KeyCtrlE
- KeyCtrlF
- KeyCtrlG
- KeyCtrlJ
- KeyCtrlK
- KeyCtrlL
- KeyCtrlN
- KeyCtrlO
- KeyCtrlP
- KeyCtrlQ
- KeyCtrlR
- KeyCtrlRsqBracket
- KeyCtrlS
- KeyCtrlSlash
- KeyCtrlTilde
- KeyCtrlT
- KeyCtrlU
- KeyCtrlV
- KeyCtrlW
- KeyCtrlX
- KeyCtrlY
- KeyCtrlZ
- KeyDelete
- KeyEnd
- KeyEnter
- KeyEsc
- KeyF1
- KeyF10
- KeyF11
- KeyF12
- KeyF2
- KeyF3
- KeyF4
- KeyF5
- KeyF6
- KeyF7
- KeyF8
- KeyF9
- KeyHome
- KeyInsert
- KeyPageDn
- KeyPageUp
- KeySpace
- KeyTab
- pattern KeyCtrlUnderscore :: Key
- pattern KeyCtrlI :: Key
- pattern KeyCtrlM :: Key
- pattern KeyCtrl7 :: Key
- pattern KeyCtrl5 :: Key
- pattern KeyCtrl4 :: Key
- pattern KeyCtrl3 :: Key
- pattern KeyCtrl2 :: Key
- pattern KeyCtrlLsqBracket :: Key
- pattern KeyCtrlH :: Key
- data Mouse = Mouse {
- button :: !MouseButton
- pos :: !Pos
- data MouseButton where
- pattern WheelUp :: MouseButton
- pattern WheelDown :: MouseButton
- pattern ReleaseClick :: MouseButton
- pattern RightClick :: MouseButton
- pattern MiddleClick :: MouseButton
- pattern LeftClick :: MouseButton
- data Pos = Pos {}
- posUp :: Int -> Pos -> Pos
- posDown :: Int -> Pos -> Pos
- posLeft :: Int -> Pos -> Pos
- posRight :: Int -> Pos -> Pos
- data Size = Size {}
Main
The inputs to a termbox
FRP network.
The outputs from a termbox
FRP network.
:: (Inputs -> MomentIO (Outputs a)) | The FRP network. |
-> IO (Either InitError a) | The result of the FRP network. |
Run a termbox
FRP network.
run
either:
- Returns immediately with an
InitError
. - Returns the first value emitted by
done
.
termbox
initialization errors.
Instances
Exception InitError | |
Defined in Termbox.Internal.Main toException :: InitError -> SomeException # fromException :: SomeException -> Maybe InitError # displayException :: InitError -> String # | |
Show InitError | |
Terminal contents
Scene
Image
An image.
Instances
Create an image from a character.
If the character is not 1 character wide, it will not be displayed.
Color
Style
Translation
Colors
A color.
There are three classes of colors:
Basic colors
defaultColor :: Color #
216 miscellaneous colors
A miscellaneous color.
Valid values are in the range [0, 215]
; values outside of this range are clamped.
24 monochrome colors
A monochrome color; black is 0 and white is 23.
Valid values are in the range [0, 23]
; values outside of this range are clamped.
Event handling
A key event.
Some distinct key sequences map to the same key event. For example, to a termbox
program, Enter
is
indistinguishable from Ctrl+M
. Pattern synonyms below are provided for an alternate syntax in these cases, if
desired.
pattern KeyCtrlUnderscore :: Key | |
pattern KeyCtrlI :: Key | |
pattern KeyCtrlM :: Key | |
pattern KeyCtrl7 :: Key | |
pattern KeyCtrl5 :: Key | |
pattern KeyCtrl4 :: Key | |
pattern KeyCtrl3 :: Key | |
pattern KeyCtrl2 :: Key | |
pattern KeyCtrlLsqBracket :: Key | |
pattern KeyCtrlH :: Key |
A mouse event.
Mouse | |
|
Instances
Generic Mouse | |
Show Mouse | |
Eq Mouse | |
Ord Mouse | |
type Rep Mouse | |
Defined in Termbox.Internal.Mouse type Rep Mouse = D1 ('MetaData "Mouse" "Termbox.Internal.Mouse" "termbox-2.0.0-inplace" 'False) (C1 ('MetaCons "Mouse" 'PrefixI 'True) (S1 ('MetaSel ('Just "button") 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 MouseButton) :*: S1 ('MetaSel ('Just "pos") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Pos))) |
data MouseButton where #
A mouse button.
pattern WheelUp :: MouseButton | |
pattern WheelDown :: MouseButton | |
pattern ReleaseClick :: MouseButton | |
pattern RightClick :: MouseButton | |
pattern MiddleClick :: MouseButton | |
pattern LeftClick :: MouseButton |
Instances
Show MouseButton | |
Defined in Termbox.Internal.Mouse showsPrec :: Int -> MouseButton -> ShowS # show :: MouseButton -> String # showList :: [MouseButton] -> ShowS # | |
Eq MouseButton | |
Defined in Termbox.Internal.Mouse (==) :: MouseButton -> MouseButton -> Bool # (/=) :: MouseButton -> MouseButton -> Bool # | |
Ord MouseButton | |
Defined in Termbox.Internal.Mouse compare :: MouseButton -> MouseButton -> Ordering # (<) :: MouseButton -> MouseButton -> Bool # (<=) :: MouseButton -> MouseButton -> Bool # (>) :: MouseButton -> MouseButton -> Bool # (>=) :: MouseButton -> MouseButton -> Bool # max :: MouseButton -> MouseButton -> MouseButton # min :: MouseButton -> MouseButton -> MouseButton # |
Miscellaneous types
A relative terminal position.
Instances
Monoid Pos | |
Semigroup Pos | |
Generic Pos | |
Show Pos | |
Eq Pos | |
Ord Pos | |
type Rep Pos | |
Defined in Termbox.Internal.Pos type Rep Pos = D1 ('MetaData "Pos" "Termbox.Internal.Pos" "termbox-2.0.0-inplace" 'False) (C1 ('MetaCons "Pos" 'PrefixI 'True) (S1 ('MetaSel ('Just "row") 'SourceUnpack 'SourceStrict 'DecidedUnpack) (Rec0 Int) :*: S1 ('MetaSel ('Just "col") 'SourceUnpack 'SourceStrict 'DecidedUnpack) (Rec0 Int))) |
A terminal size.
Instances
Generic Size | |
Show Size | |
Eq Size | |
Ord Size | |
type Rep Size | |
Defined in Termbox.Internal.Size type Rep Size = D1 ('MetaData "Size" "Termbox.Internal.Size" "termbox-2.0.0-inplace" 'False) (C1 ('MetaCons "Size" 'PrefixI 'True) (S1 ('MetaSel ('Just "width") 'SourceUnpack 'SourceStrict 'DecidedUnpack) (Rec0 Int) :*: S1 ('MetaSel ('Just "height") 'SourceUnpack 'SourceStrict 'DecidedUnpack) (Rec0 Int))) |