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

# Content
1 #include "../config.h"
2 #include "rxvt.h"
3
4 #ifdef KEYSYM_RESOURCE
5
6 #include <cstring>
7
8 #include "keyboard.h"
9 #include "command.h"
10
11 ////////////////////////////////////////////////////////////////////////////////
12 // default keycode translation map and keyevent handlers
13
14 keysym_t keyboard_manager::stock_keymap[] = {
15 /* examples */
16 /* 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 };
37
38 static void
39 output_string (rxvt_term *rt, const char *str)
40 {
41 assert (rt && str);
42
43 if (strncmp (str, "proto:", 6) == 0)
44 rt->cmd_write ((unsigned char *)str + 6, strlen (str) - 6);
45 else
46 rt->tt_write ((unsigned char *)str, strlen (str));
47 }
48
49 static void
50 output_string_meta8 (rxvt_term *rt, unsigned int state, char *buf, int buflen)
51 {
52 if (state & rt->ModMetaMask)
53 {
54 #ifdef META8_OPTION
55 if (rt->meta_char == 0x80) /* set 8-bit on */
56 {
57 for (char *ch = buf; ch < buf + buflen; ch++)
58 *ch |= 0x80;
59 }
60 else if (rt->meta_char == C0_ESC) /* escape prefix */
61 #endif
62 {
63 const unsigned char 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 size_t len = snprintf (buf, bufsize, str + 1, keysym_offset + str [0]);
75
76 if (len >= (size_t)bufsize)
77 {
78 rxvt_warn ("format_keyrange_string: formatting failed, ignoring key.\n");
79 *buf = 0;
80 }
81
82 return len;
83 }
84
85 ////////////////////////////////////////////////////////////////////////////////
86 // return: #bits of '1'
87 #if __GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ > 3)
88 # define bitcount(n) (__extension__ ({ uint32_t n__ = (n); __builtin_popcount (n); }))
89 #else
90 static int
91 bitcount (uint16_t n)
92 {
93 int i;
94
95 for (i = 0; n; ++i, n &= n - 1)
96 ;
97
98 return i;
99 }
100 #endif
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 printf ("CONV <%s> %x %x %x %x\n", trans, (int)wc[0], (int)wc[1], (int)wc[2], (int)wc[3]);
167 const char *translation = rxvt_wcstoutf8 (wc);
168 free (wc);
169
170 if (key && translation)
171 {
172 key->keysym = keysym;
173 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
188 strcpy (translation, translation + 4);
189 }
190 else
191 rxvt_warn ("cannot parse list-type keysym '%s', treating as normal keysym.\n", translation);
192 }
193
194 user_keymap.push_back (key);
195 user_translations.push_back (translation);
196 register_keymap (key);
197 }
198 else
199 {
200 delete key;
201 free ((void *)translation);
202 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 if (keymap.size () == keymap.capacity ())
213 keymap.reserve (keymap.size () * 2);
214
215 keymap.push_back (key);
216 hash[0] = 3;
217 }
218
219 void
220 keyboard_manager::register_done ()
221 {
222 unsigned int i, n = sizeof (stock_keymap) / sizeof (keysym_t);
223
224 if (keymap.back () != &stock_keymap[n - 1])
225 for (i = 0; i < n; ++i)
226 register_keymap (&stock_keymap[i]);
227
228 purge_duplicate_keymap ();
229
230 setup_hash ();
231 }
232
233 bool
234 keyboard_manager::dispatch (rxvt_term *term, KeySym keysym, unsigned int state)
235 {
236 assert (hash[0] == 0 && "register_done() need to be called");
237
238 if (state & term->ModMetaMask) state |= MetaMask;
239 if (state & term->ModNumLockMask) state |= NumLockMask;
240 if (state & term->ModLevel3Mask) state |= Level3Mask;
241
242 if (!!(term->priv_modes & PrivMode_aplKP) != !!(state & ShiftMask))
243 state |= AppKeypadMask;
244
245 int index = find_keysym (keysym, state);
246
247 if (index >= 0)
248 {
249 const keysym_t &key = *keymap [index];
250
251 int keysym_offset = keysym - key.keysym;
252
253 wchar_t *wc = rxvt_utf8towcs (key.str);
254
255 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 return true;
307 }
308 else
309 {
310 // fprintf(stderr,"[%x:%x]",state,keysym);
311 return false;
312 }
313 }
314
315 // purge duplicate keymap entries
316 void keyboard_manager::purge_duplicate_keymap ()
317 {
318 for (unsigned int i = 0; i < keymap.size (); ++i)
319 {
320 for (unsigned int j = 0; j < i; ++j)
321 {
322 if (keymap [i] == keymap [j])
323 {
324 while (keymap [i] == keymap.back ())
325 keymap.pop_back ();
326
327 if (i < keymap.size ())
328 {
329 keymap[i] = keymap.back ();
330 keymap.pop_back ();
331 }
332 break;
333 }
334 }
335 }
336 }
337
338 void
339 keyboard_manager::setup_hash ()
340 {
341 unsigned int i, index, hashkey;
342 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
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 for (i = 0; i < keymap.size (); ++i)
351 {
352 assert (keymap [i]);
353 hashkey = (keymap [i]->keysym & KEYSYM_HASH_MASK);
354 ++hash_budget_size [hashkey];
355 }
356
357 // keysym A with range>1 is counted one more time for
358 // every keysym B lies in its range
359 for (i = 0; i < keymap.size (); ++i)
360 {
361 if (keymap[i]->range > 1)
362 {
363 for (int j = min (keymap [i]->range, KEYSYM_HASH_BUDGETS) - 1; j > 0; --j)
364 {
365 hashkey = ((keymap [i]->keysym + j) & KEYSYM_HASH_MASK);
366 if (hash_budget_size [hashkey])
367 ++hash_budget_size [hashkey];
368 }
369 }
370 }
371
372 // now we know the size of each budget
373 // compute the index of each budget
374 hash [0] = 0;
375 for (index = 0, i = 1; i < KEYSYM_HASH_BUDGETS; ++i)
376 {
377 index += hash_budget_size [i - 1];
378 hash[i] = (hash_budget_size [i] ? index : hash [i - 1]);
379 }
380
381 // and allocate just enough space
382 //sorted_keymap.reserve (hash[i - 1] + hash_budget_size[i - 1]);
383 sorted_keymap.insert (sorted_keymap.begin (), index + hash_budget_size [i - 1], 0);
384
385 // fill in sorted_keymap
386 // it is sorted in each budget
387 for (i = 0; i < keymap.size (); ++i)
388 {
389 for (int j = min (keymap [i]->range, KEYSYM_HASH_BUDGETS) - 1; j >= 0; --j)
390 {
391 hashkey = ((keymap [i]->keysym + j) & KEYSYM_HASH_MASK);
392
393 if (hash_budget_size [hashkey])
394 {
395 index = hash [hashkey] + hash_budget_counter [hashkey];
396
397 while (index > hash [hashkey]
398 && compare_priority (keymap [i], sorted_keymap [index - 1]) > 0)
399 {
400 sorted_keymap [index] = sorted_keymap [index - 1];
401 --index;
402 }
403
404 sorted_keymap [index] = keymap [i];
405 ++hash_budget_counter [hashkey];
406 }
407 }
408 }
409
410 keymap.swap (sorted_keymap);
411
412 #if defined (DEBUG_STRICT) || defined (DEBUG_KEYBOARD)
413 // check for invariants
414 for (i = 0; i < KEYSYM_HASH_BUDGETS; ++i)
415 {
416 index = hash[i];
417 for (int j = 0; j < hash_budget_size [i]; ++j)
418 {
419 if (keymap [index + j]->range == 1)
420 assert (i == (keymap [index + j]->keysym & KEYSYM_HASH_MASK));
421
422 if (j)
423 assert (compare_priority (keymap [index + j - 1],
424 keymap [index + j]) >= 0);
425 }
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 int index = find_keysym (a->keysym + j, a->state);
435
436 assert (index >= 0);
437 keysym_t *b = keymap [index];
438 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 }
441 }
442 #endif
443 }
444
445 int
446 keyboard_manager::find_keysym (KeySym keysym, unsigned int state)
447 {
448 int hashkey = keysym & KEYSYM_HASH_MASK;
449 unsigned int index = hash [hashkey];
450
451 for (; index < keymap.size (); ++index)
452 {
453 keysym_t *key = keymap [index];
454 assert (key);
455
456 if (key->keysym <= keysym && key->keysym + key->range > keysym
457 // match only the specified bits in state and ignore others
458 && (key->state & state) == key->state)
459 return index;
460 else if (key->keysym > keysym && key->range == 1)
461 return -1;
462 }
463
464 return -1;
465 }
466
467 #endif /* KEYSYM_RESOURCE */
468 // vim:et:ts=2:sw=2