lua.h 12 KB

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