src/keyboard.C

   1 #include "../config.h"
   2 #include "rxvt.h"
   3 #include "keyboard.h"
   4 #include "command.h"
   5 #include <string.h>
   6 #include <X11/X.h>
   7
   8 #ifdef KEYSYM_RESOURCE
   9
  10 ////////////////////////////////////////////////////////////////////////////////
  11 // default keycode translation map and keyevent handlers
  12
  13 keysym_t keyboard_manager::stock_keymap[] = {
  14   /* examples */
  15   /*        keysym,                state, range,        handler,             str */
  16 //{XK_ISO_Left_Tab,                    0,     1,         NORMAL,           "\033[Z"},
  17 //{            'a',                    0,    26,    RANGE_META8,           "a" "%c"},
  18 //{            'a',          ControlMask,    26,    RANGE_META8,          "\ 1" "%c"},
  19 //{        XK_Left,                    0,     4,           LIST,   "DACBZ" "\033[Z"},
  20 //{        XK_Left,            ShiftMask,     4,           LIST,   "dacbZ" "\033[Z"},
  21 //{        XK_Left,          ControlMask,     4,           LIST,   "dacbZ" "\033OZ"},
  22 //{         XK_Tab,          ControlMask,     1,         NORMAL,      "\033<C-Tab>"},
  23 //{  XK_apostrophe,          ControlMask,     1,         NORMAL,        "\033<C-'>"},
  24 //{       XK_slash,          ControlMask,     1,         NORMAL,        "\033<C-/>"},
  25 //{   XK_semicolon,          ControlMask,     1,         NORMAL,        "\033<C-;>"},
  26 //{       XK_grave,          ControlMask,     1,         NORMAL,        "\033<C-`>"},
  27 //{       XK_comma,          ControlMask,     1,         NORMAL,     "\033<C-\054>"},
  28 //{      XK_Return,          ControlMask,     1,         NORMAL,    "\033<C-Return>"},
  29 //{      XK_Return,            ShiftMask,     1,         NORMAL,    "\033<S-Return>"},
  30 //{            ' ',            ShiftMask,     1,         NORMAL,    "\033<S-Space>"},
  31 //{            '.',          ControlMask,     1,         NORMAL,        "\033<C-.>"},
  32 //{            '0',          ControlMask,    10,          RANGE,   "0" "\033<C-%c>"},
  33 //{            '0', MetaMask|ControlMask,    10,          RANGE, "0" "\033<M-C-%c>"},
  34 //{            'a', MetaMask|ControlMask,    26,          RANGE, "a" "\033<M-C-%c>"},
  35 };
  36
  37 static void
  38 output_string (rxvt_term *rt, const char *str)
  39 {
  40   assert (rt && str);
  41
  42   if (strncmp (str, "proto:", 6) == 0)
  43     rt->cmd_write ((unsigned char *)str + 6, strlen (str) - 6);
  44   else
  45     rt->tt_write ((unsigned char *)str, strlen (str));
  46 }
  47
  48 static void
  49 output_string_meta8 (rxvt_term *rt, unsigned int state, char *buf, int buflen)
  50 {
  51   if (state & rt->ModMetaMask)
  52     {
  53 #ifdef META8_OPTION
  54       if (rt->meta_char == 0x80)        /* set 8-bit on */
  55         {
  56           for (char *ch = buf; ch < buf + buflen; ch++)
  57             *ch |= 0x80;
  58         }
  59       else if (rt->meta_char == C0_ESC) /* escape prefix */
  60 #endif
  61         {
  62           const unsigned char
  63             ch = C0_ESC;
  64           rt->tt_write (&ch, 1);
  65         }
  66     }
  67
  68   rt->tt_write ((unsigned char *) buf, buflen);
  69 }
  70
  71 static int
  72 format_keyrange_string (const char *str, int keysym_offset, char *buf, int bufsize)
  73 {
  74   int len = snprintf (buf, bufsize, str + 1, keysym_offset + str [0]);
  75
  76   if (len >= bufsize)
  77     {
  78       fprintf (stderr, "buffer overflowed!\n");
  79       buf[bufsize - 1] = '\0';
  80     }
  81   else if (len < 0)
  82     {
  83       perror ("keyrange_translator()");
  84     }
  85
  86   return len;
  87 }
  88
  89 ////////////////////////////////////////////////////////////////////////////////
  90 // return: #bits of '1'
  91 static int
  92 bitcount (unsigned int n)
  93 {
  94   int i;
  95
  96   for (i = 0; n; ++i, n &= (n - 1))
  97     ;
  98
  99   return i;
 100 }
 101
 102 // return: priority_of_a - priority_of_b
 103 static int
 104 compare_priority (keysym_t *a, keysym_t *b)
 105 {
 106   assert (a && b);
 107
 108   // (the more '1's in state; the less range): the greater priority
 109   int ca = bitcount (a->state /* & OtherModMask */);
 110   int cb = bitcount (b->state /* & OtherModMask */);
 111
 112   if (ca != cb)
 113     return ca - cb;
 114 //else if (a->state != b->state) // this behavior is to be disscussed
 115 //  return b->state - a->state;
 116   else
 117     return b->range - a->range;
 118 }
 119
 120 ////////////////////////////////////////////////////////////////////////////////
 121 keyboard_manager::keyboard_manager ()
 122 {
 123   keymap.reserve (256);
 124   hash [0] = 1;                 // hash[0] != 0 indicates uninitialized data
 125 }
 126
 127 keyboard_manager::~keyboard_manager ()
 128 {
 129   clear ();
 130 }
 131
 132 void
 133 keyboard_manager::clear ()
 134 {
 135   keymap.clear ();
 136   hash [0] = 2;
 137
 138   for (unsigned int i = 0; i < user_translations.size (); ++i)
 139     {
 140       free ((void *)user_translations [i]);
 141       user_translations [i] = 0;
 142     }
 143
 144   for (unsigned int i = 0; i < user_keymap.size (); ++i)
 145     {
 146       delete user_keymap [i];
 147       user_keymap [i] = 0;
 148     }
 149
 150   user_keymap.clear ();
 151   user_translations.clear ();
 152 }
 153
 154 // a wrapper for register_keymap,
 155 // so that outside codes don't have to know so much details.
 156 //
 157 // the string 'trans' is copied to an internal managed buffer,
 158 // so the caller can free memory of 'trans' at any time.
 159 void
 160 keyboard_manager::register_user_translation (KeySym keysym, unsigned int state, const char *trans)
 161 {
 162   assert (trans);
 163
 164   keysym_t *key = new keysym_t;
 165   wchar_t *wc = rxvt_mbstowcs (trans);
 166   const char *translation = rxvt_wcstoutf8 (wc);
 167   free (wc);
 168
 169   if (key && translation)
 170     {
 171       key->keysym = keysym;
 172       key->state  = state;
 173       key->range  = 1;
 174       key->str    = translation;
 175       key->type   = keysym_t::NORMAL;
 176
 177       if (strncmp (translation, "list", 4) == 0 && translation [4])
 178         {
 179           char *middle = strchr  (translation + 5, translation [4]);
 180           char *suffix = strrchr (translation + 5, translation [4]);
 181
 182           if (suffix && middle && suffix > middle + 1)
 183             {
 184               key->type  = keysym_t::LIST;
 185               key->range = suffix - middle - 1;
 186
 187               strcpy (translation, translation + 4);
 188             }
 189           else
 190             {
 191               key->range = 1;
 192               rxvt_warn ("cannot parse list-type keysym '%s', treating as normal keysym.\n", translation);
 193             }
 194         }
 195       else
 196
 197       user_keymap.push_back (key);
 198       user_translations.push_back (translation);
 199       register_keymap (key);
 200     }
 201   else
 202     {
 203       delete key;
 204       free ((void *)translation);
 205       rxvt_fatal ("out of memory, aborting.\n");
 206     }
 207 }
 208
 209 void
 210 keyboard_manager::register_keymap (keysym_t *key)
 211 {
 212   assert (key);
 213   assert (key->range >= 1);
 214
 215   if (keymap.size () == keymap.capacity ())
 216     keymap.reserve (keymap.size () * 2);
 217
 218   keymap.push_back (key);
 219   hash[0] = 3;
 220 }
 221
 222 void
 223 keyboard_manager::register_done ()
 224 {
 225   unsigned int i, n = sizeof (stock_keymap) / sizeof (keysym_t);
 226
 227   if (keymap.back () != &stock_keymap[n - 1])
 228     for (i = 0; i < n; ++i)
 229       register_keymap (&stock_keymap[i]);
 230
 231   purge_duplicate_keymap ();
 232
 233   setup_hash ();
 234 }
 235
 236 bool
 237 keyboard_manager::dispatch (rxvt_term *term, KeySym keysym, unsigned int state)
 238 {
 239   assert (hash[0] == 0 && "register_done() need to be called");
 240
 241   if (state & term->ModMetaMask)
 242     state |= MetaMask;
 243
 244   if (state & term->ModNumLockMask)
 245     state |= NumLockMask;
 246
 247   if (!!(term->priv_modes & PrivMode_aplKP) != !!(state & ShiftMask))
 248     state |= AppKeypadMask;
 249
 250   int index = find_keysym (keysym, state);
 251
 252   if (index >= 0)
 253     {
 254       assert (term && keymap [index]);
 255       const keysym_t &key = *keymap [index];
 256
 257       int keysym_offset = keysym - key.keysym;
 258
 259       wchar_t *wc = rxvt_utf8towcs (key.str);
 260       char *str = rxvt_wcstombs (wc);
 261       // TODO: do translations, unescaping etc, here (allow \u escape etc.)
 262       free (wc);
 263
 264       switch (key.type)
 265         {
 266          case keysym_t::NORMAL:
 267             output_string (term, str);
 268             break;
 269
 270           case keysym_t::RANGE:
 271             {
 272               char buf[STRING_MAX];
 273
 274               if (format_keyrange_string (str, keysym_offset, buf, sizeof (buf)) > 0)
 275                 output_string (term, buf);
 276             }
 277             break;
 278
 279           case keysym_t::RANGE_META8:
 280             {
 281               int len;
 282               char buf[STRING_MAX];
 283
 284               len = format_keyrange_string (str, keysym_offset, buf, sizeof (buf));
 285               if (len > 0)
 286                 output_string_meta8 (term, state, buf, len);
 287             }
 288             break;
 289
 290           case keysym_t::LIST:
 291             {
 292               char buf[STRING_MAX];
 293
 294               char *prefix, *middle, *suffix;
 295
 296               prefix = str;
 297               middle = strchr  (prefix + 1, *prefix);
 298               suffix = strrchr (middle + 1, *prefix);
 299
 300               memcpy (buf, prefix + 1, middle - prefix - 1);
 301               buf [middle - prefix - 1] = middle [keysym_offset + 1];
 302               strcpy (buf + (middle - prefix), suffix + 1);
 303
 304               output_string (term, buf);
 305             }
 306             break;
 307         }
 308
 309       free (str);
 310
 311       return true;
 312     }
 313   else
 314     {
 315       // fprintf(stderr,"[%x:%x]",state,keysym);
 316       return false;
 317     }
 318 }
 319
 320 // purge duplicate keymap entries
 321 void keyboard_manager::purge_duplicate_keymap ()
 322 {
 323   for (unsigned int i = 0; i < keymap.size (); ++i)
 324     {
 325       for (unsigned int j = 0; j < i; ++j)
 326         {
 327           if (keymap [i] == keymap [j])
 328             {
 329               while (keymap [i] == keymap.back ())
 330                 keymap.pop_back ();
 331
 332               if (i < keymap.size ())
 333                 {
 334                   keymap[i] = keymap.back ();
 335                   keymap.pop_back ();
 336                 }
 337               break;
 338             }
 339         }
 340     }
 341 }
 342
 343 void
 344 keyboard_manager::setup_hash ()
 345 {
 346   unsigned int i, index, hashkey;
 347   vector <keysym_t *> sorted_keymap;
 348   uint16_t hash_budget_size[KEYSYM_HASH_BUDGETS];       // size of each budget
 349   uint16_t hash_budget_counter[KEYSYM_HASH_BUDGETS];    // #elements in each budget
 350
 351   memset (hash_budget_size, 0, sizeof (hash_budget_size));
 352   memset (hash_budget_counter, 0, sizeof (hash_budget_counter));
 353
 354   // count keysyms for corresponding hash budgets
 355   for (i = 0; i < keymap.size (); ++i)
 356     {
 357       assert (keymap [i]);
 358       hashkey = (keymap [i]->keysym & KEYSYM_HASH_MASK);
 359       ++hash_budget_size [hashkey];
 360     }
 361
 362   // keysym A with range>1 is counted one more time for
 363   // every keysym B lies in its range
 364   for (i = 0; i < keymap.size (); ++i)
 365     {
 366       if (keymap[i]->range > 1)
 367         {
 368           for (int j = min (keymap [i]->range, KEYSYM_HASH_BUDGETS) - 1; j > 0; --j)
 369             {
 370               hashkey = ((keymap [i]->keysym + j) & KEYSYM_HASH_MASK);
 371               if (hash_budget_size [hashkey])
 372                 ++hash_budget_size [hashkey];
 373             }
 374         }
 375     }
 376
 377   // now we know the size of each budget
 378   // compute the index of each budget
 379   hash [0] = 0;
 380   for (index = 0, i = 1; i < KEYSYM_HASH_BUDGETS; ++i)
 381     {
 382       index += hash_budget_size [i - 1];
 383       hash[i] = (hash_budget_size [i] ? index : hash [i - 1]);
 384     }
 385
 386   // and allocate just enough space
 387   //sorted_keymap.reserve (hash[i - 1] + hash_budget_size[i - 1]);
 388   sorted_keymap.insert (sorted_keymap.begin (), index + hash_budget_size [i - 1], 0);
 389
 390   // fill in sorted_keymap
 391   // it is sorted in each budget
 392   for (i = 0; i < keymap.size (); ++i)
 393     {
 394       for (int j = min (keymap [i]->range, KEYSYM_HASH_BUDGETS) - 1; j >= 0; --j)
 395         {
 396           hashkey = ((keymap [i]->keysym + j) & KEYSYM_HASH_MASK);
 397
 398           if (hash_budget_size [hashkey])
 399             {
 400               index = hash [hashkey] + hash_budget_counter [hashkey];
 401
 402               while (index > hash [hashkey]
 403                      && compare_priority (keymap [i], sorted_keymap [index - 1]) > 0)
 404                 {
 405                   sorted_keymap [index] = sorted_keymap [index - 1];
 406                   --index;
 407                 }
 408
 409               sorted_keymap [index] = keymap [i];
 410               ++hash_budget_counter [hashkey];
 411             }
 412         }
 413     }
 414
 415   keymap.swap (sorted_keymap);
 416
 417 #if defined (DEBUG_STRICT) || defined (DEBUG_KEYBOARD)
 418   // check for invariants
 419   for (i = 0; i < KEYSYM_HASH_BUDGETS; ++i)
 420     {
 421       index = hash[i];
 422       for (int j = 0; j < hash_budget_size [i]; ++j)
 423         {
 424           if (keymap [index + j]->range == 1)
 425             assert (i == (keymap [index + j]->keysym & KEYSYM_HASH_MASK));
 426
 427           if (j)
 428             assert (compare_priority (keymap [index + j - 1],
 429                     keymap [index + j]) >= 0);
 430         }
 431     }
 432
 433   // this should be able to detect most possible bugs
 434   for (i = 0; i < sorted_keymap.size (); ++i)
 435     {
 436       keysym_t *a = sorted_keymap[i];
 437       for (int j = 0; j < a->range; ++j)
 438         {
 439           int index = find_keysym (a->keysym + j, a->state & OtherModMask);
 440           assert (index >= 0);
 441           keysym_t *b = keymap [index];
 442           assert (i == (signed) index ||        // the normally expected result
 443             (a->keysym + j) >= b->keysym && (a->keysym + j) <= (b->keysym + b->range) && compare_priority (a, b) <= 0); // is effectively the same
 444         }
 445     }
 446 #endif
 447 }
 448
 449 int
 450 keyboard_manager::find_keysym (KeySym keysym, unsigned int state)
 451 {
 452   int hashkey = keysym & KEYSYM_HASH_MASK;
 453   unsigned int index = hash [hashkey];
 454
 455   for (; index < keymap.size (); ++index)
 456     {
 457       keysym_t *key = keymap [index];
 458       assert (key);
 459
 460       if (key->keysym <= keysym && key->keysym + key->range > keysym
 461           // match only the specified bits in state and ignore others
 462           && (key->state & OtherModMask) == (key->state & state))
 463         return index;
 464       else if (key->keysym > keysym && key->range == 1)
 465         return -1;
 466     }
 467
 468   return -1;
 469 }
 470
 471 #endif /* KEYSYM_RESOURCE */
 472 // vim:et:ts=2:sw=2