qulogic/libgnt

Fix arrow keys
fix-arrow-keys
2019-02-20, Petteri Pitkänen
7ac801527b0b
Fix arrow keys

The key-tree expects that for arrow keys the terminal transmits codes that
are defined in the terminfo database, but these codes are transmitted only
in application mode. To make the arrow key handling portable across
terminals, and to prevent the need for manually translating these codes, put
the terminal into application mode by calling ncurses keypad().

Fixes #12676.
/*
* GNT - The GLib Ncurses Toolkit
*
* GNT is the legal property of its developers, whose names are too numerous
* to list here. Please refer to the COPYRIGHT file distributed with this
* source distribution.
*
* This library is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along with
* this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
#ifndef GNT_KEYS_H
#define GNT_KEYS_H
/**
* SECTION:gntkeys
* @section_id: libgnt-gntkeys
* @short_description: <filename>gntkeys.h</filename>
* @title: Keys API
*/
#include <term.h>
/*
* terminfo/termcap doesn't provide all the information that I want to use, eg.
* ctrl-up, ctrl-down etc. So I am going to hard-code some of the information
* for some popular $TERMs
*/
extern char *gnt_key_cup;
extern char *gnt_key_cdown;
extern char *gnt_key_cleft;
extern char *gnt_key_cright;
#define SAFE(x) ((cur_term && (x)) ? (x) : "")
/* This is needed so that g-ir-scanner does not take GNT_KEY_CTRL_* as
constants -- because if it does, the .gir contains the following invalid XML
characters, and parsing explodes */
#define CONSTCH(x) x
#ifdef _WIN32
/* XXX: \xe1 is a hacky alias for \x00 key code */
#define GNT_KEY_POPUP CONSTCH("") /* not supported? */
#define GNT_KEY_UP CONSTCH("\033\xe0\x48")
#define GNT_KEY_DOWN CONSTCH("\033\xe0\x50")
#define GNT_KEY_LEFT CONSTCH("\033\xe0\x4B")
#define GNT_KEY_RIGHT CONSTCH("\033\xe0\x4D")
#define GNT_KEY_CTRL_UP CONSTCH("\033\xe0\x8d")
#define GNT_KEY_CTRL_DOWN CONSTCH("\033\xe0\x91")
#define GNT_KEY_CTRL_LEFT CONSTCH("\033\xe0\x73")
#define GNT_KEY_CTRL_RIGHT CONSTCH("\033\xe0\x74")
#define GNT_KEY_PGUP CONSTCH("\033\xe0\x49")
#define GNT_KEY_PGDOWN CONSTCH("\033\xe0\x51")
#define GNT_KEY_HOME CONSTCH("\033\xe0\x47")
#define GNT_KEY_END CONSTCH("\033\xe0\x4f")
#define GNT_KEY_ENTER CONSTCH("\x0d")
#define GNT_KEY_BACKSPACE CONSTCH("\x08")
#define GNT_KEY_DEL CONSTCH("\033\xe0\x53")
#define GNT_KEY_INS CONSTCH("\033\xe0\x52")
#define GNT_KEY_BACK_TAB CONSTCH("\033\xe1\x94")
#define GNT_KEY_F1 CONSTCH("\033\xe1\x3b")
#define GNT_KEY_F2 CONSTCH("\033\xe1\x3c")
#define GNT_KEY_F3 CONSTCH("\033\xe1\x3d")
#define GNT_KEY_F4 CONSTCH("\033\xe1\x3e")
#define GNT_KEY_F5 CONSTCH("\033\xe1\x3f")
#define GNT_KEY_F6 CONSTCH("\033\xe1\x40")
#define GNT_KEY_F7 CONSTCH("\033\xe1\x41")
#define GNT_KEY_F8 CONSTCH("\033\xe1\x42")
#define GNT_KEY_F9 CONSTCH("\033\xe1\x43")
#define GNT_KEY_F10 CONSTCH("\033\xe1\x44")
#define GNT_KEY_F11 CONSTCH("\033\xe0\x85")
#define GNT_KEY_F12 CONSTCH("\033\xe0\x86")
#else
#define GNT_KEY_POPUP SAFE(key_f16) /* Apparently */
/* Arrow keys */
#define GNT_KEY_LEFT SAFE(key_left)
#define GNT_KEY_RIGHT SAFE(key_right)
#define GNT_KEY_UP SAFE(key_up)
#define GNT_KEY_DOWN SAFE(key_down)
#define GNT_KEY_CTRL_UP SAFE(gnt_key_cup)
#define GNT_KEY_CTRL_DOWN SAFE(gnt_key_cdown)
#define GNT_KEY_CTRL_RIGHT SAFE(gnt_key_cright)
#define GNT_KEY_CTRL_LEFT SAFE(gnt_key_cleft)
#define GNT_KEY_PGUP SAFE(key_ppage)
#define GNT_KEY_PGDOWN SAFE(key_npage)
#define GNT_KEY_HOME SAFE(key_home)
#define GNT_KEY_END SAFE(key_end)
#define GNT_KEY_ENTER SAFE(carriage_return)
#define GNT_KEY_BACKSPACE SAFE(key_backspace)
#define GNT_KEY_DEL SAFE(key_dc)
#define GNT_KEY_INS SAFE(key_ic)
#define GNT_KEY_BACK_TAB ((cur_term && back_tab) ? back_tab : SAFE(key_btab))
#define GNT_KEY_F1 SAFE(key_f1)
#define GNT_KEY_F2 SAFE(key_f2)
#define GNT_KEY_F3 SAFE(key_f3)
#define GNT_KEY_F4 SAFE(key_f4)
#define GNT_KEY_F5 SAFE(key_f5)
#define GNT_KEY_F6 SAFE(key_f6)
#define GNT_KEY_F7 SAFE(key_f7)
#define GNT_KEY_F8 SAFE(key_f8)
#define GNT_KEY_F9 SAFE(key_f9)
#define GNT_KEY_F10 SAFE(key_f10)
#define GNT_KEY_F11 SAFE(key_f11)
#define GNT_KEY_F12 SAFE(key_f12)
#endif
#define GNT_KEY_CTRL_A CONSTCH("\001")
#define GNT_KEY_CTRL_B CONSTCH("\002")
#define GNT_KEY_CTRL_D CONSTCH("\004")
#define GNT_KEY_CTRL_E CONSTCH("\005")
#define GNT_KEY_CTRL_F CONSTCH("\006")
#define GNT_KEY_CTRL_G CONSTCH("\007")
#define GNT_KEY_CTRL_H CONSTCH("\010")
#define GNT_KEY_CTRL_I CONSTCH("\011")
#define GNT_KEY_CTRL_J CONSTCH("\012")
#define GNT_KEY_CTRL_K CONSTCH("\013")
#define GNT_KEY_CTRL_L CONSTCH("\014")
#define GNT_KEY_CTRL_M CONSTCH("\012")
#define GNT_KEY_CTRL_N CONSTCH("\016")
#define GNT_KEY_CTRL_O CONSTCH("\017")
#define GNT_KEY_CTRL_P CONSTCH("\020")
#define GNT_KEY_CTRL_R CONSTCH("\022")
#define GNT_KEY_CTRL_T CONSTCH("\024")
#define GNT_KEY_CTRL_U CONSTCH("\025")
#define GNT_KEY_CTRL_V CONSTCH("\026")
#define GNT_KEY_CTRL_W CONSTCH("\027")
#define GNT_KEY_CTRL_X CONSTCH("\030")
#define GNT_KEY_CTRL_Y CONSTCH("\031")
/**
* gnt_init_keys:
*
* Initialize the keys.
*/
void gnt_init_keys(void);
/**
* gnt_keys_refine:
* @text: The input text to refine.
*
* Refine input text. This usually looks at what the terminal claims it is,
* and tries to change the text to work around some oft-broken terminfo entries.
*/
void gnt_keys_refine(char *text);
/**
* gnt_key_translate:
* @name: The user-readable representation of an input (eg.: c-t)
*
* Translate a user-readable representation of an input to a machine-readable representation.
*
* Returns: A machine-readable representation of the input.
*/
const char *gnt_key_translate(const char *name);
/**
* gnt_key_lookup:
* @key: The machine-readable representation of an input.
*
* Translate a machine-readable representation of an input to a user-readable representation.
*
* Returns: A user-readable representation of the input (eg.: c-t).
*/
const char *gnt_key_lookup(const char *key);
/**
* gnt_keys_add_combination:
* @key: The key to add
*
* Add a key combination to the internal key-tree.
*/
void gnt_keys_add_combination(const char *key);
/**
* gnt_keys_del_combination:
* @key: The key to remove.
*
* Remove a key combination from the internal key-tree.
*/
void gnt_keys_del_combination(const char *key);
/**
* gnt_keys_find_combination:
* @key: The input string.
*
* Find a combination from the given string.
*
* Returns: The number of bytes in the combination that starts at the beginning
* of key (can be 0).
*/
int gnt_keys_find_combination(const char *key);
/* A lot of commonly used variable names are defined in <term.h>.
* #undef them to make life easier for everyone. */
#undef columns
#undef lines
#undef buttons
#undef newline
#undef set_clock
#endif