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_UTF_8
  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 struct term_event_keyboard {
  39         term_event_key_T key;
  40         term_event_modifier_T modifier;
  41 };
  42
  43 struct interlink_event_keyboard {
  44         /* Values <= -2 are not used, for ELinks 0.11 compatibility.
  45          * Value  == -1 is KBD_UNDEF; not sent via socket.
  46          * Values between 0 and 0xFF are bytes received from the terminal.
  47          * Values >= 0x100 are special; absolute values of constants
  48          * from enum term_event_special_key, e.g. -KBD_ENTER.  */
  49         int key;
  50         /* The values are from term_event_modifier_T, but the type
  51          * must be int so that the representation remains compatible
  52          * with ELinks 0.11.  */
  53         int modifier;
  54 };
  55
  56 /* Codes of special keys, for use in term_event_key_T.
  57  * The enum has a tag mainly to let you cast numbers to it in GDB and see
  58  * their names.  ELinks doesn't use this enum type as term_event_key_T,
  59  * because it might be 16-bit and Unicode characters wouldn't then fit.  */
  60 enum term_event_special_key {
  61         KBD_UNDEF       = -1,
  62
  63         KBD_ENTER       = -0x100,
  64         KBD_BS          = -0x101,
  65         KBD_TAB         = -0x102,
  66         KBD_ESC         = -0x103,
  67         KBD_LEFT        = -0x104,
  68         KBD_RIGHT       = -0x105,
  69         KBD_UP          = -0x106,
  70         KBD_DOWN        = -0x107,
  71         KBD_INS         = -0x108,
  72         KBD_DEL         = -0x109,
  73         KBD_HOME        = -0x10a,
  74         KBD_END         = -0x10b,
  75         KBD_PAGE_UP     = -0x10c,
  76         KBD_PAGE_DOWN   = -0x10d,
  77
  78         KBD_F1          = -0x120,
  79         KBD_F2          = -0x121,
  80         KBD_F3          = -0x122,
  81         KBD_F4          = -0x123,
  82         KBD_F5          = -0x124,
  83         KBD_F6          = -0x125,
  84         KBD_F7          = -0x126,
  85         KBD_F8          = -0x127,
  86         KBD_F9          = -0x128,
  87         KBD_F10         = -0x129,
  88         KBD_F11         = -0x12a,
  89         KBD_F12         = -0x12b,
  90
  91         KBD_CTRL_C      = -0x200
  92 };
  93
  94 static inline int is_kbd_fkey(term_event_key_T key) { return key <= KBD_F1 && key >= KBD_F12; }
  95 #define number_to_kbd_fkey(num) (KBD_F1 - (num) + 1)
  96 #define kbd_fkey_to_number(key) (KBD_F1 - (key) + 1)
  97
  98 /* int is_kbd_character(term_event_key_T key);
  99  * Check whether @key is a character or a special key.
 100  * Return true if @key is a character from term_event_char_T.
 101  * (The character is not necessarily printable.)
 102  * Return false if @key is a special key from enum term_event_special_key.  */
 103 #define is_kbd_character(key) ((key) >= 0)
 104
 105 void
 106 handle_trm(int std_in, int std_out, int sock_in, int sock_out, int ctl_in,
 107            void *init_string, int init_len, int remote);
 108
 109 void itrm_queue_event(struct itrm *itrm, unsigned char *data, int len);
 110 void block_itrm(int);
 111 int unblock_itrm(int);
 112 void free_all_itrms(void);
 113 void resize_terminal(void);
 114 void dispatch_special(unsigned char *);
 115 void kbd_ctrl_c(void);
 116 int is_blocked(void);
 117
 118 #define kbd_get_key(kbd_)       ((kbd_)->key)
 119 #define kbd_key_is(kbd_, key)   (kbd_get_key(kbd_) == (key))
 120
 121 #define kbd_get_modifier(kbd_)  ((kbd_)->modifier)
 122 #define kbd_modifier_is(kbd_, mod)      (kbd_get_modifier(kbd_) == (mod))
 123
 124 #define kbd_set(kbd_, key_, modifier_) do { \
 125         (kbd_)->key = (key_);   \
 126         (kbd_)->modifier = (modifier_); \
 127 } while (0)
 128
 129
 130 #endif