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.26 by root, Mon Oct 9 23:12:45 2006 UTC vs.
Revision 1.61 by sf-exg, Sat Apr 26 15:05:17 2014 UTC

… …
2 * File: keyboard.C 2 * File: keyboard.C
3 *----------------------------------------------------------------------* 3 *----------------------------------------------------------------------*
4 * 4 *
5 * All portions of code are copyright by their respective author/s. 5 * All portions of code are copyright by their respective author/s.
6 * Copyright (c) 2005 WU Fengguang 6 * Copyright (c) 2005 WU Fengguang
7 * Copyright (c) 2005-2006 Marc Lehmann <pcg@goof.com> 7 * Copyright (c) 2005-2006 Marc Lehmann <schmorp@schmorp.de>
8 * 8 *
9 * This program is free software; you can redistribute it and/or modify 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 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 11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version. 12 * (at your option) any later version.
… …
24#include "../config.h" 24#include "../config.h"
25#include "rxvt.h" 25#include "rxvt.h"
26 26
27#ifdef KEYSYM_RESOURCE 27#ifdef KEYSYM_RESOURCE
28 28
29#include <cstring> 29#include <string.h>
30 30
31#include "rxvtperl.h" 31#include "rxvtperl.h"
32#include "keyboard.h" 32#include "keyboard.h"
33#include "command.h"
34 33
35/* an intro to the data structure: 34/* an intro to the data structure:
36 * 35 *
37 * vector keymap[] is grouped. 36 * vector keymap[] is grouped.
38 * 37 *
… …
49 * index: 0 I1 I2 I3 In 48 * index: 0 I1 I2 I3 In
50 * value: 0...0, A1...A1, A2...A2, A3...A3, ..., An...An 49 * value: 0...0, A1...A1, A2...A2, A3...A3, ..., An...An
51 * where 50 * where
52 * A1 = 0; 51 * A1 = 0;
53 * Ai+1 = N1 + N2 + ... + Ni. 52 * Ai+1 = N1 + N2 + ... + Ni.
54 * it is computed from hash_budget_size[]: 53 * it is computed from hash_bucket_size[]:
55 * index: 0 I1 I2 I3 In 54 * index: 0 I1 I2 I3 In
56 * value: 0...0, N1, 0...0, N2, 0...0, N3, ..., Nn, 0...0 55 * value: 0...0, N1, 0...0, N2, 0...0, N3, ..., Nn, 0...0
57 * 0...0, 0.......0, N1.....N1, N1+N2...N1+N2, ... (the compution of hash[]) 56 * 0...0, 0.......0, N1.....N1, N1+N2...N1+N2, ... (the computation of hash[])
58 * or we can say 57 * or we can say
59 * hash_budget_size[Ii] = Ni; hash_budget_size[elsewhere] = 0, 58 * hash_bucket_size[Ii] = Ni; hash_bucket_size[elsewhere] = 0,
60 * where 59 * where
61 * set {I1, I2, ..., In} = { hashkey of keymap[0]->keysym, ..., keymap[keymap.size-1]->keysym } 60 * set {I1, I2, ..., In} = { hashkey of keymap[0]->keysym, ..., keymap[keymap.size-1]->keysym }
62 * where hashkey of keymap[i]->keysym = keymap[i]->keysym & KEYSYM_HASH_MASK 61 * 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_budget_size[]; 62 * n(the number of groups) = the number of non-zero member of hash_bucket_size[];
64 * Ni(the size of group i) = hash_budget_size[Ii]. 63 * Ni(the size of group i) = hash_bucket_size[Ii].
65 */ 64 */
66 65
67#if STOCK_KEYMAP
68////////////////////////////////////////////////////////////////////////////////
69// default keycode translation map and keyevent handlers
70
71keysym_t keyboard_manager::stock_keymap[] = {
72 /* examples */
73 /* keysym, state, range, handler, str */
74//{XK_ISO_Left_Tab, 0, 1, keysym_t::STRING, "\033[Z"},
75//{ 'a', 0, 26, keysym_t::RANGE_META8, "a" "%c"},
76//{ 'a', ControlMask, 26, keysym_t::RANGE_META8, "" "%c"},
77//{ XK_Left, 0, 4, keysym_t::LIST, ".\033[.DACB."},
78//{ XK_Left, ShiftMask, 4, keysym_t::LIST, ".\033[.dacb."},
79//{ XK_Left, ControlMask, 4, keysym_t::LIST, ".\033O.dacb."},
80//{ XK_Tab, ControlMask, 1, keysym_t::STRING, "\033<C-Tab>"},
81//{ XK_apostrophe, ControlMask, 1, keysym_t::STRING, "\033<C-'>"},
82//{ XK_slash, ControlMask, 1, keysym_t::STRING, "\033<C-/>"},
83//{ XK_semicolon, ControlMask, 1, keysym_t::STRING, "\033<C-;>"},
84//{ XK_grave, ControlMask, 1, keysym_t::STRING, "\033<C-`>"},
85//{ XK_comma, ControlMask, 1, keysym_t::STRING, "\033<C-\054>"},
86//{ XK_Return, ControlMask, 1, keysym_t::STRING, "\033<C-Return>"},
87//{ XK_Return, ShiftMask, 1, keysym_t::STRING, "\033<S-Return>"},
88//{ ' ', ShiftMask, 1, keysym_t::STRING, "\033<S-Space>"},
89//{ '.', ControlMask, 1, keysym_t::STRING, "\033<C-.>"},
90//{ '0', ControlMask, 10, keysym_t::RANGE, "0" "\033<C-%c>"},
91//{ '0', MetaMask|ControlMask, 10, keysym_t::RANGE, "0" "\033<M-C-%c>"},
92//{ 'a', MetaMask|ControlMask, 26, keysym_t::RANGE, "a" "\033<M-C-%c>"},
93};
94#endif
95
96static void 66static void
97output_string (rxvt_term *rt, const char *str) 67output_string (rxvt_term *term, const char *str)
98{ 68{
99 if (strncmp (str, "command:", 8) == 0) 69 if (strncmp (str, "command:", 8) == 0)
100 rt->cmd_write (str + 8, strlen (str) - 8); 70 term->cmdbuf_append (str + 8, strlen (str) - 8);
101 else if (strncmp (str, "perl:", 5) == 0) 71 else if (strncmp (str, "perl:", 5) == 0)
102 HOOK_INVOKE((rt, HOOK_USER_COMMAND, DT_STR, str + 5, DT_END)); 72 HOOK_INVOKE((term, HOOK_USER_COMMAND, DT_STR, str + 5, DT_END));
103 else 73 else
104 rt->tt_write (str, strlen (str)); 74 term->tt_write (str, strlen (str));
105} 75}
106
107static void
108output_string_meta8 (rxvt_term *rt, unsigned int state, char *buf, int buflen)
109{
110 if (state & rt->ModMetaMask)
111 {
112#ifdef META8_OPTION
113 if (rt->meta_char == 0x80) /* set 8-bit on */
114 {
115 for (char *ch = buf; ch < buf + buflen; ch++)
116 *ch |= 0x80;
117 }
118 else if (rt->meta_char == C0_ESC) /* escape prefix */
119#endif
120 {
121 const char ch = C0_ESC;
122 rt->tt_write (&ch, 1);
123 }
124 }
125
126 rt->tt_write (buf, buflen);
127}
128
129static int
130format_keyrange_string (const char *str, int keysym_offset, char *buf, int bufsize)
131{
132 size_t len = snprintf (buf, bufsize, str + 1, keysym_offset + str [0]);
133
134 if (len >= (size_t)bufsize)
135 {
136 rxvt_warn ("format_keyrange_string: formatting failed, ignoring key.\n");
137 *buf = 0;
138 }
139
140 return len;
141}
142
143////////////////////////////////////////////////////////////////////////////////
144// return: #bits of '1'
145#if __GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ > 3)
146# define bitcount(n) (__extension__ ({ uint32_t n__ = (n); __builtin_popcount (n__); }))
147#else
148static int
149bitcount (uint16_t n)
150{
151 int i;
152
153 for (i = 0; n; ++i, n &= n - 1)
154 ;
155
156 return i;
157}
158#endif
159 76
160// return: priority_of_a - priority_of_b 77// return: priority_of_a - priority_of_b
161static int 78static int
162compare_priority (keysym_t *a, keysym_t *b) 79compare_priority (keysym_t *a, keysym_t *b)
163{ 80{
164 // (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
165 int ca = bitcount (a->state /* & OtherModMask */); 82 int ca = ecb_popcount32 (a->state /* & OtherModMask */);
166 int cb = bitcount (b->state /* & OtherModMask */); 83 int cb = ecb_popcount32 (b->state /* & OtherModMask */);
167 84
168 if (ca != cb)
169 return ca - cb; 85 return ca - cb;
170//else if (a->state != b->state) // this behavior is to be disscussed
171// return b->state - a->state;
172 else
173 return b->range - a->range;
174} 86}
175 87
176//////////////////////////////////////////////////////////////////////////////// 88////////////////////////////////////////////////////////////////////////////////
177keyboard_manager::keyboard_manager () 89keyboard_manager::keyboard_manager ()
178{ 90{
… …
180 hash [0] = 1; // hash[0] != 0 indicates uninitialized data 92 hash [0] = 1; // hash[0] != 0 indicates uninitialized data
181} 93}
182 94
183keyboard_manager::~keyboard_manager () 95keyboard_manager::~keyboard_manager ()
184{ 96{
185 clear (); 97 for (unsigned int i = 0; i < keymap.size (); ++i)
98 {
99 free (keymap [i]->str);
100 delete keymap [i];
101 }
186} 102}
187 103
188void 104void
189keyboard_manager::clear ()
190{
191 keymap.clear ();
192 hash [0] = 2;
193
194 for (unsigned int i = 0; i < user_translations.size (); ++i)
195 {
196 free ((void *)user_translations [i]);
197 user_translations [i] = 0;
198 }
199
200 for (unsigned int i = 0; i < user_keymap.size (); ++i)
201 {
202 delete user_keymap [i];
203 user_keymap [i] = 0;
204 }
205
206 user_keymap.clear ();
207 user_translations.clear ();
208}
209
210// a wrapper for register_keymap,
211// so that outside codes don't have to know so much details.
212//
213// the string 'trans' is copied to an internal managed buffer,
214// so the caller can free memory of 'trans' at any time.
215void
216keyboard_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)
217{ 106{
107 char *translation = rxvt_wcstoutf8 (ws);
108
218 keysym_t *key = new keysym_t; 109 keysym_t *key = new keysym_t;
219 wchar_t *wc = rxvt_mbstowcs (trans);
220 char *translation = rxvt_wcstoutf8 (wc);
221 free (wc);
222 110
223 if (key && translation)
224 {
225 key->keysym = keysym; 111 key->keysym = keysym;
226 key->state = state; 112 key->state = state;
227 key->range = 1;
228 key->str = translation; 113 key->str = translation;
229 key->type = keysym_t::STRING; 114 key->type = keysym_t::STRING;
230 115
231 if (strncmp (translation, "list", 4) == 0 && translation [4])
232 {
233 char *middle = strchr (translation + 5, translation [4]);
234 char *suffix = strrchr (translation + 5, translation [4]);
235
236 if (suffix && middle && suffix > middle + 1)
237 {
238 key->type = keysym_t::LIST;
239 key->range = suffix - middle - 1;
240
241 memmove (translation, translation + 4, strlen (translation + 4) + 1);
242 }
243 else
244 rxvt_warn ("cannot parse list-type keysym '%s', treating as normal keysym.\n", translation);
245 }
246 else if (strncmp (translation, "builtin:", 8) == 0) 116 if (strncmp (translation, "builtin:", 8) == 0)
247 key->type = keysym_t::BUILTIN; 117 key->type = keysym_t::BUILTIN;
248 118
249 user_keymap.push_back (key);
250 user_translations.push_back (translation);
251 register_keymap (key);
252 }
253 else
254 {
255 delete key;
256 free ((void *)translation);
257 rxvt_fatal ("out of memory, aborting.\n");
258 }
259}
260
261void
262keyboard_manager::register_keymap (keysym_t *key)
263{
264 if (keymap.size () == keymap.capacity ()) 119 if (keymap.size () == keymap.capacity ())
265 keymap.reserve (keymap.size () * 2); 120 keymap.reserve (keymap.size () * 2);
266 121
267 keymap.push_back (key); 122 keymap.push_back (key);
268 hash[0] = 3; 123 hash[0] = 3;
269} 124}
270 125
271void
272keyboard_manager::register_done ()
273{
274#if STOCK_KEYMAP
275 int n = sizeof (stock_keymap) / sizeof (keysym_t);
276
277 //TODO: shield against repeated calls and empty keymap
278 //if (keymap.back () != &stock_keymap[n - 1])
279 for (int i = 0; i < n; ++i)
280 register_keymap (&stock_keymap[i]);
281#endif
282
283 purge_duplicate_keymap ();
284
285 setup_hash ();
286}
287
288bool 126bool
289keyboard_manager::dispatch (rxvt_term *term, KeySym keysym, unsigned int state) 127keyboard_manager::dispatch (rxvt_term *term, KeySym keysym, unsigned int state, const char *kbuf, int len)
290{ 128{
291 assert (hash[0] == 0 && "register_done() need to be called"); 129 assert (("register_done() need to be called", hash[0] == 0));
292 130
293 state &= OtherModMask; // mask out uninteresting modifiers 131 state &= OtherModMask; // mask out uninteresting modifiers
294 132
295 if (state & term->ModMetaMask) state |= MetaMask; 133 if (state & term->ModMetaMask) state |= MetaMask;
296 if (state & term->ModNumLockMask) state |= NumLockMask; 134 if (state & term->ModNumLockMask) state |= NumLockMask;
… …
301 139
302 int index = find_keysym (keysym, state); 140 int index = find_keysym (keysym, state);
303 141
304 if (index >= 0) 142 if (index >= 0)
305 { 143 {
306 const keysym_t &key = *keymap [index]; 144 keysym_t *key = keymap [index];
307 145
308 if (key.type != keysym_t::BUILTIN) 146 if (key->type != keysym_t::BUILTIN)
309 { 147 {
310 int keysym_offset = keysym - key.keysym;
311
312 wchar_t *wc = rxvt_utf8towcs (key.str); 148 wchar_t *ws = rxvt_utf8towcs (key->str);
313 char *str = rxvt_wcstombs (wc); 149 char *str = rxvt_wcstombs (ws);
314 // TODO: do (some) translations, unescaping etc, here (allow \u escape etc.) 150 // TODO: do (some) translations, unescaping etc, here (allow \u escape etc.)
315 free (wc); 151 free (ws);
316 152
317 switch (key.type)
318 {
319 case keysym_t::STRING:
320 output_string (term, str); 153 output_string (term, str);
321 break;
322
323 case keysym_t::RANGE:
324 {
325 char buf[STRING_MAX];
326
327 if (format_keyrange_string (str, keysym_offset, buf, sizeof (buf)) > 0)
328 output_string (term, buf);
329 }
330 break;
331
332 case keysym_t::RANGE_META8:
333 {
334 int len;
335 char buf[STRING_MAX];
336
337 len = format_keyrange_string (str, keysym_offset, buf, sizeof (buf));
338 if (len > 0)
339 output_string_meta8 (term, state, buf, len);
340 }
341 break;
342
343 case keysym_t::LIST:
344 {
345 char buf[STRING_MAX];
346
347 char *prefix, *middle, *suffix;
348
349 prefix = str;
350 middle = strchr (prefix + 1, *prefix);
351 suffix = strrchr (middle + 1, *prefix);
352
353 memcpy (buf, prefix + 1, middle - prefix - 1);
354 buf [middle - prefix - 1] = middle [keysym_offset + 1];
355 strcpy (buf + (middle - prefix), suffix + 1);
356
357 output_string (term, buf);
358 }
359 break;
360 }
361 154
362 free (str); 155 free (str);
363 156
364 return true; 157 return true;
365 } 158 }
366 } 159 }
367 160
368 return false; 161 return false;
369} 162}
370 163
371// purge duplicate keymap entries
372void keyboard_manager::purge_duplicate_keymap ()
373{
374 for (unsigned int i = 0; i < keymap.size (); ++i)
375 {
376 for (unsigned int j = 0; j < i; ++j)
377 {
378 if (keymap [i] == keymap [j])
379 {
380 while (keymap [i] == keymap.back ())
381 keymap.pop_back ();
382
383 if (i < keymap.size ())
384 {
385 keymap[i] = keymap.back ();
386 keymap.pop_back ();
387 }
388
389 break;
390 }
391 }
392 }
393}
394
395void 164void
396keyboard_manager::setup_hash () 165keyboard_manager::register_done ()
397{ 166{
398 unsigned int i, index, hashkey; 167 unsigned int i, index, hashkey;
399 vector <keysym_t *> sorted_keymap;
400 uint16_t hash_budget_size[KEYSYM_HASH_BUDGETS]; // size of each budget 168 uint16_t hash_bucket_size[KEYSYM_HASH_BUCKETS]; // size of each bucket
401 uint16_t hash_budget_counter[KEYSYM_HASH_BUDGETS]; // #elements in each budget
402 169
403 memset (hash_budget_size, 0, sizeof (hash_budget_size)); 170 memset (hash_bucket_size, 0, sizeof (hash_bucket_size));
404 memset (hash_budget_counter, 0, sizeof (hash_budget_counter));
405 171
406 // determine hash bucket size 172 // determine hash bucket size
407 for (i = 0; i < keymap.size (); ++i) 173 for (i = 0; i < keymap.size (); ++i)
408 for (int j = min (keymap [i]->range, KEYSYM_HASH_BUDGETS) - 1; j >= 0; --j)
409 { 174 {
410 hashkey = (keymap [i]->keysym + j) & KEYSYM_HASH_MASK; 175 hashkey = keymap [i]->keysym & KEYSYM_HASH_MASK;
411 ++hash_budget_size [hashkey]; 176 ++hash_bucket_size [hashkey];
412 } 177 }
413 178
414 // now we know the size of each budget 179 // now we know the size of each bucket
415 // compute the index of each budget 180 // compute the index of each bucket
416 hash [0] = 0;
417 for (index = 0, i = 1; i < KEYSYM_HASH_BUDGETS; ++i) 181 for (index = 0, i = 0; i < KEYSYM_HASH_BUCKETS; ++i)
418 { 182 {
419 index += hash_budget_size [i - 1];
420 hash [i] = index; 183 hash [i] = index;
184 index += hash_bucket_size [i];
421 } 185 }
422 186
423 // and allocate just enough space 187 // and allocate just enough space
424 sorted_keymap.insert (sorted_keymap.begin (), index + hash_budget_size [i - 1], 0); 188 simplevec <keysym_t *> sorted_keymap (index, 0);
189
190 memset (hash_bucket_size, 0, sizeof (hash_bucket_size));
425 191
426 // fill in sorted_keymap 192 // fill in sorted_keymap
427 // it is sorted in each budget 193 // it is sorted in each bucket
428 for (i = 0; i < keymap.size (); ++i) 194 for (i = 0; i < keymap.size (); ++i)
429 for (int j = min (keymap [i]->range, KEYSYM_HASH_BUDGETS) - 1; j >= 0; --j)
430 { 195 {
431 hashkey = (keymap [i]->keysym + j) & KEYSYM_HASH_MASK; 196 hashkey = keymap [i]->keysym & KEYSYM_HASH_MASK;
432 197
433 index = hash [hashkey] + hash_budget_counter [hashkey]; 198 index = hash [hashkey] + hash_bucket_size [hashkey];
434 199
435 while (index > hash [hashkey] 200 while (index > hash [hashkey]
436 && compare_priority (keymap [i], sorted_keymap [index - 1]) > 0) 201 && compare_priority (keymap [i], sorted_keymap [index - 1]) > 0)
437 { 202 {
438 sorted_keymap [index] = sorted_keymap [index - 1]; 203 sorted_keymap [index] = sorted_keymap [index - 1];
439 --index; 204 --index;
440 } 205 }
441 206
442 sorted_keymap [index] = keymap [i]; 207 sorted_keymap [index] = keymap [i];
443 ++hash_budget_counter [hashkey]; 208 ++hash_bucket_size [hashkey];
444 } 209 }
445 210
446 keymap.swap (sorted_keymap); 211 keymap.swap (sorted_keymap);
447 212
448#ifdef DEBUG_STRICT 213#ifndef NDEBUG
449 // check for invariants 214 // check for invariants
450 for (i = 0; i < KEYSYM_HASH_BUDGETS; ++i) 215 for (i = 0; i < KEYSYM_HASH_BUCKETS; ++i)
451 { 216 {
452 index = hash[i]; 217 index = hash[i];
453 for (int j = 0; j < hash_budget_size [i]; ++j) 218 for (int j = 0; j < hash_bucket_size [i]; ++j)
454 { 219 {
455 if (keymap [index + j]->range == 1)
456 assert (i == (keymap [index + j]->keysym & KEYSYM_HASH_MASK)); 220 assert (i == (keymap [index + j]->keysym & KEYSYM_HASH_MASK));
457 221
458 if (j) 222 if (j)
459 assert (compare_priority (keymap [index + j - 1], 223 assert (compare_priority (keymap [index + j - 1],
460 keymap [index + j]) >= 0); 224 keymap [index + j]) >= 0);
461 } 225 }
… …
463 227
464 // this should be able to detect most possible bugs 228 // this should be able to detect most possible bugs
465 for (i = 0; i < sorted_keymap.size (); ++i) 229 for (i = 0; i < sorted_keymap.size (); ++i)
466 { 230 {
467 keysym_t *a = sorted_keymap[i]; 231 keysym_t *a = sorted_keymap[i];
468 for (int j = 0; j < a->range; ++j)
469 {
470 int index = find_keysym (a->keysym + j, a->state); 232 int index = find_keysym (a->keysym, a->state);
471 233
472 assert (index >= 0); 234 assert (index >= 0);
473 keysym_t *b = keymap [index]; 235 keysym_t *b = keymap [index];
474 assert (i == (signed) index || // the normally expected result 236 assert (i == index // the normally expected result
475 (a->keysym + j) >= b->keysym && (a->keysym + j) <= (b->keysym + b->range) && compare_priority (a, b) <= 0); // is effectively the same or a closer match 237 || a->keysym == b->keysym
476 } 238 && compare_priority (a, b) <= 0); // is effectively the same or a closer match
477 } 239 }
478#endif 240#endif
479} 241}
480 242
481int 243int
482keyboard_manager::find_keysym (KeySym keysym, unsigned int state) 244keyboard_manager::find_keysym (KeySym keysym, unsigned int state)
483{ 245{
484 int hashkey = keysym & KEYSYM_HASH_MASK; 246 int hashkey = keysym & KEYSYM_HASH_MASK;
485 unsigned int index = hash [hashkey]; 247 unsigned int index = hash [hashkey];
486 unsigned int end = hashkey < KEYSYM_HASH_BUDGETS - 1 248 unsigned int end = hashkey < KEYSYM_HASH_BUCKETS - 1
487 ? hash [hashkey + 1] 249 ? hash [hashkey + 1]
488 : keymap.size (); 250 : keymap.size ();
489 251
490 for (; index < end; ++index) 252 for (; index < end; ++index)
491 { 253 {
492 keysym_t *key = keymap [index]; 254 keysym_t *key = keymap [index];
493 255
494 if (key->keysym <= keysym && keysym < key->keysym + key->range 256 if (key->keysym == keysym
495 // match only the specified bits in state and ignore others 257 // match only the specified bits in state and ignore others
496 && (key->state & state) == key->state) 258 && (key->state & state) == key->state)
497 return index; 259 return index;
498 } 260 }
499 261

Diff Legend

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