vty: A simple terminal UI library

[ bsd3, library, program, user-interfaces ] [ Propose Tags ]

vty is terminal GUI library in the niche of ncurses. It is intended to be easy to use, have no confusing corner cases, and good support for common terminal types.

See the vty-examples package as well as the program test/interactive_terminal_test.hs included in the vty package for examples on how to use the library.

Import the Graphics.Vty convenience module to get access to the core parts of the library.

© 2006-2007 Stefan O'Rear; BSD3 license.

© Corey O'Connor; BSD3 license.

© Jonathan Daugherty; BSD3 license.


[Skip to Readme]
Versions [faq] 3.0.0, 3.0.1, 3.0.2, 3.0.4, 3.1.0, 3.1.2, 3.1.4, 3.1.6, 3.1.8, 3.1.8.2, 3.1.8.4, 4.0.0, 4.0.0.1, 4.2.1.0, 4.4.0.0, 4.4.0.0.1, 4.6.0.1, 4.6.0.2, 4.6.0.4, 4.6.0.6, 4.7.0.0, 4.7.0.4, 4.7.0.6, 4.7.0.8, 4.7.0.10, 4.7.0.12, 4.7.0.14, 4.7.0.18, 4.7.0.20, 4.7.1, 4.7.2, 4.7.3, 4.7.4, 4.7.5, 5.0.0, 5.0.1, 5.0.2, 5.1.0, 5.1.1, 5.1.3, 5.1.4, 5.2.0, 5.2.1, 5.2.2, 5.2.3, 5.2.4, 5.2.5, 5.2.6, 5.2.7, 5.2.8, 5.2.9, 5.2.10, 5.2.11, 5.3, 5.3.1, 5.4.0, 5.5.0, 5.6, 5.7, 5.7.1, 5.8, 5.8.1, 5.9, 5.9.1, 5.10, 5.11, 5.11.1, 5.11.2, 5.11.3, 5.12, 5.13, 5.14, 5.15, 5.15.1, 5.16, 5.17, 5.17.1, 5.18, 5.18.1, 5.19, 5.19.1, 5.19.2, 5.20, 5.21, 5.22, 5.23, 5.23.1, 5.24, 5.24.1, 5.25, 5.25.1, 5.26, 5.27, 5.28, 5.28.1, 5.28.2, 5.29 (info)
Change log CHANGELOG.md
Dependencies ansi-terminal (>=0.10.3), base (>=4.8 && <5), binary, blaze-builder (>=0.3.3.2 && <0.5), bytestring, containers, deepseq (>=1.1 && <1.5), directory, fail, filepath (>=1.0 && <2.0), hashable (>=1.2), microlens (<0.4.12), microlens-mtl, microlens-th, mtl (>=1.1.1.0 && <2.3), parallel (>=2.2 && <3.3), parsec (>=2 && <4), semigroups (>=0.16), stm, terminfo (>=0.3 && <0.5), text (>=0.11.3), transformers (>=0.3.0.0), unix, utf8-string (>=0.3 && <1.1), vector (>=0.7), vty [details]
License BSD-3-Clause
Author AUTHORS
Maintainer Jonathan Daugherty (cygnus@foobox.com)
Category User Interfaces
Home page https://github.com/jtdaugherty/vty
Source repo head: git clone https://github.com/jtdaugherty/vty.git
Uploaded by JonathanDaugherty at 2020-03-27T16:14:24Z
Distributions Arch:5.28.2, Debian:5.21, Fedora:5.25.1, LTSHaskell:5.25.1, NixOS:5.28.2, Stackage:5.25.1
Executables vty-demo, vty-mode-demo, vty-build-width-table
Downloads 82965 total (3231 in the last 30 days)
Rating 2.25 (votes: 2) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Hackage Matrix CI
Docs available [build log]
Last success reported on 2020-03-27 [all 1 reports]

Modules

[Index] [Quick Jump]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees


Readme for vty-5.28.2

[back to package description]

Build Status

vty is a terminal interface library. It provides a high-level interface for doing terminal I/O. Vty is supported on GHC versions 7.10.1 and up.

Install via git with:

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

Install via cabal with:

cabal install vty

