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"

/* 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 *term, const char *str)
{
  if (strncmp (str, "command:", 8) == 0)
    term->cmdbuf_append (str + 8, strlen (str) - 8);
  else if (strncmp (str, "perl:", 5) == 0)
    HOOK_INVOKE((term, HOOK_USER_COMMAND, DT_STR, str + 5, DT_END));
  else
    term->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 ()
{
  for (unsigned int i = 0; i < keymap.size (); ++i)
    {
      free (keymap [i]->str);
      delete keymap [i];
    }
}

void
keyboard_manager::register_user_translation (KeySym keysym, unsigned int state, const wchar_t *ws)
{
  char *translation = rxvt_wcstoutf8 (ws);

  keysym_t *key = new keysym_t;

  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;

  if (keymap.size () == keymap.capacity ())
    keymap.reserve (keymap.size () * 2);

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

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

  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)
    {
      keysym_t *key = keymap [index];

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

          output_string (term, str);

          free (str);

          return true;
        }
    }

  return false;
}

void
keyboard_manager::register_done ()
{
  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.57
Committed:	Wed Dec 21 11:14:43 2011 UTC (12 years, 5 months ago) by sf-exg
Content type:	text/plain
Branch:	MAIN
CVS Tags:	rel-9_14
Changes since 1.56:	+0 -1 lines
Log Message:	Remove unneeded include.
#	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
34	/* an intro to the data structure:
35	*
36	* vector keymap[] is grouped.
37	*
38	* inside each group, elements are sorted by the criteria given by compare_priority().
39	* the lookup of keysym is done in two steps:
40	* 1) locate the group corresponds to the keysym;
41	* 2) do a linear search inside the group.
42	*
43	* array hash[] effectively defines a map from a keysym to a group in keymap[].
44	*
45	* each group has its address(the index of first group element in keymap[]),
46	* which is computed and stored in hash[].
47	* hash[] stores the addresses in the form of:
48	* index: 0 I1 I2 I3 In
49	* value: 0...0, A1...A1, A2...A2, A3...A3, ..., An...An
50	* where
51	* A1 = 0;
52	* Ai+1 = N1 + N2 + ... + Ni.
53	* it is computed from hash_bucket_size[]:
54	* index: 0 I1 I2 I3 In
55	* value: 0...0, N1, 0...0, N2, 0...0, N3, ..., Nn, 0...0
56	* 0...0, 0.......0, N1.....N1, N1+N2...N1+N2, ... (the computation of hash[])
57	* or we can say
58	* hash_bucket_size[Ii] = Ni; hash_bucket_size[elsewhere] = 0,
59	* where
60	* set {I1, I2, ..., In} = { hashkey of keymap[0]->keysym, ..., keymap[keymap.size-1]->keysym }
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	*/
65
66	static void
67	output_string (rxvt_term term, const char str)
68	{
69	if (strncmp (str, "command:", 8) == 0)
70	term->cmdbuf_append (str + 8, strlen (str) - 8);
71	else if (strncmp (str, "perl:", 5) == 0)
72	HOOK_INVOKE((term, HOOK_USER_COMMAND, DT_STR, str + 5, DT_END));
73	else
74	term->tt_write (str, strlen (str));
75	}
76
77	// return: priority_of_a - priority_of_b
78	static int
79	compare_priority (keysym_t a, keysym_t b)
80	{
81	// (the more '1's in state; the less range): the greater priority
82	int ca = ecb_popcount32 (a->state /* & OtherModMask */);
83	int cb = ecb_popcount32 (b->state /* & OtherModMask */);
84
85	if (ca != cb)
86	return ca - cb;
87	//else if (a->state != b->state) // this behavior is to be discussed
88	// return b->state - a->state;
89	else
90	return 0;
91	}
92
93	////////////////////////////////////////////////////////////////////////////////
94	keyboard_manager::keyboard_manager ()
95	{
96	keymap.reserve (256);
97	hash [0] = 1; // hash[0] != 0 indicates uninitialized data
98	}
99
100	keyboard_manager::~keyboard_manager ()
101	{
102	for (unsigned int i = 0; i < keymap.size (); ++i)
103	{
104	free (keymap [i]->str);
105	delete keymap [i];
106	}
107	}
108
109	void
110	keyboard_manager::register_user_translation (KeySym keysym, unsigned int state, const wchar_t *ws)
111	{
112	char *translation = rxvt_wcstoutf8 (ws);
113
114	keysym_t *key = new keysym_t;
115
116	key->keysym = keysym;
117	key->state = state;
118	key->str = translation;
119	key->type = keysym_t::STRING;
120
121	if (strncmp (translation, "builtin:", 8) == 0)
122	key->type = keysym_t::BUILTIN;
123
124	if (keymap.size () == keymap.capacity ())
125	keymap.reserve (keymap.size () * 2);
126
127	keymap.push_back (key);
128	hash[0] = 3;
129	}
130
131	bool
132	keyboard_manager::dispatch (rxvt_term *term, KeySym keysym, unsigned int state)
133	{
134	assert (("register_done() need to be called", hash[0] == 0));
135
136	state &= OtherModMask; // mask out uninteresting modifiers
137
138	if (state & term->ModMetaMask) state \|= MetaMask;
139	if (state & term->ModNumLockMask) state \|= NumLockMask;
140	if (state & term->ModLevel3Mask) state \|= Level3Mask;
141
142	if (!!(term->priv_modes & PrivMode_aplKP) != !!(state & ShiftMask))
143	state \|= AppKeypadMask;
144
145	int index = find_keysym (keysym, state);
146
147	if (index >= 0)
148	{
149	keysym_t *key = keymap [index];
150
151	if (key->type != keysym_t::BUILTIN)
152	{
153	wchar_t *ws = rxvt_utf8towcs (key->str);
154	char *str = rxvt_wcstombs (ws);
155	// TODO: do (some) translations, unescaping etc, here (allow \u escape etc.)
156	free (ws);
157
158	output_string (term, str);
159
160	free (str);
161
162	return true;
163	}
164	}
165
166	return false;
167	}
168
169	void
170	keyboard_manager::register_done ()
171	{
172	unsigned int i, index, hashkey;
173	vector <keysym_t *> sorted_keymap;
174	uint16_t hash_bucket_size[KEYSYM_HASH_BUCKETS]; // size of each bucket
175
176	memset (hash_bucket_size, 0, sizeof (hash_bucket_size));
177
178	// determine hash bucket size
179	for (i = 0; i < keymap.size (); ++i)
180	{
181	hashkey = keymap [i]->keysym & KEYSYM_HASH_MASK;
182	++hash_bucket_size [hashkey];
183	}
184
185	// now we know the size of each bucket
186	// compute the index of each bucket
187	hash [0] = 0;
188	for (index = 0, i = 1; i < KEYSYM_HASH_BUCKETS; ++i)
189	{
190	index += hash_bucket_size [i - 1];
191	hash [i] = index;
192	}
193
194	// and allocate just enough space
195	sorted_keymap.insert (sorted_keymap.begin (), index + hash_bucket_size [i - 1], 0);
196
197	memset (hash_bucket_size, 0, sizeof (hash_bucket_size));
198
199	// fill in sorted_keymap
200	// it is sorted in each bucket
201	for (i = 0; i < keymap.size (); ++i)
202	{
203	hashkey = keymap [i]->keysym & KEYSYM_HASH_MASK;
204
205	index = hash [hashkey] + hash_bucket_size [hashkey];
206
207	while (index > hash [hashkey]
208	&& compare_priority (keymap [i], sorted_keymap [index - 1]) > 0)
209	{
210	sorted_keymap [index] = sorted_keymap [index - 1];
211	--index;
212	}
213
214	sorted_keymap [index] = keymap [i];
215	++hash_bucket_size [hashkey];
216	}
217
218	keymap.swap (sorted_keymap);
219
220	#ifndef NDEBUG
221	// check for invariants
222	for (i = 0; i < KEYSYM_HASH_BUCKETS; ++i)
223	{
224	index = hash[i];
225	for (int j = 0; j < hash_bucket_size [i]; ++j)
226	{
227	assert (i == (keymap [index + j]->keysym & KEYSYM_HASH_MASK));
228
229	if (j)
230	assert (compare_priority (keymap [index + j - 1],
231	keymap [index + j]) >= 0);
232	}
233	}
234
235	// this should be able to detect most possible bugs
236	for (i = 0; i < sorted_keymap.size (); ++i)
237	{
238	keysym_t *a = sorted_keymap[i];
239	int index = find_keysym (a->keysym, a->state);
240
241	assert (index >= 0);
242	keysym_t *b = keymap [index];
243	assert (i == index // the normally expected result
244	\|\| a->keysym == b->keysym
245	&& compare_priority (a, b) <= 0); // is effectively the same or a closer match
246	}
247	#endif
248	}
249
250	int
251	keyboard_manager::find_keysym (KeySym keysym, unsigned int state)
252	{
253	int hashkey = keysym & KEYSYM_HASH_MASK;
254	unsigned int index = hash [hashkey];
255	unsigned int end = hashkey < KEYSYM_HASH_BUCKETS - 1
256	? hash [hashkey + 1]
257	: keymap.size ();
258
259	for (; index < end; ++index)
260	{
261	keysym_t *key = keymap [index];
262
263	if (key->keysym == keysym
264	// match only the specified bits in state and ignore others
265	&& (key->state & state) == key->state)
266	return index;
267	}
268
269	return -1;
270	}
271
272	#endif /* KEYSYM_RESOURCE */
273	// vim:et:ts=2:sw=2