9
3

lua.h 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486
  1. /*
  2. ** $Id: lua.h,v 1.332 2016/12/22 15:51:20 roberto Exp $
  3. ** Lua - A Scripting Language
  4. ** Lua.org, PUC-Rio, Brazil (http://www.lua.org)
  5. ** See Copyright Notice at the end of this file
  6. */
  7. #ifndef lua_h
  8. #define lua_h
  9. #include <stdarg.h>
  10. #include <stddef.h>
  11. #include "luaconf.h"
  12. #define LUA_VERSION_MAJOR "5"
  13. #define LUA_VERSION_MINOR "3"
  14. #define LUA_VERSION_NUM 503
  15. #define LUA_VERSION_RELEASE "4"
  16. #define LUA_VERSION "Lua " LUA_VERSION_MAJOR "." LUA_VERSION_MINOR
  17. #define LUA_RELEASE LUA_VERSION "." LUA_VERSION_RELEASE
  18. #define LUA_COPYRIGHT LUA_RELEASE " Copyright (C) 1994-2017 Lua.org, PUC-Rio"
  19. #define LUA_AUTHORS "R. Ierusalimschy, L. H. de Figueiredo, W. Celes"
  20. /* mark for precompiled code ('<esc>Lua') */
  21. #define LUA_SIGNATURE "\x1bLua"
  22. /* option for multiple returns in 'lua_pcall' and 'lua_call' */
  23. #define LUA_MULTRET (-1)
  24. /*
  25. ** Pseudo-indices
  26. ** (-LUAI_MAXSTACK is the minimum valid index; we keep some free empty
  27. ** space after that to help overflow detection)
  28. */
  29. #define LUA_REGISTRYINDEX (-LUAI_MAXSTACK - 1000)
  30. #define lua_upvalueindex(i) (LUA_REGISTRYINDEX - (i))
  31. /* thread status */
  32. #define LUA_OK 0
  33. #define LUA_YIELD 1
  34. #define LUA_ERRRUN 2
  35. #define LUA_ERRSYNTAX 3
  36. #define LUA_ERRMEM 4
  37. #define LUA_ERRGCMM 5
  38. #define LUA_ERRERR 6
  39. typedef struct lua_State lua_State;
  40. /*
  41. ** basic types
  42. */
  43. #define LUA_TNONE (-1)
  44. #define LUA_TNIL 0
  45. #define LUA_TBOOLEAN 1
  46. #define LUA_TLIGHTUSERDATA 2
  47. #define LUA_TNUMBER 3
  48. #define LUA_TSTRING 4
  49. #define LUA_TTABLE 5
  50. #define LUA_TFUNCTION 6
  51. #define LUA_TUSERDATA 7
  52. #define LUA_TTHREAD 8
  53. #define LUA_NUMTAGS 9
  54. /* minimum Lua stack available to a C function */
  55. #define LUA_MINSTACK 20
  56. /* predefined values in the registry */
  57. #define LUA_RIDX_MAINTHREAD 1
  58. #define LUA_RIDX_GLOBALS 2
  59. #define LUA_RIDX_LAST LUA_RIDX_GLOBALS
  60. /* type of numbers in Lua */
  61. typedef LUA_NUMBER lua_Number;
  62. /* type for integer functions */
  63. typedef LUA_INTEGER lua_Integer;
  64. /* unsigned integer type */
  65. typedef LUA_UNSIGNED lua_Unsigned;
  66. /* type for continuation-function contexts */
  67. typedef LUA_KCONTEXT lua_KContext;
  68. /*
  69. ** Type for C functions registered with Lua
  70. */
  71. typedef int (*lua_CFunction) (lua_State *L);
  72. /*
  73. ** Type for continuation functions
  74. */
  75. typedef int (*lua_KFunction) (lua_State *L, int status, lua_KContext ctx);
  76. /*
  77. ** Type for functions that read/write blocks when loading/dumping Lua chunks
  78. */
  79. typedef const char * (*lua_Reader) (lua_State *L, void *ud, size_t *sz);
  80. typedef int (*lua_Writer) (lua_State *L, const void *p, size_t sz, void *ud);
  81. /*
  82. ** Type for memory-allocation functions
  83. */
  84. typedef void * (*lua_Alloc) (void *ud, void *ptr, size_t osize, size_t nsize);
  85. /*
  86. ** generic extra include file
  87. */
  88. #if defined(LUA_USER_H)
  89. #include LUA_USER_H
  90. #endif
  91. /*
  92. ** RCS ident string
  93. */
  94. extern const char lua_ident[];
  95. /*
  96. ** state manipulation
  97. */
  98. LUA_API lua_State *(lua_newstate) (lua_Alloc f, void *ud);
  99. LUA_API void (lua_close) (lua_State *L);
  100. LUA_API lua_State *(lua_newthread) (lua_State *L);
  101. LUA_API lua_CFunction (lua_atpanic) (lua_State *L, lua_CFunction panicf);
  102. LUA_API const lua_Number *(lua_version) (lua_State *L);
  103. /*
  104. ** basic stack manipulation
  105. */
  106. LUA_API int (lua_absindex) (lua_State *L, int idx);
  107. LUA_API int (lua_gettop) (lua_State *L);
  108. LUA_API void (lua_settop) (lua_State *L, int idx);
  109. LUA_API void (lua_pushvalue) (lua_State *L, int idx);
  110. LUA_API void (lua_rotate) (lua_State *L, int idx, int n);
  111. LUA_API void (lua_copy) (lua_State *L, int fromidx, int toidx);
  112. LUA_API int (lua_checkstack) (lua_State *L, int n);
  113. LUA_API void (lua_xmove) (lua_State *from, lua_State *to, int n);
  114. /*
  115. ** access functions (stack -> C)
  116. */
  117. LUA_API int (lua_isnumber) (lua_State *L, int idx);
  118. LUA_API int (lua_isstring) (lua_State *L, int idx);
  119. LUA_API int (lua_iscfunction) (lua_State *L, int idx);
  120. LUA_API int (lua_isinteger) (lua_State *L, int idx);
  121. LUA_API int (lua_isuserdata) (lua_State *L, int idx);
  122. LUA_API int (lua_type) (lua_State *L, int idx);
  123. LUA_API const char *(lua_typename) (lua_State *L, int tp);
  124. LUA_API lua_Number (lua_tonumberx) (lua_State *L, int idx, int *isnum);
  125. LUA_API lua_Integer (lua_tointegerx) (lua_State *L, int idx, int *isnum);
  126. LUA_API int (lua_toboolean) (lua_State *L, int idx);
  127. LUA_API const char *(lua_tolstring) (lua_State *L, int idx, size_t *len);
  128. LUA_API size_t (lua_rawlen) (lua_State *L, int idx);
  129. LUA_API lua_CFunction (lua_tocfunction) (lua_State *L, int idx);
  130. LUA_API void *(lua_touserdata) (lua_State *L, int idx);
  131. LUA_API lua_State *(lua_tothread) (lua_State *L, int idx);
  132. LUA_API const void *(lua_topointer) (lua_State *L, int idx);
  133. /*
  134. ** Comparison and arithmetic functions
  135. */
  136. #define LUA_OPADD 0 /* ORDER TM, ORDER OP */
  137. #define LUA_OPSUB 1
  138. #define LUA_OPMUL 2
  139. #define LUA_OPMOD 3
  140. #define LUA_OPPOW 4
  141. #define LUA_OPDIV 5
  142. #define LUA_OPIDIV 6
  143. #define LUA_OPBAND 7
  144. #define LUA_OPBOR 8
  145. #define LUA_OPBXOR 9
  146. #define LUA_OPSHL 10
  147. #define LUA_OPSHR 11
  148. #define LUA_OPUNM 12
  149. #define LUA_OPBNOT 13
  150. LUA_API void (lua_arith) (lua_State *L, int op);
  151. #define LUA_OPEQ 0
  152. #define LUA_OPLT 1
  153. #define LUA_OPLE 2
  154. LUA_API int (lua_rawequal) (lua_State *L, int idx1, int idx2);
  155. LUA_API int (lua_compare) (lua_State *L, int idx1, int idx2, int op);
  156. /*
  157. ** push functions (C -> stack)
  158. */
  159. LUA_API void (lua_pushnil) (lua_State *L);
  160. LUA_API void (lua_pushnumber) (lua_State *L, lua_Number n);
  161. LUA_API void (lua_pushinteger) (lua_State *L, lua_Integer n);
  162. LUA_API const char *(lua_pushlstring) (lua_State *L, const char *s, size_t len);
  163. LUA_API const char *(lua_pushstring) (lua_State *L, const char *s);
  164. LUA_API const char *(lua_pushvfstring) (lua_State *L, const char *fmt,
  165. va_list argp);
  166. LUA_API const char *(lua_pushfstring) (lua_State *L, const char *fmt, ...);
  167. LUA_API void (lua_pushcclosure) (lua_State *L, lua_CFunction fn, int n);
  168. LUA_API void (lua_pushboolean) (lua_State *L, int b);
  169. LUA_API void (lua_pushlightuserdata) (lua_State *L, void *p);
  170. LUA_API int (lua_pushthread) (lua_State *L);
  171. /*
  172. ** get functions (Lua -> stack)
  173. */
  174. LUA_API int (lua_getglobal) (lua_State *L, const char *name);
  175. LUA_API int (lua_gettable) (lua_State *L, int idx);
  176. LUA_API int (lua_getfield) (lua_State *L, int idx, const char *k);
  177. LUA_API int (lua_geti) (lua_State *L, int idx, lua_Integer n);
  178. LUA_API int (lua_rawget) (lua_State *L, int idx);
  179. LUA_API int (lua_rawgeti) (lua_State *L, int idx, lua_Integer n);
  180. LUA_API int (lua_rawgetp) (lua_State *L, int idx, const void *p);
  181. LUA_API void (lua_createtable) (lua_State *L, int narr, int nrec);
  182. LUA_API void *(lua_newuserdata) (lua_State *L, size_t sz);
  183. LUA_API int (lua_getmetatable) (lua_State *L, int objindex);
  184. LUA_API int (lua_getuservalue) (lua_State *L, int idx);
  185. /*
  186. ** set functions (stack -> Lua)
  187. */
  188. LUA_API void (lua_setglobal) (lua_State *L, const char *name);
  189. LUA_API void (lua_settable) (lua_State *L, int idx);
  190. LUA_API void (lua_setfield) (lua_State *L, int idx, const char *k);
  191. LUA_API void (lua_seti) (lua_State *L, int idx, lua_Integer n);
  192. LUA_API void (lua_rawset) (lua_State *L, int idx);
  193. LUA_API void (lua_rawseti) (lua_State *L, int idx, lua_Integer n);
  194. LUA_API void (lua_rawsetp) (lua_State *L, int idx, const void *p);
  195. LUA_API int (lua_setmetatable) (lua_State *L, int objindex);
  196. LUA_API void (lua_setuservalue) (lua_State *L, int idx);
  197. /*
  198. ** 'load' and 'call' functions (load and run Lua code)
  199. */
  200. LUA_API void (lua_callk) (lua_State *L, int nargs, int nresults,
  201. lua_KContext ctx, lua_KFunction k);
  202. #define lua_call(L,n,r) lua_callk(L, (n), (r), 0, NULL)
  203. LUA_API int (lua_pcallk) (lua_State *L, int nargs, int nresults, int errfunc,
  204. lua_KContext ctx, lua_KFunction k);
  205. #define lua_pcall(L,n,r,f) lua_pcallk(L, (n), (r), (f), 0, NULL)
  206. LUA_API int (lua_load) (lua_State *L, lua_Reader reader, void *dt,
  207. const char *chunkname, const char *mode);
  208. LUA_API int (lua_dump) (lua_State *L, lua_Writer writer, void *data, int strip);
  209. /*
  210. ** coroutine functions
  211. */
  212. LUA_API int (lua_yieldk) (lua_State *L, int nresults, lua_KContext ctx,
  213. lua_KFunction k);
  214. LUA_API int (lua_resume) (lua_State *L, lua_State *from, int narg);
  215. LUA_API int (lua_status) (lua_State *L);
  216. LUA_API int (lua_isyieldable) (lua_State *L);
  217. #define lua_yield(L,n) lua_yieldk(L, (n), 0, NULL)
  218. /*
  219. ** garbage-collection function and options
  220. */
  221. #define LUA_GCSTOP 0
  222. #define LUA_GCRESTART 1
  223. #define LUA_GCCOLLECT 2
  224. #define LUA_GCCOUNT 3
  225. #define LUA_GCCOUNTB 4
  226. #define LUA_GCSTEP 5
  227. #define LUA_GCSETPAUSE 6
  228. #define LUA_GCSETSTEPMUL 7
  229. #define LUA_GCISRUNNING 9
  230. LUA_API int (lua_gc) (lua_State *L, int what, int data);
  231. /*
  232. ** miscellaneous functions
  233. */
  234. LUA_API int (lua_error) (lua_State *L);
  235. LUA_API int (lua_next) (lua_State *L, int idx);
  236. LUA_API void (lua_concat) (lua_State *L, int n);
  237. LUA_API void (lua_len) (lua_State *L, int idx);
  238. LUA_API size_t (lua_stringtonumber) (lua_State *L, const char *s);
  239. LUA_API lua_Alloc (lua_getallocf) (lua_State *L, void **ud);
  240. LUA_API void (lua_setallocf) (lua_State *L, lua_Alloc f, void *ud);
  241. /*
  242. ** {==============================================================
  243. ** some useful macros
  244. ** ===============================================================
  245. */
  246. #define lua_getextraspace(L) ((void *)((char *)(L) - LUA_EXTRASPACE))
  247. #define lua_tonumber(L,i) lua_tonumberx(L,(i),NULL)
  248. #define lua_tointeger(L,i) lua_tointegerx(L,(i),NULL)
  249. #define lua_pop(L,n) lua_settop(L, -(n)-1)
  250. #define lua_newtable(L) lua_createtable(L, 0, 0)
  251. #define lua_register(L,n,f) (lua_pushcfunction(L, (f)), lua_setglobal(L, (n)))
  252. #define lua_pushcfunction(L,f) lua_pushcclosure(L, (f), 0)
  253. #define lua_isfunction(L,n) (lua_type(L, (n)) == LUA_TFUNCTION)
  254. #define lua_istable(L,n) (lua_type(L, (n)) == LUA_TTABLE)
  255. #define lua_islightuserdata(L,n) (lua_type(L, (n)) == LUA_TLIGHTUSERDATA)
  256. #define lua_isnil(L,n) (lua_type(L, (n)) == LUA_TNIL)
  257. #define lua_isboolean(L,n) (lua_type(L, (n)) == LUA_TBOOLEAN)
  258. #define lua_isthread(L,n) (lua_type(L, (n)) == LUA_TTHREAD)
  259. #define lua_isnone(L,n) (lua_type(L, (n)) == LUA_TNONE)
  260. #define lua_isnoneornil(L, n) (lua_type(L, (n)) <= 0)
  261. #define lua_pushliteral(L, s) lua_pushstring(L, "" s)
  262. #define lua_pushglobaltable(L) \
  263. ((void)lua_rawgeti(L, LUA_REGISTRYINDEX, LUA_RIDX_GLOBALS))
  264. #define lua_tostring(L,i) lua_tolstring(L, (i), NULL)
  265. #define lua_insert(L,idx) lua_rotate(L, (idx), 1)
  266. #define lua_remove(L,idx) (lua_rotate(L, (idx), -1), lua_pop(L, 1))
  267. #define lua_replace(L,idx) (lua_copy(L, -1, (idx)), lua_pop(L, 1))
  268. /* }============================================================== */
  269. /*
  270. ** {==============================================================
  271. ** compatibility macros for unsigned conversions
  272. ** ===============================================================
  273. */
  274. #if defined(LUA_COMPAT_APIINTCASTS)
  275. #define lua_pushunsigned(L,n) lua_pushinteger(L, (lua_Integer)(n))
  276. #define lua_tounsignedx(L,i,is) ((lua_Unsigned)lua_tointegerx(L,i,is))
  277. #define lua_tounsigned(L,i) lua_tounsignedx(L,(i),NULL)
  278. #endif
  279. /* }============================================================== */
  280. /*
  281. ** {======================================================================
  282. ** Debug API
  283. ** =======================================================================
  284. */
  285. /*
  286. ** Event codes
  287. */
  288. #define LUA_HOOKCALL 0
  289. #define LUA_HOOKRET 1
  290. #define LUA_HOOKLINE 2
  291. #define LUA_HOOKCOUNT 3
  292. #define LUA_HOOKTAILCALL 4
  293. /*
  294. ** Event masks
  295. */
  296. #define LUA_MASKCALL (1 << LUA_HOOKCALL)
  297. #define LUA_MASKRET (1 << LUA_HOOKRET)
  298. #define LUA_MASKLINE (1 << LUA_HOOKLINE)
  299. #define LUA_MASKCOUNT (1 << LUA_HOOKCOUNT)
  300. typedef struct lua_Debug lua_Debug; /* activation record */
  301. /* Functions to be called by the debugger in specific events */
  302. typedef void (*lua_Hook) (lua_State *L, lua_Debug *ar);
  303. LUA_API int (lua_getstack) (lua_State *L, int level, lua_Debug *ar);
  304. LUA_API int (lua_getinfo) (lua_State *L, const char *what, lua_Debug *ar);
  305. LUA_API const char *(lua_getlocal) (lua_State *L, const lua_Debug *ar, int n);
  306. LUA_API const char *(lua_setlocal) (lua_State *L, const lua_Debug *ar, int n);
  307. LUA_API const char *(lua_getupvalue) (lua_State *L, int funcindex, int n);
  308. LUA_API const char *(lua_setupvalue) (lua_State *L, int funcindex, int n);
  309. LUA_API void *(lua_upvalueid) (lua_State *L, int fidx, int n);
  310. LUA_API void (lua_upvaluejoin) (lua_State *L, int fidx1, int n1,
  311. int fidx2, int n2);
  312. LUA_API void (lua_sethook) (lua_State *L, lua_Hook func, int mask, int count);
  313. LUA_API lua_Hook (lua_gethook) (lua_State *L);
  314. LUA_API int (lua_gethookmask) (lua_State *L);
  315. LUA_API int (lua_gethookcount) (lua_State *L);
  316. struct lua_Debug {
  317. int event;
  318. const char *name; /* (n) */
  319. const char *namewhat; /* (n) 'global', 'local', 'field', 'method' */
  320. const char *what; /* (S) 'Lua', 'C', 'main', 'tail' */
  321. const char *source; /* (S) */
  322. int currentline; /* (l) */
  323. int linedefined; /* (S) */
  324. int lastlinedefined; /* (S) */
  325. unsigned char nups; /* (u) number of upvalues */
  326. unsigned char nparams;/* (u) number of parameters */
  327. char isvararg; /* (u) */
  328. char istailcall; /* (t) */
  329. char short_src[LUA_IDSIZE]; /* (S) */
  330. /* private part */
  331. struct CallInfo *i_ci; /* active function */
  332. };
  333. /* }====================================================================== */
  334. /******************************************************************************
  335. * Copyright (C) 1994-2017 Lua.org, PUC-Rio.
  336. *
  337. * Permission is hereby granted, free of charge, to any person obtaining
  338. * a copy of this software and associated documentation files (the
  339. * "Software"), to deal in the Software without restriction, including
  340. * without limitation the rights to use, copy, modify, merge, publish,
  341. * distribute, sublicense, and/or sell copies of the Software, and to
  342. * permit persons to whom the Software is furnished to do so, subject to
  343. * the following conditions:
  344. *
  345. * The above copyright notice and this permission notice shall be
  346. * included in all copies or substantial portions of the Software.
  347. *
  348. * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  349. * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  350. * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
  351. * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
  352. * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
  353. * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  354. * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  355. ******************************************************************************/
  356. #endif