rxvt-unicode/src/keyboard.C

/*----------------------------------------------------------------------*
 * File:        keyboard.C
 *----------------------------------------------------------------------*
 *
 * All portions of code are copyright by their respective author/s.
 * Copyright (c) 2005      WU Fengguang
 * Copyright (c) 2005-2006 Marc Lehmann <schmorp@schmorp.de>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 *----------------------------------------------------------------------*/

#include "../config.h"
#include "rxvt.h"

#ifdef KEYSYM_RESOURCE

#include <cstring>

#include "rxvtperl.h"
#include "keyboard.h"
#include "command.h"

/* an intro to the data structure:
 *
 * vector keymap[] is grouped.
 *
 * inside each group, elements are sorted by the criteria given by compare_priority().
 * the lookup of keysym is done in two steps:
 * 1) locate the group corresponds to the keysym;
 * 2) do a linear search inside the group.
 *
 * array hash[] effectively defines a map from a keysym to a group in keymap[].
 *
 * each group has its address(the index of first group element in keymap[]),
 * which is computed and stored in hash[].
 * hash[] stores the addresses in the form of:
 * index: 0      I1       I2       I3            In
 * value: 0...0, A1...A1, A2...A2, A3...A3, ..., An...An
 * where
 * A1 = 0;
 * Ai+1 = N1 + N2 + ... + Ni.
 * it is computed from hash_bucket_size[]:
 * index: 0      I1         I2         I3             In
 * value: 0...0, N1, 0...0, N2, 0...0, N3,    ...,    Nn, 0...0
 *        0...0, 0.......0, N1.....N1, N1+N2...N1+N2, ... (the computation of hash[])
 * or we can say
 * hash_bucket_size[Ii] = Ni; hash_bucket_size[elsewhere] = 0,
 * where
 * set {I1, I2, ..., In} = { hashkey of keymap[0]->keysym, ..., keymap[keymap.size-1]->keysym }
 * where hashkey of keymap[i]->keysym = keymap[i]->keysym & KEYSYM_HASH_MASK
 *       n(the number of groups) = the number of non-zero member of hash_bucket_size[];
 *       Ni(the size of group i) = hash_bucket_size[Ii].
 */

static void
output_string (rxvt_term *rt, const char *str)
{
  if (strncmp (str, "command:", 8) == 0)
    rt->cmdbuf_append (str + 8, strlen (str) - 8);
  else if (strncmp (str, "perl:", 5) == 0)
    HOOK_INVOKE((rt, HOOK_USER_COMMAND, DT_STR, str + 5, DT_END));
  else
    rt->tt_write (str, strlen (str));
}

// return: priority_of_a - priority_of_b
static int
compare_priority (keysym_t *a, keysym_t *b)
{
  // (the more '1's in state; the less range): the greater priority
  int ca = ecb_popcount32 (a->state /* & OtherModMask */);
  int cb = ecb_popcount32 (b->state /* & OtherModMask */);

  if (ca != cb)
    return ca - cb;
//else if (a->state != b->state) // this behavior is to be discussed
//  return b->state - a->state;
  else
    return 0;
}

////////////////////////////////////////////////////////////////////////////////
keyboard_manager::keyboard_manager ()
{
  keymap.reserve (256);
  hash [0] = 1;                 // hash[0] != 0 indicates uninitialized data
}

keyboard_manager::~keyboard_manager ()
{
  clear ();
}

void
keyboard_manager::clear ()
{
  hash [0] = 2;

  for (unsigned int i = 0; i < keymap.size (); ++i)
    {
      free (keymap [i]->str);
      delete keymap [i];
      keymap [i] = 0;
    }

  keymap.clear ();
}

