ilyakooo0/vty
1
0
Fork 0
mirror of https://github.com/ilyakooo0/vty.git synced 2024-11-29 08:49:40 +03:00
Code Issues Projects Releases Wiki Activity
A high-level ncurses alternative written in Haskell
480 Commits 12 Branches 65 Tags 3.8 MiB
Haskell 94.7%
C 3.7%
Perl 0.9%
Shell 0.4%
Makefile 0.3%
7ca5927baa
Go to file
Lennart Spitzner 7ca5927baa Fix .cabal files 
- Add source repos
- Remove -threaded for library (in accordance with
  cabal check recommendation)
- Copy LICENSE to test package (Fix cabal check error)
- Add proper other-modules to test executables (Fixes #88)
2016-03-12 00:56:20 +01: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 Ask Travis to use GHC 7.10 too. 2015-01-02 16:44:58 +06: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 STM chans to avoid deprecated interface (fixes #60) 2015-08-11 22:35:20 -07:00
test Fix .cabal files 2016-03-12 00:56:20 +01:00
.gitignore update git ignore to include cabal sandbox config 2014-04-09 21:03:56 -07:00
.travis.yml Ask Travis to use GHC 7.10 too. 2015-01-02 16:44:58 +06:00
AUTHORS up to 5.2.3 for release 2014-09-24 23:29:14 -07:00
build_examples add a build examples script which just builds the examples package 2013-11-12 22:31:25 -08:00
CHANGELOG Update CHANGELOG. Bump version to 5.4.0. 2015-08-11 22:56:34 -07:00
Demo.hs Fixup how the standardIOConfig is applied. Correct the Config Monoid. #77 2015-08-09 13:57: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 README: minor formatting adjustments 2015-08-09 13:09:14 -07: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 Fix .cabal files 2016-03-12 00:56:20 +01:00

README.md

Build Status

vty is a terminal interface library.

This project is hosted on github.com: https://github.com/coreyoconnor/vty

Install via git with:

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

Install via cabal with:

cabal install vty

Features

  • Support for a large number of terminals. vt100, ansi, hurd, linux, screen etc etc. Anything with a sufficient terminfo entry.

  • Automatic handling of window resizes.

  • If the terminal support UTF-8 then vty supports Unicode output.

  • Handles multi-column glyphs. (Requires user to properly configure terminal.)

  • Efficient output. Output buffering and terminal state changes are minimized.

  • Minimizes repaint area. Virtually eliminating the flicker problems 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 for lone ESC. The timeout is customizable.

  • Interface is designed for easy compatible extension.

  • Supports ANSI graphics modes (SGR as defined in console_codes(4)) with a type-safe interface. Gracefull fallback for terminals that do not support, or partially support the standard ANSI graphics modes.

  • Properly handles cleanup, but not due to signals.

  • Comprehensive test suite.

Known Issues

  • Terminals have numerous quirks and bugs. vty picks what works best for the author in ambigious, or buggy situations.

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

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

  • Terminfo is assumed to be correct unless there is an override configured. Some terminals will not have correct special key support (shifted F10 etc). See Config for customizing vty's behavior for a particular terminal.

  • 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. With some special rules to handle some omissions from terminfo.

Windows

cygwin only.

Development Notes

Under NixOS

After installing ncurses to user env.

LIBRARY_PATH=$HOME/.nix-profile/lib/ cabal configure --enable-tests --extra-lib-dirs=$HOME/.nix-profile/lib
LIBRARY_PATH=$HOME/.nix-profile/lib/ cabal build
LIBRARY_PATH=$HOME/.nix-profile/lib/ cabal test

Coverage

As of last testing, profiling causes 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