mouse.c

   1 /*
   2  * mouse.c - mouse managing
   3  *
   4  * Copyright © 2007-2009 Julien Danjou <julien@danjou.info>
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along
  17  * with this program; if not, write to the Free Software Foundation, Inc.,
  18  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  19  *
  20  */
  21
  22 #include "mouse.h"
  23 #include "screen.h"
  24 #include "objects/client.h"
  25 #include "globalconf.h"
  26 #include "objects/drawin.h"
  27 #include "luaa.h"
  28 #include "common/xutil.h"
  29
  30 /** Get the pointer position.
  31  * \param window The window to get position on.
  32  * \param x will be set to the Pointer-x-coordinate relative to window
  33  * \param y will be set to the Pointer-y-coordinate relative to window
  34  * \param child Will be set to the window under the pointer.
  35  * \param mask will be set to the current buttons state
  36  * \return true on success, false if an error occurred
  37  **/
  38 bool
  39 mouse_query_pointer(xcb_window_t window, int16_t *x, int16_t *y, xcb_window_t *child, uint16_t *mask)
  40 {
  41     xcb_query_pointer_cookie_t query_ptr_c;
  42     xcb_query_pointer_reply_t *query_ptr_r;
  43
  44     query_ptr_c = xcb_query_pointer_unchecked(globalconf.connection, window);
  45     query_ptr_r = xcb_query_pointer_reply(globalconf.connection, query_ptr_c, NULL);
  46
  47     if(!query_ptr_r || !query_ptr_r->same_screen)
  48     {
  49         p_delete(&query_ptr_r);
  50         return false;
  51     }
  52
  53     *x = query_ptr_r->win_x;
  54     *y = query_ptr_r->win_y;
  55
  56     if(mask)
  57         *mask = query_ptr_r->mask;
  58     if(child)
  59         *child = query_ptr_r->child;
  60
  61     p_delete(&query_ptr_r);
  62
  63     return true;
  64 }
  65
  66 /** Get the pointer position on the screen.
  67  * \param x This will be set to the Pointer-x-coordinate relative to window.
  68  * \param y This will be set to the Pointer-y-coordinate relative to window.
  69  * \param child This will be set to the window under the pointer.
  70  * \param mask This will be set to the current buttons state.
  71  * \return True on success, false if an error occurred.
  72  */
  73 static bool
  74 mouse_query_pointer_root(int16_t *x, int16_t *y, xcb_window_t *child, uint16_t *mask)
  75 {
  76     xcb_window_t root = globalconf.screen->root;
  77
  78     return mouse_query_pointer(root, x, y, child, mask);
  79 }
  80
  81 /** Set the pointer position.
  82  * \param window The destination window.
  83  * \param x X-coordinate inside window.
  84  * \param y Y-coordinate inside window.
  85  */
  86 static inline void
  87 mouse_warp_pointer(xcb_window_t window, int x, int y)
  88 {
  89     xcb_warp_pointer(globalconf.connection, XCB_NONE, window,
  90                      0, 0, 0, 0, x, y);
  91 }
  92
  93 /** Mouse library.
  94  * \param L The Lua VM state.
  95  * \return The number of elements pushed on stack.
  96  * \luastack
  97  * \lfield coords Mouse coordinates.
  98  * \lfield screen Mouse screen number.
  99  */
 100 static int
 101 luaA_mouse_index(lua_State *L)
 102 {
 103     const char *attr = luaL_checkstring(L, 2);
 104     int16_t mouse_x, mouse_y;
 105     screen_t *screen;
 106
 107     /* attr is not "screen"?! */
 108     if (A_STRNEQ(attr, "screen"))
 109         return 0;
 110
 111     if (!mouse_query_pointer_root(&mouse_x, &mouse_y, NULL, NULL))
 112     {
 113         /* Nothing ever handles mouse.screen being nil. Lying is better than
 114          * having lots of lua errors in this case.
 115          */
 116         if (globalconf.focus.client)
 117             lua_pushnumber(L, screen_array_indexof(&globalconf.screens, globalconf.focus.client->screen) + 1);
 118         else
 119             lua_pushnumber(L, 1);
 120         return 1;
 121     }
 122
 123     screen = screen_getbycoord(mouse_x, mouse_y);
 124     lua_pushnumber(L, screen_array_indexof(&globalconf.screens, screen) + 1);
 125     return 1;
 126 }
 127
 128 /** Newindex for mouse.
 129  * \param L The Lua VM state.
 130  * \return The number of elements pushed on stack.
 131  */
 132 static int
 133 luaA_mouse_newindex(lua_State *L)
 134 {
 135     const char *attr = luaL_checkstring(L, 2);
 136     int x, y = 0;
 137     int screen;
 138
 139     if (A_STRNEQ(attr, "screen"))
 140         return 0;
 141
 142     screen = luaL_checknumber(L, 3) - 1;
 143     luaA_checkscreen(screen);
 144
 145     x = globalconf.screens.tab[screen].geometry.x;
 146     y = globalconf.screens.tab[screen].geometry.y;
 147
 148     mouse_warp_pointer(globalconf.screen->root, x, y);
 149     return 0;
 150 }
 151
 152 /** Push a table with mouse status.
 153  * \param L The Lua VM state.
 154  * \param x The x coordinate.
 155  * \param y The y coordinate.
 156  * \param mask The button mask.
 157  */
 158 int
 159 luaA_mouse_pushstatus(lua_State *L, int x, int y, uint16_t mask)
 160 {
 161     lua_createtable(L, 0, 2);
 162     lua_pushnumber(L, x);
 163     lua_setfield(L, -2, "x");
 164     lua_pushnumber(L, y);
 165     lua_setfield(L, -2, "y");
 166
 167     lua_createtable(L, 5, 0);
 168
 169     int i = 1;
 170
 171     for(uint16_t maski = XCB_BUTTON_MASK_1; maski <= XCB_BUTTON_MASK_5; maski <<= 1)
 172     {
 173         if(mask & maski)
 174             lua_pushboolean(L, true);
 175         else
 176             lua_pushboolean(L, false);
 177         lua_rawseti(L, -2, i++);
 178     }
 179     lua_setfield(L, -2, "buttons");
 180     return 1;
 181 }
 182
 183 /** Get or set the mouse coords.
 184  * \param L The Lua VM state.
 185  * \return The number of elements pushed on stack.
 186  */
 187 static int
 188 luaA_mouse_coords(lua_State *L)
 189 {
 190     uint16_t mask;
 191     int x, y;
 192     int16_t mouse_x, mouse_y;
 193
 194     if(lua_gettop(L) >= 1)
 195     {
 196         luaA_checktable(L, 1);
 197         bool ignore_enter_notify = (lua_gettop(L) == 2 && luaA_checkboolean(L, 2));
 198
 199         if(!mouse_query_pointer_root(&mouse_x, &mouse_y, NULL, &mask))
 200             return 0;
 201
 202         x = luaA_getopt_number(L, 1, "x", mouse_x);
 203         y = luaA_getopt_number(L, 1, "y", mouse_y);
 204
 205         if(ignore_enter_notify)
 206             client_ignore_enterleave_events();
 207
 208         mouse_warp_pointer(globalconf.screen->root, x, y);
 209
 210         if(ignore_enter_notify)
 211             client_restore_enterleave_events();
 212
 213         lua_pop(L, 1);
 214     }
 215
 216     if(!mouse_query_pointer_root(&mouse_x, &mouse_y, NULL, &mask))
 217         return 0;
 218
 219     return luaA_mouse_pushstatus(L, mouse_x, mouse_y, mask);
 220 }
 221
 222 /** Get the client which is under the pointer.
 223  * \param L The Lua VM state.
 224  * \return The number of elements pushed on stack.
 225  * \luastack
 226  * \lreturn A client or nil.
 227  */
 228 static int
 229 luaA_mouse_object_under_pointer(lua_State *L)
 230 {
 231     int16_t mouse_x, mouse_y;
 232     xcb_window_t child;
 233
 234     if(!mouse_query_pointer_root(&mouse_x, &mouse_y, &child, NULL))
 235         return 0;
 236
 237     drawin_t *drawin;
 238     client_t *client;
 239
 240     if((drawin = drawin_getbywin(child)))
 241         return luaA_object_push(L, drawin);
 242
 243     if((client = client_getbyframewin(child)))
 244         return luaA_object_push(globalconf.L, client);
 245
 246     return 0;
 247 }
 248
 249 const struct luaL_Reg awesome_mouse_methods[] =
 250 {
 251     { "__index", luaA_mouse_index },
 252     { "__newindex", luaA_mouse_newindex },
 253     { "coords", luaA_mouse_coords },
 254     { "object_under_pointer", luaA_mouse_object_under_pointer },
 255     { NULL, NULL }
 256 };
 257 const struct luaL_Reg awesome_mouse_meta[] =
 258 {
 259     { NULL, NULL }
 260 };
 261
 262 // vim: filetype=c:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:textwidth=80