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
23 #define LUA_VERSION "Lua 5.1"
24 #define LUA_RELEASE "Lua 5.1.4"
25 #define LUA_VERSION_NUM 501
26 #define LUA_COPYRIGHT "Copyright (C) 1994-2008 Lua.org, PUC-Rio"
27 #define LUA_AUTHORS "R. Ierusalimschy, L. H. de Figueiredo & W. Celes"
30 /* mark for precompiled code (`<esc>Lua') */
31 #define LUA_SIGNATURE "\033Lua"
33 /* option for multiple returns in `lua_pcall' and `lua_call' */
34 #define LUA_MULTRET (-1)
40 #define LUA_REGISTRYINDEX (-10000)
41 #define LUA_ENVIRONINDEX (-10001)
42 #define LUA_GLOBALSINDEX (-10002)
43 #define lua_upvalueindex(i) (LUA_GLOBALSINDEX-(i))
46 /* thread status; 0 is OK */
49 #define LUA_ERRSYNTAX 3
54 typedef struct lua_State lua_State;
56 typedef int (*lua_CFunction) (lua_State *L);
60 ** functions that read/write blocks when loading/dumping Lua chunks
62 typedef const char * (*lua_Reader) (lua_State *L, void *ud, size_t *sz);
64 typedef int (*lua_Writer) (lua_State *L, const void* p, size_t sz, void* ud);
68 ** prototype for memory-allocation functions
70 typedef void * (*lua_Alloc) (void *ud, void *ptr, size_t osize, size_t nsize);
76 #define LUA_TNONE (-1)
79 #define LUA_TBOOLEAN 1
80 #define LUA_TLIGHTUSERDATA 2
84 #define LUA_TFUNCTION 6
85 #define LUA_TUSERDATA 7
90 /* minimum Lua stack available to a C function */
91 #define LUA_MINSTACK 20
95 ** generic extra include file
97 #if defined(LUA_USER_H)
102 /* type of numbers in Lua */
103 typedef LUA_NUMBER lua_Number;
106 /* type for integer functions */
107 typedef LUA_INTEGER lua_Integer;
112 ** state manipulation
114 LUA_API lua_State *(lua_newstate) (lua_Alloc f, void *ud);
115 LUA_API void (lua_close) (lua_State *L);
116 LUA_API lua_State *(lua_newthread) (lua_State *L);
118 LUA_API lua_CFunction (lua_atpanic) (lua_State *L, lua_CFunction panicf);
122 ** basic stack manipulation
124 LUA_API int (lua_gettop) (lua_State *L);
125 LUA_API void (lua_settop) (lua_State *L, int idx);
126 LUA_API void (lua_pushvalue) (lua_State *L, int idx);
127 LUA_API void (lua_remove) (lua_State *L, int idx);
128 LUA_API void (lua_insert) (lua_State *L, int idx);
129 LUA_API void (lua_replace) (lua_State *L, int idx);
130 LUA_API int (lua_checkstack) (lua_State *L, int sz);
132 LUA_API void (lua_xmove) (lua_State *from, lua_State *to, int n);
136 ** access functions (stack -> C)
139 LUA_API int (lua_isnumber) (lua_State *L, int idx);
140 LUA_API int (lua_isstring) (lua_State *L, int idx);
141 LUA_API int (lua_iscfunction) (lua_State *L, int idx);
142 LUA_API int (lua_isuserdata) (lua_State *L, int idx);
143 LUA_API int (lua_type) (lua_State *L, int idx);
144 LUA_API const char *(lua_typename) (lua_State *L, int tp);
146 LUA_API int (lua_equal) (lua_State *L, int idx1, int idx2);
147 LUA_API int (lua_rawequal) (lua_State *L, int idx1, int idx2);
148 LUA_API int (lua_lessthan) (lua_State *L, int idx1, int idx2);
150 LUA_API lua_Number (lua_tonumber) (lua_State *L, int idx);
151 LUA_API lua_Integer (lua_tointeger) (lua_State *L, int idx);
152 LUA_API int (lua_toboolean) (lua_State *L, int idx);
153 LUA_API const char *(lua_tolstring) (lua_State *L, int idx, size_t *len);
154 LUA_API size_t (lua_objlen) (lua_State *L, int idx);
155 LUA_API lua_CFunction (lua_tocfunction) (lua_State *L, int idx);
156 LUA_API void *(lua_touserdata) (lua_State *L, int idx);
157 LUA_API lua_State *(lua_tothread) (lua_State *L, int idx);
158 LUA_API const void *(lua_topointer) (lua_State *L, int idx);
162 ** push functions (C -> stack)
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 void (lua_pushlstring) (lua_State *L, const char *s, size_t l);
168 LUA_API void (lua_pushstring) (lua_State *L, const char *s);
169 LUA_API const char *(lua_pushvfstring) (lua_State *L, const char *fmt,
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);
179 ** get functions (Lua -> stack)
181 LUA_API void (lua_gettable) (lua_State *L, int idx);
182 LUA_API void (lua_getfield) (lua_State *L, int idx, const char *k);
183 LUA_API void (lua_rawget) (lua_State *L, int idx);
184 LUA_API void (lua_rawgeti) (lua_State *L, int idx, int n);
185 LUA_API void (lua_createtable) (lua_State *L, int narr, int nrec);
186 LUA_API void *(lua_newuserdata) (lua_State *L, size_t sz);
187 LUA_API int (lua_getmetatable) (lua_State *L, int objindex);
188 LUA_API void (lua_getfenv) (lua_State *L, int idx);
192 ** set functions (stack -> Lua)
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_rawset) (lua_State *L, int idx);
197 LUA_API void (lua_rawseti) (lua_State *L, int idx, int n);
198 LUA_API int (lua_setmetatable) (lua_State *L, int objindex);
199 LUA_API int (lua_setfenv) (lua_State *L, int idx);
203 ** `load' and `call' functions (load and run Lua code)
205 LUA_API void (lua_call) (lua_State *L, int nargs, int nresults);
206 LUA_API int (lua_pcall) (lua_State *L, int nargs, int nresults, int errfunc);
207 LUA_API int (lua_cpcall) (lua_State *L, lua_CFunction func, void *ud);
208 LUA_API int (lua_load) (lua_State *L, lua_Reader reader, void *dt,
209 const char *chunkname);
211 LUA_API int (lua_dump) (lua_State *L, lua_Writer writer, void *data);
215 ** coroutine functions
217 LUA_API int (lua_yield) (lua_State *L, int nresults);
218 LUA_API int (lua_resume) (lua_State *L, int narg);
219 LUA_API int (lua_status) (lua_State *L);
222 ** garbage-collection function and options
226 #define LUA_GCRESTART 1
227 #define LUA_GCCOLLECT 2
228 #define LUA_GCCOUNT 3
229 #define LUA_GCCOUNTB 4
231 #define LUA_GCSETPAUSE 6
232 #define LUA_GCSETSTEPMUL 7
234 LUA_API int (lua_gc) (lua_State *L, int what, int data);
238 ** miscellaneous functions
241 LUA_API int (lua_error) (lua_State *L);
243 LUA_API int (lua_next) (lua_State *L, int idx);
245 LUA_API void (lua_concat) (lua_State *L, int n);
247 LUA_API lua_Alloc (lua_getallocf) (lua_State *L, void **ud);
248 LUA_API void lua_setallocf (lua_State *L, lua_Alloc f, void *ud);
253 ** ===============================================================
254 ** some useful macros
255 ** ===============================================================
258 #define lua_pop(L,n) lua_settop(L, -(n)-1)
260 #define lua_newtable(L) lua_createtable(L, 0, 0)
262 #define lua_register(L,n,f) (lua_pushcfunction(L, (f)), lua_setglobal(L, (n)))
264 #define lua_pushcfunction(L,f) lua_pushcclosure(L, (f), 0)
266 #define lua_strlen(L,i) lua_objlen(L, (i))
268 #define lua_isfunction(L,n) (lua_type(L, (n)) == LUA_TFUNCTION)
269 #define lua_istable(L,n) (lua_type(L, (n)) == LUA_TTABLE)
270 #define lua_islightuserdata(L,n) (lua_type(L, (n)) == LUA_TLIGHTUSERDATA)
271 #define lua_isnil(L,n) (lua_type(L, (n)) == LUA_TNIL)
272 #define lua_isboolean(L,n) (lua_type(L, (n)) == LUA_TBOOLEAN)
273 #define lua_isthread(L,n) (lua_type(L, (n)) == LUA_TTHREAD)
274 #define lua_isnone(L,n) (lua_type(L, (n)) == LUA_TNONE)
275 #define lua_isnoneornil(L, n) (lua_type(L, (n)) <= 0)
277 #define lua_pushliteral(L, s) \
278 lua_pushlstring(L, "" s, (sizeof(s)/sizeof(char))-1)
280 #define lua_setglobal(L,s) lua_setfield(L, LUA_GLOBALSINDEX, (s))
281 #define lua_getglobal(L,s) lua_getfield(L, LUA_GLOBALSINDEX, (s))
283 #define lua_tostring(L,i) lua_tolstring(L, (i), NULL)
288 ** compatibility macros and functions
291 #define lua_open() luaL_newstate()
293 #define lua_getregistry(L) lua_pushvalue(L, LUA_REGISTRYINDEX)
295 #define lua_getgccount(L) lua_gc(L, LUA_GCCOUNT, 0)
297 #define lua_Chunkreader lua_Reader
298 #define lua_Chunkwriter lua_Writer
302 LUA_API void lua_setlevel (lua_State *from, lua_State *to);
306 ** {======================================================================
308 ** =======================================================================
315 #define LUA_HOOKCALL 0
316 #define LUA_HOOKRET 1
317 #define LUA_HOOKLINE 2
318 #define LUA_HOOKCOUNT 3
319 #define LUA_HOOKTAILRET 4
325 #define LUA_MASKCALL (1 << LUA_HOOKCALL)
326 #define LUA_MASKRET (1 << LUA_HOOKRET)
327 #define LUA_MASKLINE (1 << LUA_HOOKLINE)
328 #define LUA_MASKCOUNT (1 << LUA_HOOKCOUNT)
330 typedef struct lua_Debug lua_Debug; /* activation record */
333 /* Functions to be called by the debuger in specific events */
334 typedef void (*lua_Hook) (lua_State *L, lua_Debug *ar);
337 LUA_API int lua_getstack (lua_State *L, int level, lua_Debug *ar);
338 LUA_API int lua_getinfo (lua_State *L, const char *what, lua_Debug *ar);
339 LUA_API const char *lua_getlocal (lua_State *L, const lua_Debug *ar, int n);
340 LUA_API const char *lua_setlocal (lua_State *L, const lua_Debug *ar, int n);
341 LUA_API const char *lua_getupvalue (lua_State *L, int funcindex, int n);
342 LUA_API const char *lua_setupvalue (lua_State *L, int funcindex, int n);
344 LUA_API int lua_sethook (lua_State *L, lua_Hook func, int mask, int count);
345 LUA_API lua_Hook lua_gethook (lua_State *L);
346 LUA_API int lua_gethookmask (lua_State *L);
347 LUA_API int lua_gethookcount (lua_State *L);
352 const char *name; /* (n) */
353 const char *namewhat; /* (n) `global', `local', `field', `method' */
354 const char *what; /* (S) `Lua', `C', `main', `tail' */
355 const char *source; /* (S) */
356 int currentline; /* (l) */
357 int nups; /* (u) number of upvalues */
358 int linedefined; /* (S) */
359 int lastlinedefined; /* (S) */
360 char short_src[LUA_IDSIZE]; /* (S) */
362 int i_ci; /* active function */
365 /* }====================================================================== */
368 /******************************************************************************
369 * Copyright (C) 1994-2008 Lua.org, PUC-Rio. All rights reserved.
371 * Permission is hereby granted, free of charge, to any person obtaining
372 * a copy of this software and associated documentation files (the
373 * "Software"), to deal in the Software without restriction, including
374 * without limitation the rights to use, copy, modify, merge, publish,
375 * distribute, sublicense, and/or sell copies of the Software, and to
376 * permit persons to whom the Software is furnished to do so, subject to
377 * the following conditions:
379 * The above copyright notice and this permission notice shall be
380 * included in all copies or substantial portions of the Software.
382 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
383 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
384 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
385 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
386 * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
387 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
388 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
389 ******************************************************************************/