src/keyboard.h

   1 /*----------------------------------------------------------------------*
   2  * File:        keyboard.h
   3  *----------------------------------------------------------------------*
   4  *
   5  * All portions of code are copyright by their respective author/s.
   6  * Copyright (c) 2005      WU Fengguang
   7  * Copyright (c) 2005-2006 Marc Lehmann <pcg@goof.com>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  22  *----------------------------------------------------------------------*/
  23
  24 #ifndef KEYBOARD_H_
  25 #define KEYBOARD_H_
  26
  27 #ifdef KEYSYM_RESOURCE
  28
  29 #include <inttypes.h>
  30
  31 #include "feature.h"
  32 #include "rxvtutil.h"
  33
  34 #define KEYSYM_HASH_BITS        4       /* lowest #bits of keysym is used as hash key */
  35 #define KEYSYM_HASH_BUDGETS     (1<<KEYSYM_HASH_BITS)
  36 #define KEYSYM_HASH_MASK        (KEYSYM_HASH_BUDGETS-1)
  37
  38 #define MetaMask                0x0100
  39 #define NumLockMask             0x0200
  40 #define AppKeypadMask           0x0400
  41 #define Level3Mask              0x0800 // currently not supported
  42 #define OtherModMask            (ShiftMask | LockMask | ControlMask \
  43                                 | Mod1Mask | Mod2Mask | Mod3Mask | Mod4Mask | Mod5Mask)
  44
  45 #if OtherModMask > 0xff
  46 # error FATAL: X modifiers might clash with rxvt-unicode ones
  47 #endif
  48
  49 struct rxvt_term;
  50 struct keysym_t;
  51
  52 typedef void (keyevent_handler) (rxvt_term *rt,
  53                                  keysym_t *key,
  54                                  KeySym keysym,
  55                                  unsigned int state);
  56
  57 struct keysym_t
  58 {
  59   enum keysym_type {
  60     STRING, RANGE, RANGE_META8, LIST, BUILTIN,
  61   };
  62
  63   KeySym      keysym;
  64   /* only the lower 8 bits of state are used for matching according to X.h */
  65   /* the higher bits are preserved for Meta/NumLock keys */
  66   /* which are mapped to corresponding lower bits at register time */
  67   uint16_t    state;    /* indicates each modifiers' DOWN/UP status         */
  68   uint16_t    range;    /* =1: single keysym; >1: a of range keysyms        */
  69   keysym_type type;
  70   const char  *str;      /* would normally be a keycode translation in UTF-8 */
  71 };
  72
  73 class keyboard_manager
  74 {
  75 public:
  76   keyboard_manager ();
  77   ~keyboard_manager ();
  78
  79   void clear ();
  80   void register_user_translation (KeySym keysym, unsigned int state, const char *trans);
  81   void register_done ();        // call this to make newly registered keymaps take effect
  82   bool dispatch (rxvt_term *term, KeySym keysym, unsigned int state);
  83
  84 private:
  85   void register_keymap (keysym_t *key);
  86   void purge_duplicate_keymap ();
  87   void setup_hash ();
  88   int find_keysym (KeySym keysym, unsigned int state);
  89
  90 private:
  91   uint16_t hash[KEYSYM_HASH_BUDGETS];
  92   vector<keysym_t *> keymap;
  93
  94 #if STOCK_KEYMAP
  95   // stock keymaps are all static data
  96   static keysym_t stock_keymap[];
  97 #endif
  98   // user keymaps and their .string are dynamically allocated and freed
  99   vector<keysym_t *> user_keymap;
 100   vector<const char *> user_translations;
 101 };
 102
 103 #endif /* KEYSYM_RESOURCE */
 104
 105 #endif /* KEYBOARD_H_ */