File: luaobject.h

package info (click to toggle)
luakit 2012.09.13-r1-8
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 1,160 kB
  • ctags: 1,276
  • sloc: ansic: 6,086; makefile: 153; ruby: 79; sh: 38
file content (188 lines) | stat: -rw-r--r-- 6,825 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
/*
 * luaobject.h - useful functions for handling Lua objects
 *
 * Copyright © 2010 Mason Larobina <mason.larobina@gmail.com>
 * Copyright © 2009 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 3 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, see <http://www.gnu.org/licenses/>.
 *
 */

#ifndef LUAKIT_COMMON_LUAOBJECT_H
#define LUAKIT_COMMON_LUAOBJECT_H

#include "common/luaclass.h"
#include "common/lualib.h"
#include "common/signal.h"
#include "globalconf.h"

gint luaH_settype(lua_State *L, lua_class_t *lua_class);
void luaH_object_setup(lua_State *L);
gpointer luaH_object_incref(lua_State *L, gint tud, gint oud);
void luaH_object_decref(lua_State *L, gint tud, gpointer oud);

/* Store an item in the environment table of an object.
 * Removes the stored object from the stack.
 * `ud` is the index of the object on the stack.
 * `iud` is the index of the item on the stack.
 * Return the item reference. */
static inline gpointer
luaH_object_ref_item(lua_State *L, gint ud, gint iud) {
    /* Get the env table from the object */
    lua_getfenv(L, ud);
    gpointer p = luaH_object_incref(L, -1, iud < 0 ? iud - 1 : iud);
    /* Remove env table */
    lua_pop(L, 1);
    return p;
}

/* Unref an item from the environment table of an object.
 * `ud` is the index of the object on the stack.
 * `p` is the item. */
static inline void
luaH_object_unref_item(lua_State *L, gint ud, gpointer p) {
    /* Get the env table from the object */
    lua_getfenv(L, ud);
    /* Decrement */
    luaH_object_decref(L, -1, p);
    /* Remove env table */
    lua_pop(L, 1);
}

/* Push an object item on the stack.
 * `ud` is the object index on the stack.
 * `p` is the item pointer.
 * Returns the number of element pushed on stack. */
static inline gint
luaH_object_push_item(lua_State *L, gint ud, gpointer p) {
    /* Get env table of the object */
    lua_getfenv(L, ud);
    /* Push key */
    lua_pushlightuserdata(L, p);
    /* Get env.pointer */
    lua_rawget(L, -2);
    /* Remove env table */
    lua_remove(L, -2);
    return 1;
}

static inline void
luaH_object_registry_push(lua_State *L) {
    lua_pushliteral(L, LUAKIT_OBJECT_REGISTRY_KEY);
    lua_rawget(L, LUA_REGISTRYINDEX);
}

/* Reference an object and return a pointer to it. That only works with
 * userdata, table, thread or function.
 * Removes the referenced object from the stack.
 * `oud` is the object index on the stack.
 * Returns the object reference, or NULL if not referenceable. */
static inline gpointer
luaH_object_ref(lua_State *L, gint oud) {
    luaH_object_registry_push(L);
    gpointer p = luaH_object_incref(L, -1, oud < 0 ? oud - 1 : oud);
    lua_pop(L, 1);
    return p;
}

/* Reference an object and return a pointer to it checking its type. That only
 * works with userdata.
 * `oud` is the object index on the stack.
 * `class` is the class of object expected
 * Return the object reference, or NULL if not referenceable. */
static inline gpointer
luaH_object_ref_class(lua_State *L, gint oud, lua_class_t *class) {
    luaH_checkudata(L, oud, class);
    return luaH_object_ref(L, oud);
}

/* Unreference an object and return a pointer to it. That only works with
 * userdata, table, thread or function.
 * `oud` is the object index on the stack. */
static inline void
luaH_object_unref(lua_State *L, gpointer p) {
    luaH_object_registry_push(L);
    luaH_object_decref(L, -1, p);
    lua_pop(L, 1);
}

/* Push a referenced object onto the stack.
 * `p` is the object to push.
 * Returns is the number of element pushed on stack.
 */
static inline gint
luaH_object_push(lua_State *L, gpointer p) {
    luaH_object_registry_push(L);
    lua_pushlightuserdata(L, p);
    lua_rawget(L, -2);
    lua_remove(L, -2);
    return 1;
}

gint signal_object_emit(lua_State *, signal_t *signals,
        const gchar *name, gint nargs, gint nret);
void luaH_object_add_signal(lua_State *L, gint oud,
        const gchar *name, gint ud);
void luaH_object_remove_signal(lua_State *L, gint oud,
        const gchar *name , gint ud);
gint luaH_object_emit_signal(lua_State *L, gint oud,
        const gchar *name, gint nargs, gint nret);

gint luaH_object_add_signal_simple(lua_State *L);
gint luaH_object_remove_signal_simple(lua_State *L);
gint luaH_object_emit_signal_simple(lua_State *L);
gint luaH_object_property_signal(lua_State *, gint, luakit_token_t);

#define LUA_OBJECT_FUNCS(lua_class, type, prefix)             \
    LUA_CLASS_FUNCS(prefix, lua_class)                        \
    static inline type *                                      \
    prefix##_new(lua_State *L) {                              \
        type *p = lua_newuserdata(L, sizeof(type));           \
        p_clear(p, 1);                                        \
        p->signals = signal_new();                            \
        luaH_settype(L, &(lua_class));                        \
        lua_newtable(L);                                      \
        lua_newtable(L);                                      \
        lua_setmetatable(L, -2);                              \
        lua_setfenv(L, -2);                                   \
        lua_pushvalue(L, -1);                                 \
        luaH_class_emit_signal(L, &(lua_class), "new", 1, 0); \
        return p;                                             \
    }

#define OBJECT_EXPORT_PROPERTY(pfx, type, field) \
    fieldtypeof(type, field)                     \
    pfx##_get_##field(type *object) {            \
        return object->field;                    \
    }

#define LUA_OBJECT_EXPORT_PROPERTY(pfx, type, field, pusher) \
    static gint                                              \
    luaH_##pfx##_get_##field(lua_State *L, type *object) {   \
        pusher(L, object->field);                            \
        return 1;                                            \
    }

gint luaH_object_tostring(lua_State *);
gint luaH_object_gc(lua_State *);

#define LUA_OBJECT_META(prefix)                            \
    { "__tostring", luaH_object_tostring },                \
    { "add_signal", luaH_object_add_signal_simple },       \
    { "remove_signal", luaH_object_remove_signal_simple }, \
    { "emit_signal", luaH_object_emit_signal_simple },

#endif

// vim: ft=c:et:sw=4:ts=8:sts=4:tw=80