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             } else if (CLIENT_CONTEXT(i, client)) {
 111                 win = client->frame->plate;
 112                 mode = GrabModeSync; /* this is handled in event */
 113                 mask = ButtonPressMask; /* can't catch more than this with Sync
 114                                            mode the release event is
 115                                            manufactured in event() */
 116             } else continue;
 117
 118             if (grab)
 119                 grab_button_full(b->button, b->state, win, mask, mode,
 120                                  OB_CURSOR_NONE);
 121             else
 122                 ungrab_button(b->button, b->state, win);
 123         }
 124 }
 125
 126 static void grab_all_clients(gboolean grab)
 127 {
 128     GList *it;
 129
 130     for (it = client_list; it; it = g_list_next(it))
 131         mouse_grab_for_client(it->data, grab);
 132 }
 133
 134 void mouse_unbind_all()
 135 {
 136     gint i;
 137     GSList *it;
 138
 139     for(i = 0; i < OB_FRAME_NUM_CONTEXTS; ++i) {
 140         for (it = bound_contexts[i]; it; it = g_slist_next(it)) {
 141             ObMouseBinding *b = it->data;
 142             gint j;
 143
 144             for (j = 0; j < OB_NUM_MOUSE_ACTIONS; ++j) {
 145                 GSList *it;
 146
 147                 for (it = b->actions[j]; it; it = g_slist_next(it))
 148                     action_unref(it->data);
 149                 g_slist_free(b->actions[j]);
 150             }
 151             g_free(b);
 152         }
 153         g_slist_free(bound_contexts[i]);
 154         bound_contexts[i] = NULL;
 155     }
 156 }
 157
 158 static gboolean fire_binding(ObMouseAction a, ObFrameContext context,
 159                              ObClient *c, guint state,
 160                              guint button, gint x, gint y, Time time)
 161 {
 162     GSList *it;
 163     ObMouseBinding *b;
 164
 165     for (it = bound_contexts[context]; it; it = g_slist_next(it)) {
 166         b = it->data;
 167         if (b->state == state && b->button == button)
 168             break;
 169     }
 170     /* if not bound, then nothing to do! */
 171     if (it == NULL) return FALSE;
 172
 173     action_run_mouse(b->actions[a], c, context, state, button, x, y, time);
 174     return TRUE;
 175 }
 176
 177 void mouse_event(ObClient *client, XEvent *e)
 178 {
 179     static Time ltime;
 180     static guint button = 0, state = 0, lbutton = 0;
 181     static Window lwindow = None;
 182     static gint px, py, pwx = -1, pwy = -1;
 183
 184     ObFrameContext context;
 185     gboolean click = FALSE;
 186     gboolean dclick = FALSE;
 187
 188     switch (e->type) {
 189     case ButtonPress:
 190         context = frame_context(client, e->xbutton.window,
 191                                 e->xbutton.x, e->xbutton.y);
 192         context = mouse_button_frame_context(context, e->xbutton.button);
 193
 194         px = e->xbutton.x_root;
 195         py = e->xbutton.y_root;
 196         if (!button) pwx = e->xbutton.x;
 197         if (!button) pwy = e->xbutton.y;
 198         button = e->xbutton.button;
 199         state = e->xbutton.state;
 200
 201         fire_binding(OB_MOUSE_ACTION_PRESS, context,
 202                      client, e->xbutton.state,
 203                      e->xbutton.button,
 204                      e->xbutton.x_root, e->xbutton.y_root,
 205                      e->xbutton.time);
 206
 207         if (CLIENT_CONTEXT(context, client)) {
 208             /* Replay the event, so it goes to the client*/
 209             XAllowEvents(ob_display, ReplayPointer, event_curtime);
 210             /* Fall through to the release case! */
 211         } else
 212             break;
 213
 214     case ButtonRelease:
 215         /* use where the press occured in the window */
 216         context = frame_context(client, e->xbutton.window, pwx, pwy);
 217         context = mouse_button_frame_context(context, e->xbutton.button);
 218
 219         if (e->xbutton.button == button)
 220             pwx = pwy = -1;
 221
 222         if (e->xbutton.button == button) {
 223             /* clicks are only valid if its released over the window */
 224             gint junk1, junk2;
 225             Window wjunk;
 226             guint ujunk, b, w, h;
 227             /* this can cause errors to occur when the window closes */
 228             xerror_set_ignore(TRUE);
 229             junk1 = XGetGeometry(ob_display, e->xbutton.window,
 230                                  &wjunk, &junk1, &junk2, &w, &h, &b, &ujunk);
 231             xerror_set_ignore(FALSE);
 232             if (junk1) {
 233                 if (e->xbutton.x >= (signed)-b &&
 234                     e->xbutton.y >= (signed)-b &&
 235                     e->xbutton.x < (signed)(w+b) &&
 236                     e->xbutton.y < (signed)(h+b)) {
 237                     click = TRUE;
 238                     /* double clicks happen if there were 2 in a row! */
 239                     if (lbutton == button &&
 240                         lwindow == e->xbutton.window &&
 241                         e->xbutton.time - config_mouse_dclicktime <=
 242                         ltime) {
 243                         dclick = TRUE;
 244                         lbutton = 0;
 245                     } else {
 246                         lbutton = button;
 247                         lwindow = e->xbutton.window;
 248                     }
 249                 } else {
 250                     lbutton = 0;
 251                     lwindow = None;
 252                 }
 253             }
 254
 255             button = 0;
 256             state = 0;
 257             ltime = e->xbutton.time;
 258         }
 259         fire_binding(OB_MOUSE_ACTION_RELEASE, 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 (click)
 266             fire_binding(OB_MOUSE_ACTION_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         if (dclick)
 273             fire_binding(OB_MOUSE_ACTION_DOUBLE_CLICK, context,
 274                          client, e->xbutton.state,
 275                          e->xbutton.button,
 276                          e->xbutton.x_root,
 277                          e->xbutton.y_root,
 278                          e->xbutton.time);
 279         break;
 280
 281     case MotionNotify:
 282         if (button) {
 283             context = frame_context(client, e->xmotion.window, pwx, pwy);
 284             context = mouse_button_frame_context(context, button);
 285
 286             if (ABS(e->xmotion.x_root - px) >= config_mouse_threshold ||
 287                 ABS(e->xmotion.y_root - py) >= config_mouse_threshold) {
 288
 289                 /* You can't drag on buttons */
 290                 if (context == OB_FRAME_CONTEXT_MAXIMIZE ||
 291                     context == OB_FRAME_CONTEXT_ALLDESKTOPS ||
 292                     context == OB_FRAME_CONTEXT_SHADE ||
 293                     context == OB_FRAME_CONTEXT_ICONIFY ||
 294                     context == OB_FRAME_CONTEXT_ICON ||
 295                     context == OB_FRAME_CONTEXT_CLOSE)
 296                     break;
 297
 298                 fire_binding(OB_MOUSE_ACTION_MOTION, context,
 299                              client, state, button, px, py, e->xmotion.time);
 300                 button = 0;
 301                 state = 0;
 302             }
 303         }
 304         break;
 305
 306     default:
 307         g_assert_not_reached();
 308     }
 309 }
 310
 311 gboolean mouse_bind(const gchar *buttonstr, const gchar *contextstr,
 312                     ObMouseAction mact, ObAction *action)
 313 {
 314     guint state, button;
 315     ObFrameContext context;
 316     ObMouseBinding *b;
 317     GSList *it;
 318
 319     if (!translate_button(buttonstr, &state, &button)) {
 320         g_message(_("Invalid button '%s' in mouse binding"), buttonstr);
 321         return FALSE;
 322     }
 323
 324     context = frame_context_from_string(contextstr);
 325     if (!context) {
 326         g_message(_("Invalid context '%s' in mouse binding"), contextstr);
 327         return FALSE;
 328     }
 329
 330     for (it = bound_contexts[context]; it; it = g_slist_next(it)) {
 331         b = it->data;
 332         if (b->state == state && b->button == button) {
 333             b->actions[mact] = g_slist_append(b->actions[mact], action);
 334             return TRUE;
 335         }
 336     }
 337
 338     /* when there are no modifiers in the binding, then the action cannot
 339        be interactive */
 340     if (!state && action->data.any.interactive) {
 341         action->data.any.interactive = FALSE;
 342         action->data.inter.final = TRUE;
 343     }
 344
 345     /* add the binding */
 346     b = g_new0(ObMouseBinding, 1);
 347     b->state = state;
 348     b->button = button;
 349     b->actions[mact] = g_slist_append(NULL, action);
 350     bound_contexts[context] = g_slist_append(bound_contexts[context], b);
 351
 352     return TRUE;
 353 }
 354
 355 void mouse_startup(gboolean reconfig)
 356 {
 357     grab_all_clients(TRUE);
 358 }
 359
 360 void mouse_shutdown(gboolean reconfig)
 361 {
 362     grab_all_clients(FALSE);
 363     mouse_unbind_all();
 364 }