lua.h 15 KB

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