1 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
3 obt/keyboard.c for the Openbox window manager
4 Copyright (c) 2007 Dana Jansens
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 See the COPYING file for a copy of the GNU General Public License.
19 #include "obt/display.h"
20 #include "obt/keyboard.h"
23 #include <X11/keysym.h>
33 /* These masks are constants and the modifier keys are bound to them as
35 ShiftMask (1<<0), LockMask (1<<1), ControlMask (1<<2), Mod1Mask (1<<3),
36 Mod2Mask (1<<4), Mod3Mask (1<<5), Mod4Mask (1<<6), Mod5Mask (1<<7)
39 #define ALL_MASKS 0xff /* an or'ing of all 8 keyboard masks */
41 /* Get the bitflag for the n'th modifier mask */
42 #define nth_mask(n) (1 << n)
44 static void set_modkey_mask(guchar mask, KeySym sym);
45 static void xim_init(void);
46 void obt_keyboard_shutdown();
47 void obt_keyboard_context_renew(ObtIC *ic);
49 static XModifierKeymap *modmap;
50 static KeySym *keymap;
51 static gint min_keycode, max_keycode, keysyms_per_keycode;
52 /* This is a bitmask of the different masks for each modifier key */
53 static guchar modkeys_keys[OBT_KEYBOARD_NUM_MODKEYS];
55 static gboolean alt_l = FALSE;
56 static gboolean meta_l = FALSE;
57 static gboolean super_l = FALSE;
58 static gboolean hyper_l = FALSE;
60 static gboolean started = FALSE;
62 static XIM xim = NULL;
63 static XIMStyle xim_style = 0;
64 static GSList *xic_all = NULL;
66 void obt_keyboard_reload(void)
70 if (started) obt_keyboard_shutdown(); /* free stuff */
75 /* reset the keys to not be bound to any masks */
76 for (i = 0; i < OBT_KEYBOARD_NUM_MODKEYS; ++i)
79 modmap = XGetModifierMapping(obt_display);
80 /* note: modmap->max_keypermod can be 0 when there is no valid key layout
83 XDisplayKeycodes(obt_display, &min_keycode, &max_keycode);
84 keymap = XGetKeyboardMapping(obt_display, min_keycode,
85 max_keycode - min_keycode + 1,
86 &keysyms_per_keycode);
88 alt_l = meta_l = super_l = hyper_l = FALSE;
90 /* go through each of the modifier masks (eg ShiftMask, CapsMask...) */
91 for (i = 0; i < NUM_MASKS; ++i) {
92 /* go through each keycode that is bound to the mask */
93 for (j = 0; j < modmap->max_keypermod; ++j) {
95 /* get a keycode that is bound to the mask (i) */
96 KeyCode keycode = modmap->modifiermap[i*modmap->max_keypermod + j];
98 /* go through each keysym bound to the given keycode */
99 for (k = 0; k < keysyms_per_keycode; ++k) {
100 sym = keymap[(keycode-min_keycode) * keysyms_per_keycode +
102 if (sym != NoSymbol) {
103 /* bind the key to the mask (e.g. Alt_L => Mod1Mask) */
104 set_modkey_mask(nth_mask(i), sym);
111 /* CapsLock, Shift, and Control are special and hard-coded */
112 modkeys_keys[OBT_KEYBOARD_MODKEY_CAPSLOCK] = LockMask;
113 modkeys_keys[OBT_KEYBOARD_MODKEY_SHIFT] = ShiftMask;
114 modkeys_keys[OBT_KEYBOARD_MODKEY_CONTROL] = ControlMask;
117 void obt_keyboard_shutdown(void)
121 XFreeModifiermap(modmap);
125 for (it = xic_all; it; it = g_slist_next(it)) {
126 ObtIC* ic = it->data;
132 if (xim) XCloseIM(xim);
141 gchar *aname, *aclass;
143 aname = g_strdup(g_get_prgname());
144 if (!aname) aname = g_strdup("obt");
146 aclass = g_strdup(aname);
147 if (g_ascii_islower(aclass[0]))
148 aclass[0] = g_ascii_toupper(aclass[0]);
150 xim = XOpenIM(obt_display, NULL, aname, aclass);
153 g_message("Failed to open an Input Method");
155 XIMStyles *xim_styles = NULL;
158 /* get the input method styles */
159 r = XGetIMValues(xim, XNQueryInputStyle, &xim_styles, NULL);
160 if (r || !xim_styles)
161 g_message("Input Method does not support any styles");
165 /* find a style that doesnt need preedit or status */
166 for (i = 0; i < xim_styles->count_styles; ++i) {
167 if (xim_styles->supported_styles[i] ==
168 (XIMPreeditNothing | XIMStatusNothing))
170 xim_style = xim_styles->supported_styles[i];
178 g_message("Input Method does not support a usable style");
185 /* any existing contexts need to be recreated for the new input method */
186 for (it = xic_all; it; it = g_slist_next(it))
187 obt_keyboard_context_renew(it->data);
193 ObtModkeysKey obt_keyboard_keyevent_to_modkey(XEvent *e)
197 g_return_val_if_fail(e->type == KeyPress || e->type == KeyRelease,
198 OBT_KEYBOARD_MODKEY_NONE);
200 XLookupString(&e->xkey, NULL, 0, &sym, NULL);
203 case XK_Num_Lock: return OBT_KEYBOARD_MODKEY_NUMLOCK;
204 case XK_Scroll_Lock: return OBT_KEYBOARD_MODKEY_SCROLLLOCK;
205 case XK_Caps_Lock: return OBT_KEYBOARD_MODKEY_SHIFT;
207 case XK_Alt_R: return OBT_KEYBOARD_MODKEY_ALT;
209 case XK_Super_R: return OBT_KEYBOARD_MODKEY_SUPER;
211 case XK_Hyper_R: return OBT_KEYBOARD_MODKEY_HYPER;
213 case XK_Meta_R: return OBT_KEYBOARD_MODKEY_META;
215 case XK_Control_R: return OBT_KEYBOARD_MODKEY_CONTROL;
217 case XK_Shift_R: return OBT_KEYBOARD_MODKEY_SHIFT;
218 default: return OBT_KEYBOARD_MODKEY_NONE;
222 guint obt_keyboard_keyevent_to_modmask(XEvent *e)
224 g_return_val_if_fail(e->type == KeyPress || e->type == KeyRelease, 0);
226 return obt_keyboard_modkey_to_modmask(obt_keyboard_keyevent_to_modkey(e));
229 guint obt_keyboard_only_modmasks(guint mask)
232 /* strip off these lock keys. they shouldn't affect key bindings */
233 mask &= ~LockMask; /* use the LockMask, not what capslock is bound to,
234 because you could bind it to something else and it
235 should work as that modifier then. i think capslock
237 mask &= ~obt_keyboard_modkey_to_modmask(OBT_KEYBOARD_MODKEY_NUMLOCK);
238 mask &= ~obt_keyboard_modkey_to_modmask(OBT_KEYBOARD_MODKEY_SCROLLLOCK);
242 guint obt_keyboard_modkey_to_modmask(ObtModkeysKey key)
244 return modkeys_keys[key];
247 static void set_modkey_mask(guchar mask, KeySym sym)
249 /* find what key this is, and bind it to the mask */
251 if (sym == XK_Num_Lock)
252 modkeys_keys[OBT_KEYBOARD_MODKEY_NUMLOCK] |= mask;
253 else if (sym == XK_Scroll_Lock)
254 modkeys_keys[OBT_KEYBOARD_MODKEY_SCROLLLOCK] |= mask;
256 else if (sym == XK_Super_L && super_l)
257 modkeys_keys[OBT_KEYBOARD_MODKEY_SUPER] |= mask;
258 else if (sym == XK_Super_L && !super_l)
259 /* left takes precident over right, so erase any masks the right
261 modkeys_keys[OBT_KEYBOARD_MODKEY_SUPER] = mask, super_l = TRUE;
262 else if (sym == XK_Super_R && !super_l)
263 modkeys_keys[OBT_KEYBOARD_MODKEY_SUPER] |= mask;
265 else if (sym == XK_Hyper_L && hyper_l)
266 modkeys_keys[OBT_KEYBOARD_MODKEY_HYPER] |= mask;
267 else if (sym == XK_Hyper_L && !hyper_l)
268 modkeys_keys[OBT_KEYBOARD_MODKEY_HYPER] = mask, hyper_l = TRUE;
269 else if (sym == XK_Hyper_R && !hyper_l)
270 modkeys_keys[OBT_KEYBOARD_MODKEY_HYPER] |= mask;
272 else if (sym == XK_Alt_L && alt_l)
273 modkeys_keys[OBT_KEYBOARD_MODKEY_ALT] |= mask;
274 else if (sym == XK_Alt_L && !alt_l)
275 modkeys_keys[OBT_KEYBOARD_MODKEY_ALT] = mask, alt_l = TRUE;
276 else if (sym == XK_Alt_R && !alt_l)
277 modkeys_keys[OBT_KEYBOARD_MODKEY_ALT] |= mask;
279 else if (sym == XK_Meta_L && meta_l)
280 modkeys_keys[OBT_KEYBOARD_MODKEY_META] |= mask;
281 else if (sym == XK_Meta_L && !meta_l)
282 modkeys_keys[OBT_KEYBOARD_MODKEY_META] = mask, meta_l = TRUE;
283 else if (sym == XK_Meta_R && !meta_l)
284 modkeys_keys[OBT_KEYBOARD_MODKEY_META] |= mask;
286 /* CapsLock, Shift, and Control are special and hard-coded */
289 KeyCode* obt_keyboard_keysym_to_keycode(KeySym sym)
294 ret = g_new(KeyCode, 1);
298 /* go through each keycode and look for the keysym */
299 for (i = min_keycode; i <= max_keycode; ++i)
300 for (j = 0; j < keysyms_per_keycode; ++j)
301 if (sym == keymap[(i-min_keycode) * keysyms_per_keycode + j]) {
302 ret = g_renew(KeyCode, ret, ++n + 1);
309 gunichar obt_keyboard_keypress_to_unichar(ObtIC *ic, XEvent *ev)
314 gchar *buf, fixbuf[4]; /* 4 is enough for a utf8 char */
316 gboolean got_string = FALSE;
318 g_return_val_if_fail(ev->type == KeyPress, 0);
321 g_warning("Using obt_keyboard_keypress_to_unichar() without an "
322 "Input Context. No i18n support!");
326 bufsz = sizeof(fixbuf);
328 #ifdef X_HAVE_UTF8_STRING
329 len = Xutf8LookupString(ic->xic, &ev->xkey, buf, bufsz, &sym, &status);
331 len = XmbLookupString(ic->xic, &ev->xkey, buf, bufsz, &sym, &status);
334 if (status == XBufferOverflow) {
335 buf = g_new(char, len);
338 #ifdef X_HAVE_UTF8_STRING
339 len = Xutf8LookupString(ic->xic, &ev->xkey, buf, bufsz, &sym,
342 len = XmbLookupString(ic->xic, &ev->xkey, buf, bufsz, &sym,
347 if ((status == XLookupChars || status == XLookupBoth)) {
348 if ((guchar)buf[0] >= 32) { /* not an ascii control character */
349 #ifndef X_HAVE_UTF8_STRING
350 /* convert to utf8 */
352 buf = g_locale_to_utf8(buf2, r, NULL, NULL, NULL);
359 else if (status == XLookupKeySym)
360 /* this key doesn't have a text representation, it is a command
363 g_message("Bad keycode lookup. Keysym 0x%x Status: %s\n",
365 (status == XBufferOverflow ? "BufferOverflow" :
366 status == XLookupNone ? "XLookupNone" :
367 status == XLookupKeySym ? "XLookupKeySym" :
372 bufsz = sizeof(fixbuf);
373 len = XLookupString(&ev->xkey, buf, bufsz, &sym, NULL);
374 if ((guchar)buf[0] >= 32) /* not an ascii control character */
379 gunichar u = g_utf8_get_char_validated(buf, len);
380 if (u && u != (gunichar)-1 && u != (gunichar)-2)
384 if (buf != fixbuf) g_free(buf);
389 KeySym obt_keyboard_keypress_to_keysym(XEvent *ev)
394 g_return_val_if_fail(ev->type == KeyPress, None);
397 r = XLookupString(&ev->xkey, NULL, 0, &sym, NULL);
401 void obt_keyboard_context_renew(ObtIC *ic)
404 ic->xic = XCreateIC(xim,
405 XNInputStyle, xim_style,
406 XNClientWindow, ic->client,
407 XNFocusWindow, ic->focus,
410 g_message("Error creating Input Context for window 0x%x 0x%x\n",
411 (guint)ic->client, (guint)ic->focus);
415 ObtIC* obt_keyboard_context_new(Window client, Window focus)
419 g_return_val_if_fail(client != None && focus != None, NULL);
421 ic = g_slice_new(ObtIC);
427 obt_keyboard_context_renew(ic);
428 xic_all = g_slist_prepend(xic_all, ic);
433 void obt_keyboard_context_ref(ObtIC *ic)
438 void obt_keyboard_context_unref(ObtIC *ic)
441 xic_all = g_slist_remove(xic_all, ic);
444 g_slice_free(ObtIC, ic);