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_FRAME:
  69     case OB_FRAME_CONTEXT_MOVE_RESIZE:
  70         break;
  71     case OB_FRAME_CONTEXT_BOTTOM:
  72     case OB_FRAME_CONTEXT_BLCORNER:
  73     case OB_FRAME_CONTEXT_BRCORNER:
  74         x = OB_FRAME_CONTEXT_BOTTOM;
  75         break;
  76     case OB_FRAME_CONTEXT_TLCORNER:
  77     case OB_FRAME_CONTEXT_TRCORNER:
  78     case OB_FRAME_CONTEXT_TOP:
  79     case OB_FRAME_CONTEXT_MAXIMIZE:
  80     case OB_FRAME_CONTEXT_ALLDESKTOPS:
  81     case OB_FRAME_CONTEXT_SHADE:
  82     case OB_FRAME_CONTEXT_ICONIFY:
  83     case OB_FRAME_CONTEXT_ICON:
  84     case OB_FRAME_CONTEXT_CLOSE:
  85         x = OB_FRAME_CONTEXT_TITLEBAR;
  86         break;
  87     case OB_FRAME_NUM_CONTEXTS:
  88         g_assert_not_reached();
  89     }
  90
  91     return x;
  92 }
  93
  94 void mouse_grab_for_client(ObClient *client, gboolean grab)
  95 {
  96     gint i;
  97     GSList *it;
  98
  99     for (i = 0; i < OB_FRAME_NUM_CONTEXTS; ++i)
 100         for (it = bound_contexts[i]; it; it = g_slist_next(it)) {
 101             /* grab/ungrab the button */
 102             ObMouseBinding *b = it->data;
 103             Window win;
 104             gint mode;
 105             guint mask;
 106
 107             if (FRAME_CONTEXT(i, client)) {
 108                 win = client->frame->window;
 109                 mode = GrabModeAsync;
 110                 mask = ButtonPressMask | ButtonMotionMask | ButtonReleaseMask;
 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, pwx = -1, pwy = -1;
 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->xbutton.window,
 192                                 e->xbutton.x, e->xbutton.y);
 193         context = mouse_button_frame_context(context, e->xbutton.button);
 194
 195         px = e->xbutton.x_root;
 196         py = e->xbutton.y_root;
 197         if (!button) pwx = e->xbutton.x;
 198         if (!button) pwy = e->xbutton.y;
 199         button = e->xbutton.button;
 200         state = e->xbutton.state;
 201
 202         fire_binding(OB_MOUSE_ACTION_PRESS, context,
 203                      client, e->xbutton.state,
 204                      e->xbutton.button,
 205                      e->xbutton.x_root, e->xbutton.y_root,
 206                      e->xbutton.time);
 207
 208         /* if the bindings grab the pointer, there won't be a ButtonRelease
 209            event for us */
 210         if (grab_on_pointer())
 211             button = 0;
 212
 213         if (CLIENT_CONTEXT(context, client)) {
 214             /* Replay the event, so it goes to the client*/
 215             XAllowEvents(ob_display, ReplayPointer, event_curtime);
 216             /* Fall through to the release case! */
 217         } else
 218             break;
 219
 220     case ButtonRelease:
 221         /* use where the press occured in the window */
 222         context = frame_context(client, e->xbutton.window, pwx, pwy);
 223         context = mouse_button_frame_context(context, e->xbutton.button);
 224
 225         if (e->xbutton.button == button)
 226             pwx = pwy = -1;
 227
 228         if (e->xbutton.button == button) {
 229             /* clicks are only valid if its released over the window */
 230             gint junk1, junk2;
 231             Window wjunk;
 232             guint ujunk, b, w, h;
 233             /* this can cause errors to occur when the window closes */
 234             xerror_set_ignore(TRUE);
 235             junk1 = XGetGeometry(ob_display, e->xbutton.window,
 236                                  &wjunk, &junk1, &junk2, &w, &h, &b, &ujunk);
 237             xerror_set_ignore(FALSE);
 238             if (junk1) {
 239                 if (e->xbutton.x >= (signed)-b &&
 240                     e->xbutton.y >= (signed)-b &&
 241                     e->xbutton.x < (signed)(w+b) &&
 242                     e->xbutton.y < (signed)(h+b)) {
 243                     click = TRUE;
 244                     /* double clicks happen if there were 2 in a row! */
 245                     if (lbutton == button &&
 246                         lwindow == e->xbutton.window &&
 247                         e->xbutton.time - config_mouse_dclicktime <=
 248                         ltime) {
 249                         dclick = TRUE;
 250                         lbutton = 0;
 251                     } else {
 252                         lbutton = button;
 253                         lwindow = e->xbutton.window;
 254                     }
 255                 } else {
 256                     lbutton = 0;
 257                     lwindow = None;
 258                 }
 259             }
 260
 261             button = 0;
 262             state = 0;
 263             ltime = e->xbutton.time;
 264         }
 265         fire_binding(OB_MOUSE_ACTION_RELEASE, context,
 266                      client, e->xbutton.state,
 267                      e->xbutton.button,
 268                      e->xbutton.x_root,
 269                      e->xbutton.y_root,
 270                      e->xbutton.time);
 271         if (click)
 272             fire_binding(OB_MOUSE_ACTION_CLICK, context,
 273                          client, e->xbutton.state,
 274                          e->xbutton.button,
 275                          e->xbutton.x_root,
 276                          e->xbutton.y_root,
 277                          e->xbutton.time);
 278         if (dclick)
 279             fire_binding(OB_MOUSE_ACTION_DOUBLE_CLICK, context,
 280                          client, e->xbutton.state,
 281                          e->xbutton.button,
 282                          e->xbutton.x_root,
 283                          e->xbutton.y_root,
 284                          e->xbutton.time);
 285         break;
 286
 287     case MotionNotify:
 288         if (button) {
 289             context = frame_context(client, e->xmotion.window, pwx, pwy);
 290             context = mouse_button_frame_context(context, button);
 291
 292             if (ABS(e->xmotion.x_root - px) >= config_mouse_threshold ||
 293                 ABS(e->xmotion.y_root - py) >= config_mouse_threshold) {
 294
 295                 /* You can't drag on buttons */
 296                 if (context == OB_FRAME_CONTEXT_MAXIMIZE ||
 297                     context == OB_FRAME_CONTEXT_ALLDESKTOPS ||
 298                     context == OB_FRAME_CONTEXT_SHADE ||
 299                     context == OB_FRAME_CONTEXT_ICONIFY ||
 300                     context == OB_FRAME_CONTEXT_ICON ||
 301                     context == OB_FRAME_CONTEXT_CLOSE)
 302                     break;
 303
 304                 fire_binding(OB_MOUSE_ACTION_MOTION, context,
 305                              client, state, button, px, py, e->xmotion.time);
 306                 button = 0;
 307                 state = 0;
 308             }
 309         }
 310         break;
 311
 312     default:
 313         g_assert_not_reached();
 314     }
 315 }
 316
 317 gboolean mouse_bind(const gchar *buttonstr, const gchar *contextstr,
 318                     ObMouseAction mact, ObAction *action)
 319 {
 320     guint state, button;
 321     ObFrameContext context;
 322     ObMouseBinding *b;
 323     GSList *it;
 324
 325     if (!translate_button(buttonstr, &state, &button)) {
 326         g_message(_("Invalid button '%s' in mouse binding"), buttonstr);
 327         return FALSE;
 328     }
 329
 330     context = frame_context_from_string(contextstr);
 331     if (!context) {
 332         g_message(_("Invalid context '%s' in mouse binding"), contextstr);
 333         return FALSE;
 334     }
 335
 336     for (it = bound_contexts[context]; it; it = g_slist_next(it)) {
 337         b = it->data;
 338         if (b->state == state && b->button == button) {
 339             b->actions[mact] = g_slist_append(b->actions[mact], action);
 340             return TRUE;
 341         }
 342     }
 343
 344     /* when there are no modifiers in the binding, then the action cannot
 345        be interactive */
 346     if (!state && action->data.any.interactive) {
 347         action->data.any.interactive = FALSE;
 348         action->data.inter.final = TRUE;
 349     }
 350
 351     /* add the binding */
 352     b = g_new0(ObMouseBinding, 1);
 353     b->state = state;
 354     b->button = button;
 355     b->actions[mact] = g_slist_append(NULL, action);
 356     bound_contexts[context] = g_slist_append(bound_contexts[context], b);
 357
 358     return TRUE;
 359 }
 360
 361 void mouse_startup(gboolean reconfig)
 362 {
 363     grab_all_clients(TRUE);
 364 }
 365
 366 void mouse_shutdown(gboolean reconfig)
 367 {
 368     grab_all_clients(FALSE);
 369     mouse_unbind_all();
 370 }