2
** $Id: lobject.h,v 2.20.1.2 2008/08/06 13:29:48 roberto Exp $
3
** Type definitions for Lua objects
4
** See Copyright Notice in lua.h
19
/* tags for values visible from Lua */
20
#define LAST_TAG LUA_TTHREAD
22
#define NUM_TAGS (LAST_TAG+1)
26
** Extra tags for non-values
28
#define LUA_TPROTO (LAST_TAG+1)
29
#define LUA_TUPVAL (LAST_TAG+2)
30
#define LUA_TDEADKEY (LAST_TAG+3)
34
** Union of all collectable objects
36
typedef union GCObject GCObject;
40
** Common Header for all collectable objects (in macro form, to be
41
** included in other objects)
43
#define CommonHeader GCObject *next; lu_byte tt; lu_byte marked
47
** Common header in struct form
49
typedef struct GCheader {
57
** Union of all Lua values
71
#define TValuefields Value value; int tt
73
typedef struct lua_TValue {
78
/* Macros to test type */
79
#define ttisnil(o) (ttype(o) == LUA_TNIL)
80
#define ttisnumber(o) (ttype(o) == LUA_TNUMBER)
81
#define ttisstring(o) (ttype(o) == LUA_TSTRING)
82
#define ttistable(o) (ttype(o) == LUA_TTABLE)
83
#define ttisfunction(o) (ttype(o) == LUA_TFUNCTION)
84
#define ttisboolean(o) (ttype(o) == LUA_TBOOLEAN)
85
#define ttisuserdata(o) (ttype(o) == LUA_TUSERDATA)
86
#define ttisthread(o) (ttype(o) == LUA_TTHREAD)
87
#define ttislightuserdata(o) (ttype(o) == LUA_TLIGHTUSERDATA)
89
/* Macros to access values */
90
#define ttype(o) ((o)->tt)
91
#define gcvalue(o) check_exp(iscollectable(o), (o)->value.gc)
92
#define pvalue(o) check_exp(ttislightuserdata(o), (o)->value.p)
93
#define nvalue(o) check_exp(ttisnumber(o), (o)->value.n)
94
#define rawtsvalue(o) check_exp(ttisstring(o), &(o)->value.gc->ts)
95
#define tsvalue(o) (&rawtsvalue(o)->tsv)
96
#define rawuvalue(o) check_exp(ttisuserdata(o), &(o)->value.gc->u)
97
#define uvalue(o) (&rawuvalue(o)->uv)
98
#define clvalue(o) check_exp(ttisfunction(o), &(o)->value.gc->cl)
99
#define hvalue(o) check_exp(ttistable(o), &(o)->value.gc->h)
100
#define bvalue(o) check_exp(ttisboolean(o), (o)->value.b)
101
#define thvalue(o) check_exp(ttisthread(o), &(o)->value.gc->th)
103
#define l_isfalse(o) (ttisnil(o) || (ttisboolean(o) && bvalue(o) == 0))
106
** for internal debug only
108
#define checkconsistency(obj) \
109
lua_assert(!iscollectable(obj) || (ttype(obj) == (obj)->value.gc->gch.tt))
111
#define checkliveness(g,obj) \
112
lua_assert(!iscollectable(obj) || \
113
((ttype(obj) == (obj)->value.gc->gch.tt) && !isdead(g, (obj)->value.gc)))
116
/* Macros to set values */
117
#define setnilvalue(obj) ((obj)->tt=LUA_TNIL)
119
#define setnvalue(obj,x) \
120
{ TValue *i_o=(obj); i_o->value.n=(x); i_o->tt=LUA_TNUMBER; }
122
#define setpvalue(obj,x) \
123
{ TValue *i_o=(obj); i_o->value.p=(x); i_o->tt=LUA_TLIGHTUSERDATA; }
125
#define setbvalue(obj,x) \
126
{ TValue *i_o=(obj); i_o->value.b=(x); i_o->tt=LUA_TBOOLEAN; }
128
#define setsvalue(L,obj,x) \
129
{ TValue *i_o=(obj); \
130
i_o->value.gc=cast(GCObject *, (x)); i_o->tt=LUA_TSTRING; \
131
checkliveness(G(L),i_o); }
133
#define setuvalue(L,obj,x) \
134
{ TValue *i_o=(obj); \
135
i_o->value.gc=cast(GCObject *, (x)); i_o->tt=LUA_TUSERDATA; \
136
checkliveness(G(L),i_o); }
138
#define setthvalue(L,obj,x) \
139
{ TValue *i_o=(obj); \
140
i_o->value.gc=cast(GCObject *, (x)); i_o->tt=LUA_TTHREAD; \
141
checkliveness(G(L),i_o); }
143
#define setclvalue(L,obj,x) \
144
{ TValue *i_o=(obj); \
145
i_o->value.gc=cast(GCObject *, (x)); i_o->tt=LUA_TFUNCTION; \
146
checkliveness(G(L),i_o); }
148
#define sethvalue(L,obj,x) \
149
{ TValue *i_o=(obj); \
150
i_o->value.gc=cast(GCObject *, (x)); i_o->tt=LUA_TTABLE; \
151
checkliveness(G(L),i_o); }
153
#define setptvalue(L,obj,x) \
154
{ TValue *i_o=(obj); \
155
i_o->value.gc=cast(GCObject *, (x)); i_o->tt=LUA_TPROTO; \
156
checkliveness(G(L),i_o); }
161
#define setobj(L,obj1,obj2) \
162
{ const TValue *o2=(obj2); TValue *o1=(obj1); \
163
o1->value = o2->value; o1->tt=o2->tt; \
164
checkliveness(G(L),o1); }
168
** different types of sets, according to destination
171
/* from stack to (same) stack */
172
#define setobjs2s setobj
173
/* to stack (not from same stack) */
174
#define setobj2s setobj
175
#define setsvalue2s setsvalue
176
#define sethvalue2s sethvalue
177
#define setptvalue2s setptvalue
178
/* from table to same table */
179
#define setobjt2t setobj
181
#define setobj2t setobj
183
#define setobj2n setobj
184
#define setsvalue2n setsvalue
186
#define setttype(obj, tt) (ttype(obj) = (tt))
189
#define iscollectable(o) (ttype(o) >= LUA_TSTRING)
193
typedef TValue *StkId; /* index to stack elements */
197
** String headers for string table
199
typedef union TString {
200
L_Umaxalign dummy; /* ensures maximum alignment for strings */
210
#define getstr(ts) cast(const char *, (ts) + 1)
211
#define svalue(o) getstr(rawtsvalue(o))
215
typedef union Udata {
216
L_Umaxalign dummy; /* ensures maximum alignment for `local' udata */
219
struct Table *metatable;
229
** Function Prototypes
231
typedef struct Proto {
233
TValue *k; /* constants used by the function */
235
struct Proto **p; /* functions defined inside the function */
236
int *lineinfo; /* map from opcodes to source lines */
237
struct LocVar *locvars; /* information about local variables */
238
TString **upvalues; /* upvalue names */
241
int sizek; /* size of `k' */
244
int sizep; /* size of `p' */
249
lu_byte nups; /* number of upvalues */
252
lu_byte maxstacksize;
256
/* masks for new-style vararg */
257
#define VARARG_HASARG 1
258
#define VARARG_ISVARARG 2
259
#define VARARG_NEEDSARG 4
262
typedef struct LocVar {
264
int startpc; /* first point where variable is active */
265
int endpc; /* first point where variable is dead */
274
typedef struct UpVal {
276
TValue *v; /* points to stack or to its own value */
278
TValue value; /* the value (when closed) */
279
struct { /* double linked list (when open) */
291
#define ClosureHeader \
292
CommonHeader; lu_byte isC; lu_byte nupvalues; GCObject *gclist; \
295
typedef struct CClosure {
302
typedef struct LClosure {
309
typedef union Closure {
315
#define iscfunction(o) (ttype(o) == LUA_TFUNCTION && clvalue(o)->c.isC)
316
#define isLfunction(o) (ttype(o) == LUA_TFUNCTION && !clvalue(o)->c.isC)
326
struct Node *next; /* for chaining */
332
typedef struct Node {
338
typedef struct Table {
340
lu_byte flags; /* 1<<p means tagmethod(p) is not present */
341
lu_byte lsizenode; /* log2 of size of `node' array */
342
struct Table *metatable;
343
TValue *array; /* array part */
345
Node *lastfree; /* any free position is before this position */
347
int sizearray; /* size of `array' array */
353
** `module' operation for hashing (size is always a power of 2)
355
#define lmod(s,size) \
356
(check_exp((size&(size-1))==0, (cast(int, (s) & ((size)-1)))))
359
#define twoto(x) (1<<(x))
360
#define sizenode(t) (twoto((t)->lsizenode))
363
#define luaO_nilobject (&luaO_nilobject_)
365
LUAI_DATA const TValue luaO_nilobject_;
367
#define ceillog2(x) (luaO_log2((x)-1) + 1)
369
LUAI_FUNC int luaO_log2 (unsigned int x);
370
LUAI_FUNC int luaO_int2fb (unsigned int x);
371
LUAI_FUNC int luaO_fb2int (int x);
372
LUAI_FUNC int luaO_rawequalObj (const TValue *t1, const TValue *t2);
373
LUAI_FUNC int luaO_str2d (const char *s, lua_Number *result);
374
LUAI_FUNC const char *luaO_pushvfstring (lua_State *L, const char *fmt,
376
LUAI_FUNC const char *luaO_pushfstring (lua_State *L, const char *fmt, ...);
377
LUAI_FUNC void luaO_chunkid (char *out, const char *source, size_t len);