A high-level ncurses alternative written in Haskell
Go to file
2014-04-25 19:01:27 -07:00
cbits use hack from SendFile for determining Fd for handle. Use when requesting window size 2014-04-09 17:08:40 -07:00
ci initialize GHCVER under jenkins 2014-04-14 19:20:47 -07:00
docs - 2009-11-07 00:34:29 -08:00
scripts refactor vty to use standard naming convention. 2014-04-11 17:51:13 -07:00
src use a GHC 7.4 compatible System.Environment API 2014-04-25 19:01:27 -07:00
test fix debugLog reference 2014-04-24 13:28:24 -07:00
.gitignore update git ignore to include cabal sandbox config 2014-04-09 21:03:56 -07:00
.travis.yml update travis.ci def 2014-04-24 09:20:17 -07:00
AUTHORS update AUTHORS 2010-08-06 14:16:26 -07:00
build_examples add a build examples script which just builds the examples package 2013-11-12 22:31:25 -08:00
CHANGELOG refactor vty to use standard naming convention. 2014-04-11 17:51:13 -07:00
DESIGN adding example of Graphics.Vty.Inline to test 2009-12-28 15:32:18 -08:00
install_examples rename ClassifyTable to ClassifyTableV1 2013-11-17 20:59:52 -08:00
LICENSE use alloca instead of mallocBytes for exception safety 2009-09-04 10:29:28 -07:00
README.md split input table generation based on terminal type 2013-12-24 22:06:58 -08:00
Setup.lhs use alloca instead of mallocBytes for exception safety 2009-09-04 10:29:28 -07:00
TODO adding example of Graphics.Vty.Inline to test 2009-12-28 15:32:18 -08:00
view-benchmark-core add view-benchmark-core to use ghc-core to view the full core of the benchmark exe 2014-02-03 01:46:28 -08:00
vty.cabal finish the implementation of userConfig 2014-04-24 09:18:43 -07:00

vty is a terminal interface library.

Project is hosted on github.com: https://github.com/coreyoconnor/vty

git clone git://github.com/coreyoconnor/vty.git

Features

  • Automatic handling of window resizes.

  • Supports Unicode characters on output, automatically setting and resetting UTF-8 mode for xterm. Other terminals are assumed to support

  • Efficient output.

  • Minimizes repaint area, thus virtually eliminating the flicker problem that plagues ncurses programs.

  • A pure, compositional interface for efficiently constructing display images.

  • Automatically decodes keyboard keys into (key,[modifier]) tuples.

  • Automatically supports refresh on Ctrl-L.

  • Automatically supports timeout after 50ms for lone ESC (a barely noticable delay)

  • Interface is designed for relatively easy compatible extension.

  • Supports all ANSI SGR-modes (defined in console_codes(4)) with a type-safe interface.

  • Properly handles cleanup, but not due to signals.

Known Issues

  • Signal handling of STOP, TERM and INT are non existent.

  • The character encoding of the terminal is assumed to be UTF-8.

  • Terminfo is assumed to be correct unless the terminal (as declared by TERM) starts with xterm or ansi. This means that some terminals will not have correct special key support (shifted F10 etc)

  • Uses the TIOCGWINSZ ioctl to find the current window size, which appears to be limited to Linux and *BSD.

Platform Support

Posix Terminals

Uses terminfo to determine terminal protocol. Some special rules for Mac terminal applications. The special rules might be invalid on newer Mac OS.

Windows

None!

Development Notes

Coverage

Profiling appears to cause issues with coverage when enabled. To evaluate coverage configure as follows:

rm -rf dist ; cabal configure --enable-tests --enable-library-coverage \
  --disable-library-profiling \
  --disable-executable-profiling

Profiling

rm -rf dist ; cabal configure --enable-tests --disable-library-coverage \
  --enable-library-profiling \
  --enable-executable-profiling