4fdf0203f68aa6dde35d3aa23f61c4dd27b41827
[dana/urxvt.git] / 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 #if TO_BE_DONE_INSIDE_dispatch
234   for (i = 0; i < keymap.size (); ++i)
235     {
236       keysym_t *key = keymap[i];
237
238       assert (bitcount (term_->ModMetaMask) == 1 && "call me after ModMetaMask was set!");
239
240       if (key->state & MetaMask)
241         {
242           //key->state &= ~MetaMask;
243           key->state |= term_->ModMetaMask;
244         }
245
246       assert (bitcount (term_->ModNumLockMask) == 1 && "call me after ModNumLockMask was set!");
247
248       if (key->state & NumLockMask)
249         {
250           //key->state &= ~NumLockMask;
251           key->state |= term_->ModNumLockMask;
252         }
253     }
254 #endif
255
256   setup_hash ();
257 }
258
259 bool
260 keyboard_manager::dispatch (rxvt_term *term, KeySym keysym, unsigned int state)
261 {
262   assert (hash[0] == 0 && "register_done() need to be called");
263
264   int index = find_keysym (keysym, state);
265
266   if (index >= 0)
267     {
268       assert (term && keymap [index]);
269       const keysym_t &key = *keymap [index];
270
271       int keysym_offset = keysym - key.keysym;
272
273       wchar_t *wc = rxvt_utf8towcs (key.str);
274       char *str = rxvt_wcstombs (wc);
275       // TODO: do translations, unescaping etc, here (allow \u escape etc.)
276       free (wc);
277
278       switch (key.type)
279         {
280          case keysym_t::NORMAL:
281             output_string (term, str);
282             break;
283
284           case keysym_t::RANGE:
285             {
286               char buf[STRING_MAX];
287
288               if (format_keyrange_string (str, keysym_offset, buf, sizeof (buf)) > 0)
289                 output_string (term, buf);
290             }
291             break;
292
293           case keysym_t::RANGE_META8:
294             {
295               int len;
296               char buf[STRING_MAX];
297
298               len = format_keyrange_string (str, keysym_offset, buf, sizeof (buf));
299               if (len > 0)
300                 output_string_meta8 (term, state, buf, len);
301             }
302             break;
303
304           case keysym_t::LIST:
305             {
306               char buf[STRING_MAX];
307
308               char *prefix, *middle, *suffix;
309
310               prefix = str;
311               middle = strchr  (prefix + 1, *prefix);
312               suffix = strrchr (middle + 1, *prefix);
313
314               memcpy (buf, prefix + 1, middle - prefix - 1);
315               buf [middle - prefix - 1] = middle [keysym_offset + 1];
316               strcpy (buf + (middle - prefix), suffix + 1);
317
318               output_string (term, buf);
319             }
320             break;
321         }
322
323       free (str);
324
325       return true;
326     }
327   else
328     {
329       // fprintf(stderr,"[%x:%x]",state,keysym);
330       return false;
331     }
332 }
333
334 // purge duplicate keymap entries
335 void keyboard_manager::purge_duplicate_keymap ()
336 {
337   for (unsigned int i = 0; i < keymap.size (); ++i)
338     {
339       for (unsigned int j = 0; j < i; ++j)
340         {
341           if (keymap[i] == keymap[j])
342             {
343               while (keymap[i] == keymap.back ())
344                 keymap.pop_back ();
345
346               if (i < keymap.size ())
347                 {
348                   keymap[i] = keymap.back ();
349                   keymap.pop_back ();
350                 }
351               break;
352             }
353         }
354     }
355 }
356
357 void
358 keyboard_manager::setup_hash ()
359 {
360   unsigned int i, index, hashkey;
361   vector <keysym_t *> sorted_keymap;
362   uint16_t hash_budget_size[KEYSYM_HASH_BUDGETS];       // size of each budget
363   uint16_t hash_budget_counter[KEYSYM_HASH_BUDGETS];    // #elements in each budget
364
365   memset (hash_budget_size, 0, sizeof (hash_budget_size));
366   memset (hash_budget_counter, 0, sizeof (hash_budget_counter));
367
368   // count keysyms for corresponding hash budgets
369   for (i = 0; i < keymap.size (); ++i)
370     {
371       assert (keymap[i]);
372       hashkey = (keymap[i]->keysym & KEYSYM_HASH_MASK);
373       ++hash_budget_size[hashkey];
374     }
375
376   // keysym A with range>1 is counted one more time for
377   // every keysym B lies in its range
378   for (i = 0; i < keymap.size (); ++i)
379     {
380       if (keymap[i]->range > 1)
381         {
382           for (int j = min (keymap[i]->range, KEYSYM_HASH_BUDGETS) - 1; j > 0; --j)
383             {
384               hashkey = ((keymap[i]->keysym + j) & KEYSYM_HASH_MASK);
385               if (hash_budget_size[hashkey])
386                 ++hash_budget_size[hashkey];
387             }
388         }
389     }
390
391   // now we know the size of each budget
392   // compute the index of each budget
393   hash[0] = 0;
394   for (index = 0, i = 1; i < KEYSYM_HASH_BUDGETS; ++i)
395     {
396       index += hash_budget_size[i - 1];
397       hash[i] = (hash_budget_size[i] ? index : hash[i - 1]);
398     }
399
400   // and allocate just enough space
401   //sorted_keymap.reserve (hash[i - 1] + hash_budget_size[i - 1]);
402   sorted_keymap.insert (sorted_keymap.begin (), index + hash_budget_size[i - 1], 0);
403
404   // fill in sorted_keymap
405   // it is sorted in each budget
406   for (i = 0; i < keymap.size (); ++i)
407     {
408       for (int j = min (keymap[i]->range, KEYSYM_HASH_BUDGETS) - 1; j >= 0; --j)
409         {
410           hashkey = ((keymap[i]->keysym + j) & KEYSYM_HASH_MASK);
411
412           if (hash_budget_size[hashkey])
413             {
414               index = hash[hashkey] + hash_budget_counter[hashkey];
415
416               while (index > hash[hashkey]
417                      && compare_priority (keymap[i], sorted_keymap[index - 1]) > 0)
418                 {
419                   sorted_keymap[index] = sorted_keymap[index - 1];
420                   --index;
421                 }
422
423               sorted_keymap[index] = keymap[i];
424               ++hash_budget_counter[hashkey];
425             }
426         }
427     }
428
429   keymap.swap (sorted_keymap);
430
431 #if defined (DEBUG_STRICT) || defined (DEBUG_KEYBOARD)
432   // check for invariants
433   for (i = 0; i < KEYSYM_HASH_BUDGETS; ++i)
434     {
435       index = hash[i];
436       for (int j = 0; j < hash_budget_size[i]; ++j)
437         {
438           if (keymap[index + j]->range == 1)
439             assert (i == (keymap[index + j]->keysym & KEYSYM_HASH_MASK));
440
441           if (j)
442             assert (compare_priority (keymap[index + j - 1],
443                     keymap[index + j]) >= 0);
444         }
445     }
446
447   // this should be able to detect most possible bugs
448   for (i = 0; i < sorted_keymap.size (); ++i)
449     {
450       keysym_t *a = sorted_keymap[i];
451       for (int j = 0; j < a->range; ++j)
452         {
453           int index = find_keysym (a->keysym + j, a->state & OtherModMask);
454           assert (index >= 0);
455           keysym_t *b = keymap[index];
456           assert (i == (signed) index ||        // the normally expected result
457             (a->keysym + j) >= b->keysym && (a->keysym + j) <= (b->keysym + b->range) && compare_priority (a, b) <= 0); // is effectively the same
458         }
459     }
460 #endif
461 }
462
463 int
464 keyboard_manager::find_keysym (KeySym keysym, unsigned int state)
465 {
466   int hashkey = keysym & KEYSYM_HASH_MASK;
467   unsigned int index = hash [hashkey];
468
469   for (; index < keymap.size (); ++index)
470     {
471       keysym_t *key = keymap[index];
472       assert (key);
473
474       if (key->keysym <= keysym && key->keysym + key->range > keysym
475           // match only the specified bits in state and ignore others
476           && (key->state & OtherModMask) == (key->state & state))
477         return index;
478       else if (key->keysym > keysym && key->range == 1)
479         return -1;
480     }
481
482   return -1;
483 }
484
485 #endif /* KEYSYM_RESOURCE */
486 // vim:et:ts=2:sw=2