plugins/mouse/mouse.c

   1 #include "../../kernel/openbox.h"
   2 #include "../../kernel/dispatch.h"
   3 #include "../../kernel/action.h"
   4 #include "../../kernel/client.h"
   5 #include "../../kernel/frame.h"
   6 #include "../../kernel/engine.h"
   7 #include "translate.h"
   8 #include "mouse.h"
   9 #include <glib.h>
  10
  11 /* GData of GSList*s of PointerBinding*s. */
  12 static GData *bound_contexts;
  13
  14 struct foreach_grab_temp {
  15     Client *client;
  16     gboolean grab;
  17 };
  18
  19 static void grab_button(Client *client, guint state, guint button,
  20                         GQuark context, gboolean grab)
  21 {
  22     Window win;
  23     int mode = GrabModeAsync;
  24     unsigned int mask;
  25
  26     if (context == g_quark_try_string("frame")) {
  27         win = client->frame->window;
  28         mask = ButtonPressMask | ButtonMotionMask | ButtonReleaseMask;
  29     } else if (context == g_quark_try_string("client")) {
  30         win = client->frame->plate;
  31         mode = GrabModeSync; /* this is handled in pointer_event */
  32         mask = ButtonPressMask; /* can't catch more than this with Sync mode
  33                                    the release event is manufactured in
  34                                    pointer_fire */
  35     } else return;
  36
  37     if (grab)
  38         /* XXX grab all lock keys */
  39         XGrabButton(ob_display, button, state, win, FALSE, mask, mode,
  40                     GrabModeAsync, None, None);
  41     else
  42         /* XXX ungrab all lock keys */
  43         XUngrabButton(ob_display, button, state, win);
  44 }
  45
  46 static void foreach_grab(GQuark key, gpointer data, gpointer user_data)
  47 {
  48     struct foreach_grab_temp *d = user_data;
  49     GSList *it;
  50     for (it = data; it != NULL; it = it->next) {
  51         MouseBinding *b = it->data;
  52         grab_button(d->client, b->state, b->button, key, d->grab);
  53     }
  54 }
  55
  56 static void grab_for_client(Client *client, gboolean grab)
  57 {
  58     struct foreach_grab_temp bt;
  59     bt.client = client;
  60     bt.grab = grab;
  61     g_datalist_foreach(&bound_contexts, foreach_grab, &bt);
  62 }
  63
  64 static void grab_all_clients(gboolean grab)
  65 {
  66     GSList *it;
  67
  68     for (it = client_list; it != NULL; it = it->next)
  69         grab_for_client(it->data, grab);
  70 }
  71
  72 static void foreach_clear(GQuark key, gpointer data, gpointer user_data)
  73 {
  74     GSList *it;
  75     user_data = user_data;
  76     for (it = data; it != NULL; it = it->next) {
  77         int i;
  78
  79         MouseBinding *b = it->data;
  80         for (i = 0; i < NUM_MOUSEACTION; ++i)
  81             if (b->action[i] != NULL)
  82                 action_free(b->action[i]);
  83         g_free(b);
  84     }
  85     g_slist_free(data);
  86 }
  87
  88 static void fire_button(MouseAction a, GQuark context, Client *c, guint state,
  89                         guint button)
  90 {
  91     GSList *it;
  92     MouseBinding *b;
  93
  94     for (it = g_datalist_id_get_data(&bound_contexts, context);
  95          it != NULL; it = it->next) {
  96         b = it->data;
  97         if (b->state == state && b->button == button)
  98             break;
  99     }
 100     /* if not bound, then nothing to do! */
 101     if (it == NULL) return;
 102
 103     if (b->action[a] != NULL && b->action[a]->func != NULL) {
 104         b->action[a]->data.any.c = c;
 105
 106         g_assert(!(b->action[a]->func == action_move ||
 107                    b->action[a]->func == action_resize));
 108
 109         b->action[a]->func(&b->action[a]->data);
 110     }
 111 }
 112
 113 /* corner should be the opposite corner of the window in which the pointer
 114    clicked, Corner_TopLeft if a good default if there is no client */
 115 static void fire_motion(MouseAction a, GQuark context, Client *c, guint state,
 116                         guint button, int cx, int cy, int cw, int ch,
 117                         int dx, int dy, gboolean final, Corner corner)
 118 {
 119     GSList *it;
 120     MouseBinding *b;
 121
 122     for (it = g_datalist_id_get_data(&bound_contexts, context);
 123          it != NULL; it = it->next) {
 124         b = it->data;
 125         if (b->state == state && b->button == button)
 126                 break;
 127     }
 128     /* if not bound, then nothing to do! */
 129     if (it == NULL) return;
 130
 131     if (b->action[a] != NULL && b->action[a]->func != NULL) {
 132         b->action[a]->data.any.c = c;
 133
 134         if (b->action[a]->func == action_move) {
 135             b->action[a]->data.move.x = cx + dx;
 136             b->action[a]->data.move.y = cy + dy;
 137             b->action[a]->data.move.final = final;
 138         } else if (b->action[a]->func == action_resize) {
 139             b->action[a]->data.resize.corner = corner;
 140             switch (corner) {
 141             case Corner_TopLeft:
 142                 b->action[a]->data.resize.x = cw + dx;
 143                 b->action[a]->data.resize.y = ch + dy;
 144                 break;
 145             case Corner_TopRight:
 146                 b->action[a]->data.resize.x = cw - dx;
 147                 b->action[a]->data.resize.y = ch + dy;
 148                 break;
 149             case Corner_BottomLeft:
 150                 b->action[a]->data.resize.x = cw + dx;
 151                 b->action[a]->data.resize.y = ch - dy;
 152                 break;
 153             case Corner_BottomRight:
 154                 b->action[a]->data.resize.x = cw - dx;
 155                 b->action[a]->data.resize.y = ch - dy;
 156                 break;
 157             }
 158             b->action[a]->data.resize.final = final;
 159         }
 160         b->action[a]->func(&b->action[a]->data);
 161     }
 162 }
 163
 164 static Corner pick_corner(int x, int y, int cx, int cy, int cw, int ch)
 165 {
 166     if (x - cx < cw / 2) {
 167         if (y - cy < ch / 2)
 168             return Corner_BottomRight;
 169         else
 170             return Corner_TopRight;
 171     } else {
 172         if (y - cy < ch / 2)
 173             return Corner_BottomLeft;
 174         else
 175             return Corner_TopLeft;
 176     }
 177 }
 178
 179 static void event(ObEvent *e, void *foo)
 180 {
 181     static Time ltime;
 182     static int px, py, cx, cy, cw, ch, dx, dy;
 183     static guint button = 0, lbutton = 0;
 184     static gboolean drag = FALSE;
 185     static Corner corner = Corner_TopLeft;
 186     gboolean click = FALSE;
 187     gboolean dclick = FALSE;
 188
 189     switch (e->type) {
 190     case Event_Client_Mapped:
 191         grab_for_client(e->data.c.client, TRUE);
 192         break;
 193
 194     case Event_Client_Destroy:
 195         grab_for_client(e->data.c.client, FALSE);
 196         break;
 197
 198     case Event_X_ButtonPress:
 199         if (!button) {
 200             if (e->data.x.client != NULL) {
 201                 cx = e->data.x.client->frame->area.x;
 202                 cy = e->data.x.client->frame->area.y;
 203                 cw = e->data.x.client->frame->area.width;
 204                 ch = e->data.x.client->frame->area.height;
 205                 px = e->data.x.e->xbutton.x_root;
 206                 py = e->data.x.e->xbutton.y_root;
 207                 corner = pick_corner(px, py, cx, cy, cw, ch);
 208             }
 209             button = e->data.x.e->xbutton.button;
 210         }
 211         fire_button(MouseAction_Press,
 212                     engine_get_context(e->data.x.client,
 213                                        e->data.x.e->xbutton.window),
 214                     e->data.x.client, e->data.x.e->xbutton.state,
 215                     e->data.x.e->xbutton.button);
 216         break;
 217
 218     case Event_X_ButtonRelease:
 219         if (e->data.x.e->xbutton.button == button) {
 220             /* end drags */
 221             if (drag) {
 222                 fire_motion(MouseAction_Motion,
 223                             engine_get_context(e->data.x.client,
 224                                                e->data.x.e->xbutton.window),
 225                             e->data.x.client, e->data.x.e->xbutton.state,
 226                             e->data.x.e->xbutton.button,
 227                             cx, cy, cw, ch, dx, dy, TRUE, corner);
 228                 drag = FALSE;
 229
 230                 lbutton = 0;
 231             } else {
 232                 /* clicks are only valid if its released over the window */
 233                 if (e->data.x.e->xbutton.x >= 0 &&
 234                     e->data.x.e->xbutton.y >= 0) {
 235                     int junk;
 236                     Window wjunk;
 237                     guint ujunk, w, h;
 238                     XGetGeometry(ob_display, e->data.x.e->xbutton.window,
 239                                  &wjunk, &junk, &junk, &w, &h, &ujunk, &ujunk);
 240                     if (e->data.x.e->xbutton.x < (signed)w &&
 241                         e->data.x.e->xbutton.y < (signed)h) {
 242                         click =TRUE;
 243                         /* double clicks happen if there were 2 in a row! */
 244                         if (lbutton == button &&
 245                             e->data.x.e->xbutton.time - 300 <= ltime)
 246                             dclick = TRUE;
 247                     }
 248                     lbutton = button;
 249                 } else
 250                     lbutton = 0;
 251             }
 252
 253             button = 0;
 254             ltime = e->data.x.e->xbutton.time;
 255         }
 256         fire_button(MouseAction_Press,
 257                     engine_get_context(e->data.x.client,
 258                                        e->data.x.e->xbutton.window),
 259                     e->data.x.client, e->data.x.e->xbutton.state,
 260                     e->data.x.e->xbutton.button);
 261         if (click)
 262             fire_button(MouseAction_Click,
 263                         engine_get_context(e->data.x.client,
 264                                            e->data.x.e->xbutton.window),
 265                         e->data.x.client, e->data.x.e->xbutton.state,
 266                         e->data.x.e->xbutton.button);
 267         if (dclick)
 268             fire_button(MouseAction_DClick,
 269                         engine_get_context(e->data.x.client,
 270                                            e->data.x.e->xbutton.window),
 271                         e->data.x.client, e->data.x.e->xbutton.state,
 272                         e->data.x.e->xbutton.button);
 273         break;
 274
 275     case Event_X_MotionNotify:
 276         if (button) {
 277             drag = TRUE;
 278             dx = e->data.x.e->xmotion.x_root - px;
 279             dy = e->data.x.e->xmotion.y_root - py;
 280             fire_motion(MouseAction_Motion,
 281                         engine_get_context(e->data.x.client,
 282                                            e->data.x.e->xbutton.window),
 283                         e->data.x.client, e->data.x.e->xmotion.state,
 284                         button, cx, cy, cw, ch, dx, dy, FALSE, corner);
 285         }
 286         break;
 287
 288     default:
 289         g_assert_not_reached();
 290     }
 291 }
 292
 293 static gboolean mbind(char *buttonstr, char *contextstr, MouseAction mact,
 294                       Action *action)
 295 {
 296     guint state, button;
 297     GQuark context;
 298     MouseBinding *b;
 299     GSList *it;
 300     guint i;
 301
 302     if (!translate_button(buttonstr, &state, &button)) {
 303         g_warning("invalid button");
 304         return FALSE;
 305     }
 306
 307     context = g_quark_try_string(contextstr);
 308     if (!context) {
 309         g_warning("invalid context");
 310         return FALSE;
 311     }
 312
 313     for (it = g_datalist_id_get_data(&bound_contexts, context);
 314          it != NULL; it = it->next){
 315         b = it->data;
 316         if (b->state == state && b->button == button) {
 317             /* already bound */
 318             if (b->action[mact] != NULL) {
 319                 g_warning("duplicate binding");
 320                 return FALSE;
 321             }
 322             b->action[mact] = action;
 323             return TRUE;
 324         }
 325     }
 326
 327     grab_all_clients(FALSE);
 328
 329     /* add the binding */
 330     b = g_new(MouseBinding, 1);
 331     b->state = state;
 332     b->button = button;
 333     for (i = 0; i < NUM_MOUSEACTION; ++i)
 334         b->action[i] = NULL;
 335     b->action[mact] = action;
 336     g_datalist_id_set_data(&bound_contexts, context,
 337         g_slist_append(g_datalist_id_get_data(&bound_contexts, context), b));
 338
 339     grab_all_clients(TRUE);
 340
 341     return TRUE;
 342 }
 343
 344 static void binddef()
 345 {
 346     Action *a;
 347
 348     /* When creating an Action struct, all of the data elements in the
 349        appropriate struct need to be set, except the Client*, which will be set
 350        at call-time when then action function is used.
 351
 352        For action_move and action_resize, the 'x', 'y', and 'final' data
 353        elements should not be set, as they are set at call-time.
 354     */
 355
 356     a = action_new(action_move);
 357     mbind("1", "titlebar", MouseAction_Motion, a);
 358     a = action_new(action_move);
 359     mbind("1", "handle", MouseAction_Motion, a);
 360     a = action_new(action_move);
 361     mbind("A-1", "frame", MouseAction_Motion, a);
 362
 363     a = action_new(action_resize);
 364     mbind("1", "blcorner", MouseAction_Motion, a);
 365     a = action_new(action_resize);
 366     mbind("1", "brcorner", MouseAction_Motion, a);
 367     a = action_new(action_resize);
 368     mbind("A-3", "frame", MouseAction_Motion, a);
 369
 370     a = action_new(action_raise);
 371     mbind("1", "titlebar", MouseAction_Press, a);
 372     a = action_new(action_raise);
 373     mbind("1", "handle", MouseAction_Press, a);
 374     a = action_new(action_lower);
 375     mbind("2", "titlebar", MouseAction_Press, a);
 376     a = action_new(action_lower);
 377     mbind("2", "handle", MouseAction_Press, a);
 378     a = action_new(action_raise);
 379     mbind("A-1", "frame", MouseAction_Click, a);
 380     a = action_new(action_lower);
 381     mbind("A-3", "frame", MouseAction_Click, a);
 382
 383     a = action_new(action_toggle_shade);
 384     mbind("1", "titlebar", MouseAction_DClick, a);
 385     a = action_new(action_shade);
 386     mbind("4", "titlebar", MouseAction_Press, a);
 387     a = action_new(action_unshade);
 388     mbind("5", "titlebar", MouseAction_Click, a);
 389
 390     a = action_new(action_toggle_maximize_full);
 391     mbind("1", "maximize", MouseAction_Click, a);
 392     a = action_new(action_toggle_maximize_vert);
 393     mbind("2", "maximize", MouseAction_Click, a);
 394     a = action_new(action_toggle_maximize_horz);
 395     mbind("3", "maximize", MouseAction_Click, a);
 396     a = action_new(action_iconify);
 397     mbind("1", "iconify", MouseAction_Click, a);
 398     a = action_new(action_close);
 399     mbind("1", "icon", MouseAction_DClick, a);
 400     a = action_new(action_close);
 401     mbind("1", "close", MouseAction_Click, a);
 402     a = action_new(action_toggle_omnipresent);
 403     mbind("1", "alldesktops", MouseAction_Click, a);
 404
 405     a = action_new(action_next_desktop);
 406     a->data.nextprevdesktop.wrap = TRUE;
 407     mbind("4", "root", MouseAction_Click, a);
 408     a = action_new(action_previous_desktop);
 409     a->data.nextprevdesktop.wrap = TRUE;
 410     mbind("5", "root", MouseAction_Click, a);
 411     a = action_new(action_next_desktop);
 412     a->data.nextprevdesktop.wrap = TRUE;
 413     mbind("A-4", "root", MouseAction_Click, a);
 414     a = action_new(action_previous_desktop);
 415     a->data.nextprevdesktop.wrap = TRUE;
 416     mbind("A-5", "root", MouseAction_Click, a);
 417     a = action_new(action_next_desktop);
 418     a->data.nextprevdesktop.wrap = TRUE;
 419     mbind("A-4", "frame", MouseAction_Click, a);
 420     a = action_new(action_previous_desktop);
 421     a->data.nextprevdesktop.wrap = TRUE;
 422     mbind("A-5", "frame", MouseAction_Click, a);
 423 }
 424
 425 void plugin_startup()
 426 {
 427     dispatch_register(Event_Client_Mapped | Event_Client_Destroy |
 428                       Event_X_ButtonPress | Event_X_ButtonRelease |
 429                       Event_X_MotionNotify, (EventHandler)event, NULL);
 430
 431     /* XXX parse a config */
 432     binddef();
 433 }
 434
 435 void plugin_shutdown()
 436 {
 437     dispatch_register(0, (EventHandler)event, NULL);
 438
 439     grab_all_clients(FALSE);
 440     g_datalist_foreach(&bound_contexts, foreach_clear, NULL);
 441 }