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.37 by sf-exg, Tue Aug 24 23:57:04 2010 UTC vs.
Revision 1.73 by sf-exg, Tue Oct 13 08:10:43 2015 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 * Copyright (c) 2015 Emanuele Giaquinta <e.giaquinta@glauco.it>
8 * 9 *
9 * This program is free software; you can redistribute it and/or modify 10 * 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 * 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 * the Free Software Foundation; either version 3 of the License, or
12 * (at your option) any later version. 13 * (at your option) any later version.
13 * 14 *
14 * This program is distributed in the hope that it will be useful, 15 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of 16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24#include "../config.h" 25#include "../config.h"
25#include "rxvt.h" 26#include "rxvt.h"
26 27
27#ifdef KEYSYM_RESOURCE 28#ifdef KEYSYM_RESOURCE
28 29
29#include <cstring> 30#include <string.h>
30 31
31#include "rxvtperl.h" 32#include "rxvtperl.h"
32#include "keyboard.h" 33#include "keyboard.h"
33#include "command.h"
34 34
35/* an intro to the data structure: 35/* an intro to the data structure:
36 * 36 *
37 * vector keymap[] is grouped. 37 * vector keymap[] is grouped.
38 * 38 *
62 * where hashkey of keymap[i]->keysym = keymap[i]->keysym & KEYSYM_HASH_MASK 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[]; 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]. 64 * Ni(the size of group i) = hash_bucket_size[Ii].
65 */ 65 */
66 66
67static void
68output_string (rxvt_term *rt, const char *str)
69{
70 if (strncmp (str, "command:", 8) == 0)
71 rt->cmd_write (str + 8, strlen (str) - 8);
72 else if (strncmp (str, "perl:", 5) == 0)
73 HOOK_INVOKE((rt, HOOK_USER_COMMAND, DT_STR, str + 5, DT_END));
74 else
75 rt->tt_write (str, strlen (str));
76}
77
78// return: priority_of_a - priority_of_b 67// return: priority_of_a - priority_of_b
79static int 68static int
80compare_priority (keysym_t *a, keysym_t *b) 69compare_priority (keysym_t *a, keysym_t *b)
81{ 70{
82 // (the more '1's in state; the less range): the greater priority 71 // (the more '1's in state; the less range): the greater priority
83 int ca = rxvt_popcount (a->state /* & OtherModMask */); 72 int ca = ecb_popcount32 (a->state /* & OtherModMask */);
84 int cb = rxvt_popcount (b->state /* & OtherModMask */); 73 int cb = ecb_popcount32 (b->state /* & OtherModMask */);
85 74
86 if (ca != cb)
87 return ca - cb; 75 return ca - cb;
88//else if (a->state != b->state) // this behavior is to be discussed
89// return b->state - a->state;
90 else
91 return b->range - a->range;
92} 76}
93 77
94//////////////////////////////////////////////////////////////////////////////// 78////////////////////////////////////////////////////////////////////////////////
95keyboard_manager::keyboard_manager () 79keyboard_manager::keyboard_manager ()
96{ 80{
98 hash [0] = 1; // hash[0] != 0 indicates uninitialized data 82 hash [0] = 1; // hash[0] != 0 indicates uninitialized data
99} 83}
100 84
101keyboard_manager::~keyboard_manager () 85keyboard_manager::~keyboard_manager ()
102{ 86{
103 clear (); 87 for (unsigned int i = 0; i < keymap.size (); ++i)
88 {
89 free (keymap [i]->str);
90 delete keymap [i];
91 }
104} 92}
105 93
106void 94void
107keyboard_manager::clear () 95keyboard_manager::unregister_action (KeySym keysym, unsigned int state)
108{ 96{
109 hash [0] = 2;
110
111 for (unsigned int i = 0; i < keymap.size (); ++i) 97 for (unsigned int i = 0; i < keymap.size (); ++i)
98 if (keymap [i]->keysym == keysym
99 && keymap [i]->state == state)
112 { 100 {
113 free ((void *)keymap [i]->str); 101 free (keymap [i]->str);
114 delete keymap [i]; 102 delete keymap [i];
115 keymap [i] = 0; 103
104 if (i < keymap.size () - 1)
105 keymap [i] = keymap [keymap.size () - 1];
106 keymap.pop_back ();
107
108 break;
116 } 109 }
117
118 keymap.clear ();
119} 110}
120 111
121// a wrapper for register_keymap,
122// so that outside codes don't have to know so much details.
123//
124// the string 'trans' is copied to an internal managed buffer,
125// so the caller can free memory of 'trans' at any time.
126void 112void
127keyboard_manager::register_user_translation (KeySym keysym, unsigned int state, const char *trans) 113keyboard_manager::register_action (KeySym keysym, unsigned int state, const wchar_t *ws)
128{ 114{
115 char *action = rxvt_wcstoutf8 (ws);
116
129 keysym_t *key = new keysym_t; 117 keysym_t *key = new keysym_t;
130 wchar_t *wc = rxvt_mbstowcs (trans);
131 char *translation = rxvt_wcstoutf8 (wc);
132 free (wc);
133 118
134 if (key && translation)
135 {
136 key->keysym = keysym; 119 key->keysym = keysym;
137 key->state = state; 120 key->state = state;
138 key->range = 1;
139 key->str = translation; 121 key->str = action;
140 key->type = keysym_t::STRING; 122 key->type = keysym_t::STRING;
141 123
142 if (strncmp (translation, "list", 4) == 0 && translation [4])
143 {
144 char *middle = strchr (translation + 5, translation [4]);
145 char *suffix = strrchr (translation + 5, translation [4]);
146
147 if (suffix && middle && suffix > middle + 1)
148 {
149 key->type = keysym_t::LIST;
150 key->range = suffix - middle - 1;
151
152 memmove (translation, translation + 4, strlen (translation + 4) + 1);
153 }
154 else
155 rxvt_warn ("cannot parse list-type keysym '%s', treating as normal keysym.\n", translation);
156 }
157 else if (strncmp (translation, "builtin:", 8) == 0) 124 if (strncmp (action, "builtin:", 8) == 0)
158 key->type = keysym_t::BUILTIN; 125 key->type = keysym_t::BUILTIN;
126 else if (strncmp (action, "builtin-string:", 15) == 0)
127 key->type = keysym_t::BUILTIN_STRING;
159 128
160 register_keymap (key); 129 unregister_action (keysym, state);
161 }
162 else
163 {
164 delete key;
165 free ((void *)translation);
166 rxvt_fatal ("out of memory, aborting.\n");
167 }
168}
169 130
170void
171keyboard_manager::register_keymap (keysym_t *key)
172{
173 if (keymap.size () == keymap.capacity ()) 131 if (keymap.size () == keymap.capacity ())
174 keymap.reserve (keymap.size () * 2); 132 keymap.reserve (keymap.size () * 2);
175 133
176 keymap.push_back (key); 134 keymap.push_back (key);
177 hash[0] = 3; 135 hash[0] = 3;
178} 136}
179 137
180void 138keysym_t *
181keyboard_manager::register_done ()
182{
183 setup_hash ();
184}
185
186bool
187keyboard_manager::dispatch (rxvt_term *term, KeySym keysym, unsigned int state) 139keyboard_manager::lookup_keysym (rxvt_term *term, KeySym keysym, unsigned int state)
188{ 140{
189 assert (hash[0] == 0 && "register_done() need to be called"); 141 assert (("register_done() need to be called", hash[0] == 0));
190 142
191 state &= OtherModMask; // mask out uninteresting modifiers 143 state &= OtherModMask; // mask out uninteresting modifiers
192 144
193 if (state & term->ModMetaMask) state |= MetaMask; 145 if (state & term->ModMetaMask) state |= MetaMask;
194 if (state & term->ModNumLockMask) state |= NumLockMask; 146 if (state & term->ModNumLockMask) state |= NumLockMask;
197 if (!!(term->priv_modes & PrivMode_aplKP) != !!(state & ShiftMask)) 149 if (!!(term->priv_modes & PrivMode_aplKP) != !!(state & ShiftMask))
198 state |= AppKeypadMask; 150 state |= AppKeypadMask;
199 151
200 int index = find_keysym (keysym, state); 152 int index = find_keysym (keysym, state);
201 153
202 if (index >= 0) 154 return index >= 0 ? keymap [index] : 0;
203 { 155}
204 const keysym_t &key = *keymap [index];
205 156
157bool
158keyboard_manager::dispatch (rxvt_term *term, KeySym keysym, unsigned int state, const char *kbuf, int len)
159{
160 keysym_t *key = lookup_keysym (term, keysym, state);
161
162 if (key)
163 {
206 if (key.type != keysym_t::BUILTIN) 164 if (key->type == keysym_t::BUILTIN_STRING)
207 { 165 {
208 int keysym_offset = keysym - key.keysym; 166 term->tt_write_user_input (kbuf, len);
209
210 wchar_t *wc = rxvt_utf8towcs (key.str);
211 char *str = rxvt_wcstombs (wc);
212 // TODO: do (some) translations, unescaping etc, here (allow \u escape etc.)
213 free (wc);
214
215 switch (key.type)
216 {
217 case keysym_t::STRING:
218 output_string (term, str);
219 break;
220
221 case keysym_t::LIST:
222 {
223 char buf[STRING_MAX];
224
225 char *prefix, *middle, *suffix;
226
227 prefix = str;
228 middle = strchr (prefix + 1, *prefix);
229 suffix = strrchr (middle + 1, *prefix);
230
231 memcpy (buf, prefix + 1, middle - prefix - 1);
232 buf [middle - prefix - 1] = middle [keysym_offset + 1];
233 strcpy (buf + (middle - prefix), suffix + 1);
234
235 output_string (term, buf);
236 }
237 break;
238 }
239
240 free (str);
241
242 return true; 167 return true;
243 } 168 }
169 else if (key->type != keysym_t::BUILTIN)
170 {
171 wchar_t *ws = rxvt_utf8towcs (key->str);
172 char *str = rxvt_wcstombs (ws);
173 // TODO: do (some) translations, unescaping etc, here (allow \u escape etc.)
174 free (ws);
175
176 if (char *colon = strchr (str, ':'))
177 {
178 if (strncmp (str, "command:", 8) == 0)
179 term->cmdbuf_append (str + 8, strlen (str) - 8);
180 else if (strncmp (str, "string:", 7) == 0)
181 term->tt_write_user_input (colon + 1, strlen (colon + 1));
182 else if (strncmp (str, "perl:", 5) == 0)
183 HOOK_INVOKE ((term, HOOK_USER_COMMAND, DT_STR, colon + 1, DT_END));
184 else
185 HOOK_INVOKE ((term, HOOK_ACTION, DT_STR_LEN, str, colon - str, DT_STR, colon + 1, DT_INT, 0, DT_STR_LEN, kbuf, len, DT_END));
186 }
187 else
188 term->tt_write_user_input (str, strlen (str));
189
190 free (str);
191
192 return true;
193 }
244 } 194 }
245 195
246 return false; 196 return false;
247} 197}
248 198
249void 199void
250keyboard_manager::setup_hash () 200keyboard_manager::register_done ()
251{ 201{
252 unsigned int i, index, hashkey; 202 unsigned int i, index, hashkey;
253 vector <keysym_t *> sorted_keymap;
254 uint16_t hash_bucket_size[KEYSYM_HASH_BUCKETS]; // size of each bucket 203 uint16_t hash_bucket_size[KEYSYM_HASH_BUCKETS]; // size of each bucket
255 uint16_t hash_bucket_counter[KEYSYM_HASH_BUCKETS]; // #elements in each bucket
256 204
257 memset (hash_bucket_size, 0, sizeof (hash_bucket_size)); 205 memset (hash_bucket_size, 0, sizeof (hash_bucket_size));
258 memset (hash_bucket_counter, 0, sizeof (hash_bucket_counter));
259 206
260 // determine hash bucket size 207 // determine hash bucket size
261 for (i = 0; i < keymap.size (); ++i) 208 for (i = 0; i < keymap.size (); ++i)
262 for (int j = min (keymap [i]->range, KEYSYM_HASH_BUCKETS) - 1; j >= 0; --j)
263 { 209 {
264 hashkey = (keymap [i]->keysym + j) & KEYSYM_HASH_MASK; 210 hashkey = keymap [i]->keysym & KEYSYM_HASH_MASK;
265 ++hash_bucket_size [hashkey]; 211 ++hash_bucket_size [hashkey];
266 } 212 }
267 213
268 // now we know the size of each bucket 214 // now we know the size of each bucket
269 // compute the index of each bucket 215 // compute the index of each bucket
270 hash [0] = 0;
271 for (index = 0, i = 1; i < KEYSYM_HASH_BUCKETS; ++i) 216 for (index = 0, i = 0; i < KEYSYM_HASH_BUCKETS; ++i)
272 { 217 {
273 index += hash_bucket_size [i - 1];
274 hash [i] = index; 218 hash [i] = index;
219 index += hash_bucket_size [i];
275 } 220 }
276 221
277 // and allocate just enough space 222 // and allocate just enough space
278 sorted_keymap.insert (sorted_keymap.begin (), index + hash_bucket_size [i - 1], 0); 223 simplevec <keysym_t *> sorted_keymap (index, 0);
224
225 memset (hash_bucket_size, 0, sizeof (hash_bucket_size));
279 226
280 // fill in sorted_keymap 227 // fill in sorted_keymap
281 // it is sorted in each bucket 228 // it is sorted in each bucket
282 for (i = 0; i < keymap.size (); ++i) 229 for (i = 0; i < keymap.size (); ++i)
283 for (int j = min (keymap [i]->range, KEYSYM_HASH_BUCKETS) - 1; j >= 0; --j)
284 { 230 {
285 hashkey = (keymap [i]->keysym + j) & KEYSYM_HASH_MASK; 231 hashkey = keymap [i]->keysym & KEYSYM_HASH_MASK;
286 232
287 index = hash [hashkey] + hash_bucket_counter [hashkey]; 233 index = hash [hashkey] + hash_bucket_size [hashkey];
288 234
289 while (index > hash [hashkey] 235 while (index > hash [hashkey]
290 && compare_priority (keymap [i], sorted_keymap [index - 1]) > 0) 236 && compare_priority (keymap [i], sorted_keymap [index - 1]) > 0)
291 { 237 {
292 sorted_keymap [index] = sorted_keymap [index - 1]; 238 sorted_keymap [index] = sorted_keymap [index - 1];
293 --index; 239 --index;
294 } 240 }
295 241
296 sorted_keymap [index] = keymap [i]; 242 sorted_keymap [index] = keymap [i];
297 ++hash_bucket_counter [hashkey]; 243 ++hash_bucket_size [hashkey];
298 } 244 }
299 245
300 keymap.swap (sorted_keymap); 246 keymap.swap (sorted_keymap);
301 247
302#ifndef NDEBUG 248#ifndef NDEBUG
303 // check for invariants 249 // check for invariants
304 for (i = 0; i < KEYSYM_HASH_BUCKETS; ++i) 250 for (i = 0; i < KEYSYM_HASH_BUCKETS; ++i)
305 { 251 {
306 index = hash[i]; 252 index = hash[i];
307 for (int j = 0; j < hash_bucket_size [i]; ++j) 253 for (int j = 0; j < hash_bucket_size [i]; ++j)
308 { 254 {
309 if (keymap [index + j]->range == 1)
310 assert (i == (keymap [index + j]->keysym & KEYSYM_HASH_MASK)); 255 assert (i == (keymap [index + j]->keysym & KEYSYM_HASH_MASK));
311 256
312 if (j) 257 if (j)
313 assert (compare_priority (keymap [index + j - 1], 258 assert (compare_priority (keymap [index + j - 1],
314 keymap [index + j]) >= 0); 259 keymap [index + j]) >= 0);
315 } 260 }
317 262
318 // this should be able to detect most possible bugs 263 // this should be able to detect most possible bugs
319 for (i = 0; i < sorted_keymap.size (); ++i) 264 for (i = 0; i < sorted_keymap.size (); ++i)
320 { 265 {
321 keysym_t *a = sorted_keymap[i]; 266 keysym_t *a = sorted_keymap[i];
322 for (int j = 0; j < a->range; ++j)
323 {
324 int index = find_keysym (a->keysym + j, a->state); 267 int index = find_keysym (a->keysym, a->state);
325 268
326 assert (index >= 0); 269 assert (index >= 0);
327 keysym_t *b = keymap [index]; 270 keysym_t *b = keymap [index];
328 assert (i == index // the normally expected result 271 assert (i == index // the normally expected result
329 || IN_RANGE_INC (a->keysym + j, b->keysym, b->keysym + b->range) 272 || a->keysym == b->keysym
330 && compare_priority (a, b) <= 0); // is effectively the same or a closer match 273 && compare_priority (a, b) <= 0); // is effectively the same or a closer match
331 }
332 } 274 }
333#endif 275#endif
334} 276}
335 277
336int 278int
344 286
345 for (; index < end; ++index) 287 for (; index < end; ++index)
346 { 288 {
347 keysym_t *key = keymap [index]; 289 keysym_t *key = keymap [index];
348 290
349 if (key->keysym <= keysym && keysym < key->keysym + key->range 291 if (key->keysym == keysym
350 // match only the specified bits in state and ignore others 292 // match only the specified bits in state and ignore others
351 && (key->state & state) == key->state) 293 && (key->state & state) == key->state)
352 return index; 294 return index;
353 } 295 }
354 296

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines