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 "common/util.h"
  24 #include "globalconf.h"
  25 #include "objects/client.h"
  26 #include "objects/drawin.h"
  27 #include "objects/screen.h"
  28
  29 /** Get the pointer position.
  30  * \param window The window to get position on.
  31  * \param x will be set to the Pointer-x-coordinate relative to window
  32  * \param y will be set to the Pointer-y-coordinate relative to window
  33  * \param child Will be set to the window under the pointer.
  34  * \param mask will be set to the current buttons state
  35  * \return true on success, false if an error occurred
  36  **/
  37 bool
  38 mouse_query_pointer(xcb_window_t window, int16_t *x, int16_t *y, xcb_window_t *child, uint16_t *mask)
  39 {
  40     xcb_query_pointer_cookie_t query_ptr_c;
  41     xcb_query_pointer_reply_t *query_ptr_r;
  42
  43     query_ptr_c = xcb_query_pointer_unchecked(globalconf.connection, window);
  44     query_ptr_r = xcb_query_pointer_reply(globalconf.connection, query_ptr_c, NULL);
  45
  46     if(!query_ptr_r || !query_ptr_r->same_screen)
  47     {
  48         p_delete(&query_ptr_r);
  49         return false;
  50     }
  51
  52     *x = query_ptr_r->win_x;
  53     *y = query_ptr_r->win_y;
  54
  55     if(mask)
  56         *mask = query_ptr_r->mask;
  57     if(child)
  58         *child = query_ptr_r->child;
  59
  60     p_delete(&query_ptr_r);
  61
  62     return true;
  63 }
  64
  65 /** Get the pointer position on the screen.
  66  * \param x This will be set to the Pointer-x-coordinate relative to window.
  67  * \param y This will be set to the Pointer-y-coordinate relative to window.
  68  * \param child This will be set to the window under the pointer.
  69  * \param mask This will be set to the current buttons state.
  70  * \return True on success, false if an error occurred.
  71  */
  72 static bool
  73 mouse_query_pointer_root(int16_t *x, int16_t *y, xcb_window_t *child, uint16_t *mask)
  74 {
  75     xcb_window_t root = globalconf.screen->root;
  76
  77     return mouse_query_pointer(root, x, y, child, mask);
  78 }
  79
  80 /** Set the pointer position.
  81  * \param window The destination window.
  82  * \param x X-coordinate inside window.
  83  * \param y Y-coordinate inside window.
  84  */
  85 static inline void
  86 mouse_warp_pointer(xcb_window_t window, int x, int y)
  87 {
  88     xcb_warp_pointer(globalconf.connection, XCB_NONE, window,
  89                      0, 0, 0, 0, x, y);
  90 }
  91
  92 /** Mouse library.
  93  * \param L The Lua VM state.
  94  * \return The number of elements pushed on stack.
  95  * \luastack
  96  * \lfield coords Mouse coordinates.
  97  * \lfield screen Mouse screen number.
  98  */
  99 static int
 100 luaA_mouse_index(lua_State *L)
 101 {
 102     const char *attr = luaL_checkstring(L, 2);
 103     int16_t mouse_x, mouse_y;
 104     screen_t *screen;
 105
 106     /* attr is not "screen"?! */
 107     if (A_STRNEQ(attr, "screen"))
 108         return luaA_default_index(L);
 109
 110     if (!mouse_query_pointer_root(&mouse_x, &mouse_y, NULL, NULL))
 111     {
 112         /* Nothing ever handles mouse.screen being nil. Lying is better than
 113          * having lots of lua errors in this case.
 114          */
 115         if (globalconf.focus.client)
 116             lua_pushnumber(L, screen_get_index(globalconf.focus.client->screen));
 117         else
 118             lua_pushnumber(L, 1);
 119         return 1;
 120     }
 121
 122     screen = screen_getbycoord(mouse_x, mouse_y);
 123     lua_pushnumber(L, screen_get_index(screen));
 124     return 1;
 125 }
 126
 127 /** Newindex for mouse.
 128  * \param L The Lua VM state.
 129  * \return The number of elements pushed on stack.
 130  */
 131 static int
 132 luaA_mouse_newindex(lua_State *L)
 133 {
 134     const char *attr = luaL_checkstring(L, 2);
 135     screen_t *screen;
 136
 137     if (A_STRNEQ(attr, "screen"))
 138         return luaA_default_newindex(L);
 139
 140     screen = luaA_checkscreen(L, 3);
 141     mouse_warp_pointer(globalconf.screen->root, screen->geometry.x, screen->geometry.y);
 142     return 0;
 143 }
 144
 145 /** Push a table with mouse status.
 146  * \param L The Lua VM state.
 147  * \param x The x coordinate.
 148  * \param y The y coordinate.
 149  * \param mask The button mask.
 150  */
 151 int
 152 luaA_mouse_pushstatus(lua_State *L, int x, int y, uint16_t mask)
 153 {
 154     lua_createtable(L, 0, 2);
 155     lua_pushnumber(L, x);
 156     lua_setfield(L, -2, "x");
 157     lua_pushnumber(L, y);
 158     lua_setfield(L, -2, "y");
 159
 160     lua_createtable(L, 5, 0);
 161
 162     int i = 1;
 163
 164     for(uint16_t maski = XCB_BUTTON_MASK_1; maski <= XCB_BUTTON_MASK_5; maski <<= 1)
 165     {
 166         if(mask & maski)
 167             lua_pushboolean(L, true);
 168         else
 169             lua_pushboolean(L, false);
 170         lua_rawseti(L, -2, i++);
 171     }
 172     lua_setfield(L, -2, "buttons");
 173     return 1;
 174 }
 175
 176 /** Get or set the mouse coords.
 177  * \param L The Lua VM state.
 178  * \return The number of elements pushed on stack.
 179  */
 180 static int
 181 luaA_mouse_coords(lua_State *L)
 182 {
 183     uint16_t mask;
 184     int x, y;
 185     int16_t mouse_x, mouse_y;
 186
 187     if(lua_gettop(L) >= 1)
 188     {
 189         luaA_checktable(L, 1);
 190         bool ignore_enter_notify = (lua_gettop(L) == 2 && luaA_checkboolean(L, 2));
 191
 192         if(!mouse_query_pointer_root(&mouse_x, &mouse_y, NULL, &mask))
 193             return 0;
 194
 195         x = luaA_getopt_number(L, 1, "x", mouse_x);
 196         y = luaA_getopt_number(L, 1, "y", mouse_y);
 197
 198         if(ignore_enter_notify)
 199             client_ignore_enterleave_events();
 200
 201         mouse_warp_pointer(globalconf.screen->root, x, y);
 202
 203         if(ignore_enter_notify)
 204             client_restore_enterleave_events();
 205
 206         lua_pop(L, 1);
 207     }
 208
 209     if(!mouse_query_pointer_root(&mouse_x, &mouse_y, NULL, &mask))
 210         return 0;
 211
 212     return luaA_mouse_pushstatus(L, mouse_x, mouse_y, mask);
 213 }
 214
 215 /** Get the client which is under the pointer.
 216  * \param L The Lua VM state.
 217  * \return The number of elements pushed on stack.
 218  * \luastack
 219  * \lreturn A client or nil.
 220  */
 221 static int
 222 luaA_mouse_object_under_pointer(lua_State *L)
 223 {
 224     int16_t mouse_x, mouse_y;
 225     xcb_window_t child;
 226
 227     if(!mouse_query_pointer_root(&mouse_x, &mouse_y, &child, NULL))
 228         return 0;
 229
 230     drawin_t *drawin;
 231     client_t *client;
 232
 233     if((drawin = drawin_getbywin(child)))
 234         return luaA_object_push(L, drawin);
 235
 236     if((client = client_getbyframewin(child)))
 237         return luaA_object_push(globalconf.L, client);
 238
 239     return 0;
 240 }
 241
 242 const struct luaL_Reg awesome_mouse_methods[] =
 243 {
 244     { "__index", luaA_mouse_index },
 245     { "__newindex", luaA_mouse_newindex },
 246     { "coords", luaA_mouse_coords },
 247     { "object_under_pointer", luaA_mouse_object_under_pointer },
 248     { NULL, NULL }
 249 };
 250 const struct luaL_Reg awesome_mouse_meta[] =
 251 {
 252     { NULL, NULL }
 253 };
 254
 255 // vim: filetype=c:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:textwidth=80