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.4 by root, Sun Jan 16 18:57:03 2005 UTC vs.
Revision 1.61 by sf-exg, Sat Apr 26 15:05:17 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
62 * n(the number of groups) = the number of non-zero member of hash_bucket_size[];
63 * Ni(the size of group i) = hash_bucket_size[Ii].
64 */
36 65
37static void 66static void
38output_string (rxvt_term *rt, const char *str) 67output_string (rxvt_term *term, const char *str)
39{ 68{
40 assert (rt && str); 69 if (strncmp (str, "command:", 8) == 0)
41 70 term->cmdbuf_append (str + 8, strlen (str) - 8);
42 if (strncmp (str, "proto:", 6) == 0) 71 else if (strncmp (str, "perl:", 5) == 0)
43 rt->cmd_write ((unsigned char *)str + 6, strlen (str) - 6); 72 HOOK_INVOKE((term, HOOK_USER_COMMAND, DT_STR, str + 5, DT_END));
44 else 73 else
45 rt->tt_write ((unsigned char *)str, strlen (str)); 74 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
63 ch = C0_ESC;
64 rt->tt_write (&ch, 1);
65 }
66 }
67
68 rt->tt_write ((unsigned char *) buf, buflen);
69}
70
71static int
72format_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'
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} 75}
101 76
102// return: priority_of_a - priority_of_b 77// return: priority_of_a - priority_of_b
103static int 78static int
104compare_priority (keysym_t *a, keysym_t *b) 79compare_priority (keysym_t *a, keysym_t *b)
105{ 80{
106 assert (a && b);
107
108 // (the more '1's in state; the less range): the greater priority 81 // (the more '1's in state; the less range): the greater priority
109 int ca = bitcount (a->state /* & OtherModMask */); 82 int ca = ecb_popcount32 (a->state /* & OtherModMask */);
110 int cb = bitcount (b->state /* & OtherModMask */); 83 int cb = ecb_popcount32 (b->state /* & OtherModMask */);
111 84
112 if (ca != cb)
113 return ca - cb; 85 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} 86}
119 87
120//////////////////////////////////////////////////////////////////////////////// 88////////////////////////////////////////////////////////////////////////////////
121keyboard_manager::keyboard_manager () 89keyboard_manager::keyboard_manager ()
122{ 90{
… …
124 hash [0] = 1; // hash[0] != 0 indicates uninitialized data 92 hash [0] = 1; // hash[0] != 0 indicates uninitialized data
125} 93}
126 94
127keyboard_manager::~keyboard_manager () 95keyboard_manager::~keyboard_manager ()
128{ 96{
129 clear (); 97 for (unsigned int i = 0; i < keymap.size (); ++i)
98 {
99 free (keymap [i]->str);
100 delete keymap [i];
101 }
130} 102}
131 103
132void 104void
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) 105keyboard_manager::register_user_translation (KeySym keysym, unsigned int state, const wchar_t *ws)
161{ 106{
162 assert (trans); 107 char *translation = rxvt_wcstoutf8 (ws);
163 108
164 keysym_t *key = new keysym_t; 109 keysym_t *key = new keysym_t;
165 wchar_t *wc = rxvt_mbstowcs (trans);
166 const char *translation = rxvt_wcstoutf8 (wc);
167 free (wc);
168 110
169 if (key && translation)
170 {
171 key->keysym = keysym; 111 key->keysym = keysym;
172 key->state = state; 112 key->state = state;
173 key->range = 1;
174 key->str = translation; 113 key->str = translation;
175 key->type = keysym_t::NORMAL; 114 key->type = keysym_t::STRING;
176 115
177 if (strncmp (translation, "list", 4) == 0 && translation [4]) 116 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; 117 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 118
215 if (keymap.size () == keymap.capacity ()) 119 if (keymap.size () == keymap.capacity ())
216 keymap.reserve (keymap.size () * 2); 120 keymap.reserve (keymap.size () * 2);
217 121
218 keymap.push_back (key); 122 keymap.push_back (key);
219 hash[0] = 3; 123 hash[0] = 3;
220} 124}
221 125
126bool
127keyboard_manager::dispatch (rxvt_term *term, KeySym keysym, unsigned int state, const char *kbuf, int len)
128{
129 assert (("register_done() need to be called", hash[0] == 0));
130
131 state &= OtherModMask; // mask out uninteresting modifiers
132
133 if (state & term->ModMetaMask) state |= MetaMask;
134 if (state & term->ModNumLockMask) state |= NumLockMask;
135 if (state & term->ModLevel3Mask) state |= Level3Mask;
136
137 if (!!(term->priv_modes & PrivMode_aplKP) != !!(state & ShiftMask))
138 state |= AppKeypadMask;
139
140 int index = find_keysym (keysym, state);
141
142 if (index >= 0)
143 {
144 keysym_t *key = keymap [index];
145
146 if (key->type != keysym_t::BUILTIN)
147 {
148 wchar_t *ws = rxvt_utf8towcs (key->str);
149 char *str = rxvt_wcstombs (ws);
150 // TODO: do (some) translations, unescaping etc, here (allow \u escape etc.)
151 free (ws);
152
153 output_string (term, str);
154
155 free (str);
156
157 return true;
158 }
159 }
160
161 return false;
162}
163
222void 164void
223keyboard_manager::register_done () 165keyboard_manager::register_done ()
224{ 166{
225 unsigned int i, n = sizeof (stock_keymap) / sizeof (keysym_t); 167 unsigned int i, index, hashkey;
168 uint16_t hash_bucket_size[KEYSYM_HASH_BUCKETS]; // size of each bucket
226 169
227 if (keymap.back () != &stock_keymap[n - 1]) 170 memset (hash_bucket_size, 0, sizeof (hash_bucket_size));
228 for (i = 0; i < n; ++i)
229 register_keymap (&stock_keymap[i]);
230 171
231 purge_duplicate_keymap (); 172 // determine hash bucket size
232 173 for (i = 0; i < keymap.size (); ++i)
233 setup_hash (); 174 {
234} 175 hashkey = keymap [i]->keysym & KEYSYM_HASH_MASK;
235 176 ++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 { 177 }
254 assert (term && keymap [index]);
255 const keysym_t &key = *keymap [index];
256 178
257 int keysym_offset = keysym - key.keysym; 179 // now we know the size of each bucket
180 // compute the index of each bucket
181 for (index = 0, i = 0; i < KEYSYM_HASH_BUCKETS; ++i)
182 {
183 hash [i] = index;
184 index += hash_bucket_size [i];
185 }
258 186
259 wchar_t *wc = rxvt_utf8towcs (key.str); 187 // and allocate just enough space
260 char *str = rxvt_wcstombs (wc); 188 simplevec <keysym_t *> sorted_keymap (index, 0);
261 // TODO: do translations, unescaping etc, here (allow \u escape etc.)
262 free (wc);
263 189
264 switch (key.type) 190 memset (hash_bucket_size, 0, sizeof (hash_bucket_size));
191
192 // fill in sorted_keymap
193 // it is sorted in each bucket
194 for (i = 0; i < keymap.size (); ++i)
195 {
196 hashkey = keymap [i]->keysym & KEYSYM_HASH_MASK;
197
198 index = hash [hashkey] + hash_bucket_size [hashkey];
199
200 while (index > hash [hashkey]
201 && compare_priority (keymap [i], sorted_keymap [index - 1]) > 0)
265 { 202 {
266 case keysym_t::NORMAL: 203 sorted_keymap [index] = sorted_keymap [index - 1];
267 output_string (term, str); 204 --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 } 205 }
308 206
309 free (str); 207 sorted_keymap [index] = keymap [i];
310 208 ++hash_bucket_size [hashkey];
311 return true;
312 }
313 else
314 { 209 }
315 // fprintf(stderr,"[%x:%x]",state,keysym); 210
316 return false; 211 keymap.swap (sorted_keymap);
212
213#ifndef NDEBUG
214 // check for invariants
215 for (i = 0; i < KEYSYM_HASH_BUCKETS; ++i)
317 } 216 {
318} 217 index = hash[i];
319 218 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 { 219 {
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)); 220 assert (i == (keymap [index + j]->keysym & KEYSYM_HASH_MASK));
426 221
427 if (j) 222 if (j)
428 assert (compare_priority (keymap [index + j - 1], 223 assert (compare_priority (keymap [index + j - 1],
429 keymap [index + j]) >= 0); 224 keymap [index + j]) >= 0);
430 } 225 }
… …
432 227
433 // this should be able to detect most possible bugs 228 // this should be able to detect most possible bugs
434 for (i = 0; i < sorted_keymap.size (); ++i) 229 for (i = 0; i < sorted_keymap.size (); ++i)
435 { 230 {
436 keysym_t *a = sorted_keymap[i]; 231 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); 232 int index = find_keysym (a->keysym, a->state);
233
440 assert (index >= 0); 234 assert (index >= 0);
441 keysym_t *b = keymap [index]; 235 keysym_t *b = keymap [index];
442 assert (i == (signed) index || // the normally expected result 236 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 237 || a->keysym == b->keysym
444 } 238 && compare_priority (a, b) <= 0); // is effectively the same or a closer match
445 } 239 }
446#endif 240#endif
447} 241}
448 242
449int 243int
450keyboard_manager::find_keysym (KeySym keysym, unsigned int state) 244keyboard_manager::find_keysym (KeySym keysym, unsigned int state)
451{ 245{
452 int hashkey = keysym & KEYSYM_HASH_MASK; 246 int hashkey = keysym & KEYSYM_HASH_MASK;
453 unsigned int index = hash [hashkey]; 247 unsigned int index = hash [hashkey];
248 unsigned int end = hashkey < KEYSYM_HASH_BUCKETS - 1
249 ? hash [hashkey + 1]
250 : keymap.size ();
454 251
455 for (; index < keymap.size (); ++index) 252 for (; index < end; ++index)
456 { 253 {
457 keysym_t *key = keymap [index]; 254 keysym_t *key = keymap [index];
458 assert (key);
459 255
460 if (key->keysym <= keysym && key->keysym + key->range > keysym 256 if (key->keysym == keysym
461 // match only the specified bits in state and ignore others 257 // match only the specified bits in state and ignore others
462 && (key->state & OtherModMask) == (key->state & state)) 258 && (key->state & state) == key->state)
463 return index; 259 return index;
464 else if (key->keysym > keysym && key->range == 1)
465 return -1;
466 } 260 }
467 261
468 return -1; 262 return -1;
469} 263}
470 264

Diff Legend

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