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 <pcg@goof.com>
 *
 * 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].
 */

#if STOCK_KEYMAP
////////////////////////////////////////////////////////////////////////////////
// default keycode translation map and keyevent handlers

keysym_t keyboard_manager::stock_keymap[] = {
  /* examples */
  /*        keysym,                state, range,                  type,              str */
//{XK_ISO_Left_Tab,                    0,     1,      keysym_t::STRING,           "\033[Z"},
//{            'a',                    0,    26, keysym_t::RANGE_META8,           "a" "%c"},
//{            'a',          ControlMask,    26, keysym_t::RANGE_META8,          "" "%c"},
//{        XK_Left,                    0,     4,        keysym_t::LIST,     ".\033[.DACB."},
//{        XK_Left,            ShiftMask,     4,        keysym_t::LIST,     ".\033[.dacb."},
//{        XK_Left,          ControlMask,     4,        keysym_t::LIST,     ".\033O.dacb."},
//{         XK_Tab,          ControlMask,     1,      keysym_t::STRING,      "\033<C-Tab>"},
//{  XK_apostrophe,          ControlMask,     1,      keysym_t::STRING,        "\033<C-'>"},
//{       XK_slash,          ControlMask,     1,      keysym_t::STRING,        "\033<C-/>"},
//{   XK_semicolon,          ControlMask,     1,      keysym_t::STRING,        "\033<C-;>"},
//{       XK_grave,          ControlMask,     1,      keysym_t::STRING,        "\033<C-`>"},
//{       XK_comma,          ControlMask,     1,      keysym_t::STRING,     "\033<C-\054>"},
//{      XK_Return,          ControlMask,     1,      keysym_t::STRING,   "\033<C-Return>"},
//{      XK_Return,            ShiftMask,     1,      keysym_t::STRING,   "\033<S-Return>"},
//{            ' ',            ShiftMask,     1,      keysym_t::STRING,    "\033<S-Space>"},
//{            '.',          ControlMask,     1,      keysym_t::STRING,        "\033<C-.>"},
//{            '0',          ControlMask,    10,       keysym_t::RANGE,   "0" "\033<C-%c>"},
//{            '0', MetaMask|ControlMask,    10,       keysym_t::RANGE, "0" "\033<M-C-%c>"},
//{            'a', MetaMask|ControlMask,    26,       keysym_t::RANGE, "a" "\033<M-C-%c>"},
};
#endif

static void
output_string (rxvt_term *rt, const char *str)
{
  if (strncmp (str, "command:", 8) == 0)
    rt->cmd_write (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));
}

static void
output_string_meta8 (rxvt_term *rt, unsigned int state, char *buf, int buflen)
{
  if (state & rt->ModMetaMask)
    {
#ifdef META8_OPTION
      if (rt->meta_char == 0x80)        /* set 8-bit on */
        {
          for (char *ch = buf; ch < buf + buflen; ch++)
            *ch |= 0x80;
        }
      else if (rt->meta_char == C0_ESC) /* escape prefix */
#endif
        {
          const char ch = C0_ESC;
          rt->tt_write (&ch, 1);
        }
    }

  rt->tt_write (buf, buflen);
}

static int
format_keyrange_string (const char *str, int keysym_offset, char *buf, int bufsize)
{
  size_t len = snprintf (buf, bufsize, str + 1, keysym_offset + str [0]);

  if (len >= (size_t)bufsize)
    {
      rxvt_warn ("format_keyrange_string: formatting failed, ignoring key.\n");
      *buf = 0;
    }

  return len;
}

// 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 = rxvt_popcount (a->state /* & OtherModMask */);
  int cb = rxvt_popcount (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 b->range - a->range;
}

////////////////////////////////////////////////////////////////////////////////
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 ()
{
  keymap.clear ();
  hash [0] = 2;
}