// a wrapper for register_translation that converts the input string
// to utf-8 and expands 'list' syntax.
void
keyboard_manager::register_user_translation (KeySym keysym, unsigned int state, const char *trans)
{
  wchar_t *wc = rxvt_mbstowcs (trans);
  char *translation = rxvt_wcstoutf8 (wc);
  free (wc);

  if (strncmp (translation, "list", 4) == 0 && translation [4]
      && strlen (translation) < STRING_MAX)
    {
      char *prefix = translation + 4;
      char *middle = strchr  (prefix + 1, translation [4]);
      char *suffix = strrchr (prefix + 1, translation [4]);

      if (suffix && middle && suffix > middle + 1)
        {
          int range = suffix - middle - 1;
          int prefix_len = middle - prefix - 1;
          char buf[STRING_MAX];

          memcpy (buf, prefix + 1, prefix_len);
          strcpy (buf + prefix_len + 1, suffix + 1);

          for (int i = 0; i < range; i++)
            {
              buf [prefix_len] = middle [i + 1];
              register_translation (keysym + i, state, strdup (buf));
            }

          free (translation);
          return;
        }
      else
        rxvt_warn ("cannot parse list-type keysym '%s', processing as normal keysym.\n", translation);
    }

  register_translation (keysym, state, translation);
}

void
keyboard_manager::register_translation (KeySym keysym, unsigned int state, char *translation)
{
  keysym_t *key = new keysym_t;

  if (key && translation)
    {
      key->keysym = keysym;
      key->state  = state;
      key->str    = translation;
      key->type   = keysym_t::STRING;

      if (strncmp (translation, "builtin:", 8) == 0)
        key->type = keysym_t::BUILTIN;

      register_keymap (key);
    }
  else
    {
      delete key;
      free (translation);
      rxvt_fatal ("out of memory, aborting.\n");
    }
}

void
keyboard_manager::register_keymap (keysym_t *key)
{
  if (keymap.size () == keymap.capacity ())
    keymap.reserve (keymap.size () * 2);

  keymap.push_back (key);
  hash[0] = 3;
}

void
keyboard_manager::register_done ()
{
  setup_hash ();
}

bool
keyboard_manager::dispatch (rxvt_term *term, KeySym keysym, unsigned int state)
{
  assert (hash[0] == 0 && "register_done() need to be called");

  state &= OtherModMask; // mask out uninteresting modifiers

  if (state & term->ModMetaMask)    state |= MetaMask;
  if (state & term->ModNumLockMask) state |= NumLockMask;
  if (state & term->ModLevel3Mask)  state |= Level3Mask;

  if (!!(term->priv_modes & PrivMode_aplKP) != !!(state & ShiftMask))
    state |= AppKeypadMask;

  int index = find_keysym (keysym, state);

  if (index >= 0)
    {
      const keysym_t &key = *keymap [index];

      if (key.type != keysym_t::BUILTIN)
        {
          wchar_t *wc = rxvt_utf8towcs (key.str);
          char *str = rxvt_wcstombs (wc);
          // TODO: do (some) translations, unescaping etc, here (allow \u escape etc.)
          free (wc);

          output_string (term, str);

          free (str);

          return true;
        }
    }

  return false;
}

