2008-05-20 15:39:47 +02:00
|
|
|
/*
|
2009-04-03 13:09:17 +02:00
|
|
|
* luaa.h - Lua configuration management header
|
2008-05-20 15:39:47 +02:00
|
|
|
*
|
2009-04-03 13:09:17 +02:00
|
|
|
* Copyright © 2008-2009 Julien Danjou <julien@danjou.info>
|
2008-05-20 15:39:47 +02:00
|
|
|
*
|
|
|
|
* 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
|
|
|
|
|
2008-06-17 00:30:53 +02:00
|
|
|
#include <ev.h>
|
2008-10-20 11:21:15 +02:00
|
|
|
|
2008-05-20 19:02:40 +02:00
|
|
|
#include <lua.h>
|
|
|
|
#include <lauxlib.h>
|
2008-05-20 15:39:47 +02:00
|
|
|
|
2009-04-08 15:47:31 +02:00
|
|
|
#include <basedir.h>
|
|
|
|
|
2008-09-11 14:11:13 +02:00
|
|
|
#include "draw.h"
|
2009-08-17 16:38:56 +02:00
|
|
|
#include "common/lualib.h"
|
2010-09-29 19:36:58 +02:00
|
|
|
#include "common/luaclass.h"
|
2008-05-20 15:39:47 +02:00
|
|
|
|
2008-11-14 13:44:47 +01:00
|
|
|
#define luaA_deprecate(L, repl) \
|
2009-08-27 18:05:44 +02:00
|
|
|
do { \
|
|
|
|
luaA_warn(L, "%s: This function is deprecated and will be removed, see %s", \
|
|
|
|
__FUNCTION__, repl); \
|
|
|
|
lua_pushlstring(L, __FUNCTION__, sizeof(__FUNCTION__)); \
|
|
|
|
signal_object_emit(L, &global_signals, "debug::deprecation", 1); \
|
|
|
|
} while(0)
|
2008-08-12 12:08:20 +02:00
|
|
|
|
2008-05-20 15:39:47 +02:00
|
|
|
#define luaA_checkscreen(screen) \
|
|
|
|
do { \
|
2009-04-17 16:14:09 +02:00
|
|
|
if(screen < 0 || screen >= globalconf.screens.len) \
|
2008-08-14 18:17:39 +02:00
|
|
|
luaL_error(L, "invalid screen number: %d", screen + 1); \
|
2008-05-20 15:39:47 +02:00
|
|
|
} while(0)
|
|
|
|
|
2008-06-12 13:27:45 +02:00
|
|
|
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);
|
|
|
|
}
|
|
|
|
|
2008-05-20 15:39:47 +02:00
|
|
|
static inline lua_Number
|
|
|
|
luaA_getopt_number(lua_State *L, int idx, const char *name, lua_Number def)
|
|
|
|
{
|
|
|
|
lua_getfield(L, idx, name);
|
2009-04-06 09:47:44 +02:00
|
|
|
if (lua_isnil(L, -1) || lua_isnumber(L, -1))
|
|
|
|
def = luaL_optnumber(L, -1, def);
|
2009-04-09 12:47:19 +02:00
|
|
|
lua_pop(L, 1);
|
2009-04-06 09:47:44 +02:00
|
|
|
return def;
|
2008-05-20 15:39:47 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
static inline const char *
|
2008-06-25 17:33:05 +02:00
|
|
|
luaA_getopt_lstring(lua_State *L, int idx, const char *name, const char *def, size_t *len)
|
2008-05-20 15:39:47 +02:00
|
|
|
{
|
|
|
|
lua_getfield(L, idx, name);
|
2009-04-09 12:47:19 +02:00
|
|
|
const char *s = luaL_optlstring(L, -1, def, len);
|
|
|
|
lua_pop(L, 1);
|
|
|
|
return s;
|
2008-05-20 15:39:47 +02:00
|
|
|
}
|
|
|
|
|
2008-06-12 13:27:45 +02:00
|
|
|
static inline bool
|
|
|
|
luaA_getopt_boolean(lua_State *L, int idx, const char *name, bool def)
|
|
|
|
{
|
|
|
|
lua_getfield(L, idx, name);
|
2009-04-09 12:47:19 +02:00
|
|
|
bool b = luaA_optboolean(L, -1, def);
|
|
|
|
lua_pop(L, 1);
|
|
|
|
return b;
|
2008-06-12 13:27:45 +02:00
|
|
|
}
|
|
|
|
|
2008-08-20 12:00:22 +02:00
|
|
|
/** 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)
|
|
|
|
{
|
2009-04-25 15:04:27 +02:00
|
|
|
lua_createtable(L, 0, 4);
|
2008-08-20 12:00:22 +02:00
|
|
|
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;
|
|
|
|
}
|
|
|
|
|
2008-10-20 11:43:58 +02:00
|
|
|
/** Register an Lua object.
|
|
|
|
* \param L The Lua stack.
|
|
|
|
* \param idx Index of the object in the stack.
|
2009-07-28 10:29:30 +02:00
|
|
|
* \param ref A int address: it will be filled with the int
|
2009-08-30 07:26:19 +02:00
|
|
|
* registered. If the address points to an already registered object, it will
|
2008-10-20 11:43:58 +02:00
|
|
|
* be unregistered.
|
|
|
|
* \return Always 0.
|
|
|
|
*/
|
|
|
|
static inline int
|
2009-07-28 10:29:30 +02:00
|
|
|
luaA_register(lua_State *L, int idx, int *ref)
|
2008-10-20 11:43:58 +02:00
|
|
|
{
|
|
|
|
lua_pushvalue(L, idx);
|
|
|
|
if(*ref != LUA_REFNIL)
|
|
|
|
luaL_unref(L, LUA_REGISTRYINDEX, *ref);
|
|
|
|
*ref = luaL_ref(L, LUA_REGISTRYINDEX);
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
2008-11-10 17:26:24 +01:00
|
|
|
/** Unregister a Lua object.
|
|
|
|
* \param L The Lua stack.
|
|
|
|
* \param ref A reference to an Lua object.
|
|
|
|
*/
|
|
|
|
static inline void
|
2009-07-28 10:29:30 +02:00
|
|
|
luaA_unregister(lua_State *L, int *ref)
|
2008-11-10 17:26:24 +01:00
|
|
|
{
|
|
|
|
luaL_unref(L, LUA_REGISTRYINDEX, *ref);
|
|
|
|
*ref = LUA_REFNIL;
|
|
|
|
}
|
|
|
|
|
2008-07-29 10:43:11 +02:00
|
|
|
/** Register a function.
|
|
|
|
* \param L The Lua stack.
|
2008-08-12 13:23:10 +02:00
|
|
|
* \param idx Index of the function in the stack.
|
2009-07-28 10:29:30 +02:00
|
|
|
* \param fct A int address: it will be filled with the int
|
2009-08-30 07:26:19 +02:00
|
|
|
* registered. If the address points to an already registered function, it will
|
2008-07-29 10:43:11 +02:00
|
|
|
* be unregistered.
|
2008-10-20 11:43:58 +02:00
|
|
|
* \return luaA_register value.
|
2008-07-29 10:43:11 +02:00
|
|
|
*/
|
2008-07-09 12:12:52 +02:00
|
|
|
static inline int
|
2009-07-28 10:29:30 +02:00
|
|
|
luaA_registerfct(lua_State *L, int idx, int *fct)
|
2008-07-09 12:12:52 +02:00
|
|
|
{
|
2008-08-12 13:23:10 +02:00
|
|
|
luaA_checkfunction(L, idx);
|
2008-10-20 11:43:58 +02:00
|
|
|
return luaA_register(L, idx, fct);
|
2008-07-09 12:12:52 +02:00
|
|
|
}
|
|
|
|
|
2009-05-19 17:37:35 +02:00
|
|
|
/** Grab a function from the registry and execute it.
|
|
|
|
* \param L The Lua stack.
|
|
|
|
* \param ref The function reference.
|
|
|
|
* \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
|
2009-07-28 10:29:30 +02:00
|
|
|
luaA_dofunction_from_registry(lua_State *L, int ref, int nargs, int nret)
|
2009-05-19 17:37:35 +02:00
|
|
|
{
|
|
|
|
lua_rawgeti(L, LUA_REGISTRYINDEX, ref);
|
|
|
|
return luaA_dofunction(L, nargs, nret);
|
|
|
|
}
|
|
|
|
|
2008-11-05 11:15:57 +01:00
|
|
|
/** Print a warning about some Lua code.
|
|
|
|
* This is less mean than luaL_error() which setjmp via lua_error() and kills
|
|
|
|
* everything. This only warn, it's up to you to then do what's should be done.
|
|
|
|
* \param L The Lua VM state.
|
|
|
|
* \param fmt The warning message.
|
|
|
|
*/
|
|
|
|
static inline void __attribute__ ((format(printf, 2, 3)))
|
|
|
|
luaA_warn(lua_State *L, const char *fmt, ...)
|
|
|
|
{
|
|
|
|
va_list ap;
|
|
|
|
luaL_where(L, 1);
|
|
|
|
fprintf(stderr, "%sW: ", lua_tostring(L, -1));
|
|
|
|
lua_pop(L, 1);
|
|
|
|
va_start(ap, fmt);
|
|
|
|
vfprintf(stderr, fmt, ap);
|
|
|
|
va_end(ap);
|
|
|
|
fprintf(stderr, "\n");
|
|
|
|
}
|
|
|
|
|
2009-04-18 18:50:55 +02:00
|
|
|
void luaA_init(xdgHandle *);
|
|
|
|
bool luaA_parserc(xdgHandle *, const char *, bool);
|
2008-10-19 19:14:55 +02:00
|
|
|
bool luaA_hasitem(lua_State *, const void *);
|
|
|
|
void luaA_table2wtable(lua_State *);
|
2008-10-27 14:17:12 +01:00
|
|
|
bool luaA_isloop(lua_State *, int);
|
2008-06-04 19:21:21 +02:00
|
|
|
|
2009-07-31 16:28:17 +02:00
|
|
|
/** Global signals */
|
|
|
|
signal_array_t global_signals;
|
|
|
|
|
2009-08-20 17:37:46 +02:00
|
|
|
int luaA_class_index_miss_property(lua_State *, lua_object_t *);
|
|
|
|
int luaA_class_newindex_miss_property(lua_State *, lua_object_t *);
|
|
|
|
|
2008-05-20 15:39:47 +02:00
|
|
|
#endif
|
|
|
|
// vim: filetype=c:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=80
|