// a wrapper for register_keymap,
// so that outside codes don't have to know so much details.
//
// the string 'trans' is copied to an internal managed buffer,
// so the caller can free memory of 'trans' at any time.
void
keyboard_manager::register_user_translation (KeySym keysym, unsigned int state, const char *trans)
{
  keysym_t *key = new keysym_t;
  wchar_t *wc = rxvt_mbstowcs (trans);
  char *translation = rxvt_wcstoutf8 (wc);
  free (wc);

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

      if (strncmp (translation, "list", 4) == 0 && translation [4])
        {
          char *middle = strchr  (translation + 5, translation [4]);
          char *suffix = strrchr (translation + 5, translation [4]);

          if (suffix && middle && suffix > middle + 1)
            {
              key->type  = keysym_t::LIST;
              key->range = suffix - middle - 1;

              memmove (translation, translation + 4, strlen (translation + 4) + 1);
            }
          else
            rxvt_warn ("cannot parse list-type keysym '%s', treating as normal keysym.\n", translation);
        }
      else if (strncmp (translation, "builtin:", 8) == 0)
        key->type = keysym_t::BUILTIN;

      register_keymap (key);
    }
  else
    {
      delete key;
      free ((void *)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 ()
{
#if STOCK_KEYMAP
  int n = sizeof (stock_keymap) / sizeof (keysym_t);

  //TODO: shield against repeated calls and empty keymap
  //if (keymap.back () != &stock_keymap[n - 1])
    for (int i = 0; i < n; ++i)
      register_keymap (&stock_keymap[i]);
#endif

  purge_duplicate_keymap ();

  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)
        {
          int keysym_offset = keysym - key.keysym;

          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);

          switch (key.type)
            {
              case keysym_t::STRING:
                output_string (term, str);
                break;

              case keysym_t::RANGE:
                {
                  char buf[STRING_MAX];

                  if (format_keyrange_string (str, keysym_offset, buf, sizeof (buf)) > 0)
                    output_string (term, buf);
                }
                break;

              case keysym_t::RANGE_META8:
                {
                  int len;
                  char buf[STRING_MAX];

                  len = format_keyrange_string (str, keysym_offset, buf, sizeof (buf));
                  if (len > 0)
                    output_string_meta8 (term, state, buf, len);
                }
                break;

              case keysym_t::LIST:
                {
                  char buf[STRING_MAX];

                  char *prefix, *middle, *suffix;

                  prefix = str;
                  middle = strchr  (prefix + 1, *prefix);
                  suffix = strrchr (middle + 1, *prefix);

                  memcpy (buf, prefix + 1, middle - prefix - 1);
                  buf [middle - prefix - 1] = middle [keysym_offset + 1];
                  strcpy (buf + (middle - prefix), suffix + 1);

                  output_string (term, buf);
                }
                break;
            }

          free (str);

          return true;
        }
    }

  return false;
}

