p
/
termo
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
termo/termkey.c

713 lines
18 KiB
C
Raw Blame History

#include "termkey.h"
#include "termkey-internal.h"
#include <errno.h>
#include <poll.h>
#include <unistd.h>
#include <string.h>
#include <stdio.h>
static struct termkey_driver *drivers[] = {
&termkey_driver_csi,
&termkey_driver_ti,
NULL,
};
// Forwards for the "protected" methods
static void eat_bytes(termkey_t *tk, size_t count);
static void emit_codepoint(termkey_t *tk, long codepoint, termkey_key *key);
static termkey_result getkey_simple(termkey_t *tk, termkey_key *key, int force);
static termkey_keysym register_c0(termkey_t *tk, termkey_keysym sym, unsigned char ctrl, const char *name);
static termkey_keysym register_c0_full(termkey_t *tk, termkey_keysym sym, int modifier_set, int modifier_mask, unsigned char ctrl, const char *name);
static struct {
termkey_keysym sym;
const char *name;
} keynames[] = {
{ TERMKEY_SYM_NONE, "NONE" },
{ TERMKEY_SYM_BACKSPACE, "Backspace" },
{ TERMKEY_SYM_TAB, "Tab" },
{ TERMKEY_SYM_ENTER, "Enter" },
{ TERMKEY_SYM_ESCAPE, "Escape" },
{ TERMKEY_SYM_SPACE, "Space" },
{ TERMKEY_SYM_DEL, "DEL" },
{ TERMKEY_SYM_UP, "Up" },
{ TERMKEY_SYM_DOWN, "Down" },
{ TERMKEY_SYM_LEFT, "Left" },
{ TERMKEY_SYM_RIGHT, "Right" },
{ TERMKEY_SYM_BEGIN, "Begin" },
{ TERMKEY_SYM_FIND, "Find" },
{ TERMKEY_SYM_INSERT, "Insert" },
{ TERMKEY_SYM_DELETE, "Delete" },
{ TERMKEY_SYM_SELECT, "Select" },
{ TERMKEY_SYM_PAGEUP, "PageUp" },
{ TERMKEY_SYM_PAGEDOWN, "PageDown" },
{ TERMKEY_SYM_HOME, "Home" },
{ TERMKEY_SYM_END, "End" },
{ TERMKEY_SYM_CANCEL, "Cancel" },
{ TERMKEY_SYM_CLEAR, "Clear" },
{ TERMKEY_SYM_CLOSE, "Close" },
{ TERMKEY_SYM_COMMAND, "Command" },
{ TERMKEY_SYM_COPY, "Copy" },
{ TERMKEY_SYM_EXIT, "Exit" },
{ TERMKEY_SYM_HELP, "Help" },
{ TERMKEY_SYM_MARK, "Mark" },
{ TERMKEY_SYM_MESSAGE, "Message" },
{ TERMKEY_SYM_MOVE, "Move" },
{ TERMKEY_SYM_OPEN, "Open" },
{ TERMKEY_SYM_OPTIONS, "Options" },
{ TERMKEY_SYM_PRINT, "Print" },
{ TERMKEY_SYM_REDO, "Redo" },
{ TERMKEY_SYM_REFERENCE, "Reference" },
{ TERMKEY_SYM_REFRESH, "Refresh" },
{ TERMKEY_SYM_REPLACE, "Replace" },
{ TERMKEY_SYM_RESTART, "Restart" },
{ TERMKEY_SYM_RESUME, "Resume" },
{ TERMKEY_SYM_SAVE, "Save" },
{ TERMKEY_SYM_SUSPEND, "Suspend" },
{ TERMKEY_SYM_UNDO, "Undo" },
{ TERMKEY_SYM_KP0, "KP0" },
{ TERMKEY_SYM_KP1, "KP1" },
{ TERMKEY_SYM_KP2, "KP2" },
{ TERMKEY_SYM_KP3, "KP3" },
{ TERMKEY_SYM_KP4, "KP4" },
{ TERMKEY_SYM_KP5, "KP5" },
{ TERMKEY_SYM_KP6, "KP6" },
{ TERMKEY_SYM_KP7, "KP7" },
{ TERMKEY_SYM_KP8, "KP8" },
{ TERMKEY_SYM_KP9, "KP9" },
{ TERMKEY_SYM_KPENTER, "KPEnter" },
{ TERMKEY_SYM_KPPLUS, "KPPlus" },
{ TERMKEY_SYM_KPMINUS, "KPMinus" },
{ TERMKEY_SYM_KPMULT, "KPMult" },
{ TERMKEY_SYM_KPDIV, "KPDiv" },
{ TERMKEY_SYM_KPCOMMA, "KPComma" },
{ TERMKEY_SYM_KPPERIOD, "KPPeriod" },
{ TERMKEY_SYM_KPEQUALS, "KPEquals" },
{ 0, NULL },
};
termkey_t *termkey_new_full(int fd, int flags, size_t buffsize, int waittime)
{
termkey_t *tk = malloc(sizeof(*tk));
if(!tk)
return NULL;
if(!(flags & (TERMKEY_FLAG_RAW|TERMKEY_FLAG_UTF8))) {
int locale_is_utf8 = 0;
char *e;
if((e = getenv("LANG")) && strstr(e, "UTF-8"))
locale_is_utf8 = 1;
if(!locale_is_utf8 && (e = getenv("LC_MESSAGES")) && strstr(e, "UTF-8"))
locale_is_utf8 = 1;
if(!locale_is_utf8 && (e = getenv("LC_ALL")) && strstr(e, "UTF-8"))
locale_is_utf8 = 1;
if(locale_is_utf8)
flags |= TERMKEY_FLAG_UTF8;
else
flags |= TERMKEY_FLAG_RAW;
}
tk->fd = fd;
tk->flags = flags;
tk->buffer = malloc(buffsize);
if(!tk->buffer)
goto abort_free_tk;
tk->buffstart = 0;
tk->buffcount = 0;
tk->buffsize = buffsize;
tk->restore_termios_valid = 0;
tk->waittime = waittime;
tk->is_closed = 0;
tk->nkeynames = 64;
tk->keynames = malloc(sizeof(tk->keynames[0]) * tk->nkeynames);
if(!tk->keynames)
goto abort_free_buffer;
int i;
for(i = 0; i < tk->nkeynames; i++)
tk->keynames[i] = NULL;
for(i = 0; i < 32; i++)
tk->c0[i].sym = TERMKEY_SYM_NONE;
tk->method.eat_bytes = &eat_bytes;
tk->method.emit_codepoint = &emit_codepoint;
tk->method.getkey_simple = &getkey_simple;
for(i = 0; keynames[i].name; i++)
termkey_register_keyname(tk, keynames[i].sym, keynames[i].name);
register_c0(tk, TERMKEY_SYM_BACKSPACE, 0x08, NULL);
register_c0(tk, TERMKEY_SYM_TAB, 0x09, NULL);
register_c0(tk, TERMKEY_SYM_ENTER, 0x0d, NULL);
register_c0(tk, TERMKEY_SYM_ESCAPE, 0x1b, NULL);
const char *term = getenv("TERM");
for(i = 0; drivers[i]; i++) {
void *driver_info = (*drivers[i]->new_driver)(tk, term);
if(!driver_info)
continue;
tk->driver = *(drivers[i]);
tk->driver_info = driver_info;
break;
}
if(!tk->driver_info) {
fprintf(stderr, "Unable to find a terminal driver\n");
goto abort_free_keynames;
}
if(!(flags & TERMKEY_FLAG_NOTERMIOS)) {
struct termios termios;
if(tcgetattr(fd, &termios) == 0) {
tk->restore_termios = termios;
tk->restore_termios_valid = 1;
termios.c_iflag &= ~(IXON|INLCR|ICRNL);
termios.c_lflag &= ~(ICANON|ECHO|ISIG);
tcsetattr(fd, TCSANOW, &termios);
}
}
if(tk->driver.start_driver)
(*tk->driver.start_driver)(tk);
return tk;
abort_free_keynames:
free(tk->keynames);
abort_free_buffer:
free(tk->buffer);
abort_free_tk:
free(tk);
return NULL;
}
termkey_t *termkey_new(int fd, int flags)
{
return termkey_new_full(fd, flags, 256, 50);
}
void termkey_free(termkey_t *tk)
{
free(tk->buffer); tk->buffer = NULL;
free(tk->keynames); tk->keynames = NULL;
(*tk->driver.free_driver)(tk->driver_info);
tk->driver_info = NULL; /* Be nice to GC'ers, etc */
free(tk);
}
void termkey_destroy(termkey_t *tk)
{
if(tk->driver.stop_driver)
(*tk->driver.stop_driver)(tk);
if(tk->restore_termios_valid)
tcsetattr(tk->fd, TCSANOW, &tk->restore_termios);
termkey_free(tk);
}
void termkey_setwaittime(termkey_t *tk, int msec)
{
tk->waittime = msec;
}
int termkey_getwaittime(termkey_t *tk)
{
return tk->waittime;
}
static void eat_bytes(termkey_t *tk, size_t count)
{
if(count >= tk->buffcount) {
tk->buffstart = 0;
tk->buffcount = 0;
return;
}
tk->buffstart += count;
tk->buffcount -= count;
size_t halfsize = tk->buffsize / 2;
if(tk->buffstart > halfsize) {
memcpy(tk->buffer, tk->buffer + halfsize, halfsize);
tk->buffstart -= halfsize;
}
}
static inline int utf8_seqlen(long codepoint)
{
if(codepoint < 0x0000080) return 1;
if(codepoint < 0x0000800) return 2;
if(codepoint < 0x0010000) return 3;
if(codepoint < 0x0200000) return 4;
if(codepoint < 0x4000000) return 5;
return 6;
}
static void fill_utf8(termkey_key *key)
{
long codepoint = key->code.codepoint;
int nbytes = utf8_seqlen(codepoint);
key->utf8[nbytes] = 0;
// This is easier done backwards
int b = nbytes;
while(b > 1) {
b--;
key->utf8[b] = 0x80 | (codepoint & 0x3f);
codepoint >>= 6;
}
switch(nbytes) {
case 1: key->utf8[0] = (codepoint & 0x7f); break;
case 2: key->utf8[0] = 0xc0 | (codepoint & 0x1f); break;
case 3: key->utf8[0] = 0xe0 | (codepoint & 0x0f); break;
case 4: key->utf8[0] = 0xf0 | (codepoint & 0x07); break;
case 5: key->utf8[0] = 0xf8 | (codepoint & 0x03); break;
case 6: key->utf8[0] = 0xfc | (codepoint & 0x01); break;
}
}
static void emit_codepoint(termkey_t *tk, long codepoint, termkey_key *key)
{
if(codepoint < 0x20) {
// C0 range
key->code.codepoint = 0;
key->modifiers = 0;
if(!(tk->flags & TERMKEY_FLAG_NOINTERPRET) && tk->c0[codepoint].sym != TERMKEY_SYM_UNKNOWN) {
key->code.sym = tk->c0[codepoint].sym;
key->modifiers |= tk->c0[codepoint].modifier_set;
}
if(!key->code.sym) {
key->type = TERMKEY_TYPE_UNICODE;
key->code.codepoint = codepoint + 0x40;
key->modifiers = TERMKEY_KEYMOD_CTRL;
}
else {
key->type = TERMKEY_TYPE_KEYSYM;
}
}
else if(codepoint == 0x20 && !(tk->flags & TERMKEY_FLAG_NOINTERPRET)) {
// ASCII space
key->type = TERMKEY_TYPE_KEYSYM;
key->code.sym = TERMKEY_SYM_SPACE;
key->modifiers = 0;
}
else if(codepoint == 0x7f && !(tk->flags & TERMKEY_FLAG_NOINTERPRET)) {
// ASCII DEL
key->type = TERMKEY_TYPE_KEYSYM;
key->code.sym = TERMKEY_SYM_DEL;
key->modifiers = 0;
}
else if(codepoint >= 0x20 && codepoint < 0x80) {
// ASCII lowbyte range
key->type = TERMKEY_TYPE_UNICODE;
key->code.codepoint = codepoint;
key->modifiers = 0;
}
else if(codepoint >= 0x80 && codepoint < 0xa0) {
// UTF-8 never starts with a C1 byte. So we can be sure of these
key->type = TERMKEY_TYPE_UNICODE;
key->code.codepoint = codepoint - 0x40;
key->modifiers = TERMKEY_KEYMOD_CTRL|TERMKEY_KEYMOD_ALT;
}
else {
// UTF-8 codepoint
key->type = TERMKEY_TYPE_UNICODE;
key->code.codepoint = codepoint;
key->modifiers = 0;
}
if(key->type == TERMKEY_TYPE_UNICODE)
fill_utf8(key);
}
#define UTF8_INVALID 0xFFFD
#define CHARAT(i) (tk->buffer[tk->buffstart + (i)])
static termkey_result getkey_simple(termkey_t *tk, termkey_key *key, int force)
{
unsigned char b0 = CHARAT(0);
if(b0 == 0x1b) {
// Escape-prefixed value? Might therefore be Alt+key
if(tk->buffcount == 1) {
// This might be an <Esc> press, or it may want to be part of a longer
// sequence
if(!force)
return TERMKEY_RES_AGAIN;
(*tk->method.emit_codepoint)(tk, b0, key);
(*tk->method.eat_bytes)(tk, 1);
return TERMKEY_RES_KEY;
}
// Try another key there
tk->buffstart++;
tk->buffcount--;
// Run the full driver
termkey_result metakey_result = (*tk->driver.getkey)(tk, key, force);
tk->buffstart--;
tk->buffcount++;
switch(metakey_result) {
case TERMKEY_RES_KEY:
key->modifiers |= TERMKEY_KEYMOD_ALT;
(*tk->method.eat_bytes)(tk, 1);
break;
case TERMKEY_RES_NONE:
case TERMKEY_RES_EOF:
case TERMKEY_RES_AGAIN:
break;
}
return metakey_result;
}
else if(b0 < 0xa0) {
// Single byte C0, G0 or C1 - C1 is never UTF-8 initial byte
(*tk->method.emit_codepoint)(tk, b0, key);
(*tk->method.eat_bytes)(tk, 1);
return TERMKEY_RES_KEY;
}
else if(tk->flags & TERMKEY_FLAG_UTF8) {
// Some UTF-8
int nbytes;
long codepoint;
key->type = TERMKEY_TYPE_UNICODE;
key->modifiers = 0;
if(b0 < 0xc0) {
// Starts with a continuation byte - that's not right
(*tk->method.emit_codepoint)(tk, UTF8_INVALID, key);
(*tk->method.eat_bytes)(tk, 1);
return TERMKEY_RES_KEY;
}
else if(b0 < 0xe0) {
nbytes = 2;
codepoint = b0 & 0x1f;
}
else if(b0 < 0xf0) {
nbytes = 3;
codepoint = b0 & 0x0f;
}
else if(b0 < 0xf8) {
nbytes = 4;
codepoint = b0 & 0x07;
}
else if(b0 < 0xfc) {
nbytes = 5;
codepoint = b0 & 0x03;
}
else if(b0 < 0xfe) {
nbytes = 6;
codepoint = b0 & 0x01;
}
else {
(*tk->method.emit_codepoint)(tk, UTF8_INVALID, key);
(*tk->method.eat_bytes)(tk, 1);
return TERMKEY_RES_KEY;
}
if(tk->buffcount < nbytes) {
if(!force)
return TERMKEY_RES_AGAIN;
/* There weren't enough bytes for a complete UTF-8 sequence but caller
* demands an answer. About the best thing we can do here is eat as many
* bytes as we have, and emit a UTF8_INVALID. If the remaining bytes
* arrive later, they'll be invalid too.
*/
(*tk->method.emit_codepoint)(tk, UTF8_INVALID, key);
(*tk->method.eat_bytes)(tk, tk->buffcount);
return TERMKEY_RES_KEY;
}
for(int b = 1; b < nbytes; b++) {
unsigned char cb = CHARAT(b);
if(cb < 0x80 || cb >= 0xc0) {
(*tk->method.emit_codepoint)(tk, UTF8_INVALID, key);
(*tk->method.eat_bytes)(tk, b - 1);
return TERMKEY_RES_KEY;
}
codepoint <<= 6;
codepoint |= cb & 0x3f;
}
// Check for overlong sequences
if(nbytes > utf8_seqlen(codepoint))
codepoint = UTF8_INVALID;
// Check for UTF-16 surrogates or invalid codepoints
if((codepoint >= 0xD800 && codepoint <= 0xDFFF) ||
codepoint == 0xFFFE ||
codepoint == 0xFFFF)
codepoint = UTF8_INVALID;
(*tk->method.emit_codepoint)(tk, codepoint, key);
(*tk->method.eat_bytes)(tk, nbytes);
return TERMKEY_RES_KEY;
}
else {
// Non UTF-8 case - just report the raw byte
key->type = TERMKEY_TYPE_UNICODE;
key->code.codepoint = b0;
key->modifiers = 0;
key->utf8[0] = key->code.codepoint;
key->utf8[1] = 0;
(*tk->method.eat_bytes)(tk, 1);
return TERMKEY_RES_KEY;
}
}
termkey_result termkey_getkey(termkey_t *tk, termkey_key *key)
{
return (*tk->driver.getkey)(tk, key, 0);
}
termkey_result termkey_getkey_force(termkey_t *tk, termkey_key *key)
{
return (*tk->driver.getkey)(tk, key, 1);
}
termkey_result termkey_waitkey(termkey_t *tk, termkey_key *key)
{
while(1) {
termkey_result ret = termkey_getkey(tk, key);
switch(ret) {
case TERMKEY_RES_KEY:
case TERMKEY_RES_EOF:
return ret;
case TERMKEY_RES_NONE:
termkey_advisereadable(tk);
break;
case TERMKEY_RES_AGAIN:
{
if(tk->is_closed)
// We're closed now. Never going to get more bytes so just go with
// what we have
return termkey_getkey_force(tk, key);
struct pollfd fd;
fd.fd = tk->fd;
fd.events = POLLIN;
poll(&fd, 1, tk->waittime);
if(fd.revents & (POLLIN|POLLHUP|POLLERR))
ret = termkey_advisereadable(tk);
else
ret = TERMKEY_RES_NONE;
if(ret == TERMKEY_RES_NONE)
return termkey_getkey_force(tk, key);
}
break;
}
}
/* UNREACHABLE */
}
void termkey_pushinput(termkey_t *tk, unsigned char *input, size_t inputlen)
{
if(tk->buffstart + tk->buffcount + inputlen > tk->buffsize) {
while(tk->buffstart + tk->buffcount + inputlen > tk->buffsize)
tk->buffsize *= 2;
unsigned char *newbuffer = realloc(tk->buffer, tk->buffsize);
// TODO: Handle realloc() failure
tk->buffer = newbuffer;
}
// Not strcpy just in case of NUL bytes
memcpy(tk->buffer + tk->buffstart + tk->buffcount, input, inputlen);
tk->buffcount += inputlen;
}
termkey_result termkey_advisereadable(termkey_t *tk)
{
unsigned char buffer[64]; // Smaller than the default size
size_t len = read(tk->fd, buffer, sizeof buffer);
if(len == -1 && errno == EAGAIN)
return TERMKEY_RES_NONE;
else if(len < 1) {
tk->is_closed = 1;
return TERMKEY_RES_NONE;
}
else {
termkey_pushinput(tk, buffer, len);
return TERMKEY_RES_AGAIN;
}
}
termkey_keysym termkey_register_keyname(termkey_t *tk, termkey_keysym sym, const char *name)
{
if(!sym)
sym = tk->nkeynames;
if(sym >= tk->nkeynames) {
const char **new_keynames = realloc(tk->keynames, sizeof(new_keynames[0]) * (sym + 1));
// TODO: Handle realloc() failure
tk->keynames = new_keynames;
// Fill in the hole
for(int i = tk->nkeynames; i < sym; i++)
tk->keynames[i] = NULL;
tk->nkeynames = sym + 1;
}
tk->keynames[sym] = name;
return sym;
}
const char *termkey_get_keyname(termkey_t *tk, termkey_keysym sym)
{
if(sym == TERMKEY_SYM_UNKNOWN)
return "UNKNOWN";
if(sym < tk->nkeynames)
return tk->keynames[sym];
return "UNKNOWN";
}
static termkey_keysym register_c0(termkey_t *tk, termkey_keysym sym, unsigned char ctrl, const char *name)
{
return register_c0_full(tk, sym, 0, 0, ctrl, name);
}
static termkey_keysym register_c0_full(termkey_t *tk, termkey_keysym sym, int modifier_set, int modifier_mask, unsigned char ctrl, const char *name)
{
if(ctrl >= 0x20) {
fprintf(stderr, "Cannot register C0 key at ctrl 0x%02x - out of bounds\n", ctrl);
return -1;
}
if(name)
sym = termkey_register_keyname(tk, sym, name);
tk->c0[ctrl].sym = sym;
tk->c0[ctrl].modifier_set = modifier_set;
tk->c0[ctrl].modifier_mask = modifier_mask;
return sym;
}
size_t termkey_snprint_key(termkey_t *tk, char *buffer, size_t len, termkey_key *key, termkey_format format)
{
size_t pos = 0;
size_t l;
int longmod = format & TERMKEY_FORMAT_LONGMOD;
int wrapbracket = (format & TERMKEY_FORMAT_WRAPBRACKET) &&
(key->type != TERMKEY_TYPE_UNICODE || key->modifiers != 0);
if(wrapbracket) {
l = snprintf(buffer + pos, len - pos, "<");
if(l <= 0) return pos;
pos += l;
}
if(format & TERMKEY_FORMAT_CARETCTRL) {
if(key->type == TERMKEY_TYPE_UNICODE &&
key->modifiers == TERMKEY_KEYMOD_CTRL &&
key->code.number >= '@' &&
key->code.number <= '_') {
l = snprintf(buffer + pos, len - pos, "^");
if(l <= 0) return pos;
pos += l;
goto do_codepoint;
}
}
if(key->modifiers & TERMKEY_KEYMOD_ALT) {
int altismeta = format & TERMKEY_FORMAT_ALTISMETA;
l = snprintf(buffer + pos, len - pos, longmod ? ( altismeta ? "Meta-" : "Alt-" )
: ( altismeta ? "M-" : "A-" ));
if(l <= 0) return pos;
pos += l;
}
if(key->modifiers & TERMKEY_KEYMOD_CTRL) {
l = snprintf(buffer + pos, len - pos, longmod ? "Ctrl-" : "C-");
if(l <= 0) return pos;
pos += l;
}
if(key->modifiers & TERMKEY_KEYMOD_SHIFT) {
l = snprintf(buffer + pos, len - pos, longmod ? "Shift-" : "S-");
if(l <= 0) return pos;
pos += l;
}
do_codepoint:
switch(key->type) {
case TERMKEY_TYPE_UNICODE:
l = snprintf(buffer + pos, len - pos, "%s", key->utf8);
break;
case TERMKEY_TYPE_KEYSYM:
l = snprintf(buffer + pos, len - pos, "%s", termkey_get_keyname(tk, key->code.sym));
break;
case TERMKEY_TYPE_FUNCTION:
l = snprintf(buffer + pos, len - pos, "F%d", key->code.number);
break;
}
if(l <= 0) return pos;
pos += l;
if(wrapbracket) {
l = snprintf(buffer + pos, len - pos, ">");
if(l <= 0) return pos;
pos += l;
}
return pos;
}
Reference in New Issue View Git Blame Copy Permalink