ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/src/keyboard.C
Revision: 1.12
Committed: Sat Feb 12 18:55:04 2005 UTC (19 years, 4 months ago) by root
Content type: text/plain
Branch: MAIN
CVS Tags: rel-5_1, rel-5_2
Changes since 1.11: +8 -3 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 #if STOCK_KEYMAP
12 ////////////////////////////////////////////////////////////////////////////////
13 // default keycode translation map and keyevent handlers
14
15 keysym_t keyboard_manager::stock_keymap[] = {
16 /* examples */
17 /* keysym, state, range, handler, str */
18 //{XK_ISO_Left_Tab, 0, 1, keysym_t::NORMAL, "\033[Z"},
19 //{ 'a', 0, 26, keysym_t::RANGE_META8, "a" "%c"},
20 //{ 'a', ControlMask, 26, keysym_t::RANGE_META8, "" "%c"},
21 //{ XK_Left, 0, 4, keysym_t::LIST, ".\033[.DACB."},
22 //{ XK_Left, ShiftMask, 4, keysym_t::LIST, ".\033[.dacb."},
23 //{ XK_Left, ControlMask, 4, keysym_t::LIST, ".\033O.dacb."},
24 //{ XK_Tab, ControlMask, 1, keysym_t::NORMAL, "\033<C-Tab>"},
25 //{ XK_apostrophe, ControlMask, 1, keysym_t::NORMAL, "\033<C-'>"},
26 //{ XK_slash, ControlMask, 1, keysym_t::NORMAL, "\033<C-/>"},
27 //{ XK_semicolon, ControlMask, 1, keysym_t::NORMAL, "\033<C-;>"},
28 //{ XK_grave, ControlMask, 1, keysym_t::NORMAL, "\033<C-`>"},
29 //{ XK_comma, ControlMask, 1, keysym_t::NORMAL, "\033<C-\054>"},
30 //{ XK_Return, ControlMask, 1, keysym_t::NORMAL, "\033<C-Return>"},
31 //{ XK_Return, ShiftMask, 1, keysym_t::NORMAL, "\033<S-Return>"},
32 //{ ' ', ShiftMask, 1, keysym_t::NORMAL, "\033<S-Space>"},
33 //{ '.', ControlMask, 1, keysym_t::NORMAL, "\033<C-.>"},
34 //{ '0', ControlMask, 10, keysym_t::RANGE, "0" "\033<C-%c>"},
35 //{ '0', MetaMask|ControlMask, 10, keysym_t::RANGE, "0" "\033<M-C-%c>"},
36 //{ 'a', MetaMask|ControlMask, 26, keysym_t::RANGE, "a" "\033<M-C-%c>"},
37 };
38 #endif
39
40 static void
41 output_string (rxvt_term *rt, const char *str)
42 {
43 if (strncmp (str, "command:", 8) == 0)
44 rt->cmd_write ((unsigned char *)str + 8, strlen (str) - 8);
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 // (the more '1's in state; the less range): the greater priority
107 int ca = bitcount (a->state /* & OtherModMask */);
108 int cb = bitcount (b->state /* & OtherModMask */);
109
110 if (ca != cb)
111 return ca - cb;
112 //else if (a->state != b->state) // this behavior is to be disscussed
113 // return b->state - a->state;
114 else
115 return b->range - a->range;
116 }
117
118 ////////////////////////////////////////////////////////////////////////////////
119 keyboard_manager::keyboard_manager ()
120 {
121 keymap.reserve (256);
122 hash [0] = 1; // hash[0] != 0 indicates uninitialized data
123 }
124
125 keyboard_manager::~keyboard_manager ()
126 {
127 clear ();
128 }
129
130 void
131 keyboard_manager::clear ()
132 {
133 keymap.clear ();
134 hash [0] = 2;
135
136 for (unsigned int i = 0; i < user_translations.size (); ++i)
137 {
138 free ((void *)user_translations [i]);
139 user_translations [i] = 0;
140 }
141
142 for (unsigned int i = 0; i < user_keymap.size (); ++i)
143 {
144 delete user_keymap [i];
145 user_keymap [i] = 0;
146 }
147
148 user_keymap.clear ();
149 user_translations.clear ();
150 }
151
152 // a wrapper for register_keymap,
153 // so that outside codes don't have to know so much details.
154 //
155 // the string 'trans' is copied to an internal managed buffer,
156 // so the caller can free memory of 'trans' at any time.
157 void
158 keyboard_manager::register_user_translation (KeySym keysym, unsigned int state, const char *trans)
159 {
160 keysym_t *key = new keysym_t;
161 wchar_t *wc = rxvt_mbstowcs (trans);
162 const char *translation = rxvt_wcstoutf8 (wc);
163 free (wc);
164
165 if (key && translation)
166 {
167 key->keysym = keysym;
168 key->state = state;
169 key->range = 1;
170 key->str = translation;
171 key->type = keysym_t::NORMAL;
172
173 if (strncmp (translation, "list", 4) == 0 && translation [4])
174 {
175 char *middle = strchr (translation + 5, translation [4]);
176 char *suffix = strrchr (translation + 5, translation [4]);
177
178 if (suffix && middle && suffix > middle + 1)
179 {
180 key->type = keysym_t::LIST;
181 key->range = suffix - middle - 1;
182
183 strcpy (translation, translation + 4);
184 }
185 else
186 rxvt_warn ("cannot parse list-type keysym '%s', treating as normal keysym.\n", translation);
187 }
188
189 user_keymap.push_back (key);
190 user_translations.push_back (translation);
191 register_keymap (key);
192 }
193 else
194 {
195 delete key;
196 free ((void *)translation);
197 rxvt_fatal ("out of memory, aborting.\n");
198 }
199 }
200
201 void
202 keyboard_manager::register_keymap (keysym_t *key)
203 {
204 if (keymap.size () == keymap.capacity ())
205 keymap.reserve (keymap.size () * 2);
206
207 keymap.push_back (key);
208 hash[0] = 3;
209 }
210
211 void
212 keyboard_manager::register_done ()
213 {
214 #if STOCK_KEYMAP
215 int n = sizeof (stock_keymap) / sizeof (keysym_t);
216
217 //TODO: shield against repeated calls and empty keymap
218 //if (keymap.back () != &stock_keymap[n - 1])
219 for (int i = 0; i < n; ++i)
220 register_keymap (&stock_keymap[i]);
221 #endif
222
223 purge_duplicate_keymap ();
224
225 setup_hash ();
226 }
227
228 bool
229 keyboard_manager::dispatch (rxvt_term *term, KeySym keysym, unsigned int state)
230 {
231 assert (hash[0] == 0 && "register_done() need to be called");
232
233 if (state & term->ModMetaMask) state |= MetaMask;
234 if (state & term->ModNumLockMask) state |= NumLockMask;
235 if (state & term->ModLevel3Mask) state |= Level3Mask;
236
237 if (!!(term->priv_modes & PrivMode_aplKP) != !!(state & ShiftMask))
238 state |= AppKeypadMask;
239
240 int index = find_keysym (keysym, state);
241
242 if (index >= 0)
243 {
244 const keysym_t &key = *keymap [index];
245
246 int keysym_offset = keysym - key.keysym;
247
248 wchar_t *wc = rxvt_utf8towcs (key.str);
249 char *str = rxvt_wcstombs (wc);
250 // TODO: do (some) translations, unescaping etc, here (allow \u escape etc.)
251 free (wc);
252
253 switch (key.type)
254 {
255 case keysym_t::NORMAL:
256 output_string (term, str);
257 break;
258
259 case keysym_t::RANGE:
260 {
261 char buf[STRING_MAX];
262
263 if (format_keyrange_string (str, keysym_offset, buf, sizeof (buf)) > 0)
264 output_string (term, buf);
265 }
266 break;
267
268 case keysym_t::RANGE_META8:
269 {
270 int len;
271 char buf[STRING_MAX];
272
273 len = format_keyrange_string (str, keysym_offset, buf, sizeof (buf));
274 if (len > 0)
275 output_string_meta8 (term, state, buf, len);
276 }
277 break;
278
279 case keysym_t::LIST:
280 {
281 char buf[STRING_MAX];
282
283 char *prefix, *middle, *suffix;
284
285 prefix = str;
286 middle = strchr (prefix + 1, *prefix);
287 suffix = strrchr (middle + 1, *prefix);
288
289 memcpy (buf, prefix + 1, middle - prefix - 1);
290 buf [middle - prefix - 1] = middle [keysym_offset + 1];
291 strcpy (buf + (middle - prefix), suffix + 1);
292
293 output_string (term, buf);
294 }
295 break;
296 }
297
298 free (str);
299
300 return true;
301 }
302 else
303 return false;
304 }
305
306 // purge duplicate keymap entries
307 void keyboard_manager::purge_duplicate_keymap ()
308 {
309 for (unsigned int i = 0; i < keymap.size (); ++i)
310 {
311 for (unsigned int j = 0; j < i; ++j)
312 {
313 if (keymap [i] == keymap [j])
314 {
315 while (keymap [i] == keymap.back ())
316 keymap.pop_back ();
317
318 if (i < keymap.size ())
319 {
320 keymap[i] = keymap.back ();
321 keymap.pop_back ();
322 }
323
324 break;
325 }
326 }
327 }
328 }
329
330 void
331 keyboard_manager::setup_hash ()
332 {
333 unsigned int i, index, hashkey;
334 vector <keysym_t *> sorted_keymap;
335 uint16_t hash_budget_size[KEYSYM_HASH_BUDGETS]; // size of each budget
336 uint16_t hash_budget_counter[KEYSYM_HASH_BUDGETS]; // #elements in each budget
337
338 memset (hash_budget_size, 0, sizeof (hash_budget_size));
339 memset (hash_budget_counter, 0, sizeof (hash_budget_counter));
340
341 // determine hash bucket size
342 for (i = 0; i < keymap.size (); ++i)
343 for (int j = min (keymap [i]->range, KEYSYM_HASH_BUDGETS) - 1; j >= 0; --j)
344 {
345 hashkey = (keymap [i]->keysym + j) & KEYSYM_HASH_MASK;
346 ++hash_budget_size [hashkey];
347 }
348
349 // now we know the size of each budget
350 // compute the index of each budget
351 hash [0] = 0;
352 for (index = 0, i = 1; i < KEYSYM_HASH_BUDGETS; ++i)
353 {
354 index += hash_budget_size [i - 1];
355 hash [i] = index;
356 }
357
358 // and allocate just enough space
359 sorted_keymap.insert (sorted_keymap.begin (), index + hash_budget_size [i - 1], 0);
360
361 // fill in sorted_keymap
362 // it is sorted in each budget
363 for (i = 0; i < keymap.size (); ++i)
364 for (int j = min (keymap [i]->range, KEYSYM_HASH_BUDGETS) - 1; j >= 0; --j)
365 {
366 hashkey = (keymap [i]->keysym + j) & KEYSYM_HASH_MASK;
367
368 index = hash [hashkey] + hash_budget_counter [hashkey];
369
370 while (index > hash [hashkey]
371 && compare_priority (keymap [i], sorted_keymap [index - 1]) > 0)
372 {
373 sorted_keymap [index] = sorted_keymap [index - 1];
374 --index;
375 }
376
377 sorted_keymap [index] = keymap [i];
378 ++hash_budget_counter [hashkey];
379 }
380
381 keymap.swap (sorted_keymap);
382
383 #if defined (DEBUG_STRICT) || defined (DEBUG_KEYBOARD)
384 // check for invariants
385 for (i = 0; i < KEYSYM_HASH_BUDGETS; ++i)
386 {
387 index = hash[i];
388 for (int j = 0; j < hash_budget_size [i]; ++j)
389 {
390 if (keymap [index + j]->range == 1)
391 assert (i == (keymap [index + j]->keysym & KEYSYM_HASH_MASK));
392
393 if (j)
394 assert (compare_priority (keymap [index + j - 1],
395 keymap [index + j]) >= 0);
396 }
397 }
398
399 // this should be able to detect most possible bugs
400 for (i = 0; i < sorted_keymap.size (); ++i)
401 {
402 keysym_t *a = sorted_keymap[i];
403 for (int j = 0; j < a->range; ++j)
404 {
405 int index = find_keysym (a->keysym + j, a->state);
406
407 assert (index >= 0);
408 keysym_t *b = keymap [index];
409 assert (i == (signed) index || // the normally expected result
410 (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
411 }
412 }
413 #endif
414 }
415
416 int
417 keyboard_manager::find_keysym (KeySym keysym, unsigned int state)
418 {
419 int hashkey = keysym & KEYSYM_HASH_MASK;
420 unsigned int index = hash [hashkey];
421 unsigned int end = hashkey < KEYSYM_HASH_BUDGETS - 1
422 ? hash [hashkey + 1]
423 : keymap.size ();
424
425 for (; index < end; ++index)
426 {
427 keysym_t *key = keymap [index];
428
429 if (key->keysym <= keysym && keysym < key->keysym + key->range
430 // match only the specified bits in state and ignore others
431 && (key->state & state) == key->state)
432 return index;
433 }
434
435 return -1;
436 }
437
438 #endif /* KEYSYM_RESOURCE */
439 // vim:et:ts=2:sw=2