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

Diff Legend

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