// purge duplicate keymap entries
void keyboard_manager::purge_duplicate_keymap ()
{
  for (unsigned int i = 0; i < keymap.size (); ++i)
    {
      for (unsigned int j = 0; j < i; ++j)
        {
          if (keymap [i] == keymap [j])
            {
              while (keymap [i] == keymap.back ())
                keymap.pop_back ();

              if (i < keymap.size ())
                {
                  keymap[i] = keymap.back ();
                  keymap.pop_back ();
                }

              break;
            }
        }
    }
}

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
  uint16_t hash_bucket_counter[KEYSYM_HASH_BUCKETS];    // #elements in each bucket

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

  // determine hash bucket size
  for (i = 0; i < keymap.size (); ++i)
    for (int j = min (keymap [i]->range, KEYSYM_HASH_BUCKETS) - 1; j >= 0; --j)
      {
        hashkey = (keymap [i]->keysym + j) & 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);

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

        index = hash [hashkey] + hash_bucket_counter [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_counter [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)
        {
          if (keymap [index + j]->range == 1)
            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];
      for (int j = 0; j < a->range; ++j)
        {
          int index = find_keysym (a->keysym + j, a->state);

          assert (index >= 0);
          keysym_t *b = keymap [index];
          assert (i == index    // the normally expected result
                  || IN_RANGE_INC (a->keysym + j, b->keysym, b->keysym + b->range)
                  && 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 && keysym < key->keysym + key->range
          // 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.35
Committed:	Mon Aug 23 15:58:43 2010 UTC (13 years, 9 months ago) by sf-exg
Content type:	text/plain
Branch:	MAIN
Changes since 1.34:	+0 -17 lines
Log Message:	Remove write-only variables.
#	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			* Copyright (c) 2005-2006 Marc Lehmann <pcg@goof.com>
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	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.12	#if STOCK_KEYMAP
68	root	1.1	////////////////////////////////////////////////////////////////////////////////
69			// default keycode translation map and keyevent handlers
70
71	root	1.2	keysym_t keyboard_manager::stock_keymap[] = {
72	root	1.1	/* examples */
73	ayin	1.29	/* keysym, state, range, type, str */
74	root	1.22	//{XK_ISO_Left_Tab, 0, 1, keysym_t::STRING, "\033[Z"},
75	root	1.10	//{ 'a', 0, 26, keysym_t::RANGE_META8, "a" "%c"},
76			//{ 'a', ControlMask, 26, keysym_t::RANGE_META8, "" "%c"},
77			//{ XK_Left, 0, 4, keysym_t::LIST, ".\033[.DACB."},
78			//{ XK_Left, ShiftMask, 4, keysym_t::LIST, ".\033[.dacb."},
79			//{ XK_Left, ControlMask, 4, keysym_t::LIST, ".\033O.dacb."},
80	root	1.22	//{ XK_Tab, ControlMask, 1, keysym_t::STRING, "\033<C-Tab>"},
81			//{ XK_apostrophe, ControlMask, 1, keysym_t::STRING, "\033<C-'>"},
82			//{ XK_slash, ControlMask, 1, keysym_t::STRING, "\033<C-/>"},
83			//{ XK_semicolon, ControlMask, 1, keysym_t::STRING, "\033<C-;>"},
84			//{ XK_grave, ControlMask, 1, keysym_t::STRING, "\033<C-`>"},
85			//{ XK_comma, ControlMask, 1, keysym_t::STRING, "\033<C-\054>"},
86			//{ XK_Return, ControlMask, 1, keysym_t::STRING, "\033<C-Return>"},
87			//{ XK_Return, ShiftMask, 1, keysym_t::STRING, "\033<S-Return>"},
88			//{ ' ', ShiftMask, 1, keysym_t::STRING, "\033<S-Space>"},
89			//{ '.', ControlMask, 1, keysym_t::STRING, "\033<C-.>"},
90	root	1.10	//{ '0', ControlMask, 10, keysym_t::RANGE, "0" "\033<C-%c>"},
91			//{ '0', MetaMask\|ControlMask, 10, keysym_t::RANGE, "0" "\033<M-C-%c>"},
92			//{ 'a', MetaMask\|ControlMask, 26, keysym_t::RANGE, "a" "\033<M-C-%c>"},
93	root	1.1	};
94	root	1.12	#endif
95	root	1.1
96	root	1.2	static void
97			output_string (rxvt_term rt, const char str)
98	root	1.1	{
99	root	1.10	if (strncmp (str, "command:", 8) == 0)
100	root	1.19	rt->cmd_write (str + 8, strlen (str) - 8);
101	root	1.18	else if (strncmp (str, "perl:", 5) == 0)
102	root	1.24	HOOK_INVOKE((rt, HOOK_USER_COMMAND, DT_STR, str + 5, DT_END));
103	root	1.1	else
104	root	1.19	rt->tt_write (str, strlen (str));
105	root	1.1	}
106
107	root	1.2	static void
108			output_string_meta8 (rxvt_term rt, unsigned int state, char buf, int buflen)
109	root	1.1	{
110			if (state & rt->ModMetaMask)
111			{
112			#ifdef META8_OPTION
113	root	1.2	if (rt->meta_char == 0x80) /* set 8-bit on */
114	root	1.1	{
115			for (char *ch = buf; ch < buf + buflen; ch++)
116			*ch \|= 0x80;
117			}
118	root	1.2	else if (rt->meta_char == C0_ESC) /* escape prefix */
119	root	1.1	#endif
120			{
121	root	1.19	const char ch = C0_ESC;
122	root	1.1	rt->tt_write (&ch, 1);
123			}
124			}
125
126	root	1.19	rt->tt_write (buf, buflen);
127	root	1.1	}
128
129	root	1.2	static int
130			format_keyrange_string (const char str, int keysym_offset, char buf, int bufsize)
131	root	1.1	{
132	root	1.7	size_t len = snprintf (buf, bufsize, str + 1, keysym_offset + str [0]);
133	root	1.1
134	root	1.7	if (len >= (size_t)bufsize)
135	root	1.1	{
136	root	1.7	rxvt_warn ("format_keyrange_string: formatting failed, ignoring key.\n");
137	root	1.5	*buf = 0;
138	root	1.1	}
139
140			return len;
141			}
142
143			// return: priority_of_a - priority_of_b
144	root	1.2	static int
145	root	1.1	compare_priority (keysym_t a, keysym_t b)
146			{
147			// (the more '1's in state; the less range): the greater priority
148	root	1.31	int ca = rxvt_popcount (a->state /* & OtherModMask */);
149			int cb = rxvt_popcount (b->state /* & OtherModMask */);
150	root	1.2
151	root	1.1	if (ca != cb)
152			return ca - cb;
153	sf-exg	1.33	//else if (a->state != b->state) // this behavior is to be discussed
154	root	1.1	// return b->state - a->state;
155			else
156			return b->range - a->range;
157			}
158
159			////////////////////////////////////////////////////////////////////////////////
160	root	1.2	keyboard_manager::keyboard_manager ()
161	root	1.1	{
162	root	1.2	keymap.reserve (256);
163	root	1.4	hash [0] = 1; // hash[0] != 0 indicates uninitialized data
164	root	1.1	}
165
166			keyboard_manager::~keyboard_manager ()
167			{
168			clear ();
169			}
170
171			void
172			keyboard_manager::clear ()
173			{
174	root	1.2	keymap.clear ();
175			hash [0] = 2;
176	root	1.1	}
177
178			// a wrapper for register_keymap,
179			// so that outside codes don't have to know so much details.
180			//
181			// the string 'trans' is copied to an internal managed buffer,
182			// so the caller can free memory of 'trans' at any time.
183			void
184	root	1.2	keyboard_manager::register_user_translation (KeySym keysym, unsigned int state, const char *trans)
185	root	1.1	{
186			keysym_t *key = new keysym_t;
187	root	1.2	wchar_t *wc = rxvt_mbstowcs (trans);
188	root	1.19	char *translation = rxvt_wcstoutf8 (wc);
189	root	1.2	free (wc);
190	root	1.1
191	root	1.2	if (key && translation)
192	root	1.1	{
193			key->keysym = keysym;
194	root	1.2	key->state = state;
195			key->range = 1;
196			key->str = translation;
197	root	1.22	key->type = keysym_t::STRING;
198	root	1.2
199			if (strncmp (translation, "list", 4) == 0 && translation [4])
200			{
201			char *middle = strchr (translation + 5, translation [4]);
202			char *suffix = strrchr (translation + 5, translation [4]);
203	ayin	1.28
204	root	1.2	if (suffix && middle && suffix > middle + 1)
205			{
206			key->type = keysym_t::LIST;
207			key->range = suffix - middle - 1;
208	root	1.1
209	root	1.26	memmove (translation, translation + 4, strlen (translation + 4) + 1);
210	root	1.2	}
211			else
212	root	1.7	rxvt_warn ("cannot parse list-type keysym '%s', treating as normal keysym.\n", translation);
213	root	1.1	}
214	root	1.16	else if (strncmp (translation, "builtin:", 8) == 0)
215			key->type = keysym_t::BUILTIN;
216	root	1.1
217			register_keymap (key);
218			}
219			else
220			{
221			delete key;
222	root	1.2	free ((void *)translation);
223	root	1.1	rxvt_fatal ("out of memory, aborting.\n");
224			}
225			}
226
227			void
228			keyboard_manager::register_keymap (keysym_t *key)
229			{
230	root	1.2	if (keymap.size () == keymap.capacity ())
231			keymap.reserve (keymap.size () * 2);
232	root	1.1
233	root	1.2	keymap.push_back (key);
234			hash[0] = 3;
235	root	1.1	}
236
237			void
238			keyboard_manager::register_done ()
239			{
240	root	1.12	#if STOCK_KEYMAP
241			int n = sizeof (stock_keymap) / sizeof (keysym_t);
242	root	1.1
243	root	1.12	//TODO: shield against repeated calls and empty keymap
244			//if (keymap.back () != &stock_keymap[n - 1])
245			for (int i = 0; i < n; ++i)
246	root	1.2	register_keymap (&stock_keymap[i]);
247	root	1.12	#endif
248	root	1.1
249			purge_duplicate_keymap ();
250
251			setup_hash ();
252			}
253
254	root	1.2	bool
255			keyboard_manager::dispatch (rxvt_term *term, KeySym keysym, unsigned int state)
256	root	1.1	{
257	root	1.2	assert (hash[0] == 0 && "register_done() need to be called");
258	root	1.1
259	root	1.14	state &= OtherModMask; // mask out uninteresting modifiers
260
261	root	1.6	if (state & term->ModMetaMask) state \|= MetaMask;
262			if (state & term->ModNumLockMask) state \|= NumLockMask;
263			if (state & term->ModLevel3Mask) state \|= Level3Mask;
264	root	1.3
265			if (!!(term->priv_modes & PrivMode_aplKP) != !!(state & ShiftMask))
266			state \|= AppKeypadMask;
267
268	root	1.1	int index = find_keysym (keysym, state);
269
270			if (index >= 0)
271			{
272	root	1.2	const keysym_t &key = *keymap [index];
273
274	root	1.16	if (key.type != keysym_t::BUILTIN)
275			{
276			int keysym_offset = keysym - key.keysym;
277	root	1.2
278	root	1.16	wchar_t *wc = rxvt_utf8towcs (key.str);
279			char *str = rxvt_wcstombs (wc);
280			// TODO: do (some) translations, unescaping etc, here (allow \u escape etc.)
281			free (wc);
282	root	1.2
283	root	1.16	switch (key.type)
284			{
285	root	1.22	case keysym_t::STRING:
286	root	1.16	output_string (term, str);
287			break;
288	root	1.2
289	root	1.16	case keysym_t::RANGE:
290			{
291			char buf[STRING_MAX];
292	root	1.2
293	root	1.16	if (format_keyrange_string (str, keysym_offset, buf, sizeof (buf)) > 0)
294			output_string (term, buf);
295			}
296			break;
297	root	1.2
298	root	1.16	case keysym_t::RANGE_META8:
299			{
300			int len;
301			char buf[STRING_MAX];
302	root	1.2
303	root	1.16	len = format_keyrange_string (str, keysym_offset, buf, sizeof (buf));
304			if (len > 0)
305			output_string_meta8 (term, state, buf, len);
306			}
307			break;
308	root	1.2
309	root	1.16	case keysym_t::LIST:
310			{
311			char buf[STRING_MAX];
312	root	1.2
313	root	1.16	char prefix, middle, *suffix;
314	root	1.2
315	root	1.16	prefix = str;
316			middle = strchr (prefix + 1, *prefix);
317			suffix = strrchr (middle + 1, *prefix);
318	root	1.2
319	root	1.16	memcpy (buf, prefix + 1, middle - prefix - 1);
320			buf [middle - prefix - 1] = middle [keysym_offset + 1];
321			strcpy (buf + (middle - prefix), suffix + 1);
322	root	1.2
323	root	1.16	output_string (term, buf);
324			}
325			break;
326	root	1.2	}
327
328	root	1.16	free (str);
329	root	1.2
330	root	1.16	return true;
331			}
332	root	1.1	}
333	root	1.16
334			return false;
335	root	1.1	}
336
337	root	1.2	// purge duplicate keymap entries
338			void keyboard_manager::purge_duplicate_keymap ()
339	root	1.1	{
340	root	1.2	for (unsigned int i = 0; i < keymap.size (); ++i)
341	root	1.1	{
342			for (unsigned int j = 0; j < i; ++j)
343			{
344	root	1.4	if (keymap [i] == keymap [j])
345	root	1.1	{
346	root	1.4	while (keymap [i] == keymap.back ())
347	root	1.2	keymap.pop_back ();
348
349			if (i < keymap.size ())
350	root	1.1	{
351	root	1.2	keymap[i] = keymap.back ();
352			keymap.pop_back ();
353	root	1.1	}
354	root	1.11
355	root	1.1	break;
356			}
357			}
358			}
359			}
360
361			void
362			keyboard_manager::setup_hash ()
363			{
364			unsigned int i, index, hashkey;
365	root	1.2	vector <keysym_t *> sorted_keymap;
366	sf-exg	1.34	uint16_t hash_bucket_size[KEYSYM_HASH_BUCKETS]; // size of each bucket
367			uint16_t hash_bucket_counter[KEYSYM_HASH_BUCKETS]; // #elements in each bucket
368	root	1.1
369	sf-exg	1.34	memset (hash_bucket_size, 0, sizeof (hash_bucket_size));
370			memset (hash_bucket_counter, 0, sizeof (hash_bucket_counter));
371	root	1.1
372	root	1.11	// determine hash bucket size
373	root	1.2	for (i = 0; i < keymap.size (); ++i)
374	sf-exg	1.34	for (int j = min (keymap [i]->range, KEYSYM_HASH_BUCKETS) - 1; j >= 0; --j)
375	root	1.11	{
376			hashkey = (keymap [i]->keysym + j) & KEYSYM_HASH_MASK;
377	sf-exg	1.34	++hash_bucket_size [hashkey];
378	root	1.11	}
379	root	1.1
380	sf-exg	1.34	// now we know the size of each bucket
381			// compute the index of each bucket
382	root	1.4	hash [0] = 0;
383	sf-exg	1.34	for (index = 0, i = 1; i < KEYSYM_HASH_BUCKETS; ++i)
384	root	1.1	{
385	sf-exg	1.34	index += hash_bucket_size [i - 1];
386	root	1.11	hash [i] = index;
387	root	1.1	}
388	root	1.2
389	root	1.1	// and allocate just enough space
390	sf-exg	1.34	sorted_keymap.insert (sorted_keymap.begin (), index + hash_bucket_size [i - 1], 0);
391	root	1.1
392			// fill in sorted_keymap
393	sf-exg	1.34	// it is sorted in each bucket
394	root	1.2	for (i = 0; i < keymap.size (); ++i)
395	sf-exg	1.34	for (int j = min (keymap [i]->range, KEYSYM_HASH_BUCKETS) - 1; j >= 0; --j)
396	root	1.11	{
397			hashkey = (keymap [i]->keysym + j) & KEYSYM_HASH_MASK;
398
399	sf-exg	1.34	index = hash [hashkey] + hash_bucket_counter [hashkey];
400	root	1.11
401			while (index > hash [hashkey]
402			&& compare_priority (keymap [i], sorted_keymap [index - 1]) > 0)
403			{
404			sorted_keymap [index] = sorted_keymap [index - 1];
405			--index;
406			}
407
408			sorted_keymap [index] = keymap [i];
409	sf-exg	1.34	++hash_bucket_counter [hashkey];
410	root	1.11	}
411	root	1.1
412	root	1.2	keymap.swap (sorted_keymap);
413	root	1.1
414	root	1.32	#ifndef NDEBUG
415	root	1.1	// check for invariants
416	sf-exg	1.34	for (i = 0; i < KEYSYM_HASH_BUCKETS; ++i)
417	root	1.1	{
418	root	1.2	index = hash[i];
419	sf-exg	1.34	for (int j = 0; j < hash_bucket_size [i]; ++j)
420	root	1.1	{
421	root	1.4	if (keymap [index + j]->range == 1)
422			assert (i == (keymap [index + j]->keysym & KEYSYM_HASH_MASK));
423	root	1.2
424	root	1.1	if (j)
425	root	1.4	assert (compare_priority (keymap [index + j - 1],
426			keymap [index + j]) >= 0);
427	root	1.1	}
428			}
429
430			// this should be able to detect most possible bugs
431			for (i = 0; i < sorted_keymap.size (); ++i)
432			{
433			keysym_t *a = sorted_keymap[i];
434			for (int j = 0; j < a->range; ++j)
435			{
436	root	1.7	int index = find_keysym (a->keysym + j, a->state);
437	root	1.6
438	root	1.1	assert (index >= 0);
439	root	1.4	keysym_t *b = keymap [index];
440	ayin	1.30	assert (i == index // the normally expected result
441			\|\| IN_RANGE_INC (a->keysym + j, b->keysym, b->keysym + b->range)
442			&& compare_priority (a, b) <= 0); // is effectively the same or a closer match
443	root	1.1	}
444			}
445			#endif
446			}
447
448			int
449			keyboard_manager::find_keysym (KeySym keysym, unsigned int state)
450			{
451	root	1.2	int hashkey = keysym & KEYSYM_HASH_MASK;
452			unsigned int index = hash [hashkey];
453	sf-exg	1.34	unsigned int end = hashkey < KEYSYM_HASH_BUCKETS - 1
454	ayin	1.28	? hash [hashkey + 1]
455	root	1.11	: keymap.size ();
456	root	1.1
457	root	1.11	for (; index < end; ++index)
458	root	1.1	{
459	root	1.4	keysym_t *key = keymap [index];
460	root	1.2
461	root	1.11	if (key->keysym <= keysym && keysym < key->keysym + key->range
462	root	1.1	// match only the specified bits in state and ignore others
463	root	1.16	&& (key->state & state) == key->state)
464	root	1.2	return index;
465	root	1.1	}
466
467			return -1;
468			}
469
470			#endif /* KEYSYM_RESOURCE */
471			// vim:et:ts=2:sw=2