2 ** Lua - A Scripting Language
3 ** Lua.org, PUC-Rio, Brazil (http://www.lua.org)
4 ** See Copyright Notice at the end of this file
18 #define LUA_VERSION_MAJOR "5"
19 #define LUA_VERSION_MINOR "3"
20 #define LUA_VERSION_NUM 503
21 #define LUA_VERSION_RELEASE "6"
23 #define LUA_VERSION "Lua " LUA_VERSION_MAJOR "." LUA_VERSION_MINOR
24 #define LUA_RELEASE LUA_VERSION "." LUA_VERSION_RELEASE
25 #define LUA_COPYRIGHT LUA_RELEASE " Copyright (C) 1994-2020 Lua.org, PUC-Rio"
26 #define LUA_AUTHORS "R. Ierusalimschy, L. H. de Figueiredo, W. Celes"
29 /* mark for precompiled code ('<esc>Lua') */
30 #define LUA_SIGNATURE "\x1bLua"
32 /* option for multiple returns in 'lua_pcall' and 'lua_call' */
33 #define LUA_MULTRET (-1)
38 ** (-LUAI_MAXSTACK is the minimum valid index; we keep some free empty
39 ** space after that to help overflow detection)
41 #define LUA_REGISTRYINDEX (-LUAI_MAXSTACK - 1000)
42 #define lua_upvalueindex(i) (LUA_REGISTRYINDEX - (i))
49 #define LUA_ERRSYNTAX 3
55 typedef struct lua_State lua_State
;
61 #define LUA_TNONE (-1)
64 #define LUA_TBOOLEAN 1
65 #define LUA_TLIGHTUSERDATA 2
69 #define LUA_TFUNCTION 6
70 #define LUA_TUSERDATA 7
77 /* minimum Lua stack available to a C function */
78 #define LUA_MINSTACK 20
81 /* predefined values in the registry */
82 #define LUA_RIDX_MAINTHREAD 1
83 #define LUA_RIDX_GLOBALS 2
84 #define LUA_RIDX_LAST LUA_RIDX_GLOBALS
87 /* type of numbers in Lua */
88 typedef LUA_NUMBER lua_Number
;
91 /* type for integer functions */
92 typedef LUA_INTEGER lua_Integer
;
94 /* unsigned integer type */
95 typedef LUA_UNSIGNED lua_Unsigned
;
97 /* type for continuation-function contexts */
98 typedef LUA_KCONTEXT lua_KContext
;
102 ** Type for C functions registered with Lua
104 typedef int (*lua_CFunction
) (lua_State
*L
);
107 ** Type for continuation functions
109 typedef int (*lua_KFunction
) (lua_State
*L
, int status
, lua_KContext ctx
);
113 ** Type for functions that read/write blocks when loading/dumping Lua chunks
115 typedef const char * (*lua_Reader
) (lua_State
*L
, void *ud
, size_t *sz
);
117 typedef int (*lua_Writer
) (lua_State
*L
, const void *p
, size_t sz
, void *ud
);
121 ** Type for memory-allocation functions
123 typedef void * (*lua_Alloc
) (void *ud
, void *ptr
, size_t osize
, size_t nsize
);
128 ** generic extra include file
130 #if defined(LUA_USER_H)
138 extern const char lua_ident
[];
142 ** state manipulation
144 LUA_API lua_State
*(lua_newstate
) (lua_Alloc f
, void *ud
);
145 LUA_API
void (lua_close
) (lua_State
*L
);
146 LUA_API lua_State
*(lua_newthread
) (lua_State
*L
);
148 LUA_API
lua_CFunction (lua_atpanic
) (lua_State
*L
, lua_CFunction panicf
);
151 LUA_API
const lua_Number
*(lua_version
) (lua_State
*L
);
155 ** basic stack manipulation
157 LUA_API
int (lua_absindex
) (lua_State
*L
, int idx
);
158 LUA_API
int (lua_gettop
) (lua_State
*L
);
159 LUA_API
void (lua_settop
) (lua_State
*L
, int idx
);
160 LUA_API
void (lua_pushvalue
) (lua_State
*L
, int idx
);
161 LUA_API
void (lua_rotate
) (lua_State
*L
, int idx
, int n
);
162 LUA_API
void (lua_copy
) (lua_State
*L
, int fromidx
, int toidx
);
163 LUA_API
int (lua_checkstack
) (lua_State
*L
, int n
);
165 LUA_API
void (lua_xmove
) (lua_State
*from
, lua_State
*to
, int n
);
169 ** access functions (stack -> C)
172 LUA_API
int (lua_isnumber
) (lua_State
*L
, int idx
);
173 LUA_API
int (lua_isstring
) (lua_State
*L
, int idx
);
174 LUA_API
int (lua_iscfunction
) (lua_State
*L
, int idx
);
175 LUA_API
int (lua_isinteger
) (lua_State
*L
, int idx
);
176 LUA_API
int (lua_isuserdata
) (lua_State
*L
, int idx
);
177 LUA_API
int (lua_type
) (lua_State
*L
, int idx
);
178 LUA_API
const char *(lua_typename
) (lua_State
*L
, int tp
);
180 LUA_API
lua_Number (lua_tonumberx
) (lua_State
*L
, int idx
, int *isnum
);
181 LUA_API
lua_Integer (lua_tointegerx
) (lua_State
*L
, int idx
, int *isnum
);
182 LUA_API
int (lua_toboolean
) (lua_State
*L
, int idx
);
183 LUA_API
const char *(lua_tolstring
) (lua_State
*L
, int idx
, size_t *len
);
184 LUA_API
size_t (lua_rawlen
) (lua_State
*L
, int idx
);
185 LUA_API
lua_CFunction (lua_tocfunction
) (lua_State
*L
, int idx
);
186 LUA_API
void *(lua_touserdata
) (lua_State
*L
, int idx
);
187 LUA_API lua_State
*(lua_tothread
) (lua_State
*L
, int idx
);
188 LUA_API
const void *(lua_topointer
) (lua_State
*L
, int idx
);
192 ** Comparison and arithmetic functions
195 #define LUA_OPADD 0 /* ORDER TM, ORDER OP */
208 #define LUA_OPBNOT 13
210 LUA_API
void (lua_arith
) (lua_State
*L
, int op
);
216 LUA_API
int (lua_rawequal
) (lua_State
*L
, int idx1
, int idx2
);
217 LUA_API
int (lua_compare
) (lua_State
*L
, int idx1
, int idx2
, int op
);
221 ** push functions (C -> stack)
223 LUA_API
void (lua_pushnil
) (lua_State
*L
);
224 LUA_API
void (lua_pushnumber
) (lua_State
*L
, lua_Number n
);
225 LUA_API
void (lua_pushinteger
) (lua_State
*L
, lua_Integer n
);
226 LUA_API
const char *(lua_pushlstring
) (lua_State
*L
, const char *s
, size_t len
);
227 LUA_API
const char *(lua_pushstring
) (lua_State
*L
, const char *s
);
228 LUA_API
const char *(lua_pushvfstring
) (lua_State
*L
, const char *fmt
,
230 LUA_API
const char *(lua_pushfstring
) (lua_State
*L
, const char *fmt
, ...);
231 LUA_API
void (lua_pushcclosure
) (lua_State
*L
, lua_CFunction fn
, int n
);
232 LUA_API
void (lua_pushboolean
) (lua_State
*L
, int b
);
233 LUA_API
void (lua_pushlightuserdata
) (lua_State
*L
, void *p
);
234 LUA_API
int (lua_pushthread
) (lua_State
*L
);
238 ** get functions (Lua -> stack)
240 LUA_API
int (lua_getglobal
) (lua_State
*L
, const char *name
);
241 LUA_API
int (lua_gettable
) (lua_State
*L
, int idx
);
242 LUA_API
int (lua_getfield
) (lua_State
*L
, int idx
, const char *k
);
243 LUA_API
int (lua_geti
) (lua_State
*L
, int idx
, lua_Integer n
);
244 LUA_API
int (lua_rawget
) (lua_State
*L
, int idx
);
245 LUA_API
int (lua_rawgeti
) (lua_State
*L
, int idx
, lua_Integer n
);
246 LUA_API
int (lua_rawgetp
) (lua_State
*L
, int idx
, const void *p
);
248 LUA_API
void (lua_createtable
) (lua_State
*L
, int narr
, int nrec
);
249 LUA_API
void *(lua_newuserdata
) (lua_State
*L
, size_t sz
);
250 LUA_API
int (lua_getmetatable
) (lua_State
*L
, int objindex
);
251 LUA_API
int (lua_getuservalue
) (lua_State
*L
, int idx
);
255 ** set functions (stack -> Lua)
257 LUA_API
void (lua_setglobal
) (lua_State
*L
, const char *name
);
258 LUA_API
void (lua_settable
) (lua_State
*L
, int idx
);
259 LUA_API
void (lua_setfield
) (lua_State
*L
, int idx
, const char *k
);
260 LUA_API
void (lua_seti
) (lua_State
*L
, int idx
, lua_Integer n
);
261 LUA_API
void (lua_rawset
) (lua_State
*L
, int idx
);
262 LUA_API
void (lua_rawseti
) (lua_State
*L
, int idx
, lua_Integer n
);
263 LUA_API
void (lua_rawsetp
) (lua_State
*L
, int idx
, const void *p
);
264 LUA_API
int (lua_setmetatable
) (lua_State
*L
, int objindex
);
265 LUA_API
void (lua_setuservalue
) (lua_State
*L
, int idx
);
269 ** 'load' and 'call' functions (load and run Lua code)
271 LUA_API
void (lua_callk
) (lua_State
*L
, int nargs
, int nresults
,
272 lua_KContext ctx
, lua_KFunction k
);
273 #define lua_call(L,n,r) lua_callk(L, (n), (r), 0, NULL)
275 LUA_API
int (lua_pcallk
) (lua_State
*L
, int nargs
, int nresults
, int errfunc
,
276 lua_KContext ctx
, lua_KFunction k
);
277 #define lua_pcall(L,n,r,f) lua_pcallk(L, (n), (r), (f), 0, NULL)
279 LUA_API
int (lua_load
) (lua_State
*L
, lua_Reader reader
, void *dt
,
280 const char *chunkname
, const char *mode
);
282 LUA_API
int (lua_dump
) (lua_State
*L
, lua_Writer writer
, void *data
, int strip
);
286 ** coroutine functions
288 LUA_API
int (lua_yieldk
) (lua_State
*L
, int nresults
, lua_KContext ctx
,
290 LUA_API
int (lua_resume
) (lua_State
*L
, lua_State
*from
, int narg
);
291 LUA_API
int (lua_status
) (lua_State
*L
);
292 LUA_API
int (lua_isyieldable
) (lua_State
*L
);
294 #define lua_yield(L,n) lua_yieldk(L, (n), 0, NULL)
298 ** garbage-collection function and options
302 #define LUA_GCRESTART 1
303 #define LUA_GCCOLLECT 2
304 #define LUA_GCCOUNT 3
305 #define LUA_GCCOUNTB 4
307 #define LUA_GCSETPAUSE 6
308 #define LUA_GCSETSTEPMUL 7
309 #define LUA_GCISRUNNING 9
311 LUA_API
int (lua_gc
) (lua_State
*L
, int what
, int data
);
315 ** miscellaneous functions
318 LUA_API
int (lua_error
) (lua_State
*L
);
320 LUA_API
int (lua_next
) (lua_State
*L
, int idx
);
322 LUA_API
void (lua_concat
) (lua_State
*L
, int n
);
323 LUA_API
void (lua_len
) (lua_State
*L
, int idx
);
325 LUA_API
size_t (lua_stringtonumber
) (lua_State
*L
, const char *s
);
327 LUA_API
lua_Alloc (lua_getallocf
) (lua_State
*L
, void **ud
);
328 LUA_API
void (lua_setallocf
) (lua_State
*L
, lua_Alloc f
, void *ud
);
333 ** {==============================================================
334 ** some useful macros
335 ** ===============================================================
338 #define lua_getextraspace(L) ((void *)((char *)(L) - LUA_EXTRASPACE))
340 #define lua_tonumber(L,i) lua_tonumberx(L,(i),NULL)
341 #define lua_tointeger(L,i) lua_tointegerx(L,(i),NULL)
343 #define lua_pop(L,n) lua_settop(L, -(n)-1)
345 #define lua_newtable(L) lua_createtable(L, 0, 0)
347 #define lua_register(L,n,f) (lua_pushcfunction(L, (f)), lua_setglobal(L, (n)))
349 #define lua_pushcfunction(L,f) lua_pushcclosure(L, (f), 0)
351 #define lua_isfunction(L,n) (lua_type(L, (n)) == LUA_TFUNCTION)
352 #define lua_istable(L,n) (lua_type(L, (n)) == LUA_TTABLE)
353 #define lua_islightuserdata(L,n) (lua_type(L, (n)) == LUA_TLIGHTUSERDATA)
354 #define lua_isnil(L,n) (lua_type(L, (n)) == LUA_TNIL)
355 #define lua_isboolean(L,n) (lua_type(L, (n)) == LUA_TBOOLEAN)
356 #define lua_isthread(L,n) (lua_type(L, (n)) == LUA_TTHREAD)
357 #define lua_isnone(L,n) (lua_type(L, (n)) == LUA_TNONE)
358 #define lua_isnoneornil(L, n) (lua_type(L, (n)) <= 0)
360 #define lua_pushliteral(L, s) lua_pushstring(L, "" s)
362 #define lua_pushglobaltable(L) \
363 ((void)lua_rawgeti(L, LUA_REGISTRYINDEX, LUA_RIDX_GLOBALS))
365 #define lua_tostring(L,i) lua_tolstring(L, (i), NULL)
368 #define lua_insert(L,idx) lua_rotate(L, (idx), 1)
370 #define lua_remove(L,idx) (lua_rotate(L, (idx), -1), lua_pop(L, 1))
372 #define lua_replace(L,idx) (lua_copy(L, -1, (idx)), lua_pop(L, 1))
374 /* }============================================================== */
378 ** {==============================================================
379 ** compatibility macros for unsigned conversions
380 ** ===============================================================
382 #if defined(LUA_COMPAT_APIINTCASTS)
384 #define lua_pushunsigned(L,n) lua_pushinteger(L, (lua_Integer)(n))
385 #define lua_tounsignedx(L,i,is) ((lua_Unsigned)lua_tointegerx(L,i,is))
386 #define lua_tounsigned(L,i) lua_tounsignedx(L,(i),NULL)
389 /* }============================================================== */
392 ** {======================================================================
394 ** =======================================================================
401 #define LUA_HOOKCALL 0
402 #define LUA_HOOKRET 1
403 #define LUA_HOOKLINE 2
404 #define LUA_HOOKCOUNT 3
405 #define LUA_HOOKTAILCALL 4
411 #define LUA_MASKCALL (1 << LUA_HOOKCALL)
412 #define LUA_MASKRET (1 << LUA_HOOKRET)
413 #define LUA_MASKLINE (1 << LUA_HOOKLINE)
414 #define LUA_MASKCOUNT (1 << LUA_HOOKCOUNT)
416 typedef struct lua_Debug lua_Debug
; /* activation record */
419 /* Functions to be called by the debugger in specific events */
420 typedef void (*lua_Hook
) (lua_State
*L
, lua_Debug
*ar
);
423 LUA_API
int (lua_getstack
) (lua_State
*L
, int level
, lua_Debug
*ar
);
424 LUA_API
int (lua_getinfo
) (lua_State
*L
, const char *what
, lua_Debug
*ar
);
425 LUA_API
const char *(lua_getlocal
) (lua_State
*L
, const lua_Debug
*ar
, int n
);
426 LUA_API
const char *(lua_setlocal
) (lua_State
*L
, const lua_Debug
*ar
, int n
);
427 LUA_API
const char *(lua_getupvalue
) (lua_State
*L
, int funcindex
, int n
);
428 LUA_API
const char *(lua_setupvalue
) (lua_State
*L
, int funcindex
, int n
);
430 LUA_API
void *(lua_upvalueid
) (lua_State
*L
, int fidx
, int n
);
431 LUA_API
void (lua_upvaluejoin
) (lua_State
*L
, int fidx1
, int n1
,
434 LUA_API
void (lua_sethook
) (lua_State
*L
, lua_Hook func
, int mask
, int count
);
435 LUA_API
lua_Hook (lua_gethook
) (lua_State
*L
);
436 LUA_API
int (lua_gethookmask
) (lua_State
*L
);
437 LUA_API
int (lua_gethookcount
) (lua_State
*L
);
442 const char *name
; /* (n) */
443 const char *namewhat
; /* (n) 'global', 'local', 'field', 'method' */
444 const char *what
; /* (S) 'Lua', 'C', 'main', 'tail' */
445 const char *source
; /* (S) */
446 int currentline
; /* (l) */
447 int linedefined
; /* (S) */
448 int lastlinedefined
; /* (S) */
449 unsigned char nups
; /* (u) number of upvalues */
450 unsigned char nparams
;/* (u) number of parameters */
451 char isvararg
; /* (u) */
452 char istailcall
; /* (t) */
453 char short_src
[LUA_IDSIZE
]; /* (S) */
455 struct CallInfo
*i_ci
; /* active function */
458 /* }====================================================================== */
461 /******************************************************************************
462 * Copyright (C) 1994-2020 Lua.org, PUC-Rio.
464 * Permission is hereby granted, free of charge, to any person obtaining
465 * a copy of this software and associated documentation files (the
466 * "Software"), to deal in the Software without restriction, including
467 * without limitation the rights to use, copy, modify, merge, publish,
468 * distribute, sublicense, and/or sell copies of the Software, and to
469 * permit persons to whom the Software is furnished to do so, subject to
470 * the following conditions:
472 * The above copyright notice and this permission notice shall be
473 * included in all copies or substantial portions of the Software.
475 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
476 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
477 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
478 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
479 * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
480 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
481 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
482 ******************************************************************************/