95433acc7782bbc97e1ea9b260b70877ba147b45
[dana/openbox.git] / openbox / keyboard.c
1 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
2
3    keyboard.c for the Openbox window manager
4    Copyright (c) 2006        Mikael Magnusson
5    Copyright (c) 2003-2007   Dana Jansens
6
7    This program is free software; you can redistribute it and/or modify
8    it under the terms of the GNU General Public License as published by
9    the Free Software Foundation; either version 2 of the License, or
10    (at your option) any later version.
11
12    This program is distributed in the hope that it will be useful,
13    but WITHOUT ANY WARRANTY; without even the implied warranty of
14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15    GNU General Public License for more details.
16
17    See the COPYING file for a copy of the GNU General Public License.
18 */
19
20 #include "focus.h"
21 #include "screen.h"
22 #include "frame.h"
23 #include "openbox.h"
24 #include "event.h"
25 #include "grab.h"
26 #include "client.h"
27 #include "actions.h"
28 #include "menuframe.h"
29 #include "config.h"
30 #include "keytree.h"
31 #include "keyboard.h"
32 #include "translate.h"
33 #include "moveresize.h"
34 #include "popup.h"
35 #include "gettext.h"
36 #include "obt/keyboard.h"
37
38 #include <glib.h>
39
40 KeyBindingTree *keyboard_firstnode = NULL;
41 static ObPopup *popup = NULL;
42 static KeyBindingTree *curpos;
43 static guint chain_timer = 0;
44
45 static void grab_keys(gboolean grab)
46 {
47     KeyBindingTree *p;
48
49     ungrab_all_keys(obt_root(ob_screen));
50
51     if (grab) {
52         p = curpos ? curpos->first_child : keyboard_firstnode;
53         while (p) {
54             if (p->key)
55                 grab_key(p->key, p->state, obt_root(ob_screen),
56                          GrabModeAsync);
57             p = p->next_sibling;
58         }
59         if (curpos)
60             grab_key(config_keyboard_reset_keycode,
61                      config_keyboard_reset_state,
62                      obt_root(ob_screen), GrabModeAsync);
63     }
64 }
65
66 static gboolean chain_timeout(gpointer data)
67 {
68     keyboard_reset_chains(0);
69     XFlush(obt_display);
70     return FALSE; /* don't repeat */
71 }
72
73 static void chain_done(gpointer data)
74 {
75     chain_timer = 0;
76 }
77
78 static void set_curpos(KeyBindingTree *newpos)
79 {
80     if (curpos == newpos) return;
81
82     grab_keys(FALSE);
83     curpos = newpos;
84     grab_keys(TRUE);
85
86     if (curpos != NULL) {
87         gchar *text = NULL;
88         GList *it;
89         const Rect *a;
90
91         for (it = curpos->keylist; it; it = g_list_next(it)) {
92             gchar *oldtext = text;
93             if (text == NULL)
94                 text = g_strdup(it->data);
95             else
96                 text = g_strconcat(text, " - ", it->data, NULL);
97             g_free(oldtext);
98         }
99
100         a = screen_physical_area_primary(FALSE);
101         popup_position(popup, NorthWestGravity, a->x + 10, a->y + 10);
102         /* 1 second delay for the popup to show */
103         popup_delay_show(popup, 1000, text);
104         g_free(text);
105     } else {
106         popup_hide(popup);
107     }
108 }
109
110 void keyboard_reset_chains(gint break_chroots)
111 {
112     KeyBindingTree *p;
113
114     for (p = curpos; p; p = p->parent) {
115         if (p->chroot) {
116             if (break_chroots == 0) break; /* stop here */
117             if (break_chroots > 0)
118                 --break_chroots;
119         }
120     }
121     set_curpos(p);
122 }
123
124 void keyboard_unbind_all(void)
125 {
126     tree_destroy(keyboard_firstnode);
127     keyboard_firstnode = NULL;
128 }
129
130 void keyboard_chroot(GList *keylist)
131 {
132     /* try do it in the existing tree. if we can't that means it is an empty
133        chroot binding. so add it to the tree then. */
134     if (!tree_chroot(keyboard_firstnode, keylist)) {
135         KeyBindingTree *tree;
136         if (!(tree = tree_build(keylist)))
137             return;
138         tree_chroot(tree, keylist);
139         tree_assimilate(tree);
140     }
141 }
142
143 gboolean keyboard_bind(GList *keylist, ObActionsAct *action)
144 {
145     KeyBindingTree *tree, *t;
146     gboolean conflict;
147
148     g_assert(keylist != NULL);
149     g_assert(action != NULL);
150
151     if (!(tree = tree_build(keylist)))
152         return FALSE;
153
154     if ((t = tree_find(tree, &conflict)) != NULL) {
155         /* already bound to something, use the existing tree */
156         tree_destroy(tree);
157         tree = NULL;
158     } else
159         t = tree;
160
161     if (conflict) {
162         g_message(_("Conflict with key binding in config file"));
163         tree_destroy(tree);
164         return FALSE;
165     }
166
167     /* find the bottom node */
168     for (; t->first_child; t = t->first_child);
169
170     /* set the action */
171     t->actions = g_slist_append(t->actions, action);
172     /* assimilate this built tree into the main tree. assimilation
173        destroys/uses the tree */
174     if (tree) tree_assimilate(tree);
175
176     return TRUE;
177 }
178
179 #if 0
180 gboolean keyboard_process_interactive_grab(const XEvent *e, ObClient **client)
181 {
182     gboolean handled = FALSE;
183     gboolean done = FALSE;
184     gboolean cancel = FALSE;
185     guint mods;
186
187     mods = obt_keyboard_only_modmasks(ev->xkey.state);
188
189     if (istate.active) {
190         if ((e->type == KeyRelease && !(istate.state & mods))) {
191             done = TRUE;
192             handled = TRUE;
193         } else if (e->type == KeyPress) {
194             /*if (e->xkey.keycode == ob_keycode(OB_KEY_RETURN))
195               done = TRUE;
196               else */if (e->xkey.keycode == ob_keycode(OB_KEY_ESCAPE)) {
197                   cancel = done = TRUE;
198                   handled = TRUE;
199               }
200         } else if (e->type == ButtonPress) {
201             cancel = TRUE;
202             done = TRUE;
203             handled = FALSE;
204         }
205
206         if (done)
207             keyboard_interactive_end(e->xkey.state, cancel, e->xkey.time,TRUE);
208
209         if (handled)
210             *client = istate.client;
211     }
212
213     return handled;
214 }
215 #endif
216
217 gboolean keyboard_event(ObClient *client, const XEvent *e)
218 {
219     KeyBindingTree *p;
220     gboolean used;
221     guint mods;
222
223     if (e->type == KeyRelease) {
224         grab_key_passive_count(-1);
225         return FALSE;
226     }
227
228     g_assert(e->type == KeyPress);
229     grab_key_passive_count(1);
230
231     mods = obt_keyboard_only_modmasks(e->xkey.state);
232
233     if (e->xkey.keycode == config_keyboard_reset_keycode &&
234         mods == config_keyboard_reset_state)
235     {
236         if (chain_timer) g_source_remove(chain_timer);
237         keyboard_reset_chains(-1);
238         return TRUE;
239     }
240
241     used = FALSE;
242     if (curpos == NULL)
243         p = keyboard_firstnode;
244     else
245         p = curpos->first_child;
246     while (p) {
247         if (p->key == e->xkey.keycode && p->state == mods) {
248             /* if we hit a key binding, then close any open menus and run it */
249             if (menu_frame_visible)
250                 menu_frame_hide_all();
251
252             if (p->first_child != NULL) { /* part of a chain */
253                 if (chain_timer) g_source_remove(chain_timer);
254                 /* 3 second timeout for chains */
255                 chain_timer =
256                     g_timeout_add_full(G_PRIORITY_DEFAULT,
257                                        3000, chain_timeout, NULL,
258                                        chain_done);
259                 set_curpos(p);
260             } else if (p->chroot)         /* an empty chroot */
261                 set_curpos(p);
262             else {
263                 GSList *it;
264
265                 for (it = p->actions; it; it = g_slist_next(it))
266                     if (actions_act_is_interactive(it->data)) break;
267                 if (it == NULL) /* reset if the actions are not interactive */
268                     keyboard_reset_chains(0);
269
270                 actions_run_acts(p->actions, OB_USER_ACTION_KEYBOARD_KEY,
271                                  e->xkey.state, e->xkey.x_root, e->xkey.y_root,
272                                  0, OB_FRAME_CONTEXT_NONE, client);
273             }
274             break;
275             used = TRUE;
276         }
277         p = p->next_sibling;
278     }
279     return used;
280 }
281
282 static void node_rebind(KeyBindingTree *node)
283 {
284     if (node->first_child) {
285         /* find leaf nodes */
286         node_rebind(node->first_child);
287
288         /* for internal nodes, add them to the tree if they
289            are a chroot, but do this after adding their
290            children */
291         if (node->chroot)
292             keyboard_chroot(node->keylist);
293     }
294     else {
295         /* for leaf nodes, rebind each action assigned to it */
296         while (node->actions) {
297             /* add each action, and remove them from the original tree so
298                they don't get free'd on us */
299             keyboard_bind(node->keylist, node->actions->data);
300             node->actions = g_slist_delete_link(node->actions, node->actions);
301         }
302
303         if (node->chroot)
304             keyboard_chroot(node->keylist);
305     }
306
307     /* go through each sibling */
308     if (node->next_sibling) node_rebind(node->next_sibling);
309 }
310
311 void keyboard_rebind(void)
312 {
313     KeyBindingTree *old;
314
315     old = keyboard_firstnode;
316     keyboard_firstnode = NULL;
317     node_rebind(old);
318
319     tree_destroy(old);
320     set_curpos(NULL);
321     grab_keys(TRUE);
322 }
323
324 void keyboard_startup(gboolean reconfig)
325 {
326     grab_keys(TRUE);
327     popup = popup_new();
328     popup_set_text_align(popup, RR_JUSTIFY_CENTER);
329 }
330
331 void keyboard_shutdown(gboolean reconfig)
332 {
333     if (chain_timer) g_source_remove(chain_timer);
334
335     keyboard_unbind_all();
336     set_curpos(NULL);
337
338     popup_free(popup);
339     popup = NULL;
340 }