ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/src/keyboard.C
Revision: 1.7
Committed: Sun Jan 16 23:55:42 2005 UTC (19 years, 4 months ago) by root
Content type: text/plain
Branch: MAIN
Changes since 1.6: +19 -22 lines
Log Message:
*** empty log message ***

File Contents

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