add the PointerMotionHintMask everywhere, we dont need every mouse event
[dana/openbox.git] / openbox / mouse.c
1 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
2
3    mouse.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 "openbox.h"
21 #include "config.h"
22 #include "xerror.h"
23 #include "action.h"
24 #include "event.h"
25 #include "client.h"
26 #include "prop.h"
27 #include "grab.h"
28 #include "frame.h"
29 #include "translate.h"
30 #include "mouse.h"
31 #include "gettext.h"
32
33 #include <glib.h>
34
35 typedef struct {
36     guint state;
37     guint button;
38     GSList *actions[OB_NUM_MOUSE_ACTIONS]; /* lists of Action pointers */
39 } ObMouseBinding;
40
41 #define FRAME_CONTEXT(co, cl) ((cl && cl->type != OB_CLIENT_TYPE_DESKTOP) ? \
42                                co == OB_FRAME_CONTEXT_FRAME : FALSE)
43 #define CLIENT_CONTEXT(co, cl) ((cl && cl->type == OB_CLIENT_TYPE_DESKTOP) ? \
44                                 co == OB_FRAME_CONTEXT_DESKTOP : \
45                                 co == OB_FRAME_CONTEXT_CLIENT)
46
47 /* Array of GSList*s of ObMouseBinding*s. */
48 static GSList *bound_contexts[OB_FRAME_NUM_CONTEXTS];
49
50 ObFrameContext mouse_button_frame_context(ObFrameContext context,
51                                           guint button)
52 {
53     GSList *it;
54     ObFrameContext x = context;
55
56     for (it = bound_contexts[context]; it; it = g_slist_next(it)) {
57         ObMouseBinding *b = it->data;
58
59         if (b->button == button)
60             return context;
61     }
62
63     switch (context) {
64     case OB_FRAME_CONTEXT_NONE:
65     case OB_FRAME_CONTEXT_DESKTOP:
66     case OB_FRAME_CONTEXT_CLIENT:
67     case OB_FRAME_CONTEXT_TITLEBAR:
68     case OB_FRAME_CONTEXT_HANDLE:
69     case OB_FRAME_CONTEXT_FRAME:
70     case OB_FRAME_CONTEXT_MOVE_RESIZE:
71         break;
72     case OB_FRAME_CONTEXT_BLCORNER:
73     case OB_FRAME_CONTEXT_BRCORNER:
74         x = OB_FRAME_CONTEXT_HANDLE;
75         break;
76     case OB_FRAME_CONTEXT_TLCORNER:
77     case OB_FRAME_CONTEXT_TRCORNER:
78     case OB_FRAME_CONTEXT_MAXIMIZE:
79     case OB_FRAME_CONTEXT_ALLDESKTOPS:
80     case OB_FRAME_CONTEXT_SHADE:
81     case OB_FRAME_CONTEXT_ICONIFY:
82     case OB_FRAME_CONTEXT_ICON:
83     case OB_FRAME_CONTEXT_CLOSE:
84         x = OB_FRAME_CONTEXT_TITLEBAR;
85         break;
86     case OB_FRAME_NUM_CONTEXTS:
87         g_assert_not_reached();
88     }
89
90     return x;
91 }
92
93 void mouse_grab_for_client(ObClient *client, gboolean grab)
94 {
95     gint i;
96     GSList *it;
97
98     for (i = 0; i < OB_FRAME_NUM_CONTEXTS; ++i)
99         for (it = bound_contexts[i]; it; it = g_slist_next(it)) {
100             /* grab/ungrab the button */
101             ObMouseBinding *b = it->data;
102             Window win;
103             gint mode;
104             guint mask;
105
106             if (FRAME_CONTEXT(i, client)) {
107                 win = client->frame->window;
108                 mode = GrabModeAsync;
109                 mask = ButtonPressMask | ButtonMotionMask | ButtonReleaseMask |
110                     PointerMotionHintMask;
111             } else if (CLIENT_CONTEXT(i, client)) {
112                 win = client->frame->plate;
113                 mode = GrabModeSync; /* this is handled in event */
114                 mask = ButtonPressMask; /* can't catch more than this with Sync
115                                            mode the release event is
116                                            manufactured in event() */
117             } else continue;
118
119             if (grab)
120                 grab_button_full(b->button, b->state, win, mask, mode,
121                                  OB_CURSOR_NONE);
122             else
123                 ungrab_button(b->button, b->state, win);
124         }
125 }
126
127 static void grab_all_clients(gboolean grab)
128 {
129     GList *it;
130
131     for (it = client_list; it; it = g_list_next(it))
132         mouse_grab_for_client(it->data, grab);
133 }
134
135 void mouse_unbind_all()
136 {
137     gint i;
138     GSList *it;
139     
140     for(i = 0; i < OB_FRAME_NUM_CONTEXTS; ++i) {
141         for (it = bound_contexts[i]; it; it = g_slist_next(it)) {
142             ObMouseBinding *b = it->data;
143             gint j;
144
145             for (j = 0; j < OB_NUM_MOUSE_ACTIONS; ++j) {
146                 GSList *it;
147
148                 for (it = b->actions[j]; it; it = g_slist_next(it))
149                     action_unref(it->data);
150                 g_slist_free(b->actions[j]);
151             }
152             g_free(b);
153         }
154         g_slist_free(bound_contexts[i]);
155         bound_contexts[i] = NULL;
156     }
157 }
158
159 static gboolean fire_binding(ObMouseAction a, ObFrameContext context,
160                              ObClient *c, guint state,
161                              guint button, gint x, gint y, Time time)
162 {
163     GSList *it;
164     ObMouseBinding *b;
165
166     for (it = bound_contexts[context]; it; it = g_slist_next(it)) {
167         b = it->data;
168         if (b->state == state && b->button == button)
169             break;
170     }
171     /* if not bound, then nothing to do! */
172     if (it == NULL) return FALSE;
173
174     action_run_mouse(b->actions[a], c, context, state, button, x, y, time);
175     return TRUE;
176 }
177
178 void mouse_event(ObClient *client, XEvent *e)
179 {
180     static Time ltime;
181     static guint button = 0, state = 0, lbutton = 0;
182     static Window lwindow = None;
183     static gint px, py;
184
185     ObFrameContext context;
186     gboolean click = FALSE;
187     gboolean dclick = FALSE;
188
189     switch (e->type) {
190     case ButtonPress:
191         context = frame_context(client, e->xany.window);
192         context = mouse_button_frame_context(context, e->xbutton.button);
193
194         px = e->xbutton.x_root;
195         py = e->xbutton.y_root;
196         button = e->xbutton.button;
197         state = e->xbutton.state;
198
199         fire_binding(OB_MOUSE_ACTION_PRESS, context,
200                      client, e->xbutton.state,
201                      e->xbutton.button,
202                      e->xbutton.x_root, e->xbutton.y_root,
203                      e->xbutton.time);
204
205         if (CLIENT_CONTEXT(context, client)) {
206             /* Replay the event, so it goes to the client*/
207             XAllowEvents(ob_display, ReplayPointer, event_curtime);
208             /* Fall through to the release case! */
209         } else
210             break;
211
212     case ButtonRelease:
213         context = frame_context(client, e->xany.window);
214         context = mouse_button_frame_context(context, e->xbutton.button);
215
216         if (e->xbutton.button == button) {
217             /* clicks are only valid if its released over the window */
218             gint junk1, junk2;
219             Window wjunk;
220             guint ujunk, b, w, h;
221             /* this can cause errors to occur when the window closes */
222             xerror_set_ignore(TRUE);
223             junk1 = XGetGeometry(ob_display, e->xbutton.window,
224                                  &wjunk, &junk1, &junk2, &w, &h, &b, &ujunk);
225             xerror_set_ignore(FALSE);
226             if (junk1) {
227                 if (e->xbutton.x >= (signed)-b &&
228                     e->xbutton.y >= (signed)-b &&
229                     e->xbutton.x < (signed)(w+b) &&
230                     e->xbutton.y < (signed)(h+b)) {
231                     click = TRUE;
232                     /* double clicks happen if there were 2 in a row! */
233                     if (lbutton == button &&
234                         lwindow == e->xbutton.window &&
235                         e->xbutton.time - config_mouse_dclicktime <=
236                         ltime) {
237                         dclick = TRUE;
238                         lbutton = 0;
239                     } else {
240                         lbutton = button;
241                         lwindow = e->xbutton.window;
242                     }
243                 } else {
244                     lbutton = 0;
245                     lwindow = None;
246                 }
247             }
248
249             button = 0;
250             state = 0;
251             ltime = e->xbutton.time;
252         }
253         fire_binding(OB_MOUSE_ACTION_RELEASE, context,
254                      client, e->xbutton.state,
255                      e->xbutton.button,
256                      e->xbutton.x_root, e->xbutton.y_root,
257                      e->xbutton.time);
258         if (click)
259             fire_binding(OB_MOUSE_ACTION_CLICK, context,
260                          client, e->xbutton.state,
261                          e->xbutton.button,
262                          e->xbutton.x_root,
263                          e->xbutton.y_root,
264                          e->xbutton.time);
265         if (dclick)
266             fire_binding(OB_MOUSE_ACTION_DOUBLE_CLICK, context,
267                          client, e->xbutton.state,
268                          e->xbutton.button,
269                          e->xbutton.x_root,
270                          e->xbutton.y_root,
271                          e->xbutton.time);
272         break;
273
274     case MotionNotify:
275         if (button) {
276             context = frame_context(client, e->xany.window);
277             context = mouse_button_frame_context(context, button);
278
279             if (ABS(e->xmotion.x_root - px) >=
280                 config_mouse_threshold ||
281                 ABS(e->xmotion.y_root - py) >=
282                 config_mouse_threshold) {
283
284                 /* You can't drag on buttons */
285                 if (context == OB_FRAME_CONTEXT_MAXIMIZE ||
286                     context == OB_FRAME_CONTEXT_ALLDESKTOPS ||
287                     context == OB_FRAME_CONTEXT_SHADE ||
288                     context == OB_FRAME_CONTEXT_ICONIFY ||
289                     context == OB_FRAME_CONTEXT_ICON ||
290                     context == OB_FRAME_CONTEXT_CLOSE)
291                     break;
292
293                 fire_binding(OB_MOUSE_ACTION_MOTION, context,
294                              client, state, button, px, py, e->xmotion.time);
295                 button = 0;
296                 state = 0;
297             }
298         }
299         break;
300
301     default:
302         g_assert_not_reached();
303     }
304 }
305
306 gboolean mouse_bind(const gchar *buttonstr, const gchar *contextstr,
307                     ObMouseAction mact, ObAction *action)
308 {
309     guint state, button;
310     ObFrameContext context;
311     ObMouseBinding *b;
312     GSList *it;
313
314     if (!translate_button(buttonstr, &state, &button)) {
315         g_message(_("Invalid button '%s' in pointer binding"), buttonstr);
316         return FALSE;
317     }
318
319     context = frame_context_from_string(contextstr);
320     if (!context) {
321         g_message(_("Invalid context '%s' in pointer binding"), contextstr);
322         return FALSE;
323     }
324
325     for (it = bound_contexts[context]; it; it = g_slist_next(it)) {
326         b = it->data;
327         if (b->state == state && b->button == button) {
328             b->actions[mact] = g_slist_append(b->actions[mact], action);
329             return TRUE;
330         }
331     }
332
333     /* when there are no modifiers in the binding, then the action cannot
334        be interactive */
335     if (!state && action->data.any.interactive) {
336         action->data.any.interactive = FALSE;
337         action->data.inter.final = TRUE;
338     }
339
340     /* add the binding */
341     b = g_new0(ObMouseBinding, 1);
342     b->state = state;
343     b->button = button;
344     b->actions[mact] = g_slist_append(NULL, action);
345     bound_contexts[context] = g_slist_append(bound_contexts[context], b);
346
347     return TRUE;
348 }
349
350 void mouse_startup(gboolean reconfig)
351 {
352     grab_all_clients(TRUE);
353 }
354
355 void mouse_shutdown(gboolean reconfig)
356 {
357     grab_all_clients(FALSE);
358     mouse_unbind_all();
359 }