lobject.h 8.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381
  1. /*
  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
  5. */
  6. #ifndef lobject_h
  7. #define lobject_h
  8. #include <stdarg.h>
  9. #include "llimits.h"
  10. #include "lua.h"
  11. /* tags for values visible from Lua */
  12. #define LAST_TAG LUA_TTHREAD
  13. #define NUM_TAGS (LAST_TAG+1)
  14. /*
  15. ** Extra tags for non-values
  16. */
  17. #define LUA_TPROTO (LAST_TAG+1)
  18. #define LUA_TUPVAL (LAST_TAG+2)
  19. #define LUA_TDEADKEY (LAST_TAG+3)
  20. /*
  21. ** Union of all collectable objects
  22. */
  23. typedef union GCObject GCObject;
  24. /*
  25. ** Common Header for all collectable objects (in macro form, to be
  26. ** included in other objects)
  27. */
  28. #define CommonHeader GCObject *next; lu_byte tt; lu_byte marked
  29. /*
  30. ** Common header in struct form
  31. */
  32. typedef struct GCheader {
  33. CommonHeader;
  34. } GCheader;
  35. /*
  36. ** Union of all Lua values
  37. */
  38. typedef union {
  39. GCObject *gc;
  40. void *p;
  41. lua_Number n;
  42. int b;
  43. } Value;
  44. /*
  45. ** Tagged Values
  46. */
  47. #define TValuefields Value value; int tt
  48. typedef struct lua_TValue {
  49. TValuefields;
  50. } TValue;
  51. /* Macros to test type */
  52. #define ttisnil(o) (ttype(o) == LUA_TNIL)
  53. #define ttisnumber(o) (ttype(o) == LUA_TNUMBER)
  54. #define ttisstring(o) (ttype(o) == LUA_TSTRING)
  55. #define ttistable(o) (ttype(o) == LUA_TTABLE)
  56. #define ttisfunction(o) (ttype(o) == LUA_TFUNCTION)
  57. #define ttisboolean(o) (ttype(o) == LUA_TBOOLEAN)
  58. #define ttisuserdata(o) (ttype(o) == LUA_TUSERDATA)
  59. #define ttisthread(o) (ttype(o) == LUA_TTHREAD)
  60. #define ttislightuserdata(o) (ttype(o) == LUA_TLIGHTUSERDATA)
  61. /* Macros to access values */
  62. #define ttype(o) ((o)->tt)
  63. #define gcvalue(o) check_exp(iscollectable(o), (o)->value.gc)
  64. #define pvalue(o) check_exp(ttislightuserdata(o), (o)->value.p)
  65. #define nvalue(o) check_exp(ttisnumber(o), (o)->value.n)
  66. #define rawtsvalue(o) check_exp(ttisstring(o), &(o)->value.gc->ts)
  67. #define tsvalue(o) (&rawtsvalue(o)->tsv)
  68. #define rawuvalue(o) check_exp(ttisuserdata(o), &(o)->value.gc->u)
  69. #define uvalue(o) (&rawuvalue(o)->uv)
  70. #define clvalue(o) check_exp(ttisfunction(o), &(o)->value.gc->cl)
  71. #define hvalue(o) check_exp(ttistable(o), &(o)->value.gc->h)
  72. #define bvalue(o) check_exp(ttisboolean(o), (o)->value.b)
  73. #define thvalue(o) check_exp(ttisthread(o), &(o)->value.gc->th)
  74. #define l_isfalse(o) (ttisnil(o) || (ttisboolean(o) && bvalue(o) == 0))
  75. /*
  76. ** for internal debug only
  77. */
  78. #define checkconsistency(obj) \
  79. lua_assert(!iscollectable(obj) || (ttype(obj) == (obj)->value.gc->gch.tt))
  80. #define checkliveness(g,obj) \
  81. lua_assert(!iscollectable(obj) || \
  82. ((ttype(obj) == (obj)->value.gc->gch.tt) && !isdead(g, (obj)->value.gc)))
  83. /* Macros to set values */
  84. #define setnilvalue(obj) ((obj)->tt=LUA_TNIL)
  85. #define setnvalue(obj,x) \
  86. { TValue *i_o=(obj); i_o->value.n=(x); i_o->tt=LUA_TNUMBER; }
  87. #define setpvalue(obj,x) \
  88. { TValue *i_o=(obj); i_o->value.p=(x); i_o->tt=LUA_TLIGHTUSERDATA; }
  89. #define setbvalue(obj,x) \
  90. { TValue *i_o=(obj); i_o->value.b=(x); i_o->tt=LUA_TBOOLEAN; }
  91. #define setsvalue(L,obj,x) \
  92. { TValue *i_o=(obj); \
  93. i_o->value.gc=cast(GCObject *, (x)); i_o->tt=LUA_TSTRING; \
  94. checkliveness(G(L),i_o); }
  95. #define setuvalue(L,obj,x) \
  96. { TValue *i_o=(obj); \
  97. i_o->value.gc=cast(GCObject *, (x)); i_o->tt=LUA_TUSERDATA; \
  98. checkliveness(G(L),i_o); }
  99. #define setthvalue(L,obj,x) \
  100. { TValue *i_o=(obj); \
  101. i_o->value.gc=cast(GCObject *, (x)); i_o->tt=LUA_TTHREAD; \
  102. checkliveness(G(L),i_o); }
  103. #define setclvalue(L,obj,x) \
  104. { TValue *i_o=(obj); \
  105. i_o->value.gc=cast(GCObject *, (x)); i_o->tt=LUA_TFUNCTION; \
  106. checkliveness(G(L),i_o); }
  107. #define sethvalue(L,obj,x) \
  108. { TValue *i_o=(obj); \
  109. i_o->value.gc=cast(GCObject *, (x)); i_o->tt=LUA_TTABLE; \
  110. checkliveness(G(L),i_o); }
  111. #define setptvalue(L,obj,x) \
  112. { TValue *i_o=(obj); \
  113. i_o->value.gc=cast(GCObject *, (x)); i_o->tt=LUA_TPROTO; \
  114. checkliveness(G(L),i_o); }
  115. #define setobj(L,obj1,obj2) \
  116. { const TValue *o2=(obj2); TValue *o1=(obj1); \
  117. o1->value = o2->value; o1->tt=o2->tt; \
  118. checkliveness(G(L),o1); }
  119. /*
  120. ** different types of sets, according to destination
  121. */
  122. /* from stack to (same) stack */
  123. #define setobjs2s setobj
  124. /* to stack (not from same stack) */
  125. #define setobj2s setobj
  126. #define setsvalue2s setsvalue
  127. #define sethvalue2s sethvalue
  128. #define setptvalue2s setptvalue
  129. /* from table to same table */
  130. #define setobjt2t setobj
  131. /* to table */
  132. #define setobj2t setobj
  133. /* to new object */
  134. #define setobj2n setobj
  135. #define setsvalue2n setsvalue
  136. #define setttype(obj, tt) (ttype(obj) = (tt))
  137. #define iscollectable(o) (ttype(o) >= LUA_TSTRING)
  138. typedef TValue *StkId; /* index to stack elements */
  139. /*
  140. ** String headers for string table
  141. */
  142. typedef union TString {
  143. L_Umaxalign dummy; /* ensures maximum alignment for strings */
  144. struct {
  145. CommonHeader;
  146. lu_byte reserved;
  147. unsigned int hash;
  148. size_t len;
  149. } tsv;
  150. } TString;
  151. #define getstr(ts) cast(const char *, (ts) + 1)
  152. #define svalue(o) getstr(rawtsvalue(o))
  153. typedef union Udata {
  154. L_Umaxalign dummy; /* ensures maximum alignment for `local' udata */
  155. struct {
  156. CommonHeader;
  157. struct Table *metatable;
  158. struct Table *env;
  159. size_t len;
  160. } uv;
  161. } Udata;
  162. /*
  163. ** Function Prototypes
  164. */
  165. typedef struct Proto {
  166. CommonHeader;
  167. TValue *k; /* constants used by the function */
  168. Instruction *code;
  169. struct Proto **p; /* functions defined inside the function */
  170. int *lineinfo; /* map from opcodes to source lines */
  171. struct LocVar *locvars; /* information about local variables */
  172. TString **upvalues; /* upvalue names */
  173. TString *source;
  174. int sizeupvalues;
  175. int sizek; /* size of `k' */
  176. int sizecode;
  177. int sizelineinfo;
  178. int sizep; /* size of `p' */
  179. int sizelocvars;
  180. int linedefined;
  181. int lastlinedefined;
  182. GCObject *gclist;
  183. lu_byte nups; /* number of upvalues */
  184. lu_byte numparams;
  185. lu_byte is_vararg;
  186. lu_byte maxstacksize;
  187. } Proto;
  188. /* masks for new-style vararg */
  189. #define VARARG_HASARG 1
  190. #define VARARG_ISVARARG 2
  191. #define VARARG_NEEDSARG 4
  192. typedef struct LocVar {
  193. TString *varname;
  194. int startpc; /* first point where variable is active */
  195. int endpc; /* first point where variable is dead */
  196. } LocVar;
  197. /*
  198. ** Upvalues
  199. */
  200. typedef struct UpVal {
  201. CommonHeader;
  202. TValue *v; /* points to stack or to its own value */
  203. union {
  204. TValue value; /* the value (when closed) */
  205. struct { /* double linked list (when open) */
  206. struct UpVal *prev;
  207. struct UpVal *next;
  208. } l;
  209. } u;
  210. } UpVal;
  211. /*
  212. ** Closures
  213. */
  214. #define ClosureHeader \
  215. CommonHeader; lu_byte isC; lu_byte nupvalues; GCObject *gclist; \
  216. struct Table *env
  217. typedef struct CClosure {
  218. ClosureHeader;
  219. lua_CFunction f;
  220. TValue upvalue[1];
  221. } CClosure;
  222. typedef struct LClosure {
  223. ClosureHeader;
  224. struct Proto *p;
  225. UpVal *upvals[1];
  226. } LClosure;
  227. typedef union Closure {
  228. CClosure c;
  229. LClosure l;
  230. } Closure;
  231. #define iscfunction(o) (ttype(o) == LUA_TFUNCTION && clvalue(o)->c.isC)
  232. #define isLfunction(o) (ttype(o) == LUA_TFUNCTION && !clvalue(o)->c.isC)
  233. /*
  234. ** Tables
  235. */
  236. typedef union TKey {
  237. struct {
  238. TValuefields;
  239. struct Node *next; /* for chaining */
  240. } nk;
  241. TValue tvk;
  242. } TKey;
  243. typedef struct Node {
  244. TValue i_val;
  245. TKey i_key;
  246. } Node;
  247. typedef struct Table {
  248. CommonHeader;
  249. lu_byte flags; /* 1<<p means tagmethod(p) is not present */
  250. lu_byte lsizenode; /* log2 of size of `node' array */
  251. struct Table *metatable;
  252. TValue *array; /* array part */
  253. Node *node;
  254. Node *lastfree; /* any free position is before this position */
  255. GCObject *gclist;
  256. int sizearray; /* size of `array' array */
  257. } Table;
  258. /*
  259. ** `module' operation for hashing (size is always a power of 2)
  260. */
  261. #define lmod(s,size) \
  262. (check_exp((size&(size-1))==0, (cast(int, (s) & ((size)-1)))))
  263. #define twoto(x) (1<<(x))
  264. #define sizenode(t) (twoto((t)->lsizenode))
  265. #define luaO_nilobject (&luaO_nilobject_)
  266. LUAI_DATA const TValue luaO_nilobject_;
  267. #define ceillog2(x) (luaO_log2((x)-1) + 1)
  268. LUAI_FUNC int luaO_log2 (unsigned int x);
  269. LUAI_FUNC int luaO_int2fb (unsigned int x);
  270. LUAI_FUNC int luaO_fb2int (int x);
  271. LUAI_FUNC int luaO_rawequalObj (const TValue *t1, const TValue *t2);
  272. LUAI_FUNC int luaO_str2d (const char *s, lua_Number *result);
  273. LUAI_FUNC const char *luaO_pushvfstring (lua_State *L, const char *fmt,
  274. va_list argp);
  275. LUAI_FUNC const char *luaO_pushfstring (lua_State *L, const char *fmt, ...);
  276. LUAI_FUNC void luaO_chunkid (char *out, const char *source, size_t len);
  277. #endif