lua.h 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534
  1. /*
  2. ** $Id: lua.h,v 1.332.1.2 2018/06/13 16:58:17 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 "5"
  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-2018 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. typedef LUA_FLOAT lua_Float;
  63. /* type for integer functions */
  64. typedef LUA_INTEGER lua_Integer;
  65. /* unsigned integer type */
  66. typedef LUA_UNSIGNED lua_Unsigned;
  67. /* type for continuation-function contexts */
  68. typedef LUA_KCONTEXT lua_KContext;
  69. /*
  70. ** Type for C functions registered with Lua
  71. */
  72. typedef int (*lua_CFunction) (lua_State *L);
  73. /*
  74. ** Type for continuation functions
  75. */
  76. typedef int (*lua_KFunction) (lua_State *L, int status, lua_KContext ctx);
  77. /*
  78. ** Type for functions that read/write blocks when loading/dumping Lua chunks
  79. */
  80. typedef const char * (*lua_Reader) (lua_State *L, void *ud, size_t *sz);
  81. typedef int (*lua_Writer) (lua_State *L, const void *p, size_t sz, void *ud);
  82. /*
  83. ** Type for memory-allocation functions
  84. */
  85. typedef void * (*lua_Alloc) (void *ud, void *ptr, size_t osize, size_t nsize);
  86. /*
  87. ** generic extra include file
  88. */
  89. #if defined(LUA_USER_H)
  90. #include LUA_USER_H
  91. #endif
  92. #if defined(LUA_ENABLE_TEST) && defined(LUA_USE_HOST)
  93. #include "ltests.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 lua_CFunction (lua_atpanic) (lua_State *L, lua_CFunction panicf);
  106. LUA_API const lua_Number *(lua_version) (lua_State *L);
  107. #ifndef LUAI_OPTIMIZE_DEBUG
  108. #define LUAI_OPTIMIZE_DEBUG 2
  109. #endif
  110. /*
  111. ** basic stack manipulation
  112. */
  113. LUA_API int (lua_absindex) (lua_State *L, int idx);
  114. LUA_API int (lua_gettop) (lua_State *L);
  115. LUA_API void (lua_settop) (lua_State *L, int idx);
  116. LUA_API void (lua_pushvalue) (lua_State *L, int idx);
  117. LUA_API void (lua_rotate) (lua_State *L, int idx, int n);
  118. LUA_API void (lua_copy) (lua_State *L, int fromidx, int toidx);
  119. LUA_API int (lua_checkstack) (lua_State *L, int n);
  120. LUA_API void (lua_xmove) (lua_State *from, lua_State *to, int n);
  121. /*
  122. ** access functions (stack -> C)
  123. */
  124. LUA_API int (lua_isnumber) (lua_State *L, int idx);
  125. LUA_API int (lua_isstring) (lua_State *L, int idx);
  126. LUA_API int (lua_iscfunction) (lua_State *L, int idx);
  127. LUA_API int (lua_isinteger) (lua_State *L, int idx);
  128. LUA_API int (lua_isuserdata) (lua_State *L, int idx);
  129. LUA_API int (lua_type) (lua_State *L, int idx);
  130. LUA_API const char *(lua_typename) (lua_State *L, int tp);
  131. LUA_API lua_Number (lua_tonumberx) (lua_State *L, int idx, int *isnum);
  132. LUA_API lua_Integer (lua_tointegerx) (lua_State *L, int idx, int *isnum);
  133. LUA_API int (lua_toboolean) (lua_State *L, int idx);
  134. LUA_API const char *(lua_tolstring) (lua_State *L, int idx, size_t *len);
  135. LUA_API size_t (lua_rawlen) (lua_State *L, int idx);
  136. LUA_API lua_CFunction (lua_tocfunction) (lua_State *L, int idx);
  137. LUA_API void *(lua_touserdata) (lua_State *L, int idx);
  138. LUA_API lua_State *(lua_tothread) (lua_State *L, int idx);
  139. LUA_API const void *(lua_topointer) (lua_State *L, int idx);
  140. /*
  141. ** Comparison and arithmetic functions
  142. */
  143. #define LUA_OPADD 0 /* ORDER TM, ORDER OP */
  144. #define LUA_OPSUB 1
  145. #define LUA_OPMUL 2
  146. #define LUA_OPMOD 3
  147. #define LUA_OPPOW 4
  148. #define LUA_OPDIV 5
  149. #define LUA_OPIDIV 6
  150. #define LUA_OPBAND 7
  151. #define LUA_OPBOR 8
  152. #define LUA_OPBXOR 9
  153. #define LUA_OPSHL 10
  154. #define LUA_OPSHR 11
  155. #define LUA_OPUNM 12
  156. #define LUA_OPBNOT 13
  157. LUA_API void (lua_arith) (lua_State *L, int op);
  158. #define LUA_OPEQ 0
  159. #define LUA_OPLT 1
  160. #define LUA_OPLE 2
  161. LUA_API int (lua_rawequal) (lua_State *L, int idx1, int idx2);
  162. LUA_API int (lua_compare) (lua_State *L, int idx1, int idx2, int op);
  163. /*
  164. ** push functions (C -> stack)
  165. */
  166. LUA_API void (lua_pushnil) (lua_State *L);
  167. LUA_API void (lua_pushnumber) (lua_State *L, lua_Number n);
  168. LUA_API void (lua_pushinteger) (lua_State *L, lua_Integer n);
  169. LUA_API const char *(lua_pushlstring) (lua_State *L, const char *s, size_t len);
  170. LUA_API const char *(lua_pushstring) (lua_State *L, const char *s);
  171. LUA_API const char *(lua_pushvfstring) (lua_State *L, const char *fmt,
  172. va_list argp);
  173. LUA_API const char *(lua_pushfstring) (lua_State *L, const char *fmt, ...);
  174. LUA_API void (lua_pushcclosure) (lua_State *L, lua_CFunction fn, int n);
  175. LUA_API void (lua_pushboolean) (lua_State *L, int b);
  176. LUA_API void (lua_pushlightuserdata) (lua_State *L, void *p);
  177. LUA_API int (lua_pushthread) (lua_State *L);
  178. /*
  179. ** get functions (Lua -> stack)
  180. */
  181. LUA_API int (lua_getglobal) (lua_State *L, const char *name);
  182. LUA_API int (lua_gettable) (lua_State *L, int idx);
  183. LUA_API int (lua_getfield) (lua_State *L, int idx, const char *k);
  184. LUA_API int (lua_geti) (lua_State *L, int idx, lua_Integer n);
  185. LUA_API int (lua_rawget) (lua_State *L, int idx);
  186. LUA_API int (lua_rawgeti) (lua_State *L, int idx, lua_Integer n);
  187. LUA_API int (lua_rawgetp) (lua_State *L, int idx, const void *p);
  188. LUA_API void (lua_createtable) (lua_State *L, int narr, int nrec);
  189. LUA_API void *(lua_newuserdata) (lua_State *L, size_t sz);
  190. LUA_API int (lua_getmetatable) (lua_State *L, int objindex);
  191. LUA_API int (lua_getuservalue) (lua_State *L, int idx);
  192. /*
  193. ** set functions (stack -> Lua)
  194. */
  195. LUA_API void (lua_setglobal) (lua_State *L, const char *name);
  196. LUA_API void (lua_settable) (lua_State *L, int idx);
  197. LUA_API void (lua_setfield) (lua_State *L, int idx, const char *k);
  198. LUA_API void (lua_seti) (lua_State *L, int idx, lua_Integer n);
  199. LUA_API void (lua_rawset) (lua_State *L, int idx);
  200. LUA_API void (lua_rawseti) (lua_State *L, int idx, lua_Integer n);
  201. LUA_API void (lua_rawsetp) (lua_State *L, int idx, const void *p);
  202. LUA_API int (lua_setmetatable) (lua_State *L, int objindex);
  203. LUA_API void (lua_setuservalue) (lua_State *L, int idx);
  204. /*
  205. ** 'load' and 'call' functions (load and run Lua code)
  206. */
  207. LUA_API void (lua_callk) (lua_State *L, int nargs, int nresults,
  208. lua_KContext ctx, lua_KFunction k);
  209. #define lua_call(L,n,r) lua_callk(L, (n), (r), 0, NULL)
  210. LUA_API int (lua_pcallk) (lua_State *L, int nargs, int nresults, int errfunc,
  211. lua_KContext ctx, lua_KFunction k);
  212. #define lua_pcall(L,n,r,f) lua_pcallk(L, (n), (r), (f), 0, NULL)
  213. LUA_API int (lua_load) (lua_State *L, lua_Reader reader, void *dt,
  214. const char *chunkname, const char *mode);
  215. LUA_API int (lua_dump) (lua_State *L, lua_Writer writer, void *data, int strip);
  216. LUA_API int (lua_stripdebug) (lua_State *L, int stripping);
  217. /*
  218. ** coroutine functions
  219. */
  220. LUA_API int (lua_yieldk) (lua_State *L, int nresults, lua_KContext ctx,
  221. lua_KFunction k);
  222. LUA_API int (lua_resume) (lua_State *L, lua_State *from, int narg);
  223. LUA_API int (lua_status) (lua_State *L);
  224. LUA_API int (lua_isyieldable) (lua_State *L);
  225. #define lua_yield(L,n) lua_yieldk(L, (n), 0, NULL)
  226. /*
  227. ** garbage-collection function and options
  228. */
  229. #define LUA_GCSTOP 0
  230. #define LUA_GCRESTART 1
  231. #define LUA_GCCOLLECT 2
  232. #define LUA_GCCOUNT 3
  233. #define LUA_GCCOUNTB 4
  234. #define LUA_GCSTEP 5
  235. #define LUA_GCSETPAUSE 6
  236. #define LUA_GCSETSTEPMUL 7
  237. #define LUA_GCSETMEMLIMIT 8
  238. #define LUA_GCISRUNNING 9
  239. LUA_API int (lua_gc) (lua_State *L, int what, int data);
  240. /*
  241. ** miscellaneous functions
  242. */
  243. LUA_API int (lua_error) (lua_State *L);
  244. LUA_API int (lua_next) (lua_State *L, int idx);
  245. LUA_API void (lua_concat) (lua_State *L, int n);
  246. LUA_API void (lua_len) (lua_State *L, int idx);
  247. LUA_API size_t (lua_stringtonumber) (lua_State *L, const char *s);
  248. LUA_API lua_Alloc (lua_getallocf) (lua_State *L, void **ud);
  249. LUA_API void (lua_setallocf) (lua_State *L, lua_Alloc f, void *ud);
  250. /*
  251. ** {==============================================================
  252. ** some useful macros
  253. ** ===============================================================
  254. */
  255. #define lua_getextraspace(L) ((void *)((char *)(L) - LUA_EXTRASPACE))
  256. #define lua_tonumber(L,i) lua_tonumberx(L,(i),NULL)
  257. #define lua_tointeger(L,i) lua_tointegerx(L,(i),NULL)
  258. #define lua_pop(L,n) lua_settop(L, -(n)-1)
  259. #define lua_newtable(L) lua_createtable(L, 0, 0)
  260. #define lua_register(L,n,f) (lua_pushcfunction(L, (f)), lua_setglobal(L, (n)))
  261. #define lua_pushcfunction(L,f) lua_pushcclosure(L, (f), 0)
  262. #define lua_isfunction(L,n) (lua_type(L, (n)) == LUA_TFUNCTION)
  263. #define lua_istable(L,n) (lua_type(L, (n)) == LUA_TTABLE)
  264. #define lua_islightuserdata(L,n) (lua_type(L, (n)) == LUA_TLIGHTUSERDATA)
  265. #define lua_isnil(L,n) (lua_type(L, (n)) == LUA_TNIL)
  266. #define lua_isboolean(L,n) (lua_type(L, (n)) == LUA_TBOOLEAN)
  267. #define lua_isthread(L,n) (lua_type(L, (n)) == LUA_TTHREAD)
  268. #define lua_isnone(L,n) (lua_type(L, (n)) == LUA_TNONE)
  269. #define lua_isnoneornil(L, n) (lua_type(L, (n)) <= 0)
  270. #define lua_pushliteral(L, s) lua_pushstring(L, "" s)
  271. #define lua_pushglobaltable(L) \
  272. ((void)lua_rawgeti(L, LUA_REGISTRYINDEX, LUA_RIDX_GLOBALS))
  273. #define lua_tostring(L,i) lua_tolstring(L, (i), NULL)
  274. #define lua_insert(L,idx) lua_rotate(L, (idx), 1)
  275. #define lua_remove(L,idx) (lua_rotate(L, (idx), -1), lua_pop(L, 1))
  276. #define lua_replace(L,idx) (lua_copy(L, -1, (idx)), lua_pop(L, 1))
  277. /* }============================================================== */
  278. /*
  279. ** {==============================================================
  280. ** compatibility macros for unsigned conversions
  281. ** ===============================================================
  282. */
  283. #if defined(LUA_COMPAT_APIINTCASTS)
  284. #define lua_pushunsigned(L,n) lua_pushinteger(L, (lua_Integer)(n))
  285. #define lua_tounsignedx(L,i,is) ((lua_Unsigned)lua_tointegerx(L,i,is))
  286. #define lua_tounsigned(L,i) lua_tounsignedx(L,(i),NULL)
  287. #endif
  288. /* }============================================================== */
  289. /*
  290. ** {======================================================================
  291. ** Debug API
  292. ** =======================================================================
  293. */
  294. /*
  295. ** Event codes
  296. */
  297. #define LUA_HOOKCALL 0
  298. #define LUA_HOOKRET 1
  299. #define LUA_HOOKLINE 2
  300. #define LUA_HOOKCOUNT 3
  301. #define LUA_HOOKTAILCALL 4
  302. /*
  303. ** Event masks
  304. */
  305. #define LUA_MASKCALL (1 << LUA_HOOKCALL)
  306. #define LUA_MASKRET (1 << LUA_HOOKRET)
  307. #define LUA_MASKLINE (1 << LUA_HOOKLINE)
  308. #define LUA_MASKCOUNT (1 << LUA_HOOKCOUNT)
  309. typedef struct lua_Debug lua_Debug; /* activation record */
  310. /* Functions to be called by the debugger in specific events */
  311. typedef void (*lua_Hook) (lua_State *L, lua_Debug *ar);
  312. LUA_API int (lua_getstack) (lua_State *L, int level, lua_Debug *ar);
  313. LUA_API int (lua_getinfo) (lua_State *L, const char *what, lua_Debug *ar);
  314. LUA_API const char *(lua_getlocal) (lua_State *L, const lua_Debug *ar, int n);
  315. LUA_API const char *(lua_setlocal) (lua_State *L, const lua_Debug *ar, int n);
  316. LUA_API const char *(lua_getupvalue) (lua_State *L, int funcindex, int n);
  317. LUA_API const char *(lua_setupvalue) (lua_State *L, int funcindex, int n);
  318. LUA_API void *(lua_upvalueid) (lua_State *L, int fidx, int n);
  319. LUA_API void (lua_upvaluejoin) (lua_State *L, int fidx1, int n1,
  320. int fidx2, int n2);
  321. LUA_API void (lua_sethook) (lua_State *L, lua_Hook func, int mask, int count);
  322. LUA_API lua_Hook (lua_gethook) (lua_State *L);
  323. LUA_API int (lua_gethookmask) (lua_State *L);
  324. LUA_API int (lua_gethookcount) (lua_State *L);
  325. struct lua_Debug {
  326. int event;
  327. const char *name; /* (n) */
  328. const char *namewhat; /* (n) 'global', 'local', 'field', 'method' */
  329. const char *what; /* (S) 'Lua', 'C', 'main', 'tail' */
  330. const char *source; /* (S) */
  331. int currentline; /* (l) */
  332. int linedefined; /* (S) */
  333. int lastlinedefined; /* (S) */
  334. unsigned char nups; /* (u) number of upvalues */
  335. unsigned char nparams;/* (u) number of parameters */
  336. char isvararg; /* (u) */
  337. char istailcall; /* (t) */
  338. char short_src[LUA_IDSIZE]; /* (S) */
  339. /* private part */
  340. struct CallInfo *i_ci; /* active function */
  341. };
  342. /* }====================================================================== */
  343. /* NodeMCU extensions to the standard API */
  344. typedef struct ROTable ROTable;
  345. typedef const struct ROTable_entry ROTable_entry;
  346. LUA_API void (lua_pushrotable) (lua_State *L, const ROTable *p);
  347. LUA_API void (lua_createrotable) (lua_State *L, ROTable *t, const ROTable_entry *e, ROTable *mt);
  348. LUA_API lua_State *(lua_getstate) (void);
  349. LUA_API int (lua_pushstringsarray) (lua_State *L, int opt);
  350. LUA_API int (lua_freeheap) (void);
  351. LUA_API void (lua_getlfsconfig) (lua_State *L, int *);
  352. LUA_API int (lua_pushlfsindex) (lua_State *L);
  353. LUA_API int (lua_pushlfsfunc) (lua_State *L);
  354. #define luaN_freearray(L,a,l) luaM_freearray(L,a,l)
  355. // LUA_MAXINPUT is the maximum length for an input line in the
  356. #define LUA_MAXINPUT 256
  357. #define LUAI_MAXINT32 INT_MAX
  358. typedef struct Proto Proto;
  359. #ifdef DEVELOPMENT_USE_GDB
  360. LUALIB_API void (lua_debugbreak)(void);
  361. #define ASSERT(s) ((s) ? (void)0 : lua_debugbreak())
  362. #else
  363. #define lua_debugbreak() (void)(0)
  364. #define ASSERT(s) (void)(0)
  365. #endif
  366. // from undump.c
  367. #define LUA_ERR_CC_INTOVERFLOW 101
  368. #define LUA_ERR_CC_NOTINTEGER 102
  369. /* }====================================================================== */
  370. /******************************************************************************
  371. * Copyright (C) 1994-2018 Lua.org, PUC-Rio.
  372. *
  373. * Permission is hereby granted, free of charge, to any person obtaining
  374. * a copy of this software and associated documentation files (the
  375. * "Software"), to deal in the Software without restriction, including
  376. * without limitation the rights to use, copy, modify, merge, publish,
  377. * distribute, sublicense, and/or sell copies of the Software, and to
  378. * permit persons to whom the Software is furnished to do so, subject to
  379. * the following conditions:
  380. *
  381. * The above copyright notice and this permission notice shall be
  382. * included in all copies or substantial portions of the Software.
  383. *
  384. * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  385. * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  386. * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
  387. * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
  388. * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
  389. * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  390. * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  391. ******************************************************************************/
  392. #endif