ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/src/keyboard.C
(Generate patch)

Comparing rxvt-unicode/src/keyboard.C (file contents):
Revision 1.5 by root, Sun Jan 16 19:03:45 2005 UTC vs.
Revision 1.62 by root, Sat Apr 26 18:53:51 2014 UTC

1/*----------------------------------------------------------------------*
2 * File: keyboard.C
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 <schmorp@schmorp.de>
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
1#include "../config.h" 24#include "../config.h"
2#include "rxvt.h" 25#include "rxvt.h"
26
27#ifdef KEYSYM_RESOURCE
28
29#include <string.h>
30
31#include "rxvtperl.h"
3#include "keyboard.h" 32#include "keyboard.h"
4#include "command.h"
5#include <string.h>
6#include <X11/X.h>
7 33
8#ifdef KEYSYM_RESOURCE 34/* an intro to the data structure:
9 35 *
10//////////////////////////////////////////////////////////////////////////////// 36 * vector keymap[] is grouped.
11// default keycode translation map and keyevent handlers 37 *
12 38 * inside each group, elements are sorted by the criteria given by compare_priority().
13keysym_t keyboard_manager::stock_keymap[] = { 39 * the lookup of keysym is done in two steps:
14 /* examples */ 40 * 1) locate the group corresponds to the keysym;
15 /* keysym, state, range, handler, str */ 41 * 2) do a linear search inside the group.
16//{XK_ISO_Left_Tab, 0, 1, NORMAL, "\033[Z"}, 42 *
17//{ 'a', 0, 26, RANGE_META8, "a" "%c"}, 43 * array hash[] effectively defines a map from a keysym to a group in keymap[].
18//{ 'a', ControlMask, 26, RANGE_META8, "" "%c"}, 44 *
19//{ XK_Left, 0, 4, LIST, "DACBZ" "\033[Z"}, 45 * each group has its address(the index of first group element in keymap[]),
20//{ XK_Left, ShiftMask, 4, LIST, "dacbZ" "\033[Z"}, 46 * which is computed and stored in hash[].
21//{ XK_Left, ControlMask, 4, LIST, "dacbZ" "\033OZ"}, 47 * hash[] stores the addresses in the form of:
22//{ XK_Tab, ControlMask, 1, NORMAL, "\033<C-Tab>"}, 48 * index: 0 I1 I2 I3 In
23//{ XK_apostrophe, ControlMask, 1, NORMAL, "\033<C-'>"}, 49 * value: 0...0, A1...A1, A2...A2, A3...A3, ..., An...An
24//{ XK_slash, ControlMask, 1, NORMAL, "\033<C-/>"}, 50 * where
25//{ XK_semicolon, ControlMask, 1, NORMAL, "\033<C-;>"}, 51 * A1 = 0;
26//{ XK_grave, ControlMask, 1, NORMAL, "\033<C-`>"}, 52 * Ai+1 = N1 + N2 + ... + Ni.
27//{ XK_comma, ControlMask, 1, NORMAL, "\033<C-\054>"}, 53 * it is computed from hash_bucket_size[]:
28//{ XK_Return, ControlMask, 1, NORMAL, "\033<C-Return>"}, 54 * index: 0 I1 I2 I3 In
29//{ XK_Return, ShiftMask, 1, NORMAL, "\033<S-Return>"}, 55 * value: 0...0, N1, 0...0, N2, 0...0, N3, ..., Nn, 0...0
30//{ ' ', ShiftMask, 1, NORMAL, "\033<S-Space>"}, 56 * 0...0, 0.......0, N1.....N1, N1+N2...N1+N2, ... (the computation of hash[])
31//{ '.', ControlMask, 1, NORMAL, "\033<C-.>"}, 57 * or we can say
32//{ '0', ControlMask, 10, RANGE, "0" "\033<C-%c>"}, 58 * hash_bucket_size[Ii] = Ni; hash_bucket_size[elsewhere] = 0,
33//{ '0', MetaMask|ControlMask, 10, RANGE, "0" "\033<M-C-%c>"}, 59 * where
34//{ 'a', MetaMask|ControlMask, 26, RANGE, "a" "\033<M-C-%c>"}, 60 * set {I1, I2, ..., In} = { hashkey of keymap[0]->keysym, ..., keymap[keymap.size-1]->keysym }
35}; 61 * where hashkey of keymap[i]->keysym = keymap[i]->keysym & KEYSYM_HASH_MASK
36 62 * n(the number of groups) = the number of non-zero member of hash_bucket_size[];
37static void 63 * Ni(the size of group i) = hash_bucket_size[Ii].
38output_string (rxvt_term *rt, const char *str) 64 */
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
48static void
49output_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 ch = C0_ESC;
63 rt->tt_write (&ch, 1);
64 }
65 }
66
67 rt->tt_write ((unsigned char *) buf, buflen);
68}
69
70static int
71format_keyrange_string (const char *str, int keysym_offset, char *buf, int bufsize)
72{
73 int len = snprintf (buf, bufsize, str + 1, keysym_offset + str [0]);
74
75 if (len >= bufsize)
76 {
77 rxvt_warn ("buffer overflowed!\n");
78 *buf = 0;
79 }
80 else if (len < 0)
81 {
82 rxvt_warn ("keyrange_translator(), snprintf error");
83 *buf = 0;
84 }
85
86 return len;
87}
88
89////////////////////////////////////////////////////////////////////////////////
90// return: #bits of '1'
91static int
92bitcount (unsigned int n)
93{
94 int i;
95
96 for (i = 0; n; ++i, n &= (n - 1))
97 ;
98
99 return i;
100}
101 65
102// return: priority_of_a - priority_of_b 66// return: priority_of_a - priority_of_b
103static int 67static int
104compare_priority (keysym_t *a, keysym_t *b) 68compare_priority (keysym_t *a, keysym_t *b)
105{ 69{
106 assert (a && b);
107
108 // (the more '1's in state; the less range): the greater priority 70 // (the more '1's in state; the less range): the greater priority
109 int ca = bitcount (a->state /* & OtherModMask */); 71 int ca = ecb_popcount32 (a->state /* & OtherModMask */);
110 int cb = bitcount (b->state /* & OtherModMask */); 72 int cb = ecb_popcount32 (b->state /* & OtherModMask */);
111 73
112 if (ca != cb)
113 return ca - cb; 74 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} 75}
119 76
120//////////////////////////////////////////////////////////////////////////////// 77////////////////////////////////////////////////////////////////////////////////
121keyboard_manager::keyboard_manager () 78keyboard_manager::keyboard_manager ()
122{ 79{
… …
124 hash [0] = 1; // hash[0] != 0 indicates uninitialized data 81 hash [0] = 1; // hash[0] != 0 indicates uninitialized data
125} 82}
126 83
127keyboard_manager::~keyboard_manager () 84keyboard_manager::~keyboard_manager ()
128{ 85{
129 clear (); 86 for (unsigned int i = 0; i < keymap.size (); ++i)
87 {
88 free (keymap [i]->str);
89 delete keymap [i];
90 }
130} 91}
131 92
132void 93void
133keyboard_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.
159void
160keyboard_manager::register_user_translation (KeySym keysym, unsigned int state, const char *trans) 94keyboard_manager::register_user_translation (KeySym keysym, unsigned int state, const wchar_t *ws)
161{ 95{
162 assert (trans); 96 char *translation = rxvt_wcstoutf8 (ws);
163 97
164 keysym_t *key = new keysym_t; 98 keysym_t *key = new keysym_t;
165 wchar_t *wc = rxvt_mbstowcs (trans);
166 const char *translation = rxvt_wcstoutf8 (wc);
167 free (wc);
168 99
169 if (key && translation)
170 {
171 key->keysym = keysym; 100 key->keysym = keysym;
172 key->state = state; 101 key->state = state;
173 key->range = 1;
174 key->str = translation; 102 key->str = translation;
175 key->type = keysym_t::NORMAL; 103 key->type = keysym_t::STRING;
176 104
177 if (strncmp (translation, "list", 4) == 0 && translation [4]) 105 if (strncmp (translation, "builtin:", 8) == 0)
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; 106 key->type = keysym_t::BUILTIN;
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
209void
210keyboard_manager::register_keymap (keysym_t *key)
211{
212 assert (key);
213 assert (key->range >= 1);
214 107
215 if (keymap.size () == keymap.capacity ()) 108 if (keymap.size () == keymap.capacity ())
216 keymap.reserve (keymap.size () * 2); 109 keymap.reserve (keymap.size () * 2);
217 110
218 keymap.push_back (key); 111 keymap.push_back (key);
219 hash[0] = 3; 112 hash[0] = 3;
220} 113}
221 114
115bool
116keyboard_manager::dispatch (rxvt_term *term, KeySym keysym, unsigned int state, const char *kbuf, int len)
117{
118 assert (("register_done() need to be called", hash[0] == 0));
119
120 state &= OtherModMask; // mask out uninteresting modifiers
121
122 if (state & term->ModMetaMask) state |= MetaMask;
123 if (state & term->ModNumLockMask) state |= NumLockMask;
124 if (state & term->ModLevel3Mask) state |= Level3Mask;
125
126 if (!!(term->priv_modes & PrivMode_aplKP) != !!(state & ShiftMask))
127 state |= AppKeypadMask;
128
129 int index = find_keysym (keysym, state);
130
131 if (index >= 0)
132 {
133 keysym_t *key = keymap [index];
134
135 if (key->type != keysym_t::BUILTIN)
136 {
137 wchar_t *ws = rxvt_utf8towcs (key->str);
138 char *str = rxvt_wcstombs (ws);
139 // TODO: do (some) translations, unescaping etc, here (allow \u escape etc.)
140 free (ws);
141
142 if (char *colon = strchr (str, ':'))
143 {
144 if (strncmp (str, "command:", 8) == 0)
145 term->cmdbuf_append (str + 8, strlen (str) - 8);
146 else if (strncmp (str, "perl:", 8) == 0)
147 HOOK_INVOKE ((term, HOOK_USER_COMMAND, DT_STR, colon + 1, DT_END));
148 else if (HOOK_INVOKE ((term, HOOK_KEYBOARD_DISPATCH, DT_STR_LEN, str, colon - str, DT_STR, colon + 1, DT_END)))
149 /* done */;
150 else
151 term->tt_write (str, strlen (str));
152 }
153
154 free (str);
155
156 return true;
157 }
158 }
159
160 return false;
161}
162
222void 163void
223keyboard_manager::register_done () 164keyboard_manager::register_done ()
224{ 165{
225 unsigned int i, n = sizeof (stock_keymap) / sizeof (keysym_t); 166 unsigned int i, index, hashkey;
167 uint16_t hash_bucket_size[KEYSYM_HASH_BUCKETS]; // size of each bucket
226 168
227 if (keymap.back () != &stock_keymap[n - 1]) 169 memset (hash_bucket_size, 0, sizeof (hash_bucket_size));
228 for (i = 0; i < n; ++i)
229 register_keymap (&stock_keymap[i]);
230 170
231 purge_duplicate_keymap (); 171 // determine hash bucket size
232 172 for (i = 0; i < keymap.size (); ++i)
233 setup_hash (); 173 {
234} 174 hashkey = keymap [i]->keysym & KEYSYM_HASH_MASK;
235 175 ++hash_bucket_size [hashkey];
236bool
237keyboard_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 { 176 }
254 assert (term && keymap [index]);
255 const keysym_t &key = *keymap [index];
256 177
257 int keysym_offset = keysym - key.keysym; 178 // now we know the size of each bucket
179 // compute the index of each bucket
180 for (index = 0, i = 0; i < KEYSYM_HASH_BUCKETS; ++i)
181 {
182 hash [i] = index;
183 index += hash_bucket_size [i];
184 }
258 185
259 wchar_t *wc = rxvt_utf8towcs (key.str); 186 // and allocate just enough space
260 char *str = rxvt_wcstombs (wc); 187 simplevec <keysym_t *> sorted_keymap (index, 0);
261 // TODO: do translations, unescaping etc, here (allow \u escape etc.)
262 free (wc);
263 188
264 switch (key.type) 189 memset (hash_bucket_size, 0, sizeof (hash_bucket_size));
190
191 // fill in sorted_keymap
192 // it is sorted in each bucket
193 for (i = 0; i < keymap.size (); ++i)
194 {
195 hashkey = keymap [i]->keysym & KEYSYM_HASH_MASK;
196
197 index = hash [hashkey] + hash_bucket_size [hashkey];
198
199 while (index > hash [hashkey]
200 && compare_priority (keymap [i], sorted_keymap [index - 1]) > 0)
265 { 201 {
266 case keysym_t::NORMAL: 202 sorted_keymap [index] = sorted_keymap [index - 1];
267 output_string (term, str); 203 --index;
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 } 204 }
308 205
309 free (str); 206 sorted_keymap [index] = keymap [i];
310 207 ++hash_bucket_size [hashkey];
311 return true;
312 }
313 else
314 { 208 }
315 // fprintf(stderr,"[%x:%x]",state,keysym); 209
316 return false; 210 keymap.swap (sorted_keymap);
211
212#ifndef NDEBUG
213 // check for invariants
214 for (i = 0; i < KEYSYM_HASH_BUCKETS; ++i)
317 } 215 {
318} 216 index = hash[i];
319 217 for (int j = 0; j < hash_bucket_size [i]; ++j)
320// purge duplicate keymap entries
321void 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 { 218 {
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
343void
344keyboard_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)); 219 assert (i == (keymap [index + j]->keysym & KEYSYM_HASH_MASK));
426 220
427 if (j) 221 if (j)
428 assert (compare_priority (keymap [index + j - 1], 222 assert (compare_priority (keymap [index + j - 1],
429 keymap [index + j]) >= 0); 223 keymap [index + j]) >= 0);
430 } 224 }
… …
432 226
433 // this should be able to detect most possible bugs 227 // this should be able to detect most possible bugs
434 for (i = 0; i < sorted_keymap.size (); ++i) 228 for (i = 0; i < sorted_keymap.size (); ++i)
435 { 229 {
436 keysym_t *a = sorted_keymap[i]; 230 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); 231 int index = find_keysym (a->keysym, a->state);
232
440 assert (index >= 0); 233 assert (index >= 0);
441 keysym_t *b = keymap [index]; 234 keysym_t *b = keymap [index];
442 assert (i == (signed) index || // the normally expected result 235 assert (i == 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 236 || a->keysym == b->keysym
444 } 237 && compare_priority (a, b) <= 0); // is effectively the same or a closer match
445 } 238 }
446#endif 239#endif
447} 240}
448 241
449int 242int
450keyboard_manager::find_keysym (KeySym keysym, unsigned int state) 243keyboard_manager::find_keysym (KeySym keysym, unsigned int state)
451{ 244{
452 int hashkey = keysym & KEYSYM_HASH_MASK; 245 int hashkey = keysym & KEYSYM_HASH_MASK;
453 unsigned int index = hash [hashkey]; 246 unsigned int index = hash [hashkey];
247 unsigned int end = hashkey < KEYSYM_HASH_BUCKETS - 1
248 ? hash [hashkey + 1]
249 : keymap.size ();
454 250
455 for (; index < keymap.size (); ++index) 251 for (; index < end; ++index)
456 { 252 {
457 keysym_t *key = keymap [index]; 253 keysym_t *key = keymap [index];
458 assert (key);
459 254
460 if (key->keysym <= keysym && key->keysym + key->range > keysym 255 if (key->keysym == keysym
461 // match only the specified bits in state and ignore others 256 // match only the specified bits in state and ignore others
462 && (key->state & OtherModMask) == (key->state & state)) 257 && (key->state & state) == key->state)
463 return index; 258 return index;
464 else if (key->keysym > keysym && key->range == 1)
465 return -1;
466 } 259 }
467 260
468 return -1; 261 return -1;
469} 262}
470 263

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines