Run a termbox program and restore the terminal state afterwards. May throw an InitError exception.

Initialization errors that can be thrown by main.

A Cell contains a character, foreground attribute, and background attribute.

Set the Cell at the given coordinates.

Get the terminal's internal back buffer as a two-dimensional array of Cells indexed by their coordinates.

Warning: the data is only valid until the next call to clear or flush.

Clear the back buffer with the given foreground and background attributes.

Synchronize the internal back buffer with the terminal.

Get the terminal width and height.

Set the cursor coordinates.

Hide the cursor.

A input event.

A key event.

A mouse event.

Block until an Event arrives.

Note: termbox v1.1.2 does not properly handle OS signals that interrupt the underlying select system call, so unfortunately the familiar Ctrl-C will not be able to stop a program stuck in pollEvent.

You can work around this issue by polling in a background thread using the threaded runtime, or simply writing event-handling code that is responsive to intuitive "quit" keys like q and Esc.

This function may throw a PollError exception under mysterious circumstances that are not well-documented in the original C codebase.

An error occurred when polling.

A cell attribute, which includes its color, and whether or not it is bold, underlined, and/or reversed.

A cell can only have one color, but may be (for example) bold and underlined. The Monoid instance combines Attrs this way, with a left bias. That is,

red <> bold <> black <> underline = red <> bold <> underline

Warning: the Num instance is very partial! It only includes an implementation of fromInteger, for numeric literals.

black = 1.

red = 2.

green = 3.

yellow = 4.

blue = 5.

magenta = 6.

cyan = 7.

white = 8.

Bold modifier attribute.

Underline modifier attribute.

Reverse modifier attribute.

The input modes.

• Esc. When ESC sequence is in the buffer and it doesn't match any known sequence, ESC means KeyEsc.
• Alt. When ESC sequence is in the buffer and it doesn't match any known sequence, ESC enables the alt modifier for the next keyboard event.

The mouse mode.

• No. Don't handle mouse events.
• Yes. Handle mouse events.

Get the current input mode.

Set the input mode.

The output modes.

• Normal. Supports colors 0..8, which includes all named color attributes exported by this library, e.g. red.
• Grayscale. Supports colors 0..23.
• 216. Supports colors 0..216.
• 256. Supports colors 0..255.

Get the current output mode.

Set the output mode.