awesome/luaa.h

357 lines
9.6 KiB
C
Raw Normal View History

/*
* lua.h - Lua configuration management header
*
* Copyright © 2008 Julien Danjou <julien@danjou.info>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*
*/
#ifndef AWESOME_LUA_H
#define AWESOME_LUA_H
#include <ev.h>
#include <lua.h>
#include <lauxlib.h>
#include <stdio.h>
#include "draw.h"
#include "common/util.h"
/** Type for Lua function */
typedef int luaA_ref;
#define deprecate() _warn(__LINE__, \
__FUNCTION__, \
"This function is deprecated and will be removed.")
#define DO_LUA_NEW(decl, type, prefix, lua_type, type_ref) \
decl int \
luaA_##prefix##_userdata_new(lua_State *L, type *p) \
{ \
type **pp = lua_newuserdata(L, sizeof(type *)); \
*pp = p; \
type_ref(pp); \
return luaA_settype(L, lua_type); \
}
#define DO_LUA_GC(type, prefix, lua_type, type_unref) \
static int \
luaA_##prefix##_gc(lua_State *L) \
{ \
type **p = luaA_checkudata(L, 1, lua_type); \
type_unref(p); \
*p = NULL; \
return 0; \
}
#define DO_LUA_EQ(type, prefix, lua_type) \
static int \
luaA_##prefix##_eq(lua_State *L) \
{ \
type **p1 = luaA_checkudata(L, 1, lua_type); \
type **p2 = luaA_checkudata(L, 2, lua_type); \
lua_pushboolean(L, (*p1 == *p2)); \
return 1; \
}
#define luaA_dostring(L, cmd) \
do { \
if(a_strlen(cmd)) \
if(luaL_dostring(L, cmd)) \
warn("error executing Lua code: %s", \
lua_tostring(L, -1)); \
} while(0)
#define luaA_checktable(L, n) \
do { \
if(!lua_istable(L, n)) \
luaL_typerror(L, n, "table"); \
} while(0)
#define luaA_checkfunction(L, n) \
do { \
if(!lua_isfunction(L, n)) \
luaL_typerror(L, n, "function"); \
} while(0)
#define luaA_checkscreen(screen) \
do { \
if(screen < 0 || screen >= globalconf.nscreen) \
luaL_error(L, "invalid screen number: %d", screen + 1); \
} while(0)
/** Dump the Lua stack. Useful for debugging.
* \param L The Lua VM state.
*/
static inline void
luaA_dumpstack(lua_State *L)
{
fprintf(stderr, "-------- Lua stack dump ---------\n");
for(int i = lua_gettop(L); i; i--)
{
int t = lua_type(L, i);
switch (t)
{
case LUA_TSTRING:
fprintf(stderr, "%d: string: `%s'\n", i, lua_tostring(L, i));
break;
case LUA_TBOOLEAN:
fprintf(stderr, "%d: bool: %s\n", i, lua_toboolean(L, i) ? "true" : "false");
break;
case LUA_TNUMBER:
fprintf(stderr, "%d: number: %g\n", i, lua_tonumber(L, i));
break;
case LUA_TNIL:
fprintf(stderr, "%d: nil\n", i);
break;
default:
fprintf(stderr, "%d: %s\t#%d\t%p\n", i, lua_typename(L, t),
(int) lua_objlen(L, i),
lua_topointer(L, i));
break;
}
}
fprintf(stderr, "------- Lua stack dump end ------\n");
}
/** Check that an object is not a NULL reference.
* \param L The Lua state.
* \param ud The index of the object in the stack.
* \param tname The type name.
* \return A pointer to the object.
*/
static inline void *
luaA_checkudata(lua_State *L, int ud, const char *tname)
{
void **p = luaL_checkudata(L, ud, tname);
if(*p)
return p;
luaL_error(L, "invalid object");
return NULL;
}
/** Convert a object to a udata if possible.
* \param L The Lua VM state.
* \param ud The index.
* \param tname The type name.
* \return A pointer to the object, NULL otherwise.
*/
static inline void *
luaA_toudata(lua_State *L, int ud, const char *tname)
{
void **p = lua_touserdata(L, ud);
if(p && *p) /* value is a userdata? */
if(lua_getmetatable(L, ud)) /* does it have a metatable? */
{
lua_getfield(L, LUA_REGISTRYINDEX, tname); /* get correct metatable */
if(lua_rawequal(L, -1, -2)) /* does it have the correct mt? */
{
lua_pop(L, 2); /* remove both metatables */
return p;
}
lua_pop(L, 2); /* remove both metatables */
}
return NULL;
}
static inline bool
luaA_checkboolean(lua_State *L, int n)
{
if(!lua_isboolean(L, n))
luaL_typerror(L, n, "boolean");
return lua_toboolean(L, n);
}
static inline bool
luaA_optboolean(lua_State *L, int idx, bool def)
{
return luaL_opt(L, luaA_checkboolean, idx, def);
}
static inline lua_Number
luaA_getopt_number(lua_State *L, int idx, const char *name, lua_Number def)
{
lua_getfield(L, idx, name);
return luaL_optnumber(L, -1, def);
}
static inline const char *
luaA_getopt_lstring(lua_State *L, int idx, const char *name, const char *def, size_t *len)
{
lua_getfield(L, idx, name);
return luaL_optlstring(L, -1, def, len);
}
static inline const char *
luaA_getopt_string(lua_State *L, int idx, const char *name, const char *def)
{
return luaA_getopt_lstring(L, idx, name, def, NULL);
}
static inline bool
luaA_getopt_boolean(lua_State *L, int idx, const char *name, bool def)
{
lua_getfield(L, idx, name);
return luaA_optboolean(L, -1, def);
}
static inline int
luaA_settype(lua_State *L, const char *type)
{
luaL_getmetatable(L, type);
lua_setmetatable(L, -2);
return 1;
}
/** Push a area type to a table on stack.
* \param L The Lua VM state.
* \param geometry The area geometry to push.
* \return The number of elements pushed on stack.
*/
static inline int
luaA_pusharea(lua_State *L, area_t geometry)
{
lua_newtable(L);
lua_pushnumber(L, geometry.x);
lua_setfield(L, -2, "x");
lua_pushnumber(L, geometry.y);
lua_setfield(L, -2, "y");
lua_pushnumber(L, geometry.width);
lua_setfield(L, -2, "width");
lua_pushnumber(L, geometry.height);
lua_setfield(L, -2, "height");
return 1;
}
static inline int
luaA_usemetatable(lua_State *L, int idxobj, int idxfield)
{
lua_getmetatable(L, idxobj);
lua_pushvalue(L, idxfield);
lua_rawget(L, -2);
if(!lua_isnil(L, -1))
{
lua_remove(L, -2);
return 1;
}
lua_pop(L, 2);
return 0;
}
/** Register an Lua object.
* \param L The Lua stack.
* \param idx Index of the object in the stack.
* \param fct A luaA_ref address: it will be filled with the luaA_ref
* registered. If the adresse point to an already registered object, it will
* be unregistered.
* \return Always 0.
*/
static inline int
luaA_register(lua_State *L, int idx, luaA_ref *ref)
{
lua_pushvalue(L, idx);
if(*ref != LUA_REFNIL)
luaL_unref(L, LUA_REGISTRYINDEX, *ref);
*ref = luaL_ref(L, LUA_REGISTRYINDEX);
return 0;
}
/** Register a function.
* \param L The Lua stack.
* \param idx Index of the function in the stack.
* \param fct A luaA_ref address: it will be filled with the luaA_ref
* registered. If the adresse point to an already registered function, it will
* be unregistered.
* \return luaA_register value.
*/
static inline int
luaA_registerfct(lua_State *L, int idx, luaA_ref *fct)
{
luaA_checkfunction(L, idx);
return luaA_register(L, idx, fct);
}
/** Execute an Lua function.
* \param L The Lua stack.
* \param f The Lua function to execute.
* \param nargs The number of arguments for the Lua function.
* \param nret The number of returned value from the Lua function.
* \return True on no error, false otherwise.
*/
static inline bool
luaA_dofunction(lua_State *L, luaA_ref f, int nargs, int nret)
{
if(f != LUA_REFNIL)
{
lua_rawgeti(L, LUA_REGISTRYINDEX, f);
if(nargs)
lua_insert(L, - (nargs + 1));
if(lua_pcall(L, nargs, nret, 0))
{
warn("error running function: %s",
lua_tostring(L, -1));
lua_pop(L, 1);
return false;
}
return true;
}
return false;
}
int luaA_otable_index(lua_State *);
/** Create a new object table with a metatable.
* This is useful to compare table with objects (udata) as keys.
* \param L The Lua stack.
* \return The number of elements pushed on stack.
*/
static inline int
luaA_otable_new(lua_State *L)
{
/* Our object */
lua_newtable(L);
return luaA_settype(L, "otable");
}
void luaA_init(void);
bool luaA_parserc(const char *, bool);
void luaA_cs_init(void);
void luaA_cs_cleanup(void);
void luaA_on_timer(EV_P_ ev_timer *w, int revents);
void luaA_pushcolor(lua_State *, const xcolor_t *);
static inline int
luaA_generic_pairs(lua_State *L)
{
lua_pushvalue(L, lua_upvalueindex(1)); /* return generator, */
lua_pushvalue(L, 1); /* state, */
lua_pushnil(L); /* and initial value */
return 3;
}
#define hooks_property(c, prop) \
do { \
luaA_client_userdata_new(globalconf.L, c); \
lua_pushliteral(globalconf.L, prop); \
luaA_dofunction(globalconf.L, globalconf.hooks.property, 2, 0); \
} while(0);
#endif
// vim: filetype=c:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=80