2 * luaclass.h - useful functions for handling Lua classes
4 * Copyright © 2009 Julien Danjou <julien@danjou.info>
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.
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.
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.
22 #ifndef AWESOME_COMMON_LUACLASS
23 #define AWESOME_COMMON_LUACLASS
25 #include "common/signal.h"
27 typedef struct lua_class_property lua_class_property_t
;
29 ARRAY_TYPE(lua_class_property_t
, lua_class_property
)
31 #define LUA_OBJECT_HEADER \
32 signal_array_t signals;
34 /** Generic type for all objects.
35 * All Lua objects can be casted to this type.
42 typedef lua_object_t
*(*lua_class_allocator_t
)(lua_State
*);
43 typedef void (*lua_class_collector_t
)(lua_object_t
*);
45 typedef int (*lua_class_propfunc_t
)(lua_State
*, lua_object_t
*);
47 typedef bool (*lua_class_checker_t
)(lua_object_t
*);
49 typedef struct lua_class_t lua_class_t
;
55 signal_array_t signals
;
58 /** Allocator for creating new objects of that class */
59 lua_class_allocator_t allocator
;
60 /** Garbage collection function */
61 lua_class_collector_t collector
;
62 /** Class properties */
63 lua_class_property_array_t properties
;
64 /** Function to call when a indexing an unknown property */
65 lua_class_propfunc_t index_miss_property
;
66 /** Function to call when a indexing an unknown property */
67 lua_class_propfunc_t newindex_miss_property
;
68 /** Function to call to check if an object is valid */
69 lua_class_checker_t checker
;
70 /** Number of instances of this class in lua */
71 unsigned int instances
;
74 const char * luaA_typename(lua_State
*, int);
75 lua_class_t
* luaA_class_get(lua_State
*, int);
77 void luaA_class_connect_signal(lua_State
*, lua_class_t
*, const char *, lua_CFunction
);
78 void luaA_class_connect_signal_from_stack(lua_State
*, lua_class_t
*, const char *, int);
79 void luaA_class_disconnect_signal_from_stack(lua_State
*, lua_class_t
*, const char *, int);
80 void luaA_class_emit_signal(lua_State
*, lua_class_t
*, const char *, int);
82 void luaA_openlib(lua_State
*, const char *, const struct luaL_reg
[], const struct luaL_reg
[]);
83 void luaA_class_setup(lua_State
*, lua_class_t
*, const char *, lua_class_t
*,
84 lua_class_allocator_t
, lua_class_collector_t
,
86 lua_class_propfunc_t
, lua_class_propfunc_t
,
87 const struct luaL_reg
[], const struct luaL_reg
[]);
89 void luaA_class_add_property(lua_class_t
*, const char *,
90 lua_class_propfunc_t
, lua_class_propfunc_t
, lua_class_propfunc_t
);
92 int luaA_usemetatable(lua_State
*, int, int);
93 int luaA_class_index(lua_State
*);
94 int luaA_class_newindex(lua_State
*);
95 int luaA_class_new(lua_State
*, lua_class_t
*);
97 void * luaA_checkudata(lua_State
*, int, lua_class_t
*);
98 void * luaA_toudata(lua_State
*L
, int ud
, lua_class_t
*);
101 luaA_checkudataornil(lua_State
*L
, int udx
, lua_class_t
*class)
103 if(lua_isnil(L
, udx
))
105 return luaA_checkudata(L
, udx
, class);
108 #define LUA_CLASS_FUNCS(prefix, lua_class) \
110 luaA_##prefix##_class_add_signal(lua_State *L) \
112 signal_add(&(lua_class).signals, luaL_checkstring(L, 1)); \
117 luaA_##prefix##_class_connect_signal(lua_State *L) \
119 luaA_class_connect_signal_from_stack(L, &(lua_class), \
120 luaL_checkstring(L, 1), 2); \
125 luaA_##prefix##_class_disconnect_signal(lua_State *L) \
127 luaA_class_disconnect_signal_from_stack(L, &(lua_class), \
128 luaL_checkstring(L, 1), 2); \
133 luaA_##prefix##_class_emit_signal(lua_State *L) \
135 luaA_class_emit_signal(L, &(lua_class), luaL_checkstring(L, 1), \
136 lua_gettop(L) - 1); \
141 luaA_##prefix##_class_instances(lua_State *L) \
143 lua_pushnumber(L, (lua_class).instances); \
147 #define LUA_CLASS_METHODS(class) \
148 { "add_signal", luaA_##class##_class_add_signal }, \
149 { "connect_signal", luaA_##class##_class_connect_signal }, \
150 { "disconnect_signal", luaA_##class##_class_disconnect_signal }, \
151 { "emit_signal", luaA_##class##_class_emit_signal }, \
152 { "instances", luaA_##class##_class_instances }, \
154 #define LUA_CLASS_META \
155 { "__index", luaA_class_index }, \
156 { "__newindex", luaA_class_newindex },
160 // vim: filetype=c:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=80