2 ** $Id: lua.h,v 1.285.1.2 2013/11/11 12:09:16 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
19 #define clearerr(x) (void)0
24 #define LUA_VERSION_MAJOR "5"
25 #define LUA_VERSION_MINOR "2"
26 #define LUA_VERSION_NUM 502
27 #define LUA_VERSION_RELEASE "3"
29 #define LUA_VERSION "Lua " LUA_VERSION_MAJOR "." LUA_VERSION_MINOR
30 #define LUA_RELEASE LUA_VERSION "." LUA_VERSION_RELEASE
31 #define LUA_COPYRIGHT LUA_RELEASE " Copyright (C) 1994-2013 Lua.org, PUC-Rio"
32 #define LUA_AUTHORS "R. Ierusalimschy, L. H. de Figueiredo, W. Celes"
35 /* mark for precompiled code ('<esc>Lua') */
36 #define LUA_SIGNATURE "\033Lua"
38 /* option for multiple returns in 'lua_pcall' and 'lua_call' */
39 #define LUA_MULTRET (-1)
45 #define LUA_REGISTRYINDEX LUAI_FIRSTPSEUDOIDX
46 #define lua_upvalueindex(i) (LUA_REGISTRYINDEX - (i))
53 #define LUA_ERRSYNTAX 3
59 typedef struct lua_State lua_State;
61 typedef int (*lua_CFunction) (lua_State *L);
65 ** functions that read/write blocks when loading/dumping Lua chunks
67 typedef const char * (*lua_Reader) (lua_State *L, void *ud, size_t *sz);
69 typedef int (*lua_Writer) (lua_State *L, const void* p, size_t sz, void* ud);
73 ** prototype for memory-allocation functions
75 typedef void * (*lua_Alloc) (void *ud, void *ptr, size_t osize, size_t nsize);
81 #define LUA_TNONE (-1)
84 #define LUA_TBOOLEAN 1
85 #define LUA_TLIGHTUSERDATA 2
89 #define LUA_TFUNCTION 6
90 #define LUA_TUSERDATA 7
97 /* minimum Lua stack available to a C function */
98 #define LUA_MINSTACK 20
101 /* predefined values in the registry */
102 #define LUA_RIDX_MAINTHREAD 1
103 #define LUA_RIDX_GLOBALS 2
104 #define LUA_RIDX_LAST LUA_RIDX_GLOBALS
107 /* type of numbers in Lua */
108 typedef LUA_NUMBER lua_Number;
111 /* type for integer functions */
112 typedef LUA_INTEGER lua_Integer;
114 /* unsigned integer type */
115 typedef LUA_UNSIGNED lua_Unsigned;
120 ** generic extra include file
122 #if defined(LUA_USER_H)
130 extern const char lua_ident[];
134 ** state manipulation
136 LUA_API lua_State *(lua_newstate) (lua_Alloc f, void *ud);
137 LUA_API void (lua_close) (lua_State *L);
138 LUA_API lua_State *(lua_newthread) (lua_State *L);
140 LUA_API lua_CFunction (lua_atpanic) (lua_State *L, lua_CFunction panicf);
143 LUA_API const lua_Number *(lua_version) (lua_State *L);
147 ** basic stack manipulation
149 LUA_API int (lua_absindex) (lua_State *L, int idx);
150 LUA_API int (lua_gettop) (lua_State *L);
151 LUA_API void (lua_settop) (lua_State *L, int idx);
152 LUA_API void (lua_pushvalue) (lua_State *L, int idx);
153 LUA_API void (lua_remove) (lua_State *L, int idx);
154 LUA_API void (lua_insert) (lua_State *L, int idx);
155 LUA_API void (lua_replace) (lua_State *L, int idx);
156 LUA_API void (lua_copy) (lua_State *L, int fromidx, int toidx);
157 LUA_API int (lua_checkstack) (lua_State *L, int sz);
159 LUA_API void (lua_xmove) (lua_State *from, lua_State *to, int n);
163 ** access functions (stack -> C)
166 LUA_API int (lua_isnumber) (lua_State *L, int idx);
167 LUA_API int (lua_isstring) (lua_State *L, int idx);
168 LUA_API int (lua_iscfunction) (lua_State *L, int idx);
169 LUA_API int (lua_isuserdata) (lua_State *L, int idx);
170 LUA_API int (lua_type) (lua_State *L, int idx);
171 LUA_API const char *(lua_typename) (lua_State *L, int tp);
173 LUA_API lua_Number (lua_tonumberx) (lua_State *L, int idx, int *isnum);
174 LUA_API lua_Integer (lua_tointegerx) (lua_State *L, int idx, int *isnum);
175 LUA_API lua_Unsigned (lua_tounsignedx) (lua_State *L, int idx, int *isnum);
176 LUA_API int (lua_toboolean) (lua_State *L, int idx);
177 LUA_API const char *(lua_tolstring) (lua_State *L, int idx, size_t *len);
178 LUA_API size_t (lua_rawlen) (lua_State *L, int idx);
179 LUA_API lua_CFunction (lua_tocfunction) (lua_State *L, int idx);
180 LUA_API void *(lua_touserdata) (lua_State *L, int idx);
181 LUA_API lua_State *(lua_tothread) (lua_State *L, int idx);
182 LUA_API const void *(lua_topointer) (lua_State *L, int idx);
186 ** Comparison and arithmetic functions
189 #define LUA_OPADD 0 /* ORDER TM */
197 LUA_API void (lua_arith) (lua_State *L, int op);
203 LUA_API int (lua_rawequal) (lua_State *L, int idx1, int idx2);
204 LUA_API int (lua_compare) (lua_State *L, int idx1, int idx2, int op);
208 ** push functions (C -> stack)
210 LUA_API void (lua_pushnil) (lua_State *L);
211 LUA_API void (lua_pushnumber) (lua_State *L, lua_Number n);
212 LUA_API void (lua_pushinteger) (lua_State *L, lua_Integer n);
213 LUA_API void (lua_pushunsigned) (lua_State *L, lua_Unsigned n);
214 LUA_API const char *(lua_pushlstring) (lua_State *L, const char *s, size_t l);
215 LUA_API const char *(lua_pushstring) (lua_State *L, const char *s);
216 LUA_API const char *(lua_pushvfstring) (lua_State *L, const char *fmt,
218 LUA_API const char *(lua_pushfstring) (lua_State *L, const char *fmt, ...);
219 LUA_API void (lua_pushcclosure) (lua_State *L, lua_CFunction fn, int n);
220 LUA_API void (lua_pushboolean) (lua_State *L, int b);
221 LUA_API void (lua_pushlightuserdata) (lua_State *L, void *p);
222 LUA_API int (lua_pushthread) (lua_State *L);
226 ** get functions (Lua -> stack)
228 LUA_API void (lua_getglobal) (lua_State *L, const char *var);
229 LUA_API void (lua_gettable) (lua_State *L, int idx);
230 LUA_API void (lua_getfield) (lua_State *L, int idx, const char *k);
231 LUA_API void (lua_rawget) (lua_State *L, int idx);
232 LUA_API void (lua_rawgeti) (lua_State *L, int idx, int n);
233 LUA_API void (lua_rawgetp) (lua_State *L, int idx, const void *p);
234 LUA_API void (lua_createtable) (lua_State *L, int narr, int nrec);
235 LUA_API void *(lua_newuserdata) (lua_State *L, size_t sz);
236 LUA_API int (lua_getmetatable) (lua_State *L, int objindex);
237 LUA_API void (lua_getuservalue) (lua_State *L, int idx);
241 ** set functions (stack -> Lua)
243 LUA_API void (lua_setglobal) (lua_State *L, const char *var);
244 LUA_API void (lua_settable) (lua_State *L, int idx);
245 LUA_API void (lua_setfield) (lua_State *L, int idx, const char *k);
246 LUA_API void (lua_rawset) (lua_State *L, int idx);
247 LUA_API void (lua_rawseti) (lua_State *L, int idx, int n);
248 LUA_API void (lua_rawsetp) (lua_State *L, int idx, const void *p);
249 LUA_API int (lua_setmetatable) (lua_State *L, int objindex);
250 LUA_API void (lua_setuservalue) (lua_State *L, int idx);
254 ** 'load' and 'call' functions (load and run Lua code)
256 LUA_API void (lua_callk) (lua_State *L, int nargs, int nresults, int ctx,
258 #define lua_call(L,n,r) lua_callk(L, (n), (r), 0, NULL)
260 LUA_API int (lua_getctx) (lua_State *L, int *ctx);
262 LUA_API int (lua_pcallk) (lua_State *L, int nargs, int nresults, int errfunc,
263 int ctx, lua_CFunction k);
264 #define lua_pcall(L,n,r,f) lua_pcallk(L, (n), (r), (f), 0, NULL)
266 LUA_API int (lua_load) (lua_State *L, lua_Reader reader, void *dt,
267 const char *chunkname,
270 LUA_API int (lua_dump) (lua_State *L, lua_Writer writer, void *data);
274 ** coroutine functions
276 LUA_API int (lua_yieldk) (lua_State *L, int nresults, int ctx,
278 #define lua_yield(L,n) lua_yieldk(L, (n), 0, NULL)
279 LUA_API int (lua_resume) (lua_State *L, lua_State *from, int narg);
280 LUA_API int (lua_status) (lua_State *L);
283 ** garbage-collection function and options
287 #define LUA_GCRESTART 1
288 #define LUA_GCCOLLECT 2
289 #define LUA_GCCOUNT 3
290 #define LUA_GCCOUNTB 4
292 #define LUA_GCSETPAUSE 6
293 #define LUA_GCSETSTEPMUL 7
294 #define LUA_GCSETMAJORINC 8
295 #define LUA_GCISRUNNING 9
299 LUA_API int (lua_gc) (lua_State *L, int what, int data);
303 ** miscellaneous functions
306 LUA_API int (lua_error) (lua_State *L);
308 LUA_API int (lua_next) (lua_State *L, int idx);
310 LUA_API void (lua_concat) (lua_State *L, int n);
311 LUA_API void (lua_len) (lua_State *L, int idx);
313 LUA_API lua_Alloc (lua_getallocf) (lua_State *L, void **ud);
314 LUA_API void (lua_setallocf) (lua_State *L, lua_Alloc f, void *ud);
319 ** ===============================================================
320 ** some useful macros
321 ** ===============================================================
324 #define lua_tonumber(L,i) lua_tonumberx(L,i,NULL)
325 #define lua_tointeger(L,i) lua_tointegerx(L,i,NULL)
326 #define lua_tounsigned(L,i) lua_tounsignedx(L,i,NULL)
328 #define lua_pop(L,n) lua_settop(L, -(n)-1)
330 #define lua_newtable(L) lua_createtable(L, 0, 0)
332 #define lua_register(L,n,f) (lua_pushcfunction(L, (f)), lua_setglobal(L, (n)))
334 #define lua_pushcfunction(L,f) lua_pushcclosure(L, (f), 0)
336 #define lua_isfunction(L,n) (lua_type(L, (n)) == LUA_TFUNCTION)
337 #define lua_istable(L,n) (lua_type(L, (n)) == LUA_TTABLE)
338 #define lua_islightuserdata(L,n) (lua_type(L, (n)) == LUA_TLIGHTUSERDATA)
339 #define lua_isnil(L,n) (lua_type(L, (n)) == LUA_TNIL)
340 #define lua_isboolean(L,n) (lua_type(L, (n)) == LUA_TBOOLEAN)
341 #define lua_isthread(L,n) (lua_type(L, (n)) == LUA_TTHREAD)
342 #define lua_isnone(L,n) (lua_type(L, (n)) == LUA_TNONE)
343 #define lua_isnoneornil(L, n) (lua_type(L, (n)) <= 0)
345 #define lua_pushliteral(L, s) \
346 lua_pushlstring(L, "" s, (sizeof(s)/sizeof(char))-1)
348 #define lua_pushglobaltable(L) \
349 lua_rawgeti(L, LUA_REGISTRYINDEX, LUA_RIDX_GLOBALS)
351 #define lua_tostring(L,i) lua_tolstring(L, (i), NULL)
356 ** {======================================================================
358 ** =======================================================================
365 #define LUA_HOOKCALL 0
366 #define LUA_HOOKRET 1
367 #define LUA_HOOKLINE 2
368 #define LUA_HOOKCOUNT 3
369 #define LUA_HOOKTAILCALL 4
375 #define LUA_MASKCALL (1 << LUA_HOOKCALL)
376 #define LUA_MASKRET (1 << LUA_HOOKRET)
377 #define LUA_MASKLINE (1 << LUA_HOOKLINE)
378 #define LUA_MASKCOUNT (1 << LUA_HOOKCOUNT)
380 typedef struct lua_Debug lua_Debug; /* activation record */
383 /* Functions to be called by the debugger in specific events */
384 typedef void (*lua_Hook) (lua_State *L, lua_Debug *ar);
387 LUA_API int (lua_getstack) (lua_State *L, int level, lua_Debug *ar);
388 LUA_API int (lua_getinfo) (lua_State *L, const char *what, lua_Debug *ar);
389 LUA_API const char *(lua_getlocal) (lua_State *L, const lua_Debug *ar, int n);
390 LUA_API const char *(lua_setlocal) (lua_State *L, const lua_Debug *ar, int n);
391 LUA_API const char *(lua_getupvalue) (lua_State *L, int funcindex, int n);
392 LUA_API const char *(lua_setupvalue) (lua_State *L, int funcindex, int n);
394 LUA_API void *(lua_upvalueid) (lua_State *L, int fidx, int n);
395 LUA_API void (lua_upvaluejoin) (lua_State *L, int fidx1, int n1,
398 LUA_API int (lua_sethook) (lua_State *L, lua_Hook func, int mask, int count);
399 LUA_API lua_Hook (lua_gethook) (lua_State *L);
400 LUA_API int (lua_gethookmask) (lua_State *L);
401 LUA_API int (lua_gethookcount) (lua_State *L);
406 const char *name; /* (n) */
407 const char *namewhat; /* (n) 'global', 'local', 'field', 'method' */
408 const char *what; /* (S) 'Lua', 'C', 'main', 'tail' */
409 const char *source; /* (S) */
410 int currentline; /* (l) */
411 int linedefined; /* (S) */
412 int lastlinedefined; /* (S) */
413 unsigned char nups; /* (u) number of upvalues */
414 unsigned char nparams;/* (u) number of parameters */
415 char isvararg; /* (u) */
416 char istailcall; /* (t) */
417 char short_src[LUA_IDSIZE]; /* (S) */
419 struct CallInfo *i_ci; /* active function */
422 /* }====================================================================== */
425 /******************************************************************************
426 * Copyright (C) 1994-2013 Lua.org, PUC-Rio.
428 * Permission is hereby granted, free of charge, to any person obtaining
429 * a copy of this software and associated documentation files (the
430 * "Software"), to deal in the Software without restriction, including
431 * without limitation the rights to use, copy, modify, merge, publish,
432 * distribute, sublicense, and/or sell copies of the Software, and to
433 * permit persons to whom the Software is furnished to do so, subject to
434 * the following conditions:
436 * The above copyright notice and this permission notice shall be
437 * included in all copies or substantial portions of the Software.
439 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
440 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
441 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
442 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
443 * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
444 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
445 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
446 ******************************************************************************/