void
keyboard_manager::setup_hash ()
{
  unsigned int i, index, hashkey;
  vector <keysym_t *> sorted_keymap;
  uint16_t hash_bucket_size[KEYSYM_HASH_BUCKETS];       // size of each bucket

  memset (hash_bucket_size, 0, sizeof (hash_bucket_size));

  // determine hash bucket size
  for (i = 0; i < keymap.size (); ++i)
    {
      hashkey = keymap [i]->keysym & KEYSYM_HASH_MASK;
      ++hash_bucket_size [hashkey];
    }

  // now we know the size of each bucket
  // compute the index of each bucket
  hash [0] = 0;
  for (index = 0, i = 1; i < KEYSYM_HASH_BUCKETS; ++i)
    {
      index += hash_bucket_size [i - 1];
      hash [i] = index;
    }

  // and allocate just enough space
  sorted_keymap.insert (sorted_keymap.begin (), index + hash_bucket_size [i - 1], 0);

  memset (hash_bucket_size, 0, sizeof (hash_bucket_size));

  // fill in sorted_keymap
  // it is sorted in each bucket
  for (i = 0; i < keymap.size (); ++i)
    {
      hashkey = keymap [i]->keysym & KEYSYM_HASH_MASK;

      index = hash [hashkey] + hash_bucket_size [hashkey];

      while (index > hash [hashkey]
             && compare_priority (keymap [i], sorted_keymap [index - 1]) > 0)
        {
          sorted_keymap [index] = sorted_keymap [index - 1];
          --index;
        }

      sorted_keymap [index] = keymap [i];
      ++hash_bucket_size [hashkey];
    }

  keymap.swap (sorted_keymap);

#ifndef NDEBUG
  // check for invariants
  for (i = 0; i < KEYSYM_HASH_BUCKETS; ++i)
    {
      index = hash[i];
      for (int j = 0; j < hash_bucket_size [i]; ++j)
        {
          assert (i == (keymap [index + j]->keysym & KEYSYM_HASH_MASK));

          if (j)
            assert (compare_priority (keymap [index + j - 1],
                    keymap [index + j]) >= 0);
        }
    }

  // this should be able to detect most possible bugs
  for (i = 0; i < sorted_keymap.size (); ++i)
    {
      keysym_t *a = sorted_keymap[i];
      int index = find_keysym (a->keysym, a->state);

      assert (index >= 0);
      keysym_t *b = keymap [index];
      assert (i == index        // the normally expected result
              || a->keysym == b->keysym
              && compare_priority (a, b) <= 0); // is effectively the same or a closer match
    }
#endif
}

int
keyboard_manager::find_keysym (KeySym keysym, unsigned int state)
{
  int hashkey = keysym & KEYSYM_HASH_MASK;
  unsigned int index = hash [hashkey];
  unsigned int end = hashkey < KEYSYM_HASH_BUCKETS - 1
                     ? hash [hashkey + 1]
                     : keymap.size ();

  for (; index < end; ++index)
    {
      keysym_t *key = keymap [index];

      if (key->keysym == keysym
          // match only the specified bits in state and ignore others
          && (key->state & state) == key->state)
        return index;
    }

  return -1;
}

