add interactive action functions. some other changes to stuff that wasnt going to...
[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 "mainloop.h"
21 #include "focus.h"
22 #include "screen.h"
23 #include "frame.h"
24 #include "openbox.h"
25 #include "event.h"
26 #include "grab.h"
27 #include "client.h"
28 #include "actions.h"
29 #include "prop.h"
30 #include "menuframe.h"
31 #include "config.h"
32 #include "keytree.h"
33 #include "keyboard.h"
34 #include "translate.h"
35 #include "moveresize.h"
36 #include "popup.h"
37 #include "gettext.h"
38
39 #include <glib.h>
40
41 typedef struct {
42     gboolean active;
43     guint state;
44     ObClient *client;
45     ObActionsAct *action;
46 } ObInteractiveState;
47
48 KeyBindingTree *keyboard_firstnode = NULL;
49 static ObPopup *popup = NULL;
50 static ObInteractiveState istate;
51 static KeyBindingTree *curpos;
52
53 static void grab_keys(gboolean grab)
54 {
55     KeyBindingTree *p;
56
57     ungrab_all_keys(RootWindow(ob_display, ob_screen));
58
59     if (grab) {
60         p = curpos ? curpos->first_child : keyboard_firstnode;
61         while (p) {
62             grab_key(p->key, p->state, RootWindow(ob_display, ob_screen),
63                      GrabModeAsync);
64             p = p->next_sibling;
65         }
66         if (curpos)
67             grab_key(config_keyboard_reset_keycode,
68                      config_keyboard_reset_state,
69                      RootWindow(ob_display, ob_screen), GrabModeAsync);
70     }
71 }
72
73 static gboolean chain_timeout(gpointer data)
74 {
75     keyboard_reset_chains(0);
76     return FALSE; /* don't repeat */
77 }
78
79 static void set_curpos(KeyBindingTree *newpos)
80 {
81     if (curpos == newpos) return;
82
83     grab_keys(FALSE);
84     curpos = newpos;
85     grab_keys(TRUE);
86
87     if (curpos != NULL) {
88         gchar *text = NULL;
89         GList *it;
90         Rect *a;
91
92         for (it = curpos->keylist; it; it = g_list_next(it)) {
93             gchar *oldtext = text;
94             if (text == NULL)
95                 text = g_strdup(it->data);
96             else
97                 text = g_strconcat(text, " - ", it->data, NULL);
98             g_free(oldtext);
99         }
100
101         a = screen_physical_area_active();
102         popup_position(popup, NorthWestGravity, a->x + 10, a->y + 10);
103         /* 1 second delay for the popup to show */
104         popup_delay_show(popup, G_USEC_PER_SEC, text);
105         g_free(text);
106         g_free(a);
107     } else {
108         popup_hide(popup);
109     }
110 }
111
112 void keyboard_reset_chains(gint break_chroots)
113 {
114     KeyBindingTree *p;
115
116     for (p = curpos; p; p = p->parent) {
117         if (p->chroot) {
118             if (break_chroots == 0) break; /* stop here */
119             if (break_chroots > 0)
120                 --break_chroots;
121         }
122     }
123     set_curpos(p);
124 }
125
126 void keyboard_unbind_all()
127 {
128     tree_destroy(keyboard_firstnode);
129     keyboard_firstnode = NULL;
130 }
131
132 void keyboard_chroot(GList *keylist)
133 {
134     /* try do it in the existing tree. if we can't that means it is an empty
135        chroot binding. so add it to the tree then. */
136     if (!tree_chroot(keyboard_firstnode, keylist)) {
137         KeyBindingTree *tree;
138         if (!(tree = tree_build(keylist)))
139             return;
140         tree_chroot(tree, keylist);
141         tree_assimilate(tree);
142     }
143 }
144
145 gboolean keyboard_bind(GList *keylist, ObActionsAct *action)
146 {
147     KeyBindingTree *tree, *t;
148     gboolean conflict;
149
150     g_assert(keylist != NULL);
151     g_assert(action != NULL);
152
153     if (!(tree = tree_build(keylist)))
154         return FALSE;
155
156     if ((t = tree_find(tree, &conflict)) != NULL) {
157         /* already bound to something, use the existing tree */
158         tree_destroy(tree);
159         tree = NULL;
160     } else
161         t = tree;
162
163     if (conflict) {
164         g_message(_("Conflict with key binding in config file"));
165         tree_destroy(tree);
166         return FALSE;
167     }
168
169     /* find the bottom node */
170     for (; t->first_child; t = t->first_child);
171
172     /* set the action */
173     t->actions = g_slist_append(t->actions, action);
174     /* assimilate this built tree into the main tree. assimilation
175        destroys/uses the tree */
176     if (tree) tree_assimilate(tree);
177
178     return TRUE;
179 }
180
181 static void keyboard_interactive_end(guint state, gboolean cancel, Time time,
182                                      gboolean ungrab)
183 {
184 #if 0
185     GSList *alist;
186
187     g_assert(istate.active);
188
189     /* ungrab first so they won't be NotifyWhileGrabbed */
190     if (ungrab)
191         ungrab_keyboard();
192
193     /* set this before running the actions so they know the keyboard is not
194        grabbed */
195     istate.active = FALSE;
196
197     alist = g_slist_append(NULL, istate.action);
198     action_run_interactive(alist, istate.client, state, time, cancel, TRUE);
199     g_slist_free(alist);
200
201     keyboard_reset_chains(0);
202 #endif
203 }
204
205 static void keyboard_interactive_end_client(ObClient *client, gpointer data)
206 {
207     if (istate.active && istate.client == client)
208         istate.client = NULL;
209 }
210
211
212 void keyboard_interactive_cancel()
213 {
214     keyboard_interactive_end(0, TRUE, event_curtime, TRUE);
215 }
216
217 gboolean keyboard_interactive_grab(guint state, ObClient *client,
218                                    ObActionsAct *action)
219 {
220 #if 0
221     g_assert(action->data.any.interactive);
222
223     if (!istate.active) {
224         if (!grab_keyboard())
225             return FALSE;
226     } else if (action->func != istate.action->func) {
227         keyboard_interactive_end(state, TRUE, action->data.any.time, FALSE);
228     }
229
230     istate.active = TRUE;
231     istate.state = state;
232     istate.client = client;
233     istate.action = action;
234
235 #endif
236     return TRUE;
237 }
238
239 gboolean keyboard_process_interactive_grab(const XEvent *e, ObClient **client)
240 {
241     gboolean handled = FALSE;
242     gboolean done = FALSE;
243     gboolean cancel = FALSE;
244
245     if (istate.active) {
246         if ((e->type == KeyRelease && !(istate.state & e->xkey.state))) {
247             done = TRUE;
248             handled = TRUE;
249         } else if (e->type == KeyPress) {
250             /*if (e->xkey.keycode == ob_keycode(OB_KEY_RETURN))
251               done = TRUE;
252               else */if (e->xkey.keycode == ob_keycode(OB_KEY_ESCAPE)) {
253                   cancel = done = TRUE;
254                   handled = TRUE;
255               }
256         } else if (e->type == ButtonPress) {
257             cancel = TRUE;
258             done = TRUE;
259             handled = FALSE;
260         }
261
262         if (done)
263             keyboard_interactive_end(e->xkey.state, cancel, e->xkey.time,TRUE);
264
265         if (handled)
266             *client = istate.client;
267     }
268
269     return handled;
270 }
271
272 void keyboard_event(ObClient *client, const XEvent *e)
273 {
274     KeyBindingTree *p;
275
276     if (e->type == KeyRelease) {
277         grab_key_passive_count(-1);
278         return;
279     }
280
281     g_assert(e->type == KeyPress);
282     grab_key_passive_count(1);
283
284     if (e->xkey.keycode == config_keyboard_reset_keycode &&
285         e->xkey.state == config_keyboard_reset_state)
286     {
287         ob_main_loop_timeout_remove(ob_main_loop, chain_timeout);
288         keyboard_reset_chains(-1);
289         return;
290     }
291
292     if (curpos == NULL)
293         p = keyboard_firstnode;
294     else
295         p = curpos->first_child;
296     while (p) {
297         if (p->key == e->xkey.keycode &&
298             p->state == e->xkey.state)
299         {
300             /* if we hit a key binding, then close any open menus and run it */
301             if (menu_frame_visible)
302                 menu_frame_hide_all();
303
304             if (p->first_child != NULL) { /* part of a chain */
305                 ob_main_loop_timeout_remove(ob_main_loop, chain_timeout);
306                 /* 3 second timeout for chains */
307                 ob_main_loop_timeout_add(ob_main_loop, 3 * G_USEC_PER_SEC,
308                                          chain_timeout, NULL,
309                                          g_direct_equal, NULL);
310                 set_curpos(p);
311             } else if (p->chroot)         /* an empty chroot */
312                 set_curpos(p);
313             else {
314                 GSList *it;
315                 gboolean inter = FALSE;
316
317                 for (it = p->actions; it && !inter; it = g_slist_next(it))
318                     if (((ObActionsAct*)it->data)->data.any.interactive)
319                         inter = TRUE;
320                 if (!inter) /* don't reset if the action is interactive */
321                     keyboard_reset_chains(0);
322
323                 action_run_key(p->actions, client, e->xkey.state,
324                                e->xkey.x_root, e->xkey.y_root,
325                                e->xkey.time);
326             }
327             break;
328         }
329         p = p->next_sibling;
330     }
331 }
332
333 gboolean keyboard_interactively_grabbed()
334 {
335     return istate.active;
336 }
337
338 void keyboard_startup(gboolean reconfig)
339 {
340     grab_keys(TRUE);
341     popup = popup_new(FALSE);
342     popup_set_text_align(popup, RR_JUSTIFY_CENTER);
343
344     if (!reconfig)
345         client_add_destroy_notify(keyboard_interactive_end_client, NULL);
346 }
347
348 void keyboard_shutdown(gboolean reconfig)
349 {
350     if (!reconfig)
351         client_remove_destroy_notify(keyboard_interactive_end_client);
352
353     if (istate.active)
354         keyboard_interactive_cancel();
355
356     ob_main_loop_timeout_remove(ob_main_loop, chain_timeout);
357
358     keyboard_unbind_all();
359     set_curpos(NULL);
360
361     popup_free(popup);
362     popup = NULL;
363 }
364