lua.h 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458
  1. /*
  2. ** $Id: lua.h,v 1.218.1.5 2008/08/06 13:30:12 roberto Exp $
  3. ** Lua - An Extensible Extension 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 <stdint.h>
  10. #include "stdarg.h"
  11. #include "stddef.h"
  12. #include "ctype.h"
  13. #include "luaconf.h"
  14. #define LUA_VERSION "Lua 5.1"
  15. #define LUA_RELEASE "Lua 5.1.4"
  16. #define LUA_VERSION_NUM 501
  17. #define LUA_COPYRIGHT "Copyright (C) 1994-2011 Lua.org, PUC-Rio"
  18. #define LUA_AUTHORS "R. Ierusalimschy, L. H. de Figueiredo & W. Celes"
  19. /* mark for precompiled code (`<esc>Lua') */
  20. #define LUA_SIGNATURE "\033Lua"
  21. /* option for multiple returns in `lua_pcall' and `lua_call' */
  22. #define LUA_MULTRET (-1)
  23. /*
  24. ** pseudo-indices
  25. */
  26. #define LUA_REGISTRYINDEX (-10000)
  27. #define LUA_ENVIRONINDEX (-10001)
  28. #define LUA_GLOBALSINDEX (-10002)
  29. #define lua_upvalueindex(i) (LUA_GLOBALSINDEX-(i))
  30. /* thread status */
  31. #define LUA_OK 0
  32. #define LUA_YIELD 1
  33. #define LUA_ERRRUN 2
  34. #define LUA_ERRSYNTAX 3
  35. #define LUA_ERRMEM 4
  36. #define LUA_ERRERR 5
  37. typedef struct lua_State lua_State;
  38. typedef int (*lua_CFunction) (lua_State *L);
  39. /*
  40. ** functions that read/write blocks when loading/dumping Lua chunks
  41. */
  42. typedef const char * (*lua_Reader) (lua_State *L, void *ud, size_t *sz);
  43. typedef int (*lua_Writer) (lua_State *L, const void* p, size_t sz, void* ud);
  44. /*
  45. ** prototype for memory-allocation functions
  46. */
  47. typedef void * (*lua_Alloc) (void *ud, void *ptr, size_t osize, size_t nsize);
  48. /*
  49. ** basic types
  50. */
  51. #define LUA_TNONE (-1)
  52. #define LUA_TNIL 0
  53. #define LUA_TBOOLEAN 1
  54. #define LUA_TLIGHTUSERDATA 2
  55. #define LUA_TNUMBER 3
  56. #define LUA_TSTRING 4
  57. #define LUA_TTABLE 5
  58. #define LUA_TFUNCTION 6
  59. #define LUA_TUSERDATA 7
  60. #define LUA_TTHREAD 8
  61. #define LUA_TISROTABLE (1<<4)
  62. #define LUA_TISLIGHTFUNC (1<<5)
  63. #define LUA_TMASK 15
  64. #define LUA_TROTABLE (LUA_TTABLE + LUA_TISROTABLE)
  65. #define LUA_TLIGHTFUNCTION (LUA_TFUNCTION + LUA_TISLIGHTFUNC)
  66. /* minimum Lua stack available to a C function */
  67. #define LUA_MINSTACK 20
  68. /*
  69. ** generic extra include file
  70. */
  71. #if defined(LUA_USER_H)
  72. #include LUA_USER_H
  73. #endif
  74. #if defined(LUA_OPTIMIZE_DEBUG) && LUA_OPTIMIZE_DEBUG == 0
  75. #undef LUA_OPTIMIZE_DEBUG
  76. #endif
  77. /* type of numbers in Lua */
  78. typedef LUA_NUMBER lua_Number;
  79. /* type for integer functions */
  80. typedef LUA_INTEGER lua_Integer;
  81. /*
  82. ** state manipulation
  83. */
  84. LUA_API lua_State *(lua_newstate) (lua_Alloc f, void *ud);
  85. LUA_API void (lua_close) (lua_State *L);
  86. LUA_API lua_State *(lua_newthread) (lua_State *L);
  87. LUA_API lua_CFunction (lua_atpanic) (lua_State *L, lua_CFunction panicf);
  88. /*
  89. ** basic stack manipulation
  90. */
  91. LUA_API int (lua_gettop) (lua_State *L);
  92. LUA_API void (lua_settop) (lua_State *L, int idx);
  93. LUA_API void (lua_pushvalue) (lua_State *L, int idx);
  94. LUA_API void (lua_remove) (lua_State *L, int idx);
  95. LUA_API void (lua_insert) (lua_State *L, int idx);
  96. LUA_API void (lua_replace) (lua_State *L, int idx);
  97. LUA_API int (lua_checkstack) (lua_State *L, int sz);
  98. LUA_API void (lua_xmove) (lua_State *from, lua_State *to, int n);
  99. /*
  100. ** access functions (stack -> C)
  101. */
  102. LUA_API int (lua_isnumber) (lua_State *L, int idx);
  103. LUA_API int (lua_isstring) (lua_State *L, int idx);
  104. LUA_API int (lua_iscfunction) (lua_State *L, int idx);
  105. LUA_API int (lua_isuserdata) (lua_State *L, int idx);
  106. LUA_API int (lua_type) (lua_State *L, int idx);
  107. LUA_API int (lua_fulltype) (lua_State *L, int idx);
  108. LUA_API const char *(lua_typename) (lua_State *L, int tp);
  109. LUA_API int (lua_equal) (lua_State *L, int idx1, int idx2);
  110. LUA_API int (lua_rawequal) (lua_State *L, int idx1, int idx2);
  111. LUA_API int (lua_lessthan) (lua_State *L, int idx1, int idx2);
  112. LUA_API lua_Number (lua_tonumber) (lua_State *L, int idx);
  113. LUA_API lua_Integer (lua_tointeger) (lua_State *L, int idx);
  114. LUA_API int (lua_toboolean) (lua_State *L, int idx);
  115. LUA_API const char *(lua_tolstring) (lua_State *L, int idx, size_t *len);
  116. LUA_API size_t (lua_objlen) (lua_State *L, int idx);
  117. LUA_API lua_CFunction (lua_tocfunction) (lua_State *L, int idx);
  118. LUA_API void *(lua_touserdata) (lua_State *L, int idx);
  119. LUA_API lua_State *(lua_tothread) (lua_State *L, int idx);
  120. LUA_API const void *(lua_topointer) (lua_State *L, int idx);
  121. /*
  122. ** push functions (C -> stack)
  123. */
  124. LUA_API void (lua_pushnil) (lua_State *L);
  125. LUA_API void (lua_pushnumber) (lua_State *L, lua_Number n);
  126. LUA_API void (lua_pushinteger) (lua_State *L, lua_Integer n);
  127. LUA_API void (lua_pushlstring) (lua_State *L, const char *s, size_t l);
  128. LUA_API void (lua_pushstring) (lua_State *L, const char *s);
  129. LUA_API const char *(lua_pushvfstring) (lua_State *L, const char *fmt,
  130. va_list argp);
  131. LUA_API const char *(lua_pushfstring) (lua_State *L, const char *fmt, ...);
  132. LUA_API void (lua_pushcclosure) (lua_State *L, lua_CFunction fn, int n);
  133. LUA_API void (lua_pushboolean) (lua_State *L, int b);
  134. LUA_API void (lua_pushlightuserdata) (lua_State *L, void *p);
  135. LUA_API int (lua_pushthread) (lua_State *L);
  136. /*
  137. ** get functions (Lua -> stack)
  138. */
  139. LUA_API void (lua_gettable) (lua_State *L, int idx);
  140. LUA_API void (lua_getfield) (lua_State *L, int idx, const char *k);
  141. LUA_API void (lua_rawget) (lua_State *L, int idx);
  142. LUA_API void (lua_rawgeti) (lua_State *L, int idx, int n);
  143. LUA_API void (lua_createtable) (lua_State *L, int narr, int nrec);
  144. LUA_API void *(lua_newuserdata) (lua_State *L, size_t sz);
  145. LUA_API int (lua_getmetatable) (lua_State *L, int objindex);
  146. LUA_API void (lua_getfenv) (lua_State *L, int idx);
  147. /*
  148. ** set functions (stack -> Lua)
  149. */
  150. LUA_API void (lua_settable) (lua_State *L, int idx);
  151. LUA_API void (lua_setfield) (lua_State *L, int idx, const char *k);
  152. LUA_API void (lua_rawset) (lua_State *L, int idx);
  153. LUA_API void (lua_rawseti) (lua_State *L, int idx, int n);
  154. LUA_API int (lua_setmetatable) (lua_State *L, int objindex);
  155. LUA_API int (lua_setfenv) (lua_State *L, int idx);
  156. /*
  157. ** `load' and `call' functions (load and run Lua code)
  158. */
  159. LUA_API void (lua_call) (lua_State *L, int nargs, int nresults);
  160. LUA_API int (lua_pcall) (lua_State *L, int nargs, int nresults, int errfunc);
  161. LUA_API int (lua_cpcall) (lua_State *L, lua_CFunction func, void *ud);
  162. LUA_API int (lua_load) (lua_State *L, lua_Reader reader, void *dt,
  163. const char *chunkname);
  164. LUA_API int (lua_dumpEx) (lua_State *L, lua_Writer writer, void *data, int stripping);
  165. /*
  166. ** coroutine functions
  167. */
  168. LUA_API int (lua_yield) (lua_State *L, int nresults);
  169. LUA_API int (lua_resume) (lua_State *L, int narg);
  170. LUA_API int (lua_status) (lua_State *L);
  171. /*
  172. ** garbage-collection function and options
  173. */
  174. #define LUA_GCSTOP 0
  175. #define LUA_GCRESTART 1
  176. #define LUA_GCCOLLECT 2
  177. #define LUA_GCCOUNT 3
  178. #define LUA_GCCOUNTB 4
  179. #define LUA_GCSTEP 5
  180. #define LUA_GCSETPAUSE 6
  181. #define LUA_GCSETSTEPMUL 7
  182. #define LUA_GCSETMEMLIMIT 8
  183. #define LUA_GCGETMEMLIMIT 9
  184. LUA_API int (lua_gc) (lua_State *L, int what, int data);
  185. /*
  186. ** miscellaneous functions
  187. */
  188. LUA_API int (lua_error) (lua_State *L);
  189. LUA_API int (lua_next) (lua_State *L, int idx);
  190. LUA_API void (lua_concat) (lua_State *L, int n);
  191. LUA_API lua_Alloc (lua_getallocf) (lua_State *L, void **ud);
  192. LUA_API void lua_setallocf (lua_State *L, lua_Alloc f, void *ud);
  193. /*
  194. ** ===============================================================
  195. ** some useful macros
  196. ** ===============================================================
  197. */
  198. #define lua_pop(L,n) lua_settop(L, -(n)-1)
  199. #define lua_newtable(L) lua_createtable(L, 0, 0)
  200. #define lua_register(L,n,f) (lua_pushcfunction(L, (f)), lua_setglobal(L, (n)))
  201. #define lua_pushcfunction(L,f) lua_pushcclosure(L, (f), 0)
  202. #define lua_strlen(L,i) lua_objlen(L, (i))
  203. #define lua_isfunction(L,n) (lua_type(L, (n)) == LUA_TFUNCTION)
  204. #define lua_islightfunction(L,n) (lua_fulltype(L, (n)) == LUA_TLIGHTFUNCTION)
  205. #define lua_istable(L,n) (lua_type(L, (n)) == LUA_TTABLE)
  206. #define lua_isrotable(L,n) (lua_fulltype(L, (n)) == LUA_TROTABLE)
  207. #define lua_islightuserdata(L,n) (lua_type(L, (n)) == LUA_TLIGHTUSERDATA)
  208. #define lua_isnil(L,n) (lua_type(L, (n)) == LUA_TNIL)
  209. #define lua_isboolean(L,n) (lua_type(L, (n)) == LUA_TBOOLEAN)
  210. #define lua_isthread(L,n) (lua_type(L, (n)) == LUA_TTHREAD)
  211. #define lua_isnone(L,n) (lua_type(L, (n)) == LUA_TNONE)
  212. #define lua_isnoneornil(L, n) (lua_type(L, (n)) <= 0)
  213. #define lua_pushliteral(L, s) \
  214. lua_pushlstring(L, "" s, (sizeof(s)/sizeof(char))-1)
  215. #define lua_setglobal(L,s) lua_setfield(L, LUA_GLOBALSINDEX, (s))
  216. #define lua_getglobal(L,s) lua_getfield(L, LUA_GLOBALSINDEX, (s))
  217. #define lua_tostring(L,i) lua_tolstring(L, (i), NULL)
  218. #define lua_dump(L,w,d) lua_dumpEx(L,w,d,0)
  219. /* error codes from cross-compiler returned by lua_dumpEx */
  220. /* target integer is too small to hold a value */
  221. #define LUA_ERR_CC_INTOVERFLOW 101
  222. /* target lua_Number is integral but a constant is non-integer */
  223. #define LUA_ERR_CC_NOTINTEGER 102
  224. /*
  225. ** compatibility macros and functions
  226. */
  227. // BogdanM: modified for eLua interrupt support
  228. lua_State* lua_open(void);
  229. lua_State* lua_getstate(void);
  230. #define lua_getregistry(L) lua_pushvalue(L, LUA_REGISTRYINDEX)
  231. #define lua_getgccount(L) lua_gc(L, LUA_GCCOUNT, 0)
  232. #define lua_Chunkreader lua_Reader
  233. #define lua_Chunkwriter lua_Writer
  234. /* hack */
  235. LUA_API void lua_setlevel (lua_State *from, lua_State *to);
  236. /*
  237. ** {======================================================================
  238. ** Debug API
  239. ** =======================================================================
  240. */
  241. /*
  242. ** Event codes
  243. */
  244. #define LUA_HOOKCALL 0
  245. #define LUA_HOOKRET 1
  246. #define LUA_HOOKLINE 2
  247. #define LUA_HOOKCOUNT 3
  248. #define LUA_HOOKTAILRET 4
  249. /*
  250. ** Event masks
  251. */
  252. #define LUA_MASKCALL (1 << LUA_HOOKCALL)
  253. #define LUA_MASKRET (1 << LUA_HOOKRET)
  254. #define LUA_MASKLINE (1 << LUA_HOOKLINE)
  255. #define LUA_MASKCOUNT (1 << LUA_HOOKCOUNT)
  256. typedef struct lua_Debug lua_Debug; /* activation record */
  257. /* Functions to be called by the debuger in specific events */
  258. typedef void (*lua_Hook) (lua_State *L, lua_Debug *ar);
  259. LUA_API int lua_getstack (lua_State *L, int level, lua_Debug *ar);
  260. LUA_API int lua_getinfo (lua_State *L, const char *what, lua_Debug *ar);
  261. LUA_API const char *lua_getlocal (lua_State *L, const lua_Debug *ar, int n);
  262. LUA_API const char *lua_setlocal (lua_State *L, const lua_Debug *ar, int n);
  263. LUA_API const char *lua_getupvalue (lua_State *L, int funcindex, int n);
  264. LUA_API const char *lua_setupvalue (lua_State *L, int funcindex, int n);
  265. LUA_API int lua_sethook (lua_State *L, lua_Hook func, int mask, int count);
  266. LUA_API lua_Hook lua_gethook (lua_State *L);
  267. LUA_API int lua_gethookmask (lua_State *L);
  268. LUA_API int lua_gethookcount (lua_State *L);
  269. struct lua_Debug {
  270. int event;
  271. const char *name; /* (n) */
  272. const char *namewhat; /* (n) `global', `local', `field', `method' */
  273. const char *what; /* (S) `Lua', `C', `main', `tail' */
  274. const char *source; /* (S) */
  275. int currentline; /* (l) */
  276. int nups; /* (u) number of upvalues */
  277. int linedefined; /* (S) */
  278. int lastlinedefined; /* (S) */
  279. char short_src[LUA_IDSIZE]; /* (S) */
  280. /* private part */
  281. int i_ci; /* active function */
  282. };
  283. /* }====================================================================== */
  284. typedef struct ROTable ROTable;
  285. typedef const struct ROTable_entry ROTable_entry;
  286. LUA_API void (lua_pushrotable) (lua_State *L, const ROTable *p);
  287. LUA_API void (lua_createrotable) (lua_State *L, ROTable *t, ROTable_entry *e, ROTable *mt);
  288. LUAI_FUNC int lua_lfsreload (lua_State *L);
  289. LUAI_FUNC int lua_lfsindex (lua_State *L);
  290. #define EGC_NOT_ACTIVE 0 // EGC disabled
  291. #define EGC_ON_ALLOC_FAILURE 1 // run EGC on allocation failure
  292. #define EGC_ON_MEM_LIMIT 2 // run EGC when an upper memory limit is hit
  293. #define EGC_ALWAYS 4 // always run EGC before an allocation
  294. #ifdef LUA_USE_ESP
  295. #define LUA_QUEUE_APP 0
  296. #define LUA_QUEUE_UART 1
  297. #define LUA_TASK_LOW 0
  298. #define LUA_TASK_MEDIUM 1
  299. #define LUA_TASK_HIGH 2
  300. /**DEBUG**/extern void dbg_printf(const char *fmt, ...)
  301. __attribute__ ((format (printf, 1, 2)));
  302. #define luaN_freearray(L,b,l) luaM_freearray(L,b,l,sizeof(*b));
  303. LUA_API void lua_setegcmode(lua_State *L, int mode, int limit);
  304. #else
  305. #define ICACHE_RODATA_ATTR
  306. #define dbg_printf printf
  307. #endif
  308. #ifdef DEVELOPMENT_USE_GDB
  309. LUALIB_API void (lua_debugbreak)(void);
  310. #else
  311. #define lua_debugbreak() (void)(0)
  312. #endif
  313. // EGC operations modes
  314. #define EGC_NOT_ACTIVE 0 // EGC disabled
  315. #define EGC_ON_ALLOC_FAILURE 1 // run EGC on allocation failure
  316. #define EGC_ON_MEM_LIMIT 2 // run EGC when an upper memory limit is hit
  317. #define EGC_ALWAYS 4 // always run EGC before an allocation
  318. void legc_set_mode(lua_State *L, int mode, int limit);
  319. /******************************************************************************
  320. * Copyright (C) 1994-2008 Lua.org, PUC-Rio. All rights reserved.
  321. *
  322. * Permission is hereby granted, free of charge, to any person obtaining
  323. * a copy of this software and associated documentation files (the
  324. * "Software"), to deal in the Software without restriction, including
  325. * without limitation the rights to use, copy, modify, merge, publish,
  326. * distribute, sublicense, and/or sell copies of the Software, and to
  327. * permit persons to whom the Software is furnished to do so, subject to
  328. * the following conditions:
  329. *
  330. * The above copyright notice and this permission notice shall be
  331. * included in all copies or substantial portions of the Software.
  332. *
  333. * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  334. * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  335. * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
  336. * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
  337. * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
  338. * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  339. * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  340. ******************************************************************************/
  341. #endif