lobject.h 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813
  1. /*
  2. ** $Id: lobject.h $
  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. /*
  12. ** Extra types for collectable non-values
  13. */
  14. #define LUA_TUPVAL LUA_NUMTYPES /* upvalues */
  15. #define LUA_TPROTO (LUA_NUMTYPES+1) /* function prototypes */
  16. #define LUA_TDEADKEY (LUA_NUMTYPES+2) /* removed keys in tables */
  17. /*
  18. ** number of all possible types (including LUA_TNONE but excluding DEADKEY)
  19. */
  20. #define LUA_TOTALTYPES (LUA_TPROTO + 2)
  21. /*
  22. ** tags for Tagged Values have the following use of bits:
  23. ** bits 0-3: actual tag (a LUA_T* constant)
  24. ** bits 4-5: variant bits
  25. ** bit 6: whether value is collectable
  26. */
  27. /* add variant bits to a type */
  28. #define makevariant(t,v) ((t) | ((v) << 4))
  29. /*
  30. ** Union of all Lua values
  31. */
  32. typedef union Value {
  33. struct GCObject *gc; /* collectable objects */
  34. void *p; /* light userdata */
  35. lua_CFunction f; /* light C functions */
  36. lua_Integer i; /* integer numbers */
  37. lua_Number n; /* float numbers */
  38. /* not used, but may avoid warnings for uninitialized value */
  39. lu_byte ub;
  40. } Value;
  41. /*
  42. ** Tagged Values. This is the basic representation of values in Lua:
  43. ** an actual value plus a tag with its type.
  44. */
  45. #define TValuefields Value value_; lu_byte tt_
  46. typedef struct TValue {
  47. TValuefields;
  48. } TValue;
  49. #define val_(o) ((o)->value_)
  50. #define valraw(o) (val_(o))
  51. /* raw type tag of a TValue */
  52. #define rawtt(o) ((o)->tt_)
  53. /* tag with no variants (bits 0-3) */
  54. #define novariant(t) ((t) & 0x0F)
  55. /* type tag of a TValue (bits 0-3 for tags + variant bits 4-5) */
  56. #define withvariant(t) ((t) & 0x3F)
  57. #define ttypetag(o) withvariant(rawtt(o))
  58. /* type of a TValue */
  59. #define ttype(o) (novariant(rawtt(o)))
  60. /* Macros to test type */
  61. #define checktag(o,t) (rawtt(o) == (t))
  62. #define checktype(o,t) (ttype(o) == (t))
  63. /* Macros for internal tests */
  64. /* collectable object has the same tag as the original value */
  65. #define righttt(obj) (ttypetag(obj) == gcvalue(obj)->tt)
  66. /*
  67. ** Any value being manipulated by the program either is non
  68. ** collectable, or the collectable object has the right tag
  69. ** and it is not dead. The option 'L == NULL' allows other
  70. ** macros using this one to be used where L is not available.
  71. */
  72. #define checkliveness(L,obj) \
  73. ((void)L, lua_longassert(!iscollectable(obj) || \
  74. (righttt(obj) && (L == NULL || !isdead(G(L),gcvalue(obj))))))
  75. /* Macros to set values */
  76. /* set a value's tag */
  77. #define settt_(o,t) ((o)->tt_=(t))
  78. /* main macro to copy values (from 'obj2' to 'obj1') */
  79. #define setobj(L,obj1,obj2) \
  80. { TValue *io1=(obj1); const TValue *io2=(obj2); \
  81. io1->value_ = io2->value_; settt_(io1, io2->tt_); \
  82. checkliveness(L,io1); lua_assert(!isnonstrictnil(io1)); }
  83. /*
  84. ** Different types of assignments, according to source and destination.
  85. ** (They are mostly equal now, but may be different in the future.)
  86. */
  87. /* from stack to stack */
  88. #define setobjs2s(L,o1,o2) setobj(L,s2v(o1),s2v(o2))
  89. /* to stack (not from same stack) */
  90. #define setobj2s(L,o1,o2) setobj(L,s2v(o1),o2)
  91. /* from table to same table */
  92. #define setobjt2t setobj
  93. /* to new object */
  94. #define setobj2n setobj
  95. /* to table */
  96. #define setobj2t setobj
  97. /*
  98. ** Entries in a Lua stack. Field 'tbclist' forms a list of all
  99. ** to-be-closed variables active in this stack. Dummy entries are
  100. ** used when the distance between two tbc variables does not fit
  101. ** in an unsigned short. They are represented by delta==0, and
  102. ** their real delta is always the maximum value that fits in
  103. ** that field.
  104. */
  105. typedef union StackValue {
  106. TValue val;
  107. struct {
  108. TValuefields;
  109. unsigned short delta;
  110. } tbclist;
  111. } StackValue;
  112. /* index to stack elements */
  113. typedef StackValue *StkId;
  114. /*
  115. ** When reallocating the stack, change all pointers to the stack into
  116. ** proper offsets.
  117. */
  118. typedef union {
  119. StkId p; /* actual pointer */
  120. ptrdiff_t offset; /* used while the stack is being reallocated */
  121. } StkIdRel;
  122. /* convert a 'StackValue' to a 'TValue' */
  123. #define s2v(o) (&(o)->val)
  124. /*
  125. ** {==================================================================
  126. ** Nil
  127. ** ===================================================================
  128. */
  129. /* Standard nil */
  130. #define LUA_VNIL makevariant(LUA_TNIL, 0)
  131. /* Empty slot (which might be different from a slot containing nil) */
  132. #define LUA_VEMPTY makevariant(LUA_TNIL, 1)
  133. /* Value returned for a key not found in a table (absent key) */
  134. #define LUA_VABSTKEY makevariant(LUA_TNIL, 2)
  135. /* macro to test for (any kind of) nil */
  136. #define ttisnil(v) checktype((v), LUA_TNIL)
  137. /* macro to test for a standard nil */
  138. #define ttisstrictnil(o) checktag((o), LUA_VNIL)
  139. #define setnilvalue(obj) settt_(obj, LUA_VNIL)
  140. #define isabstkey(v) checktag((v), LUA_VABSTKEY)
  141. /*
  142. ** macro to detect non-standard nils (used only in assertions)
  143. */
  144. #define isnonstrictnil(v) (ttisnil(v) && !ttisstrictnil(v))
  145. /*
  146. ** By default, entries with any kind of nil are considered empty.
  147. ** (In any definition, values associated with absent keys must also
  148. ** be accepted as empty.)
  149. */
  150. #define isempty(v) ttisnil(v)
  151. /* macro defining a value corresponding to an absent key */
  152. #define ABSTKEYCONSTANT {NULL}, LUA_VABSTKEY
  153. /* mark an entry as empty */
  154. #define setempty(v) settt_(v, LUA_VEMPTY)
  155. /* }================================================================== */
  156. /*
  157. ** {==================================================================
  158. ** Booleans
  159. ** ===================================================================
  160. */
  161. #define LUA_VFALSE makevariant(LUA_TBOOLEAN, 0)
  162. #define LUA_VTRUE makevariant(LUA_TBOOLEAN, 1)
  163. #define ttisboolean(o) checktype((o), LUA_TBOOLEAN)
  164. #define ttisfalse(o) checktag((o), LUA_VFALSE)
  165. #define ttistrue(o) checktag((o), LUA_VTRUE)
  166. #define l_isfalse(o) (ttisfalse(o) || ttisnil(o))
  167. #define setbfvalue(obj) settt_(obj, LUA_VFALSE)
  168. #define setbtvalue(obj) settt_(obj, LUA_VTRUE)
  169. /* }================================================================== */
  170. /*
  171. ** {==================================================================
  172. ** Threads
  173. ** ===================================================================
  174. */
  175. #define LUA_VTHREAD makevariant(LUA_TTHREAD, 0)
  176. #define ttisthread(o) checktag((o), ctb(LUA_VTHREAD))
  177. #define thvalue(o) check_exp(ttisthread(o), gco2th(val_(o).gc))
  178. #define setthvalue(L,obj,x) \
  179. { TValue *io = (obj); lua_State *x_ = (x); \
  180. val_(io).gc = obj2gco(x_); settt_(io, ctb(LUA_VTHREAD)); \
  181. checkliveness(L,io); }
  182. #define setthvalue2s(L,o,t) setthvalue(L,s2v(o),t)
  183. /* }================================================================== */
  184. /*
  185. ** {==================================================================
  186. ** Collectable Objects
  187. ** ===================================================================
  188. */
  189. /*
  190. ** Common Header for all collectable objects (in macro form, to be
  191. ** included in other objects)
  192. */
  193. #define CommonHeader struct GCObject *next; lu_byte tt; lu_byte marked
  194. /* Common type for all collectable objects */
  195. typedef struct GCObject {
  196. CommonHeader;
  197. } GCObject;
  198. /* Bit mark for collectable types */
  199. #define BIT_ISCOLLECTABLE (1 << 6)
  200. #define iscollectable(o) (rawtt(o) & BIT_ISCOLLECTABLE)
  201. /* mark a tag as collectable */
  202. #define ctb(t) ((t) | BIT_ISCOLLECTABLE)
  203. #define gcvalue(o) check_exp(iscollectable(o), val_(o).gc)
  204. #define gcvalueraw(v) ((v).gc)
  205. #define setgcovalue(L,obj,x) \
  206. { TValue *io = (obj); GCObject *i_g=(x); \
  207. val_(io).gc = i_g; settt_(io, ctb(i_g->tt)); }
  208. /* }================================================================== */
  209. /*
  210. ** {==================================================================
  211. ** Numbers
  212. ** ===================================================================
  213. */
  214. /* Variant tags for numbers */
  215. #define LUA_VNUMINT makevariant(LUA_TNUMBER, 0) /* integer numbers */
  216. #define LUA_VNUMFLT makevariant(LUA_TNUMBER, 1) /* float numbers */
  217. #define ttisnumber(o) checktype((o), LUA_TNUMBER)
  218. #define ttisfloat(o) checktag((o), LUA_VNUMFLT)
  219. #define ttisinteger(o) checktag((o), LUA_VNUMINT)
  220. #define nvalue(o) check_exp(ttisnumber(o), \
  221. (ttisinteger(o) ? cast_num(ivalue(o)) : fltvalue(o)))
  222. #define fltvalue(o) check_exp(ttisfloat(o), val_(o).n)
  223. #define ivalue(o) check_exp(ttisinteger(o), val_(o).i)
  224. #define fltvalueraw(v) ((v).n)
  225. #define ivalueraw(v) ((v).i)
  226. #define setfltvalue(obj,x) \
  227. { TValue *io=(obj); val_(io).n=(x); settt_(io, LUA_VNUMFLT); }
  228. #define chgfltvalue(obj,x) \
  229. { TValue *io=(obj); lua_assert(ttisfloat(io)); val_(io).n=(x); }
  230. #define setivalue(obj,x) \
  231. { TValue *io=(obj); val_(io).i=(x); settt_(io, LUA_VNUMINT); }
  232. #define chgivalue(obj,x) \
  233. { TValue *io=(obj); lua_assert(ttisinteger(io)); val_(io).i=(x); }
  234. /* }================================================================== */
  235. /*
  236. ** {==================================================================
  237. ** Strings
  238. ** ===================================================================
  239. */
  240. /* Variant tags for strings */
  241. #define LUA_VSHRSTR makevariant(LUA_TSTRING, 0) /* short strings */
  242. #define LUA_VLNGSTR makevariant(LUA_TSTRING, 1) /* long strings */
  243. #define ttisstring(o) checktype((o), LUA_TSTRING)
  244. #define ttisshrstring(o) checktag((o), ctb(LUA_VSHRSTR))
  245. #define ttislngstring(o) checktag((o), ctb(LUA_VLNGSTR))
  246. #define tsvalueraw(v) (gco2ts((v).gc))
  247. #define tsvalue(o) check_exp(ttisstring(o), gco2ts(val_(o).gc))
  248. #define setsvalue(L,obj,x) \
  249. { TValue *io = (obj); TString *x_ = (x); \
  250. val_(io).gc = obj2gco(x_); settt_(io, ctb(x_->tt)); \
  251. checkliveness(L,io); }
  252. /* set a string to the stack */
  253. #define setsvalue2s(L,o,s) setsvalue(L,s2v(o),s)
  254. /* set a string to a new object */
  255. #define setsvalue2n setsvalue
  256. /*
  257. ** Header for a string value.
  258. */
  259. typedef struct TString {
  260. CommonHeader;
  261. lu_byte extra; /* reserved words for short strings; "has hash" for longs */
  262. lu_byte shrlen; /* length for short strings, 0xFF for long strings */
  263. unsigned int hash;
  264. union {
  265. size_t lnglen; /* length for long strings */
  266. struct TString *hnext; /* linked list for hash table */
  267. } u;
  268. char contents[1];
  269. } TString;
  270. /*
  271. ** Get the actual string (array of bytes) from a 'TString'. (Generic
  272. ** version and specialized versions for long and short strings.)
  273. */
  274. #define getstr(ts) ((ts)->contents)
  275. #define getlngstr(ts) check_exp((ts)->shrlen == 0xFF, (ts)->contents)
  276. #define getshrstr(ts) check_exp((ts)->shrlen != 0xFF, (ts)->contents)
  277. /* get string length from 'TString *s' */
  278. #define tsslen(s) \
  279. ((s)->shrlen != 0xFF ? (s)->shrlen : (s)->u.lnglen)
  280. /* }================================================================== */
  281. /*
  282. ** {==================================================================
  283. ** Userdata
  284. ** ===================================================================
  285. */
  286. /*
  287. ** Light userdata should be a variant of userdata, but for compatibility
  288. ** reasons they are also different types.
  289. */
  290. #define LUA_VLIGHTUSERDATA makevariant(LUA_TLIGHTUSERDATA, 0)
  291. #define LUA_VUSERDATA makevariant(LUA_TUSERDATA, 0)
  292. #define ttislightuserdata(o) checktag((o), LUA_VLIGHTUSERDATA)
  293. #define ttisfulluserdata(o) checktag((o), ctb(LUA_VUSERDATA))
  294. #define pvalue(o) check_exp(ttislightuserdata(o), val_(o).p)
  295. #define uvalue(o) check_exp(ttisfulluserdata(o), gco2u(val_(o).gc))
  296. #define pvalueraw(v) ((v).p)
  297. #define setpvalue(obj,x) \
  298. { TValue *io=(obj); val_(io).p=(x); settt_(io, LUA_VLIGHTUSERDATA); }
  299. #define setuvalue(L,obj,x) \
  300. { TValue *io = (obj); Udata *x_ = (x); \
  301. val_(io).gc = obj2gco(x_); settt_(io, ctb(LUA_VUSERDATA)); \
  302. checkliveness(L,io); }
  303. /* Ensures that addresses after this type are always fully aligned. */
  304. typedef union UValue {
  305. TValue uv;
  306. LUAI_MAXALIGN; /* ensures maximum alignment for udata bytes */
  307. } UValue;
  308. /*
  309. ** Header for userdata with user values;
  310. ** memory area follows the end of this structure.
  311. */
  312. typedef struct Udata {
  313. CommonHeader;
  314. unsigned short nuvalue; /* number of user values */
  315. size_t len; /* number of bytes */
  316. struct Table *metatable;
  317. GCObject *gclist;
  318. UValue uv[1]; /* user values */
  319. } Udata;
  320. /*
  321. ** Header for userdata with no user values. These userdata do not need
  322. ** to be gray during GC, and therefore do not need a 'gclist' field.
  323. ** To simplify, the code always use 'Udata' for both kinds of userdata,
  324. ** making sure it never accesses 'gclist' on userdata with no user values.
  325. ** This structure here is used only to compute the correct size for
  326. ** this representation. (The 'bindata' field in its end ensures correct
  327. ** alignment for binary data following this header.)
  328. */
  329. typedef struct Udata0 {
  330. CommonHeader;
  331. unsigned short nuvalue; /* number of user values */
  332. size_t len; /* number of bytes */
  333. struct Table *metatable;
  334. union {LUAI_MAXALIGN;} bindata;
  335. } Udata0;
  336. /* compute the offset of the memory area of a userdata */
  337. #define udatamemoffset(nuv) \
  338. ((nuv) == 0 ? offsetof(Udata0, bindata) \
  339. : offsetof(Udata, uv) + (sizeof(UValue) * (nuv)))
  340. /* get the address of the memory block inside 'Udata' */
  341. #define getudatamem(u) (cast_charp(u) + udatamemoffset((u)->nuvalue))
  342. /* compute the size of a userdata */
  343. #define sizeudata(nuv,nb) (udatamemoffset(nuv) + (nb))
  344. /* }================================================================== */
  345. /*
  346. ** {==================================================================
  347. ** Prototypes
  348. ** ===================================================================
  349. */
  350. #define LUA_VPROTO makevariant(LUA_TPROTO, 0)
  351. /*
  352. ** Description of an upvalue for function prototypes
  353. */
  354. typedef struct Upvaldesc {
  355. TString *name; /* upvalue name (for debug information) */
  356. lu_byte instack; /* whether it is in stack (register) */
  357. lu_byte idx; /* index of upvalue (in stack or in outer function's list) */
  358. lu_byte kind; /* kind of corresponding variable */
  359. } Upvaldesc;
  360. /*
  361. ** Description of a local variable for function prototypes
  362. ** (used for debug information)
  363. */
  364. typedef struct LocVar {
  365. TString *varname;
  366. int startpc; /* first point where variable is active */
  367. int endpc; /* first point where variable is dead */
  368. } LocVar;
  369. /*
  370. ** Associates the absolute line source for a given instruction ('pc').
  371. ** The array 'lineinfo' gives, for each instruction, the difference in
  372. ** lines from the previous instruction. When that difference does not
  373. ** fit into a byte, Lua saves the absolute line for that instruction.
  374. ** (Lua also saves the absolute line periodically, to speed up the
  375. ** computation of a line number: we can use binary search in the
  376. ** absolute-line array, but we must traverse the 'lineinfo' array
  377. ** linearly to compute a line.)
  378. */
  379. typedef struct AbsLineInfo {
  380. int pc;
  381. int line;
  382. } AbsLineInfo;
  383. /*
  384. ** Function Prototypes
  385. */
  386. typedef struct Proto {
  387. CommonHeader;
  388. lu_byte numparams; /* number of fixed (named) parameters */
  389. lu_byte is_vararg;
  390. lu_byte maxstacksize; /* number of registers needed by this function */
  391. int sizeupvalues; /* size of 'upvalues' */
  392. int sizek; /* size of 'k' */
  393. int sizecode;
  394. int sizelineinfo;
  395. int sizep; /* size of 'p' */
  396. int sizelocvars;
  397. int sizeabslineinfo; /* size of 'abslineinfo' */
  398. int linedefined; /* debug information */
  399. int lastlinedefined; /* debug information */
  400. TValue *k; /* constants used by the function */
  401. Instruction *code; /* opcodes */
  402. struct Proto **p; /* functions defined inside the function */
  403. Upvaldesc *upvalues; /* upvalue information */
  404. ls_byte *lineinfo; /* information about source lines (debug information) */
  405. AbsLineInfo *abslineinfo; /* idem */
  406. LocVar *locvars; /* information about local variables (debug information) */
  407. TString *source; /* used for debug information */
  408. GCObject *gclist;
  409. } Proto;
  410. /* }================================================================== */
  411. /*
  412. ** {==================================================================
  413. ** Functions
  414. ** ===================================================================
  415. */
  416. #define LUA_VUPVAL makevariant(LUA_TUPVAL, 0)
  417. /* Variant tags for functions */
  418. #define LUA_VLCL makevariant(LUA_TFUNCTION, 0) /* Lua closure */
  419. #define LUA_VLCF makevariant(LUA_TFUNCTION, 1) /* light C function */
  420. #define LUA_VCCL makevariant(LUA_TFUNCTION, 2) /* C closure */
  421. #define ttisfunction(o) checktype(o, LUA_TFUNCTION)
  422. #define ttisLclosure(o) checktag((o), ctb(LUA_VLCL))
  423. #define ttislcf(o) checktag((o), LUA_VLCF)
  424. #define ttisCclosure(o) checktag((o), ctb(LUA_VCCL))
  425. #define ttisclosure(o) (ttisLclosure(o) || ttisCclosure(o))
  426. #define isLfunction(o) ttisLclosure(o)
  427. #define clvalue(o) check_exp(ttisclosure(o), gco2cl(val_(o).gc))
  428. #define clLvalue(o) check_exp(ttisLclosure(o), gco2lcl(val_(o).gc))
  429. #define fvalue(o) check_exp(ttislcf(o), val_(o).f)
  430. #define clCvalue(o) check_exp(ttisCclosure(o), gco2ccl(val_(o).gc))
  431. #define fvalueraw(v) ((v).f)
  432. #define setclLvalue(L,obj,x) \
  433. { TValue *io = (obj); LClosure *x_ = (x); \
  434. val_(io).gc = obj2gco(x_); settt_(io, ctb(LUA_VLCL)); \
  435. checkliveness(L,io); }
  436. #define setclLvalue2s(L,o,cl) setclLvalue(L,s2v(o),cl)
  437. #define setfvalue(obj,x) \
  438. { TValue *io=(obj); val_(io).f=(x); settt_(io, LUA_VLCF); }
  439. #define setclCvalue(L,obj,x) \
  440. { TValue *io = (obj); CClosure *x_ = (x); \
  441. val_(io).gc = obj2gco(x_); settt_(io, ctb(LUA_VCCL)); \
  442. checkliveness(L,io); }
  443. /*
  444. ** Upvalues for Lua closures
  445. */
  446. typedef struct UpVal {
  447. CommonHeader;
  448. union {
  449. TValue *p; /* points to stack or to its own value */
  450. ptrdiff_t offset; /* used while the stack is being reallocated */
  451. } v;
  452. union {
  453. struct { /* (when open) */
  454. struct UpVal *next; /* linked list */
  455. struct UpVal **previous;
  456. } open;
  457. TValue value; /* the value (when closed) */
  458. } u;
  459. } UpVal;
  460. #define ClosureHeader \
  461. CommonHeader; lu_byte nupvalues; GCObject *gclist
  462. typedef struct CClosure {
  463. ClosureHeader;
  464. lua_CFunction f;
  465. TValue upvalue[1]; /* list of upvalues */
  466. } CClosure;
  467. typedef struct LClosure {
  468. ClosureHeader;
  469. struct Proto *p;
  470. UpVal *upvals[1]; /* list of upvalues */
  471. } LClosure;
  472. typedef union Closure {
  473. CClosure c;
  474. LClosure l;
  475. } Closure;
  476. #define getproto(o) (clLvalue(o)->p)
  477. /* }================================================================== */
  478. /*
  479. ** {==================================================================
  480. ** Tables
  481. ** ===================================================================
  482. */
  483. #define LUA_VTABLE makevariant(LUA_TTABLE, 0)
  484. #define ttistable(o) checktag((o), ctb(LUA_VTABLE))
  485. #define hvalue(o) check_exp(ttistable(o), gco2t(val_(o).gc))
  486. #define sethvalue(L,obj,x) \
  487. { TValue *io = (obj); Table *x_ = (x); \
  488. val_(io).gc = obj2gco(x_); settt_(io, ctb(LUA_VTABLE)); \
  489. checkliveness(L,io); }
  490. #define sethvalue2s(L,o,h) sethvalue(L,s2v(o),h)
  491. /*
  492. ** Nodes for Hash tables: A pack of two TValue's (key-value pairs)
  493. ** plus a 'next' field to link colliding entries. The distribution
  494. ** of the key's fields ('key_tt' and 'key_val') not forming a proper
  495. ** 'TValue' allows for a smaller size for 'Node' both in 4-byte
  496. ** and 8-byte alignments.
  497. */
  498. typedef union Node {
  499. struct NodeKey {
  500. TValuefields; /* fields for value */
  501. lu_byte key_tt; /* key type */
  502. int next; /* for chaining */
  503. Value key_val; /* key value */
  504. } u;
  505. TValue i_val; /* direct access to node's value as a proper 'TValue' */
  506. } Node;
  507. /* copy a value into a key */
  508. #define setnodekey(L,node,obj) \
  509. { Node *n_=(node); const TValue *io_=(obj); \
  510. n_->u.key_val = io_->value_; n_->u.key_tt = io_->tt_; \
  511. checkliveness(L,io_); }
  512. /* copy a value from a key */
  513. #define getnodekey(L,obj,node) \
  514. { TValue *io_=(obj); const Node *n_=(node); \
  515. io_->value_ = n_->u.key_val; io_->tt_ = n_->u.key_tt; \
  516. checkliveness(L,io_); }
  517. /*
  518. ** About 'alimit': if 'isrealasize(t)' is true, then 'alimit' is the
  519. ** real size of 'array'. Otherwise, the real size of 'array' is the
  520. ** smallest power of two not smaller than 'alimit' (or zero iff 'alimit'
  521. ** is zero); 'alimit' is then used as a hint for #t.
  522. */
  523. #define BITRAS (1 << 7)
  524. #define isrealasize(t) (!((t)->flags & BITRAS))
  525. #define setrealasize(t) ((t)->flags &= cast_byte(~BITRAS))
  526. #define setnorealasize(t) ((t)->flags |= BITRAS)
  527. typedef struct Table {
  528. CommonHeader;
  529. lu_byte flags; /* 1<<p means tagmethod(p) is not present */
  530. lu_byte lsizenode; /* log2 of size of 'node' array */
  531. unsigned int alimit; /* "limit" of 'array' array */
  532. TValue *array; /* array part */
  533. Node *node;
  534. Node *lastfree; /* any free position is before this position */
  535. struct Table *metatable;
  536. GCObject *gclist;
  537. } Table;
  538. /*
  539. ** Macros to manipulate keys inserted in nodes
  540. */
  541. #define keytt(node) ((node)->u.key_tt)
  542. #define keyval(node) ((node)->u.key_val)
  543. #define keyisnil(node) (keytt(node) == LUA_TNIL)
  544. #define keyisinteger(node) (keytt(node) == LUA_VNUMINT)
  545. #define keyival(node) (keyval(node).i)
  546. #define keyisshrstr(node) (keytt(node) == ctb(LUA_VSHRSTR))
  547. #define keystrval(node) (gco2ts(keyval(node).gc))
  548. #define setnilkey(node) (keytt(node) = LUA_TNIL)
  549. #define keyiscollectable(n) (keytt(n) & BIT_ISCOLLECTABLE)
  550. #define gckey(n) (keyval(n).gc)
  551. #define gckeyN(n) (keyiscollectable(n) ? gckey(n) : NULL)
  552. /*
  553. ** Dead keys in tables have the tag DEADKEY but keep their original
  554. ** gcvalue. This distinguishes them from regular keys but allows them to
  555. ** be found when searched in a special way. ('next' needs that to find
  556. ** keys removed from a table during a traversal.)
  557. */
  558. #define setdeadkey(node) (keytt(node) = LUA_TDEADKEY)
  559. #define keyisdead(node) (keytt(node) == LUA_TDEADKEY)
  560. /* }================================================================== */
  561. /*
  562. ** 'module' operation for hashing (size is always a power of 2)
  563. */
  564. #define lmod(s,size) \
  565. (check_exp((size&(size-1))==0, (cast_int((s) & ((size)-1)))))
  566. #define twoto(x) (1<<(x))
  567. #define sizenode(t) (twoto((t)->lsizenode))
  568. /* size of buffer for 'luaO_utf8esc' function */
  569. #define UTF8BUFFSZ 8
  570. LUAI_FUNC int luaO_utf8esc (char *buff, unsigned long x);
  571. LUAI_FUNC int luaO_ceillog2 (unsigned int x);
  572. LUAI_FUNC int luaO_rawarith (lua_State *L, int op, const TValue *p1,
  573. const TValue *p2, TValue *res);
  574. LUAI_FUNC void luaO_arith (lua_State *L, int op, const TValue *p1,
  575. const TValue *p2, StkId res);
  576. LUAI_FUNC size_t luaO_str2num (const char *s, TValue *o);
  577. LUAI_FUNC int luaO_hexavalue (int c);
  578. LUAI_FUNC void luaO_tostring (lua_State *L, TValue *obj);
  579. LUAI_FUNC const char *luaO_pushvfstring (lua_State *L, const char *fmt,
  580. va_list argp);
  581. LUAI_FUNC const char *luaO_pushfstring (lua_State *L, const char *fmt, ...);
  582. LUAI_FUNC void luaO_chunkid (char *out, const char *source, size_t srclen);
  583. #endif