lua.h 11 KB

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