use g_slice_new() instead of g_new() part 3
[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     g_print("Opening Input Method for %s %s\n", aname, aclass);
151     xim = XOpenIM(obt_display, NULL, aname, aclass);
152
153     if (!xim)
154         g_message("Failed to open an Input Method");
155     else {
156         XIMStyles *xim_styles = NULL;
157         char *r;
158
159         /* get the input method styles */
160         r = XGetIMValues(xim, XNQueryInputStyle, &xim_styles, NULL);
161         if (r || !xim_styles)
162             g_message("Input Method does not support any styles");
163         if (xim_styles) {
164             int i;
165
166             /* find a style that doesnt need preedit or status */
167             for (i = 0; i < xim_styles->count_styles; ++i) {
168                 if (xim_styles->supported_styles[i] == 
169                     (XIMPreeditNothing | XIMStatusNothing))
170                 {
171                     xim_style = xim_styles->supported_styles[i];
172                     break;
173                 }
174             }
175             XFree(xim_styles);
176         }
177
178         if (!xim_style) {
179             g_message("Input Method does not support a usable style");
180
181             XCloseIM(xim);
182             xim = NULL;
183         }
184     }
185
186     /* any existing contexts need to be recreated for the new input method */
187     for (it = xic_all; it; it = g_slist_next(it))
188         obt_keyboard_context_renew(it->data);
189
190     g_free(aclass);
191     g_free(aname);
192 }
193
194 guint obt_keyboard_keycode_to_modmask(guint keycode)
195 {
196     gint i, j;
197     guint mask = 0;
198
199     if (keycode == NoSymbol) return 0;
200
201     /* go through each of the modifier masks (eg ShiftMask, CapsMask...) */
202     for (i = 0; i < NUM_MASKS; ++i) {
203         /* go through each keycode that is bound to the mask */
204         for (j = 0; j < modmap->max_keypermod; ++j) {
205             /* compare with a keycode that is bound to the mask (i) */
206             if (modmap->modifiermap[i*modmap->max_keypermod + j] == keycode)
207                 mask |= nth_mask(i);
208         }
209     }
210     return mask;
211 }
212
213 guint obt_keyboard_only_modmasks(guint mask)
214 {
215     mask &= ALL_MASKS;
216     /* strip off these lock keys. they shouldn't affect key bindings */
217     mask &= ~LockMask; /* use the LockMask, not what capslock is bound to,
218                           because you could bind it to something else and it
219                           should work as that modifier then. i think capslock
220                           is weird in xkb. */
221     mask &= ~obt_keyboard_modkey_to_modmask(OBT_KEYBOARD_MODKEY_NUMLOCK);
222     mask &= ~obt_keyboard_modkey_to_modmask(OBT_KEYBOARD_MODKEY_SCROLLLOCK);
223     return mask;
224 }
225
226 guint obt_keyboard_modkey_to_modmask(ObtModkeysKey key)
227 {
228     return modkeys_keys[key];
229 }
230
231 static void set_modkey_mask(guchar mask, KeySym sym)
232 {
233     /* find what key this is, and bind it to the mask */
234
235     if (sym == XK_Num_Lock)
236         modkeys_keys[OBT_KEYBOARD_MODKEY_NUMLOCK] |= mask;
237     else if (sym == XK_Scroll_Lock)
238         modkeys_keys[OBT_KEYBOARD_MODKEY_SCROLLLOCK] |= mask;
239
240     else if (sym == XK_Super_L && super_l)
241         modkeys_keys[OBT_KEYBOARD_MODKEY_SUPER] |= mask;
242     else if (sym == XK_Super_L && !super_l)
243         /* left takes precident over right, so erase any masks the right
244            key may have set */
245         modkeys_keys[OBT_KEYBOARD_MODKEY_SUPER] = mask, super_l = TRUE;
246     else if (sym == XK_Super_R && !super_l)
247         modkeys_keys[OBT_KEYBOARD_MODKEY_SUPER] |= mask;
248
249     else if (sym == XK_Hyper_L && hyper_l)
250         modkeys_keys[OBT_KEYBOARD_MODKEY_HYPER] |= mask;
251     else if (sym == XK_Hyper_L && !hyper_l)
252         modkeys_keys[OBT_KEYBOARD_MODKEY_HYPER] = mask, hyper_l = TRUE;
253     else if (sym == XK_Hyper_R && !hyper_l)
254         modkeys_keys[OBT_KEYBOARD_MODKEY_HYPER] |= mask;
255
256     else if (sym == XK_Alt_L && alt_l)
257         modkeys_keys[OBT_KEYBOARD_MODKEY_ALT] |= mask;
258     else if (sym == XK_Alt_L && !alt_l)
259         modkeys_keys[OBT_KEYBOARD_MODKEY_ALT] = mask, alt_l = TRUE;
260     else if (sym == XK_Alt_R && !alt_l)
261         modkeys_keys[OBT_KEYBOARD_MODKEY_ALT] |= mask;
262
263     else if (sym == XK_Meta_L && meta_l)
264         modkeys_keys[OBT_KEYBOARD_MODKEY_META] |= mask;
265     else if (sym == XK_Meta_L && !meta_l)
266         modkeys_keys[OBT_KEYBOARD_MODKEY_META] = mask, meta_l = TRUE;
267     else if (sym == XK_Meta_R && !meta_l)
268         modkeys_keys[OBT_KEYBOARD_MODKEY_META] |= mask;
269
270     /* CapsLock, Shift, and Control are special and hard-coded */
271 }
272
273 KeyCode* obt_keyboard_keysym_to_keycode(KeySym sym)
274 {
275     KeyCode *ret;
276     gint i, j, n;
277
278     ret = g_new(KeyCode, 1);
279     n = 0;
280     ret[n] = 0;
281
282     /* go through each keycode and look for the keysym */
283     for (i = min_keycode; i <= max_keycode; ++i)
284         for (j = 0; j < keysyms_per_keycode; ++j)
285             if (sym == keymap[(i-min_keycode) * keysyms_per_keycode + j]) {
286                 ret = g_renew(KeyCode, ret, ++n);
287                 ret[n-1] = i;
288                 ret[n] = 0;
289             }
290     return ret;
291 }
292
293 gunichar obt_keyboard_keypress_to_unichar(ObtIC *ic, XEvent *ev)
294 {
295     gunichar unikey = 0;
296     KeySym sym;
297     Status status;
298     gchar *buf, fixbuf[4]; /* 4 is enough for a utf8 char */
299     gint len, bufsz;
300     gboolean got_string = FALSE;
301
302     g_return_val_if_fail(ev->type == KeyPress, 0);
303
304     if (!ic)
305         g_warning("Using obt_keyboard_keypress_to_unichar() without an "
306                   "Input Context.  No i18n support!");
307
308     if (ic && ic->xic) {
309         buf = fixbuf;
310         bufsz = sizeof(fixbuf);
311
312 #ifdef X_HAVE_UTF8_STRING
313         len = Xutf8LookupString(ic->xic, &ev->xkey, buf, bufsz, &sym, &status);
314 #else
315         len = XmbLookupString(ic->xic, &ev->xkey, buf, bufsz, &sym, &status);
316 #endif
317
318         if (status == XBufferOverflow) {
319             buf = g_new(char, len);
320             bufsz = len;
321
322 #ifdef X_HAVE_UTF8_STRING
323             len = Xutf8LookupString(ic->xic, &ev->xkey, buf, bufsz, &sym,
324                                     &status);
325 #else
326             len = XmbLookupString(ic->xic, &ev->xkey, buf, bufsz, &sym,
327                                   &status);
328 #endif
329         }
330
331         if ((status == XLookupChars || status == XLookupBoth)) {
332             if ((guchar)buf[0] >= 32) { /* not an ascii control character */
333 #ifndef X_HAVE_UTF8_STRING
334                 /* convert to utf8 */
335                 gchar *buf2 = buf;
336                 buf = g_locale_to_utf8(buf2, r, NULL, NULL, NULL);
337                 g_free(buf2);
338 #endif
339
340                 got_string = TRUE;
341             }
342         }
343         else if (status == XLookupKeySym)
344             /* this key doesn't have a text representation, it is a command
345                key of some sort */;
346         else
347             g_message("Bad keycode lookup. Keysym 0x%x Status: %s\n",
348                       (guint) sym,
349                       (status == XBufferOverflow ? "BufferOverflow" :
350                        status == XLookupNone ? "XLookupNone" :
351                        status == XLookupKeySym ? "XLookupKeySym" :
352                        "Unknown status"));
353     }
354     else {
355         buf = fixbuf;
356         bufsz = sizeof(fixbuf);
357         len = XLookupString(&ev->xkey, buf, bufsz, &sym, NULL);
358         if ((guchar)buf[0] >= 32) /* not an ascii control character */
359             got_string = TRUE;
360     }
361
362     if (got_string) {
363         gunichar u = g_utf8_get_char_validated(buf, len);
364         if (u && u != (gunichar)-1 && u != (gunichar)-2)
365             unikey = u;
366     }
367
368     if (buf != fixbuf) g_free(buf);
369
370     return unikey;
371 }
372
373 KeySym obt_keyboard_keypress_to_keysym(XEvent *ev)
374 {
375     KeySym sym;
376     gint r;
377
378     g_return_val_if_fail(ev->type == KeyPress, None);
379
380     sym = None;
381     r = XLookupString(&ev->xkey, NULL, 0, &sym, NULL);
382     return sym;
383 }
384
385 void obt_keyboard_context_renew(ObtIC *ic)
386 {
387     if (xim) {
388         ic->xic = XCreateIC(xim,
389                             XNInputStyle, xim_style,
390                             XNClientWindow, ic->client,
391                             XNFocusWindow, ic->focus,
392                             NULL);
393         if (!ic->xic)
394             g_message("Error creating Input Context for window 0x%x 0x%x\n",
395                       (guint)ic->client, (guint)ic->focus);
396     }
397 }
398
399 ObtIC* obt_keyboard_context_new(Window client, Window focus)
400 {
401     ObtIC *ic;
402
403     g_return_val_if_fail(client != None && focus != None, NULL);
404
405     ic = g_slice_new(ObtIC);
406     ic->ref = 1;
407     ic->client = client;
408     ic->focus = focus;
409     ic->xic = NULL;
410
411     obt_keyboard_context_renew(ic);
412     xic_all = g_slist_prepend(xic_all, ic);
413
414     return ic;
415 }
416
417 void obt_keyboard_context_ref(ObtIC *ic)
418 {
419     ++ic->ref;
420 }
421
422 void obt_keyboard_context_unref(ObtIC *ic)
423 {
424     if (--ic->ref < 1) {
425         xic_all = g_slist_remove(xic_all, ic);
426         XDestroyIC(ic->xic);
427         g_slice_free(ObtIC, ic);
428     }
429 }