src/terminal/kbd.h

   1 #ifndef EL__TERMINAL_KBD_H
   2 #define EL__TERMINAL_KBD_H
   3
   4 #include "intl/charsets.h"
   5
   6 struct itrm;
   7
   8 /* A character received from a terminal.  */
   9 #ifdef CONFIG_UTF8
  10 typedef unicode_val_T term_event_char_T; /* in UCS-4 */
  11 #else
  12 typedef unsigned char term_event_char_T; /* in the charset of the terminal */
  13 #endif
  14
  15 /* A key received from a terminal, without modifiers.  The value is
  16  * either from term_event_char_T or from enum term_event_special_key.
  17  * To check which one it is, use is_kbd_character().
  18  *
  19  * Values <= -0x100 are special; from enum term_event_special_key.
  20  * Values between -0xFF and -2 are not used yet; treat as special.
  21  * Value  == -1 is KBD_UNDEF; not sent via socket.
  22  * Values >= 0 are characters; from term_event_char_T.
  23  *
  24  * Any at least 32-bit signed integer type would work here; using an
  25  * exact-width type hurts portability in principle, but some other
  26  * parts of ELinks already require the existence of uint32_t.  */
  27 typedef int32_t term_event_key_T;
  28
  29 /* Values for term_event_keyboard.modifier and
  30  * interlink_event_keyboard.modifier */
  31 typedef enum {
  32         KBD_MOD_NONE    = 0,
  33         KBD_MOD_SHIFT   = 1,
  34         KBD_MOD_CTRL    = 2,
  35         KBD_MOD_ALT     = 4
  36 } term_event_modifier_T;
  37
  38 /* A key received from a terminal, with modifiers.  */
  39 struct term_event_keyboard {
  40         term_event_key_T key;
  41         term_event_modifier_T modifier;
  42 };
  43
  44 /* Like struct term_event_keyboard but used in the interlink protocol
  45  * between ELinks processes.  Because the processes may be running
  46  * different versions of ELinks, especially if a new version has just
  47  * been installed, this structure should be kept binary compatible as
  48  * long as possible.  See bug 793 for a list of pending changes to the
  49  * protocol.  */
  50 struct interlink_event_keyboard {
  51         /* This is like term_event_key_T but carries individual bytes
  52          * rather than entire characters, and uses different values
  53          * for special keys.
  54          *
  55          * Values <= -2 are not used, for ELinks 0.11 compatibility.
  56          * Value  == -1 is KBD_UNDEF; not sent via socket.
  57          * Values between 0 and 0xFF are bytes received from the terminal.
  58          * Values >= 0x100 are special; absolute values of constants
  59          * from enum term_event_special_key, e.g. -KBD_ENTER.  */
  60         int key;
  61         /* The values are from term_event_modifier_T, but the type
  62          * must be int so that the representation remains compatible
  63          * with ELinks 0.11.  */
  64         int modifier;
  65 };
  66
  67 /* Codes of special keys, for use in term_event_key_T.
  68  * The enum has a tag mainly to let you cast numbers to it in GDB and see
  69  * their names.  ELinks doesn't use this enum type as term_event_key_T,
  70  * because it might be 16-bit and Unicode characters wouldn't then fit.  */
  71 enum term_event_special_key {
  72         KBD_UNDEF       = -1,
  73
  74         KBD_ENTER       = -0x100,
  75         KBD_BS          = -0x101,
  76         KBD_TAB         = -0x102,
  77         KBD_ESC         = -0x103,
  78         KBD_LEFT        = -0x104,
  79         KBD_RIGHT       = -0x105,
  80         KBD_UP          = -0x106,
  81         KBD_DOWN        = -0x107,
  82         KBD_INS         = -0x108,
  83         KBD_DEL         = -0x109,
  84         KBD_HOME        = -0x10a,
  85         KBD_END         = -0x10b,
  86         KBD_PAGE_UP     = -0x10c,
  87         KBD_PAGE_DOWN   = -0x10d,
  88
  89         KBD_F1          = -0x120,
  90         KBD_F2          = -0x121,
  91         KBD_F3          = -0x122,
  92         KBD_F4          = -0x123,
  93         KBD_F5          = -0x124,
  94         KBD_F6          = -0x125,
  95         KBD_F7          = -0x126,
  96         KBD_F8          = -0x127,
  97         KBD_F9          = -0x128,
  98         KBD_F10         = -0x129,
  99         KBD_F11         = -0x12a,
 100         KBD_F12         = -0x12b,
 101
 102         KBD_CTRL_C      = -0x200
 103 };
 104
 105 static inline int is_kbd_fkey(term_event_key_T key) { return key <= KBD_F1 && key >= KBD_F12; }
 106 #define number_to_kbd_fkey(num) (KBD_F1 - (num) + 1)
 107 #define kbd_fkey_to_number(key) (KBD_F1 - (key) + 1)
 108
 109 /* int is_kbd_character(term_event_key_T key);
 110  * Check whether @key is a character or a special key.
 111  * Return true if @key is a character from term_event_char_T.
 112  * (The character is not necessarily printable.)
 113  * Return false if @key is a special key from enum term_event_special_key.  */
 114 #define is_kbd_character(key) ((key) >= 0)
 115
 116 void
 117 handle_trm(int std_in, int std_out, int sock_in, int sock_out, int ctl_in,
 118            void *init_string, int init_len, int remote);
 119
 120 void itrm_queue_event(struct itrm *itrm, unsigned char *data, int len);
 121 void block_itrm(int);
 122 int unblock_itrm(int);
 123 void free_all_itrms(void);
 124 void resize_terminal(void);
 125 void dispatch_special(unsigned char *);
 126 void kbd_ctrl_c(void);
 127 int is_blocked(void);
 128 void get_terminal_name(unsigned char *);
 129
 130 #define kbd_get_key(kbd_)       ((kbd_)->key)
 131 #define kbd_key_is(kbd_, key)   (kbd_get_key(kbd_) == (key))
 132
 133 #define kbd_get_modifier(kbd_)  ((kbd_)->modifier)
 134 #define kbd_modifier_is(kbd_, mod)      (kbd_get_modifier(kbd_) == (mod))
 135
 136 #define kbd_set(kbd_, key_, modifier_) do { \
 137         (kbd_)->key = (key_);   \
 138         (kbd_)->modifier = (modifier_); \
 139 } while (0)
 140
 141
 142 #endif