Features

  • Supports a large number of terminals, i.e., vt100, ansi, hurd, linux, screen, etc., or anything with a sufficient terminfo entry.

  • Automatically handles window resizes.

  • Supports Unicode output on terminals with UTF-8 support.

  • Provides an efficient output algorithm. Output buffering and terminal state changes are minimized.

  • Minimizes repaint area, which virtually eliminates the flicker problems that plague ncurses programs.

  • Provides a pure, compositional interface for efficiently constructing display images.

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

  • Automatically supports refresh on Ctrl-L.

  • Supports a keypress timeout after for lone ESC. The timeout is customizable.

  • Provides extensible input and output interfaces.

  • Supports ANSI graphics modes (SGR as defined in console_codes(4)) with a type-safe interface and graceful fallback for terminals with limited or nonexistent support for such modes.

  • Properly handles cleanup (but not due to signals).

  • Provides a comprehensive test suite.

  • Supports "normal" and "extended" (SGR) mouse modes as described at http://invisible-island.net/xterm/ctlseqs/ctlseqs.html#h2-Mouse-Tracking

  • Supports bracketed paste mode as described at http://cirw.in/blog/bracketed-paste

  • Supports multi-column Unicode characters such as emoji characters. In cases where Vty and your terminal emulator disagree on character widths, Vty provides a tool vty-build-width-table and library functionality to build a width table that will work for your terminal and load it on application startup.

Development Notes

Vty uses threads internally, so programs made with Vty need to be compiled with the threaded runtime using the GHC -threaded option.

Platform Support

Posix Terminals

For the most part, Vty uses terminfo to determine terminal protocol with some special rules to handle some omissions from terminfo.

Windows

Windows is not supported.

Multi-Column Character Support

Vty supports rendering of multi-column characters such as two-column Asian characters and Emoji characters. This section details how to take advantage of this feature, since its behavior will depend on the terminal emulator in use.

Terminal emulators support Unicode to varying degrees, and each terminal emulator relies on a table of column widths for each supported Unicode character. Vty also needs to rely on such a table to compute the width of Vty images to do image layout. Since those tables can disagree if Vty and the terminal emulator support different versions of Unicode, and since different terminal emulators will support different versions of Unicode, it's likely that for some wide characters, Vty applications will exhibit rendering problems. Those rendering problems arise from Vty and the terminal emulator coming to different conclusions about how wide some characters are.

To address this, Vty supports loading custom character width tables that are based on the terminal's behavior in order to eliminate these disagreements. By default, though, Vty will use its built-in Unicode character width table. Since the built-in table is likely to eventually disagree with your terminal, Vty provides an API and a command-line tool to generate and install custom tables.

Custom Unicode width tables based on your terminal emulator can be built by running Vty's built-in tool, vty-build-width-table. The tool works by querying the current terminal emulator to obtain its width measurements for the entire supported Unicode range. The results are then saved to a disk file. These custom tables can also be generated programmatically by using the API in Graphics.Vty.UnicodeWidthTable.Query.

Saved width tables can then be loaded in one of two ways:

  • Via the library API in Graphics.Vty.UnicodeWidthTable.IO
  • By adding a widthMap directive to your Vty configuration file and then invoking mkVty to initialize Vty

The Vty configuration file supports the widthMap directive to allow users to specify which custom width table should be loaded for a given terminal type. This is done by specifying, e.g.,

widthMap "xterm" "/path/to/map.dat"

where the first argument is the value that TERM must have in order for the table to be loaded, and the second argument is the path to the table file itself as generated by the two alternatives listed above. If the Vty configuration file contains multiple matching widthMap directives for the current value of TERM, the last one listed in the file is used.

The tables declared in the configuration file are only ever automatically loaded when applications set up Vty by calling Graphics.Vty.mkVty.

Before a custom table has been loaded, calls to the library's character width functions (e.g. wcwidth) will use the default built-in table. Once a custom table has been loaded, the functions will use the new custom table. Only one custom table load can be performed in a Vty program. Once a custom table has been loaded, it cannot be replaced or removed.

Without using a custom width table, users of Vty-based applications are likely to eventually experience rendering problems with with wide characters. We recommend that developers of Vty-based applications either:

  • Provide the vty-build-width-table tool and documentation for running it and updating the Vty configuration, or
  • Have the application invoke the Vty library's table-building functionality and load the table at startup without using the Vty configuration.

The best option will depend on a number of factors: the user audience, the amount of risk posed by wide character rendering, the terminal emulators in use, etc.

Contributing

If you decide to contribute, that's great! Here are some guidelines you should consider to make submitting patches easier for all concerned:

  • If you want to take on big things, talk to me first; let's have a design/vision discussion before you start coding. Create a GitHub issue and we can use that as the place to hash things out.
  • If you make changes, make them consistent with the syntactic conventions already used in the codebase.
  • Please provide Haddock documentation for any changes you make.

Known Issues

  • Terminals have numerous quirks and bugs, so mileage may vary. Please report issues as you encounter them and provide details on your terminal emulator, operating system, etc.

  • STOP, TERM and INT signals are not handled.

  • 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.

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

Further Reading

Good sources of documentation for terminal programming are: