ilyakooo0/vty
1
0
Fork 0
mirror of https://github.com/ilyakooo0/vty.git synced 2024-10-04 19:27:08 +03:00
Code Issues Projects Releases Wiki Activity
A high-level ncurses alternative written in Haskell
285 Commits 12 Branches 65 Tags 3.8 MiB
Haskell 94.7%
C 3.7%
Perl 0.9%
Shell 0.4%
Makefile 0.3%
6111351eda
Go to file
Corey O'Connor 6111351eda ask travis CI to build with multiple GHC versions
2013-12-13 00:03:01 -08:00
cbits prefixed all c functions to avoid Cabal bug #944 2012-04-22 15:49:25 +02:00
docs - 2009-11-07 00:34:29 -08:00
scripts add script used to generate the Color240 module 2013-10-30 14:10:19 -07:00
src add empty_picture, add_to_top and add_to_bottom to Graphics.Vty.Picture 2013-11-30 00:23:10 -08:00
test add a sprite generator to RougeStory. Stopping on this for now. 2013-12-11 23:12:03 -08:00
.gitignore add .hpc dir 2013-07-06 21:59:21 -07:00
.travis.yml ask travis CI to build with multiple GHC versions 2013-12-13 00:03:01 -08: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 add empty_picture, add_to_top and add_to_bottom to Graphics.Vty.Picture 2013-11-30 00:23:10 -08: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 docs 2013-11-17 03:22:04 -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
vty.cabal change the translate method to allow negative translations.. with a catch. 2013-11-20 11:43:13 -08:00

README.md

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.

Known Issues

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

  • Minimal support for special keys on terminals other than the linux-console. (F1-5 and arrow keys should work, but anything shifted isn't likely to.)

  • 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

References