#endif /* KEYSYM_RESOURCE */
// vim:et:ts=2:sw=2
Revision:	1.45
Committed:	Sun Nov 27 09:19:04 2011 UTC (12 years, 5 months ago) by sf-exg
Content type:	text/plain
Branch:	MAIN
Changes since 1.44:	+2 -2 lines
Log Message:	Get rid of casts.
#	Content
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
24	#include "../config.h"
25	#include "rxvt.h"
26
27	#ifdef KEYSYM_RESOURCE
28
29	#include <cstring>
30
31	#include "rxvtperl.h"
32	#include "keyboard.h"
33	#include "command.h"
34
35	/* an intro to the data structure:
36	*
37	* vector keymap[] is grouped.
38	*
39	* inside each group, elements are sorted by the criteria given by compare_priority().
40	* the lookup of keysym is done in two steps:
41	* 1) locate the group corresponds to the keysym;
42	* 2) do a linear search inside the group.
43	*
44	* array hash[] effectively defines a map from a keysym to a group in keymap[].
45	*
46	* each group has its address(the index of first group element in keymap[]),
47	* which is computed and stored in hash[].
48	* hash[] stores the addresses in the form of:
49	* index: 0 I1 I2 I3 In
50	* value: 0...0, A1...A1, A2...A2, A3...A3, ..., An...An
51	* where
52	* A1 = 0;
53	* Ai+1 = N1 + N2 + ... + Ni.
54	* it is computed from hash_bucket_size[]:
55	* index: 0 I1 I2 I3 In
56	* 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 computation of hash[])
58	* or we can say
59	* hash_bucket_size[Ii] = Ni; hash_bucket_size[elsewhere] = 0,
60	* where
61	* 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
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	*/
66
67	static void
68	output_string (rxvt_term rt, const char str)
69	{
70	if (strncmp (str, "command:", 8) == 0)
71	rt->cmdbuf_append (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
79	static int
80	compare_priority (keysym_t a, keysym_t b)
81	{
82	// (the more '1's in state; the less range): the greater priority
83	int ca = ecb_popcount32 (a->state /* & OtherModMask */);
84	int cb = ecb_popcount32 (b->state /* & OtherModMask */);
85
86	if (ca != cb)
87	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 0;
92	}
93
94	////////////////////////////////////////////////////////////////////////////////
95	keyboard_manager::keyboard_manager ()
96	{
97	keymap.reserve (256);
98	hash [0] = 1; // hash[0] != 0 indicates uninitialized data
99	}
100
101	keyboard_manager::~keyboard_manager ()
102	{
103	clear ();
104	}
105
106	void
107	keyboard_manager::clear ()
108	{
109	hash [0] = 2;
110
111	for (unsigned int i = 0; i < keymap.size (); ++i)
112	{
113	free (keymap [i]->str);
114	delete keymap [i];
115	keymap [i] = 0;
116	}
117
118	keymap.clear ();
119	}
120
121	// a wrapper for register_translation that converts the input string
122	// to utf-8 and expands 'list' syntax.
123	void
124	keyboard_manager::register_user_translation (KeySym keysym, unsigned int state, const char *trans)
125	{
126	wchar_t *wc = rxvt_mbstowcs (trans);
127	char *translation = rxvt_wcstoutf8 (wc);
128	free (wc);
129
130	if (strncmp (translation, "list", 4) == 0 && translation [4]
131	&& strlen (translation) < STRING_MAX)
132	{
133	char *prefix = translation + 4;
134	char *middle = strchr (prefix + 1, translation [4]);
135	char *suffix = strrchr (prefix + 1, translation [4]);
136
137	if (suffix && middle && suffix > middle + 1)
138	{
139	int range = suffix - middle - 1;
140	int prefix_len = middle - prefix - 1;
141	char buf[STRING_MAX];
142
143	memcpy (buf, prefix + 1, prefix_len);
144	strcpy (buf + prefix_len + 1, suffix + 1);
145
146	for (int i = 0; i < range; i++)
147	{
148	buf [prefix_len] = middle [i + 1];
149	register_translation (keysym + i, state, strdup (buf));
150	}
151
152	free (translation);
153	return;
154	}
155	else
156	rxvt_warn ("cannot parse list-type keysym '%s', processing as normal keysym.\n", translation);
157	}
158
159	register_translation (keysym, state, translation);
160	}
161
162	void
163	keyboard_manager::register_translation (KeySym keysym, unsigned int state, char *translation)
164	{
165	keysym_t *key = new keysym_t;
166
167	if (key && translation)
168	{
169	key->keysym = keysym;
170	key->state = state;
171	key->str = translation;
172	key->type = keysym_t::STRING;
173
174	if (strncmp (translation, "builtin:", 8) == 0)
175	key->type = keysym_t::BUILTIN;
176
177	register_keymap (key);
178	}
179	else
180	{
181	delete key;
182	free (translation);
183	rxvt_fatal ("out of memory, aborting.\n");
184	}
185	}
186
187	void
188	keyboard_manager::register_keymap (keysym_t *key)
189	{
190	if (keymap.size () == keymap.capacity ())
191	keymap.reserve (keymap.size () * 2);
192
193	keymap.push_back (key);
194	hash[0] = 3;
195	}
196
197	void
198	keyboard_manager::register_done ()
199	{
200	setup_hash ();
201	}
202
203	bool
204	keyboard_manager::dispatch (rxvt_term *term, KeySym keysym, unsigned int state)
205	{
206	assert (hash[0] == 0 && "register_done() need to be called");
207
208	state &= OtherModMask; // mask out uninteresting modifiers
209
210	if (state & term->ModMetaMask) state \|= MetaMask;
211	if (state & term->ModNumLockMask) state \|= NumLockMask;
212	if (state & term->ModLevel3Mask) state \|= Level3Mask;
213
214	if (!!(term->priv_modes & PrivMode_aplKP) != !!(state & ShiftMask))
215	state \|= AppKeypadMask;
216
217	int index = find_keysym (keysym, state);
218
219	if (index >= 0)
220	{
221	const keysym_t &key = *keymap [index];
222
223	if (key.type != keysym_t::BUILTIN)
224	{
225	wchar_t *wc = rxvt_utf8towcs (key.str);
226	char *str = rxvt_wcstombs (wc);
227	// TODO: do (some) translations, unescaping etc, here (allow \u escape etc.)
228	free (wc);
229
230	output_string (term, str);
231
232	free (str);
233
234	return true;
235	}
236	}
237
238	return false;
239	}
240
241	void
242	keyboard_manager::setup_hash ()
243	{
244	unsigned int i, index, hashkey;
245	vector <keysym_t *> sorted_keymap;
246	uint16_t hash_bucket_size[KEYSYM_HASH_BUCKETS]; // size of each bucket
247
248	memset (hash_bucket_size, 0, sizeof (hash_bucket_size));
249
250	// determine hash bucket size
251	for (i = 0; i < keymap.size (); ++i)
252	{
253	hashkey = keymap [i]->keysym & KEYSYM_HASH_MASK;
254	++hash_bucket_size [hashkey];
255	}
256
257	// now we know the size of each bucket
258	// compute the index of each bucket
259	hash [0] = 0;
260	for (index = 0, i = 1; i < KEYSYM_HASH_BUCKETS; ++i)
261	{
262	index += hash_bucket_size [i - 1];
263	hash [i] = index;
264	}
265
266	// and allocate just enough space
267	sorted_keymap.insert (sorted_keymap.begin (), index + hash_bucket_size [i - 1], 0);
268
269	memset (hash_bucket_size, 0, sizeof (hash_bucket_size));
270
271	// fill in sorted_keymap
272	// it is sorted in each bucket
273	for (i = 0; i < keymap.size (); ++i)
274	{
275	hashkey = keymap [i]->keysym & KEYSYM_HASH_MASK;
276
277	index = hash [hashkey] + hash_bucket_size [hashkey];
278
279	while (index > hash [hashkey]
280	&& compare_priority (keymap [i], sorted_keymap [index - 1]) > 0)
281	{
282	sorted_keymap [index] = sorted_keymap [index - 1];
283	--index;
284	}
285
286	sorted_keymap [index] = keymap [i];
287	++hash_bucket_size [hashkey];
288	}
289
290	keymap.swap (sorted_keymap);
291
292	#ifndef NDEBUG
293	// check for invariants
294	for (i = 0; i < KEYSYM_HASH_BUCKETS; ++i)
295	{
296	index = hash[i];
297	for (int j = 0; j < hash_bucket_size [i]; ++j)
298	{
299	assert (i == (keymap [index + j]->keysym & KEYSYM_HASH_MASK));
300
301	if (j)
302	assert (compare_priority (keymap [index + j - 1],
303	keymap [index + j]) >= 0);
304	}
305	}
306
307	// this should be able to detect most possible bugs
308	for (i = 0; i < sorted_keymap.size (); ++i)
309	{
310	keysym_t *a = sorted_keymap[i];
311	int index = find_keysym (a->keysym, a->state);
312
313	assert (index >= 0);
314	keysym_t *b = keymap [index];
315	assert (i == index // the normally expected result
316	\|\| a->keysym == b->keysym
317	&& compare_priority (a, b) <= 0); // is effectively the same or a closer match
318	}
319	#endif
320	}
321
322	int
323	keyboard_manager::find_keysym (KeySym keysym, unsigned int state)
324	{
325	int hashkey = keysym & KEYSYM_HASH_MASK;
326	unsigned int index = hash [hashkey];
327	unsigned int end = hashkey < KEYSYM_HASH_BUCKETS - 1
328	? hash [hashkey + 1]
329	: keymap.size ();
330
331	for (; index < end; ++index)
332	{
333	keysym_t *key = keymap [index];
334
335	if (key->keysym == keysym
336	// match only the specified bits in state and ignore others
337	&& (key->state & state) == key->state)
338	return index;
339	}
340
341	return -1;
342	}
343
344	#endif /* KEYSYM_RESOURCE */
345	// vim:et:ts=2:sw=2