TinyApp.Interactive

Build interactice apps that reacts to each keystroke and renders text Requires `ghc-options: -threaded`

Documentation

data Event

Event the application can receive

Constructors

Key Key [Modifier]

data Key

Representes keys that can be pressed

Constructors

KEsc

KChar Char

KBS

KEnter

KLeft

KRight

KUp

KDown

KUpLeft

KUpRight

KDownLeft

KDownRight

KCenter

KFun Int

KBackTab

KPrtScr

KPause

KIns

KHome

KPageUp

KDel

KEnd

KPageDown

KBegin

KMenu

Instances

Read Key

Defined in TinyApp.Interactive

Methods

readsPrec :: Int -> ReadS Key

readList :: ReadS [Key]

readPrec :: ReadPrec Key

readListPrec :: ReadPrec [Key]

Show Key

Defined in TinyApp.Interactive

Methods

showsPrec :: Int -> Key -> ShowS

show :: Key -> String

showList :: [Key] -> ShowS

Eq Key

Defined in TinyApp.Interactive

Methods

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

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

Ord Key

Defined in TinyApp.Interactive

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

data Modifier

Modifiers keys

Constructors

MShift

MCtrl

MMeta

MAlt

Instances

Read Modifier

Defined in TinyApp.Interactive

Methods

readsPrec :: Int -> ReadS Modifier

readList :: ReadS [Modifier]

readPrec :: ReadPrec Modifier

readListPrec :: ReadPrec [Modifier]

Show Modifier

Defined in TinyApp.Interactive

Methods

showsPrec :: Int -> Modifier -> ShowS

show :: Modifier -> String

showList :: [Modifier] -> ShowS

Eq Modifier

Defined in TinyApp.Interactive

Methods

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

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

Ord Modifier

Defined in TinyApp.Interactive

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

data Sandbox state

Defines an interactive application that is not allowed to perform arbitrary IO while executing.

Constructors

Sandbox

Fields

• initialize :: state

  Initial state

• render :: state -> String

  What to draw based on the current state. The screen is cleared between render calls. Usually use 'n' or *Prelude.unlines* to render multiple lines.

• update :: Event -> state -> (state, ContinueExit)

  Process the event given the current state Returns the next state and whether to continue or not the program

data ContinueExit

Signals whether the application should continue waiting input from the user or exit.

Constructors

Continue

Exit

Instances

Show ContinueExit

Defined in TinyApp.Interactive

Methods

showsPrec :: Int -> ContinueExit -> ShowS

show :: ContinueExit -> String

showList :: [ContinueExit] -> ShowS

Eq ContinueExit

Defined in TinyApp.Interactive

Methods

(==) :: ContinueExit -> ContinueExit -> Bool

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

runInteractive :: Sandbox s -> IO ()

Executes the application.

runInteractive' :: forall s. Sandbox s -> IO s

Executes the application returning its final state.