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 "structs.h"
  23
  24 extern awesome_t globalconf;
  25
  26 #define HANDLE_HOOK(L, h) \
  27     do { \
  28         if(lua_gettop(L) == 1) \
  29             luaA_registerfct(L, 1, &h); \
  30         lua_rawgeti(L, LUA_REGISTRYINDEX, h); \
  31         return 1; \
  32     } while(0)
  33
  34 /** Set the function called each time a client gets focus. This function is
  35  * called with the client object as argument.
  36  * \param L The Lua VM state.
  37  * \return The number of elements pushed on stack.
  38  * \luastack
  39  * \lparam A function to call each time a client gets focus.
  40  */
  41 static int
  42 luaA_hooks_focus(lua_State *L)
  43 {
  44     HANDLE_HOOK(L, globalconf.hooks.focus);
  45 }
  46
  47 /** Set the function called each time a client loses focus. This function is
  48  * called with the client object as argument.
  49  * \param L The Lua VM state.
  50  * \return The number of elements pushed on stack.
  51  * \luastack
  52  * \lparam A function to call each time a client loses focus.
  53  */
  54 static int
  55 luaA_hooks_unfocus(lua_State *L)
  56 {
  57     HANDLE_HOOK(L, globalconf.hooks.unfocus);
  58 }
  59
  60 /** Set the function called each time a new client appears. This function is
  61  * called with the client object as argument, plus a boolean argument which is
  62  * true if the client is managed at startup.
  63  * \param L The Lua VM state.
  64  * \return The number of elements pushed on stack.
  65  * \luastack
  66  * \lparam A function to call on each new client.
  67  */
  68 static int
  69 luaA_hooks_manage(lua_State *L)
  70 {
  71     HANDLE_HOOK(L, globalconf.hooks.manage);
  72 }
  73
  74 /** Set the function called each time a client goes away. This function is
  75  * called with the client object as argument.
  76  * \param L The Lua VM state.
  77  * \return The number of elements pushed on stack.
  78  * \luastack
  79  * \lparam A function to call when a client goes away.
  80  */
  81 static int
  82 luaA_hooks_unmanage(lua_State *L)
  83 {
  84     HANDLE_HOOK(L, globalconf.hooks.unmanage);
  85 }
  86
  87 /** Set the function called each time the mouse enter a window. This
  88  * function is called with the client object as argument.
  89  * \param L The Lua VM state.
  90  * \return The number of elements pushed on stack.
  91  * \luastack
  92  * \lparam A function to call each time a client gets mouse over it.
  93  */
  94 static int
  95 luaA_hooks_mouse_enter(lua_State *L)
  96 {
  97     HANDLE_HOOK(L, globalconf.hooks.mouse_enter);
  98 }
  99
 100 /** Set the function called each time the mouse leave a window. This
 101  * function is called with the client object as argument.
 102  * \param L The Lua VM state.
 103  * \return The number of elements pushed on stack.
 104  * \luastack
 105  * \lparam A function to call each time a client gets mouse over it.
 106  */
 107 static int
 108 luaA_hooks_mouse_leave(lua_State *L)
 109 {
 110     HANDLE_HOOK(L, globalconf.hooks.mouse_leave);
 111 }
 112
 113 /** Set the function called on each client list change.
 114  * This function is called without any argument.
 115  * \param L The Lua VM state.
 116  * \return The number of elements pushed on stack.
 117  * \luastack
 118  * \lparam A function to call on each client list change.
 119  */
 120 static int
 121 luaA_hooks_clients(lua_State *L)
 122 {
 123     HANDLE_HOOK(L, globalconf.hooks.clients);
 124 }
 125
 126 /** Set the function called on each screen tag list change.
 127  * This function is called with a screen number as first argument,
 128  * the tag object as second and the action (add or remove) 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 screen arrange. This function is called
 154  * with the screen number as argument.
 155  * \param L The Lua VM state.
 156  * \return The number of elements pushed on stack.
 157  * \luastack
 158  * \lparam A function to call on each screen arrange.
 159  */
 160 static int
 161 luaA_hooks_arrange(lua_State *L)
 162 {
 163     HANDLE_HOOK(L, globalconf.hooks.arrange);
 164 }
 165
 166 /** Set the function called on each client's property change.
 167  * This function is called with the client object as argument and the
 168  * property name.
 169  * \param L The Lua VM state.
 170  * \return The number of elements pushed on stack.
 171  * \luastack
 172  * \lparam A function to call on each client property update.
 173  */
 174 static int
 175 luaA_hooks_property(lua_State *L)
 176 {
 177     HANDLE_HOOK(L, globalconf.hooks.property);
 178 }
 179
 180 /** Set the function to be called every N seconds.
 181  * \param L The Lua VM state.
 182  * \return The number of elements pushed on stack.
 183  * \luastack
 184  * \lparam The number of seconds to run function every. Set 0 to disable.
 185  * \lparam A function to call every N seconds (optional).
 186  */
 187 static int
 188 luaA_hooks_timer(lua_State *L)
 189 {
 190     if(lua_gettop(L) >= 1)
 191     {
 192         globalconf.timer.repeat = luaL_checknumber(L, 1);
 193
 194         if(lua_gettop(L) == 2 && !lua_isnil(L, 2))
 195             luaA_registerfct(L, 2, &globalconf.hooks.timer);
 196
 197         ev_timer_again(globalconf.loop, &globalconf.timer);
 198     }
 199
 200     lua_rawgeti(L, LUA_REGISTRYINDEX, globalconf.hooks.timer);
 201
 202     return 1;
 203 }
 204
 205 #ifdef WITH_DBUS
 206 /** Set the function to be called when a D-Bus event is received.
 207  * The first argument passed to this function is the type of the message we
 208  * receive: signal, method_call, method_return or error.
 209  * The second argument is the path.
 210  * The other arguments are a variable list of arguments.
 211  * The function can return values using pair of type, value.
 212  * For example: return "s", "hello", "i", 32
 213  * \param L The Lua VM state.
 214  * \return The number of elements pushed on stack.
 215  * \luastack
 216  * \lparam A function to call on D-Bus events.
 217  */
 218 static int
 219 luaA_hooks_dbus(lua_State *L)
 220 {
 221     HANDLE_HOOK(L, globalconf.hooks.dbus);
 222 }
 223 #endif
 224
 225 const struct luaL_reg awesome_hooks_lib[] =
 226 {
 227     { "focus", luaA_hooks_focus },
 228     { "unfocus", luaA_hooks_unfocus },
 229     { "manage", luaA_hooks_manage },
 230     { "unmanage", luaA_hooks_unmanage },
 231     { "mouse_enter", luaA_hooks_mouse_enter },
 232     { "mouse_leave", luaA_hooks_mouse_leave },
 233     { "property", luaA_hooks_property },
 234     { "arrange", luaA_hooks_arrange },
 235     { "clients", luaA_hooks_clients },
 236     { "tags", luaA_hooks_tags },
 237     { "tagged", luaA_hooks_tagged },
 238     { "timer", luaA_hooks_timer },
 239 #ifdef WITH_DBUS
 240     { "dbus", luaA_hooks_dbus },
 241 #endif
 242     { NULL, NULL }
 243 };