hooks.c

   1 /*
   2  * hooks.c - Lua hooks management
   3  *
   4  * Copyright © 2008 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 "globalconf.h"
  23 #include "luaa.h"
  24
  25 #define HANDLE_HOOK(L, h) \
  26     do { \
  27         if(lua_gettop(L) == 1) \
  28             luaA_registerfct(L, 1, &h); \
  29         lua_rawgeti(L, LUA_REGISTRYINDEX, h); \
  30         return 1; \
  31     } while(0)
  32
  33 /** Set the function called each time a client gets focus. This function is
  34  * called with the client object as argument.
  35  * \param L The Lua VM state.
  36  * \return The number of elements pushed on stack.
  37  * \luastack
  38  * \lparam A function to call each time a client gets focus.
  39  */
  40 static int
  41 luaA_hooks_focus(lua_State *L)
  42 {
  43     HANDLE_HOOK(L, globalconf.hooks.focus);
  44 }
  45
  46 /** Set the function called each time a client loses focus. This function is
  47  * called with the client object as argument.
  48  * \param L The Lua VM state.
  49  * \return The number of elements pushed on stack.
  50  * \luastack
  51  * \lparam A function to call each time a client loses focus.
  52  */
  53 static int
  54 luaA_hooks_unfocus(lua_State *L)
  55 {
  56     HANDLE_HOOK(L, globalconf.hooks.unfocus);
  57 }
  58
  59 /** Set the function called each time a new client appears. This function is
  60  * called with the client object as argument, plus a boolean argument which is
  61  * true if the client is managed at startup.
  62  * \param L The Lua VM state.
  63  * \return The number of elements pushed on stack.
  64  * \luastack
  65  * \lparam A function to call on each new client.
  66  */
  67 static int
  68 luaA_hooks_manage(lua_State *L)
  69 {
  70     HANDLE_HOOK(L, globalconf.hooks.manage);
  71 }
  72
  73 /** Set the function called each time a client goes away. This function is
  74  * called with the client object as argument.
  75  * \param L The Lua VM state.
  76  * \return The number of elements pushed on stack.
  77  * \luastack
  78  * \lparam A function to call when a client goes away.
  79  */
  80 static int
  81 luaA_hooks_unmanage(lua_State *L)
  82 {
  83     HANDLE_HOOK(L, globalconf.hooks.unmanage);
  84 }
  85
  86 /** Set the function called each time the mouse enter a window. This
  87  * function is called with the client object as argument.
  88  * \param L The Lua VM state.
  89  * \return The number of elements pushed on stack.
  90  * \luastack
  91  * \lparam A function to call each time a client gets mouse over it.
  92  */
  93 static int
  94 luaA_hooks_mouse_enter(lua_State *L)
  95 {
  96     HANDLE_HOOK(L, globalconf.hooks.mouse_enter);
  97 }
  98
  99 /** Set the function called each time the mouse leave a window. This
 100  * function is called with the client object as argument.
 101  * \param L The Lua VM state.
 102  * \return The number of elements pushed on stack.
 103  * \luastack
 104  * \lparam A function to call each time a client gets mouse over it.
 105  */
 106 static int
 107 luaA_hooks_mouse_leave(lua_State *L)
 108 {
 109     HANDLE_HOOK(L, globalconf.hooks.mouse_leave);
 110 }
 111
 112 /** Set the function called on each client list change.
 113  * This function is called without any argument.
 114  * \param L The Lua VM state.
 115  * \return The number of elements pushed on stack.
 116  * \luastack
 117  * \lparam A function to call on each client list change.
 118  */
 119 static int
 120 luaA_hooks_clients(lua_State *L)
 121 {
 122     HANDLE_HOOK(L, globalconf.hooks.clients);
 123 }
 124
 125 /** Set the function called on each screen tag list change.
 126  * This function is called with a screen number as first argument,
 127  * the tag object as second and the action (add, remove, select or unselect)
 128  * as third.
 129  * \param L The Lua VM state.
 130  * \return The number of elements pushed on stack.
 131  * \luastack
 132  * \lparam A function to call on each tag list change.
 133  */
 134 static int
 135 luaA_hooks_tags(lua_State *L)
 136 {
 137     HANDLE_HOOK(L, globalconf.hooks.tags);
 138 }
 139
 140 /** Set the function called on each client's tags change.
 141  * This function is called with the client and the tag as argument.
 142  * \param L The Lua VM state.
 143  * \return The number of elements pushed on stack.
 144  * \luastack
 145  * \lparam A function to call on each client's tags change.
 146  */
 147 static int
 148 luaA_hooks_tagged(lua_State *L)
 149 {
 150     HANDLE_HOOK(L, globalconf.hooks.tagged);
 151 }
 152
 153 /** Set the function called on each client's property change.
 154  * This function is called with the client object as argument and the
 155  * property name.
 156  * \param L The Lua VM state.
 157  * \return The number of elements pushed on stack.
 158  * \luastack
 159  * \lparam A function to call on each client property update.
 160  */
 161 static int
 162 luaA_hooks_property(lua_State *L)
 163 {
 164     HANDLE_HOOK(L, globalconf.hooks.property);
 165 }
 166
 167 /** Set the function to be called every N seconds.
 168  * \param L The Lua VM state.
 169  * \return The number of elements pushed on stack.
 170  * \luastack
 171  * \lparam The number of seconds to run function every. Set 0 to disable.
 172  * \lparam A function to call every N seconds (optional).
 173  */
 174 static int
 175 luaA_hooks_timer(lua_State *L)
 176 {
 177     if(lua_gettop(L) >= 1)
 178     {
 179         globalconf.timer.repeat = luaL_checknumber(L, 1);
 180
 181         if(lua_gettop(L) == 2 && !lua_isnil(L, 2))
 182             luaA_registerfct(L, 2, &globalconf.hooks.timer);
 183
 184         ev_timer_again(globalconf.loop, &globalconf.timer);
 185     }
 186
 187     lua_rawgeti(L, LUA_REGISTRYINDEX, globalconf.hooks.timer);
 188
 189     return 1;
 190 }
 191
 192 /** Set the function called on awesome exit
 193  * \param L The Lua VM state.
 194  * \return The number of elements pushed on stack.
 195  * \luastack
 196  * \lparam A function to call on awesome exit.
 197  */
 198 static int
 199 luaA_hooks_exit(lua_State *L)
 200 {
 201     HANDLE_HOOK(L, globalconf.hooks.exit);
 202 }
 203
 204 const struct luaL_reg awesome_hooks_lib[] =
 205 {
 206     { "focus", luaA_hooks_focus },
 207     { "unfocus", luaA_hooks_unfocus },
 208     { "manage", luaA_hooks_manage },
 209     { "unmanage", luaA_hooks_unmanage },
 210     { "mouse_enter", luaA_hooks_mouse_enter },
 211     { "mouse_leave", luaA_hooks_mouse_leave },
 212     { "property", luaA_hooks_property },
 213     { "clients", luaA_hooks_clients },
 214     { "tags", luaA_hooks_tags },
 215     { "tagged", luaA_hooks_tagged },
 216     { "timer", luaA_hooks_timer },
 217     { "exit", luaA_hooks_exit },
 218     { NULL, NULL }
 219 };
 220
 221 // vim: filetype=c:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=80