luaa.h

   1 /*
   2  * lua.h - Lua configuration management header
   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 #ifndef AWESOME_LUA_H
  23 #define AWESOME_LUA_H
  24
  25 #include <ev.h>
  26
  27 #include <lua.h>
  28 #include <lauxlib.h>
  29
  30 #include <stdio.h>
  31
  32 #include "draw.h"
  33 #include "common/util.h"
  34
  35 /** Type for Lua function */
  36 typedef int luaA_ref;
  37
  38 #define deprecate(L, repl) \
  39     luaA_warn(L, "%s: This function is deprecated and will be removed, see %s", \
  40               __FUNCTION__, repl)
  41
  42 #define DO_LUA_NEW(decl, type, prefix, lua_type, type_ref) \
  43     decl int \
  44     luaA_##prefix##_userdata_new(lua_State *L, type *p) \
  45     { \
  46         type **pp = lua_newuserdata(L, sizeof(type *)); \
  47         *pp = p; \
  48         type_ref(pp); \
  49         return luaA_settype(L, lua_type); \
  50     } \
  51     static int \
  52     luaA_##prefix##_tostring(lua_State *L) \
  53     { \
  54         type **p = luaA_checkudata(L, 1, lua_type); \
  55         lua_pushfstring(L, lua_type ": %p", *p); \
  56         return 1; \
  57     }
  58
  59 #define DO_LUA_GC(type, prefix, lua_type, type_unref) \
  60     static int \
  61     luaA_##prefix##_gc(lua_State *L) \
  62     { \
  63         type **p = luaA_checkudata(L, 1, lua_type); \
  64         type_unref(p); \
  65         *p = NULL; \
  66         return 0; \
  67     }
  68
  69 #define DO_LUA_EQ(type, prefix, lua_type) \
  70     static int \
  71     luaA_##prefix##_eq(lua_State *L) \
  72     { \
  73         type **p1 = luaA_checkudata(L, 1, lua_type); \
  74         type **p2 = luaA_checkudata(L, 2, lua_type); \
  75         lua_pushboolean(L, (*p1 == *p2)); \
  76         return 1; \
  77     }
  78
  79 #define luaA_dostring(L, cmd) \
  80     do { \
  81         if(luaL_dostring(L, cmd)) \
  82             warn("error executing Lua code: %s", \
  83                  lua_tostring(L, -1)); \
  84     } while(0)
  85
  86 #define luaA_checktable(L, n) \
  87     do { \
  88         if(!lua_istable(L, n)) \
  89             luaL_typerror(L, n, "table"); \
  90     } while(0)
  91
  92 #define luaA_checkfunction(L, n) \
  93     do { \
  94         if(!lua_isfunction(L, n)) \
  95             luaL_typerror(L, n, "function"); \
  96     } while(0)
  97
  98 #define luaA_checkscreen(screen) \
  99     do { \
 100         if(screen < 0 || screen >= globalconf.nscreen) \
 101             luaL_error(L, "invalid screen number: %d", screen + 1); \
 102     } while(0)
 103
 104 /** Dump the Lua stack. Useful for debugging.
 105  * \param L The Lua VM state.
 106  */
 107 static inline void
 108 luaA_dumpstack(lua_State *L)
 109 {
 110     fprintf(stderr, "-------- Lua stack dump ---------\n");
 111     for(int i = lua_gettop(L); i; i--)
 112     {
 113         int t = lua_type(L, i);
 114         switch (t)
 115         {
 116           case LUA_TSTRING:
 117             fprintf(stderr, "%d: string: `%s'\n", i, lua_tostring(L, i));
 118             break;
 119           case LUA_TBOOLEAN:
 120             fprintf(stderr, "%d: bool:   %s\n", i, lua_toboolean(L, i) ? "true" : "false");
 121             break;
 122           case LUA_TNUMBER:
 123             fprintf(stderr, "%d: number: %g\n", i, lua_tonumber(L, i));
 124             break;
 125           case LUA_TNIL:
 126             fprintf(stderr, "%d: nil\n", i);
 127             break;
 128           default:
 129             fprintf(stderr, "%d: %s\t#%d\t%p\n", i, lua_typename(L, t),
 130                     (int) lua_objlen(L, i),
 131                     lua_topointer(L, i));
 132             break;
 133         }
 134     }
 135     fprintf(stderr, "------- Lua stack dump end ------\n");
 136 }
 137
 138 /** Check that an object is not a NULL reference.
 139  * \param L The Lua state.
 140  * \param ud The index of the object in the stack.
 141  * \param tname The type name.
 142  * \return A pointer to the object.
 143  */
 144 static inline void *
 145 luaA_checkudata(lua_State *L, int ud, const char *tname)
 146 {
 147     void **p = luaL_checkudata(L, ud, tname);
 148     if(*p)
 149         return p;
 150     luaL_error(L, "invalid object");
 151     return NULL;
 152 }
 153
 154 /** Convert a object to a udata if possible.
 155  * \param L The Lua VM state.
 156  * \param ud The index.
 157  * \param tname The type name.
 158  * \return A pointer to the object, NULL otherwise.
 159  */
 160 static inline void *
 161 luaA_toudata(lua_State *L, int ud, const char *tname)
 162 {
 163     void **p = lua_touserdata(L, ud);
 164     if(p && *p) /* value is a userdata? */
 165         if(lua_getmetatable(L, ud)) /* does it have a metatable? */
 166         {
 167             lua_getfield(L, LUA_REGISTRYINDEX, tname); /* get correct metatable */
 168             if(lua_rawequal(L, -1, -2)) /* does it have the correct mt? */
 169             {
 170                 lua_pop(L, 2); /* remove both metatables */
 171                 return p;
 172             }
 173             lua_pop(L, 2); /* remove both metatables */
 174         }
 175     return NULL;
 176 }
 177
 178 static inline bool
 179 luaA_checkboolean(lua_State *L, int n)
 180 {
 181     if(!lua_isboolean(L, n))
 182         luaL_typerror(L, n, "boolean");
 183     return lua_toboolean(L, n);
 184 }
 185
 186 static inline bool
 187 luaA_optboolean(lua_State *L, int idx, bool def)
 188 {
 189     return luaL_opt(L, luaA_checkboolean, idx, def);
 190 }
 191
 192 static inline lua_Number
 193 luaA_getopt_number(lua_State *L, int idx, const char *name, lua_Number def)
 194 {
 195     lua_getfield(L, idx, name);
 196     return luaL_optnumber(L, -1, def);
 197 }
 198
 199 static inline const char *
 200 luaA_getopt_lstring(lua_State *L, int idx, const char *name, const char *def, size_t *len)
 201 {
 202     lua_getfield(L, idx, name);
 203     return luaL_optlstring(L, -1, def, len);
 204 }
 205
 206 static inline const char *
 207 luaA_getopt_string(lua_State *L, int idx, const char *name, const char *def)
 208 {
 209     return luaA_getopt_lstring(L, idx, name, def, NULL);
 210 }
 211
 212 static inline bool
 213 luaA_getopt_boolean(lua_State *L, int idx, const char *name, bool def)
 214 {
 215     lua_getfield(L, idx, name);
 216     return luaA_optboolean(L, -1, def);
 217 }
 218
 219 static inline int
 220 luaA_settype(lua_State *L, const char *type)
 221 {
 222     luaL_getmetatable(L, type);
 223     lua_setmetatable(L, -2);
 224     return 1;
 225 }
 226
 227 /** Push a area type to a table on stack.
 228  * \param L The Lua VM state.
 229  * \param geometry The area geometry to push.
 230  * \return The number of elements pushed on stack.
 231  */
 232 static inline int
 233 luaA_pusharea(lua_State *L, area_t geometry)
 234 {
 235     lua_newtable(L);
 236     lua_pushnumber(L, geometry.x);
 237     lua_setfield(L, -2, "x");
 238     lua_pushnumber(L, geometry.y);
 239     lua_setfield(L, -2, "y");
 240     lua_pushnumber(L, geometry.width);
 241     lua_setfield(L, -2, "width");
 242     lua_pushnumber(L, geometry.height);
 243     lua_setfield(L, -2, "height");
 244     return 1;
 245 }
 246
 247 static inline int
 248 luaA_usemetatable(lua_State *L, int idxobj, int idxfield)
 249 {
 250     lua_getmetatable(L, idxobj);
 251     lua_pushvalue(L, idxfield);
 252     lua_rawget(L, -2);
 253     if(!lua_isnil(L, -1))
 254     {
 255         lua_remove(L, -2);
 256         return 1;
 257     }
 258     lua_pop(L, 2);
 259
 260     return 0;
 261 }
 262
 263 /** Register an Lua object.
 264  * \param L The Lua stack.
 265  * \param idx Index of the object in the stack.
 266  * \param ref A luaA_ref address: it will be filled with the luaA_ref
 267  * registered. If the adresse point to an already registered object, it will
 268  * be unregistered.
 269  * \return Always 0.
 270  */
 271 static inline int
 272 luaA_register(lua_State *L, int idx, luaA_ref *ref)
 273 {
 274     lua_pushvalue(L, idx);
 275     if(*ref != LUA_REFNIL)
 276         luaL_unref(L, LUA_REGISTRYINDEX, *ref);
 277     *ref = luaL_ref(L, LUA_REGISTRYINDEX);
 278     return 0;
 279 }
 280
 281 /** Unregister a Lua object.
 282  * \param L The Lua stack.
 283  * \param ref A reference to an Lua object.
 284  */
 285 static inline void
 286 luaA_unregister(lua_State *L, luaA_ref *ref)
 287 {
 288     luaL_unref(L, LUA_REGISTRYINDEX, *ref);
 289     *ref = LUA_REFNIL;
 290 }
 291
 292 /** Register a function.
 293  * \param L The Lua stack.
 294  * \param idx Index of the function in the stack.
 295  * \param fct A luaA_ref address: it will be filled with the luaA_ref
 296  * registered. If the adresse point to an already registered function, it will
 297  * be unregistered.
 298  * \return luaA_register value.
 299  */
 300 static inline int
 301 luaA_registerfct(lua_State *L, int idx, luaA_ref *fct)
 302 {
 303     luaA_checkfunction(L, idx);
 304     return luaA_register(L, idx, fct);
 305 }
 306
 307 /** Execute an Lua function.
 308  * \param L The Lua stack.
 309  * \param f The Lua function to execute.
 310  * \param nargs The number of arguments for the Lua function.
 311  * \param nret The number of returned value from the Lua function.
 312  * \return True on no error, false otherwise.
 313  */
 314 static inline bool
 315 luaA_dofunction(lua_State *L, luaA_ref f, int nargs, int nret)
 316 {
 317     lua_rawgeti(L, LUA_REGISTRYINDEX, f);
 318     if(nargs)
 319         lua_insert(L, - (nargs + 1));
 320     if(lua_pcall(L, nargs, nret, 0))
 321     {
 322         warn("error running function: %s",
 323              lua_tostring(L, -1));
 324         lua_pop(L, 1);
 325         return false;
 326     }
 327     return true;
 328 }
 329
 330 /** Print a warning about some Lua code.
 331  * This is less mean than luaL_error() which setjmp via lua_error() and kills
 332  * everything. This only warn, it's up to you to then do what's should be done.
 333  * \param L The Lua VM state.
 334  * \param fmt The warning message.
 335  */
 336 static inline void __attribute__ ((format(printf, 2, 3)))
 337 luaA_warn(lua_State *L, const char *fmt, ...)
 338 {
 339     va_list ap;
 340     luaL_where(L, 1);
 341     fprintf(stderr, "%sW: ", lua_tostring(L, -1));
 342     lua_pop(L, 1);
 343     va_start(ap, fmt);
 344     vfprintf(stderr, fmt, ap);
 345     va_end(ap);
 346     fprintf(stderr, "\n");
 347 }
 348
 349 int luaA_otable_index(lua_State *);
 350
 351 /** Create a new object table with a metatable.
 352  * This is useful to compare table with objects (udata) as keys.
 353  * \param L The Lua stack.
 354  * \return The number of elements pushed on stack.
 355  */
 356 static inline int
 357 luaA_otable_new(lua_State *L)
 358 {
 359     /* Our object */
 360     lua_newtable(L);
 361     return luaA_settype(L, "otable");
 362 }
 363
 364 void luaA_init(void);
 365 bool luaA_parserc(const char *, bool);
 366 void luaA_cs_init(void);
 367 void luaA_cs_cleanup(void);
 368 void luaA_on_timer(EV_P_ ev_timer *, int);
 369 int luaA_pushcolor(lua_State *, const xcolor_t *);
 370 bool luaA_hasitem(lua_State *, const void *);
 371 void luaA_table2wtable(lua_State *);
 372 int luaA_next(lua_State *, int);
 373 bool luaA_isloop(lua_State *, int);
 374
 375 #define hooks_property(c, prop) \
 376     do { \
 377         if(globalconf.hooks.property != LUA_REFNIL) \
 378         { \
 379             luaA_client_userdata_new(globalconf.L, c); \
 380             lua_pushliteral(globalconf.L, prop); \
 381             luaA_dofunction(globalconf.L, globalconf.hooks.property, 2, 0); \
 382         } \
 383     } while(0);
 384
 385 #endif
 386 // vim: filetype=c:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=80