2
** $Id: lua.h,v 1.285 2013/03/15 13:04:22 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 LUA_VERSION_MAJOR "5"
20
#define LUA_VERSION_MINOR "2"
21
#define LUA_VERSION_NUM 502
22
#define LUA_VERSION_RELEASE "2"
24
#define LUA_VERSION "Lua " LUA_VERSION_MAJOR "." LUA_VERSION_MINOR
25
#define LUA_RELEASE LUA_VERSION "." LUA_VERSION_RELEASE
26
#define LUA_COPYRIGHT LUA_RELEASE " Copyright (C) 1994-2013 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 LUAI_FIRSTPSEUDOIDX
41
#define lua_upvalueindex(i) (LUA_REGISTRYINDEX - (i))
48
#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
92
/* minimum Lua stack available to a C function */
93
#define LUA_MINSTACK 20
96
/* predefined values in the registry */
97
#define LUA_RIDX_MAINTHREAD 1
98
#define LUA_RIDX_GLOBALS 2
99
#define LUA_RIDX_LAST LUA_RIDX_GLOBALS
102
/* type of numbers in Lua */
103
typedef LUA_NUMBER lua_Number;
106
/* type for integer functions */
107
typedef LUA_INTEGER lua_Integer;
109
/* unsigned integer type */
110
typedef LUA_UNSIGNED lua_Unsigned;
115
** generic extra include file
117
#if defined(LUA_USER_H)
125
extern const char lua_ident[];
129
** state manipulation
131
LUA_API lua_State *(lua_newstate) (lua_Alloc f, void *ud);
132
LUA_API void (lua_close) (lua_State *L);
133
LUA_API lua_State *(lua_newthread) (lua_State *L);
135
LUA_API lua_CFunction (lua_atpanic) (lua_State *L, lua_CFunction panicf);
138
LUA_API const lua_Number *(lua_version) (lua_State *L);
142
** basic stack manipulation
144
LUA_API int (lua_absindex) (lua_State *L, int idx);
145
LUA_API int (lua_gettop) (lua_State *L);
146
LUA_API void (lua_settop) (lua_State *L, int idx);
147
LUA_API void (lua_pushvalue) (lua_State *L, int idx);
148
LUA_API void (lua_remove) (lua_State *L, int idx);
149
LUA_API void (lua_insert) (lua_State *L, int idx);
150
LUA_API void (lua_replace) (lua_State *L, int idx);
151
LUA_API void (lua_copy) (lua_State *L, int fromidx, int toidx);
152
LUA_API int (lua_checkstack) (lua_State *L, int sz);
154
LUA_API void (lua_xmove) (lua_State *from, lua_State *to, int n);
158
** access functions (stack -> C)
161
LUA_API int (lua_isnumber) (lua_State *L, int idx);
162
LUA_API int (lua_isstring) (lua_State *L, int idx);
163
LUA_API int (lua_iscfunction) (lua_State *L, int idx);
164
LUA_API int (lua_isuserdata) (lua_State *L, int idx);
165
LUA_API int (lua_type) (lua_State *L, int idx);
166
LUA_API const char *(lua_typename) (lua_State *L, int tp);
168
LUA_API lua_Number (lua_tonumberx) (lua_State *L, int idx, int *isnum);
169
LUA_API lua_Integer (lua_tointegerx) (lua_State *L, int idx, int *isnum);
170
LUA_API lua_Unsigned (lua_tounsignedx) (lua_State *L, int idx, int *isnum);
171
LUA_API int (lua_toboolean) (lua_State *L, int idx);
172
LUA_API const char *(lua_tolstring) (lua_State *L, int idx, size_t *len);
173
LUA_API size_t (lua_rawlen) (lua_State *L, int idx);
174
LUA_API lua_CFunction (lua_tocfunction) (lua_State *L, int idx);
175
LUA_API void *(lua_touserdata) (lua_State *L, int idx);
176
LUA_API lua_State *(lua_tothread) (lua_State *L, int idx);
177
LUA_API const void *(lua_topointer) (lua_State *L, int idx);
181
** Comparison and arithmetic functions
184
#define LUA_OPADD 0 /* ORDER TM */
192
LUA_API void (lua_arith) (lua_State *L, int op);
198
LUA_API int (lua_rawequal) (lua_State *L, int idx1, int idx2);
199
LUA_API int (lua_compare) (lua_State *L, int idx1, int idx2, int op);
203
** push functions (C -> stack)
205
LUA_API void (lua_pushnil) (lua_State *L);
206
LUA_API void (lua_pushnumber) (lua_State *L, lua_Number n);
207
LUA_API void (lua_pushinteger) (lua_State *L, lua_Integer n);
208
LUA_API void (lua_pushunsigned) (lua_State *L, lua_Unsigned n);
209
LUA_API const char *(lua_pushlstring) (lua_State *L, const char *s, size_t l);
210
LUA_API const char *(lua_pushstring) (lua_State *L, const char *s);
211
LUA_API const char *(lua_pushvfstring) (lua_State *L, const char *fmt,
213
LUA_API const char *(lua_pushfstring) (lua_State *L, const char *fmt, ...);
214
LUA_API void (lua_pushcclosure) (lua_State *L, lua_CFunction fn, int n);
215
LUA_API void (lua_pushboolean) (lua_State *L, int b);
216
LUA_API void (lua_pushlightuserdata) (lua_State *L, void *p);
217
LUA_API int (lua_pushthread) (lua_State *L);
221
** get functions (Lua -> stack)
223
LUA_API void (lua_getglobal) (lua_State *L, const char *var);
224
LUA_API void (lua_gettable) (lua_State *L, int idx);
225
LUA_API void (lua_getfield) (lua_State *L, int idx, const char *k);
226
LUA_API void (lua_rawget) (lua_State *L, int idx);
227
LUA_API void (lua_rawgeti) (lua_State *L, int idx, int n);
228
LUA_API void (lua_rawgetp) (lua_State *L, int idx, const void *p);
229
LUA_API void (lua_createtable) (lua_State *L, int narr, int nrec);
230
LUA_API void *(lua_newuserdata) (lua_State *L, size_t sz);
231
LUA_API int (lua_getmetatable) (lua_State *L, int objindex);
232
LUA_API void (lua_getuservalue) (lua_State *L, int idx);
236
** set functions (stack -> Lua)
238
LUA_API void (lua_setglobal) (lua_State *L, const char *var);
239
LUA_API void (lua_settable) (lua_State *L, int idx);
240
LUA_API void (lua_setfield) (lua_State *L, int idx, const char *k);
241
LUA_API void (lua_rawset) (lua_State *L, int idx);
242
LUA_API void (lua_rawseti) (lua_State *L, int idx, int n);
243
LUA_API void (lua_rawsetp) (lua_State *L, int idx, const void *p);
244
LUA_API int (lua_setmetatable) (lua_State *L, int objindex);
245
LUA_API void (lua_setuservalue) (lua_State *L, int idx);
249
** 'load' and 'call' functions (load and run Lua code)
251
LUA_API void (lua_callk) (lua_State *L, int nargs, int nresults, int ctx,
253
#define lua_call(L,n,r) lua_callk(L, (n), (r), 0, NULL)
255
LUA_API int (lua_getctx) (lua_State *L, int *ctx);
257
LUA_API int (lua_pcallk) (lua_State *L, int nargs, int nresults, int errfunc,
258
int ctx, lua_CFunction k);
259
#define lua_pcall(L,n,r,f) lua_pcallk(L, (n), (r), (f), 0, NULL)
261
LUA_API int (lua_load) (lua_State *L, lua_Reader reader, void *dt,
262
const char *chunkname,
265
LUA_API int (lua_dump) (lua_State *L, lua_Writer writer, void *data);
269
** coroutine functions
271
LUA_API int (lua_yieldk) (lua_State *L, int nresults, int ctx,
273
#define lua_yield(L,n) lua_yieldk(L, (n), 0, NULL)
274
LUA_API int (lua_resume) (lua_State *L, lua_State *from, int narg);
275
LUA_API int (lua_status) (lua_State *L);
278
** garbage-collection function and options
282
#define LUA_GCRESTART 1
283
#define LUA_GCCOLLECT 2
284
#define LUA_GCCOUNT 3
285
#define LUA_GCCOUNTB 4
287
#define LUA_GCSETPAUSE 6
288
#define LUA_GCSETSTEPMUL 7
289
#define LUA_GCSETMAJORINC 8
290
#define LUA_GCISRUNNING 9
294
LUA_API int (lua_gc) (lua_State *L, int what, int data);
298
** miscellaneous functions
301
LUA_API int (lua_error) (lua_State *L);
303
LUA_API int (lua_next) (lua_State *L, int idx);
305
LUA_API void (lua_concat) (lua_State *L, int n);
306
LUA_API void (lua_len) (lua_State *L, int idx);
308
LUA_API lua_Alloc (lua_getallocf) (lua_State *L, void **ud);
309
LUA_API void (lua_setallocf) (lua_State *L, lua_Alloc f, void *ud);
314
** ===============================================================
315
** some useful macros
316
** ===============================================================
319
#define lua_tonumber(L,i) lua_tonumberx(L,i,NULL)
320
#define lua_tointeger(L,i) lua_tointegerx(L,i,NULL)
321
#define lua_tounsigned(L,i) lua_tounsignedx(L,i,NULL)
323
#define lua_pop(L,n) lua_settop(L, -(n)-1)
325
#define lua_newtable(L) lua_createtable(L, 0, 0)
327
#define lua_register(L,n,f) (lua_pushcfunction(L, (f)), lua_setglobal(L, (n)))
329
#define lua_pushcfunction(L,f) lua_pushcclosure(L, (f), 0)
331
#define lua_isfunction(L,n) (lua_type(L, (n)) == LUA_TFUNCTION)
332
#define lua_istable(L,n) (lua_type(L, (n)) == LUA_TTABLE)
333
#define lua_islightuserdata(L,n) (lua_type(L, (n)) == LUA_TLIGHTUSERDATA)
334
#define lua_isnil(L,n) (lua_type(L, (n)) == LUA_TNIL)
335
#define lua_isboolean(L,n) (lua_type(L, (n)) == LUA_TBOOLEAN)
336
#define lua_isthread(L,n) (lua_type(L, (n)) == LUA_TTHREAD)
337
#define lua_isnone(L,n) (lua_type(L, (n)) == LUA_TNONE)
338
#define lua_isnoneornil(L, n) (lua_type(L, (n)) <= 0)
340
#define lua_pushliteral(L, s) \
341
lua_pushlstring(L, "" s, (sizeof(s)/sizeof(char))-1)
343
#define lua_pushglobaltable(L) \
344
lua_rawgeti(L, LUA_REGISTRYINDEX, LUA_RIDX_GLOBALS)
346
#define lua_tostring(L,i) lua_tolstring(L, (i), NULL)
351
** {======================================================================
353
** =======================================================================
360
#define LUA_HOOKCALL 0
361
#define LUA_HOOKRET 1
362
#define LUA_HOOKLINE 2
363
#define LUA_HOOKCOUNT 3
364
#define LUA_HOOKTAILCALL 4
370
#define LUA_MASKCALL (1 << LUA_HOOKCALL)
371
#define LUA_MASKRET (1 << LUA_HOOKRET)
372
#define LUA_MASKLINE (1 << LUA_HOOKLINE)
373
#define LUA_MASKCOUNT (1 << LUA_HOOKCOUNT)
375
typedef struct lua_Debug lua_Debug; /* activation record */
378
/* Functions to be called by the debugger in specific events */
379
typedef void (*lua_Hook) (lua_State *L, lua_Debug *ar);
382
LUA_API int (lua_getstack) (lua_State *L, int level, lua_Debug *ar);
383
LUA_API int (lua_getinfo) (lua_State *L, const char *what, lua_Debug *ar);
384
LUA_API const char *(lua_getlocal) (lua_State *L, const lua_Debug *ar, int n);
385
LUA_API const char *(lua_setlocal) (lua_State *L, const lua_Debug *ar, int n);
386
LUA_API const char *(lua_getupvalue) (lua_State *L, int funcindex, int n);
387
LUA_API const char *(lua_setupvalue) (lua_State *L, int funcindex, int n);
389
LUA_API void *(lua_upvalueid) (lua_State *L, int fidx, int n);
390
LUA_API void (lua_upvaluejoin) (lua_State *L, int fidx1, int n1,
393
LUA_API int (lua_sethook) (lua_State *L, lua_Hook func, int mask, int count);
394
LUA_API lua_Hook (lua_gethook) (lua_State *L);
395
LUA_API int (lua_gethookmask) (lua_State *L);
396
LUA_API int (lua_gethookcount) (lua_State *L);
401
const char *name; /* (n) */
402
const char *namewhat; /* (n) 'global', 'local', 'field', 'method' */
403
const char *what; /* (S) 'Lua', 'C', 'main', 'tail' */
404
const char *source; /* (S) */
405
int currentline; /* (l) */
406
int linedefined; /* (S) */
407
int lastlinedefined; /* (S) */
408
unsigned char nups; /* (u) number of upvalues */
409
unsigned char nparams;/* (u) number of parameters */
410
char isvararg; /* (u) */
411
char istailcall; /* (t) */
412
char short_src[LUA_IDSIZE]; /* (S) */
414
struct CallInfo *i_ci; /* active function */
417
/* }====================================================================== */
420
/******************************************************************************
421
* Copyright (C) 1994-2013 Lua.org, PUC-Rio.
423
* Permission is hereby granted, free of charge, to any person obtaining
424
* a copy of this software and associated documentation files (the
425
* "Software"), to deal in the Software without restriction, including
426
* without limitation the rights to use, copy, modify, merge, publish,
427
* distribute, sublicense, and/or sell copies of the Software, and to
428
* permit persons to whom the Software is furnished to do so, subject to
429
* the following conditions:
431
* The above copyright notice and this permission notice shall be
432
* included in all copies or substantial portions of the Software.
434
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
435
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
436
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
437
* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
438
* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
439
* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
440
* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
441
******************************************************************************/