Correct typo occured -> occurred in function name
[dana/openbox.git] / obt / keyboard.c
1 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
2
3    obt/keyboard.c for the Openbox window manager
4    Copyright (c) 2007        Dana Jansens
5
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.
10
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.
15
16    See the COPYING file for a copy of the GNU General Public License.
17 */
18
19 #include "obt/display.h"
20 #include "obt/keyboard.h"
21
22 #include <X11/Xlib.h>
23 #include <X11/keysym.h>
24
25 struct _ObtIC
26 {
27     guint ref;
28     XIC xic;
29     Window client;
30     Window focus;
31 };
32
33 /* These masks are constants and the modifier keys are bound to them as
34    anyone sees fit:
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)
37 */
38 #define NUM_MASKS 8
39 #define ALL_MASKS 0xff /* an or'ing of all 8 keyboard masks */
40
41 /* Get the bitflag for the n'th modifier mask */
42 #define nth_mask(n) (1 << n)
43
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);
48
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];
54
55 static gboolean alt_l = FALSE;
56 static gboolean meta_l = FALSE;
57 static gboolean super_l = FALSE;
58 static gboolean hyper_l = FALSE;
59
60 static gboolean started = FALSE;
61
62 static XIM xim = NULL;
63 static XIMStyle xim_style = 0;
64 static GSList *xic_all = NULL;
65
66 void obt_keyboard_reload(void)
67 {
68     gint i, j, k;
69
70     if (started) obt_keyboard_shutdown(); /* free stuff */
71     started = TRUE;
72
73     xim_init();
74
75     /* reset the keys to not be bound to any masks */
76     for (i = 0; i < OBT_KEYBOARD_NUM_MODKEYS; ++i)
77         modkeys_keys[i] = 0;
78
79     modmap = XGetModifierMapping(obt_display);
80     /* note: modmap->max_keypermod can be 0 when there is no valid key layout
81        available */
82
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);
87
88     alt_l = meta_l = super_l = hyper_l = FALSE;
89
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) {
94             KeySym sym;
95             /* get a keycode that is bound to the mask (i) */
96             KeyCode keycode = modmap->modifiermap[i*modmap->max_keypermod + j];
97             if (keycode) {
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 +
101                                  k];
102                     if (sym != NoSymbol) {
103                         /* bind the key to the mask (e.g. Alt_L => Mod1Mask) */
104                         set_modkey_mask(nth_mask(i), sym);
105                     }
106                 }
107             }
108         }
109     }
110
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;
115 }
116
117 void obt_keyboard_shutdown(void)
118 {
119     GSList *it;
120
121     XFreeModifiermap(modmap);
122     modmap = NULL;
123     XFree(keymap);
124     keymap = NULL;
125     for (it = xic_all; it; it = g_slist_next(it)) {
126         ObtIC* ic = it->data;
127         if (ic->xic) {
128             XDestroyIC(ic->xic);
129             ic->xic = NULL;
130         }
131     }
132     if (xim) XCloseIM(xim);
133     xim = NULL;
134     xim_style = 0;
135     started = FALSE;
136 }
137
138 void xim_init(void)
139 {
140     GSList *it;
141     gchar *aname, *aclass;
142
143     aname = g_strdup(g_get_prgname());
144     if (!aname) aname = g_strdup("obt");
145
146     aclass = g_strdup(aname);
147     if (g_ascii_islower(aclass[0]))
148         aclass[0] = g_ascii_toupper(aclass[0]);
149
150     xim = XOpenIM(obt_display, NULL, aname, aclass);
151
152     if (!xim)
153         g_message("Failed to open an Input Method");
154     else {
155         XIMStyles *xim_styles = NULL;
156         char *r;
157
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");
162         if (xim_styles) {
163             int i;
164
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))
169                 {
170                     xim_style = xim_styles->supported_styles[i];
171                     break;
172                 }
173             }
174             XFree(xim_styles);
175         }
176
177         if (!xim_style) {
178             g_message("Input Method does not support a usable style");
179
180             XCloseIM(xim);
181             xim = NULL;
182         }
183     }
184
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);
188
189     g_free(aclass);
190     g_free(aname);
191 }
192
193 ObtModkeysKey obt_keyboard_keyevent_to_modkey(XEvent *e)
194 {
195     KeySym sym;
196
197     g_return_val_if_fail(e->type == KeyPress || e->type == KeyRelease,
198                          OBT_KEYBOARD_MODKEY_NONE);
199
200     XLookupString(&e->xkey, NULL, 0, &sym, NULL);
201
202     switch (sym) {
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;
206     case XK_Alt_L:
207     case XK_Alt_R: return OBT_KEYBOARD_MODKEY_ALT;
208     case XK_Super_L:
209     case XK_Super_R: return OBT_KEYBOARD_MODKEY_SUPER;
210     case XK_Hyper_L:
211     case XK_Hyper_R: return OBT_KEYBOARD_MODKEY_SUPER;
212     case XK_Meta_L:
213     case XK_Meta_R: return OBT_KEYBOARD_MODKEY_SUPER;
214     case XK_Control_L:
215     case XK_Control_R: return OBT_KEYBOARD_MODKEY_CONTROL;
216     case XK_Shift_L:
217     case XK_Shift_R: return OBT_KEYBOARD_MODKEY_SHIFT;
218     default: return OBT_KEYBOARD_MODKEY_NONE;
219     }
220 }
221
222 guint obt_keyboard_keyevent_to_modmask(XEvent *e)
223 {
224     g_return_val_if_fail(e->type == KeyPress || e->type == KeyRelease, 0);
225
226     return obt_keyboard_modkey_to_modmask(obt_keyboard_keyevent_to_modkey(e));
227 }
228
229 guint obt_keyboard_only_modmasks(guint mask)
230 {
231     mask &= ALL_MASKS;
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
236                           is weird in xkb. */
237     mask &= ~obt_keyboard_modkey_to_modmask(OBT_KEYBOARD_MODKEY_NUMLOCK);
238     mask &= ~obt_keyboard_modkey_to_modmask(OBT_KEYBOARD_MODKEY_SCROLLLOCK);
239     return mask;
240 }
241
242 guint obt_keyboard_modkey_to_modmask(ObtModkeysKey key)
243 {
244     return modkeys_keys[key];
245 }
246
247 static void set_modkey_mask(guchar mask, KeySym sym)
248 {
249     /* find what key this is, and bind it to the mask */
250
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;
255
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
260            key may have set */
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;
264
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;
271
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;
278
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;
285
286     /* CapsLock, Shift, and Control are special and hard-coded */
287 }
288
289 KeyCode* obt_keyboard_keysym_to_keycode(KeySym sym)
290 {
291     KeyCode *ret;
292     gint i, j, n;
293
294     ret = g_new(KeyCode, 1);
295     n = 0;
296     ret[n] = 0;
297
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);
303                 ret[n-1] = i;
304                 ret[n] = 0;
305             }
306     return ret;
307 }
308
309 gunichar obt_keyboard_keypress_to_unichar(ObtIC *ic, XEvent *ev)
310 {
311     gunichar unikey = 0;
312     KeySym sym;
313     Status status;
314     gchar *buf, fixbuf[4]; /* 4 is enough for a utf8 char */
315     gint len, bufsz;
316     gboolean got_string = FALSE;
317
318     g_return_val_if_fail(ev->type == KeyPress, 0);
319
320     if (!ic)
321         g_warning("Using obt_keyboard_keypress_to_unichar() without an "
322                   "Input Context.  No i18n support!");
323
324     if (ic && ic->xic) {
325         buf = fixbuf;
326         bufsz = sizeof(fixbuf);
327
328 #ifdef X_HAVE_UTF8_STRING
329         len = Xutf8LookupString(ic->xic, &ev->xkey, buf, bufsz, &sym, &status);
330 #else
331         len = XmbLookupString(ic->xic, &ev->xkey, buf, bufsz, &sym, &status);
332 #endif
333
334         if (status == XBufferOverflow) {
335             buf = g_new(char, len);
336             bufsz = len;
337
338 #ifdef X_HAVE_UTF8_STRING
339             len = Xutf8LookupString(ic->xic, &ev->xkey, buf, bufsz, &sym,
340                                     &status);
341 #else
342             len = XmbLookupString(ic->xic, &ev->xkey, buf, bufsz, &sym,
343                                   &status);
344 #endif
345         }
346
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 */
351                 gchar *buf2 = buf;
352                 buf = g_locale_to_utf8(buf2, r, NULL, NULL, NULL);
353                 g_free(buf2);
354 #endif
355
356                 got_string = TRUE;
357             }
358         }
359         else if (status == XLookupKeySym)
360             /* this key doesn't have a text representation, it is a command
361                key of some sort */;
362         else
363             g_message("Bad keycode lookup. Keysym 0x%x Status: %s\n",
364                       (guint) sym,
365                       (status == XBufferOverflow ? "BufferOverflow" :
366                        status == XLookupNone ? "XLookupNone" :
367                        status == XLookupKeySym ? "XLookupKeySym" :
368                        "Unknown status"));
369     }
370     else {
371         buf = fixbuf;
372         bufsz = sizeof(fixbuf);
373         len = XLookupString(&ev->xkey, buf, bufsz, &sym, NULL);
374         if ((guchar)buf[0] >= 32) /* not an ascii control character */
375             got_string = TRUE;
376     }
377
378     if (got_string) {
379         gunichar u = g_utf8_get_char_validated(buf, len);
380         if (u && u != (gunichar)-1 && u != (gunichar)-2)
381             unikey = u;
382     }
383
384     if (buf != fixbuf) g_free(buf);
385
386     return unikey;
387 }
388
389 KeySym obt_keyboard_keypress_to_keysym(XEvent *ev)
390 {
391     KeySym sym;
392     gint r;
393
394     g_return_val_if_fail(ev->type == KeyPress, None);
395
396     sym = None;
397     r = XLookupString(&ev->xkey, NULL, 0, &sym, NULL);
398     return sym;
399 }
400
401 void obt_keyboard_context_renew(ObtIC *ic)
402 {
403     if (xim) {
404         ic->xic = XCreateIC(xim,
405                             XNInputStyle, xim_style,
406                             XNClientWindow, ic->client,
407                             XNFocusWindow, ic->focus,
408                             NULL);
409         if (!ic->xic)
410             g_message("Error creating Input Context for window 0x%x 0x%x\n",
411                       (guint)ic->client, (guint)ic->focus);
412     }
413 }
414
415 ObtIC* obt_keyboard_context_new(Window client, Window focus)
416 {
417     ObtIC *ic;
418
419     g_return_val_if_fail(client != None && focus != None, NULL);
420
421     ic = g_slice_new(ObtIC);
422     ic->ref = 1;
423     ic->client = client;
424     ic->focus = focus;
425     ic->xic = NULL;
426
427     obt_keyboard_context_renew(ic);
428     xic_all = g_slist_prepend(xic_all, ic);
429
430     return ic;
431 }
432
433 void obt_keyboard_context_ref(ObtIC *ic)
434 {
435     ++ic->ref;
436 }
437
438 void obt_keyboard_context_unref(ObtIC *ic)
439 {
440     if (--ic->ref < 1) {
441         xic_all = g_slist_remove(xic_all, ic);
442         XDestroyIC(ic->xic);
443         g_slice_free(ObtIC, ic);
444     }
445 }