Terminal key input library
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Přemysl Janouch 30e0eee1a8
2 years ago
cmake Try harder to get ncursesw 4 years ago
tests Use termo_str{f,p}key_utf8 in tests 3 years ago
.gitignore Miscellaneous little changes 5 years ago
.travis.yml Travis CI: brevify notifications 3 years ago
CMakeLists.txt Update mail address 2 years ago
LICENSE Update mail address 2 years ago
README.adoc Update README 2 years ago
config-version.cmake.in CMake-ify, rename to termkey2 for the time being 5 years ago
config.cmake.in Rename to termo 5 years ago
demo-async.c Get rid of most block comments 5 years ago
demo-draw.c Rewrite the mouse API 5 years ago
demo-glib.c Fix condition in demo-glib.c 3 years ago
demo.c Rewrite the mouse API 5 years ago
driver-csi.c Don't interpret an n*<Esc> as (n-1)*<Alt>-<Esc> 5 years ago
driver-ti.c Try to fix terminfo loading 3 years ago
termo-config.h.in Rename to termo 5 years ago
termo-internal.h Don't interpret an n*<Esc> as (n-1)*<Alt>-<Esc> 5 years ago
termo.c Backport TERMKEY_FLAG_NOSTART and fix two leaks 3 years ago
termo.h Backport TERMKEY_FLAG_NOSTART and fix two leaks 3 years ago


termo is a library providing an alternative to ncurses' handling of terminal input. ncurses does a really terrible job at that, mainly wrt. mouse support which seems to be utterly broken. If you can drag things in a terminal application, such as in VIM, I can assure you it's not using ncurses for that. (At least not with ncurses older than 6.0.)

Since terminal I/O is really complicated and full of special cases, this project doesn't aspire to also replace the output part of ncurses, but is rather complementary to it. In the end it makes use of its terminfo library.

The API isn't stable yet. Tell me what needs to be done so I can fix it first.

Building and Installing

Build dependencies: cmake >= 2.8.5, pkg-config
Optional dependencies: Unibilium (alternative for curses), GLib (for the demos)

$ git clone https://git.janouch.name/p/termo.git
$ mkdir termo/build
$ cd termo/build

To install the library, you can do either the usual:

# make install

Or you can try telling CMake to make a package for you. For Debian it is:

$ cpack -G DEB
# dpkg -i termo-*.deb

To see the library in action, you can try running the demos, which are statically linked against the library, and hence they can be run as they are:

$ make demos

What's Different From the Original termkey?

The main change is throwing out any UTF-8 dependent code, making the library capable of handling all unibyte and multibyte encodings supported by iconv on your system. The characters are still presented as Unicode in the end, however, as the other sensible option is wchar_t and that doesn't really work well, see http://gnu.org/software/libunistring/manual/libunistring.html#The-wchar_005ft-mess

To make the mouse parsing support actually useful, some API has been added to set the proper modes on request, and unset them appropriately while destroying. You can have a look at demo-draw.c for an example.

Another change worth mentioning is the usage of CMake instead of the problematic libtool-based Makefile. Now you can include this project in your other CMake-based projects and simply import the target. No package maintainer action is needed for you to enjoy the benefits of proper terminal input.

The rest is just me going silly over formatting and various unimportant stuff. Oh, and I've deleted the manpages. It needs more Doxygen. :) TBD

Contributing and Support

Use https://git.janouch.name/p/termo to report any bugs, request features, or submit pull requests. git send-email is tolerated. If you want to discuss the project, feel free to join me at ircs://irc.janouch.name, channel #dev.

Bitcoin donations are accepted at: 12r5uEWEgcHC46xd64tt3hHt9EUvYYDHe9


termo is based on the termkey library, originally written by Paul Evans <leonerd@leonerd.org.uk>, with additional changes made by Přemysl Janouch <p@janouch.name>.

You may use the software under the terms of the MIT license, the text of which is included within the package, see the file LICENSE.