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 *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 ()
{
  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 ("unable to 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;

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

      keymap.push_back (key);
      hash[0] = 3;
    }
  else
    {
      delete key;
      free (translation);
      rxvt_fatal ("memory allocation failure. aborting.\n");
    }
}

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 *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::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.49
Committed:	Sun Nov 27 12:12:49 2011 UTC (12 years, 5 months ago) by sf-exg
Content type:	text/plain
Branch:	MAIN
Changes since 1.48:	+3 -3 lines
Log Message:	Use a pointer rather than a reference for consistency.
#	User	Rev	Content
1	root	1.25	/----------------------------------------------------------------------
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	root	1.39	* Copyright (c) 2005-2006 Marc Lehmann <schmorp@schmorp.de>
8	root	1.25	*
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	root	1.1	#include "../config.h"
25			#include "rxvt.h"
26	root	1.7
27			#ifdef KEYSYM_RESOURCE
28
29			#include <cstring>
30
31	root	1.18	#include "rxvtperl.h"
32	root	1.1	#include "keyboard.h"
33			#include "command.h"
34
35	root	1.13	/* 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	sf-exg	1.34	* it is computed from hash_bucket_size[]:
55	root	1.13	* index: 0 I1 I2 I3 In
56			* value: 0...0, N1, 0...0, N2, 0...0, N3, ..., Nn, 0...0
57	sf-exg	1.33	* 0...0, 0.......0, N1.....N1, N1+N2...N1+N2, ... (the computation of hash[])
58	root	1.13	* or we can say
59	sf-exg	1.34	* hash_bucket_size[Ii] = Ni; hash_bucket_size[elsewhere] = 0,
60	root	1.13	* 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	sf-exg	1.34	* 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	root	1.13	*/
66
67	root	1.2	static void
68	sf-exg	1.48	output_string (rxvt_term term, const char str)
69	root	1.1	{
70	root	1.10	if (strncmp (str, "command:", 8) == 0)
71	sf-exg	1.48	term->cmdbuf_append (str + 8, strlen (str) - 8);
72	root	1.18	else if (strncmp (str, "perl:", 5) == 0)
73	sf-exg	1.48	HOOK_INVOKE((term, HOOK_USER_COMMAND, DT_STR, str + 5, DT_END));
74	root	1.1	else
75	sf-exg	1.48	term->tt_write (str, strlen (str));
76	root	1.1	}
77
78			// return: priority_of_a - priority_of_b
79	root	1.2	static int
80	root	1.1	compare_priority (keysym_t a, keysym_t b)
81			{
82			// (the more '1's in state; the less range): the greater priority
83	sf-exg	1.43	int ca = ecb_popcount32 (a->state /* & OtherModMask */);
84			int cb = ecb_popcount32 (b->state /* & OtherModMask */);
85	root	1.2
86	root	1.1	if (ca != cb)
87			return ca - cb;
88	sf-exg	1.33	//else if (a->state != b->state) // this behavior is to be discussed
89	root	1.1	// return b->state - a->state;
90			else
91	sf-exg	1.41	return 0;
92	root	1.1	}
93
94			////////////////////////////////////////////////////////////////////////////////
95	root	1.2	keyboard_manager::keyboard_manager ()
96	root	1.1	{
97	root	1.2	keymap.reserve (256);
98	root	1.4	hash [0] = 1; // hash[0] != 0 indicates uninitialized data
99	root	1.1	}
100
101			keyboard_manager::~keyboard_manager ()
102			{
103	root	1.2	hash [0] = 2;
104	sf-exg	1.36
105	sf-exg	1.37	for (unsigned int i = 0; i < keymap.size (); ++i)
106	sf-exg	1.36	{
107	sf-exg	1.45	free (keymap [i]->str);
108	sf-exg	1.37	delete keymap [i];
109			keymap [i] = 0;
110	sf-exg	1.36	}
111
112	sf-exg	1.37	keymap.clear ();
113	root	1.1	}
114
115	sf-exg	1.42	// a wrapper for register_translation that converts the input string
116			// to utf-8 and expands 'list' syntax.
117	root	1.1	void
118	root	1.2	keyboard_manager::register_user_translation (KeySym keysym, unsigned int state, const char *trans)
119	root	1.1	{
120	root	1.2	wchar_t *wc = rxvt_mbstowcs (trans);
121	root	1.19	char *translation = rxvt_wcstoutf8 (wc);
122	root	1.2	free (wc);
123	root	1.1
124	sf-exg	1.42	if (strncmp (translation, "list", 4) == 0 && translation [4]
125			&& strlen (translation) < STRING_MAX)
126			{
127			char *prefix = translation + 4;
128			char *middle = strchr (prefix + 1, translation [4]);
129			char *suffix = strrchr (prefix + 1, translation [4]);
130
131			if (suffix && middle && suffix > middle + 1)
132			{
133			int range = suffix - middle - 1;
134			int prefix_len = middle - prefix - 1;
135			char buf[STRING_MAX];
136
137			memcpy (buf, prefix + 1, prefix_len);
138			strcpy (buf + prefix_len + 1, suffix + 1);
139
140			for (int i = 0; i < range; i++)
141			{
142			buf [prefix_len] = middle [i + 1];
143			register_translation (keysym + i, state, strdup (buf));
144			}
145
146			free (translation);
147			return;
148			}
149			else
150	sf-exg	1.46	rxvt_warn ("unable to parse list-type keysym '%s', processing as normal keysym.\n", translation);
151	sf-exg	1.42	}
152
153			register_translation (keysym, state, translation);
154			}
155
156			void
157			keyboard_manager::register_translation (KeySym keysym, unsigned int state, char *translation)
158			{
159			keysym_t *key = new keysym_t;
160
161	root	1.2	if (key && translation)
162	root	1.1	{
163			key->keysym = keysym;
164	root	1.2	key->state = state;
165			key->str = translation;
166	root	1.22	key->type = keysym_t::STRING;
167	root	1.2
168	sf-exg	1.41	if (strncmp (translation, "builtin:", 8) == 0)
169	root	1.16	key->type = keysym_t::BUILTIN;
170	root	1.1
171	sf-exg	1.47	if (keymap.size () == keymap.capacity ())
172			keymap.reserve (keymap.size () * 2);
173
174			keymap.push_back (key);
175			hash[0] = 3;
176	root	1.1	}
177			else
178			{
179			delete key;
180	sf-exg	1.45	free (translation);
181	sf-exg	1.46	rxvt_fatal ("memory allocation failure. aborting.\n");
182	root	1.1	}
183			}
184
185	root	1.2	bool
186			keyboard_manager::dispatch (rxvt_term *term, KeySym keysym, unsigned int state)
187	root	1.1	{
188	sf-exg	1.46	assert (("register_done() need to be called", hash[0] == 0));
189	root	1.1
190	root	1.14	state &= OtherModMask; // mask out uninteresting modifiers
191
192	root	1.6	if (state & term->ModMetaMask) state \|= MetaMask;
193			if (state & term->ModNumLockMask) state \|= NumLockMask;
194			if (state & term->ModLevel3Mask) state \|= Level3Mask;
195	root	1.3
196			if (!!(term->priv_modes & PrivMode_aplKP) != !!(state & ShiftMask))
197			state \|= AppKeypadMask;
198
199	root	1.1	int index = find_keysym (keysym, state);
200
201			if (index >= 0)
202			{
203	sf-exg	1.49	keysym_t *key = keymap [index];
204	root	1.2
205	sf-exg	1.49	if (key->type != keysym_t::BUILTIN)
206	root	1.16	{
207	sf-exg	1.49	wchar_t *wc = rxvt_utf8towcs (key->str);
208	root	1.16	char *str = rxvt_wcstombs (wc);
209			// TODO: do (some) translations, unescaping etc, here (allow \u escape etc.)
210			free (wc);
211	root	1.2
212	sf-exg	1.44	output_string (term, str);
213	root	1.2
214	root	1.16	free (str);
215	root	1.2
216	root	1.16	return true;
217			}
218	root	1.1	}
219	root	1.16
220			return false;
221	root	1.1	}
222
223			void
224	sf-exg	1.47	keyboard_manager::register_done ()
225	root	1.1	{
226			unsigned int i, index, hashkey;
227	root	1.2	vector <keysym_t *> sorted_keymap;
228	sf-exg	1.34	uint16_t hash_bucket_size[KEYSYM_HASH_BUCKETS]; // size of each bucket
229	root	1.1
230	sf-exg	1.34	memset (hash_bucket_size, 0, sizeof (hash_bucket_size));
231	root	1.1
232	root	1.11	// determine hash bucket size
233	root	1.2	for (i = 0; i < keymap.size (); ++i)
234	sf-exg	1.41	{
235			hashkey = keymap [i]->keysym & KEYSYM_HASH_MASK;
236			++hash_bucket_size [hashkey];
237			}
238	root	1.1
239	sf-exg	1.34	// now we know the size of each bucket
240			// compute the index of each bucket
241	root	1.4	hash [0] = 0;
242	sf-exg	1.34	for (index = 0, i = 1; i < KEYSYM_HASH_BUCKETS; ++i)
243	root	1.1	{
244	sf-exg	1.34	index += hash_bucket_size [i - 1];
245	root	1.11	hash [i] = index;
246	root	1.1	}
247	root	1.2
248	root	1.1	// and allocate just enough space
249	sf-exg	1.34	sorted_keymap.insert (sorted_keymap.begin (), index + hash_bucket_size [i - 1], 0);
250	root	1.1
251	sf-exg	1.38	memset (hash_bucket_size, 0, sizeof (hash_bucket_size));
252
253	root	1.1	// fill in sorted_keymap
254	sf-exg	1.34	// it is sorted in each bucket
255	root	1.2	for (i = 0; i < keymap.size (); ++i)
256	sf-exg	1.41	{
257			hashkey = keymap [i]->keysym & KEYSYM_HASH_MASK;
258
259			index = hash [hashkey] + hash_bucket_size [hashkey];
260
261			while (index > hash [hashkey]
262			&& compare_priority (keymap [i], sorted_keymap [index - 1]) > 0)
263			{
264			sorted_keymap [index] = sorted_keymap [index - 1];
265			--index;
266			}
267
268			sorted_keymap [index] = keymap [i];
269			++hash_bucket_size [hashkey];
270			}
271	root	1.1
272	root	1.2	keymap.swap (sorted_keymap);
273	root	1.1
274	root	1.32	#ifndef NDEBUG
275	root	1.1	// check for invariants
276	sf-exg	1.34	for (i = 0; i < KEYSYM_HASH_BUCKETS; ++i)
277	root	1.1	{
278	root	1.2	index = hash[i];
279	sf-exg	1.34	for (int j = 0; j < hash_bucket_size [i]; ++j)
280	root	1.1	{
281	sf-exg	1.41	assert (i == (keymap [index + j]->keysym & KEYSYM_HASH_MASK));
282	root	1.2
283	root	1.1	if (j)
284	root	1.4	assert (compare_priority (keymap [index + j - 1],
285			keymap [index + j]) >= 0);
286	root	1.1	}
287			}
288
289			// this should be able to detect most possible bugs
290			for (i = 0; i < sorted_keymap.size (); ++i)
291			{
292			keysym_t *a = sorted_keymap[i];
293	sf-exg	1.41	int index = find_keysym (a->keysym, a->state);
294	root	1.6
295	sf-exg	1.41	assert (index >= 0);
296			keysym_t *b = keymap [index];
297			assert (i == index // the normally expected result
298			\|\| a->keysym == b->keysym
299			&& compare_priority (a, b) <= 0); // is effectively the same or a closer match
300	root	1.1	}
301			#endif
302			}
303
304			int
305			keyboard_manager::find_keysym (KeySym keysym, unsigned int state)
306			{
307	root	1.2	int hashkey = keysym & KEYSYM_HASH_MASK;
308			unsigned int index = hash [hashkey];
309	sf-exg	1.34	unsigned int end = hashkey < KEYSYM_HASH_BUCKETS - 1
310	ayin	1.28	? hash [hashkey + 1]
311	root	1.11	: keymap.size ();
312	root	1.1
313	root	1.11	for (; index < end; ++index)
314	root	1.1	{
315	root	1.4	keysym_t *key = keymap [index];
316	root	1.2
317	sf-exg	1.41	if (key->keysym == keysym
318	root	1.1	// match only the specified bits in state and ignore others
319	root	1.16	&& (key->state & state) == key->state)
320	root	1.2	return index;
321	root	1.1	}
322
323			return -1;
324			}
325
326			#endif /* KEYSYM_RESOURCE */
327			// vim:et:ts=2:sw=2