diff --git a/3rdparty/lua/.gitignore b/3rdparty/lua/.gitignore deleted file mode 100644 index ae2899e..0000000 --- a/3rdparty/lua/.gitignore +++ /dev/null @@ -1,15 +0,0 @@ -.gitattributes - -*.so -*.o -*.a - -manual/manual.html - -testes/time.txt -testes/time-debug.txt - -testes/libs/all - -temp -lua diff --git a/3rdparty/lua/CMakeLists.txt b/3rdparty/lua/CMakeLists.txt index e31b292..36b0ccc 100644 --- a/3rdparty/lua/CMakeLists.txt +++ b/3rdparty/lua/CMakeLists.txt @@ -1,21 +1,67 @@ -cmake_minimum_required(VERSION 3.5) +cmake_minimum_required(VERSION 3.10) +project(lua) -# 获取上级目录名做为库名 -get_filename_component(CURRENT_DIR ${CMAKE_CURRENT_SOURCE_DIR} ABSOLUTE) -get_filename_component(LIBRARY_NAME ${CURRENT_DIR} NAME) +set(LUA_VERSION_MAJOR 5) +set(LUA_VERSION_MINOR 4) +set(LUA_VERSION_PATCH 4) -file(GLOB SOURCE_FILES "${PROJECT_SOURCE_DIR}/3rdparty/${LIBRARY_NAME}/*.c") +set(PJN_LUAEXE "lua") +set(PJN_LUALIB "lualib") -# 创建库 -add_library(${LIBRARY_NAME} ${SOURCE_FILES}) +set(LUA_SRC + src/lapi.c + src/lcode.c + src/lctype.c + src/ldebug.c + src/ldo.c + src/ldump.c + src/lfunc.c + src/lgc.c + src/llex.c + src/lmem.c + src/lobject.c + src/lopcodes.c + src/lparser.c + src/lstate.c + src/lstring.c + src/ltable.c + src/ltm.c + src/lundump.c + src/lvm.c + src/lzio.c + src/lauxlib.c + src/lbaselib.c + src/lcorolib.c + src/ldblib.c + src/liolib.c + src/lmathlib.c + src/loslib.c + src/lstrlib.c + src/ltablib.c + src/lutf8lib.c + src/loadlib.c + src/linit.c +) +include_directories(${PJN_LUALIB} include) +include_directories(${PJN_LUAEXE} include) +add_library(${PJN_LUALIB} STATIC ${LUA_SRC}) -# 将包含目录与目标相关联，这样只有在编译此库时才会包含这些目录 -target_include_directories(${LIBRARY_NAME} PUBLIC "${PROJECT_SOURCE_DIR}/3rdparty/${LIBRARY_NAME}") +add_executable(${PJN_LUAEXE} src/lua.c) +target_link_libraries(${PJN_LUAEXE} ${PJN_LUALIB}) -# 如果需要，可以设置C++标准 -# target_compile_features(${LIBRARY_NAME} PUBLIC cxx_std_11) -add_subdirectory(luac) +set_target_properties(${PJN_LUAEXE} PROPERTIES OUTPUT_NAME lua) +set_target_properties(${PJN_LUALIB} PROPERTIES OUTPUT_NAME lua) +#set_target_properties(${PJN_LUAEXE} PROPERTIES OUTPUT_NAME_DEBUG "${PJN_LUAEXE}_d" OUTPUT_NAME_RELEASE ${PJN_LUAEXE}) +#set_target_properties(${PJN_LUALIB} PROPERTIES OUTPUT_NAME_DEBUG "${PJN_LUALIB}_d" OUTPUT_NAME_RELEASE ${PJN_LUALIB}) + +set_property(TARGET ${PJN_LUALIB} PROPERTY FOLDER "3rdparty") +set_property(TARGET ${PJN_LUAEXE} PROPERTY FOLDER "3rdparty") + +install(TARGETS ${PJN_LUAEXE} DESTINATION $,bin/debug/3rdparty,bin/release/3rdparty>) +install(DIRECTORY include DESTINATION bin/debug/3rdparty) +install(DIRECTORY include DESTINATION bin/release/3rdparty) + + +install(TARGETS ${PJN_LUALIB} DESTINATION $,bin/debug/3rdparty/lib,bin/release/3rdparty/lib>) -# 设置 Visual Studio 中的文件夹 -set_property(TARGET ${LIBRARY_NAME} PROPERTY FOLDER "3rdparty") \ No newline at end of file diff --git a/3rdparty/lua/README.md b/3rdparty/lua/README.md deleted file mode 100644 index 5bc0ee7..0000000 --- a/3rdparty/lua/README.md +++ /dev/null @@ -1,7 +0,0 @@ -# Lua - -This is the repository of Lua development code, as seen by the Lua team. It contains the full history of all commits but is mirrored irregularly. For complete information about Lua, visit [Lua.org](https://www.lua.org/). - -Please **do not** send pull requests. To report issues, post a message to the [Lua mailing list](https://www.lua.org/lua-l.html). - -Download official Lua releases from [Lua.org](https://www.lua.org/download.html). diff --git a/3rdparty/lua/all b/3rdparty/lua/all deleted file mode 100644 index 86f38ac..0000000 --- a/3rdparty/lua/all +++ /dev/null @@ -1,9 +0,0 @@ -make -s -j -cd testes/libs; make -s -cd .. # back to directory 'testes' -ulimit -S -s 1100 -if { ../lua -W all.lua; } then - echo -e "\n\n final OK!!!!\n\n" -else - echo -e "\n\n >>>> BUG!!!!\n\n" -fi diff --git a/3rdparty/lua/lapi.h b/3rdparty/lua/include/lapi.h similarity index 70% rename from 3rdparty/lua/lapi.h rename to 3rdparty/lua/include/lapi.h index 9e99cc4..a742427 100644 --- a/3rdparty/lua/lapi.h +++ b/3rdparty/lua/include/lapi.h @@ -12,23 +12,26 @@ #include "lstate.h" -/* Increments 'L->top', checking for stack overflows */ -#define api_incr_top(L) {L->top++; api_check(L, L->top <= L->ci->top, \ - "stack overflow");} +/* Increments 'L->top.p', checking for stack overflows */ +#define api_incr_top(L) {L->top.p++; \ + api_check(L, L->top.p <= L->ci->top.p, \ + "stack overflow");} /* ** If a call returns too many multiple returns, the callee may not have ** stack space to accommodate all results. In this case, this macro -** increases its stack space ('L->ci->top'). +** increases its stack space ('L->ci->top.p'). */ #define adjustresults(L,nres) \ - { if ((nres) <= LUA_MULTRET && L->ci->top < L->top) L->ci->top = L->top; } + { if ((nres) <= LUA_MULTRET && L->ci->top.p < L->top.p) \ + L->ci->top.p = L->top.p; } /* Ensure the stack has at least 'n' elements */ -#define api_checknelems(L,n) api_check(L, (n) < (L->top - L->ci->func), \ - "not enough elements in the stack") +#define api_checknelems(L,n) \ + api_check(L, (n) < (L->top.p - L->ci->func.p), \ + "not enough elements in the stack") /* diff --git a/3rdparty/lua/lauxlib.h b/3rdparty/lua/include/lauxlib.h similarity index 97% rename from 3rdparty/lua/lauxlib.h rename to 3rdparty/lua/include/lauxlib.h index 72f70e7..5b977e2 100644 --- a/3rdparty/lua/lauxlib.h +++ b/3rdparty/lua/include/lauxlib.h @@ -102,7 +102,7 @@ LUALIB_API lua_State *(luaL_newstate) (void); LUALIB_API lua_Integer (luaL_len) (lua_State *L, int idx); -LUALIB_API void luaL_addgsub (luaL_Buffer *b, const char *s, +LUALIB_API void (luaL_addgsub) (luaL_Buffer *b, const char *s, const char *p, const char *r); LUALIB_API const char *(luaL_gsub) (lua_State *L, const char *s, const char *p, const char *r); @@ -154,6 +154,14 @@ LUALIB_API void (luaL_requiref) (lua_State *L, const char *modname, #define luaL_loadbuffer(L,s,sz,n) luaL_loadbufferx(L,s,sz,n,NULL) +/* +** Perform arithmetic operations on lua_Integer values with wrap-around +** semantics, as the Lua core does. +*/ +#define luaL_intop(op,v1,v2) \ + ((lua_Integer)((lua_Unsigned)(v1) op (lua_Unsigned)(v2))) + + /* push the value used to represent failure/error */ #define luaL_pushfail(L) lua_pushnil(L) diff --git a/3rdparty/lua/lcode.h b/3rdparty/lua/include/lcode.h similarity index 100% rename from 3rdparty/lua/lcode.h rename to 3rdparty/lua/include/lcode.h diff --git a/3rdparty/lua/lctype.h b/3rdparty/lua/include/lctype.h similarity index 100% rename from 3rdparty/lua/lctype.h rename to 3rdparty/lua/include/lctype.h diff --git a/3rdparty/lua/ldebug.h b/3rdparty/lua/include/ldebug.h similarity index 97% rename from 3rdparty/lua/ldebug.h rename to 3rdparty/lua/include/ldebug.h index 974960e..2c3074c 100644 --- a/3rdparty/lua/ldebug.h +++ b/3rdparty/lua/include/ldebug.h @@ -15,7 +15,7 @@ /* Active Lua function (given call info) */ -#define ci_func(ci) (clLvalue(s2v((ci)->func))) +#define ci_func(ci) (clLvalue(s2v((ci)->func.p))) #define resethookcount(L) (L->hookcount = L->basehookcount) diff --git a/3rdparty/lua/ldo.h b/3rdparty/lua/include/ldo.h similarity index 80% rename from 3rdparty/lua/ldo.h rename to 3rdparty/lua/include/ldo.h index 6bf0ed8..1aa446a 100644 --- a/3rdparty/lua/ldo.h +++ b/3rdparty/lua/include/ldo.h @@ -8,6 +8,7 @@ #define ldo_h +#include "llimits.h" #include "lobject.h" #include "lstate.h" #include "lzio.h" @@ -23,7 +24,7 @@ ** at every check. */ #define luaD_checkstackaux(L,n,pre,pos) \ - if (l_unlikely(L->stack_last - L->top <= (n))) \ + if (l_unlikely(L->stack_last.p - L->top.p <= (n))) \ { pre; luaD_growstack(L, n, 1); pos; } \ else { condmovestack(L,pre,pos); } @@ -32,11 +33,18 @@ -#define savestack(L,p) ((char *)(p) - (char *)L->stack) -#define restorestack(L,n) ((StkId)((char *)L->stack + (n))) +#define savestack(L,pt) (cast_charp(pt) - cast_charp(L->stack.p)) +#define restorestack(L,n) cast(StkId, cast_charp(L->stack.p) + (n)) /* macro to check stack size, preserving 'p' */ +#define checkstackp(L,n,p) \ + luaD_checkstackaux(L, n, \ + ptrdiff_t t__ = savestack(L, p), /* save 'p' */ \ + p = restorestack(L, t__)) /* 'pos' part: restore 'p' */ + + +/* macro to check stack size and GC, preserving 'p' */ #define checkstackGCp(L,n,p) \ luaD_checkstackaux(L, n, \ ptrdiff_t t__ = savestack(L, p); /* save 'p' */ \ @@ -58,11 +66,12 @@ LUAI_FUNC int luaD_protectedparser (lua_State *L, ZIO *z, const char *name, LUAI_FUNC void luaD_hook (lua_State *L, int event, int line, int fTransfer, int nTransfer); LUAI_FUNC void luaD_hookcall (lua_State *L, CallInfo *ci); -LUAI_FUNC void luaD_pretailcall (lua_State *L, CallInfo *ci, StkId func, int n); +LUAI_FUNC int luaD_pretailcall (lua_State *L, CallInfo *ci, StkId func, + int narg1, int delta); LUAI_FUNC CallInfo *luaD_precall (lua_State *L, StkId func, int nResults); LUAI_FUNC void luaD_call (lua_State *L, StkId func, int nResults); LUAI_FUNC void luaD_callnoyield (lua_State *L, StkId func, int nResults); -LUAI_FUNC void luaD_tryfuncTM (lua_State *L, StkId func); +LUAI_FUNC StkId luaD_tryfuncTM (lua_State *L, StkId func); LUAI_FUNC int luaD_closeprotected (lua_State *L, ptrdiff_t level, int status); LUAI_FUNC int luaD_pcall (lua_State *L, Pfunc func, void *u, ptrdiff_t oldtop, ptrdiff_t ef); diff --git a/3rdparty/lua/lfunc.h b/3rdparty/lua/include/lfunc.h similarity index 88% rename from 3rdparty/lua/lfunc.h rename to 3rdparty/lua/include/lfunc.h index dc1cebc..3be265e 100644 --- a/3rdparty/lua/lfunc.h +++ b/3rdparty/lua/include/lfunc.h @@ -29,10 +29,10 @@ #define MAXUPVAL 255 -#define upisopen(up) ((up)->v != &(up)->u.value) +#define upisopen(up) ((up)->v.p != &(up)->u.value) -#define uplevel(up) check_exp(upisopen(up), cast(StkId, (up)->v)) +#define uplevel(up) check_exp(upisopen(up), cast(StkId, (up)->v.p)) /* @@ -54,7 +54,7 @@ LUAI_FUNC void luaF_initupvals (lua_State *L, LClosure *cl); LUAI_FUNC UpVal *luaF_findupval (lua_State *L, StkId level); LUAI_FUNC void luaF_newtbcupval (lua_State *L, StkId level); LUAI_FUNC void luaF_closeupval (lua_State *L, StkId level); -LUAI_FUNC void luaF_close (lua_State *L, StkId level, int status, int yy); +LUAI_FUNC StkId luaF_close (lua_State *L, StkId level, int status, int yy); LUAI_FUNC void luaF_unlinkupval (UpVal *uv); LUAI_FUNC void luaF_freeproto (lua_State *L, Proto *f); LUAI_FUNC const char *luaF_getlocalname (const Proto *func, int local_number, diff --git a/3rdparty/lua/lgc.h b/3rdparty/lua/include/lgc.h similarity index 90% rename from 3rdparty/lua/lgc.h rename to 3rdparty/lua/include/lgc.h index 073e2a4..538f6ed 100644 --- a/3rdparty/lua/lgc.h +++ b/3rdparty/lua/include/lgc.h @@ -148,6 +148,16 @@ */ #define isdecGCmodegen(g) (g->gckind == KGC_GEN || g->lastatomic != 0) + +/* +** Control when GC is running: +*/ +#define GCSTPUSR 1 /* bit true when GC stopped by user */ +#define GCSTPGC 2 /* bit true when GC stopped by itself */ +#define GCSTPCLS 4 /* bit true when closing Lua state */ +#define gcrunning(g) ((g)->gcstp == 0) + + /* ** Does one step of collection when debt becomes positive. 'pre'/'pos' ** allows some adjustments to be done only when needed. macro @@ -162,24 +172,27 @@ #define luaC_checkGC(L) luaC_condGC(L,(void)0,(void)0) -#define luaC_barrier(L,p,v) ( \ - (iscollectable(v) && isblack(p) && iswhite(gcvalue(v))) ? \ - luaC_barrier_(L,obj2gco(p),gcvalue(v)) : cast_void(0)) - -#define luaC_barrierback(L,p,v) ( \ - (iscollectable(v) && isblack(p) && iswhite(gcvalue(v))) ? \ - luaC_barrierback_(L,p) : cast_void(0)) - #define luaC_objbarrier(L,p,o) ( \ (isblack(p) && iswhite(o)) ? \ luaC_barrier_(L,obj2gco(p),obj2gco(o)) : cast_void(0)) +#define luaC_barrier(L,p,v) ( \ + iscollectable(v) ? luaC_objbarrier(L,p,gcvalue(v)) : cast_void(0)) + +#define luaC_objbarrierback(L,p,o) ( \ + (isblack(p) && iswhite(o)) ? luaC_barrierback_(L,p) : cast_void(0)) + +#define luaC_barrierback(L,p,v) ( \ + iscollectable(v) ? luaC_objbarrierback(L, p, gcvalue(v)) : cast_void(0)) + LUAI_FUNC void luaC_fix (lua_State *L, GCObject *o); LUAI_FUNC void luaC_freeallobjects (lua_State *L); LUAI_FUNC void luaC_step (lua_State *L); LUAI_FUNC void luaC_runtilstate (lua_State *L, int statesmask); LUAI_FUNC void luaC_fullgc (lua_State *L, int isemergency); LUAI_FUNC GCObject *luaC_newobj (lua_State *L, int tt, size_t sz); +LUAI_FUNC GCObject *luaC_newobjdt (lua_State *L, int tt, size_t sz, + size_t offset); LUAI_FUNC void luaC_barrier_ (lua_State *L, GCObject *o, GCObject *v); LUAI_FUNC void luaC_barrierback_ (lua_State *L, GCObject *o); LUAI_FUNC void luaC_checkfinalizer (lua_State *L, GCObject *o, Table *mt); diff --git a/3rdparty/lua/ljumptab.h b/3rdparty/lua/include/ljumptab.h similarity index 100% rename from 3rdparty/lua/ljumptab.h rename to 3rdparty/lua/include/ljumptab.h diff --git a/3rdparty/lua/llex.h b/3rdparty/lua/include/llex.h similarity index 100% rename from 3rdparty/lua/llex.h rename to 3rdparty/lua/include/llex.h diff --git a/3rdparty/lua/llimits.h b/3rdparty/lua/include/llimits.h similarity index 90% rename from 3rdparty/lua/llimits.h rename to 3rdparty/lua/include/llimits.h index 025f1c8..1c826f7 100644 --- a/3rdparty/lua/llimits.h +++ b/3rdparty/lua/include/llimits.h @@ -71,11 +71,24 @@ typedef signed char ls_byte; /* -** conversion of pointer to unsigned integer: -** this is for hashing only; there is no problem if the integer -** cannot hold the whole pointer value +** conversion of pointer to unsigned integer: this is for hashing only; +** there is no problem if the integer cannot hold the whole pointer +** value. (In strict ISO C this may cause undefined behavior, but no +** actual machine seems to bother.) */ -#define point2uint(p) ((unsigned int)((size_t)(p) & UINT_MAX)) +#if !defined(LUA_USE_C89) && defined(__STDC_VERSION__) && \ + __STDC_VERSION__ >= 199901L +#include +#if defined(UINTPTR_MAX) /* even in C99 this type is optional */ +#define L_P2I uintptr_t +#else /* no 'intptr'? */ +#define L_P2I uintmax_t /* use the largest available integer */ +#endif +#else /* C89 option */ +#define L_P2I size_t +#endif + +#define point2uint(p) ((unsigned int)((L_P2I)(p) & UINT_MAX)) @@ -165,6 +178,20 @@ typedef LUAI_UACINT l_uacInt; #endif +/* +** Inline functions +*/ +#if !defined(LUA_USE_C89) +#define l_inline inline +#elif defined(__GNUC__) +#define l_inline __inline__ +#else +#define l_inline /* empty */ +#endif + +#define l_sinline static l_inline + + /* ** type for virtual-machine instructions; ** must be an unsigned with (at least) 4 bytes (see details in lopcodes.h) @@ -347,7 +374,7 @@ typedef l_uint32 Instruction; #define condchangemem(L,pre,pos) ((void)0) #else #define condchangemem(L,pre,pos) \ - { if (G(L)->gcrunning) { pre; luaC_fullgc(L, 0); pos; } } + { if (gcrunning(G(L))) { pre; luaC_fullgc(L, 0); pos; } } #endif #endif diff --git a/3rdparty/lua/lmem.h b/3rdparty/lua/include/lmem.h similarity index 100% rename from 3rdparty/lua/lmem.h rename to 3rdparty/lua/include/lmem.h diff --git a/3rdparty/lua/lobject.h b/3rdparty/lua/include/lobject.h similarity index 97% rename from 3rdparty/lua/lobject.h rename to 3rdparty/lua/include/lobject.h index 950bebb..556608e 100644 --- a/3rdparty/lua/lobject.h +++ b/3rdparty/lua/include/lobject.h @@ -52,6 +52,8 @@ typedef union Value { lua_CFunction f; /* light C functions */ lua_Integer i; /* integer numbers */ lua_Number n; /* float numbers */ + /* not used, but may avoid warnings for uninitialized value */ + lu_byte ub; } Value; @@ -68,7 +70,7 @@ typedef struct TValue { #define val_(o) ((o)->value_) -#define valraw(o) (&val_(o)) +#define valraw(o) (val_(o)) /* raw type tag of a TValue */ @@ -112,7 +114,7 @@ typedef struct TValue { #define settt_(o,t) ((o)->tt_=(t)) -/* main macro to copy values (from 'obj1' to 'obj2') */ +/* main macro to copy values (from 'obj2' to 'obj1') */ #define setobj(L,obj1,obj2) \ { TValue *io1=(obj1); const TValue *io2=(obj2); \ io1->value_ = io2->value_; settt_(io1, io2->tt_); \ @@ -155,6 +157,17 @@ typedef union StackValue { /* index to stack elements */ typedef StackValue *StkId; + +/* +** When reallocating the stack, change all pointers to the stack into +** proper offsets. +*/ +typedef union { + StkId p; /* actual pointer */ + ptrdiff_t offset; /* used while the stack is being reallocated */ +} StkIdRel; + + /* convert a 'StackValue' to a 'TValue' */ #define s2v(o) (&(o)->val) @@ -615,8 +628,10 @@ typedef struct Proto { */ typedef struct UpVal { CommonHeader; - lu_byte tbc; /* true if it represents a to-be-closed variable */ - TValue *v; /* points to stack or to its own value */ + union { + TValue *p; /* points to stack or to its own value */ + ptrdiff_t offset; /* used while the stack is being reallocated */ + } v; union { struct { /* (when open) */ struct UpVal *next; /* linked list */ diff --git a/3rdparty/lua/lopcodes.h b/3rdparty/lua/include/lopcodes.h similarity index 93% rename from 3rdparty/lua/lopcodes.h rename to 3rdparty/lua/include/lopcodes.h index d6a47e5..4c55145 100644 --- a/3rdparty/lua/lopcodes.h +++ b/3rdparty/lua/include/lopcodes.h @@ -21,7 +21,7 @@ iABC C(8) | B(8) |k| A(8) | Op(7) | iABx Bx(17) | A(8) | Op(7) | iAsBx sBx (signed)(17) | A(8) | Op(7) | iAx Ax(25) | Op(7) | -isJ sJ(25) | Op(7) | +isJ sJ (signed)(25) | Op(7) | A signed argument is represented in excess K: the represented value is the written unsigned value minus K, where K is half the maximum for the @@ -190,7 +190,8 @@ enum OpMode {iABC, iABx, iAsBx, iAx, isJ}; /* basic instruction formats */ /* -** grep "ORDER OP" if you change these enums +** Grep "ORDER OP" if you change these enums. Opcodes marked with a (*) +** has extra descriptions in the notes after the enumeration. */ typedef enum { @@ -203,7 +204,7 @@ OP_LOADF,/* A sBx R[A] := (lua_Number)sBx */ OP_LOADK,/* A Bx R[A] := K[Bx] */ OP_LOADKX,/* A R[A] := K[extra arg] */ OP_LOADFALSE,/* A R[A] := false */ -OP_LFALSESKIP,/*A R[A] := false; pc++ */ +OP_LFALSESKIP,/*A R[A] := false; pc++ (*) */ OP_LOADTRUE,/* A R[A] := true */ OP_LOADNIL,/* A B R[A], R[A+1], ..., R[A+B] := nil */ OP_GETUPVAL,/* A B R[A] := UpValue[B] */ @@ -254,7 +255,7 @@ OP_BXOR,/* A B C R[A] := R[B] ~ R[C] */ OP_SHL,/* A B C R[A] := R[B] << R[C] */ OP_SHR,/* A B C R[A] := R[B] >> R[C] */ -OP_MMBIN,/* A B C call C metamethod over R[A] and R[B] */ +OP_MMBIN,/* A B C call C metamethod over R[A] and R[B] (*) */ OP_MMBINI,/* A sB C k call C metamethod over R[A] and sB */ OP_MMBINK,/* A B C k call C metamethod over R[A] and K[B] */ @@ -280,7 +281,7 @@ OP_GTI,/* A sB k if ((R[A] > sB) ~= k) then pc++ */ OP_GEI,/* A sB k if ((R[A] >= sB) ~= k) then pc++ */ OP_TEST,/* A k if (not R[A] == k) then pc++ */ -OP_TESTSET,/* A B k if (not R[B] == k) then pc++ else R[A] := R[B] */ +OP_TESTSET,/* A B k if (not R[B] == k) then pc++ else R[A] := R[B] (*) */ OP_CALL,/* A B C R[A], ... ,R[A+C-2] := R[A](R[A+1], ... ,R[A+B-1]) */ OP_TAILCALL,/* A B C k return R[A](R[A+1], ... ,R[A+B-1]) */ @@ -315,6 +316,18 @@ OP_EXTRAARG/* Ax extra (larger) argument for previous opcode */ /*=========================================================================== Notes: + + (*) Opcode OP_LFALSESKIP is used to convert a condition to a boolean + value, in a code equivalent to (not cond ? false : true). (It + produces false and skips the next instruction producing true.) + + (*) Opcodes OP_MMBIN and variants follow each arithmetic and + bitwise opcode. If the operation succeeds, it skips this next + opcode. Otherwise, this opcode calls the corresponding metamethod. + + (*) Opcode OP_TESTSET is used in short-circuit expressions that need + both to jump and to produce a value, such as (a = b or c). + (*) In OP_CALL, if (B == 0) then B = top - A. If (C == 0), then 'top' is set to last_result+1, so next open instruction (OP_CALL, OP_RETURN*, OP_SETLIST) may use 'top'. diff --git a/3rdparty/lua/lopnames.h b/3rdparty/lua/include/lopnames.h similarity index 100% rename from 3rdparty/lua/lopnames.h rename to 3rdparty/lua/include/lopnames.h diff --git a/3rdparty/lua/lparser.h b/3rdparty/lua/include/lparser.h similarity index 100% rename from 3rdparty/lua/lparser.h rename to 3rdparty/lua/include/lparser.h diff --git a/3rdparty/lua/lprefix.h b/3rdparty/lua/include/lprefix.h similarity index 100% rename from 3rdparty/lua/lprefix.h rename to 3rdparty/lua/include/lprefix.h diff --git a/3rdparty/lua/lstate.h b/3rdparty/lua/include/lstate.h similarity index 95% rename from 3rdparty/lua/lstate.h rename to 3rdparty/lua/include/lstate.h index c1283bb..8bf6600 100644 --- a/3rdparty/lua/lstate.h +++ b/3rdparty/lua/include/lstate.h @@ -9,6 +9,11 @@ #include "lua.h" + +/* Some header files included here need this definition */ +typedef struct CallInfo CallInfo; + + #include "lobject.h" #include "ltm.h" #include "lzio.h" @@ -139,7 +144,7 @@ struct lua_longjmp; /* defined in ldo.c */ #define BASIC_STACK_SIZE (2*LUA_MINSTACK) -#define stacksize(th) cast_int((th)->stack_last - (th)->stack) +#define stacksize(th) cast_int((th)->stack_last.p - (th)->stack.p) /* kinds of Garbage Collection */ @@ -165,13 +170,13 @@ typedef struct stringtable { ** - field 'nyield' is used only while a function is "doing" an ** yield (from the yield until the next resume); ** - field 'nres' is used only while closing tbc variables when -** returning from a C function; +** returning from a function; ** - field 'transferinfo' is used only during call/returnhooks, ** before the function starts or after it ends. */ -typedef struct CallInfo { - StkId func; /* function index in the stack */ - StkId top; /* top for this function */ +struct CallInfo { + StkIdRel func; /* function index in the stack */ + StkIdRel top; /* top for this function */ struct CallInfo *previous, *next; /* dynamic call link */ union { struct { /* only for Lua functions */ @@ -196,7 +201,7 @@ typedef struct CallInfo { } u2; short nresults; /* expected number of results from this function */ unsigned short callstatus; -} CallInfo; +}; /* @@ -209,7 +214,7 @@ typedef struct CallInfo { #define CIST_YPCALL (1<<4) /* doing a yieldable protected call */ #define CIST_TAIL (1<<5) /* call was tail called */ #define CIST_HOOKYIELD (1<<6) /* last hook called yielded */ -#define CIST_FIN (1<<7) /* call is running a finalizer */ +#define CIST_FIN (1<<7) /* function "called" a finalizer */ #define CIST_TRAN (1<<8) /* 'ci' has transfer information */ #define CIST_CLSRET (1<<9) /* function is closing tbc variables */ /* Bits 10-12 are used for CIST_RECST (see below) */ @@ -263,7 +268,7 @@ typedef struct global_State { lu_byte gcstopem; /* stops emergency collections */ lu_byte genminormul; /* control for minor generational collections */ lu_byte genmajormul; /* control for major generational collections */ - lu_byte gcrunning; /* true if GC is running */ + lu_byte gcstp; /* control whether GC is running */ lu_byte gcemergency; /* true if this is an emergency collection */ lu_byte gcpause; /* size of pause between successive GCs */ lu_byte gcstepmul; /* GC "speed" */ @@ -291,7 +296,7 @@ typedef struct global_State { struct lua_State *mainthread; TString *memerrmsg; /* message for memory-allocation errors */ TString *tmname[TM_N]; /* array with tag-method names */ - struct Table *mt[LUA_NUMTAGS]; /* metatables for basic types */ + struct Table *mt[LUA_NUMTYPES]; /* metatables for basic types */ TString *strcache[STRCACHE_N][STRCACHE_M]; /* cache for strings in API */ lua_WarnFunction warnf; /* warning function */ void *ud_warn; /* auxiliary data to 'warnf' */ @@ -306,13 +311,13 @@ struct lua_State { lu_byte status; lu_byte allowhook; unsigned short nci; /* number of items in 'ci' list */ - StkId top; /* first free slot in the stack */ + StkIdRel top; /* first free slot in the stack */ global_State *l_G; CallInfo *ci; /* call info for current function */ - StkId stack_last; /* end of stack (last element + 1) */ - StkId stack; /* stack base */ + StkIdRel stack_last; /* end of stack (last element + 1) */ + StkIdRel stack; /* stack base */ UpVal *openupval; /* list of open upvalues in this stack */ - StkId tbclist; /* list of to-be-closed variables */ + StkIdRel tbclist; /* list of to-be-closed variables */ GCObject *gclist; struct lua_State *twups; /* list of threads with open upvalues */ struct lua_longjmp *errorJmp; /* current error recover point */ diff --git a/3rdparty/lua/lstring.h b/3rdparty/lua/include/lstring.h similarity index 100% rename from 3rdparty/lua/lstring.h rename to 3rdparty/lua/include/lstring.h diff --git a/3rdparty/lua/ltable.h b/3rdparty/lua/include/ltable.h similarity index 97% rename from 3rdparty/lua/ltable.h rename to 3rdparty/lua/include/ltable.h index 7bbbcb2..75dd9e2 100644 --- a/3rdparty/lua/ltable.h +++ b/3rdparty/lua/include/ltable.h @@ -59,7 +59,6 @@ LUAI_FUNC unsigned int luaH_realasize (const Table *t); #if defined(LUA_DEBUG) LUAI_FUNC Node *luaH_mainposition (const Table *t, const TValue *key); -LUAI_FUNC int luaH_isdummy (const Table *t); #endif diff --git a/3rdparty/lua/ltm.h b/3rdparty/lua/include/ltm.h similarity index 94% rename from 3rdparty/lua/ltm.h rename to 3rdparty/lua/include/ltm.h index 73b833c..c309e2a 100644 --- a/3rdparty/lua/ltm.h +++ b/3rdparty/lua/include/ltm.h @@ -9,6 +9,7 @@ #include "lobject.h" +#include "lstate.h" /* @@ -95,8 +96,8 @@ LUAI_FUNC int luaT_callorderiTM (lua_State *L, const TValue *p1, int v2, int inv, int isfloat, TMS event); LUAI_FUNC void luaT_adjustvarargs (lua_State *L, int nfixparams, - struct CallInfo *ci, const Proto *p); -LUAI_FUNC void luaT_getvarargs (lua_State *L, struct CallInfo *ci, + CallInfo *ci, const Proto *p); +LUAI_FUNC void luaT_getvarargs (lua_State *L, CallInfo *ci, StkId where, int wanted); diff --git a/3rdparty/lua/lua.h b/3rdparty/lua/include/lua.h similarity index 96% rename from 3rdparty/lua/lua.h rename to 3rdparty/lua/include/lua.h index 820535b..fd16cf8 100644 --- a/3rdparty/lua/lua.h +++ b/3rdparty/lua/include/lua.h @@ -18,14 +18,14 @@ #define LUA_VERSION_MAJOR "5" #define LUA_VERSION_MINOR "4" -#define LUA_VERSION_RELEASE "3" +#define LUA_VERSION_RELEASE "6" #define LUA_VERSION_NUM 504 -#define LUA_VERSION_RELEASE_NUM (LUA_VERSION_NUM * 100 + 0) +#define LUA_VERSION_RELEASE_NUM (LUA_VERSION_NUM * 100 + 6) #define LUA_VERSION "Lua " LUA_VERSION_MAJOR "." LUA_VERSION_MINOR #define LUA_RELEASE LUA_VERSION "." LUA_VERSION_RELEASE -#define LUA_COPYRIGHT LUA_RELEASE " Copyright (C) 1994-2021 Lua.org, PUC-Rio" +#define LUA_COPYRIGHT LUA_RELEASE " Copyright (C) 1994-2023 Lua.org, PUC-Rio" #define LUA_AUTHORS "R. Ierusalimschy, L. H. de Figueiredo, W. Celes" @@ -131,6 +131,16 @@ typedef void * (*lua_Alloc) (void *ud, void *ptr, size_t osize, size_t nsize); typedef void (*lua_WarnFunction) (void *ud, const char *msg, int tocont); +/* +** Type used by the debug API to collect debug information +*/ +typedef struct lua_Debug lua_Debug; + + +/* +** Functions to be called by the debugger in specific events +*/ +typedef void (*lua_Hook) (lua_State *L, lua_Debug *ar); /* @@ -153,7 +163,8 @@ extern const char lua_ident[]; LUA_API lua_State *(lua_newstate) (lua_Alloc f, void *ud); LUA_API void (lua_close) (lua_State *L); LUA_API lua_State *(lua_newthread) (lua_State *L); -LUA_API int (lua_resetthread) (lua_State *L); +LUA_API int (lua_closethread) (lua_State *L, lua_State *from); +LUA_API int (lua_resetthread) (lua_State *L); /* Deprecated! */ LUA_API lua_CFunction (lua_atpanic) (lua_State *L, lua_CFunction panicf); @@ -442,12 +453,6 @@ LUA_API void (lua_closeslot) (lua_State *L, int idx); #define LUA_MASKLINE (1 << LUA_HOOKLINE) #define LUA_MASKCOUNT (1 << LUA_HOOKCOUNT) -typedef struct lua_Debug lua_Debug; /* activation record */ - - -/* Functions to be called by the debugger in specific events */ -typedef void (*lua_Hook) (lua_State *L, lua_Debug *ar); - LUA_API int (lua_getstack) (lua_State *L, int level, lua_Debug *ar); LUA_API int (lua_getinfo) (lua_State *L, const char *what, lua_Debug *ar); @@ -492,7 +497,7 @@ struct lua_Debug { /****************************************************************************** -* Copyright (C) 1994-2021 Lua.org, PUC-Rio. +* Copyright (C) 1994-2023 Lua.org, PUC-Rio. * * Permission is hereby granted, free of charge, to any person obtaining * a copy of this software and associated documentation files (the diff --git a/3rdparty/lua/lua.hpp b/3rdparty/lua/include/lua.hpp similarity index 100% rename from 3rdparty/lua/lua.hpp rename to 3rdparty/lua/include/lua.hpp diff --git a/3rdparty/lua/luaconf.h b/3rdparty/lua/include/luaconf.h similarity index 98% rename from 3rdparty/lua/luaconf.h rename to 3rdparty/lua/include/luaconf.h index e64d2ee..137103e 100644 --- a/3rdparty/lua/luaconf.h +++ b/3rdparty/lua/include/luaconf.h @@ -70,6 +70,12 @@ #endif +#if defined(LUA_USE_IOS) +#define LUA_USE_POSIX +#define LUA_USE_DLOPEN +#endif + + /* @@ LUAI_IS32INT is true iff 'int' has (at least) 32 bits. */ @@ -485,7 +491,6 @@ @@ LUA_MAXINTEGER is the maximum value for a LUA_INTEGER. @@ LUA_MININTEGER is the minimum value for a LUA_INTEGER. @@ LUA_MAXUNSIGNED is the maximum value for a LUA_UNSIGNED. -@@ LUA_UNSIGNEDBITS is the number of bits in a LUA_UNSIGNED. @@ lua_integer2str converts an integer to a string. */ @@ -506,9 +511,6 @@ #define LUA_UNSIGNED unsigned LUAI_UACINT -#define LUA_UNSIGNEDBITS (sizeof(LUA_UNSIGNED) * CHAR_BIT) - - /* now the variable definitions */ #if LUA_INT_TYPE == LUA_INT_INT /* { int */ @@ -732,7 +734,7 @@ ** CHANGE it if you need a different limit. This limit is arbitrary; ** its only purpose is to stop Lua from consuming unlimited stack ** space (and to reserve some numbers for pseudo-indices). -** (It must fit into max(size_t)/32.) +** (It must fit into max(size_t)/32 and max(int)/2.) */ #if LUAI_IS32INT #define LUAI_MAXSTACK 1000000 @@ -751,14 +753,15 @@ /* @@ LUA_IDSIZE gives the maximum size for the description of the source -@@ of a function in debug information. +** of a function in debug information. ** CHANGE it if you want a different size. */ #define LUA_IDSIZE 60 /* -@@ LUAL_BUFFERSIZE is the buffer size used by the lauxlib buffer system. +@@ LUAL_BUFFERSIZE is the initial buffer size used by the lauxlib +** buffer system. */ #define LUAL_BUFFERSIZE ((int)(16 * sizeof(void*) * sizeof(lua_Number))) diff --git a/3rdparty/lua/lualib.h b/3rdparty/lua/include/lualib.h similarity index 100% rename from 3rdparty/lua/lualib.h rename to 3rdparty/lua/include/lualib.h diff --git a/3rdparty/lua/lundump.h b/3rdparty/lua/include/lundump.h similarity index 100% rename from 3rdparty/lua/lundump.h rename to 3rdparty/lua/include/lundump.h diff --git a/3rdparty/lua/lvm.h b/3rdparty/lua/include/lvm.h similarity index 97% rename from 3rdparty/lua/lvm.h rename to 3rdparty/lua/include/lvm.h index 1bc16f3..dba1ad2 100644 --- a/3rdparty/lua/lvm.h +++ b/3rdparty/lua/include/lvm.h @@ -110,6 +110,11 @@ typedef enum { luaC_barrierback(L, gcvalue(t), v); } +/* +** Shift right is the same as shift left with a negative 'y' +*/ +#define luaV_shiftr(x,y) luaV_shiftl(x,intop(-, 0, y)) + LUAI_FUNC int luaV_equalobj (lua_State *L, const TValue *t1, const TValue *t2); diff --git a/3rdparty/lua/lzio.h b/3rdparty/lua/include/lzio.h similarity index 100% rename from 3rdparty/lua/lzio.h rename to 3rdparty/lua/include/lzio.h diff --git a/3rdparty/lua/luac/CMakeLists.txt b/3rdparty/lua/luac/CMakeLists.txt deleted file mode 100644 index df6142d..0000000 --- a/3rdparty/lua/luac/CMakeLists.txt +++ /dev/null @@ -1,29 +0,0 @@ -cmake_minimum_required(VERSION 3.5) - -# 获取上级目录名做为库名 -get_filename_component(CURRENT_DIR ${CMAKE_CURRENT_SOURCE_DIR} ABSOLUTE) -get_filename_component(LUA_DIR ${CMAKE_CURRENT_BINARY_DIR} ABSOLUTE) -get_filename_component(LIBRARY_NAME ${CURRENT_DIR} NAME) - -file(GLOB SOURCE_LIB_FILES "${PROJECT_SOURCE_DIR}/3rdparty/lua/*.c") -file(GLOB SOURCE_FILES "${PROJECT_SOURCE_DIR}/3rdparty/lua/luac/*.c") - - - -# 创建LUAC -add_executable(${LIBRARY_NAME} WIN32 ${SOURCE_FILES} ${SOURCE_LIB_FILES}) -# 设置 Windows 应用程序类型 -if (WIN32) - set_target_properties(${LIBRARY_NAME} PROPERTIES WIN32_EXECUTABLE FALSE) -endif() -# 将包含目录与目标相关联，这样只有在编译此库时才会包含这些目录 -target_include_directories(${LIBRARY_NAME} PUBLIC "${PROJECT_SOURCE_DIR}/3rdparty/lua") -if(MSVC) -target_link_libraries(${LIBRARY_NAME} PRIVATE kernel32.lib Shell32.lib) -else() -target_link_libraries(${LIBRARY_NAME} PRIVATE m) -endif() - - -# 设置 Visual Studio 中的文件夹 -set_property(TARGET ${LIBRARY_NAME} PROPERTY FOLDER "3rdparty") \ No newline at end of file diff --git a/3rdparty/lua/makefile b/3rdparty/lua/makefile deleted file mode 100644 index 38e21f1..0000000 --- a/3rdparty/lua/makefile +++ /dev/null @@ -1,210 +0,0 @@ -# Developer's makefile for building Lua -# see luaconf.h for further customization - -# == CHANGE THE SETTINGS BELOW TO SUIT YOUR ENVIRONMENT ======================= - -# Warnings valid for both C and C++ -CWARNSCPP= \ - -Wfatal-errors \ - -Wextra \ - -Wshadow \ - -Wundef \ - -Wwrite-strings \ - -Wredundant-decls \ - -Wdisabled-optimization \ - -Wdouble-promotion \ - -Wmissing-declarations \ - # the next warnings might be useful sometimes, - # but usually they generate too much noise - # -Werror \ - # -pedantic # warns if we use jump tables \ - # -Wconversion \ - # -Wsign-conversion \ - # -Wstrict-overflow=2 \ - # -Wformat=2 \ - # -Wcast-qual \ - - -# Warnings for gcc, not valid for clang -CWARNGCC= \ - -Wlogical-op \ - -Wno-aggressive-loop-optimizations \ - - -# The next warnings are neither valid nor needed for C++ -CWARNSC= -Wdeclaration-after-statement \ - -Wmissing-prototypes \ - -Wnested-externs \ - -Wstrict-prototypes \ - -Wc++-compat \ - -Wold-style-definition \ - - -CWARNS= $(CWARNSCPP) $(CWARNSC) $(CWARNGCC) - -# Some useful compiler options for internal tests: -# -DLUAI_ASSERT turns on all assertions inside Lua. -# -DHARDSTACKTESTS forces a reallocation of the stack at every point where -# the stack can be reallocated. -# -DHARDMEMTESTS forces a full collection at all points where the collector -# can run. -# -DEMERGENCYGCTESTS forces an emergency collection at every single allocation. -# -DEXTERNMEMCHECK removes internal consistency checking of blocks being -# deallocated (useful when an external tool like valgrind does the check). -# -DMAXINDEXRK=k limits range of constants in RK instruction operands. -# -DLUA_COMPAT_5_3 - -# -pg -malign-double -# -DLUA_USE_CTYPE -DLUA_USE_APICHECK - -# The following options help detect "undefined behavior"s that seldom -# create problems; some are only available in newer gcc versions. To -# use some of them, we also have to define an environment variable -# ASAN_OPTIONS="detect_invalid_pointer_pairs=2". -# -fsanitize=undefined -# -fsanitize=pointer-subtract -fsanitize=address -fsanitize=pointer-compare -# TESTS= -DLUA_USER_H='"ltests.h"' -O0 -g - - -LOCAL = $(TESTS) $(CWARNS) - - -# enable Linux goodies -MYCFLAGS= $(LOCAL) -std=c99 -DLUA_USE_LINUX -DLUA_USE_READLINE -MYLDFLAGS= $(LOCAL) -Wl,-E -MYLIBS= -ldl -lreadline - - -CC= gcc -CFLAGS= -Wall -O2 $(MYCFLAGS) -fno-stack-protector -fno-common -march=native -AR= ar rc -RANLIB= ranlib -RM= rm -f - - - -# == END OF USER SETTINGS. NO NEED TO CHANGE ANYTHING BELOW THIS LINE ========= - - -LIBS = -lm - -CORE_T= liblua.a -CORE_O= lapi.o lcode.o lctype.o ldebug.o ldo.o ldump.o lfunc.o lgc.o llex.o \ - lmem.o lobject.o lopcodes.o lparser.o lstate.o lstring.o ltable.o \ - ltm.o lundump.o lvm.o lzio.o ltests.o -AUX_O= lauxlib.o -LIB_O= lbaselib.o ldblib.o liolib.o lmathlib.o loslib.o ltablib.o lstrlib.o \ - lutf8lib.o loadlib.o lcorolib.o linit.o - -LUA_T= lua -LUA_O= lua.o - - -ALL_T= $(CORE_T) $(LUA_T) -ALL_O= $(CORE_O) $(LUA_O) $(AUX_O) $(LIB_O) -ALL_A= $(CORE_T) - -all: $(ALL_T) - touch all - -o: $(ALL_O) - -a: $(ALL_A) - -$(CORE_T): $(CORE_O) $(AUX_O) $(LIB_O) - $(AR) $@ $? - $(RANLIB) $@ - -$(LUA_T): $(LUA_O) $(CORE_T) - $(CC) -o $@ $(MYLDFLAGS) $(LUA_O) $(CORE_T) $(LIBS) $(MYLIBS) $(DL) - - -clean: - $(RM) $(ALL_T) $(ALL_O) - -depend: - @$(CC) $(CFLAGS) -MM *.c - -echo: - @echo "CC = $(CC)" - @echo "CFLAGS = $(CFLAGS)" - @echo "AR = $(AR)" - @echo "RANLIB = $(RANLIB)" - @echo "RM = $(RM)" - @echo "MYCFLAGS = $(MYCFLAGS)" - @echo "MYLDFLAGS = $(MYLDFLAGS)" - @echo "MYLIBS = $(MYLIBS)" - @echo "DL = $(DL)" - -$(ALL_O): makefile ltests.h - -# DO NOT EDIT -# automatically made with 'gcc -MM l*.c' - -lapi.o: lapi.c lprefix.h lua.h luaconf.h lapi.h llimits.h lstate.h \ - lobject.h ltm.h lzio.h lmem.h ldebug.h ldo.h lfunc.h lgc.h lstring.h \ - ltable.h lundump.h lvm.h -lauxlib.o: lauxlib.c lprefix.h lua.h luaconf.h lauxlib.h -lbaselib.o: lbaselib.c lprefix.h lua.h luaconf.h lauxlib.h lualib.h -lcode.o: lcode.c lprefix.h lua.h luaconf.h lcode.h llex.h lobject.h \ - llimits.h lzio.h lmem.h lopcodes.h lparser.h ldebug.h lstate.h ltm.h \ - ldo.h lgc.h lstring.h ltable.h lvm.h -lcorolib.o: lcorolib.c lprefix.h lua.h luaconf.h lauxlib.h lualib.h -lctype.o: lctype.c lprefix.h lctype.h lua.h luaconf.h llimits.h -ldblib.o: ldblib.c lprefix.h lua.h luaconf.h lauxlib.h lualib.h -ldebug.o: ldebug.c lprefix.h lua.h luaconf.h lapi.h llimits.h lstate.h \ - lobject.h ltm.h lzio.h lmem.h lcode.h llex.h lopcodes.h lparser.h \ - ldebug.h ldo.h lfunc.h lstring.h lgc.h ltable.h lvm.h -ldo.o: ldo.c lprefix.h lua.h luaconf.h lapi.h llimits.h lstate.h \ - lobject.h ltm.h lzio.h lmem.h ldebug.h ldo.h lfunc.h lgc.h lopcodes.h \ - lparser.h lstring.h ltable.h lundump.h lvm.h -ldump.o: ldump.c lprefix.h lua.h luaconf.h lobject.h llimits.h lstate.h \ - ltm.h lzio.h lmem.h lundump.h -lfunc.o: lfunc.c lprefix.h lua.h luaconf.h ldebug.h lstate.h lobject.h \ - llimits.h ltm.h lzio.h lmem.h ldo.h lfunc.h lgc.h -lgc.o: lgc.c lprefix.h lua.h luaconf.h ldebug.h lstate.h lobject.h \ - llimits.h ltm.h lzio.h lmem.h ldo.h lfunc.h lgc.h lstring.h ltable.h -linit.o: linit.c lprefix.h lua.h luaconf.h lualib.h lauxlib.h -liolib.o: liolib.c lprefix.h lua.h luaconf.h lauxlib.h lualib.h -llex.o: llex.c lprefix.h lua.h luaconf.h lctype.h llimits.h ldebug.h \ - lstate.h lobject.h ltm.h lzio.h lmem.h ldo.h lgc.h llex.h lparser.h \ - lstring.h ltable.h -lmathlib.o: lmathlib.c lprefix.h lua.h luaconf.h lauxlib.h lualib.h -lmem.o: lmem.c lprefix.h lua.h luaconf.h ldebug.h lstate.h lobject.h \ - llimits.h ltm.h lzio.h lmem.h ldo.h lgc.h -loadlib.o: loadlib.c lprefix.h lua.h luaconf.h lauxlib.h lualib.h -lobject.o: lobject.c lprefix.h lua.h luaconf.h lctype.h llimits.h \ - ldebug.h lstate.h lobject.h ltm.h lzio.h lmem.h ldo.h lstring.h lgc.h \ - lvm.h -lopcodes.o: lopcodes.c lprefix.h lopcodes.h llimits.h lua.h luaconf.h -loslib.o: loslib.c lprefix.h lua.h luaconf.h lauxlib.h lualib.h -lparser.o: lparser.c lprefix.h lua.h luaconf.h lcode.h llex.h lobject.h \ - llimits.h lzio.h lmem.h lopcodes.h lparser.h ldebug.h lstate.h ltm.h \ - ldo.h lfunc.h lstring.h lgc.h ltable.h -lstate.o: lstate.c lprefix.h lua.h luaconf.h lapi.h llimits.h lstate.h \ - lobject.h ltm.h lzio.h lmem.h ldebug.h ldo.h lfunc.h lgc.h llex.h \ - lstring.h ltable.h -lstring.o: lstring.c lprefix.h lua.h luaconf.h ldebug.h lstate.h \ - lobject.h llimits.h ltm.h lzio.h lmem.h ldo.h lstring.h lgc.h -lstrlib.o: lstrlib.c lprefix.h lua.h luaconf.h lauxlib.h lualib.h -ltable.o: ltable.c lprefix.h lua.h luaconf.h ldebug.h lstate.h lobject.h \ - llimits.h ltm.h lzio.h lmem.h ldo.h lgc.h lstring.h ltable.h lvm.h -ltablib.o: ltablib.c lprefix.h lua.h luaconf.h lauxlib.h lualib.h -ltests.o: ltests.c lprefix.h lua.h luaconf.h lapi.h llimits.h lstate.h \ - lobject.h ltm.h lzio.h lmem.h lauxlib.h lcode.h llex.h lopcodes.h \ - lparser.h lctype.h ldebug.h ldo.h lfunc.h lopnames.h lstring.h lgc.h \ - ltable.h lualib.h -ltm.o: ltm.c lprefix.h lua.h luaconf.h ldebug.h lstate.h lobject.h \ - llimits.h ltm.h lzio.h lmem.h ldo.h lgc.h lstring.h ltable.h lvm.h -lua.o: lua.c lprefix.h lua.h luaconf.h lauxlib.h lualib.h -lundump.o: lundump.c lprefix.h lua.h luaconf.h ldebug.h lstate.h \ - lobject.h llimits.h ltm.h lzio.h lmem.h ldo.h lfunc.h lstring.h lgc.h \ - lundump.h -lutf8lib.o: lutf8lib.c lprefix.h lua.h luaconf.h lauxlib.h lualib.h -lvm.o: lvm.c lprefix.h lua.h luaconf.h ldebug.h lstate.h lobject.h \ - llimits.h ltm.h lzio.h lmem.h ldo.h lfunc.h lgc.h lopcodes.h lstring.h \ - ltable.h lvm.h ljumptab.h -lzio.o: lzio.c lprefix.h lua.h luaconf.h llimits.h lmem.h lstate.h \ - lobject.h ltm.h lzio.h - -# (end of Makefile) diff --git a/3rdparty/lua/manual/2html b/3rdparty/lua/manual/2html deleted file mode 100644 index 43fd891..0000000 --- a/3rdparty/lua/manual/2html +++ /dev/null @@ -1,519 +0,0 @@ -#!/usr/bin/env lua5.3 - - --- special marks: --- \1 - paragraph (empty line) --- \4 - remove spaces around it --- \3 - ref (followed by label|) - ---------------------------------------------------------------- -header = [[ - - - - -Lua 5.4 Reference Manual - - - - - - - -
-

-[Lua logo] -Lua 5.4 Reference Manual -

- -by Roberto Ierusalimschy, Luiz Henrique de Figueiredo, Waldemar Celes -

- -Copyright -© 2023 Lua.org, PUC-Rio. All rights reserved. - -

- - -

- -]] - -footer = "\n\n\n\n" - -local seefmt = '(see %s)' - -if arg[1] == 'port' then - seefmt = '(ver %s)' - header = string.gsub(header, "by (.-)\n", - "%1\n

Tradução: Sérgio Queiroz de Medeiros", 1) - header = string.gsub(header, "Lua (%d+.%d+) Reference Manual", - "Manual de Referência de Lua %1") - header = string.gsub(header, "All rights reserved", - "Todos os direitos reservados") -end - - ---------------------------------------------------------------- - -local function compose (f,g) - assert(f and g) - return function (s) return g(f(s)) end -end - -local function concat (f, g) - assert(f and g) - return function (s) return f(s) .. g(s) end -end - - -local Tag = {} - - -setmetatable(Tag, { - __index = function (t, tag) - local v = function (n, att) - local e = "" - if type(att) == "table" then - for k,v in pairs(att) do e = string.format('%s %s="%s"', e, k, v) end - end - if n then - return string.format("<%s%s>%s", tag, e, n, tag) - else - return string.format("<%s%s>", tag, e) - end - end - t[tag] = v - return v - end -}) - - - ---------------------------------------------------------------- -local labels = {} - - -local function anchor (text, label, link, textlink) - if labels[label] then - error("label " .. label .. " already defined") - end - labels[label] = {text = textlink, link = link} - return Tag.a(text, {name=link}) -end - -local function makeref (label) - assert(not string.find(label, "|")) - return string.format("\3%s\3", label) -end - -local function ref (label) - local l = labels[label] - if not l then - io.stderr:write("label ", label, " undefined\n") - return "@@@@@@@" - else - return Tag.a(l.text, {href="#"..l.link}) - end -end - ---------------------------------------------------------------- -local function nopara (t) - t = string.gsub(t, "\1", "\n\n") - t = string.gsub(t, "

%s*

", "") - return t -end - -local function fixpara (t) - t = string.gsub(t, "\1", "\n

\n\n

\n") - t = string.gsub(t, "

%s*

", "") - return t -end - -local function antipara (t) - return "

\n" .. t .. "

" -end - - -Tag.pre = compose(Tag.pre, antipara) -Tag.ul = compose(Tag.ul, antipara) - ---------------------------------------------------------------- -local Gfoots = 0 -local footnotes = {} - -local line = Tag.hr(nil) - -local function dischargefoots () - if #footnotes == 0 then return "" end - local fn = table.concat(footnotes) - footnotes = {} - return line .. Tag.h3"footnotes:" .. fn .. line -end - - -local Glists = 0 -local listings = {} - -local function dischargelist () - if #listings == 0 then return "" end - local l = listings - listings = {} - return line .. table.concat(l, line..line) .. line -end - ---------------------------------------------------------------- -local counters = { -h1 = {val = 1}, -h2 = {father = "h1", val = 1}, -h3 = {father = "h2", val = 1}, -listing = {father = "h1", val = 1}, -} - -local function inccounter (count) - counters[count].val = counters[count].val + 1 - for c, v in pairs(counters) do - if v.father == count then v.val = 1 end - end -end - -local function getcounter (count) - local c = counters[count] - if c.father then - return getcounter(c.father) .. "." .. c.val - else - return c.val .. "" - end -end ---------------------------------------------------------------- - - -local function fixed (x) - return function () return x end -end - -local function id (x) return x end - - -local function prepos (x, y) - assert(x and y) - return function (s) return string.format("%s%s%s", x, s, y) end -end - - -local rw = Tag.b - - - - -local function LuaName (name) - return Tag.code(name) -end - - -local function getparam (s) - local i, e = string.find(s, "^[^%s@|]+|") - if not i then return nil, s - else return string.sub(s, i, e - 1), string.sub(s, e + 1) - end -end - - -local function gettitle (h) - local title, p = assert(string.match(h, "(.-)()")) - return title, string.sub(h, p) -end - -local function getparamtitle (what, h, nonum) - local label, title, c, count - label, h = getparam(h) - title, h = gettitle(h) - if not nonum then - count = getcounter(what) - inccounter(what) - c = string.format("%s – ", count) - else - c = "" - end - label = label or count - if label then - title = anchor(title, label, count, "§"..count) - end - title = string.format("%s%s", c, title) - return title, h -end - -local function section (what, nonum) - return function (h) - local title - title, h = getparamtitle(what, h, nonum) - local fn = what == "h1" and dischargefoots() or "" - h = fixpara(Tag.p(h)) - return "

\n" .. Tag[what](title) .. h .. fn .. - dischargelist() .. "

" - end -end - - -local function verbatim (s) - s = nopara(s) - s = string.gsub(s, "\n", "\n ") - s = string.gsub(s, "\n%s*$", "\n") - return Tag.pre(s) -end - - -local function verb (s) - return Tag.code(s) -end - - -local function lua2link (e) - return string.find(e, "luaL?_") and e or "pdf-"..e -end - - -local verbfixed = verb - - -local Tex = { - -ANSI = function (func) - return "ISO C function " .. Tag.code(func) - end, -At = fixed"@", -B = Tag.b, -bigskip = fixed"", -bignum = id, -C = fixed"", -Ci = prepos(""), -CId = function (func) - return "C function " .. Tag.code(func) - end, -chapter = section"h1", -Char = compose(verbfixed, prepos("'", "'")), -Cdots = fixed"···", -Close = fixed"}", -col = Tag.td, -defid = function (name) - local l = lua2link(name) - local c = Tag.code(name) - return anchor(c, l, l, c) - end, -def = Tag.em, -description = compose(nopara, Tag.ul), -Em = fixed("\4" .. "—" .. "\4"), -emph = Tag.em, -emphx = Tag.em, -- emphasis plus index (if there was an index) -En = fixed("–"), -format = fixed"", -["false"] = fixed(Tag.b"false"), -id = Tag.code, -idx = Tag.code, -index = fixed"", -Lidx = fixed"", -- Tag.code, -ldots = fixed"...", -x = id, -itemize = compose(nopara, Tag.ul), -leq = fixed"≤", -Lid = function (s) - return makeref(lua2link(s)) - end, -M = Tag.em, -N = function (s) return (string.gsub(s, " ", " ")) end, -NE = id, -- tag"foreignphrase", -num = id, -["nil"] = fixed(Tag.b"nil"), -fail = fixed(Tag.b"fail"), -Open = fixed"{", -part = section("h1", true), -Pat = compose(verbfixed, prepos("'", "'")), -preface = section("h1", true), -psect = section("h2", true), -Q = prepos('"', '"'), -refchp = makeref, -refcode = makeref, -refsec = makeref, - -pi = fixed"π", -rep = Tag.em, -- compose(prepos("<", ">"), Tag.em), -Rw = rw, -rw = rw, -sb = Tag.sub, -sp = Tag.sup, -St = compose(verbfixed, prepos('"', '"')), -sect1 = section"h1", -sect2 = section"h2", -sect3 = section"h3", -sect4 = section("h4", true), -simplesect = id, -Tab2 = function (s) return Tag.table(s, {border=1}) end, -row = Tag.tr, -title = Tag.title, -todo = Tag.todo, -["true"] = fixed(Tag.b"true"), -T = verb, - -item = function (s) - local t, p = string.match(s, "^([^\n|]+)|()") - if t then - s = string.sub(s, p) - s = Tag.b(t..": ") .. s - end - return Tag.li(fixpara(s)) - end, - -verbatim = verbatim, - -manual = id, - - --- for the manual - -link =function (s) - local l, t = getparam(s) - assert(l) - return string.format("%s (%s)", t, makeref(l)) -end, - -see = function (s) return string.format(seefmt, makeref(s)) end, -See = makeref, -seeC = function (s) - return string.format(seefmt, makeref(s)) - end, - -seeF = function (s) - return string.format(seefmt, makeref(lua2link(s))) - end, - -APIEntry = function (e) - local h, name - h, e = string.match(e, "^%s*(.-)%s*|(.*)$") - name = string.match(h, "(luaL?_[%w_]+)%)? +%(") or - string.match(h, "luaL?_[%w_]+") - local a = anchor(Tag.code(name), name, name, Tag.code(name)) - local apiicmd, ne = string.match(e, "^(.-)(.*)") ---io.stderr:write(e) - if not apiicmd then - return antipara(Tag.hr() .. Tag.h3(a)) .. Tag.pre(h) .. e - else - return antipara(Tag.hr() .. Tag.h3(a)) .. apiicmd .. Tag.pre(h) .. ne - end -end, - -LibEntry = function (e) - local h, name - h, e = string.match(e, "^(.-)|(.*)$") - name = string.gsub(h, " (.+", "") - local l = lua2link(name) - local a = anchor(Tag.code(h), l, l, Tag.code(name)) - return Tag.hr() .. Tag.h3(a) .. e -end, - -Produc = compose(nopara, Tag.pre), -producname = prepos("\t", " ::= "), -Or = fixed" | ", -VerBar = fixed"|", -- vertical bar -OrNL = fixed" | \4", -bnfNter = prepos("", ""), -bnfopt = prepos("[", "]"), -bnfrep = prepos("{", "}"), -bnfter = compose(Tag.b, prepos("‘", "’")), -producbody = function (s) - s = string.gsub(s, "%s+", " ") - s = string.gsub(s, "\4", "\n\t\t") - return s - end, - -apii = function (s) - local pop,push,err = string.match(s, "^(.-),(.-),(.*)$") - if pop ~= "?" and string.find(pop, "%W") then - pop = "(" .. pop .. ")" - end - if push ~= "?" and string.find(push, "%W") then - push = "(" .. push .. ")" - end - err = (err == "-") and "–" or Tag.em(err) - return Tag.span( - string.format("[-%s, +%s, %s]", pop, push, err), - {class="apii"} - ) - end, -} - -local others = prepos("?? "," ??") - -local function trata (t) - t = string.gsub(t, "@(%w+)(%b{})", function (w, f) - f = trata(string.sub(f, 2, -2)) - if type(Tex[w]) ~= "function" then - io.stderr:write(w .. "\n") - return others(f) - else - return Tex[w](f, w) - end - end) - return t -end - - ---------------------------------------------------------------------- ---------------------------------------------------------------------- - --- read whole book -t = io.read"*a" - -t = string.gsub(t, "[<>&\128-\255]", - {["<"] = "<", - [">"] = ">", - ["&"] = "&", - ["\170"] = "ª", - ["\186"] = "º", - ["\192"] = "À", - ["\193"] = "Á", - ["\194"] = "Â", - ["\195"] = "Ã", - ["\199"] = "Ç", - ["\201"] = "É", - ["\202"] = "Ê", - ["\205"] = "Í", - ["\211"] = "Ó", - ["\212"] = "Ô", - ["\218"] = "Ú", - ["\224"] = "à", - ["\225"] = "á", - ["\226"] = "â", - ["\227"] = "ã", - ["\231"] = "ç", - ["\233"] = "é", - ["\234"] = "ê", - ["\237"] = "í", - ["\243"] = "ó", - ["\244"] = "ô", - ["\245"] = "õ", - ["\250"] = "ú", - ["\252"] = "ü" - }) - -t = string.gsub(t, "\n\n+", "\1") - - - --- complete macros with no arguments -t = string.gsub(t, "(@%w+)([^{%w])", "%1{}%2") - -t = trata(t) - --- correct references -t = string.gsub(t, "\3(.-)\3", ref) - --- remove extra space (??) -t = string.gsub(t, "%s*\4%s*", "") - -t = nopara(t) - --- HTML 3.2 does not need

(but complains when it is in wrong places :) -t = string.gsub(t, "

", "") - -io.write(header, t, footer) - diff --git a/3rdparty/lua/manual/manual.of b/3rdparty/lua/manual/manual.of deleted file mode 100644 index ad120f5..0000000 --- a/3rdparty/lua/manual/manual.of +++ /dev/null @@ -1,9451 +0,0 @@ -@Ci{$Id: manual.of $} -@C{[(-------------------------------------------------------------------------} -@manual{ - -@sect1{@title{Introduction} - -Lua is a powerful, efficient, lightweight, embeddable scripting language. -It supports procedural programming, -object-oriented programming, functional programming, -data-driven programming, and data description. - -Lua combines simple procedural syntax with powerful data description -constructs based on associative arrays and extensible semantics. -Lua is dynamically typed, -runs by interpreting bytecode with a register-based -virtual machine, -and has automatic memory management with -a generational garbage collection, -making it ideal for configuration, scripting, -and rapid prototyping. - -Lua is implemented as a library, written in @emphx{clean C}, -the common subset of @N{standard C} and C++. -The Lua distribution includes a host program called @id{lua}, -which uses the Lua library to offer a complete, -standalone Lua interpreter, -for interactive or batch use. -Lua is intended to be used both as a powerful, lightweight, -embeddable scripting language for any program that needs one, -and as a powerful but lightweight and efficient stand-alone language. - -As an extension language, Lua has no notion of a @Q{main} program: -it works @emph{embedded} in a host client, -called the @emph{embedding program} or simply the @emphx{host}. -(Frequently, this host is the stand-alone @id{lua} program.) -The host program can invoke functions to execute a piece of Lua code, -can write and read Lua variables, -and can register @N{C functions} to be called by Lua code. -Through the use of @N{C functions}, Lua can be augmented to cope with -a wide range of different domains, -thus creating customized programming languages sharing a syntactical framework. - -Lua is free software, -and is provided as usual with no guarantees, -as stated in its license. -The implementation described in this manual is available -at Lua's official web site, @id{www.lua.org}. - -Like any other reference manual, -this document is dry in places. -For a discussion of the decisions behind the design of Lua, -see the technical papers available at Lua's web site. -For a detailed introduction to programming in Lua, -see Roberto's book, @emphx{Programming in Lua}. - -} - - -@C{-------------------------------------------------------------------------} -@sect1{basic| @title{Basic Concepts} - -@simplesect{ - -This section describes the basic concepts of the language. - -} - -@sect2{TypesSec| @title{Values and Types} - -Lua is a dynamically typed language. -This means that -variables do not have types; only values do. -There are no type definitions in the language. -All values carry their own type. - -All values in Lua are first-class values. -This means that all values can be stored in variables, -passed as arguments to other functions, and returned as results. - -There are eight @x{basic types} in Lua: -@def{nil}, @def{boolean}, @def{number}, -@def{string}, @def{function}, @def{userdata}, -@def{thread}, and @def{table}. -The type @emph{nil} has one single value, @nil, -whose main property is to be different from any other value; -it often represents the absence of a useful value. -The type @emph{boolean} has two values, @false and @true. -Both @nil and @false make a condition false; -they are collectively called @def{false values}. -Any other value makes a condition true. -Despite its name, -@false is frequently used as an alternative to @nil, -with the key difference that @false behaves -like a regular value in a table, -while a @nil in a table represents an absent key. - -The type @emph{number} represents both -integer numbers and real (floating-point) numbers, -using two @x{subtypes}: @def{integer} and @def{float}. -Standard Lua uses 64-bit integers and double-precision (64-bit) floats, -but you can also compile Lua so that it -uses 32-bit integers and/or single-precision (32-bit) floats. -The option with 32 bits for both integers and floats -is particularly attractive -for small machines and embedded systems. -(See macro @id{LUA_32BITS} in file @id{luaconf.h}.) - -Unless stated otherwise, -any overflow when manipulating integer values @def{wrap around}, -according to the usual rules of two-complement arithmetic. -(In other words, -the actual result is the unique representable integer -that is equal modulo @M{2@sp{n}} to the mathematical result, -where @M{n} is the number of bits of the integer type.) - -Lua has explicit rules about when each subtype is used, -but it also converts between them automatically as needed @see{coercion}. -Therefore, -the programmer may choose to mostly ignore the difference -between integers and floats -or to assume complete control over the representation of each number. - -The type @emph{string} represents immutable sequences of bytes. -@index{eight-bit clean} -Lua is 8-bit clean: -strings can contain any 8-bit value, -including @x{embedded zeros} (@Char{\0}). -Lua is also encoding-agnostic; -it makes no assumptions about the contents of a string. -The length of any string in Lua must fit in a Lua integer. - -Lua can call (and manipulate) functions written in Lua and -functions written in C @see{functioncall}. -Both are represented by the type @emph{function}. - -The type @emph{userdata} is provided to allow arbitrary @N{C data} to -be stored in Lua variables. -A userdata value represents a block of raw memory. -There are two kinds of userdata: -@emphx{full userdata}, -which is an object with a block of memory managed by Lua, -and @emphx{light userdata}, -which is simply a @N{C pointer} value. -Userdata has no predefined operations in Lua, -except assignment and identity test. -By using @emph{metatables}, -the programmer can define operations for full userdata values -@see{metatable}. -Userdata values cannot be created or modified in Lua, -only through the @N{C API}. -This guarantees the integrity of data owned by -the host program and @N{C libraries}. - -The type @def{thread} represents independent threads of execution -and it is used to implement coroutines @see{coroutine}. -Lua threads are not related to operating-system threads. -Lua supports coroutines on all systems, -even those that do not support threads natively. - -The type @emph{table} implements @x{associative arrays}, -that is, @x{arrays} that can have as indices not only numbers, -but any Lua value except @nil and @x{NaN}. -(@emphx{Not a Number} is a special floating-point value -used by the @x{IEEE 754} standard to represent -undefined numerical results, such as @T{0/0}.) -Tables can be @emph{heterogeneous}; -that is, they can contain values of all types (except @nil). -Any key associated to the value @nil is not considered part of the table. -Conversely, any key that is not part of a table has -an associated value @nil. - -Tables are the sole data-structuring mechanism in Lua; -they can be used to represent ordinary arrays, lists, -symbol tables, sets, records, graphs, trees, etc. -To represent @x{records}, Lua uses the field name as an index. -The language supports this representation by -providing @id{a.name} as syntactic sugar for @T{a["name"]}. -There are several convenient ways to create tables in Lua -@see{tableconstructor}. - -Like indices, -the values of table fields can be of any type. -In particular, -because functions are first-class values, -table fields can contain functions. -Thus tables can also carry @emph{methods} @see{func-def}. - -The indexing of tables follows -the definition of raw equality in the language. -The expressions @T{a[i]} and @T{a[j]} -denote the same table element -if and only if @id{i} and @id{j} are raw equal -(that is, equal without metamethods). -In particular, floats with integral values -are equal to their respective integers -(e.g., @T{1.0 == 1}). -To avoid ambiguities, -any float used as a key that is equal to an integer -is converted to that integer. -For instance, if you write @T{a[2.0] = true}, -the actual key inserted into the table will be the integer @T{2}. - - -Tables, functions, threads, and (full) userdata values are @emph{objects}: -variables do not actually @emph{contain} these values, -only @emph{references} to them. -Assignment, parameter passing, and function returns -always manipulate references to such values; -these operations do not imply any kind of copy. - -The library function @Lid{type} returns a string describing the type -of a given value @seeF{type}. - -} - -@sect2{globalenv| @title{Environments and the Global Environment} - -As we will discuss further in @refsec{variables} and @refsec{assignment}, -any reference to a free name -(that is, a name not bound to any declaration) @id{var} -is syntactically translated to @T{_ENV.var}. -Moreover, every chunk is compiled in the scope of -an external local variable named @id{_ENV} @see{chunks}, -so @id{_ENV} itself is never a free name in a chunk. - -Despite the existence of this external @id{_ENV} variable and -the translation of free names, -@id{_ENV} is a completely regular name. -In particular, -you can define new variables and parameters with that name. -Each reference to a free name uses the @id{_ENV} that is -visible at that point in the program, -following the usual visibility rules of Lua @see{visibility}. - -Any table used as the value of @id{_ENV} is called an @def{environment}. - -Lua keeps a distinguished environment called the @def{global environment}. -This value is kept at a special index in the C registry @see{registry}. -In Lua, the global variable @Lid{_G} is initialized with this same value. -(@Lid{_G} is never used internally, -so changing its value will affect only your own code.) - -When Lua loads a chunk, -the default value for its @id{_ENV} variable -is the global environment @seeF{load}. -Therefore, by default, -free names in Lua code refer to entries in the global environment -and, therefore, they are also called @def{global variables}. -Moreover, all standard libraries are loaded in the global environment -and some functions there operate on that environment. -You can use @Lid{load} (or @Lid{loadfile}) -to load a chunk with a different environment. -(In C, you have to load the chunk and then change the value -of its first upvalue; see @See{lua_setupvalue}.) - -} - -@sect2{error| @title{Error Handling} - -Several operations in Lua can @emph{raise} an error. -An error interrupts the normal flow of the program, -which can continue by @emph{catching} the error. - -Lua code can explicitly raise an error by calling the -@Lid{error} function. -(This function never returns.) - -To catch errors in Lua, -you can do a @def{protected call}, -using @Lid{pcall} (or @Lid{xpcall}). -The function @Lid{pcall} calls a given function in @def{protected mode}. -Any error while running the function stops its execution, -and control returns immediately to @id{pcall}, -which returns a status code. - -Because Lua is an embedded extension language, -Lua code starts running by a call -from @N{C code} in the host program. -(When you use Lua standalone, -the @id{lua} application is the host program.) -Usually, this call is protected; -so, when an otherwise unprotected error occurs during -the compilation or execution of a Lua chunk, -control returns to the host, -which can take appropriate measures, -such as printing an error message. - -Whenever there is an error, -an @def{error object} -is propagated with information about the error. -Lua itself only generates errors whose error object is a string, -but programs may generate errors with -any value as the error object. -It is up to the Lua program or its host to handle such error objects. -For historical reasons, -an error object is often called an @def{error message}, -even though it does not have to be a string. - - -When you use @Lid{xpcall} (or @Lid{lua_pcall}, in C) -you may give a @def{message handler} -to be called in case of errors. -This function is called with the original error object -and returns a new error object. -It is called before the error unwinds the stack, -so that it can gather more information about the error, -for instance by inspecting the stack and creating a stack traceback. -This message handler is still protected by the protected call; -so, an error inside the message handler -will call the message handler again. -If this loop goes on for too long, -Lua breaks it and returns an appropriate message. -The message handler is called only for regular runtime errors. -It is not called for memory-allocation errors -nor for errors while running finalizers or other message handlers. - -Lua also offers a system of @emph{warnings} @seeF{warn}. -Unlike errors, warnings do not interfere -in any way with program execution. -They typically only generate a message to the user, -although this behavior can be adapted from C @seeC{lua_setwarnf}. - -} - -@sect2{metatable| @title{Metatables and Metamethods} - -Every value in Lua can have a @emph{metatable}. -This @def{metatable} is an ordinary Lua table -that defines the behavior of the original value -under certain events. -You can change several aspects of the behavior -of a value by setting specific fields in its metatable. -For instance, when a non-numeric value is the operand of an addition, -Lua checks for a function in the field @idx{__add} of the value's metatable. -If it finds one, -Lua calls this function to perform the addition. - -The key for each event in a metatable is a string -with the event name prefixed by two underscores; -the corresponding value is called a @def{metavalue}. -For most events, the metavalue must be a function, -which is then called a @def{metamethod}. -In the previous example, the key is the string @St{__add} -and the metamethod is the function that performs the addition. -Unless stated otherwise, -a metamethod may in fact be any @x{callable value}, -which is either a function or a value with a @idx{__call} metamethod. - -You can query the metatable of any value -using the @Lid{getmetatable} function. -Lua queries metamethods in metatables using a raw access @seeF{rawget}. - -You can replace the metatable of tables -using the @Lid{setmetatable} function. -You cannot change the metatable of other types from Lua code, -except by using the @link{debuglib|debug library}. - -Tables and full userdata have individual metatables, -although multiple tables and userdata can share their metatables. -Values of all other types share one single metatable per type; -that is, there is one single metatable for all numbers, -one for all strings, etc. -By default, a value has no metatable, -but the string library sets a metatable for the string type @see{strlib}. - -A detailed list of operations controlled by metatables is given next. -Each event is identified by its corresponding key. -By convention, all metatable keys used by Lua are composed by -two underscores followed by lowercase Latin letters. - -@description{ - -@item{@idx{__add}| -the addition (@T{+}) operation. -If any operand for an addition is not a number, -Lua will try to call a metamethod. -It starts by checking the first operand (even if it is a number); -if that operand does not define a metamethod for @idx{__add}, -then Lua will check the second operand. -If Lua can find a metamethod, -it calls the metamethod with the two operands as arguments, -and the result of the call -(adjusted to one value) -is the result of the operation. -Otherwise, if no metamethod is found, -Lua raises an error. -} - -@item{@idx{__sub}| -the subtraction (@T{-}) operation. -Behavior similar to the addition operation. -} - -@item{@idx{__mul}| -the multiplication (@T{*}) operation. -Behavior similar to the addition operation. -} - -@item{@idx{__div}| -the division (@T{/}) operation. -Behavior similar to the addition operation. -} - -@item{@idx{__mod}| -the modulo (@T{%}) operation. -Behavior similar to the addition operation. -} - -@item{@idx{__pow}| -the exponentiation (@T{^}) operation. -Behavior similar to the addition operation. -} - -@item{@idx{__unm}| -the negation (unary @T{-}) operation. -Behavior similar to the addition operation. -} - -@item{@idx{__idiv}| -the floor division (@T{//}) operation. -Behavior similar to the addition operation. -} - -@item{@idx{__band}| -the bitwise AND (@T{&}) operation. -Behavior similar to the addition operation, -except that Lua will try a metamethod -if any operand is neither an integer -nor a float coercible to an integer @see{coercion}. -} - -@item{@idx{__bor}| -the bitwise OR (@T{|}) operation. -Behavior similar to the bitwise AND operation. -} - -@item{@idx{__bxor}| -the bitwise exclusive OR (binary @T{~}) operation. -Behavior similar to the bitwise AND operation. -} - -@item{@idx{__bnot}| -the bitwise NOT (unary @T{~}) operation. -Behavior similar to the bitwise AND operation. -} - -@item{@idx{__shl}| -the bitwise left shift (@T{<<}) operation. -Behavior similar to the bitwise AND operation. -} - -@item{@idx{__shr}| -the bitwise right shift (@T{>>}) operation. -Behavior similar to the bitwise AND operation. -} - -@item{@idx{__concat}| -the concatenation (@T{..}) operation. -Behavior similar to the addition operation, -except that Lua will try a metamethod -if any operand is neither a string nor a number -(which is always coercible to a string). -} - -@item{@idx{__len}| -the length (@T{#}) operation. -If the object is not a string, -Lua will try its metamethod. -If there is a metamethod, -Lua calls it with the object as argument, -and the result of the call -(always adjusted to one value) -is the result of the operation. -If there is no metamethod but the object is a table, -then Lua uses the table length operation @see{len-op}. -Otherwise, Lua raises an error. -} - -@item{@idx{__eq}| -the equal (@T{==}) operation. -Behavior similar to the addition operation, -except that Lua will try a metamethod only when the values -being compared are either both tables or both full userdata -and they are not primitively equal. -The result of the call is always converted to a boolean. -} - -@item{@idx{__lt}| -the less than (@T{<}) operation. -Behavior similar to the addition operation, -except that Lua will try a metamethod only when the values -being compared are neither both numbers nor both strings. -Moreover, the result of the call is always converted to a boolean. -} - -@item{@idx{__le}| -the less equal (@T{<=}) operation. -Behavior similar to the less than operation. -} - -@item{@idx{__index}| -The indexing access operation @T{table[key]}. -This event happens when @id{table} is not a table or -when @id{key} is not present in @id{table}. -The metavalue is looked up in the metatable of @id{table}. - -The metavalue for this event can be either a function, a table, -or any value with an @idx{__index} metavalue. -If it is a function, -it is called with @id{table} and @id{key} as arguments, -and the result of the call -(adjusted to one value) -is the result of the operation. -Otherwise, -the final result is the result of indexing this metavalue with @id{key}. -This indexing is regular, not raw, -and therefore can trigger another @idx{__index} metavalue. -} - -@item{@idx{__newindex}| -The indexing assignment @T{table[key] = value}. -Like the index event, -this event happens when @id{table} is not a table or -when @id{key} is not present in @id{table}. -The metavalue is looked up in the metatable of @id{table}. - -Like with indexing, -the metavalue for this event can be either a function, a table, -or any value with an @idx{__newindex} metavalue. -If it is a function, -it is called with @id{table}, @id{key}, and @id{value} as arguments. -Otherwise, -Lua repeats the indexing assignment over this metavalue -with the same key and value. -This assignment is regular, not raw, -and therefore can trigger another @idx{__newindex} metavalue. - -Whenever a @idx{__newindex} metavalue is invoked, -Lua does not perform the primitive assignment. -If needed, -the metamethod itself can call @Lid{rawset} -to do the assignment. -} - -@item{@idx{__call}| -The call operation @T{func(args)}. -This event happens when Lua tries to call a non-function value -(that is, @id{func} is not a function). -The metamethod is looked up in @id{func}. -If present, -the metamethod is called with @id{func} as its first argument, -followed by the arguments of the original call (@id{args}). -All results of the call -are the results of the operation. -This is the only metamethod that allows multiple results. -} - -} - -In addition to the previous list, -the interpreter also respects the following keys in metatables: -@idx{__gc} @see{finalizers}, -@idx{__close} @see{to-be-closed}, -@idx{__mode} @see{weak-table}, -and @idx{__name}. -(The entry @idx{__name}, -when it contains a string, -may be used by @Lid{tostring} and in error messages.) - -For the unary operators (negation, length, and bitwise NOT), -the metamethod is computed and called with a dummy second operand, -equal to the first one. -This extra operand is only to simplify Lua's internals -(by making these operators behave like a binary operation) -and may be removed in future versions. -For most uses this extra operand is irrelevant. - -Because metatables are regular tables, -they can contain arbitrary fields, -not only the event names defined above. -Some functions in the standard library -(e.g., @Lid{tostring}) -use other fields in metatables for their own purposes. - -It is a good practice to add all needed metamethods to a table -before setting it as a metatable of some object. -In particular, the @idx{__gc} metamethod works only when this order -is followed @see{finalizers}. -It is also a good practice to set the metatable of an object -right after its creation. - -} - -@sect2{GC| @title{Garbage Collection} - -@simplesect{ - -Lua performs automatic memory management. -This means that -you do not have to worry about allocating memory for new objects -or freeing it when the objects are no longer needed. -Lua manages memory automatically by running -a @def{garbage collector} to collect all @emph{dead} objects. -All memory used by Lua is subject to automatic management: -strings, tables, userdata, functions, threads, internal structures, etc. - -An object is considered @def{dead} -as soon as the collector can be sure the object -will not be accessed again in the normal execution of the program. -(@Q{Normal execution} here excludes finalizers, -which can resurrect dead objects @see{finalizers}, -and excludes also operations using the debug library.) -Note that the time when the collector can be sure that an object -is dead may not coincide with the programmer's expectations. -The only guarantees are that Lua will not collect an object -that may still be accessed in the normal execution of the program, -and it will eventually collect an object -that is inaccessible from Lua. -(Here, -@emph{inaccessible from Lua} means that neither a variable nor -another live object refer to the object.) -Because Lua has no knowledge about @N{C code}, -it never collects objects accessible through the registry @see{registry}, -which includes the global environment @see{globalenv}. - - -The garbage collector (GC) in Lua can work in two modes: -incremental and generational. - -The default GC mode with the default parameters -are adequate for most uses. -However, programs that waste a large proportion of their time -allocating and freeing memory can benefit from other settings. -Keep in mind that the GC behavior is non-portable -both across platforms and across different Lua releases; -therefore, optimal settings are also non-portable. - -You can change the GC mode and parameters by calling -@Lid{lua_gc} @N{in C} -or @Lid{collectgarbage} in Lua. -You can also use these functions to control -the collector directly (e.g., to stop and restart it). - -} - -@sect3{incmode| @title{Incremental Garbage Collection} - -In incremental mode, -each GC cycle performs a mark-and-sweep collection in small steps -interleaved with the program's execution. -In this mode, -the collector uses three numbers to control its garbage-collection cycles: -the @def{garbage-collector pause}, -the @def{garbage-collector step multiplier}, -and the @def{garbage-collector step size}. - -The garbage-collector pause -controls how long the collector waits before starting a new cycle. -The collector starts a new cycle when the use of memory -hits @M{n%} of the use after the previous collection. -Larger values make the collector less aggressive. -Values equal to or less than 100 mean the collector will not wait to -start a new cycle. -A value of 200 means that the collector waits for the total memory in use -to double before starting a new cycle. -The default value is 200; the maximum value is 1000. - -The garbage-collector step multiplier -controls the speed of the collector relative to -memory allocation, -that is, -how many elements it marks or sweeps for each -kilobyte of memory allocated. -Larger values make the collector more aggressive but also increase -the size of each incremental step. -You should not use values less than 100, -because they make the collector too slow and -can result in the collector never finishing a cycle. -The default value is 100; the maximum value is 1000. - -The garbage-collector step size controls the -size of each incremental step, -specifically how many bytes the interpreter allocates -before performing a step. -This parameter is logarithmic: -A value of @M{n} means the interpreter will allocate @M{2@sp{n}} -bytes between steps and perform equivalent work during the step. -A large value (e.g., 60) makes the collector a stop-the-world -(non-incremental) collector. -The default value is 13, -which means steps of approximately @N{8 Kbytes}. - -} - -@sect3{genmode| @title{Generational Garbage Collection} - -In generational mode, -the collector does frequent @emph{minor} collections, -which traverses only objects recently created. -If after a minor collection the use of memory is still above a limit, -the collector does a stop-the-world @emph{major} collection, -which traverses all objects. -The generational mode uses two parameters: -the @def{minor multiplier} and the @def{the major multiplier}. - -The minor multiplier controls the frequency of minor collections. -For a minor multiplier @M{x}, -a new minor collection will be done when memory -grows @M{x%} larger than the memory in use after the previous major -collection. -For instance, for a multiplier of 20, -the collector will do a minor collection when the use of memory -gets 20% larger than the use after the previous major collection. -The default value is 20; the maximum value is 200. - -The major multiplier controls the frequency of major collections. -For a major multiplier @M{x}, -a new major collection will be done when memory -grows @M{x%} larger than the memory in use after the previous major -collection. -For instance, for a multiplier of 100, -the collector will do a major collection when the use of memory -gets larger than twice the use after the previous collection. -The default value is 100; the maximum value is 1000. - -} - -@sect3{finalizers| @title{Garbage-Collection Metamethods} - -You can set garbage-collector metamethods for tables -and, using the @N{C API}, -for full userdata @see{metatable}. -These metamethods, called @def{finalizers}, -are called when the garbage collector detects that the -corresponding table or userdata is dead. -Finalizers allow you to coordinate Lua's garbage collection -with external resource management such as closing files, -network or database connections, -or freeing your own memory. - -For an object (table or userdata) to be finalized when collected, -you must @emph{mark} it for finalization. -@index{mark (for finalization)} -You mark an object for finalization when you set its metatable -and the metatable has a @idx{__gc} metamethod. -Note that if you set a metatable without a @idx{__gc} field -and later create that field in the metatable, -the object will not be marked for finalization. - -When a marked object becomes dead, -it is not collected immediately by the garbage collector. -Instead, Lua puts it in a list. -After the collection, -Lua goes through that list. -For each object in the list, -it checks the object's @idx{__gc} metamethod: -If it is present, -Lua calls it with the object as its single argument. - -At the end of each garbage-collection cycle, -the finalizers are called in -the reverse order that the objects were marked for finalization, -among those collected in that cycle; -that is, the first finalizer to be called is the one associated -with the object marked last in the program. -The execution of each finalizer may occur at any point during -the execution of the regular code. - -Because the object being collected must still be used by the finalizer, -that object (and other objects accessible only through it) -must be @emph{resurrected} by Lua.@index{resurrection} -Usually, this resurrection is transient, -and the object memory is freed in the next garbage-collection cycle. -However, if the finalizer stores the object in some global place -(e.g., a global variable), -then the resurrection is permanent. -Moreover, if the finalizer marks a finalizing object for finalization again, -its finalizer will be called again in the next cycle where the -object is dead. -In any case, -the object memory is freed only in a GC cycle where -the object is dead and not marked for finalization. - -When you close a state @seeF{lua_close}, -Lua calls the finalizers of all objects marked for finalization, -following the reverse order that they were marked. -If any finalizer marks objects for collection during that phase, -these marks have no effect. - -Finalizers cannot yield nor run the garbage collector. -Because they can run in unpredictable times, -it is good practice to restrict each finalizer -to the minimum necessary to properly release -its associated resource. - -Any error while running a finalizer generates a warning; -the error is not propagated. - -} - -@sect3{weak-table| @title{Weak Tables} - -A @def{weak table} is a table whose elements are -@def{weak references}. -A weak reference is ignored by the garbage collector. -In other words, -if the only references to an object are weak references, -then the garbage collector will collect that object. - -A weak table can have weak keys, weak values, or both. -A table with weak values allows the collection of its values, -but prevents the collection of its keys. -A table with both weak keys and weak values allows the collection of -both keys and values. -In any case, if either the key or the value is collected, -the whole pair is removed from the table. -The weakness of a table is controlled by the -@idx{__mode} field of its metatable. -This metavalue, if present, must be one of the following strings: -@St{k}, for a table with weak keys; -@St{v}, for a table with weak values; -or @St{kv}, for a table with both weak keys and values. - -A table with weak keys and strong values -is also called an @def{ephemeron table}. -In an ephemeron table, -a value is considered reachable only if its key is reachable. -In particular, -if the only reference to a key comes through its value, -the pair is removed. - -Any change in the weakness of a table may take effect only -at the next collect cycle. -In particular, if you change the weakness to a stronger mode, -Lua may still collect some items from that table -before the change takes effect. - -Only objects that have an explicit construction -are removed from weak tables. -Values, such as numbers and @x{light @N{C functions}}, -are not subject to garbage collection, -and therefore are not removed from weak tables -(unless their associated values are collected). -Although strings are subject to garbage collection, -they do not have an explicit construction and -their equality is by value; -they behave more like values than like objects. -Therefore, they are not removed from weak tables. - -Resurrected objects -(that is, objects being finalized -and objects accessible only through objects being finalized) -have a special behavior in weak tables. -They are removed from weak values before running their finalizers, -but are removed from weak keys only in the next collection -after running their finalizers, when such objects are actually freed. -This behavior allows the finalizer to access properties -associated with the object through weak tables. - -If a weak table is among the resurrected objects in a collection cycle, -it may not be properly cleared until the next cycle. - -} - -} - -@sect2{coroutine| @title{Coroutines} - -Lua supports coroutines, -also called @emphx{collaborative multithreading}. -A coroutine in Lua represents an independent thread of execution. -Unlike threads in multithread systems, however, -a coroutine only suspends its execution by explicitly calling -a yield function. - -You create a coroutine by calling @Lid{coroutine.create}. -Its sole argument is a function -that is the main function of the coroutine. -The @id{create} function only creates a new coroutine and -returns a handle to it (an object of type @emph{thread}); -it does not start the coroutine. - -You execute a coroutine by calling @Lid{coroutine.resume}. -When you first call @Lid{coroutine.resume}, -passing as its first argument -a thread returned by @Lid{coroutine.create}, -the coroutine starts its execution by -calling its main function. -Extra arguments passed to @Lid{coroutine.resume} are passed -as arguments to that function. -After the coroutine starts running, -it runs until it terminates or @emph{yields}. - -A coroutine can terminate its execution in two ways: -normally, when its main function returns -(explicitly or implicitly, after the last instruction); -and abnormally, if there is an unprotected error. -In case of normal termination, -@Lid{coroutine.resume} returns @true, -plus any values returned by the coroutine main function. -In case of errors, @Lid{coroutine.resume} returns @false -plus the error object. -In this case, the coroutine does not unwind its stack, -so that it is possible to inspect it after the error -with the debug API. - -A coroutine yields by calling @Lid{coroutine.yield}. -When a coroutine yields, -the corresponding @Lid{coroutine.resume} returns immediately, -even if the yield happens inside nested function calls -(that is, not in the main function, -but in a function directly or indirectly called by the main function). -In the case of a yield, @Lid{coroutine.resume} also returns @true, -plus any values passed to @Lid{coroutine.yield}. -The next time you resume the same coroutine, -it continues its execution from the point where it yielded, -with the call to @Lid{coroutine.yield} returning any extra -arguments passed to @Lid{coroutine.resume}. - -Like @Lid{coroutine.create}, -the @Lid{coroutine.wrap} function also creates a coroutine, -but instead of returning the coroutine itself, -it returns a function that, when called, resumes the coroutine. -Any arguments passed to this function -go as extra arguments to @Lid{coroutine.resume}. -@Lid{coroutine.wrap} returns all the values returned by @Lid{coroutine.resume}, -except the first one (the boolean error code). -Unlike @Lid{coroutine.resume}, -the function created by @Lid{coroutine.wrap} -propagates any error to the caller. -In this case, -the function also closes the coroutine @seeF{coroutine.close}. - -As an example of how coroutines work, -consider the following code: -@verbatim{ -function foo (a) - print("foo", a) - return coroutine.yield(2*a) -end - -co = coroutine.create(function (a,b) - print("co-body", a, b) - local r = foo(a+1) - print("co-body", r) - local r, s = coroutine.yield(a+b, a-b) - print("co-body", r, s) - return b, "end" -end) - -print("main", coroutine.resume(co, 1, 10)) -print("main", coroutine.resume(co, "r")) -print("main", coroutine.resume(co, "x", "y")) -print("main", coroutine.resume(co, "x", "y")) -} -When you run it, it produces the following output: -@verbatim{ -co-body 1 10 -foo 2 -main true 4 -co-body r -main true 11 -9 -co-body x y -main true 10 end -main false cannot resume dead coroutine -} - -You can also create and manipulate coroutines through the C API: -see functions @Lid{lua_newthread}, @Lid{lua_resume}, -and @Lid{lua_yield}. - -} - -} - - -@C{-------------------------------------------------------------------------} -@sect1{language| @title{The Language} - -@simplesect{ - -This section describes the lexis, the syntax, and the semantics of Lua. -In other words, -this section describes -which tokens are valid, -how they can be combined, -and what their combinations mean. - -Language constructs will be explained using the usual extended BNF notation, -in which -@N{@bnfrep{@rep{a}} means 0} or more @rep{a}'s, and -@N{@bnfopt{@rep{a}} means} an optional @rep{a}. -Non-terminals are shown like @bnfNter{non-terminal}, -keywords are shown like @rw{kword}, -and other terminal symbols are shown like @bnfter{=}. -The complete syntax of Lua can be found in @refsec{BNF} -at the end of this manual. - -} - -@sect2{lexical| @title{Lexical Conventions} - -Lua is a @x{free-form} language. -It ignores spaces and comments between lexical elements (@x{tokens}), -except as delimiters between two tokens. -In source code, -Lua recognizes as spaces the standard ASCII whitespace -characters space, form feed, newline, -carriage return, horizontal tab, and vertical tab. - -@def{Names} -(also called @def{identifiers}) -in Lua can be any string of Latin letters, -Arabic-Indic digits, and underscores, -not beginning with a digit and -not being a reserved word. -Identifiers are used to name variables, table fields, and labels. - -The following @def{keywords} are reserved -and cannot be used as names: -@index{reserved words} -@verbatim{ -and break do else elseif end -false for function goto if in -local nil not or repeat return -then true until while -} - -Lua is a case-sensitive language: -@id{and} is a reserved word, but @id{And} and @id{AND} -are two different, valid names. -As a convention, -programs should avoid creating -names that start with an underscore followed by -one or more uppercase letters (such as @Lid{_VERSION}). - -The following strings denote other @x{tokens}: -@verbatim{ -+ - * / % ^ # -& ~ | << >> // -== ~= <= >= < > = -( ) { } [ ] :: -; : , . .. ... -} - -A @def{short literal string} -can be delimited by matching single or double quotes, -and can contain the following C-like escape sequences: -@Char{\a} (bell), -@Char{\b} (backspace), -@Char{\f} (form feed), -@Char{\n} (newline), -@Char{\r} (carriage return), -@Char{\t} (horizontal tab), -@Char{\v} (vertical tab), -@Char{\\} (backslash), -@Char{\"} (quotation mark [double quote]), -and @Char{\'} (apostrophe [single quote]). -A backslash followed by a line break -results in a newline in the string. -The escape sequence @Char{\z} skips the following span -of whitespace characters, -including line breaks; -it is particularly useful to break and indent a long literal string -into multiple lines without adding the newlines and spaces -into the string contents. -A short literal string cannot contain unescaped line breaks -nor escapes not forming a valid escape sequence. - -We can specify any byte in a short literal string, -including @x{embedded zeros}, -by its numeric value. -This can be done -with the escape sequence @T{\x@rep{XX}}, -where @rep{XX} is a sequence of exactly two hexadecimal digits, -or with the escape sequence @T{\@rep{ddd}}, -where @rep{ddd} is a sequence of up to three decimal digits. -(Note that if a decimal escape sequence is to be followed by a digit, -it must be expressed using exactly three digits.) - -The @x{UTF-8} encoding of a @x{Unicode} character -can be inserted in a literal string with -the escape sequence @T{\u{@rep{XXX}}} -(with mandatory enclosing braces), -where @rep{XXX} is a sequence of one or more hexadecimal digits -representing the character code point. -This code point can be any value less than @M{2@sp{31}}. -(Lua uses the original UTF-8 specification here, -which is not restricted to valid Unicode code points.) - -Literal strings can also be defined using a long format -enclosed by @def{long brackets}. -We define an @def{opening long bracket of level @rep{n}} as an opening -square bracket followed by @rep{n} equal signs followed by another -opening square bracket. -So, an opening long bracket of @N{level 0} is written as @T{[[}, @C{]]} -an opening long bracket of @N{level 1} is written as @T{[=[}, @C{]]} -and so on. -A @emph{closing long bracket} is defined similarly; -for instance, -a closing long bracket of @N{level 4} is written as @C{[[} @T{]====]}. -A @def{long literal} starts with an opening long bracket of any level and -ends at the first closing long bracket of the same level. -It can contain any text except a closing bracket of the same level. -Literals in this bracketed form can run for several lines, -do not interpret any escape sequences, -and ignore long brackets of any other level. -Any kind of end-of-line sequence -(carriage return, newline, carriage return followed by newline, -or newline followed by carriage return) -is converted to a simple newline. -When the opening long bracket is immediately followed by a newline, -the newline is not included in the string. - -As an example, in a system using ASCII -(in which @Char{a} is coded @N{as 97}, -newline is coded @N{as 10}, and @Char{1} is coded @N{as 49}), -the five literal strings below denote the same string: -@verbatim{ -a = 'alo\n123"' -a = "alo\n123\"" -a = '\97lo\10\04923"' -a = [[alo -123"]] -a = [==[ -alo -123"]==] -} - -Any byte in a literal string not -explicitly affected by the previous rules represents itself. -However, Lua opens files for parsing in text mode, -and the system's file functions may have problems with -some control characters. -So, it is safer to represent -binary data as a quoted literal with -explicit escape sequences for the non-text characters. - -A @def{numeric constant} (or @def{numeral}) -can be written with an optional fractional part -and an optional decimal exponent, -marked by a letter @Char{e} or @Char{E}. -Lua also accepts @x{hexadecimal constants}, -which start with @T{0x} or @T{0X}. -Hexadecimal constants also accept an optional fractional part -plus an optional binary exponent, -marked by a letter @Char{p} or @Char{P} and written in decimal. -(For instance, @T{0x1.fp10} denotes 1984, -which is @M{0x1f / 16} multiplied by @M{2@sp{10}}.) - -A numeric constant with a radix point or an exponent -denotes a float; -otherwise, -if its value fits in an integer or it is a hexadecimal constant, -it denotes an integer; -otherwise (that is, a decimal integer numeral that overflows), -it denotes a float. -Hexadecimal numerals with neither a radix point nor an exponent -always denote an integer value; -if the value overflows, it @emph{wraps around} -to fit into a valid integer. - -Examples of valid integer constants are -@verbatim{ -3 345 0xff 0xBEBADA -} -Examples of valid float constants are -@verbatim{ -3.0 3.1416 314.16e-2 0.31416E1 34e1 -0x0.1E 0xA23p-4 0X1.921FB54442D18P+1 -} - -A @def{comment} starts with a double hyphen (@T{--}) -anywhere outside a string. -If the text immediately after @T{--} is not an opening long bracket, -the comment is a @def{short comment}, -which runs until the end of the line. -Otherwise, it is a @def{long comment}, -which runs until the corresponding closing long bracket. - -} - -@sect2{variables| @title{Variables} - -Variables are places that store values. -There are three kinds of variables in Lua: -global variables, local variables, and table fields. - -A single name can denote a global variable or a local variable -(or a function's formal parameter, -which is a particular kind of local variable): -@Produc{ -@producname{var}@producbody{@bnfNter{Name}} -} -@bnfNter{Name} denotes identifiers @see{lexical}. - -Any variable name is assumed to be global unless explicitly declared -as a local @see{localvar}. -@x{Local variables} are @emph{lexically scoped}: -local variables can be freely accessed by functions -defined inside their scope @see{visibility}. - -Before the first assignment to a variable, its value is @nil. - -Square brackets are used to index a table: -@Produc{ -@producname{var}@producbody{prefixexp @bnfter{[} exp @bnfter{]}} -} -The meaning of accesses to table fields can be changed via metatables -@see{metatable}. - -The syntax @id{var.Name} is just syntactic sugar for -@T{var["Name"]}: -@Produc{ -@producname{var}@producbody{prefixexp @bnfter{.} @bnfNter{Name}} -} - -An access to a global variable @id{x} -is equivalent to @id{_ENV.x}. -Due to the way that chunks are compiled, -the variable @id{_ENV} itself is never global @see{globalenv}. - -} - -@sect2{stats| @title{Statements} - -@simplesect{ - -Lua supports an almost conventional set of @x{statements}, -similar to those in other conventional languages. -This set includes -blocks, assignments, control structures, function calls, -and variable declarations. - -} - -@sect3{@title{Blocks} - -A @x{block} is a list of statements, -which are executed sequentially: -@Produc{ -@producname{block}@producbody{@bnfrep{stat}} -} -Lua has @def{empty statements} -that allow you to separate statements with semicolons, -start a block with a semicolon -or write two semicolons in sequence: -@Produc{ -@producname{stat}@producbody{@bnfter{;}} -} - -Both function calls and assignments -can start with an open parenthesis. -This possibility leads to an ambiguity in Lua's grammar. -Consider the following fragment: -@verbatim{ -a = b + c -(print or io.write)('done') -} -The grammar could see this fragment in two ways: -@verbatim{ -a = b + c(print or io.write)('done') - -a = b + c; (print or io.write)('done') -} -The current parser always sees such constructions -in the first way, -interpreting the open parenthesis -as the start of the arguments to a call. -To avoid this ambiguity, -it is a good practice to always precede with a semicolon -statements that start with a parenthesis: -@verbatim{ -;(print or io.write)('done') -} - -A block can be explicitly delimited to produce a single statement: -@Produc{ -@producname{stat}@producbody{@Rw{do} block @Rw{end}} -} -Explicit blocks are useful -to control the scope of variable declarations. -Explicit blocks are also sometimes used to -add a @Rw{return} statement in the middle -of another block @see{control}. - -} - -@sect3{chunks| @title{Chunks} - -The unit of compilation of Lua is called a @def{chunk}. -Syntactically, -a chunk is simply a block: -@Produc{ -@producname{chunk}@producbody{block} -} - -Lua handles a chunk as the body of an anonymous function -with a variable number of arguments -@see{func-def}. -As such, chunks can define local variables, -receive arguments, and return values. -Moreover, such anonymous function is compiled as in the -scope of an external local variable called @id{_ENV} @see{globalenv}. -The resulting function always has @id{_ENV} as its only external variable, -even if it does not use that variable. - -A chunk can be stored in a file or in a string inside the host program. -To execute a chunk, -Lua first @emph{loads} it, -precompiling the chunk's code into instructions for a virtual machine, -and then Lua executes the compiled code -with an interpreter for the virtual machine. - -Chunks can also be precompiled into binary form; -see the program @idx{luac} and the function @Lid{string.dump} for details. -Programs in source and compiled forms are interchangeable; -Lua automatically detects the file type and acts accordingly @seeF{load}. - -} - -@sect3{assignment| @title{Assignment} - -Lua allows @x{multiple assignments}. -Therefore, the syntax for assignment -defines a list of variables on the left side -and a list of expressions on the right side. -The elements in both lists are separated by commas: -@Produc{ -@producname{stat}@producbody{varlist @bnfter{=} explist} -@producname{varlist}@producbody{var @bnfrep{@bnfter{,} var}} -@producname{explist}@producbody{exp @bnfrep{@bnfter{,} exp}} -} -Expressions are discussed in @See{expressions}. - -Before the assignment, -the list of values is @emph{adjusted} to the length of -the list of variables @see{multires}. - -If a variable is both assigned and read -inside a multiple assignment, -Lua ensures that all reads get the value of the variable -before the assignment. -Thus the code -@verbatim{ -i = 3 -i, a[i] = i+1, 20 -} -sets @T{a[3]} to 20, without affecting @T{a[4]} -because the @id{i} in @T{a[i]} is evaluated (to 3) -before it is @N{assigned 4}. -Similarly, the line -@verbatim{ -x, y = y, x -} -exchanges the values of @id{x} and @id{y}, -and -@verbatim{ -x, y, z = y, z, x -} -cyclically permutes the values of @id{x}, @id{y}, and @id{z}. - -Note that this guarantee covers only accesses -syntactically inside the assignment statement. -If a function or a metamethod called during the assignment -changes the value of a variable, -Lua gives no guarantees about the order of that access. - -An assignment to a global name @T{x = val} -is equivalent to the assignment -@T{_ENV.x = val} @see{globalenv}. - -The meaning of assignments to table fields and -global variables (which are actually table fields, too) -can be changed via metatables @see{metatable}. - -} - -@sect3{control| @title{Control Structures} -The control structures -@Rw{if}, @Rw{while}, and @Rw{repeat} have the usual meaning and -familiar syntax: -@index{while-do statement} -@index{repeat-until statement} -@index{if-then-else statement} -@Produc{ -@producname{stat}@producbody{@Rw{while} exp @Rw{do} block @Rw{end}} -@producname{stat}@producbody{@Rw{repeat} block @Rw{until} exp} -@producname{stat}@producbody{@Rw{if} exp @Rw{then} block - @bnfrep{@Rw{elseif} exp @Rw{then} block} - @bnfopt{@Rw{else} block} @Rw{end}} -} -Lua also has a @Rw{for} statement, in two flavors @see{for}. - -The @x{condition expression} of a -control structure can return any value. -Both @false and @nil test false. -All values different from @nil and @false test true. -In particular, the number 0 and the empty string also test true. - -In the @Rw{repeat}@En@Rw{until} loop, -the inner block does not end at the @Rw{until} keyword, -but only after the condition. -So, the condition can refer to local variables -declared inside the loop block. - -The @Rw{goto} statement transfers the program control to a label. -For syntactical reasons, -labels in Lua are considered statements too: -@index{goto statement} -@index{label} -@Produc{ -@producname{stat}@producbody{@Rw{goto} Name} -@producname{stat}@producbody{label} -@producname{label}@producbody{@bnfter{::} Name @bnfter{::}} -} - -A label is visible in the entire block where it is defined, -except inside nested functions. -A goto may jump to any visible label as long as it does not -enter into the scope of a local variable. -A label should not be declared -where a label with the same name is visible, -even if this other label has been declared in an enclosing block. - -The @Rw{break} statement terminates the execution of a -@Rw{while}, @Rw{repeat}, or @Rw{for} loop, -skipping to the next statement after the loop: -@index{break statement} -@Produc{ -@producname{stat}@producbody{@Rw{break}} -} -A @Rw{break} ends the innermost enclosing loop. - -The @Rw{return} statement is used to return values -from a function or a chunk -(which is handled as an anonymous function). -@index{return statement} -Functions can return more than one value, -so the syntax for the @Rw{return} statement is -@Produc{ -@producname{stat}@producbody{@Rw{return} @bnfopt{explist} @bnfopt{@bnfter{;}}} -} - -The @Rw{return} statement can only be written -as the last statement of a block. -If it is necessary to @Rw{return} in the middle of a block, -then an explicit inner block can be used, -as in the idiom @T{do return end}, -because now @Rw{return} is the last statement in its (inner) block. - -} - -@sect3{for| @title{For Statement} - -@index{for statement} -The @Rw{for} statement has two forms: -one numerical and one generic. - -@sect4{@title{The numerical @Rw{for} loop} - -The numerical @Rw{for} loop repeats a block of code while a -control variable goes through an arithmetic progression. -It has the following syntax: -@Produc{ -@producname{stat}@producbody{@Rw{for} @bnfNter{Name} @bnfter{=} - exp @bnfter{,} exp @bnfopt{@bnfter{,} exp} @Rw{do} block @Rw{end}} -} -The given identifier (@bnfNter{Name}) defines the control variable, -which is a new variable local to the loop body (@emph{block}). - -The loop starts by evaluating once the three control expressions. -Their values are called respectively -the @emph{initial value}, the @emph{limit}, and the @emph{step}. -If the step is absent, it defaults @N{to 1}. - -If both the initial value and the step are integers, -the loop is done with integers; -note that the limit may not be an integer. -Otherwise, the three values are converted to -floats and the loop is done with floats. -Beware of floating-point accuracy in this case. - -After that initialization, -the loop body is repeated with the value of the control variable -going through an arithmetic progression, -starting at the initial value, -with a common difference given by the step. -A negative step makes a decreasing sequence; -a step equal to zero raises an error. -The loop continues while the value is less than -or equal to the limit -(greater than or equal to for a negative step). -If the initial value is already greater than the limit -(or less than, if the step is negative), -the body is not executed. - -For integer loops, -the control variable never wraps around; -instead, the loop ends in case of an overflow. - -You should not change the value of the control variable -during the loop. -If you need its value after the loop, -assign it to another variable before exiting the loop. - -} - -@sect4{@title{The generic @Rw{for} loop} - - -The generic @Rw{for} statement works over functions, -called @def{iterators}. -On each iteration, the iterator function is called to produce a new value, -stopping when this new value is @nil. -The generic @Rw{for} loop has the following syntax: -@Produc{ -@producname{stat}@producbody{@Rw{for} namelist @Rw{in} explist - @Rw{do} block @Rw{end}} -@producname{namelist}@producbody{@bnfNter{Name} @bnfrep{@bnfter{,} @bnfNter{Name}}} -} -A @Rw{for} statement like -@verbatim{ -for @rep{var_1}, @Cdots, @rep{var_n} in @rep{explist} do @rep{body} end -} -works as follows. - -The names @rep{var_i} declare loop variables local to the loop body. -The first of these variables is the @emph{control variable}. - -The loop starts by evaluating @rep{explist} -to produce four values: -an @emph{iterator function}, -a @emph{state}, -an initial value for the control variable, -and a @emph{closing value}. - -Then, at each iteration, -Lua calls the iterator function with two arguments: -the state and the control variable. -The results from this call are then assigned to the loop variables, -following the rules of multiple assignments @see{assignment}. -If the control variable becomes @nil, -the loop terminates. -Otherwise, the body is executed and the loop goes -to the next iteration. - -The closing value behaves like a -to-be-closed variable @see{to-be-closed}, -which can be used to release resources when the loop ends. -Otherwise, it does not interfere with the loop. - -You should not change the value of the control variable -during the loop. - -} - -} - -@sect3{funcstat| @title{Function Calls as Statements} -To allow possible side-effects, -function calls can be executed as statements: -@Produc{ -@producname{stat}@producbody{functioncall} -} -In this case, all returned values are thrown away. -Function calls are explained in @See{functioncall}. - -} - -@sect3{localvar| @title{Local Declarations} -@x{Local variables} can be declared anywhere inside a block. -The declaration can include an initialization: -@Produc{ -@producname{stat}@producbody{@Rw{local} attnamelist @bnfopt{@bnfter{=} explist}} -@producname{attnamelist}@producbody{ - @bnfNter{Name} attrib @bnfrep{@bnfter{,} @bnfNter{Name} attrib}} -} -If present, an initial assignment has the same semantics -of a multiple assignment @see{assignment}. -Otherwise, all variables are initialized with @nil. - -Each variable name may be postfixed by an attribute -(a name between angle brackets): -@Produc{ -@producname{attrib}@producbody{@bnfopt{@bnfter{<} @bnfNter{Name} @bnfter{>}}} -} -There are two possible attributes: -@id{const}, which declares a @x{constant variable}, -that is, a variable that cannot be assigned to -after its initialization; -and @id{close}, which declares a to-be-closed variable @see{to-be-closed}. -A list of variables can contain at most one to-be-closed variable. - -A chunk is also a block @see{chunks}, -and so local variables can be declared in a chunk outside any explicit block. - -The visibility rules for local variables are explained in @See{visibility}. - -} - -@sect3{to-be-closed| @title{To-be-closed Variables} - -A to-be-closed variable behaves like a constant local variable, -except that its value is @emph{closed} whenever the variable -goes out of scope, including normal block termination, -exiting its block by @Rw{break}/@Rw{goto}/@Rw{return}, -or exiting by an error. - -Here, to @emph{close} a value means -to call its @idx{__close} metamethod. -When calling the metamethod, -the value itself is passed as the first argument -and the error object that caused the exit (if any) -is passed as a second argument; -if there was no error, the second argument is @nil. - -The value assigned to a to-be-closed variable -must have a @idx{__close} metamethod -or be a false value. -(@nil and @false are ignored as to-be-closed values.) - -If several to-be-closed variables go out of scope at the same event, -they are closed in the reverse order that they were declared. - -If there is any error while running a closing method, -that error is handled like an error in the regular code -where the variable was defined. -After an error, -the other pending closing methods will still be called. - -If a coroutine yields and is never resumed again, -some variables may never go out of scope, -and therefore they will never be closed. -(These variables are the ones created inside the coroutine -and in scope at the point where the coroutine yielded.) -Similarly, if a coroutine ends with an error, -it does not unwind its stack, -so it does not close any variable. -In both cases, -you can either use finalizers -or call @Lid{coroutine.close} to close the variables. -However, if the coroutine was created -through @Lid{coroutine.wrap}, -then its corresponding function will close the coroutine -in case of errors. - -} - -} - -@sect2{expressions| @title{Expressions} - -@simplesect{ - -The basic expressions in Lua are the following: -@Produc{ -@producname{exp}@producbody{prefixexp} -@producname{exp}@producbody{@Rw{nil} @Or @Rw{false} @Or @Rw{true}} -@producname{exp}@producbody{@bnfNter{Numeral}} -@producname{exp}@producbody{@bnfNter{LiteralString}} -@producname{exp}@producbody{functiondef} -@producname{exp}@producbody{tableconstructor} -@producname{exp}@producbody{@bnfter{...}} -@producname{exp}@producbody{exp binop exp} -@producname{exp}@producbody{unop exp} -@producname{prefixexp}@producbody{var @Or functioncall @Or - @bnfter{(} exp @bnfter{)}} -} - -Numerals and literal strings are explained in @See{lexical}; -variables are explained in @See{variables}; -function definitions are explained in @See{func-def}; -function calls are explained in @See{functioncall}; -table constructors are explained in @See{tableconstructor}. -Vararg expressions, -denoted by three dots (@Char{...}), can only be used when -directly inside a variadic function; -they are explained in @See{func-def}. - - -Binary operators comprise arithmetic operators @see{arith}, -bitwise operators @see{bitwise}, -relational operators @see{rel-ops}, logical operators @see{logic}, -and the concatenation operator @see{concat}. -Unary operators comprise the unary minus @see{arith}, -the unary bitwise NOT @see{bitwise}, -the unary logical @Rw{not} @see{logic}, -and the unary @def{length operator} @see{len-op}. - -} - - - -@sect3{arith| @title{Arithmetic Operators} -Lua supports the following @x{arithmetic operators}: -@description{ -@item{@T{+}|addition} -@item{@T{-}|subtraction} -@item{@T{*}|multiplication} -@item{@T{/}|float division} -@item{@T{//}|floor division} -@item{@T{%}|modulo} -@item{@T{^}|exponentiation} -@item{@T{-}|unary minus} -} - -With the exception of exponentiation and float division, -the arithmetic operators work as follows: -If both operands are integers, -the operation is performed over integers and the result is an integer. -Otherwise, if both operands are numbers, -then they are converted to floats, -the operation is performed following the machine's rules -for floating-point arithmetic -(usually the @x{IEEE 754} standard), -and the result is a float. -(The string library coerces strings to numbers in -arithmetic operations; see @See{coercion} for details.) - -Exponentiation and float division (@T{/}) -always convert their operands to floats -and the result is always a float. -Exponentiation uses the @ANSI{pow}, -so that it works for non-integer exponents too. - -Floor division (@T{//}) is a division -that rounds the quotient towards minus infinity, -resulting in the floor of the division of its operands. - -Modulo is defined as the remainder of a division -that rounds the quotient towards minus infinity (floor division). - -In case of overflows in integer arithmetic, -all operations @emphx{wrap around}. -} - -@sect3{bitwise| @title{Bitwise Operators} -Lua supports the following @x{bitwise operators}: -@description{ -@item{@T{&}|bitwise AND} -@item{@T{@VerBar}|bitwise OR} -@item{@T{~}|bitwise exclusive OR} -@item{@T{>>}|right shift} -@item{@T{<<}|left shift} -@item{@T{~}|unary bitwise NOT} -} - -All bitwise operations convert its operands to integers -@see{coercion}, -operate on all bits of those integers, -and result in an integer. - -Both right and left shifts fill the vacant bits with zeros. -Negative displacements shift to the other direction; -displacements with absolute values equal to or higher than -the number of bits in an integer -result in zero (as all bits are shifted out). - -} - -@sect3{coercion| @title{Coercions and Conversions} -Lua provides some automatic conversions between some -types and representations at run time. -Bitwise operators always convert float operands to integers. -Exponentiation and float division -always convert integer operands to floats. -All other arithmetic operations applied to mixed numbers -(integers and floats) convert the integer operand to a float. -The C API also converts both integers to floats and -floats to integers, as needed. -Moreover, string concatenation accepts numbers as arguments, -besides strings. - -In a conversion from integer to float, -if the integer value has an exact representation as a float, -that is the result. -Otherwise, -the conversion gets the nearest higher or -the nearest lower representable value. -This kind of conversion never fails. - -The conversion from float to integer -checks whether the float has an exact representation as an integer -(that is, the float has an integral value and -it is in the range of integer representation). -If it does, that representation is the result. -Otherwise, the conversion fails. - -Several places in Lua coerce strings to numbers when necessary. -In particular, -the string library sets metamethods that try to coerce -strings to numbers in all arithmetic operations. -If the conversion fails, -the library calls the metamethod of the other operand -(if present) or it raises an error. -Note that bitwise operators do not do this coercion. - -It is always a good practice not to rely on the -implicit coercions from strings to numbers, -as they are not always applied; -in particular, @T{"1"==1} is false and @T{"1"<1} raises an error -@see{rel-ops}. -These coercions exist mainly for compatibility and may be removed -in future versions of the language. - -A string is converted to an integer or a float -following its syntax and the rules of the Lua lexer. -The string may have also leading and trailing whitespaces and a sign. -All conversions from strings to numbers -accept both a dot and the current locale mark -as the radix character. -(The Lua lexer, however, accepts only a dot.) -If the string is not a valid numeral, -the conversion fails. -If necessary, the result of this first step is then converted -to a specific number subtype following the previous rules -for conversions between floats and integers. - -The conversion from numbers to strings uses a -non-specified human-readable format. -To convert numbers to strings in any specific way, -use the function @Lid{string.format}. - -} - -@sect3{rel-ops| @title{Relational Operators} -Lua supports the following @x{relational operators}: -@description{ -@item{@T{==}|equality} -@item{@T{~=}|inequality} -@item{@T{<}|less than} -@item{@T{>}|greater than} -@item{@T{<=}|less or equal} -@item{@T{>=}|greater or equal} -} -These operators always result in @false or @true. - -Equality (@T{==}) first compares the type of its operands. -If the types are different, then the result is @false. -Otherwise, the values of the operands are compared. -Strings are equal if they have the same byte content. -Numbers are equal if they denote the same mathematical value. - -Tables, userdata, and threads -are compared by reference: -two objects are considered equal only if they are the same object. -Every time you create a new object -(a table, a userdata, or a thread), -this new object is different from any previously existing object. -A function is always equal to itself. -Functions with any detectable difference -(different behavior, different definition) are always different. -Functions created at different times but with no detectable differences -may be classified as equal or not -(depending on internal caching details). - -You can change the way that Lua compares tables and userdata -by using the @idx{__eq} metamethod @see{metatable}. - -Equality comparisons do not convert strings to numbers -or vice versa. -Thus, @T{"0"==0} evaluates to @false, -and @T{t[0]} and @T{t["0"]} denote different -entries in a table. - -The operator @T{~=} is exactly the negation of equality (@T{==}). - -The order operators work as follows. -If both arguments are numbers, -then they are compared according to their mathematical values, -regardless of their subtypes. -Otherwise, if both arguments are strings, -then their values are compared according to the current locale. -Otherwise, Lua tries to call the @idx{__lt} or the @idx{__le} -metamethod @see{metatable}. -A comparison @T{a > b} is translated to @T{b < a} -and @T{a >= b} is translated to @T{b <= a}. - -Following the @x{IEEE 754} standard, -the special value @x{NaN} is considered neither less than, -nor equal to, nor greater than any value, including itself. - -} - -@sect3{logic| @title{Logical Operators} -The @x{logical operators} in Lua are -@Rw{and}, @Rw{or}, and @Rw{not}. -Like the control structures @see{control}, -all logical operators consider both @false and @nil as false -and anything else as true. - -The negation operator @Rw{not} always returns @false or @true. -The conjunction operator @Rw{and} returns its first argument -if this value is @false or @nil; -otherwise, @Rw{and} returns its second argument. -The disjunction operator @Rw{or} returns its first argument -if this value is different from @nil and @false; -otherwise, @Rw{or} returns its second argument. -Both @Rw{and} and @Rw{or} use @x{short-circuit evaluation}; -that is, -the second operand is evaluated only if necessary. -Here are some examples: -@verbatim{ -10 or 20 --> 10 -10 or error() --> 10 -nil or "a" --> "a" -nil and 10 --> nil -false and error() --> false -false and nil --> false -false or nil --> nil -10 and 20 --> 20 -} - -} - -@sect3{concat| @title{Concatenation} -The string @x{concatenation} operator in Lua is -denoted by two dots (@Char{..}). -If both operands are strings or numbers, -then the numbers are converted to strings -in a non-specified format @see{coercion}. -Otherwise, the @idx{__concat} metamethod is called @see{metatable}. - -} - -@sect3{len-op| @title{The Length Operator} - -The length operator is denoted by the unary prefix operator @T{#}. - -The length of a string is its number of bytes. -(That is the usual meaning of string length when each -character is one byte.) - -The length operator applied on a table -returns a @x{border} in that table. -A @def{border} in a table @id{t} is any non-negative integer -that satisfies the following condition: -@verbatim{ -(border == 0 or t[border] ~= nil) and -(t[border + 1] == nil or border == math.maxinteger) -} -In words, -a border is any positive integer index present in the table -that is followed by an absent index, -plus two limit cases: -zero, when index 1 is absent; -and the maximum value for an integer, when that index is present. -Note that keys that are not positive integers -do not interfere with borders. - -A table with exactly one border is called a @def{sequence}. -For instance, the table @T{{10, 20, 30, 40, 50}} is a sequence, -as it has only one border (5). -The table @T{{10, 20, 30, nil, 50}} has two borders (3 and 5), -and therefore it is not a sequence. -(The @nil at index 4 is called a @emphx{hole}.) -The table @T{{nil, 20, 30, nil, nil, 60, nil}} -has three borders (0, 3, and 6), -so it is not a sequence, too. -The table @T{{}} is a sequence with border 0. - -When @id{t} is a sequence, -@T{#t} returns its only border, -which corresponds to the intuitive notion of the length of the sequence. -When @id{t} is not a sequence, -@T{#t} can return any of its borders. -(The exact one depends on details of -the internal representation of the table, -which in turn can depend on how the table was populated and -the memory addresses of its non-numeric keys.) - -The computation of the length of a table -has a guaranteed worst time of @M{O(log n)}, -where @M{n} is the largest integer key in the table. - -A program can modify the behavior of the length operator for -any value but strings through the @idx{__len} metamethod @see{metatable}. - -} - -@sect3{prec| @title{Precedence} -@x{Operator precedence} in Lua follows the table below, -from lower to higher priority: -@verbatim{ -or -and -< > <= >= ~= == -| -~ -& -<< >> -.. -+ - -* / // % -unary operators (not # - ~) -^ -} -As usual, -you can use parentheses to change the precedences of an expression. -The concatenation (@Char{..}) and exponentiation (@Char{^}) -operators are right associative. -All other binary operators are left associative. - -} - -@sect3{tableconstructor| @title{Table Constructors} -Table @x{constructors} are expressions that create tables. -Every time a constructor is evaluated, a new table is created. -A constructor can be used to create an empty table -or to create a table and initialize some of its fields. -The general syntax for constructors is -@Produc{ -@producname{tableconstructor}@producbody{@bnfter{@Open} @bnfopt{fieldlist} @bnfter{@Close}} -@producname{fieldlist}@producbody{field @bnfrep{fieldsep field} @bnfopt{fieldsep}} -@producname{field}@producbody{@bnfter{[} exp @bnfter{]} @bnfter{=} exp @Or - @bnfNter{Name} @bnfter{=} exp @Or exp} -@producname{fieldsep}@producbody{@bnfter{,} @Or @bnfter{;}} -} - -Each field of the form @T{[exp1] = exp2} adds to the new table an entry -with key @id{exp1} and value @id{exp2}. -A field of the form @T{name = exp} is equivalent to -@T{["name"] = exp}. -Fields of the form @id{exp} are equivalent to -@T{[i] = exp}, where @id{i} are consecutive integers -starting with 1; -fields in the other formats do not affect this counting. -For example, -@verbatim{ -a = { [f(1)] = g; "x", "y"; x = 1, f(x), [30] = 23; 45 } -} -is equivalent to -@verbatim{ -do - local t = {} - t[f(1)] = g - t[1] = "x" -- 1st exp - t[2] = "y" -- 2nd exp - t.x = 1 -- t["x"] = 1 - t[3] = f(x) -- 3rd exp - t[30] = 23 - t[4] = 45 -- 4th exp - a = t -end -} - -The order of the assignments in a constructor is undefined. -(This order would be relevant only when there are repeated keys.) - -If the last field in the list has the form @id{exp} -and the expression is a multires expression, -then all values returned by this expression enter the list consecutively -@see{multires}. - -The field list can have an optional trailing separator, -as a convenience for machine-generated code. - -} - -@sect3{functioncall| @title{Function Calls} -A @x{function call} in Lua has the following syntax: -@Produc{ -@producname{functioncall}@producbody{prefixexp args} -} -In a function call, -first @bnfNter{prefixexp} and @bnfNter{args} are evaluated. -If the value of @bnfNter{prefixexp} has type @emph{function}, -then this function is called -with the given arguments. -Otherwise, if present, -the @bnfNter{prefixexp} @idx{__call} metamethod is called: -its first argument is the value of @bnfNter{prefixexp}, -followed by the original call arguments -@see{metatable}. - -The form -@Produc{ -@producname{functioncall}@producbody{prefixexp @bnfter{:} @bnfNter{Name} args} -} -can be used to emulate methods. -A call @T{v:name(@rep{args})} -is syntactic sugar for @T{v.name(v,@rep{args})}, -except that @id{v} is evaluated only once. - -Arguments have the following syntax: -@Produc{ -@producname{args}@producbody{@bnfter{(} @bnfopt{explist} @bnfter{)}} -@producname{args}@producbody{tableconstructor} -@producname{args}@producbody{@bnfNter{LiteralString}} -} -All argument expressions are evaluated before the call. -A call of the form @T{f{@rep{fields}}} is -syntactic sugar for @T{f({@rep{fields}})}; -that is, the argument list is a single new table. -A call of the form @T{f'@rep{string}'} -(or @T{f"@rep{string}"} or @T{f[[@rep{string}]]}) -is syntactic sugar for @T{f('@rep{string}')}; -that is, the argument list is a single literal string. - -A call of the form @T{return @rep{functioncall}} not in the -scope of a to-be-closed variable is called a @def{tail call}. -Lua implements @def{proper tail calls} -(or @def{proper tail recursion}): -In a tail call, -the called function reuses the stack entry of the calling function. -Therefore, there is no limit on the number of nested tail calls that -a program can execute. -However, a tail call erases any debug information about the -calling function. -Note that a tail call only happens with a particular syntax, -where the @Rw{return} has one single function call as argument, -and it is outside the scope of any to-be-closed variable. -This syntax makes the calling function return exactly -the returns of the called function, -without any intervening action. -So, none of the following examples are tail calls: -@verbatim{ -return (f(x)) -- results adjusted to 1 -return 2 * f(x) -- result multiplied by 2 -return x, f(x) -- additional results -f(x); return -- results discarded -return x or f(x) -- results adjusted to 1 -} - -} - -@sect3{func-def| @title{Function Definitions} - -The syntax for function definition is -@Produc{ -@producname{functiondef}@producbody{@Rw{function} funcbody} -@producname{funcbody}@producbody{@bnfter{(} @bnfopt{parlist} @bnfter{)} block @Rw{end}} -} - -The following syntactic sugar simplifies function definitions: -@Produc{ -@producname{stat}@producbody{@Rw{function} funcname funcbody} -@producname{stat}@producbody{@Rw{local} @Rw{function} @bnfNter{Name} funcbody} -@producname{funcname}@producbody{@bnfNter{Name} @bnfrep{@bnfter{.} @bnfNter{Name}} @bnfopt{@bnfter{:} @bnfNter{Name}}} -} -The statement -@verbatim{ -function f () @rep{body} end -} -translates to -@verbatim{ -f = function () @rep{body} end -} -The statement -@verbatim{ -function t.a.b.c.f () @rep{body} end -} -translates to -@verbatim{ -t.a.b.c.f = function () @rep{body} end -} -The statement -@verbatim{ -local function f () @rep{body} end -} -translates to -@verbatim{ -local f; f = function () @rep{body} end -} -not to -@verbatim{ -local f = function () @rep{body} end -} -(This only makes a difference when the body of the function -contains references to @id{f}.) - -A function definition is an executable expression, -whose value has type @emph{function}. -When Lua precompiles a chunk, -all its function bodies are precompiled too, -but they are not created yet. -Then, whenever Lua executes the function definition, -the function is @emph{instantiated} (or @emph{closed}). -This function instance, or @emphx{closure}, -is the final value of the expression. - -Parameters act as local variables that are -initialized with the argument values: -@Produc{ -@producname{parlist}@producbody{namelist @bnfopt{@bnfter{,} @bnfter{...}} @Or - @bnfter{...}} -} -When a Lua function is called, -it adjusts its list of @x{arguments} to -the length of its list of parameters @see{multires}, -unless the function is a @def{variadic function}, -which is indicated by three dots (@Char{...}) -at the end of its parameter list. -A variadic function does not adjust its argument list; -instead, it collects all extra arguments and supplies them -to the function through a @def{vararg expression}, -which is also written as three dots. -The value of this expression is a list of all actual extra arguments, -similar to a function with multiple results @see{multires}. - - -As an example, consider the following definitions: -@verbatim{ -function f(a, b) end -function g(a, b, ...) end -function r() return 1,2,3 end -} -Then, we have the following mapping from arguments to parameters and -to the vararg expression: -@verbatim{ -CALL PARAMETERS - -f(3) a=3, b=nil -f(3, 4) a=3, b=4 -f(3, 4, 5) a=3, b=4 -f(r(), 10) a=1, b=10 -f(r()) a=1, b=2 - -g(3) a=3, b=nil, ... --> (nothing) -g(3, 4) a=3, b=4, ... --> (nothing) -g(3, 4, 5, 8) a=3, b=4, ... --> 5 8 -g(5, r()) a=5, b=1, ... --> 2 3 -} - -Results are returned using the @Rw{return} statement @see{control}. -If control reaches the end of a function -without encountering a @Rw{return} statement, -then the function returns with no results. - -@index{multiple return} -There is a system-dependent limit on the number of values -that a function may return. -This limit is guaranteed to be greater than 1000. - -The @emphx{colon} syntax -is used to emulate @def{methods}, -adding an implicit extra parameter @idx{self} to the function. -Thus, the statement -@verbatim{ -function t.a.b.c:f (@rep{params}) @rep{body} end -} -is syntactic sugar for -@verbatim{ -t.a.b.c.f = function (self, @rep{params}) @rep{body} end -} - -} - -@sect3{multires| @title{Lists of expressions, multiple results, -and adjustment} - -Both function calls and vararg expressions can result in multiple values. -These expressions are called @def{multires expressions}. - -When a multires expression is used as the last element -of a list of expressions, -all results from the expression are added to the -list of values produced by the list of expressions. -Note that a single expression -in a place that expects a list of expressions -is the last expression in that (singleton) list. - -These are the places where Lua expects a list of expressions: -@description{ - -@item{A @rw{return} statement, -for instance @T{return e1, e2, e3} @see{control}.} - -@item{A table constructor, -for instance @T{{e1, e2, e3}} @see{tableconstructor}.} - -@item{The arguments of a function call, -for instance @T{foo(e1, e2, e3)} @see{functioncall}.} - -@item{A multiple assignment, -for instance @T{a , b, c = e1, e2, e3} @see{assignment}.} - -@item{A local declaration, -for instance @T{local a , b, c = e1, e2, e3} @see{localvar}.} - -@item{The initial values in a generic @rw{for} loop, -for instance @T{for k in e1, e2, e3 do ... end} @see{for}.} - -} -In the last four cases, -the list of values from the list of expressions -must be @emph{adjusted} to a specific length: -the number of parameters in a call to a non-variadic function -@see{func-def}, -the number of variables in a multiple assignment or -a local declaration, -and exactly four values for a generic @rw{for} loop. -The @def{adjustment} follows these rules: -If there are more values than needed, -the extra values are thrown away; -if there are fewer values than needed, -the list is extended with @nil's. -When the list of expressions ends with a multires expression, -all results from that expression enter the list of values -before the adjustment. - -When a multires expression is used -in a list of expressions without being the last element, -or in a place where the syntax expects a single expression, -Lua adjusts the result list of that expression to one element. -As a particular case, -the syntax expects a single expression inside a parenthesized expression; -therefore, adding parentheses around a multires expression -forces it to produce exactly one result. - -We seldom need to use a vararg expression in a place -where the syntax expects a single expression. -(Usually it is simpler to add a regular parameter before -the variadic part and use that parameter.) -When there is such a need, -we recommend assigning the vararg expression -to a single variable and using that variable -in its place. - -Here are some examples of uses of mutlres expressions. -In all cases, when the construction needs -@Q{the n-th result} and there is no such result, -it uses a @nil. -@verbatim{ -print(x, f()) -- prints x and all results from f(). -print(x, (f())) -- prints x and the first result from f(). -print(f(), x) -- prints the first result from f() and x. -print(1 + f()) -- prints 1 added to the first result from f(). -local x = ... -- x gets the first vararg argument. -x,y = ... -- x gets the first vararg argument, - -- y gets the second vararg argument. -x,y,z = w, f() -- x gets w, y gets the first result from f(), - -- z gets the second result from f(). -x,y,z = f() -- x gets the first result from f(), - -- y gets the second result from f(), - -- z gets the third result from f(). -x,y,z = f(), g() -- x gets the first result from f(), - -- y gets the first result from g(), - -- z gets the second result from g(). -x,y,z = (f()) -- x gets the first result from f(), y and z get nil. -return f() -- returns all results from f(). -return x, ... -- returns x and all received vararg arguments. -return x,y,f() -- returns x, y, and all results from f(). -{f()} -- creates a list with all results from f(). -{...} -- creates a list with all vararg arguments. -{f(), 5} -- creates a list with the first result from f() and 5. -} - -} - -} - -@sect2{visibility| @title{Visibility Rules} - -@index{visibility} -Lua is a lexically scoped language. -The scope of a local variable begins at the first statement after -its declaration and lasts until the last non-void statement -of the innermost block that includes the declaration. -(@emph{Void statements} are labels and empty statements.) -Consider the following example: -@verbatim{ -x = 10 -- global variable -do -- new block - local x = x -- new 'x', with value 10 - print(x) --> 10 - x = x+1 - do -- another block - local x = x+1 -- another 'x' - print(x) --> 12 - end - print(x) --> 11 -end -print(x) --> 10 (the global one) -} - -Notice that, in a declaration like @T{local x = x}, -the new @id{x} being declared is not in scope yet, -and so the second @id{x} refers to the outside variable. - -Because of the @x{lexical scoping} rules, -local variables can be freely accessed by functions -defined inside their scope. -A local variable used by an inner function is called an @def{upvalue} -(or @emphx{external local variable}, or simply @emphx{external variable}) -inside the inner function. - -Notice that each execution of a @Rw{local} statement -defines new local variables. -Consider the following example: -@verbatim{ -a = {} -local x = 20 -for i = 1, 10 do - local y = 0 - a[i] = function () y = y + 1; return x + y end -end -} -The loop creates ten closures -(that is, ten instances of the anonymous function). -Each of these closures uses a different @id{y} variable, -while all of them share the same @id{x}. - -} - -} - - -@C{-------------------------------------------------------------------------} -@sect1{API| @title{The Application Program Interface} - -@simplesect{ - -@index{C API} -This section describes the @N{C API} for Lua, that is, -the set of @N{C functions} available to the host program to communicate -with Lua. -All API functions and related types and constants -are declared in the header file @defid{lua.h}. - -Even when we use the term @Q{function}, -any facility in the API may be provided as a macro instead. -Except where stated otherwise, -all such macros use each of their arguments exactly once -(except for the first argument, which is always a Lua state), -and so do not generate any hidden side-effects. - -As in most @N{C libraries}, -the Lua API functions do not check their arguments -for validity or consistency. -However, you can change this behavior by compiling Lua -with the macro @defid{LUA_USE_APICHECK} defined. - -The Lua library is fully reentrant: -it has no global variables. -It keeps all information it needs in a dynamic structure, -called the @def{Lua state}. - -Each Lua state has one or more threads, -which correspond to independent, cooperative lines of execution. -The type @Lid{lua_State} (despite its name) refers to a thread. -(Indirectly, through the thread, it also refers to the -Lua state associated to the thread.) - -A pointer to a thread must be passed as the first argument to -every function in the library, except to @Lid{lua_newstate}, -which creates a Lua state from scratch and returns a pointer -to the @emph{main thread} in the new state. - -} - - -@sect2{@title{The Stack} - -@simplesect{ - -Lua uses a @emph{virtual stack} to pass values to and from C. -Each element in this stack represents a Lua value -(@nil, number, string, etc.). -Functions in the API can access this stack through the -Lua state parameter that they receive. - -Whenever Lua calls C, the called function gets a new stack, -which is independent of previous stacks and of stacks of -@N{C functions} that are still active. -This stack initially contains any arguments to the @N{C function} -and it is where the @N{C function} can store temporary -Lua values and must push its results -to be returned to the caller @seeC{lua_CFunction}. - -For convenience, -most query operations in the API do not follow a strict stack discipline. -Instead, they can refer to any element in the stack -by using an @emph{index}:@index{index (API stack)} -A positive index represents an absolute stack position, -starting @N{at 1} as the bottom of the stack; -a negative index represents an offset relative to the top of the stack. -More specifically, if the stack has @rep{n} elements, -then @N{index 1} represents the first element -(that is, the element that was pushed onto the stack first) -and -@N{index @rep{n}} represents the last element; -@N{index @num{-1}} also represents the last element -(that is, the element at @N{the top}) -and index @M{-n} represents the first element. - -} - -@sect3{stacksize| @title{Stack Size} - -When you interact with the Lua API, -you are responsible for ensuring consistency. -In particular, -@emph{you are responsible for controlling stack overflow}. -When you call any API function, -you must ensure the stack has enough room to accommodate the results. - -There is one exception to the above rule: -When you call a Lua function -without a fixed number of results @seeF{lua_call}, -Lua ensures that the stack has enough space for all results. -However, it does not ensure any extra space. -So, before pushing anything on the stack after such a call -you should use @Lid{lua_checkstack}. - -Whenever Lua calls C, -it ensures that the stack has space for -at least @defid{LUA_MINSTACK} extra elements; -that is, you can safely push up to @id{LUA_MINSTACK} values into it. -@id{LUA_MINSTACK} is defined as 20, -so that usually you do not have to worry about stack space -unless your code has loops pushing elements onto the stack. -Whenever necessary, -you can use the function @Lid{lua_checkstack} -to ensure that the stack has enough space for pushing new elements. - -} - -@sect3{@title{Valid and Acceptable Indices} - -Any function in the API that receives stack indices -works only with @emphx{valid indices} or @emphx{acceptable indices}. - -A @def{valid index} is an index that refers to a -position that stores a modifiable Lua value. -It comprises stack indices @N{between 1} and the stack top -(@T{1 @leq abs(index) @leq top}) -@index{stack index} -plus @def{pseudo-indices}, -which represent some positions that are accessible to @N{C code} -but that are not in the stack. -Pseudo-indices are used to access the registry @see{registry} -and the upvalues of a @N{C function} @see{c-closure}. - -Functions that do not need a specific mutable position, -but only a value (e.g., query functions), -can be called with acceptable indices. -An @def{acceptable index} can be any valid index, -but it also can be any positive index after the stack top -within the space allocated for the stack, -that is, indices up to the stack size. -(Note that 0 is never an acceptable index.) -Indices to upvalues @see{c-closure} greater than the real number -of upvalues in the current @N{C function} are also acceptable (but invalid). -Except when noted otherwise, -functions in the API work with acceptable indices. - -Acceptable indices serve to avoid extra tests -against the stack top when querying the stack. -For instance, a @N{C function} can query its third argument -without the need to check whether there is a third argument, -that is, without the need to check whether 3 is a valid index. - -For functions that can be called with acceptable indices, -any non-valid index is treated as if it -contains a value of a virtual type @defid{LUA_TNONE}, -which behaves like a nil value. - -} - -@sect3{constchar|@title{Pointers to strings} - -Several functions in the API return pointers (@T{const char*}) -to Lua strings in the stack. -(See @Lid{lua_pushfstring}, @Lid{lua_pushlstring}, -@Lid{lua_pushstring}, and @Lid{lua_tolstring}. -See also @Lid{luaL_checklstring}, @Lid{luaL_checkstring}, -and @Lid{luaL_tolstring} in the auxiliary library.) - -In general, -Lua's garbage collection can free or move internal memory -and then invalidate pointers to internal strings. -To allow a safe use of these pointers, -the API guarantees that any pointer to a string in a stack index -is valid while the string value at that index is not removed from the stack. -(It can be moved to another index, though.) -When the index is a pseudo-index (referring to an upvalue), -the pointer is valid while the corresponding call is active and -the corresponding upvalue is not modified. - -Some functions in the debug interface -also return pointers to strings, -namely @Lid{lua_getlocal}, @Lid{lua_getupvalue}, -@Lid{lua_setlocal}, and @Lid{lua_setupvalue}. -For these functions, the pointer is guaranteed to -be valid while the caller function is active and -the given closure (if one was given) is in the stack. - -Except for these guarantees, -the garbage collector is free to invalidate -any pointer to internal strings. - -} - -} - -@sect2{c-closure| @title{C Closures} - -When a @N{C function} is created, -it is possible to associate some values with it, -thus creating a @def{@N{C closure}} -@seeC{lua_pushcclosure}; -these values are called @def{upvalues} and are -accessible to the function whenever it is called. - -Whenever a @N{C function} is called, -its upvalues are located at specific pseudo-indices. -These pseudo-indices are produced by the macro -@Lid{lua_upvalueindex}. -The first upvalue associated with a function is at index -@T{lua_upvalueindex(1)}, and so on. -Any access to @T{lua_upvalueindex(@rep{n})}, -where @rep{n} is greater than the number of upvalues of the -current function -(but not greater than 256, -which is one plus the maximum number of upvalues in a closure), -produces an acceptable but invalid index. - -A @N{C closure} can also change the values -of its corresponding upvalues. - -} - -@sect2{registry| @title{Registry} - -Lua provides a @def{registry}, -a predefined table that can be used by any @N{C code} to -store whatever Lua values it needs to store. -The registry table is always accessible at pseudo-index -@defid{LUA_REGISTRYINDEX}. -Any @N{C library} can store data into this table, -but it must take care to choose keys -that are different from those used -by other libraries, to avoid collisions. -Typically, you should use as key a string containing your library name, -or a light userdata with the address of a @N{C object} in your code, -or any Lua object created by your code. -As with variable names, -string keys starting with an underscore followed by -uppercase letters are reserved for Lua. - -The integer keys in the registry are used -by the reference mechanism @seeC{luaL_ref} -and by some predefined values. -Therefore, integer keys in the registry -must not be used for other purposes. - -When you create a new Lua state, -its registry comes with some predefined values. -These predefined values are indexed with integer keys -defined as constants in @id{lua.h}. -The following constants are defined: -@description{ -@item{@defid{LUA_RIDX_MAINTHREAD}| At this index the registry has -the main thread of the state. -(The main thread is the one created together with the state.) -} - -@item{@defid{LUA_RIDX_GLOBALS}| At this index the registry has -the @x{global environment}. -} -} - -} - -@sect2{C-error|@title{Error Handling in C} - -@simplesect{ - -Internally, Lua uses the C @id{longjmp} facility to handle errors. -(Lua will use exceptions if you compile it as C++; -search for @id{LUAI_THROW} in the source code for details.) -When Lua faces any error, -such as a @x{memory allocation error} or a type error, -it @emph{raises} an error; -that is, it does a long jump. -A @emphx{protected environment} uses @id{setjmp} -to set a recovery point; -any error jumps to the most recent active recovery point. - -Inside a @N{C function} you can raise an error explicitly -by calling @Lid{lua_error}. - -Most functions in the API can raise an error, -for instance due to a @x{memory allocation error}. -The documentation for each function indicates whether -it can raise errors. - -If an error happens outside any protected environment, -Lua calls a @def{panic function} (see @Lid{lua_atpanic}) -and then calls @T{abort}, -thus exiting the host application. -Your panic function can avoid this exit by -never returning -(e.g., doing a long jump to your own recovery point outside Lua). - -The panic function, -as its name implies, -is a mechanism of last resort. -Programs should avoid it. -As a general rule, -when a @N{C function} is called by Lua with a Lua state, -it can do whatever it wants on that Lua state, -as it should be already protected. -However, -when C code operates on other Lua states -(e.g., a Lua-state argument to the function, -a Lua state stored in the registry, or -the result of @Lid{lua_newthread}), -it should use them only in API calls that cannot raise errors. - -The panic function runs as if it were a @x{message handler} @see{error}; -in particular, the error object is on the top of the stack. -However, there is no guarantee about stack space. -To push anything on the stack, -the panic function must first check the available space @see{stacksize}. - -} - - -@sect3{statuscodes|@title{Status Codes} - -Several functions that report errors in the API use the following -status codes to indicate different kinds of errors or other conditions: -@description{ - -@item{@defid{LUA_OK} (0)| no errors.} - -@item{@defid{LUA_ERRRUN}| a runtime error.} - -@item{@defid{LUA_ERRMEM}| -@x{memory allocation error}. -For such errors, Lua does not call the @x{message handler}. -} - -@item{@defid{LUA_ERRERR}| error while running the @x{message handler}.} - -@item{@defid{LUA_ERRSYNTAX}| syntax error during precompilation.} - -@item{@defid{LUA_YIELD}| the thread (coroutine) yields.} - -@item{@defid{LUA_ERRFILE}| a file-related error; -e.g., it cannot open or read the file.} - -} -These constants are defined in the header file @id{lua.h}. - -} - -} - -@sect2{continuations|@title{Handling Yields in C} - -Internally, Lua uses the C @id{longjmp} facility to yield a coroutine. -Therefore, if a @N{C function} @id{foo} calls an API function -and this API function yields -(directly or indirectly by calling another function that yields), -Lua cannot return to @id{foo} any more, -because the @id{longjmp} removes its frame from the @N{C stack}. - -To avoid this kind of problem, -Lua raises an error whenever it tries to yield across an API call, -except for three functions: -@Lid{lua_yieldk}, @Lid{lua_callk}, and @Lid{lua_pcallk}. -All those functions receive a @def{continuation function} -(as a parameter named @id{k}) to continue execution after a yield. - -We need to set some terminology to explain continuations. -We have a @N{C function} called from Lua which we will call -the @emph{original function}. -This original function then calls one of those three functions in the C API, -which we will call the @emph{callee function}, -that then yields the current thread. -This can happen when the callee function is @Lid{lua_yieldk}, -or when the callee function is either @Lid{lua_callk} or @Lid{lua_pcallk} -and the function called by them yields. - -Suppose the running thread yields while executing the callee function. -After the thread resumes, -it eventually will finish running the callee function. -However, -the callee function cannot return to the original function, -because its frame in the @N{C stack} was destroyed by the yield. -Instead, Lua calls a @def{continuation function}, -which was given as an argument to the callee function. -As the name implies, -the continuation function should continue the task -of the original function. - -As an illustration, consider the following function: -@verbatim{ -int original_function (lua_State *L) { - ... /* code 1 */ - status = lua_pcall(L, n, m, h); /* calls Lua */ - ... /* code 2 */ -} -} -Now we want to allow -the Lua code being run by @Lid{lua_pcall} to yield. -First, we can rewrite our function like here: -@verbatim{ -int k (lua_State *L, int status, lua_KContext ctx) { - ... /* code 2 */ -} - -int original_function (lua_State *L) { - ... /* code 1 */ - return k(L, lua_pcall(L, n, m, h), ctx); -} -} -In the above code, -the new function @id{k} is a -@emph{continuation function} (with type @Lid{lua_KFunction}), -which should do all the work that the original function -was doing after calling @Lid{lua_pcall}. -Now, we must inform Lua that it must call @id{k} if the Lua code -being executed by @Lid{lua_pcall} gets interrupted in some way -(errors or yielding), -so we rewrite the code as here, -replacing @Lid{lua_pcall} by @Lid{lua_pcallk}: -@verbatim{ -int original_function (lua_State *L) { - ... /* code 1 */ - return k(L, lua_pcallk(L, n, m, h, ctx2, k), ctx1); -} -} -Note the external, explicit call to the continuation: -Lua will call the continuation only if needed, that is, -in case of errors or resuming after a yield. -If the called function returns normally without ever yielding, -@Lid{lua_pcallk} (and @Lid{lua_callk}) will also return normally. -(Of course, instead of calling the continuation in that case, -you can do the equivalent work directly inside the original function.) - -Besides the Lua state, -the continuation function has two other parameters: -the final status of the call and the context value (@id{ctx}) that -was passed originally to @Lid{lua_pcallk}. -Lua does not use this context value; -it only passes this value from the original function to the -continuation function. -For @Lid{lua_pcallk}, -the status is the same value that would be returned by @Lid{lua_pcallk}, -except that it is @Lid{LUA_YIELD} when being executed after a yield -(instead of @Lid{LUA_OK}). -For @Lid{lua_yieldk} and @Lid{lua_callk}, -the status is always @Lid{LUA_YIELD} when Lua calls the continuation. -(For these two functions, -Lua will not call the continuation in case of errors, -because they do not handle errors.) -Similarly, when using @Lid{lua_callk}, -you should call the continuation function -with @Lid{LUA_OK} as the status. -(For @Lid{lua_yieldk}, there is not much point in calling -directly the continuation function, -because @Lid{lua_yieldk} usually does not return.) - -Lua treats the continuation function as if it were the original function. -The continuation function receives the same Lua stack -from the original function, -in the same state it would be if the callee function had returned. -(For instance, -after a @Lid{lua_callk} the function and its arguments are -removed from the stack and replaced by the results from the call.) -It also has the same upvalues. -Whatever it returns is handled by Lua as if it were the return -of the original function. - -} - -@sect2{@title{Functions and Types} - -Here we list all functions and types from the @N{C API} in -alphabetical order. -Each function has an indicator like this: -@apii{o,p,x} - -The first field, @T{o}, -is how many elements the function pops from the stack. -The second field, @T{p}, -is how many elements the function pushes onto the stack. -(Any function always pushes its results after popping its arguments.) -A field in the form @T{x|y} means the function can push (or pop) -@T{x} or @T{y} elements, -depending on the situation; -an interrogation mark @Char{?} means that -we cannot know how many elements the function pops/pushes -by looking only at its arguments. -(For instance, they may depend on what is in the stack.) -The third field, @T{x}, -tells whether the function may raise errors: -@Char{-} means the function never raises any error; -@Char{m} means the function may raise only out-of-memory errors; -@Char{v} means the function may raise the errors explained in the text; -@Char{e} means the function can run arbitrary Lua code, -either directly or through metamethods, -and therefore may raise any errors. - - -@APIEntry{int lua_absindex (lua_State *L, int idx);| -@apii{0,0,-} - -Converts the @x{acceptable index} @id{idx} -into an equivalent @x{absolute index} -(that is, one that does not depend on the stack size). - -} - - -@APIEntry{ -typedef void * (*lua_Alloc) (void *ud, - void *ptr, - size_t osize, - size_t nsize);| - -The type of the @x{memory-allocation function} used by Lua states. -The allocator function must provide a -functionality similar to @id{realloc}, -but not exactly the same. -Its arguments are -@id{ud}, an opaque pointer passed to @Lid{lua_newstate}; -@id{ptr}, a pointer to the block being allocated/reallocated/freed; -@id{osize}, the original size of the block or some code about what -is being allocated; -and @id{nsize}, the new size of the block. - -When @id{ptr} is not @id{NULL}, -@id{osize} is the size of the block pointed by @id{ptr}, -that is, the size given when it was allocated or reallocated. - -When @id{ptr} is @id{NULL}, -@id{osize} encodes the kind of object that Lua is allocating. -@id{osize} is any of -@Lid{LUA_TSTRING}, @Lid{LUA_TTABLE}, @Lid{LUA_TFUNCTION}, -@Lid{LUA_TUSERDATA}, or @Lid{LUA_TTHREAD} when (and only when) -Lua is creating a new object of that type. -When @id{osize} is some other value, -Lua is allocating memory for something else. - -Lua assumes the following behavior from the allocator function: - -When @id{nsize} is zero, -the allocator must behave like @id{free} -and then return @id{NULL}. - -When @id{nsize} is not zero, -the allocator must behave like @id{realloc}. -In particular, the allocator returns @id{NULL} -if and only if it cannot fulfill the request. - -Here is a simple implementation for the @x{allocator function}. -It is used in the auxiliary library by @Lid{luaL_newstate}. -@verbatim{ -static void *l_alloc (void *ud, void *ptr, size_t osize, - size_t nsize) { - (void)ud; (void)osize; /* not used */ - if (nsize == 0) { - free(ptr); - return NULL; - } - else - return realloc(ptr, nsize); -} -} -Note that @N{ISO C} ensures -that @T{free(NULL)} has no effect and that -@T{realloc(NULL,size)} is equivalent to @T{malloc(size)}. - -} - -@APIEntry{void lua_arith (lua_State *L, int op);| -@apii{2|1,1,e} - -Performs an arithmetic or bitwise operation over the two values -(or one, in the case of negations) -at the top of the stack, -with the value on the top being the second operand, -pops these values, and pushes the result of the operation. -The function follows the semantics of the corresponding Lua operator -(that is, it may call metamethods). - -The value of @id{op} must be one of the following constants: -@description{ - -@item{@defid{LUA_OPADD}| performs addition (@T{+})} -@item{@defid{LUA_OPSUB}| performs subtraction (@T{-})} -@item{@defid{LUA_OPMUL}| performs multiplication (@T{*})} -@item{@defid{LUA_OPDIV}| performs float division (@T{/})} -@item{@defid{LUA_OPIDIV}| performs floor division (@T{//})} -@item{@defid{LUA_OPMOD}| performs modulo (@T{%})} -@item{@defid{LUA_OPPOW}| performs exponentiation (@T{^})} -@item{@defid{LUA_OPUNM}| performs mathematical negation (unary @T{-})} -@item{@defid{LUA_OPBNOT}| performs bitwise NOT (@T{~})} -@item{@defid{LUA_OPBAND}| performs bitwise AND (@T{&})} -@item{@defid{LUA_OPBOR}| performs bitwise OR (@T{|})} -@item{@defid{LUA_OPBXOR}| performs bitwise exclusive OR (@T{~})} -@item{@defid{LUA_OPSHL}| performs left shift (@T{<<})} -@item{@defid{LUA_OPSHR}| performs right shift (@T{>>})} - -} - -} - -@APIEntry{lua_CFunction lua_atpanic (lua_State *L, lua_CFunction panicf);| -@apii{0,0,-} - -Sets a new panic function and returns the old one @see{C-error}. - -} - -@APIEntry{void lua_call (lua_State *L, int nargs, int nresults);| -@apii{nargs+1,nresults,e} - -Calls a function. -Like regular Lua calls, -@id{lua_call} respects the @idx{__call} metamethod. -So, here the word @Q{function} -means any callable value. - -To do a call you must use the following protocol: -first, the function to be called is pushed onto the stack; -then, the arguments to the call are pushed -in direct order; -that is, the first argument is pushed first. -Finally you call @Lid{lua_call}; -@id{nargs} is the number of arguments that you pushed onto the stack. -When the function returns, -all arguments and the function value are popped -and the call results are pushed onto the stack. -The number of results is adjusted to @id{nresults}, -unless @id{nresults} is @defid{LUA_MULTRET}. -In this case, all results from the function are pushed; -Lua takes care that the returned values fit into the stack space, -but it does not ensure any extra space in the stack. -The function results are pushed onto the stack in direct order -(the first result is pushed first), -so that after the call the last result is on the top of the stack. - -Any error while calling and running the function is propagated upwards -(with a @id{longjmp}). - -The following example shows how the host program can do the -equivalent to this Lua code: -@verbatim{ -a = f("how", t.x, 14) -} -Here it is @N{in C}: -@verbatim{ -lua_getglobal(L, "f"); /* function to be called */ -lua_pushliteral(L, "how"); /* 1st argument */ -lua_getglobal(L, "t"); /* table to be indexed */ -lua_getfield(L, -1, "x"); /* push result of t.x (2nd arg) */ -lua_remove(L, -2); /* remove 't' from the stack */ -lua_pushinteger(L, 14); /* 3rd argument */ -lua_call(L, 3, 1); /* call 'f' with 3 arguments and 1 result */ -lua_setglobal(L, "a"); /* set global 'a' */ -} -Note that the code above is @emph{balanced}: -at its end, the stack is back to its original configuration. -This is considered good programming practice. - -} - -@APIEntry{ -void lua_callk (lua_State *L, - int nargs, - int nresults, - lua_KContext ctx, - lua_KFunction k);| -@apii{nargs + 1,nresults,e} - -This function behaves exactly like @Lid{lua_call}, -but allows the called function to yield @see{continuations}. - -} - -@APIEntry{typedef int (*lua_CFunction) (lua_State *L);| - -Type for @N{C functions}. - -In order to communicate properly with Lua, -a @N{C function} must use the following protocol, -which defines the way parameters and results are passed: -a @N{C function} receives its arguments from Lua in its stack -in direct order (the first argument is pushed first). -So, when the function starts, -@T{lua_gettop(L)} returns the number of arguments received by the function. -The first argument (if any) is at index 1 -and its last argument is at index @T{lua_gettop(L)}. -To return values to Lua, a @N{C function} just pushes them onto the stack, -in direct order (the first result is pushed first), -and returns in C the number of results. -Any other value in the stack below the results will be properly -discarded by Lua. -Like a Lua function, a @N{C function} called by Lua can also return -many results. - -As an example, the following function receives a variable number -of numeric arguments and returns their average and their sum: -@verbatim{ -static int foo (lua_State *L) { - int n = lua_gettop(L); /* number of arguments */ - lua_Number sum = 0.0; - int i; - for (i = 1; i <= n; i++) { - if (!lua_isnumber(L, i)) { - lua_pushliteral(L, "incorrect argument"); - lua_error(L); - } - sum += lua_tonumber(L, i); - } - lua_pushnumber(L, sum/n); /* first result */ - lua_pushnumber(L, sum); /* second result */ - return 2; /* number of results */ -} -} - - - -} - - -@APIEntry{int lua_checkstack (lua_State *L, int n);| -@apii{0,0,-} - -Ensures that the stack has space for at least @id{n} extra elements, -that is, that you can safely push up to @id{n} values into it. -It returns false if it cannot fulfill the request, -either because it would cause the stack -to be greater than a fixed maximum size -(typically at least several thousand elements) or -because it cannot allocate memory for the extra space. -This function never shrinks the stack; -if the stack already has space for the extra elements, -it is left unchanged. - -} - -@APIEntry{void lua_close (lua_State *L);| -@apii{0,0,-} - -Close all active to-be-closed variables in the main thread, -release all objects in the given Lua state -(calling the corresponding garbage-collection metamethods, if any), -and frees all dynamic memory used by this state. - -On several platforms, you may not need to call this function, -because all resources are naturally released when the host program ends. -On the other hand, long-running programs that create multiple states, -such as daemons or web servers, -will probably need to close states as soon as they are not needed. - -} - -@APIEntry{void lua_closeslot (lua_State *L, int index);| -@apii{0,0,e} - -Close the to-be-closed slot at the given index and set its value to @nil. -The index must be the last index previously marked to be closed -@see{lua_toclose} that is still active (that is, not closed yet). - -A @idx{__close} metamethod cannot yield -when called through this function. - -(This function was introduced in @N{release 5.4.3}.) - -} - -@APIEntry{int lua_closethread (lua_State *L, lua_State *from);| -@apii{0,?,-} - -Resets a thread, cleaning its call stack and closing all pending -to-be-closed variables. -Returns a status code: -@Lid{LUA_OK} for no errors in the thread -(either the original error that stopped the thread or -errors in closing methods), -or an error status otherwise. -In case of error, -leaves the error object on the top of the stack. - -The parameter @id{from} represents the coroutine that is resetting @id{L}. -If there is no such coroutine, -this parameter can be @id{NULL}. - -(This function was introduced in @N{release 5.4.6}.) - -} - -@APIEntry{int lua_compare (lua_State *L, int index1, int index2, int op);| -@apii{0,0,e} - -Compares two Lua values. -Returns 1 if the value at index @id{index1} satisfies @id{op} -when compared with the value at index @id{index2}, -following the semantics of the corresponding Lua operator -(that is, it may call metamethods). -Otherwise @N{returns 0}. -Also @N{returns 0} if any of the indices is not valid. - -The value of @id{op} must be one of the following constants: -@description{ - -@item{@defid{LUA_OPEQ}| compares for equality (@T{==})} -@item{@defid{LUA_OPLT}| compares for less than (@T{<})} -@item{@defid{LUA_OPLE}| compares for less or equal (@T{<=})} - -} - -} - -@APIEntry{void lua_concat (lua_State *L, int n);| -@apii{n,1,e} - -Concatenates the @id{n} values at the top of the stack, -pops them, and leaves the result on the top. -If @N{@T{n} is 1}, the result is the single value on the stack -(that is, the function does nothing); -if @id{n} is 0, the result is the empty string. -Concatenation is performed following the usual semantics of Lua -@see{concat}. - -} - -@APIEntry{void lua_copy (lua_State *L, int fromidx, int toidx);| -@apii{0,0,-} - -Copies the element at index @id{fromidx} -into the valid index @id{toidx}, -replacing the value at that position. -Values at other positions are not affected. - -} - -@APIEntry{void lua_createtable (lua_State *L, int narr, int nrec);| -@apii{0,1,m} - -Creates a new empty table and pushes it onto the stack. -Parameter @id{narr} is a hint for how many elements the table -will have as a sequence; -parameter @id{nrec} is a hint for how many other elements -the table will have. -Lua may use these hints to preallocate memory for the new table. -This preallocation may help performance when you know in advance -how many elements the table will have. -Otherwise you can use the function @Lid{lua_newtable}. - -} - -@APIEntry{int lua_dump (lua_State *L, - lua_Writer writer, - void *data, - int strip);| -@apii{0,0,-} - -Dumps a function as a binary chunk. -Receives a Lua function on the top of the stack -and produces a binary chunk that, -if loaded again, -results in a function equivalent to the one dumped. -As it produces parts of the chunk, -@Lid{lua_dump} calls function @id{writer} @seeC{lua_Writer} -with the given @id{data} -to write them. - -If @id{strip} is true, -the binary representation may not include all debug information -about the function, -to save space. - -The value returned is the error code returned by the last -call to the writer; -@N{0 means} no errors. - -This function does not pop the Lua function from the stack. - -} - -@APIEntry{int lua_error (lua_State *L);| -@apii{1,0,v} - -Raises a Lua error, -using the value on the top of the stack as the error object. -This function does a long jump, -and therefore never returns -@seeC{luaL_error}. - -} - -@APIEntry{int lua_gc (lua_State *L, int what, ...);| -@apii{0,0,-} - -Controls the garbage collector. - -This function performs several tasks, -according to the value of the parameter @id{what}. -For options that need extra arguments, -they are listed after the option. -@description{ - -@item{@id{LUA_GCCOLLECT}| -Performs a full garbage-collection cycle. -} - -@item{@id{LUA_GCSTOP}| -Stops the garbage collector. -} - -@item{@id{LUA_GCRESTART}| -Restarts the garbage collector. -} - -@item{@id{LUA_GCCOUNT}| -Returns the current amount of memory (in Kbytes) in use by Lua. -} - -@item{@id{LUA_GCCOUNTB}| -Returns the remainder of dividing the current amount of bytes of -memory in use by Lua by 1024. -} - -@item{@id{LUA_GCSTEP} @T{(int stepsize)}| -Performs an incremental step of garbage collection, -corresponding to the allocation of @id{stepsize} Kbytes. -} - -@item{@id{LUA_GCISRUNNING}| -Returns a boolean that tells whether the collector is running -(i.e., not stopped). -} - -@item{@id{LUA_GCINC} (int pause, int stepmul, stepsize)| -Changes the collector to incremental mode -with the given parameters @see{incmode}. -Returns the previous mode (@id{LUA_GCGEN} or @id{LUA_GCINC}). -} - -@item{@id{LUA_GCGEN} (int minormul, int majormul)| -Changes the collector to generational mode -with the given parameters @see{genmode}. -Returns the previous mode (@id{LUA_GCGEN} or @id{LUA_GCINC}). -} - -} -For more details about these options, -see @Lid{collectgarbage}. - -This function should not be called by a finalizer. - -} - -@APIEntry{lua_Alloc lua_getallocf (lua_State *L, void **ud);| -@apii{0,0,-} - -Returns the @x{memory-allocation function} of a given state. -If @id{ud} is not @id{NULL}, Lua stores in @T{*ud} the -opaque pointer given when the memory-allocator function was set. - -} - -@APIEntry{int lua_getfield (lua_State *L, int index, const char *k);| -@apii{0,1,e} - -Pushes onto the stack the value @T{t[k]}, -where @id{t} is the value at the given index. -As in Lua, this function may trigger a metamethod -for the @Q{index} event @see{metatable}. - -Returns the type of the pushed value. - -} - -@APIEntry{void *lua_getextraspace (lua_State *L);| -@apii{0,0,-} - -Returns a pointer to a raw memory area associated with the -given Lua state. -The application can use this area for any purpose; -Lua does not use it for anything. - -Each new thread has this area initialized with a copy -of the area of the @x{main thread}. - -By default, this area has the size of a pointer to void, -but you can recompile Lua with a different size for this area. -(See @id{LUA_EXTRASPACE} in @id{luaconf.h}.) - -} - -@APIEntry{int lua_getglobal (lua_State *L, const char *name);| -@apii{0,1,e} - -Pushes onto the stack the value of the global @id{name}. -Returns the type of that value. - -} - -@APIEntry{int lua_geti (lua_State *L, int index, lua_Integer i);| -@apii{0,1,e} - -Pushes onto the stack the value @T{t[i]}, -where @id{t} is the value at the given index. -As in Lua, this function may trigger a metamethod -for the @Q{index} event @see{metatable}. - -Returns the type of the pushed value. - -} - -@APIEntry{int lua_getmetatable (lua_State *L, int index);| -@apii{0,0|1,-} - -If the value at the given index has a metatable, -the function pushes that metatable onto the stack and @N{returns 1}. -Otherwise, -the function @N{returns 0} and pushes nothing on the stack. - -} - -@APIEntry{int lua_gettable (lua_State *L, int index);| -@apii{1,1,e} - -Pushes onto the stack the value @T{t[k]}, -where @id{t} is the value at the given index -and @id{k} is the value on the top of the stack. - -This function pops the key from the stack, -pushing the resulting value in its place. -As in Lua, this function may trigger a metamethod -for the @Q{index} event @see{metatable}. - -Returns the type of the pushed value. - -} - -@APIEntry{int lua_gettop (lua_State *L);| -@apii{0,0,-} - -Returns the index of the top element in the stack. -Because indices start @N{at 1}, -this result is equal to the number of elements in the stack; -in particular, @N{0 means} an empty stack. - -} - -@APIEntry{int lua_getiuservalue (lua_State *L, int index, int n);| -@apii{0,1,-} - -Pushes onto the stack the @id{n}-th user value associated with the -full userdata at the given index and -returns the type of the pushed value. - -If the userdata does not have that value, -pushes @nil and returns @Lid{LUA_TNONE}. - -} - -@APIEntry{void lua_insert (lua_State *L, int index);| -@apii{1,1,-} - -Moves the top element into the given valid index, -shifting up the elements above this index to open space. -This function cannot be called with a pseudo-index, -because a pseudo-index is not an actual stack position. - -} - -@APIEntry{typedef @ldots lua_Integer;| - -The type of integers in Lua. - -By default this type is @id{long long}, -(usually a 64-bit two-complement integer), -but that can be changed to @id{long} or @id{int} -(usually a 32-bit two-complement integer). -(See @id{LUA_INT_TYPE} in @id{luaconf.h}.) - -Lua also defines the constants -@defid{LUA_MININTEGER} and @defid{LUA_MAXINTEGER}, -with the minimum and the maximum values that fit in this type. - -} - -@APIEntry{int lua_isboolean (lua_State *L, int index);| -@apii{0,0,-} - -Returns 1 if the value at the given index is a boolean, -and @N{0 otherwise}. - -} - -@APIEntry{int lua_iscfunction (lua_State *L, int index);| -@apii{0,0,-} - -Returns 1 if the value at the given index is a @N{C function}, -and @N{0 otherwise}. - -} - -@APIEntry{int lua_isfunction (lua_State *L, int index);| -@apii{0,0,-} - -Returns 1 if the value at the given index is a function -(either C or Lua), and @N{0 otherwise}. - -} - -@APIEntry{int lua_isinteger (lua_State *L, int index);| -@apii{0,0,-} - -Returns 1 if the value at the given index is an integer -(that is, the value is a number and is represented as an integer), -and @N{0 otherwise}. - -} - -@APIEntry{int lua_islightuserdata (lua_State *L, int index);| -@apii{0,0,-} - -Returns 1 if the value at the given index is a light userdata, -and @N{0 otherwise}. - -} - -@APIEntry{int lua_isnil (lua_State *L, int index);| -@apii{0,0,-} - -Returns 1 if the value at the given index is @nil, -and @N{0 otherwise}. - -} - -@APIEntry{int lua_isnone (lua_State *L, int index);| -@apii{0,0,-} - -Returns 1 if the given index is not valid, -and @N{0 otherwise}. - -} - -@APIEntry{int lua_isnoneornil (lua_State *L, int index);| -@apii{0,0,-} - -Returns 1 if the given index is not valid -or if the value at this index is @nil, -and @N{0 otherwise}. - -} - -@APIEntry{int lua_isnumber (lua_State *L, int index);| -@apii{0,0,-} - -Returns 1 if the value at the given index is a number -or a string convertible to a number, -and @N{0 otherwise}. - -} - -@APIEntry{int lua_isstring (lua_State *L, int index);| -@apii{0,0,-} - -Returns 1 if the value at the given index is a string -or a number (which is always convertible to a string), -and @N{0 otherwise}. - -} - -@APIEntry{int lua_istable (lua_State *L, int index);| -@apii{0,0,-} - -Returns 1 if the value at the given index is a table, -and @N{0 otherwise}. - -} - -@APIEntry{int lua_isthread (lua_State *L, int index);| -@apii{0,0,-} - -Returns 1 if the value at the given index is a thread, -and @N{0 otherwise}. - -} - -@APIEntry{int lua_isuserdata (lua_State *L, int index);| -@apii{0,0,-} - -Returns 1 if the value at the given index is a userdata -(either full or light), and @N{0 otherwise}. - -} - -@APIEntry{int lua_isyieldable (lua_State *L);| -@apii{0,0,-} - -Returns 1 if the given coroutine can yield, -and @N{0 otherwise}. - -} - -@APIEntry{typedef @ldots lua_KContext;| - -The type for continuation-function contexts. -It must be a numeric type. -This type is defined as @id{intptr_t} -when @id{intptr_t} is available, -so that it can store pointers too. -Otherwise, it is defined as @id{ptrdiff_t}. - -} - -@APIEntry{ -typedef int (*lua_KFunction) (lua_State *L, int status, lua_KContext ctx);| - -Type for continuation functions @see{continuations}. - -} - -@APIEntry{void lua_len (lua_State *L, int index);| -@apii{0,1,e} - -Returns the length of the value at the given index. -It is equivalent to the @Char{#} operator in Lua @see{len-op} and -may trigger a metamethod for the @Q{length} event @see{metatable}. -The result is pushed on the stack. - -} - -@APIEntry{ -int lua_load (lua_State *L, - lua_Reader reader, - void *data, - const char *chunkname, - const char *mode);| -@apii{0,1,-} - -Loads a Lua chunk without running it. -If there are no errors, -@id{lua_load} pushes the compiled chunk as a Lua -function on top of the stack. -Otherwise, it pushes an error message. - -The @id{lua_load} function uses a user-supplied @id{reader} function -to read the chunk @seeC{lua_Reader}. -The @id{data} argument is an opaque value passed to the reader function. - -The @id{chunkname} argument gives a name to the chunk, -which is used for error messages and in debug information @see{debugI}. - -@id{lua_load} automatically detects whether the chunk is text or binary -and loads it accordingly (see program @idx{luac}). -The string @id{mode} works as in function @Lid{load}, -with the addition that -a @id{NULL} value is equivalent to the string @St{bt}. - -@id{lua_load} uses the stack internally, -so the reader function must always leave the stack -unmodified when returning. - -@id{lua_load} can return -@Lid{LUA_OK}, @Lid{LUA_ERRSYNTAX}, or @Lid{LUA_ERRMEM}. -The function may also return other values corresponding to -errors raised by the read function @see{statuscodes}. - -If the resulting function has upvalues, -its first upvalue is set to the value of the @x{global environment} -stored at index @id{LUA_RIDX_GLOBALS} in the registry @see{registry}. -When loading main chunks, -this upvalue will be the @id{_ENV} variable @see{globalenv}. -Other upvalues are initialized with @nil. - -} - -@APIEntry{lua_State *lua_newstate (lua_Alloc f, void *ud);| -@apii{0,0,-} - -Creates a new independent state and returns its main thread. -Returns @id{NULL} if it cannot create the state -(due to lack of memory). -The argument @id{f} is the @x{allocator function}; -Lua will do all memory allocation for this state -through this function @seeF{lua_Alloc}. -The second argument, @id{ud}, is an opaque pointer that Lua -passes to the allocator in every call. - -} - -@APIEntry{void lua_newtable (lua_State *L);| -@apii{0,1,m} - -Creates a new empty table and pushes it onto the stack. -It is equivalent to @T{lua_createtable(L, 0, 0)}. - -} - -@APIEntry{lua_State *lua_newthread (lua_State *L);| -@apii{0,1,m} - -Creates a new thread, pushes it on the stack, -and returns a pointer to a @Lid{lua_State} that represents this new thread. -The new thread returned by this function shares with the original thread -its global environment, -but has an independent execution stack. - -Threads are subject to garbage collection, -like any Lua object. - -} - -@APIEntry{void *lua_newuserdatauv (lua_State *L, size_t size, int nuvalue);| -@apii{0,1,m} - -This function creates and pushes on the stack a new full userdata, -with @id{nuvalue} associated Lua values, called @id{user values}, -plus an associated block of raw memory with @id{size} bytes. -(The user values can be set and read with the functions -@Lid{lua_setiuservalue} and @Lid{lua_getiuservalue}.) - -The function returns the address of the block of memory. -Lua ensures that this address is valid as long as -the corresponding userdata is alive @see{GC}. -Moreover, if the userdata is marked for finalization @see{finalizers}, -its address is valid at least until the call to its finalizer. - -} - -@APIEntry{int lua_next (lua_State *L, int index);| -@apii{1,2|0,v} - -Pops a key from the stack, -and pushes a key@En{}value pair from the table at the given index, -the @Q{next} pair after the given key. -If there are no more elements in the table, -then @Lid{lua_next} @N{returns 0} and pushes nothing. - -A typical table traversal looks like this: -@verbatim{ -/* table is in the stack at index 't' */ -lua_pushnil(L); /* first key */ -while (lua_next(L, t) != 0) { - /* uses 'key' (at index -2) and 'value' (at index -1) */ - printf("%s - %s\n", - lua_typename(L, lua_type(L, -2)), - lua_typename(L, lua_type(L, -1))); - /* removes 'value'; keeps 'key' for next iteration */ - lua_pop(L, 1); -} -} - -While traversing a table, -avoid calling @Lid{lua_tolstring} directly on a key, -unless you know that the key is actually a string. -Recall that @Lid{lua_tolstring} may change -the value at the given index; -this confuses the next call to @Lid{lua_next}. - -This function may raise an error if the given key -is neither @nil nor present in the table. -See function @Lid{next} for the caveats of modifying -the table during its traversal. - -} - -@APIEntry{typedef @ldots lua_Number;| - -The type of floats in Lua. - -By default this type is double, -but that can be changed to a single float or a long double. -(See @id{LUA_FLOAT_TYPE} in @id{luaconf.h}.) - -} - -@APIEntry{int lua_numbertointeger (lua_Number n, lua_Integer *p);| - -Tries to convert a Lua float to a Lua integer; -the float @id{n} must have an integral value. -If that value is within the range of Lua integers, -it is converted to an integer and assigned to @T{*p}. -The macro results in a boolean indicating whether the -conversion was successful. -(Note that this range test can be tricky to do -correctly without this macro, due to rounding.) - -This macro may evaluate its arguments more than once. - -} - -@APIEntry{int lua_pcall (lua_State *L, int nargs, int nresults, int msgh);| -@apii{nargs + 1,nresults|1,-} - -Calls a function (or a callable object) in protected mode. - -Both @id{nargs} and @id{nresults} have the same meaning as -in @Lid{lua_call}. -If there are no errors during the call, -@Lid{lua_pcall} behaves exactly like @Lid{lua_call}. -However, if there is any error, -@Lid{lua_pcall} catches it, -pushes a single value on the stack (the error object), -and returns an error code. -Like @Lid{lua_call}, -@Lid{lua_pcall} always removes the function -and its arguments from the stack. - -If @id{msgh} is 0, -then the error object returned on the stack -is exactly the original error object. -Otherwise, @id{msgh} is the stack index of a -@emph{message handler}. -(This index cannot be a pseudo-index.) -In case of runtime errors, -this handler will be called with the error object -and its return value will be the object -returned on the stack by @Lid{lua_pcall}. - -Typically, the message handler is used to add more debug -information to the error object, such as a stack traceback. -Such information cannot be gathered after the return of @Lid{lua_pcall}, -since by then the stack has unwound. - -The @Lid{lua_pcall} function returns one of the following status codes: -@Lid{LUA_OK}, @Lid{LUA_ERRRUN}, @Lid{LUA_ERRMEM}, or @Lid{LUA_ERRERR}. - -} - -@APIEntry{ -int lua_pcallk (lua_State *L, - int nargs, - int nresults, - int msgh, - lua_KContext ctx, - lua_KFunction k);| -@apii{nargs + 1,nresults|1,-} - -This function behaves exactly like @Lid{lua_pcall}, -except that it allows the called function to yield @see{continuations}. - -} - -@APIEntry{void lua_pop (lua_State *L, int n);| -@apii{n,0,e} - -Pops @id{n} elements from the stack. -It is implemented as a macro over @Lid{lua_settop}. - -} - -@APIEntry{void lua_pushboolean (lua_State *L, int b);| -@apii{0,1,-} - -Pushes a boolean value with value @id{b} onto the stack. - -} - -@APIEntry{void lua_pushcclosure (lua_State *L, lua_CFunction fn, int n);| -@apii{n,1,m} - -Pushes a new @N{C closure} onto the stack. -This function receives a pointer to a @N{C function} -and pushes onto the stack a Lua value of type @id{function} that, -when called, invokes the corresponding @N{C function}. -The parameter @id{n} tells how many upvalues this function will have -@see{c-closure}. - -Any function to be callable by Lua must -follow the correct protocol to receive its parameters -and return its results @seeC{lua_CFunction}. - -When a @N{C function} is created, -it is possible to associate some values with it, -the so called upvalues; -these upvalues are then accessible to the function whenever it is called. -This association is called a @x{@N{C closure}} @see{c-closure}. -To create a @N{C closure}, -first the initial values for its upvalues must be pushed onto the stack. -(When there are multiple upvalues, the first value is pushed first.) -Then @Lid{lua_pushcclosure} -is called to create and push the @N{C function} onto the stack, -with the argument @id{n} telling how many values will be -associated with the function. -@Lid{lua_pushcclosure} also pops these values from the stack. - -The maximum value for @id{n} is 255. - -When @id{n} is zero, -this function creates a @def{light @N{C function}}, -which is just a pointer to the @N{C function}. -In that case, it never raises a memory error. - -} - -@APIEntry{void lua_pushcfunction (lua_State *L, lua_CFunction f);| -@apii{0,1,-} - -Pushes a @N{C function} onto the stack. -This function is equivalent to @Lid{lua_pushcclosure} with no upvalues. - -} - -@APIEntry{const char *lua_pushfstring (lua_State *L, const char *fmt, ...);| -@apii{0,1,v} - -Pushes onto the stack a formatted string -and returns a pointer to this string @see{constchar}. -It is similar to the @ANSI{sprintf}, -but has two important differences. -First, -you do not have to allocate space for the result; -the result is a Lua string and Lua takes care of memory allocation -(and deallocation, through garbage collection). -Second, -the conversion specifiers are quite restricted. -There are no flags, widths, or precisions. -The conversion specifiers can only be -@Char{%%} (inserts the character @Char{%}), -@Char{%s} (inserts a zero-terminated string, with no size restrictions), -@Char{%f} (inserts a @Lid{lua_Number}), -@Char{%I} (inserts a @Lid{lua_Integer}), -@Char{%p} (inserts a pointer), -@Char{%d} (inserts an @T{int}), -@Char{%c} (inserts an @T{int} as a one-byte character), and -@Char{%U} (inserts a @T{long int} as a @x{UTF-8} byte sequence). - -This function may raise errors due to memory overflow -or an invalid conversion specifier. - -} - -@APIEntry{void lua_pushglobaltable (lua_State *L);| -@apii{0,1,-} - -Pushes the @x{global environment} onto the stack. - -} - -@APIEntry{void lua_pushinteger (lua_State *L, lua_Integer n);| -@apii{0,1,-} - -Pushes an integer with value @id{n} onto the stack. - -} - -@APIEntry{void lua_pushlightuserdata (lua_State *L, void *p);| -@apii{0,1,-} - -Pushes a light userdata onto the stack. - -Userdata represent @N{C values} in Lua. -A @def{light userdata} represents a pointer, a @T{void*}. -It is a value (like a number): -you do not create it, it has no individual metatable, -and it is not collected (as it was never created). -A light userdata is equal to @Q{any} -light userdata with the same @N{C address}. - -} - -@APIEntry{const char *lua_pushliteral (lua_State *L, const char *s);| -@apii{0,1,m} - -This macro is equivalent to @Lid{lua_pushstring}, -but should be used only when @id{s} is a literal string. -(Lua may optimize this case.) - -} - -@APIEntry{const char *lua_pushlstring (lua_State *L, const char *s, size_t len);| -@apii{0,1,m} - -Pushes the string pointed to by @id{s} with size @id{len} -onto the stack. -Lua will make or reuse an internal copy of the given string, -so the memory at @id{s} can be freed or reused immediately after -the function returns. -The string can contain any binary data, -including @x{embedded zeros}. - -Returns a pointer to the internal copy of the string @see{constchar}. - -} - -@APIEntry{void lua_pushnil (lua_State *L);| -@apii{0,1,-} - -Pushes a nil value onto the stack. - -} - -@APIEntry{void lua_pushnumber (lua_State *L, lua_Number n);| -@apii{0,1,-} - -Pushes a float with value @id{n} onto the stack. - -} - -@APIEntry{const char *lua_pushstring (lua_State *L, const char *s);| -@apii{0,1,m} - -Pushes the zero-terminated string pointed to by @id{s} -onto the stack. -Lua will make or reuse an internal copy of the given string, -so the memory at @id{s} can be freed or reused immediately after -the function returns. - -Returns a pointer to the internal copy of the string @see{constchar}. - -If @id{s} is @id{NULL}, pushes @nil and returns @id{NULL}. - -} - -@APIEntry{int lua_pushthread (lua_State *L);| -@apii{0,1,-} - -Pushes the thread represented by @id{L} onto the stack. -Returns 1 if this thread is the @x{main thread} of its state. - -} - -@APIEntry{void lua_pushvalue (lua_State *L, int index);| -@apii{0,1,-} - -Pushes a copy of the element at the given index -onto the stack. - -} - -@APIEntry{ -const char *lua_pushvfstring (lua_State *L, - const char *fmt, - va_list argp);| -@apii{0,1,v} - -Equivalent to @Lid{lua_pushfstring}, except that it receives a @id{va_list} -instead of a variable number of arguments. - -} - -@APIEntry{int lua_rawequal (lua_State *L, int index1, int index2);| -@apii{0,0,-} - -Returns 1 if the two values in indices @id{index1} and -@id{index2} are primitively equal -(that is, equal without calling the @idx{__eq} metamethod). -Otherwise @N{returns 0}. -Also @N{returns 0} if any of the indices are not valid. - -} - -@APIEntry{int lua_rawget (lua_State *L, int index);| -@apii{1,1,-} - -Similar to @Lid{lua_gettable}, but does a raw access -(i.e., without metamethods). -The value at @id{index} must be a table. - -} - -@APIEntry{int lua_rawgeti (lua_State *L, int index, lua_Integer n);| -@apii{0,1,-} - -Pushes onto the stack the value @T{t[n]}, -where @id{t} is the table at the given index. -The access is raw, -that is, it does not use the @idx{__index} metavalue. - -Returns the type of the pushed value. - -} - -@APIEntry{int lua_rawgetp (lua_State *L, int index, const void *p);| -@apii{0,1,-} - -Pushes onto the stack the value @T{t[k]}, -where @id{t} is the table at the given index and -@id{k} is the pointer @id{p} represented as a light userdata. -The access is raw; -that is, it does not use the @idx{__index} metavalue. - -Returns the type of the pushed value. - -} - -@APIEntry{lua_Unsigned lua_rawlen (lua_State *L, int index);| -@apii{0,0,-} - -Returns the raw @Q{length} of the value at the given index: -for strings, this is the string length; -for tables, this is the result of the length operator (@Char{#}) -with no metamethods; -for userdata, this is the size of the block of memory allocated -for the userdata. -For other values, this call @N{returns 0}. - -} - -@APIEntry{void lua_rawset (lua_State *L, int index);| -@apii{2,0,m} - -Similar to @Lid{lua_settable}, but does a raw assignment -(i.e., without metamethods). -The value at @id{index} must be a table. - -} - -@APIEntry{void lua_rawseti (lua_State *L, int index, lua_Integer i);| -@apii{1,0,m} - -Does the equivalent of @T{t[i] = v}, -where @id{t} is the table at the given index -and @id{v} is the value on the top of the stack. - -This function pops the value from the stack. -The assignment is raw, -that is, it does not use the @idx{__newindex} metavalue. - -} - -@APIEntry{void lua_rawsetp (lua_State *L, int index, const void *p);| -@apii{1,0,m} - -Does the equivalent of @T{t[p] = v}, -where @id{t} is the table at the given index, -@id{p} is encoded as a light userdata, -and @id{v} is the value on the top of the stack. - -This function pops the value from the stack. -The assignment is raw, -that is, it does not use the @idx{__newindex} metavalue. - -} - -@APIEntry{ -typedef const char * (*lua_Reader) (lua_State *L, - void *data, - size_t *size);| - -The reader function used by @Lid{lua_load}. -Every time @Lid{lua_load} needs another piece of the chunk, -it calls the reader, -passing along its @id{data} parameter. -The reader must return a pointer to a block of memory -with a new piece of the chunk -and set @id{size} to the block size. -The block must exist until the reader function is called again. -To signal the end of the chunk, -the reader must return @id{NULL} or set @id{size} to zero. -The reader function may return pieces of any size greater than zero. - -} - -@APIEntry{void lua_register (lua_State *L, const char *name, lua_CFunction f);| -@apii{0,0,e} - -Sets the @N{C function} @id{f} as the new value of global @id{name}. -It is defined as a macro: -@verbatim{ -#define lua_register(L,n,f) \ - (lua_pushcfunction(L, f), lua_setglobal(L, n)) -} - -} - -@APIEntry{void lua_remove (lua_State *L, int index);| -@apii{1,0,-} - -Removes the element at the given valid index, -shifting down the elements above this index to fill the gap. -This function cannot be called with a pseudo-index, -because a pseudo-index is not an actual stack position. - -} - -@APIEntry{void lua_replace (lua_State *L, int index);| -@apii{1,0,-} - -Moves the top element into the given valid index -without shifting any element -(therefore replacing the value at that given index), -and then pops the top element. - -} - -@APIEntry{int lua_resetthread (lua_State *L);| -@apii{0,?,-} - -This function is deprecated; -it is equivalent to @Lid{lua_closethread} with -@id{from} being @id{NULL}. - -} - -@APIEntry{int lua_resume (lua_State *L, lua_State *from, int nargs, - int *nresults);| -@apii{?,?,-} - -Starts and resumes a coroutine in the given thread @id{L}. - -To start a coroutine, -you push the main function plus any arguments -onto the empty stack of the thread. -then you call @Lid{lua_resume}, -with @id{nargs} being the number of arguments. -This call returns when the coroutine suspends or finishes its execution. -When it returns, -@id{*nresults} is updated and -the top of the stack contains -the @id{*nresults} values passed to @Lid{lua_yield} -or returned by the body function. -@Lid{lua_resume} returns -@Lid{LUA_YIELD} if the coroutine yields, -@Lid{LUA_OK} if the coroutine finishes its execution -without errors, -or an error code in case of errors @see{statuscodes}. -In case of errors, -the error object is on the top of the stack. - -To resume a coroutine, -you remove the @id{*nresults} yielded values from its stack, -push the values to be passed as results from @id{yield}, -and then call @Lid{lua_resume}. - -The parameter @id{from} represents the coroutine that is resuming @id{L}. -If there is no such coroutine, -this parameter can be @id{NULL}. - -} - -@APIEntry{void lua_rotate (lua_State *L, int idx, int n);| -@apii{0,0,-} - -Rotates the stack elements between the valid index @id{idx} -and the top of the stack. -The elements are rotated @id{n} positions in the direction of the top, -for a positive @id{n}, -or @T{-n} positions in the direction of the bottom, -for a negative @id{n}. -The absolute value of @id{n} must not be greater than the size -of the slice being rotated. -This function cannot be called with a pseudo-index, -because a pseudo-index is not an actual stack position. - -} - -@APIEntry{void lua_setallocf (lua_State *L, lua_Alloc f, void *ud);| -@apii{0,0,-} - -Changes the @x{allocator function} of a given state to @id{f} -with user data @id{ud}. - -} - -@APIEntry{void lua_setfield (lua_State *L, int index, const char *k);| -@apii{1,0,e} - -Does the equivalent to @T{t[k] = v}, -where @id{t} is the value at the given index -and @id{v} is the value on the top of the stack. - -This function pops the value from the stack. -As in Lua, this function may trigger a metamethod -for the @Q{newindex} event @see{metatable}. - -} - -@APIEntry{void lua_setglobal (lua_State *L, const char *name);| -@apii{1,0,e} - -Pops a value from the stack and -sets it as the new value of global @id{name}. - -} - -@APIEntry{void lua_seti (lua_State *L, int index, lua_Integer n);| -@apii{1,0,e} - -Does the equivalent to @T{t[n] = v}, -where @id{t} is the value at the given index -and @id{v} is the value on the top of the stack. - -This function pops the value from the stack. -As in Lua, this function may trigger a metamethod -for the @Q{newindex} event @see{metatable}. - -} - -@APIEntry{int lua_setiuservalue (lua_State *L, int index, int n);| -@apii{1,0,-} - -Pops a value from the stack and sets it as -the new @id{n}-th user value associated to the -full userdata at the given index. -Returns 0 if the userdata does not have that value. - -} - -@APIEntry{int lua_setmetatable (lua_State *L, int index);| -@apii{1,0,-} - -Pops a table or @nil from the stack and -sets that value as the new metatable for the value at the given index. -(@nil means no metatable.) - -(For historical reasons, this function returns an @id{int}, -which now is always 1.) - -} - -@APIEntry{void lua_settable (lua_State *L, int index);| -@apii{2,0,e} - -Does the equivalent to @T{t[k] = v}, -where @id{t} is the value at the given index, -@id{v} is the value on the top of the stack, -and @id{k} is the value just below the top. - -This function pops both the key and the value from the stack. -As in Lua, this function may trigger a metamethod -for the @Q{newindex} event @see{metatable}. - -} - -@APIEntry{void lua_settop (lua_State *L, int index);| -@apii{?,?,e} - -Accepts any index, @N{or 0}, -and sets the stack top to this index. -If the new top is greater than the old one, -then the new elements are filled with @nil. -If @id{index} @N{is 0}, then all stack elements are removed. - -This function can run arbitrary code when removing an index -marked as to-be-closed from the stack. - -} - -@APIEntry{void lua_setwarnf (lua_State *L, lua_WarnFunction f, void *ud);| -@apii{0,0,-} - -Sets the @x{warning function} to be used by Lua to emit warnings -@see{lua_WarnFunction}. -The @id{ud} parameter sets the value @id{ud} passed to -the warning function. - -} - -@APIEntry{typedef struct lua_State lua_State;| - -An opaque structure that points to a thread and indirectly -(through the thread) to the whole state of a Lua interpreter. -The Lua library is fully reentrant: -it has no global variables. -All information about a state is accessible through this structure. - -A pointer to this structure must be passed as the first argument to -every function in the library, except to @Lid{lua_newstate}, -which creates a Lua state from scratch. - -} - -@APIEntry{int lua_status (lua_State *L);| -@apii{0,0,-} - -Returns the status of the thread @id{L}. - -The status can be @Lid{LUA_OK} for a normal thread, -an error code if the thread finished the execution -of a @Lid{lua_resume} with an error, -or @Lid{LUA_YIELD} if the thread is suspended. - -You can call functions only in threads with status @Lid{LUA_OK}. -You can resume threads with status @Lid{LUA_OK} -(to start a new coroutine) or @Lid{LUA_YIELD} -(to resume a coroutine). - -} - -@APIEntry{size_t lua_stringtonumber (lua_State *L, const char *s);| -@apii{0,1,-} - -Converts the zero-terminated string @id{s} to a number, -pushes that number into the stack, -and returns the total size of the string, -that is, its length plus one. -The conversion can result in an integer or a float, -according to the lexical conventions of Lua @see{lexical}. -The string may have leading and trailing whitespaces and a sign. -If the string is not a valid numeral, -returns 0 and pushes nothing. -(Note that the result can be used as a boolean, -true if the conversion succeeds.) - -} - -@APIEntry{int lua_toboolean (lua_State *L, int index);| -@apii{0,0,-} - -Converts the Lua value at the given index to a @N{C boolean} -value (@N{0 or 1}). -Like all tests in Lua, -@Lid{lua_toboolean} returns true for any Lua value -different from @false and @nil; -otherwise it returns false. -(If you want to accept only actual boolean values, -use @Lid{lua_isboolean} to test the value's type.) - -} - -@APIEntry{lua_CFunction lua_tocfunction (lua_State *L, int index);| -@apii{0,0,-} - -Converts a value at the given index to a @N{C function}. -That value must be a @N{C function}; -otherwise, returns @id{NULL}. - -} - -@APIEntry{void lua_toclose (lua_State *L, int index);| -@apii{0,0,m} - -Marks the given index in the stack as a -to-be-closed slot @see{to-be-closed}. -Like a to-be-closed variable in Lua, -the value at that slot in the stack will be closed -when it goes out of scope. -Here, in the context of a C function, -to go out of scope means that the running function returns to Lua, -or there is an error, -or the slot is removed from the stack through -@Lid{lua_settop} or @Lid{lua_pop}, -or there is a call to @Lid{lua_closeslot}. -A slot marked as to-be-closed should not be removed from the stack -by any other function in the API except @Lid{lua_settop} or @Lid{lua_pop}, -unless previously deactivated by @Lid{lua_closeslot}. - -This function should not be called for an index -that is equal to or below an active to-be-closed slot. - -Note that, both in case of errors and of a regular return, -by the time the @idx{__close} metamethod runs, -the @N{C stack} was already unwound, -so that any automatic @N{C variable} declared in the calling function -(e.g., a buffer) will be out of scope. - -} - -@APIEntry{lua_Integer lua_tointeger (lua_State *L, int index);| -@apii{0,0,-} - -Equivalent to @Lid{lua_tointegerx} with @id{isnum} equal to @id{NULL}. - -} - -@APIEntry{lua_Integer lua_tointegerx (lua_State *L, int index, int *isnum);| -@apii{0,0,-} - -Converts the Lua value at the given index -to the signed integral type @Lid{lua_Integer}. -The Lua value must be an integer, -or a number or string convertible to an integer @see{coercion}; -otherwise, @id{lua_tointegerx} @N{returns 0}. - -If @id{isnum} is not @id{NULL}, -its referent is assigned a boolean value that -indicates whether the operation succeeded. - -} - -@APIEntry{const char *lua_tolstring (lua_State *L, int index, size_t *len);| -@apii{0,0,m} - -Converts the Lua value at the given index to a @N{C string}. -If @id{len} is not @id{NULL}, -it sets @T{*len} with the string length. -The Lua value must be a string or a number; -otherwise, the function returns @id{NULL}. -If the value is a number, -then @id{lua_tolstring} also -@emph{changes the actual value in the stack to a string}. -(This change confuses @Lid{lua_next} -when @id{lua_tolstring} is applied to keys during a table traversal.) - -@id{lua_tolstring} returns a pointer -to a string inside the Lua state @see{constchar}. -This string always has a zero (@Char{\0}) -after its last character (as @N{in C}), -but can contain other zeros in its body. - -} - -@APIEntry{lua_Number lua_tonumber (lua_State *L, int index);| -@apii{0,0,-} - -Equivalent to @Lid{lua_tonumberx} with @id{isnum} equal to @id{NULL}. - -} - -@APIEntry{lua_Number lua_tonumberx (lua_State *L, int index, int *isnum);| -@apii{0,0,-} - -Converts the Lua value at the given index -to the @N{C type} @Lid{lua_Number} @seeC{lua_Number}. -The Lua value must be a number or a string convertible to a number -@see{coercion}; -otherwise, @Lid{lua_tonumberx} @N{returns 0}. - -If @id{isnum} is not @id{NULL}, -its referent is assigned a boolean value that -indicates whether the operation succeeded. - -} - -@APIEntry{const void *lua_topointer (lua_State *L, int index);| -@apii{0,0,-} - -Converts the value at the given index to a generic -@N{C pointer} (@T{void*}). -The value can be a userdata, a table, a thread, a string, or a function; -otherwise, @id{lua_topointer} returns @id{NULL}. -Different objects will give different pointers. -There is no way to convert the pointer back to its original value. - -Typically this function is used only for hashing and debug information. - -} - -@APIEntry{const char *lua_tostring (lua_State *L, int index);| -@apii{0,0,m} - -Equivalent to @Lid{lua_tolstring} with @id{len} equal to @id{NULL}. - -} - -@APIEntry{lua_State *lua_tothread (lua_State *L, int index);| -@apii{0,0,-} - -Converts the value at the given index to a Lua thread -(represented as @T{lua_State*}). -This value must be a thread; -otherwise, the function returns @id{NULL}. - -} - -@APIEntry{void *lua_touserdata (lua_State *L, int index);| -@apii{0,0,-} - -If the value at the given index is a full userdata, -returns its memory-block address. -If the value is a light userdata, -returns its value (a pointer). -Otherwise, returns @id{NULL}. - -} - -@APIEntry{int lua_type (lua_State *L, int index);| -@apii{0,0,-} - -Returns the type of the value in the given valid index, -or @id{LUA_TNONE} for a non-valid but acceptable index. -The types returned by @Lid{lua_type} are coded by the following constants -defined in @id{lua.h}: -@defid{LUA_TNIL}, -@defid{LUA_TNUMBER}, -@defid{LUA_TBOOLEAN}, -@defid{LUA_TSTRING}, -@defid{LUA_TTABLE}, -@defid{LUA_TFUNCTION}, -@defid{LUA_TUSERDATA}, -@defid{LUA_TTHREAD}, -and -@defid{LUA_TLIGHTUSERDATA}. - -} - -@APIEntry{const char *lua_typename (lua_State *L, int tp);| -@apii{0,0,-} - -Returns the name of the type encoded by the value @id{tp}, -which must be one the values returned by @Lid{lua_type}. - -} - -@APIEntry{typedef @ldots lua_Unsigned;| - -The unsigned version of @Lid{lua_Integer}. - -} - -@APIEntry{int lua_upvalueindex (int i);| -@apii{0,0,-} - -Returns the pseudo-index that represents the @id{i}-th upvalue of -the running function @see{c-closure}. -@id{i} must be in the range @M{[1,256]}. - -} - -@APIEntry{lua_Number lua_version (lua_State *L);| -@apii{0,0,-} - -Returns the version number of this core. - -} - -@APIEntry{ -typedef void (*lua_WarnFunction) (void *ud, const char *msg, int tocont);| - -The type of @x{warning function}s, called by Lua to emit warnings. -The first parameter is an opaque pointer -set by @Lid{lua_setwarnf}. -The second parameter is the warning message. -The third parameter is a boolean that -indicates whether the message is -to be continued by the message in the next call. - -See @Lid{warn} for more details about warnings. - -} - -@APIEntry{ -void lua_warning (lua_State *L, const char *msg, int tocont);| -@apii{0,0,-} - -Emits a warning with the given message. -A message in a call with @id{tocont} true should be -continued in another call to this function. - -See @Lid{warn} for more details about warnings. - -} - -@APIEntry{ -typedef int (*lua_Writer) (lua_State *L, - const void* p, - size_t sz, - void* ud);| - -The type of the writer function used by @Lid{lua_dump}. -Every time @Lid{lua_dump} produces another piece of chunk, -it calls the writer, -passing along the buffer to be written (@id{p}), -its size (@id{sz}), -and the @id{ud} parameter supplied to @Lid{lua_dump}. - -The writer returns an error code: -@N{0 means} no errors; -any other value means an error and stops @Lid{lua_dump} from -calling the writer again. - -} - -@APIEntry{void lua_xmove (lua_State *from, lua_State *to, int n);| -@apii{?,?,-} - -Exchange values between different threads of the same state. - -This function pops @id{n} values from the stack @id{from}, -and pushes them onto the stack @id{to}. - -} - -@APIEntry{int lua_yield (lua_State *L, int nresults);| -@apii{?,?,v} - -This function is equivalent to @Lid{lua_yieldk}, -but it has no continuation @see{continuations}. -Therefore, when the thread resumes, -it continues the function that called -the function calling @id{lua_yield}. -To avoid surprises, -this function should be called only in a tail call. - -} - - -@APIEntry{ -int lua_yieldk (lua_State *L, - int nresults, - lua_KContext ctx, - lua_KFunction k);| -@apii{?,?,v} - -Yields a coroutine (thread). - -When a @N{C function} calls @Lid{lua_yieldk}, -the running coroutine suspends its execution, -and the call to @Lid{lua_resume} that started this coroutine returns. -The parameter @id{nresults} is the number of values from the stack -that will be passed as results to @Lid{lua_resume}. - -When the coroutine is resumed again, -Lua calls the given @x{continuation function} @id{k} to continue -the execution of the @N{C function} that yielded @see{continuations}. -This continuation function receives the same stack -from the previous function, -with the @id{n} results removed and -replaced by the arguments passed to @Lid{lua_resume}. -Moreover, -the continuation function receives the value @id{ctx} -that was passed to @Lid{lua_yieldk}. - -Usually, this function does not return; -when the coroutine eventually resumes, -it continues executing the continuation function. -However, there is one special case, -which is when this function is called -from inside a line or a count hook @see{debugI}. -In that case, @id{lua_yieldk} should be called with no continuation -(probably in the form of @Lid{lua_yield}) and no results, -and the hook should return immediately after the call. -Lua will yield and, -when the coroutine resumes again, -it will continue the normal execution -of the (Lua) function that triggered the hook. - -This function can raise an error if it is called from a thread -with a pending C call with no continuation function -(what is called a @emphx{C-call boundary}), -or it is called from a thread that is not running inside a resume -(typically the main thread). - -} - -} - -@sect2{debugI| @title{The Debug Interface} - -Lua has no built-in debugging facilities. -Instead, it offers a special interface -by means of functions and @emph{hooks}. -This interface allows the construction of different -kinds of debuggers, profilers, and other tools -that need @Q{inside information} from the interpreter. - - -@APIEntry{ -typedef struct lua_Debug { - int event; - const char *name; /* (n) */ - const char *namewhat; /* (n) */ - const char *what; /* (S) */ - const char *source; /* (S) */ - size_t srclen; /* (S) */ - int currentline; /* (l) */ - int linedefined; /* (S) */ - int lastlinedefined; /* (S) */ - unsigned char nups; /* (u) number of upvalues */ - unsigned char nparams; /* (u) number of parameters */ - char isvararg; /* (u) */ - char istailcall; /* (t) */ - unsigned short ftransfer; /* (r) index of first value transferred */ - unsigned short ntransfer; /* (r) number of transferred values */ - char short_src[LUA_IDSIZE]; /* (S) */ - /* private part */ - @rep{other fields} -} lua_Debug; -| - -A structure used to carry different pieces of -information about a function or an activation record. -@Lid{lua_getstack} fills only the private part -of this structure, for later use. -To fill the other fields of @Lid{lua_Debug} with useful information, -you must call @Lid{lua_getinfo} with an appropriate parameter. -(Specifically, to get a field, -you must add the letter between parentheses in the field's comment -to the parameter @id{what} of @Lid{lua_getinfo}.) - -The fields of @Lid{lua_Debug} have the following meaning: -@description{ - -@item{@id{source}| -the source of the chunk that created the function. -If @T{source} starts with a @Char{@At}, -it means that the function was defined in a file where -the file name follows the @Char{@At}. -If @T{source} starts with a @Char{=}, -the remainder of its contents describes the source in a user-dependent manner. -Otherwise, -the function was defined in a string where -@T{source} is that string. -} - -@item{@id{srclen}| -The length of the string @id{source}. -} - -@item{@id{short_src}| -a @Q{printable} version of @T{source}, to be used in error messages. -} - -@item{@id{linedefined}| -the line number where the definition of the function starts. -} - -@item{@id{lastlinedefined}| -the line number where the definition of the function ends. -} - -@item{@id{what}| -the string @T{"Lua"} if the function is a Lua function, -@T{"C"} if it is a @N{C function}, -@T{"main"} if it is the main part of a chunk. -} - -@item{@id{currentline}| -the current line where the given function is executing. -When no line information is available, -@T{currentline} is set to @num{-1}. -} - -@item{@id{name}| -a reasonable name for the given function. -Because functions in Lua are first-class values, -they do not have a fixed name: -some functions can be the value of multiple global variables, -while others can be stored only in a table field. -The @T{lua_getinfo} function checks how the function was -called to find a suitable name. -If it cannot find a name, -then @id{name} is set to @id{NULL}. -} - -@item{@id{namewhat}| -explains the @T{name} field. -The value of @T{namewhat} can be -@T{"global"}, @T{"local"}, @T{"method"}, -@T{"field"}, @T{"upvalue"}, or @T{""} (the empty string), -according to how the function was called. -(Lua uses the empty string when no other option seems to apply.) -} - -@item{@id{istailcall}| -true if this function invocation was called by a tail call. -In this case, the caller of this level is not in the stack. -} - -@item{@id{nups}| -the number of upvalues of the function. -} - -@item{@id{nparams}| -the number of parameters of the function -(always @N{0 for} @N{C functions}). -} - -@item{@id{isvararg}| -true if the function is a variadic function -(always true for @N{C functions}). -} - -@item{@id{ftransfer}| -the index in the stack of the first value being @Q{transferred}, -that is, parameters in a call or return values in a return. -(The other values are in consecutive indices.) -Using this index, you can access and modify these values -through @Lid{lua_getlocal} and @Lid{lua_setlocal}. -This field is only meaningful during a -call hook, denoting the first parameter, -or a return hook, denoting the first value being returned. -(For call hooks, this value is always 1.) -} - -@item{@id{ntransfer}| -The number of values being transferred (see previous item). -(For calls of Lua functions, -this value is always equal to @id{nparams}.) -} - -} - -} - -@APIEntry{lua_Hook lua_gethook (lua_State *L);| -@apii{0,0,-} - -Returns the current hook function. - -} - -@APIEntry{int lua_gethookcount (lua_State *L);| -@apii{0,0,-} - -Returns the current hook count. - -} - -@APIEntry{int lua_gethookmask (lua_State *L);| -@apii{0,0,-} - -Returns the current hook mask. - -} - -@APIEntry{int lua_getinfo (lua_State *L, const char *what, lua_Debug *ar);| -@apii{0|1,0|1|2,m} - -Gets information about a specific function or function invocation. - -To get information about a function invocation, -the parameter @id{ar} must be a valid activation record that was -filled by a previous call to @Lid{lua_getstack} or -given as argument to a hook @seeC{lua_Hook}. - -To get information about a function, you push it onto the stack -and start the @id{what} string with the character @Char{>}. -(In that case, -@id{lua_getinfo} pops the function from the top of the stack.) -For instance, to know in which line a function @id{f} was defined, -you can write the following code: -@verbatim{ -lua_Debug ar; -lua_getglobal(L, "f"); /* get global 'f' */ -lua_getinfo(L, ">S", &ar); -printf("%d\n", ar.linedefined); -} - -Each character in the string @id{what} -selects some fields of the structure @id{ar} to be filled or -a value to be pushed on the stack. -(These characters are also documented in the declaration of -the structure @Lid{lua_Debug}, -between parentheses in the comments following each field.) -@description{ - -@item{@Char{f}| -pushes onto the stack the function that is -running at the given level; -} - -@item{@Char{l}| fills in the field @id{currentline}; -} - -@item{@Char{n}| fills in the fields @id{name} and @id{namewhat}; -} - -@item{@Char{r}| fills in the fields @id{ftransfer} and @id{ntransfer}; -} - -@item{@Char{S}| -fills in the fields @id{source}, @id{short_src}, -@id{linedefined}, @id{lastlinedefined}, and @id{what}; -} - -@item{@Char{t}| fills in the field @id{istailcall}; -} - -@item{@Char{u}| fills in the fields -@id{nups}, @id{nparams}, and @id{isvararg}; -} - -@item{@Char{L}| -pushes onto the stack a table whose indices are -the lines on the function with some associated code, -that is, the lines where you can put a break point. -(Lines with no code include empty lines and comments.) -If this option is given together with option @Char{f}, -its table is pushed after the function. -This is the only option that can raise a memory error. -} - -} - -This function returns 0 to signal an invalid option in @id{what}; -even then the valid options are handled correctly. - -} - -@APIEntry{const char *lua_getlocal (lua_State *L, const lua_Debug *ar, int n);| -@apii{0,0|1,-} - -Gets information about a local variable or a temporary value -of a given activation record or a given function. - -In the first case, -the parameter @id{ar} must be a valid activation record that was -filled by a previous call to @Lid{lua_getstack} or -given as argument to a hook @seeC{lua_Hook}. -The index @id{n} selects which local variable to inspect; -see @Lid{debug.getlocal} for details about variable indices -and names. - -@Lid{lua_getlocal} pushes the variable's value onto the stack -and returns its name. - -In the second case, @id{ar} must be @id{NULL} and the function -to be inspected must be on the top of the stack. -In this case, only parameters of Lua functions are visible -(as there is no information about what variables are active) -and no values are pushed onto the stack. - -Returns @id{NULL} (and pushes nothing) -when the index is greater than -the number of active local variables. - -} - -@APIEntry{int lua_getstack (lua_State *L, int level, lua_Debug *ar);| -@apii{0,0,-} - -Gets information about the interpreter runtime stack. - -This function fills parts of a @Lid{lua_Debug} structure with -an identification of the @emph{activation record} -of the function executing at a given level. -@N{Level 0} is the current running function, -whereas level @M{n+1} is the function that has called level @M{n} -(except for tail calls, which do not count in the stack). -When called with a level greater than the stack depth, -@Lid{lua_getstack} returns 0; -otherwise it returns 1. - -} - -@APIEntry{const char *lua_getupvalue (lua_State *L, int funcindex, int n);| -@apii{0,0|1,-} - -Gets information about the @id{n}-th upvalue -of the closure at index @id{funcindex}. -It pushes the upvalue's value onto the stack -and returns its name. -Returns @id{NULL} (and pushes nothing) -when the index @id{n} is greater than the number of upvalues. - -See @Lid{debug.getupvalue} for more information about upvalues. - -} - -@APIEntry{typedef void (*lua_Hook) (lua_State *L, lua_Debug *ar);| - -Type for debugging hook functions. - -Whenever a hook is called, its @id{ar} argument has its field -@id{event} set to the specific event that triggered the hook. -Lua identifies these events with the following constants: -@defid{LUA_HOOKCALL}, @defid{LUA_HOOKRET}, -@defid{LUA_HOOKTAILCALL}, @defid{LUA_HOOKLINE}, -and @defid{LUA_HOOKCOUNT}. -Moreover, for line events, the field @id{currentline} is also set. -To get the value of any other field in @id{ar}, -the hook must call @Lid{lua_getinfo}. - -For call events, @id{event} can be @id{LUA_HOOKCALL}, -the normal value, or @id{LUA_HOOKTAILCALL}, for a tail call; -in this case, there will be no corresponding return event. - -While Lua is running a hook, it disables other calls to hooks. -Therefore, if a hook calls back Lua to execute a function or a chunk, -this execution occurs without any calls to hooks. - -Hook functions cannot have continuations, -that is, they cannot call @Lid{lua_yieldk}, -@Lid{lua_pcallk}, or @Lid{lua_callk} with a non-null @id{k}. - -Hook functions can yield under the following conditions: -Only count and line events can yield; -to yield, a hook function must finish its execution -calling @Lid{lua_yield} with @id{nresults} equal to zero -(that is, with no values). - -} - -@APIEntry{void lua_sethook (lua_State *L, lua_Hook f, int mask, int count);| -@apii{0,0,-} - -Sets the debugging hook function. - -Argument @id{f} is the hook function. -@id{mask} specifies on which events the hook will be called: -it is formed by a bitwise OR of the constants -@defid{LUA_MASKCALL}, -@defid{LUA_MASKRET}, -@defid{LUA_MASKLINE}, -and @defid{LUA_MASKCOUNT}. -The @id{count} argument is only meaningful when the mask -includes @id{LUA_MASKCOUNT}. -For each event, the hook is called as explained below: -@description{ - -@item{The call hook| is called when the interpreter calls a function. -The hook is called just after Lua enters the new function. -} - -@item{The return hook| is called when the interpreter returns from a function. -The hook is called just before Lua leaves the function. -} - -@item{The line hook| is called when the interpreter is about to -start the execution of a new line of code, -or when it jumps back in the code (even to the same line). -This event only happens while Lua is executing a Lua function. -} - -@item{The count hook| is called after the interpreter executes every -@T{count} instructions. -This event only happens while Lua is executing a Lua function. -} - -} - -Hooks are disabled by setting @id{mask} to zero. - -} - -@APIEntry{const char *lua_setlocal (lua_State *L, const lua_Debug *ar, int n);| -@apii{0|1,0,-} - -Sets the value of a local variable of a given activation record. -It assigns the value on the top of the stack -to the variable and returns its name. -It also pops the value from the stack. - -Returns @id{NULL} (and pops nothing) -when the index is greater than -the number of active local variables. - -Parameters @id{ar} and @id{n} are as in the function @Lid{lua_getlocal}. - -} - -@APIEntry{const char *lua_setupvalue (lua_State *L, int funcindex, int n);| -@apii{0|1,0,-} - -Sets the value of a closure's upvalue. -It assigns the value on the top of the stack -to the upvalue and returns its name. -It also pops the value from the stack. - -Returns @id{NULL} (and pops nothing) -when the index @id{n} is greater than the number of upvalues. - -Parameters @id{funcindex} and @id{n} are as in -the function @Lid{lua_getupvalue}. - -} - -@APIEntry{void *lua_upvalueid (lua_State *L, int funcindex, int n);| -@apii{0,0,-} - -Returns a unique identifier for the upvalue numbered @id{n} -from the closure at index @id{funcindex}. - -These unique identifiers allow a program to check whether different -closures share upvalues. -Lua closures that share an upvalue -(that is, that access a same external local variable) -will return identical ids for those upvalue indices. - -Parameters @id{funcindex} and @id{n} are as in -the function @Lid{lua_getupvalue}, -but @id{n} cannot be greater than the number of upvalues. - -} - -@APIEntry{ -void lua_upvaluejoin (lua_State *L, int funcindex1, int n1, - int funcindex2, int n2);| -@apii{0,0,-} - -Make the @id{n1}-th upvalue of the Lua closure at index @id{funcindex1} -refer to the @id{n2}-th upvalue of the Lua closure at index @id{funcindex2}. - -} - -} - -} - - -@C{-------------------------------------------------------------------------} -@sect1{auxlib|@title{The Auxiliary Library} - -@simplesect{ - -@index{lauxlib.h} -The @def{auxiliary library} provides several convenient functions -to interface C with Lua. -While the basic API provides the primitive functions for all -interactions between C and Lua, -the auxiliary library provides higher-level functions for some -common tasks. - -All functions and types from the auxiliary library -are defined in header file @id{lauxlib.h} and -have a prefix @id{luaL_}. - -All functions in the auxiliary library are built on -top of the basic API, -and so they provide nothing that cannot be done with that API. -Nevertheless, the use of the auxiliary library ensures -more consistency to your code. - - -Several functions in the auxiliary library use internally some -extra stack slots. -When a function in the auxiliary library uses less than five slots, -it does not check the stack size; -it simply assumes that there are enough slots. - -Several functions in the auxiliary library are used to -check @N{C function} arguments. -Because the error message is formatted for arguments -(e.g., @St{bad argument #1}), -you should not use these functions for other stack values. - -Functions called @id{luaL_check*} -always raise an error if the check is not satisfied. - -} - - -@sect2{@title{Functions and Types} - -Here we list all functions and types from the auxiliary library -in alphabetical order. - - -@APIEntry{void luaL_addchar (luaL_Buffer *B, char c);| -@apii{?,?,m} - -Adds the byte @id{c} to the buffer @id{B} -@seeC{luaL_Buffer}. - -} - -@APIEntry{ -const void luaL_addgsub (luaL_Buffer *B, const char *s, - const char *p, const char *r);| -@apii{?,?,m} - -Adds a copy of the string @id{s} to the buffer @id{B} @seeC{luaL_Buffer}, -replacing any occurrence of the string @id{p} -with the string @id{r}. - -} - -@APIEntry{void luaL_addlstring (luaL_Buffer *B, const char *s, size_t l);| -@apii{?,?,m} - -Adds the string pointed to by @id{s} with length @id{l} to -the buffer @id{B} -@seeC{luaL_Buffer}. -The string can contain @x{embedded zeros}. - -} - -@APIEntry{void luaL_addsize (luaL_Buffer *B, size_t n);| -@apii{?,?,-} - -Adds to the buffer @id{B} -a string of length @id{n} previously copied to the -buffer area @seeC{luaL_prepbuffer}. - -} - -@APIEntry{void luaL_addstring (luaL_Buffer *B, const char *s);| -@apii{?,?,m} - -Adds the zero-terminated string pointed to by @id{s} -to the buffer @id{B} -@seeC{luaL_Buffer}. - -} - -@APIEntry{void luaL_addvalue (luaL_Buffer *B);| -@apii{?,?,m} - -Adds the value on the top of the stack -to the buffer @id{B} -@seeC{luaL_Buffer}. -Pops the value. - -This is the only function on string buffers that can (and must) -be called with an extra element on the stack, -which is the value to be added to the buffer. - -} - -@APIEntry{ -void luaL_argcheck (lua_State *L, - int cond, - int arg, - const char *extramsg);| -@apii{0,0,v} - -Checks whether @id{cond} is true. -If it is not, raises an error with a standard message @seeF{luaL_argerror}. - -} - -@APIEntry{int luaL_argerror (lua_State *L, int arg, const char *extramsg);| -@apii{0,0,v} - -Raises an error reporting a problem with argument @id{arg} -of the @N{C function} that called it, -using a standard message -that includes @id{extramsg} as a comment: -@verbatim{ -bad argument #@rep{arg} to '@rep{funcname}' (@rep{extramsg}) -} -This function never returns. - -} - -@APIEntry{ -void luaL_argexpected (lua_State *L, - int cond, - int arg, - const char *tname);| -@apii{0,0,v} - -Checks whether @id{cond} is true. -If it is not, raises an error about the type of the argument @id{arg} -with a standard message @seeF{luaL_typeerror}. - -} - -@APIEntry{typedef struct luaL_Buffer luaL_Buffer;| - -Type for a @def{string buffer}. - -A string buffer allows @N{C code} to build Lua strings piecemeal. -Its pattern of use is as follows: -@itemize{ - -@item{First declare a variable @id{b} of type @Lid{luaL_Buffer}.} - -@item{Then initialize it with a call @T{luaL_buffinit(L, &b)}.} - -@item{ -Then add string pieces to the buffer calling any of -the @id{luaL_add*} functions. -} - -@item{ -Finish by calling @T{luaL_pushresult(&b)}. -This call leaves the final string on the top of the stack. -} - -} - -If you know beforehand the maximum size of the resulting string, -you can use the buffer like this: -@itemize{ - -@item{First declare a variable @id{b} of type @Lid{luaL_Buffer}.} - -@item{Then initialize it and preallocate a space of -size @id{sz} with a call @T{luaL_buffinitsize(L, &b, sz)}.} - -@item{Then produce the string into that space.} - -@item{ -Finish by calling @T{luaL_pushresultsize(&b, sz)}, -where @id{sz} is the total size of the resulting string -copied into that space (which may be less than or -equal to the preallocated size). -} - -} - -During its normal operation, -a string buffer uses a variable number of stack slots. -So, while using a buffer, you cannot assume that you know where -the top of the stack is. -You can use the stack between successive calls to buffer operations -as long as that use is balanced; -that is, -when you call a buffer operation, -the stack is at the same level -it was immediately after the previous buffer operation. -(The only exception to this rule is @Lid{luaL_addvalue}.) -After calling @Lid{luaL_pushresult}, -the stack is back to its level when the buffer was initialized, -plus the final string on its top. - -} - -@APIEntry{char *luaL_buffaddr (luaL_Buffer *B);| -@apii{0,0,-} - -Returns the address of the current content of buffer @id{B} -@seeC{luaL_Buffer}. -Note that any addition to the buffer may invalidate this address. - -} - -@APIEntry{void luaL_buffinit (lua_State *L, luaL_Buffer *B);| -@apii{0,?,-} - -Initializes a buffer @id{B} -@seeC{luaL_Buffer}. -This function does not allocate any space; -the buffer must be declared as a variable. - -} - -@APIEntry{size_t luaL_bufflen (luaL_Buffer *B);| -@apii{0,0,-} - -Returns the length of the current content of buffer @id{B} -@seeC{luaL_Buffer}. - -} - -@APIEntry{char *luaL_buffinitsize (lua_State *L, luaL_Buffer *B, size_t sz);| -@apii{?,?,m} - -Equivalent to the sequence -@Lid{luaL_buffinit}, @Lid{luaL_prepbuffsize}. - -} - -@APIEntry{void luaL_buffsub (luaL_Buffer *B, int n);| -@apii{?,?,-} - -Removes @id{n} bytes from the buffer @id{B} -@seeC{luaL_Buffer}. -The buffer must have at least that many bytes. - -} - -@APIEntry{int luaL_callmeta (lua_State *L, int obj, const char *e);| -@apii{0,0|1,e} - -Calls a metamethod. - -If the object at index @id{obj} has a metatable and this -metatable has a field @id{e}, -this function calls this field passing the object as its only argument. -In this case this function returns true and pushes onto the -stack the value returned by the call. -If there is no metatable or no metamethod, -this function returns false without pushing any value on the stack. - -} - -@APIEntry{void luaL_checkany (lua_State *L, int arg);| -@apii{0,0,v} - -Checks whether the function has an argument -of any type (including @nil) at position @id{arg}. - -} - -@APIEntry{lua_Integer luaL_checkinteger (lua_State *L, int arg);| -@apii{0,0,v} - -Checks whether the function argument @id{arg} is an integer -(or can be converted to an integer) -and returns this integer. - -} - -@APIEntry{const char *luaL_checklstring (lua_State *L, int arg, size_t *l);| -@apii{0,0,v} - -Checks whether the function argument @id{arg} is a string -and returns this string; -if @id{l} is not @id{NULL} fills its referent -with the string's length. - -This function uses @Lid{lua_tolstring} to get its result, -so all conversions and caveats of that function apply here. - -} - -@APIEntry{lua_Number luaL_checknumber (lua_State *L, int arg);| -@apii{0,0,v} - -Checks whether the function argument @id{arg} is a number -and returns this number converted to a @id{lua_Number}. - -} - -@APIEntry{ -int luaL_checkoption (lua_State *L, - int arg, - const char *def, - const char *const lst[]);| -@apii{0,0,v} - -Checks whether the function argument @id{arg} is a string and -searches for this string in the array @id{lst} -(which must be NULL-terminated). -Returns the index in the array where the string was found. -Raises an error if the argument is not a string or -if the string cannot be found. - -If @id{def} is not @id{NULL}, -the function uses @id{def} as a default value when -there is no argument @id{arg} or when this argument is @nil. - -This is a useful function for mapping strings to @N{C enums}. -(The usual convention in Lua libraries is -to use strings instead of numbers to select options.) - -} - -@APIEntry{void luaL_checkstack (lua_State *L, int sz, const char *msg);| -@apii{0,0,v} - -Grows the stack size to @T{top + sz} elements, -raising an error if the stack cannot grow to that size. -@id{msg} is an additional text to go into the error message -(or @id{NULL} for no additional text). - -} - -@APIEntry{const char *luaL_checkstring (lua_State *L, int arg);| -@apii{0,0,v} - -Checks whether the function argument @id{arg} is a string -and returns this string. - -This function uses @Lid{lua_tolstring} to get its result, -so all conversions and caveats of that function apply here. - -} - -@APIEntry{void luaL_checktype (lua_State *L, int arg, int t);| -@apii{0,0,v} - -Checks whether the function argument @id{arg} has type @id{t}. -See @Lid{lua_type} for the encoding of types for @id{t}. - -} - -@APIEntry{void *luaL_checkudata (lua_State *L, int arg, const char *tname);| -@apii{0,0,v} - -Checks whether the function argument @id{arg} is a userdata -of the type @id{tname} @seeC{luaL_newmetatable} and -returns the userdata's memory-block address @seeC{lua_touserdata}. - -} - -@APIEntry{void luaL_checkversion (lua_State *L);| -@apii{0,0,v} - -Checks whether the code making the call and the Lua library being called -are using the same version of Lua and the same numeric types. - -} - -@APIEntry{int luaL_dofile (lua_State *L, const char *filename);| -@apii{0,?,m} - -Loads and runs the given file. -It is defined as the following macro: -@verbatim{ -(luaL_loadfile(L, filename) || lua_pcall(L, 0, LUA_MULTRET, 0)) -} -It @N{returns 0} (@Lid{LUA_OK}) if there are no errors, -or 1 in case of errors. - -} - -@APIEntry{int luaL_dostring (lua_State *L, const char *str);| -@apii{0,?,-} - -Loads and runs the given string. -It is defined as the following macro: -@verbatim{ -(luaL_loadstring(L, str) || lua_pcall(L, 0, LUA_MULTRET, 0)) -} -It @N{returns 0} (@Lid{LUA_OK}) if there are no errors, -or 1 in case of errors. - -} - -@APIEntry{int luaL_error (lua_State *L, const char *fmt, ...);| -@apii{0,0,v} - -Raises an error. -The error message format is given by @id{fmt} -plus any extra arguments, -following the same rules of @Lid{lua_pushfstring}. -It also adds at the beginning of the message the file name and -the line number where the error occurred, -if this information is available. - -This function never returns, -but it is an idiom to use it in @N{C functions} -as @T{return luaL_error(@rep{args})}. - -} - -@APIEntry{int luaL_execresult (lua_State *L, int stat);| -@apii{0,3,m} - -This function produces the return values for -process-related functions in the standard library -(@Lid{os.execute} and @Lid{io.close}). - -} - -@APIEntry{ -int luaL_fileresult (lua_State *L, int stat, const char *fname);| -@apii{0,1|3,m} - -This function produces the return values for -file-related functions in the standard library -(@Lid{io.open}, @Lid{os.rename}, @Lid{file:seek}, etc.). - -} - -@APIEntry{int luaL_getmetafield (lua_State *L, int obj, const char *e);| -@apii{0,0|1,m} - -Pushes onto the stack the field @id{e} from the metatable -of the object at index @id{obj} and returns the type of the pushed value. -If the object does not have a metatable, -or if the metatable does not have this field, -pushes nothing and returns @id{LUA_TNIL}. - -} - -@APIEntry{int luaL_getmetatable (lua_State *L, const char *tname);| -@apii{0,1,m} - -Pushes onto the stack the metatable associated with the name @id{tname} -in the registry @seeC{luaL_newmetatable}, -or @nil if there is no metatable associated with that name. -Returns the type of the pushed value. - -} - -@APIEntry{int luaL_getsubtable (lua_State *L, int idx, const char *fname);| -@apii{0,1,e} - -Ensures that the value @T{t[fname]}, -where @id{t} is the value at index @id{idx}, -is a table, -and pushes that table onto the stack. -Returns true if it finds a previous table there -and false if it creates a new table. - -} - -@APIEntry{ -const char *luaL_gsub (lua_State *L, - const char *s, - const char *p, - const char *r);| -@apii{0,1,m} - -Creates a copy of string @id{s}, -replacing any occurrence of the string @id{p} -with the string @id{r}. -Pushes the resulting string on the stack and returns it. - -} - -@APIEntry{lua_Integer luaL_len (lua_State *L, int index);| -@apii{0,0,e} - -Returns the @Q{length} of the value at the given index -as a number; -it is equivalent to the @Char{#} operator in Lua @see{len-op}. -Raises an error if the result of the operation is not an integer. -(This case can only happen through metamethods.) - -} - -@APIEntry{ -int luaL_loadbuffer (lua_State *L, - const char *buff, - size_t sz, - const char *name);| -@apii{0,1,-} - -Equivalent to @Lid{luaL_loadbufferx} with @id{mode} equal to @id{NULL}. - -} - - -@APIEntry{ -int luaL_loadbufferx (lua_State *L, - const char *buff, - size_t sz, - const char *name, - const char *mode);| -@apii{0,1,-} - -Loads a buffer as a Lua chunk. -This function uses @Lid{lua_load} to load the chunk in the -buffer pointed to by @id{buff} with size @id{sz}. - -This function returns the same results as @Lid{lua_load}. -@id{name} is the chunk name, -used for debug information and error messages. -The string @id{mode} works as in the function @Lid{lua_load}. - -} - - -@APIEntry{int luaL_loadfile (lua_State *L, const char *filename);| -@apii{0,1,m} - -Equivalent to @Lid{luaL_loadfilex} with @id{mode} equal to @id{NULL}. - -} - -@APIEntry{int luaL_loadfilex (lua_State *L, const char *filename, - const char *mode);| -@apii{0,1,m} - -Loads a file as a Lua chunk. -This function uses @Lid{lua_load} to load the chunk in the file -named @id{filename}. -If @id{filename} is @id{NULL}, -then it loads from the standard input. -The first line in the file is ignored if it starts with a @T{#}. - -The string @id{mode} works as in the function @Lid{lua_load}. - -This function returns the same results as @Lid{lua_load} -or @Lid{LUA_ERRFILE} for file-related errors. - -As @Lid{lua_load}, this function only loads the chunk; -it does not run it. - -} - -@APIEntry{int luaL_loadstring (lua_State *L, const char *s);| -@apii{0,1,-} - -Loads a string as a Lua chunk. -This function uses @Lid{lua_load} to load the chunk in -the zero-terminated string @id{s}. - -This function returns the same results as @Lid{lua_load}. - -Also as @Lid{lua_load}, this function only loads the chunk; -it does not run it. - -} - - -@APIEntry{void luaL_newlib (lua_State *L, const luaL_Reg l[]);| -@apii{0,1,m} - -Creates a new table and registers there -the functions in the list @id{l}. - -It is implemented as the following macro: -@verbatim{ -(luaL_newlibtable(L,l), luaL_setfuncs(L,l,0)) -} -The array @id{l} must be the actual array, -not a pointer to it. - -} - -@APIEntry{void luaL_newlibtable (lua_State *L, const luaL_Reg l[]);| -@apii{0,1,m} - -Creates a new table with a size optimized -to store all entries in the array @id{l} -(but does not actually store them). -It is intended to be used in conjunction with @Lid{luaL_setfuncs} -@seeF{luaL_newlib}. - -It is implemented as a macro. -The array @id{l} must be the actual array, -not a pointer to it. - -} - -@APIEntry{int luaL_newmetatable (lua_State *L, const char *tname);| -@apii{0,1,m} - -If the registry already has the key @id{tname}, -returns 0. -Otherwise, -creates a new table to be used as a metatable for userdata, -adds to this new table the pair @T{__name = tname}, -adds to the registry the pair @T{[tname] = new table}, -and returns 1. - -In both cases, -the function pushes onto the stack the final value associated -with @id{tname} in the registry. - -} - -@APIEntry{lua_State *luaL_newstate (void);| -@apii{0,0,-} - -Creates a new Lua state. -It calls @Lid{lua_newstate} with an -allocator based on the @N{ISO C} allocation functions -and then sets a warning function and a panic function @see{C-error} -that print messages to the standard error output. - -Returns the new state, -or @id{NULL} if there is a @x{memory allocation error}. - -} - -@APIEntry{void luaL_openlibs (lua_State *L);| -@apii{0,0,e} - -Opens all standard Lua libraries into the given state. - -} - -@APIEntry{ -T luaL_opt (L, func, arg, dflt);| -@apii{0,0,-} - -This macro is defined as follows: -@verbatim{ -(lua_isnoneornil(L,(arg)) ? (dflt) : func(L,(arg))) -} -In words, if the argument @id{arg} is nil or absent, -the macro results in the default @id{dflt}. -Otherwise, it results in the result of calling @id{func} -with the state @id{L} and the argument index @id{arg} as -arguments. -Note that it evaluates the expression @id{dflt} only if needed. - -} - -@APIEntry{ -lua_Integer luaL_optinteger (lua_State *L, - int arg, - lua_Integer d);| -@apii{0,0,v} - -If the function argument @id{arg} is an integer -(or it is convertible to an integer), -returns this integer. -If this argument is absent or is @nil, -returns @id{d}. -Otherwise, raises an error. - -} - -@APIEntry{ -const char *luaL_optlstring (lua_State *L, - int arg, - const char *d, - size_t *l);| -@apii{0,0,v} - -If the function argument @id{arg} is a string, -returns this string. -If this argument is absent or is @nil, -returns @id{d}. -Otherwise, raises an error. - -If @id{l} is not @id{NULL}, -fills its referent with the result's length. -If the result is @id{NULL} -(only possible when returning @id{d} and @T{d == NULL}), -its length is considered zero. - -This function uses @Lid{lua_tolstring} to get its result, -so all conversions and caveats of that function apply here. - -} - -@APIEntry{lua_Number luaL_optnumber (lua_State *L, int arg, lua_Number d);| -@apii{0,0,v} - -If the function argument @id{arg} is a number, -returns this number as a @id{lua_Number}. -If this argument is absent or is @nil, -returns @id{d}. -Otherwise, raises an error. - -} - -@APIEntry{ -const char *luaL_optstring (lua_State *L, - int arg, - const char *d);| -@apii{0,0,v} - -If the function argument @id{arg} is a string, -returns this string. -If this argument is absent or is @nil, -returns @id{d}. -Otherwise, raises an error. - -} - -@APIEntry{char *luaL_prepbuffer (luaL_Buffer *B);| -@apii{?,?,m} - -Equivalent to @Lid{luaL_prepbuffsize} -with the predefined size @defid{LUAL_BUFFERSIZE}. - -} - -@APIEntry{char *luaL_prepbuffsize (luaL_Buffer *B, size_t sz);| -@apii{?,?,m} - -Returns an address to a space of size @id{sz} -where you can copy a string to be added to buffer @id{B} -@seeC{luaL_Buffer}. -After copying the string into this space you must call -@Lid{luaL_addsize} with the size of the string to actually add -it to the buffer. - -} - -@APIEntry{void luaL_pushfail (lua_State *L);| -@apii{0,1,-} - -Pushes the @fail value onto the stack @see{libraries}. - -} - -@APIEntry{void luaL_pushresult (luaL_Buffer *B);| -@apii{?,1,m} - -Finishes the use of buffer @id{B} leaving the final string on -the top of the stack. - -} - -@APIEntry{void luaL_pushresultsize (luaL_Buffer *B, size_t sz);| -@apii{?,1,m} - -Equivalent to the sequence @Lid{luaL_addsize}, @Lid{luaL_pushresult}. - -} - -@APIEntry{int luaL_ref (lua_State *L, int t);| -@apii{1,0,m} - -Creates and returns a @def{reference}, -in the table at index @id{t}, -for the object on the top of the stack (and pops the object). - -A reference is a unique integer key. -As long as you do not manually add integer keys into the table @id{t}, -@Lid{luaL_ref} ensures the uniqueness of the key it returns. -You can retrieve an object referred by the reference @id{r} -by calling @T{lua_rawgeti(L, t, r)}. -The function @Lid{luaL_unref} frees a reference. - -If the object on the top of the stack is @nil, -@Lid{luaL_ref} returns the constant @defid{LUA_REFNIL}. -The constant @defid{LUA_NOREF} is guaranteed to be different -from any reference returned by @Lid{luaL_ref}. - -} - -@APIEntry{ -typedef struct luaL_Reg { - const char *name; - lua_CFunction func; -} luaL_Reg; -| - -Type for arrays of functions to be registered by -@Lid{luaL_setfuncs}. -@id{name} is the function name and @id{func} is a pointer to -the function. -Any array of @Lid{luaL_Reg} must end with a sentinel entry -in which both @id{name} and @id{func} are @id{NULL}. - -} - -@APIEntry{ -void luaL_requiref (lua_State *L, const char *modname, - lua_CFunction openf, int glb);| -@apii{0,1,e} - -If @T{package.loaded[modname]} is not true, -calls the function @id{openf} with the string @id{modname} as an argument -and sets the call result to @T{package.loaded[modname]}, -as if that function has been called through @Lid{require}. - -If @id{glb} is true, -also stores the module into the global @id{modname}. - -Leaves a copy of the module on the stack. - -} - -@APIEntry{void luaL_setfuncs (lua_State *L, const luaL_Reg *l, int nup);| -@apii{nup,0,m} - -Registers all functions in the array @id{l} -@seeC{luaL_Reg} into the table on the top of the stack -(below optional upvalues, see next). - -When @id{nup} is not zero, -all functions are created with @id{nup} upvalues, -initialized with copies of the @id{nup} values -previously pushed on the stack -on top of the library table. -These values are popped from the stack after the registration. - -A function with a @id{NULL} value represents a placeholder, -which is filled with @false. - -} - -@APIEntry{void luaL_setmetatable (lua_State *L, const char *tname);| -@apii{0,0,-} - -Sets the metatable of the object on the top of the stack -as the metatable associated with name @id{tname} -in the registry @seeC{luaL_newmetatable}. - -} - -@APIEntry{ -typedef struct luaL_Stream { - FILE *f; - lua_CFunction closef; -} luaL_Stream; -| - -The standard representation for @x{file handles} -used by the standard I/O library. - -A file handle is implemented as a full userdata, -with a metatable called @id{LUA_FILEHANDLE} -(where @id{LUA_FILEHANDLE} is a macro with the actual metatable's name). -The metatable is created by the I/O library -@seeF{luaL_newmetatable}. - -This userdata must start with the structure @id{luaL_Stream}; -it can contain other data after this initial structure. -The field @id{f} points to the corresponding C stream -(or it can be @id{NULL} to indicate an incompletely created handle). -The field @id{closef} points to a Lua function -that will be called to close the stream -when the handle is closed or collected; -this function receives the file handle as its sole argument and -must return either a true value, in case of success, -or a false value plus an error message, in case of error. -Once Lua calls this field, -it changes the field value to @id{NULL} -to signal that the handle is closed. - -} - -@APIEntry{void *luaL_testudata (lua_State *L, int arg, const char *tname);| -@apii{0,0,m} - -This function works like @Lid{luaL_checkudata}, -except that, when the test fails, -it returns @id{NULL} instead of raising an error. - -} - -@APIEntry{const char *luaL_tolstring (lua_State *L, int idx, size_t *len);| -@apii{0,1,e} - -Converts any Lua value at the given index to a @N{C string} -in a reasonable format. -The resulting string is pushed onto the stack and also -returned by the function @see{constchar}. -If @id{len} is not @id{NULL}, -the function also sets @T{*len} with the string length. - -If the value has a metatable with a @idx{__tostring} field, -then @id{luaL_tolstring} calls the corresponding metamethod -with the value as argument, -and uses the result of the call as its result. - -} - -@APIEntry{ -void luaL_traceback (lua_State *L, lua_State *L1, const char *msg, - int level);| -@apii{0,1,m} - -Creates and pushes a traceback of the stack @id{L1}. -If @id{msg} is not @id{NULL}, it is appended -at the beginning of the traceback. -The @id{level} parameter tells at which level -to start the traceback. - -} - -@APIEntry{int luaL_typeerror (lua_State *L, int arg, const char *tname);| -@apii{0,0,v} - -Raises a type error for the argument @id{arg} -of the @N{C function} that called it, -using a standard message; -@id{tname} is a @Q{name} for the expected type. -This function never returns. - -} - -@APIEntry{const char *luaL_typename (lua_State *L, int index);| -@apii{0,0,-} - -Returns the name of the type of the value at the given index. - -} - -@APIEntry{void luaL_unref (lua_State *L, int t, int ref);| -@apii{0,0,-} - -Releases the reference @id{ref} from the table at index @id{t} -@seeC{luaL_ref}. -The entry is removed from the table, -so that the referred object can be collected. -The reference @id{ref} is also freed to be used again. - -If @id{ref} is @Lid{LUA_NOREF} or @Lid{LUA_REFNIL}, -@Lid{luaL_unref} does nothing. - -} - -@APIEntry{void luaL_where (lua_State *L, int lvl);| -@apii{0,1,m} - -Pushes onto the stack a string identifying the current position -of the control at level @id{lvl} in the call stack. -Typically this string has the following format: -@verbatim{ -@rep{chunkname}:@rep{currentline}: -} -@N{Level 0} is the running function, -@N{level 1} is the function that called the running function, -etc. - -This function is used to build a prefix for error messages. - -} - -} - -} - - -@C{-------------------------------------------------------------------------} -@sect1{libraries| @title{The Standard Libraries} - -@simplesect{ - -The standard Lua libraries provide useful functions -that are implemented @N{in C} through the @N{C API}. -Some of these functions provide essential services to the language -(e.g., @Lid{type} and @Lid{getmetatable}); -others provide access to outside services (e.g., I/O); -and others could be implemented in Lua itself, -but that for different reasons -deserve an implementation in C (e.g., @Lid{table.sort}). - -All libraries are implemented through the official @N{C API} -and are provided as separate @N{C modules}. -Unless otherwise noted, -these library functions do not adjust its number of arguments -to its expected parameters. -For instance, a function documented as @T{foo(arg)} -should not be called without an argument. - -The notation @fail means a false value representing -some kind of failure. -(Currently, @fail is equal to @nil, -but that may change in future versions. -The recommendation is to always test the success of these functions -with @T{(not status)}, instead of @T{(status == nil)}.) - - -Currently, Lua has the following standard libraries: -@itemize{ - -@item{@link{predefined|basic library};} - -@item{@link{corolib|coroutine library};} - -@item{@link{packlib|package library};} - -@item{@link{strlib|string manipulation};} - -@item{@link{utf8|basic UTF-8 support};} - -@item{@link{tablib|table manipulation};} - -@item{@link{mathlib|mathematical functions} (sin, log, etc.);} - -@item{@link{iolib|input and output};} - -@item{@link{oslib|operating system facilities};} - -@item{@link{debuglib|debug facilities}.} - -} -Except for the basic and the package libraries, -each library provides all its functions as fields of a global table -or as methods of its objects. - -To have access to these libraries, -the @N{C host} program should call the @Lid{luaL_openlibs} function, -which opens all standard libraries. -Alternatively, -the host program can open them individually by using -@Lid{luaL_requiref} to call -@defid{luaopen_base} (for the basic library), -@defid{luaopen_package} (for the package library), -@defid{luaopen_coroutine} (for the coroutine library), -@defid{luaopen_string} (for the string library), -@defid{luaopen_utf8} (for the UTF-8 library), -@defid{luaopen_table} (for the table library), -@defid{luaopen_math} (for the mathematical library), -@defid{luaopen_io} (for the I/O library), -@defid{luaopen_os} (for the operating system library), -and @defid{luaopen_debug} (for the debug library). -These functions are declared in @defid{lualib.h}. - -} - - -@sect2{predefined| @title{Basic Functions} - -The basic library provides core functions to Lua. -If you do not include this library in your application, -you should check carefully whether you need to provide -implementations for some of its facilities. - - -@LibEntry{assert (v [, message])| - -Raises an error if -the value of its argument @id{v} is false (i.e., @nil or @false); -otherwise, returns all its arguments. -In case of error, -@id{message} is the error object; -when absent, it defaults to @St{assertion failed!} - -} - -@LibEntry{collectgarbage ([opt [, arg]])| - -This function is a generic interface to the garbage collector. -It performs different functions according to its first argument, @id{opt}: -@description{ - -@item{@St{collect}| -Performs a full garbage-collection cycle. -This is the default option. -} - -@item{@St{stop}| -Stops automatic execution of the garbage collector. -The collector will run only when explicitly invoked, -until a call to restart it. -} - -@item{@St{restart}| -Restarts automatic execution of the garbage collector. -} - -@item{@St{count}| -Returns the total memory in use by Lua in Kbytes. -The value has a fractional part, -so that it multiplied by 1024 -gives the exact number of bytes in use by Lua. -} - -@item{@St{step}| -Performs a garbage-collection step. -The step @Q{size} is controlled by @id{arg}. -With a zero value, -the collector will perform one basic (indivisible) step. -For non-zero values, -the collector will perform as if that amount of memory -(in Kbytes) had been allocated by Lua. -Returns @true if the step finished a collection cycle. -} - -@item{@St{isrunning}| -Returns a boolean that tells whether the collector is running -(i.e., not stopped). -} - -@item{@St{incremental}| -Change the collector mode to incremental. -This option can be followed by three numbers: -the garbage-collector pause, -the step multiplier, -and the step size @see{incmode}. -A zero means to not change that value. -} - -@item{@St{generational}| -Change the collector mode to generational. -This option can be followed by two numbers: -the garbage-collector minor multiplier -and the major multiplier @see{genmode}. -A zero means to not change that value. -} - -} -See @See{GC} for more details about garbage collection -and some of these options. - -This function should not be called by a finalizer. - -} - -@LibEntry{dofile ([filename])| -Opens the named file and executes its content as a Lua chunk. -When called without arguments, -@id{dofile} executes the content of the standard input (@id{stdin}). -Returns all values returned by the chunk. -In case of errors, @id{dofile} propagates the error -to its caller. -(That is, @id{dofile} does not run in protected mode.) - -} - -@LibEntry{error (message [, level])| -Raises an error @see{error} with @id{message} as the error object. -This function never returns. - -Usually, @id{error} adds some information about the error position -at the beginning of the message, if the message is a string. -The @id{level} argument specifies how to get the error position. -With @N{level 1} (the default), the error position is where the -@id{error} function was called. -@N{Level 2} points the error to where the function -that called @id{error} was called; and so on. -Passing a @N{level 0} avoids the addition of error position information -to the message. - -} - -@LibEntry{_G| -A global variable (not a function) that -holds the @x{global environment} @see{globalenv}. -Lua itself does not use this variable; -changing its value does not affect any environment, -nor vice versa. - -} - -@LibEntry{getmetatable (object)| - -If @id{object} does not have a metatable, returns @nil. -Otherwise, -if the object's metatable has a @idx{__metatable} field, -returns the associated value. -Otherwise, returns the metatable of the given object. - -} - -@LibEntry{ipairs (t)| - -Returns three values (an iterator function, the table @id{t}, and 0) -so that the construction -@verbatim{ -for i,v in ipairs(t) do @rep{body} end -} -will iterate over the key@En{}value pairs -(@T{1,t[1]}), (@T{2,t[2]}), @ldots, -up to the first absent index. - -} - -@LibEntry{load (chunk [, chunkname [, mode [, env]]])| - -Loads a chunk. - -If @id{chunk} is a string, the chunk is this string. -If @id{chunk} is a function, -@id{load} calls it repeatedly to get the chunk pieces. -Each call to @id{chunk} must return a string that concatenates -with previous results. -A return of an empty string, @nil, or no value signals the end of the chunk. - -If there are no syntactic errors, -@id{load} returns the compiled chunk as a function; -otherwise, it returns @fail plus the error message. - -When you load a main chunk, -the resulting function will always have exactly one upvalue, -the @id{_ENV} variable @see{globalenv}. -However, -when you load a binary chunk created from a function @seeF{string.dump}, -the resulting function can have an arbitrary number of upvalues, -and there is no guarantee that its first upvalue will be -the @id{_ENV} variable. -(A non-main function may not even have an @id{_ENV} upvalue.) - -Regardless, if the resulting function has any upvalues, -its first upvalue is set to the value of @id{env}, -if that parameter is given, -or to the value of the @x{global environment}. -Other upvalues are initialized with @nil. -All upvalues are fresh, that is, -they are not shared with any other function. - -@id{chunkname} is used as the name of the chunk for error messages -and debug information @see{debugI}. -When absent, -it defaults to @id{chunk}, if @id{chunk} is a string, -or to @St{=(load)} otherwise. - -The string @id{mode} controls whether the chunk can be text or binary -(that is, a precompiled chunk). -It may be the string @St{b} (only @x{binary chunk}s), -@St{t} (only text chunks), -or @St{bt} (both binary and text). -The default is @St{bt}. - -It is safe to load malformed binary chunks; -@id{load} signals an appropriate error. -However, -Lua does not check the consistency of the code inside binary chunks; -running maliciously crafted bytecode can crash the interpreter. - -} - -@LibEntry{loadfile ([filename [, mode [, env]]])| - -Similar to @Lid{load}, -but gets the chunk from file @id{filename} -or from the standard input, -if no file name is given. - -} - -@LibEntry{next (table [, index])| - -Allows a program to traverse all fields of a table. -Its first argument is a table and its second argument -is an index in this table. -A call to @id{next} returns the next index of the table -and its associated value. -When called with @nil as its second argument, -@id{next} returns an initial index -and its associated value. -When called with the last index, -or with @nil in an empty table, -@id{next} returns @nil. -If the second argument is absent, then it is interpreted as @nil. -In particular, -you can use @T{next(t)} to check whether a table is empty. - -The order in which the indices are enumerated is not specified, -@emph{even for numeric indices}. -(To traverse a table in numerical order, -use a numerical @Rw{for}.) - -You should not assign any value to a non-existent field in a table -during its traversal. -You may however modify existing fields. -In particular, you may set existing fields to nil. - -} - -@LibEntry{pairs (t)| - -If @id{t} has a metamethod @idx{__pairs}, -calls it with @id{t} as argument and returns the first three -results from the call. - -Otherwise, -returns three values: the @Lid{next} function, the table @id{t}, and @nil, -so that the construction -@verbatim{ -for k,v in pairs(t) do @rep{body} end -} -will iterate over all key@En{}value pairs of table @id{t}. - -See function @Lid{next} for the caveats of modifying -the table during its traversal. - -} - -@LibEntry{pcall (f [, arg1, @Cdots])| - -Calls the function @id{f} with -the given arguments in @emphx{protected mode}. -This means that any error @N{inside @T{f}} is not propagated; -instead, @id{pcall} catches the error -and returns a status code. -Its first result is the status code (a boolean), -which is @true if the call succeeds without errors. -In such case, @id{pcall} also returns all results from the call, -after this first result. -In case of any error, @id{pcall} returns @false plus the error object. -Note that errors caught by @id{pcall} do not call a message handler. - -} - -@LibEntry{print (@Cdots)| -Receives any number of arguments -and prints their values to @id{stdout}, -converting each argument to a string -following the same rules of @Lid{tostring}. - -The function @id{print} is not intended for formatted output, -but only as a quick way to show a value, -for instance for debugging. -For complete control over the output, -use @Lid{string.format} and @Lid{io.write}. - -} - -@LibEntry{rawequal (v1, v2)| -Checks whether @id{v1} is equal to @id{v2}, -without invoking the @idx{__eq} metamethod. -Returns a boolean. - -} - -@LibEntry{rawget (table, index)| -Gets the real value of @T{table[index]}, -without using the @idx{__index} metavalue. -@id{table} must be a table; -@id{index} may be any value. - -} - -@LibEntry{rawlen (v)| -Returns the length of the object @id{v}, -which must be a table or a string, -without invoking the @idx{__len} metamethod. -Returns an integer. - -} - -@LibEntry{rawset (table, index, value)| -Sets the real value of @T{table[index]} to @id{value}, -without using the @idx{__newindex} metavalue. -@id{table} must be a table, -@id{index} any value different from @nil and @x{NaN}, -and @id{value} any Lua value. - -This function returns @id{table}. - -} - -@LibEntry{select (index, @Cdots)| - -If @id{index} is a number, -returns all arguments after argument number @id{index}; -a negative number indexes from the end (@num{-1} is the last argument). -Otherwise, @id{index} must be the string @T{"#"}, -and @id{select} returns the total number of extra arguments it received. - -} - -@LibEntry{setmetatable (table, metatable)| - -Sets the metatable for the given table. -If @id{metatable} is @nil, -removes the metatable of the given table. -If the original metatable has a @idx{__metatable} field, -raises an error. - -This function returns @id{table}. - -To change the metatable of other types from Lua code, -you must use the @link{debuglib|debug library}. - -} - -@LibEntry{tonumber (e [, base])| - -When called with no @id{base}, -@id{tonumber} tries to convert its argument to a number. -If the argument is already a number or -a string convertible to a number, -then @id{tonumber} returns this number; -otherwise, it returns @fail. - -The conversion of strings can result in integers or floats, -according to the lexical conventions of Lua @see{lexical}. -The string may have leading and trailing spaces and a sign. - -When called with @id{base}, -then @id{e} must be a string to be interpreted as -an integer numeral in that base. -The base may be any integer between 2 and 36, inclusive. -In bases @N{above 10}, the letter @Char{A} (in either upper or lower case) -@N{represents 10}, @Char{B} @N{represents 11}, and so forth, -with @Char{Z} representing 35. -If the string @id{e} is not a valid numeral in the given base, -the function returns @fail. - -} - -@LibEntry{tostring (v)| - -Receives a value of any type and -converts it to a string in a human-readable format. - -If the metatable of @id{v} has a @idx{__tostring} field, -then @id{tostring} calls the corresponding value -with @id{v} as argument, -and uses the result of the call as its result. -Otherwise, if the metatable of @id{v} has a @idx{__name} field -with a string value, -@id{tostring} may use that string in its final result. - -For complete control of how numbers are converted, -use @Lid{string.format}. - -} - -@LibEntry{type (v)| - -Returns the type of its only argument, coded as a string. -The possible results of this function are -@St{nil} (a string, not the value @nil), -@St{number}, -@St{string}, -@St{boolean}, -@St{table}, -@St{function}, -@St{thread}, -and @St{userdata}. - -} - -@LibEntry{_VERSION| - -A global variable (not a function) that -holds a string containing the running Lua version. -The current value of this variable is @St{Lua 5.4}. - -} - -@LibEntry{warn (msg1, @Cdots)| - -Emits a warning with a message composed by the concatenation -of all its arguments (which should be strings). - -By convention, -a one-piece message starting with @Char{@At} -is intended to be a @emph{control message}, -which is a message to the warning system itself. -In particular, the standard warning function in Lua -recognizes the control messages @St{@At{}off}, -to stop the emission of warnings, -and @St{@At{}on}, to (re)start the emission; -it ignores unknown control messages. - -} - -@LibEntry{xpcall (f, msgh [, arg1, @Cdots])| - -This function is similar to @Lid{pcall}, -except that it sets a new @x{message handler} @id{msgh}. - -} - -} - -@sect2{corolib| @title{Coroutine Manipulation} - -This library comprises the operations to manipulate coroutines, -which come inside the table @defid{coroutine}. -See @See{coroutine} for a general description of coroutines. - - -@LibEntry{coroutine.close (co)| - -Closes coroutine @id{co}, -that is, -closes all its pending to-be-closed variables -and puts the coroutine in a dead state. -The given coroutine must be dead or suspended. -In case of error -(either the original error that stopped the coroutine or -errors in closing methods), -returns @false plus the error object; -otherwise returns @true. - -} - -@LibEntry{coroutine.create (f)| - -Creates a new coroutine, with body @id{f}. -@id{f} must be a function. -Returns this new coroutine, -an object with type @T{"thread"}. - -} - -@LibEntry{coroutine.isyieldable ([co])| - -Returns @true when the coroutine @id{co} can yield. -The default for @id{co} is the running coroutine. - -A coroutine is yieldable if it is not the main thread and -it is not inside a non-yieldable @N{C function}. - -} - -@LibEntry{coroutine.resume (co [, val1, @Cdots])| - -Starts or continues the execution of coroutine @id{co}. -The first time you resume a coroutine, -it starts running its body. -The values @id{val1}, @ldots are passed -as the arguments to the body function. -If the coroutine has yielded, -@id{resume} restarts it; -the values @id{val1}, @ldots are passed -as the results from the yield. - -If the coroutine runs without any errors, -@id{resume} returns @true plus any values passed to @id{yield} -(when the coroutine yields) or any values returned by the body function -(when the coroutine terminates). -If there is any error, -@id{resume} returns @false plus the error message. - -} - -@LibEntry{coroutine.running ()| - -Returns the running coroutine plus a boolean, -@true when the running coroutine is the main one. - -} - -@LibEntry{coroutine.status (co)| - -Returns the status of the coroutine @id{co}, as a string: -@T{"running"}, -if the coroutine is running -(that is, it is the one that called @id{status}); -@T{"suspended"}, if the coroutine is suspended in a call to @id{yield}, -or if it has not started running yet; -@T{"normal"} if the coroutine is active but not running -(that is, it has resumed another coroutine); -and @T{"dead"} if the coroutine has finished its body function, -or if it has stopped with an error. - -} - -@LibEntry{coroutine.wrap (f)| - -Creates a new coroutine, with body @id{f}; -@id{f} must be a function. -Returns a function that resumes the coroutine each time it is called. -Any arguments passed to this function behave as the -extra arguments to @id{resume}. -The function returns the same values returned by @id{resume}, -except the first boolean. -In case of error, -the function closes the coroutine and propagates the error. - -} - -@LibEntry{coroutine.yield (@Cdots)| - -Suspends the execution of the calling coroutine. -Any arguments to @id{yield} are passed as extra results to @id{resume}. - -} - -} - -@sect2{packlib| @title{Modules} - -The package library provides basic -facilities for loading modules in Lua. -It exports one function directly in the global environment: -@Lid{require}. -Everything else is exported in the table @defid{package}. - - -@LibEntry{require (modname)| - -Loads the given module. -The function starts by looking into the @Lid{package.loaded} table -to determine whether @id{modname} is already loaded. -If it is, then @id{require} returns the value stored -at @T{package.loaded[modname]}. -(The absence of a second result in this case -signals that this call did not have to load the module.) -Otherwise, it tries to find a @emph{loader} for the module. - -To find a loader, -@id{require} is guided by the table @Lid{package.searchers}. -Each item in this table is a search function, -that searches for the module in a particular way. -By changing this table, -we can change how @id{require} looks for a module. -The following explanation is based on the default configuration -for @Lid{package.searchers}. - -First @id{require} queries @T{package.preload[modname]}. -If it has a value, -this value (which must be a function) is the loader. -Otherwise @id{require} searches for a Lua loader using the -path stored in @Lid{package.path}. -If that also fails, it searches for a @N{C loader} using the -path stored in @Lid{package.cpath}. -If that also fails, -it tries an @emph{all-in-one} loader @seeF{package.searchers}. - -Once a loader is found, -@id{require} calls the loader with two arguments: -@id{modname} and an extra value, -a @emph{loader data}, -also returned by the searcher. -The loader data can be any value useful to the module; -for the default searchers, -it indicates where the loader was found. -(For instance, if the loader came from a file, -this extra value is the file path.) -If the loader returns any non-nil value, -@id{require} assigns the returned value to @T{package.loaded[modname]}. -If the loader does not return a non-nil value and -has not assigned any value to @T{package.loaded[modname]}, -then @id{require} assigns @true to this entry. -In any case, @id{require} returns the -final value of @T{package.loaded[modname]}. -Besides that value, @id{require} also returns as a second result -the loader data returned by the searcher, -which indicates how @id{require} found the module. - -If there is any error loading or running the module, -or if it cannot find any loader for the module, -then @id{require} raises an error. - -} - -@LibEntry{package.config| - -A string describing some compile-time configurations for packages. -This string is a sequence of lines: -@itemize{ - -@item{The first line is the @x{directory separator} string. -Default is @Char{\} for @x{Windows} and @Char{/} for all other systems.} - -@item{The second line is the character that separates templates in a path. -Default is @Char{;}.} - -@item{The third line is the string that marks the -substitution points in a template. -Default is @Char{?}.} - -@item{The fourth line is a string that, in a path in @x{Windows}, -is replaced by the executable's directory. -Default is @Char{!}.} - -@item{The fifth line is a mark to ignore all text after it -when building the @id{luaopen_} function name. -Default is @Char{-}.} - -} - -} - -@LibEntry{package.cpath| - -A string with the path used by @Lid{require} -to search for a @N{C loader}. - -Lua initializes the @N{C path} @Lid{package.cpath} in the same way -it initializes the Lua path @Lid{package.path}, -using the environment variable @defid{LUA_CPATH_5_4}, -or the environment variable @defid{LUA_CPATH}, -or a default path defined in @id{luaconf.h}. - -} - -@LibEntry{package.loaded| - -A table used by @Lid{require} to control which -modules are already loaded. -When you require a module @id{modname} and -@T{package.loaded[modname]} is not false, -@Lid{require} simply returns the value stored there. - -This variable is only a reference to the real table; -assignments to this variable do not change the -table used by @Lid{require}. -The real table is stored in the C registry @see{registry}, -indexed by the key @defid{LUA_LOADED_TABLE}, a string. - -} - -@LibEntry{package.loadlib (libname, funcname)| - -Dynamically links the host program with the @N{C library} @id{libname}. - -If @id{funcname} is @St{*}, -then it only links with the library, -making the symbols exported by the library -available to other dynamically linked libraries. -Otherwise, -it looks for a function @id{funcname} inside the library -and returns this function as a @N{C function}. -So, @id{funcname} must follow the @Lid{lua_CFunction} prototype -@seeC{lua_CFunction}. - -This is a low-level function. -It completely bypasses the package and module system. -Unlike @Lid{require}, -it does not perform any path searching and -does not automatically adds extensions. -@id{libname} must be the complete file name of the @N{C library}, -including if necessary a path and an extension. -@id{funcname} must be the exact name exported by the @N{C library} -(which may depend on the @N{C compiler} and linker used). - -This functionality is not supported by @N{ISO C}. -As such, it is only available on some platforms -(Windows, Linux, Mac OS X, Solaris, BSD, -plus other Unix systems that support the @id{dlfcn} standard). - -This function is inherently insecure, -as it allows Lua to call any function in any readable dynamic -library in the system. -(Lua calls any function assuming the function -has a proper prototype and respects a proper protocol -@see{lua_CFunction}. -Therefore, -calling an arbitrary function in an arbitrary dynamic library -more often than not results in an access violation.) - -} - -@LibEntry{package.path| - -A string with the path used by @Lid{require} -to search for a Lua loader. - -At start-up, Lua initializes this variable with -the value of the environment variable @defid{LUA_PATH_5_4} or -the environment variable @defid{LUA_PATH} or -with a default path defined in @id{luaconf.h}, -if those environment variables are not defined. -A @St{;;} in the value of the environment variable -is replaced by the default path. - -} - -@LibEntry{package.preload| - -A table to store loaders for specific modules -@seeF{require}. - -This variable is only a reference to the real table; -assignments to this variable do not change the -table used by @Lid{require}. -The real table is stored in the C registry @see{registry}, -indexed by the key @defid{LUA_PRELOAD_TABLE}, a string. - -} - -@LibEntry{package.searchers| - -A table used by @Lid{require} to control how to find modules. - -Each entry in this table is a @def{searcher function}. -When looking for a module, -@Lid{require} calls each of these searchers in ascending order, -with the module name (the argument given to @Lid{require}) as its -sole argument. -If the searcher finds the module, -it returns another function, the module @def{loader}, -plus an extra value, a @emph{loader data}, -that will be passed to that loader and -returned as a second result by @Lid{require}. -If it cannot find the module, -it returns a string explaining why -(or @nil if it has nothing to say). - -Lua initializes this table with four searcher functions. - -The first searcher simply looks for a loader in the -@Lid{package.preload} table. - -The second searcher looks for a loader as a Lua library, -using the path stored at @Lid{package.path}. -The search is done as described in function @Lid{package.searchpath}. - -The third searcher looks for a loader as a @N{C library}, -using the path given by the variable @Lid{package.cpath}. -Again, -the search is done as described in function @Lid{package.searchpath}. -For instance, -if the @N{C path} is the string -@verbatim{ -"./?.so;./?.dll;/usr/local/?/init.so" -} -the searcher for module @id{foo} -will try to open the files @T{./foo.so}, @T{./foo.dll}, -and @T{/usr/local/foo/init.so}, in that order. -Once it finds a @N{C library}, -this searcher first uses a dynamic link facility to link the -application with the library. -Then it tries to find a @N{C function} inside the library to -be used as the loader. -The name of this @N{C function} is the string @St{luaopen_} -concatenated with a copy of the module name where each dot -is replaced by an underscore. -Moreover, if the module name has a hyphen, -its suffix after (and including) the first hyphen is removed. -For instance, if the module name is @id{a.b.c-v2.1}, -the function name will be @id{luaopen_a_b_c}. - -The fourth searcher tries an @def{all-in-one loader}. -It searches the @N{C path} for a library for -the root name of the given module. -For instance, when requiring @id{a.b.c}, -it will search for a @N{C library} for @id{a}. -If found, it looks into it for an open function for -the submodule; -in our example, that would be @id{luaopen_a_b_c}. -With this facility, a package can pack several @N{C submodules} -into one single library, -with each submodule keeping its original open function. - -All searchers except the first one (preload) return as the extra value -the file path where the module was found, -as returned by @Lid{package.searchpath}. -The first searcher always returns the string @St{:preload:}. - -Searchers should raise no errors and have no side effects in Lua. -(They may have side effects in C, -for instance by linking the application with a library.) - -} - -@LibEntry{package.searchpath (name, path [, sep [, rep]])| - -Searches for the given @id{name} in the given @id{path}. - -A path is a string containing a sequence of -@emph{templates} separated by semicolons. -For each template, -the function replaces each interrogation mark (if any) -in the template with a copy of @id{name} -wherein all occurrences of @id{sep} -(a dot, by default) -were replaced by @id{rep} -(the system's directory separator, by default), -and then tries to open the resulting file name. - -For instance, if the path is the string -@verbatim{ -"./?.lua;./?.lc;/usr/local/?/init.lua" -} -the search for the name @id{foo.a} -will try to open the files -@T{./foo/a.lua}, @T{./foo/a.lc}, and -@T{/usr/local/foo/a/init.lua}, in that order. - -Returns the resulting name of the first file that it can -open in read mode (after closing the file), -or @fail plus an error message if none succeeds. -(This error message lists all file names it tried to open.) - -} - -} - -@sect2{strlib| @title{String Manipulation} - -@simplesect{ - -This library provides generic functions for string manipulation, -such as finding and extracting substrings, and pattern matching. -When indexing a string in Lua, the first character is at @N{position 1} -(not @N{at 0}, as in C). -Indices are allowed to be negative and are interpreted as indexing backwards, -from the end of the string. -Thus, the last character is at position @num{-1}, and so on. - -The string library provides all its functions inside the table -@defid{string}. -It also sets a @x{metatable for strings} -where the @idx{__index} field points to the @id{string} table. -Therefore, you can use the string functions in object-oriented style. -For instance, @T{string.byte(s,i)} -can be written as @T{s:byte(i)}. - -The string library assumes one-byte character encodings. - - -@LibEntry{string.byte (s [, i [, j]])| -Returns the internal numeric codes of the characters @T{s[i]}, -@T{s[i+1]}, @ldots, @T{s[j]}. -The default value for @id{i} @N{is 1}; -the default value for @id{j} @N{is @id{i}}. -These indices are corrected -following the same rules of function @Lid{string.sub}. - -Numeric codes are not necessarily portable across platforms. - -} - -@LibEntry{string.char (@Cdots)| -Receives zero or more integers. -Returns a string with length equal to the number of arguments, -in which each character has the internal numeric code equal -to its corresponding argument. - -Numeric codes are not necessarily portable across platforms. - -} - -@LibEntry{string.dump (function [, strip])| - -Returns a string containing a binary representation -(a @emph{binary chunk}) -of the given function, -so that a later @Lid{load} on this string returns -a copy of the function (but with new upvalues). -If @id{strip} is a true value, -the binary representation may not include all debug information -about the function, -to save space. - -Functions with upvalues have only their number of upvalues saved. -When (re)loaded, -those upvalues receive fresh instances. -(See the @Lid{load} function for details about -how these upvalues are initialized. -You can use the debug library to serialize -and reload the upvalues of a function -in a way adequate to your needs.) - -} - -@LibEntry{string.find (s, pattern [, init [, plain]])| - -Looks for the first match of -@id{pattern} @see{pm} in the string @id{s}. -If it finds a match, then @id{find} returns the indices @N{of @T{s}} -where this occurrence starts and ends; -otherwise, it returns @fail. -A third, optional numeric argument @id{init} specifies -where to start the search; -its default value @N{is 1} and can be negative. -A @true as a fourth, optional argument @id{plain} -turns off the pattern matching facilities, -so the function does a plain @Q{find substring} operation, -with no characters in @id{pattern} being considered magic. - -If the pattern has captures, -then in a successful match -the captured values are also returned, -after the two indices. - -} - -@LibEntry{string.format (formatstring, @Cdots)| - -Returns a formatted version of its variable number of arguments -following the description given in its first argument, -which must be a string. -The format string follows the same rules as the @ANSI{sprintf}. -The only differences are that the conversion specifiers and modifiers -@id{F}, @id{n}, @T{*}, @id{h}, @id{L}, and @id{l} are not supported -and that there is an extra specifier, @id{q}. -Both width and precision, when present, -are limited to two digits. - -The specifier @id{q} formats booleans, nil, numbers, and strings -in a way that the result is a valid constant in Lua source code. -Booleans and nil are written in the obvious way -(@id{true}, @id{false}, @id{nil}). -Floats are written in hexadecimal, -to preserve full precision. -A string is written between double quotes, -using escape sequences when necessary to ensure that -it can safely be read back by the Lua interpreter. -For instance, the call -@verbatim{ -string.format('%q', 'a string with "quotes" and \n new line') -} -may produce the string: -@verbatim{ -"a string with \"quotes\" and \ - new line" -} -This specifier does not support modifiers (flags, width, precision). - -The conversion specifiers -@id{A}, @id{a}, @id{E}, @id{e}, @id{f}, -@id{G}, and @id{g} all expect a number as argument. -The specifiers @id{c}, @id{d}, -@id{i}, @id{o}, @id{u}, @id{X}, and @id{x} -expect an integer. -When Lua is compiled with a C89 compiler, -the specifiers @id{A} and @id{a} (hexadecimal floats) -do not support modifiers. - -The specifier @id{s} expects a string; -if its argument is not a string, -it is converted to one following the same rules of @Lid{tostring}. -If the specifier has any modifier, -the corresponding string argument should not contain @x{embedded zeros}. - -The specifier @id{p} formats the pointer -returned by @Lid{lua_topointer}. -That gives a unique string identifier for tables, userdata, -threads, strings, and functions. -For other values (numbers, nil, booleans), -this specifier results in a string representing -the pointer @id{NULL}. - -} - -@LibEntry{string.gmatch (s, pattern [, init])| -Returns an iterator function that, -each time it is called, -returns the next captures from @id{pattern} @see{pm} -over the string @id{s}. -If @id{pattern} specifies no captures, -then the whole match is produced in each call. -A third, optional numeric argument @id{init} specifies -where to start the search; -its default value @N{is 1} and can be negative. - -As an example, the following loop -will iterate over all the words from string @id{s}, -printing one per line: -@verbatim{ -s = "hello world from Lua" -for w in string.gmatch(s, "%a+") do - print(w) -end -} -The next example collects all pairs @T{key=value} from the -given string into a table: -@verbatim{ -t = {} -s = "from=world, to=Lua" -for k, v in string.gmatch(s, "(%w+)=(%w+)") do - t[k] = v -end -} - -For this function, a caret @Char{^} at the start of a pattern does not -work as an anchor, as this would prevent the iteration. - -} - -@LibEntry{string.gsub (s, pattern, repl [, n])| -Returns a copy of @id{s} -in which all (or the first @id{n}, if given) -occurrences of the @id{pattern} @see{pm} have been -replaced by a replacement string specified by @id{repl}, -which can be a string, a table, or a function. -@id{gsub} also returns, as its second value, -the total number of matches that occurred. -The name @id{gsub} comes from @emph{Global SUBstitution}. - -If @id{repl} is a string, then its value is used for replacement. -The @N{character @T{%}} works as an escape character: -any sequence in @id{repl} of the form @T{%@rep{d}}, -with @rep{d} between 1 and 9, -stands for the value of the @rep{d}-th captured substring; -the sequence @T{%0} stands for the whole match; -the sequence @T{%%} stands for a @N{single @T{%}}. - -If @id{repl} is a table, then the table is queried for every match, -using the first capture as the key. - -If @id{repl} is a function, then this function is called every time a -match occurs, with all captured substrings passed as arguments, -in order. - -In any case, -if the pattern specifies no captures, -then it behaves as if the whole pattern was inside a capture. - -If the value returned by the table query or by the function call -is a string or a number, -then it is used as the replacement string; -otherwise, if it is @Rw{false} or @nil, -then there is no replacement -(that is, the original match is kept in the string). - -Here are some examples: -@verbatim{ -x = string.gsub("hello world", "(%w+)", "%1 %1") ---> x="hello hello world world" - -x = string.gsub("hello world", "%w+", "%0 %0", 1) ---> x="hello hello world" - -x = string.gsub("hello world from Lua", "(%w+)%s*(%w+)", "%2 %1") ---> x="world hello Lua from" - -x = string.gsub("home = $HOME, user = $USER", "%$(%w+)", os.getenv) ---> x="home = /home/roberto, user = roberto" - -x = string.gsub("4+5 = $return 4+5$", "%$(.-)%$", function (s) - return load(s)() - end) ---> x="4+5 = 9" - -local t = {name="lua", version="5.4"} -x = string.gsub("$name-$version.tar.gz", "%$(%w+)", t) ---> x="lua-5.4.tar.gz" -} - -} - -@LibEntry{string.len (s)| - -Receives a string and returns its length. -The empty string @T{""} has length 0. -Embedded zeros are counted, -so @T{"a\000bc\000"} has length 5. - -} - -@LibEntry{string.lower (s)| - -Receives a string and returns a copy of this string with all -uppercase letters changed to lowercase. -All other characters are left unchanged. -The definition of what an uppercase letter is depends on the current locale. - -} - -@LibEntry{string.match (s, pattern [, init])| - -Looks for the first @emph{match} of -the @id{pattern} @see{pm} in the string @id{s}. -If it finds one, then @id{match} returns -the captures from the pattern; -otherwise it returns @fail. -If @id{pattern} specifies no captures, -then the whole match is returned. -A third, optional numeric argument @id{init} specifies -where to start the search; -its default value @N{is 1} and can be negative. - -} - -@LibEntry{string.pack (fmt, v1, v2, @Cdots)| - -Returns a binary string containing the values @id{v1}, @id{v2}, etc. -serialized in binary form (packed) -according to the format string @id{fmt} @see{pack}. - -} - -@LibEntry{string.packsize (fmt)| - -Returns the length of a string resulting from @Lid{string.pack} -with the given format. -The format string cannot have the variable-length options -@Char{s} or @Char{z} @see{pack}. - -} - -@LibEntry{string.rep (s, n [, sep])| - -Returns a string that is the concatenation of @id{n} copies of -the string @id{s} separated by the string @id{sep}. -The default value for @id{sep} is the empty string -(that is, no separator). -Returns the empty string if @id{n} is not positive. - -(Note that it is very easy to exhaust the memory of your machine -with a single call to this function.) - -} - -@LibEntry{string.reverse (s)| - -Returns a string that is the string @id{s} reversed. - -} - -@LibEntry{string.sub (s, i [, j])| - -Returns the substring of @id{s} that -starts at @id{i} and continues until @id{j}; -@id{i} and @id{j} can be negative. -If @id{j} is absent, then it is assumed to be equal to @num{-1} -(which is the same as the string length). -In particular, -the call @T{string.sub(s,1,j)} returns a prefix of @id{s} -with length @id{j}, -and @T{string.sub(s, -i)} (for a positive @id{i}) -returns a suffix of @id{s} -with length @id{i}. - -If, after the translation of negative indices, -@id{i} is less than 1, -it is corrected to 1. -If @id{j} is greater than the string length, -it is corrected to that length. -If, after these corrections, -@id{i} is greater than @id{j}, -the function returns the empty string. - -} - -@LibEntry{string.unpack (fmt, s [, pos])| - -Returns the values packed in string @id{s} @seeF{string.pack} -according to the format string @id{fmt} @see{pack}. -An optional @id{pos} marks where -to start reading in @id{s} (default is 1). -After the read values, -this function also returns the index of the first unread byte in @id{s}. - -} - -@LibEntry{string.upper (s)| - -Receives a string and returns a copy of this string with all -lowercase letters changed to uppercase. -All other characters are left unchanged. -The definition of what a lowercase letter is depends on the current locale. - -} - -} - - -@sect3{pm| @title{Patterns} - -@simplesect{ - -Patterns in Lua are described by regular strings, -which are interpreted as patterns by the pattern-matching functions -@Lid{string.find}, -@Lid{string.gmatch}, -@Lid{string.gsub}, -and @Lid{string.match}. -This section describes the syntax and the meaning -(that is, what they match) of these strings. - -} - -@sect4{@title{Character Class:} -A @def{character class} is used to represent a set of characters. -The following combinations are allowed in describing a character class: -@description{ - -@item{@rep{x}| -(where @rep{x} is not one of the @emphx{magic characters} -@T{^$()%.[]*+-?}) -represents the character @emph{x} itself. -} - -@item{@T{.}| (a dot) represents all characters.} - -@item{@T{%a}| represents all letters.} - -@item{@T{%c}| represents all control characters.} - -@item{@T{%d}| represents all digits.} - -@item{@T{%g}| represents all printable characters except space.} - -@item{@T{%l}| represents all lowercase letters.} - -@item{@T{%p}| represents all punctuation characters.} - -@item{@T{%s}| represents all space characters.} - -@item{@T{%u}| represents all uppercase letters.} - -@item{@T{%w}| represents all alphanumeric characters.} - -@item{@T{%x}| represents all hexadecimal digits.} - -@item{@T{%@rep{x}}| (where @rep{x} is any non-alphanumeric character) -represents the character @rep{x}. -This is the standard way to escape the magic characters. -Any non-alphanumeric character -(including all punctuation characters, even the non-magical) -can be preceded by a @Char{%} to represent itself in a pattern. -} - -@item{@T{[@rep{set}]}| -represents the class which is the union of all -characters in @rep{set}. -A range of characters can be specified by -separating the end characters of the range, -in ascending order, with a @Char{-}. -All classes @T{%}@emph{x} described above can also be used as -components in @rep{set}. -All other characters in @rep{set} represent themselves. -For example, @T{[%w_]} (or @T{[_%w]}) -represents all alphanumeric characters plus the underscore, -@T{[0-7]} represents the octal digits, -and @T{[0-7%l%-]} represents the octal digits plus -the lowercase letters plus the @Char{-} character. - -You can put a closing square bracket in a set -by positioning it as the first character in the set. -You can put a hyphen in a set -by positioning it as the first or the last character in the set. -(You can also use an escape for both cases.) - -The interaction between ranges and classes is not defined. -Therefore, patterns like @T{[%a-z]} or @T{[a-%%]} -have no meaning. -} - -@item{@T{[^@rep{set}]}| -represents the complement of @rep{set}, -where @rep{set} is interpreted as above. -} - -} -For all classes represented by single letters (@T{%a}, @T{%c}, etc.), -the corresponding uppercase letter represents the complement of the class. -For instance, @T{%S} represents all non-space characters. - -The definitions of letter, space, and other character groups -depend on the current locale. -In particular, the class @T{[a-z]} may not be equivalent to @T{%l}. - -} - -@sect4{@title{Pattern Item:} -A @def{pattern item} can be -@itemize{ - -@item{ -a single character class, -which matches any single character in the class; -} - -@item{ -a single character class followed by @Char{*}, -which matches sequences of zero or more characters in the class. -These repetition items will always match the longest possible sequence; -} - -@item{ -a single character class followed by @Char{+}, -which matches sequences of one or more characters in the class. -These repetition items will always match the longest possible sequence; -} - -@item{ -a single character class followed by @Char{-}, -which also matches sequences of zero or more characters in the class. -Unlike @Char{*}, -these repetition items will always match the shortest possible sequence; -} - -@item{ -a single character class followed by @Char{?}, -which matches zero or one occurrence of a character in the class. -It always matches one occurrence if possible; -} - -@item{ -@T{%@rep{n}}, for @rep{n} between 1 and 9; -such item matches a substring equal to the @rep{n}-th captured string -(see below); -} - -@item{ -@T{%b@rep{xy}}, where @rep{x} and @rep{y} are two distinct characters; -such item matches strings that start @N{with @rep{x}}, end @N{with @rep{y}}, -and where the @rep{x} and @rep{y} are @emph{balanced}. -This means that, if one reads the string from left to right, -counting @M{+1} for an @rep{x} and @M{-1} for a @rep{y}, -the ending @rep{y} is the first @rep{y} where the count reaches 0. -For instance, the item @T{%b()} matches expressions with -balanced parentheses. -} - -@item{ -@T{%f[@rep{set}]}, a @def{frontier pattern}; -such item matches an empty string at any position such that -the next character belongs to @rep{set} -and the previous character does not belong to @rep{set}. -The set @rep{set} is interpreted as previously described. -The beginning and the end of the subject are handled as if -they were the character @Char{\0}. -} - -} - -} - -@sect4{@title{Pattern:} -A @def{pattern} is a sequence of pattern items. -A caret @Char{^} at the beginning of a pattern anchors the match at the -beginning of the subject string. -A @Char{$} at the end of a pattern anchors the match at the -end of the subject string. -At other positions, -@Char{^} and @Char{$} have no special meaning and represent themselves. - -} - -@sect4{@title{Captures:} -A pattern can contain sub-patterns enclosed in parentheses; -they describe @def{captures}. -When a match succeeds, the substrings of the subject string -that match captures are stored (@emph{captured}) for future use. -Captures are numbered according to their left parentheses. -For instance, in the pattern @T{"(a*(.)%w(%s*))"}, -the part of the string matching @T{"a*(.)%w(%s*)"} is -stored as the first capture, and therefore has @N{number 1}; -the character matching @St{.} is captured with @N{number 2}, -and the part matching @St{%s*} has @N{number 3}. - -As a special case, the capture @T{()} captures -the current string position (a number). -For instance, if we apply the pattern @T{"()aa()"} on the -string @T{"flaaap"}, there will be two captures: @N{3 and 5}. - -} - -@sect4{@title{Multiple matches:} -The function @Lid{string.gsub} and the iterator @Lid{string.gmatch} -match multiple occurrences of the given pattern in the subject. -For these functions, -a new match is considered valid only -if it ends at least one byte after the end of the previous match. -In other words, the pattern machine never accepts the -empty string as a match immediately after another match. -As an example, -consider the results of the following code: -@verbatim{ -> string.gsub("abc", "()a*()", print); ---> 1 2 ---> 3 3 ---> 4 4 -} -The second and third results come from Lua matching an empty -string after @Char{b} and another one after @Char{c}. -Lua does not match an empty string after @Char{a}, -because it would end at the same position of the previous match. - -} - -} - -@sect3{pack| @title{Format Strings for Pack and Unpack} - -The first argument to @Lid{string.pack}, -@Lid{string.packsize}, and @Lid{string.unpack} -is a format string, -which describes the layout of the structure being created or read. - -A format string is a sequence of conversion options. -The conversion options are as follows: -@description{ -@item{@T{<}|sets little endian} -@item{@T{>}|sets big endian} -@item{@T{=}|sets native endian} -@item{@T{![@rep{n}]}|sets maximum alignment to @id{n} -(default is native alignment)} -@item{@T{b}|a signed byte (@id{char})} -@item{@T{B}|an unsigned byte (@id{char})} -@item{@T{h}|a signed @id{short} (native size)} -@item{@T{H}|an unsigned @id{short} (native size)} -@item{@T{l}|a signed @id{long} (native size)} -@item{@T{L}|an unsigned @id{long} (native size)} -@item{@T{j}|a @id{lua_Integer}} -@item{@T{J}|a @id{lua_Unsigned}} -@item{@T{T}|a @id{size_t} (native size)} -@item{@T{i[@rep{n}]}|a signed @id{int} with @id{n} bytes -(default is native size)} -@item{@T{I[@rep{n}]}|an unsigned @id{int} with @id{n} bytes -(default is native size)} -@item{@T{f}|a @id{float} (native size)} -@item{@T{d}|a @id{double} (native size)} -@item{@T{n}|a @id{lua_Number}} -@item{@T{c@rep{n}}|a fixed-sized string with @id{n} bytes} -@item{@T{z}|a zero-terminated string} -@item{@T{s[@emph{n}]}|a string preceded by its length -coded as an unsigned integer with @id{n} bytes -(default is a @id{size_t})} -@item{@T{x}|one byte of padding} -@item{@T{X@rep{op}}|an empty item that aligns -according to option @id{op} -(which is otherwise ignored)} -@item{@Char{ }|(space) ignored} -} -(A @St{[@rep{n}]} means an optional integral numeral.) -Except for padding, spaces, and configurations -(options @St{xX <=>!}), -each option corresponds to an argument in @Lid{string.pack} -or a result in @Lid{string.unpack}. - -For options @St{!@rep{n}}, @St{s@rep{n}}, @St{i@rep{n}}, and @St{I@rep{n}}, -@id{n} can be any integer between 1 and 16. -All integral options check overflows; -@Lid{string.pack} checks whether the given value fits in the given size; -@Lid{string.unpack} checks whether the read value fits in a Lua integer. -For the unsigned options, -Lua integers are treated as unsigned values too. - -Any format string starts as if prefixed by @St{!1=}, -that is, -with maximum alignment of 1 (no alignment) -and native endianness. - -Native endianness assumes that the whole system is -either big or little endian. -The packing functions will not emulate correctly the behavior -of mixed-endian formats. - -Alignment works as follows: -For each option, -the format gets extra padding until the data starts -at an offset that is a multiple of the minimum between the -option size and the maximum alignment; -this minimum must be a power of 2. -Options @St{c} and @St{z} are not aligned; -option @St{s} follows the alignment of its starting integer. - - -All padding is filled with zeros by @Lid{string.pack} -and ignored by @Lid{string.unpack}. - -} - -} - -@sect2{utf8| @title{UTF-8 Support} - -This library provides basic support for @x{UTF-8} encoding. -It provides all its functions inside the table @defid{utf8}. -This library does not provide any support for @x{Unicode} other -than the handling of the encoding. -Any operation that needs the meaning of a character, -such as character classification, is outside its scope. - -Unless stated otherwise, -all functions that expect a byte position as a parameter -assume that the given position is either the start of a byte sequence -or one plus the length of the subject string. -As in the string library, -negative indices count from the end of the string. - -Functions that create byte sequences -accept all values up to @T{0x7FFFFFFF}, -as defined in the original UTF-8 specification; -that implies byte sequences of up to six bytes. - -Functions that interpret byte sequences only accept -valid sequences (well formed and not overlong). -By default, they only accept byte sequences -that result in valid Unicode code points, -rejecting values greater than @T{10FFFF} and surrogates. -A boolean argument @id{lax}, when available, -lifts these checks, -so that all values up to @T{0x7FFFFFFF} are accepted. -(Not well formed and overlong sequences are still rejected.) - - -@LibEntry{utf8.char (@Cdots)| - -Receives zero or more integers, -converts each one to its corresponding UTF-8 byte sequence -and returns a string with the concatenation of all these sequences. - -} - -@LibEntry{utf8.charpattern| - -The pattern (a string, not a function) @St{[\0-\x7F\xC2-\xFD][\x80-\xBF]*} -@see{pm}, -which matches exactly one UTF-8 byte sequence, -assuming that the subject is a valid UTF-8 string. - -} - -@LibEntry{utf8.codes (s [, lax])| - -Returns values so that the construction -@verbatim{ -for p, c in utf8.codes(s) do @rep{body} end -} -will iterate over all UTF-8 characters in string @id{s}, -with @id{p} being the position (in bytes) and @id{c} the code point -of each character. -It raises an error if it meets any invalid byte sequence. - -} - -@LibEntry{utf8.codepoint (s [, i [, j [, lax]]])| - -Returns the code points (as integers) from all characters in @id{s} -that start between byte position @id{i} and @id{j} (both included). -The default for @id{i} is 1 and for @id{j} is @id{i}. -It raises an error if it meets any invalid byte sequence. - -} - -@LibEntry{utf8.len (s [, i [, j [, lax]]])| - -Returns the number of UTF-8 characters in string @id{s} -that start between positions @id{i} and @id{j} (both inclusive). -The default for @id{i} is @num{1} and for @id{j} is @num{-1}. -If it finds any invalid byte sequence, -returns @fail plus the position of the first invalid byte. - -} - -@LibEntry{utf8.offset (s, n [, i])| - -Returns the position (in bytes) where the encoding of the -@id{n}-th character of @id{s} -(counting from position @id{i}) starts. -A negative @id{n} gets characters before position @id{i}. -The default for @id{i} is 1 when @id{n} is non-negative -and @T{#s + 1} otherwise, -so that @T{utf8.offset(s, -n)} gets the offset of the -@id{n}-th character from the end of the string. -If the specified character is neither in the subject -nor right after its end, -the function returns @fail. - -As a special case, -when @id{n} is 0 the function returns the start of the encoding -of the character that contains the @id{i}-th byte of @id{s}. - -This function assumes that @id{s} is a valid UTF-8 string. - -} - -} - -@sect2{tablib| @title{Table Manipulation} - -This library provides generic functions for table manipulation. -It provides all its functions inside the table @defid{table}. - -Remember that, whenever an operation needs the length of a table, -all caveats about the length operator apply @see{len-op}. -All functions ignore non-numeric keys -in the tables given as arguments. - - -@LibEntry{table.concat (list [, sep [, i [, j]]])| - -Given a list where all elements are strings or numbers, -returns the string @T{list[i]..sep..list[i+1] @Cdots sep..list[j]}. -The default value for @id{sep} is the empty string, -the default for @id{i} is 1, -and the default for @id{j} is @T{#list}. -If @id{i} is greater than @id{j}, returns the empty string. - -} - -@LibEntry{table.insert (list, [pos,] value)| - -Inserts element @id{value} at position @id{pos} in @id{list}, -shifting up the elements -@T{list[pos], list[pos+1], @Cdots, list[#list]}. -The default value for @id{pos} is @T{#list+1}, -so that a call @T{table.insert(t,x)} inserts @id{x} at the end -of the list @id{t}. - -} - -@LibEntry{table.move (a1, f, e, t [,a2])| - -Moves elements from the table @id{a1} to the table @id{a2}, -performing the equivalent to the following -multiple assignment: -@T{a2[t],@Cdots = a1[f],@Cdots,a1[e]}. -The default for @id{a2} is @id{a1}. -The destination range can overlap with the source range. -The number of elements to be moved must fit in a Lua integer. - -Returns the destination table @id{a2}. - -} - -@LibEntry{table.pack (@Cdots)| - -Returns a new table with all arguments stored into keys 1, 2, etc. -and with a field @St{n} with the total number of arguments. -Note that the resulting table may not be a sequence, -if some arguments are @nil. - -} - -@LibEntry{table.remove (list [, pos])| - -Removes from @id{list} the element at position @id{pos}, -returning the value of the removed element. -When @id{pos} is an integer between 1 and @T{#list}, -it shifts down the elements -@T{list[pos+1], list[pos+2], @Cdots, list[#list]} -and erases element @T{list[#list]}; -The index @id{pos} can also be 0 when @T{#list} is 0, -or @T{#list + 1}. - -The default value for @id{pos} is @T{#list}, -so that a call @T{table.remove(l)} removes the last element -of the list @id{l}. - -} - -@LibEntry{table.sort (list [, comp])| - -Sorts the list elements in a given order, @emph{in-place}, -from @T{list[1]} to @T{list[#list]}. -If @id{comp} is given, -then it must be a function that receives two list elements -and returns true when the first element must come -before the second in the final order, -so that, after the sort, -@T{i <= j} implies @T{not comp(list[j],list[i])}. -If @id{comp} is not given, -then the standard Lua operator @T{<} is used instead. - -The @id{comp} function must define a consistent order; -more formally, the function must define a strict weak order. -(A weak order is similar to a total order, -but it can equate different elements for comparison purposes.) - -The sort algorithm is not stable: -Different elements considered equal by the given order -may have their relative positions changed by the sort. - -} - -@LibEntry{table.unpack (list [, i [, j]])| - -Returns the elements from the given list. -This function is equivalent to -@verbatim{ -return list[i], list[i+1], @Cdots, list[j] -} -By default, @id{i} @N{is 1} and @id{j} is @T{#list}. - -} - -} - -@sect2{mathlib| @title{Mathematical Functions} - -This library provides basic mathematical functions. -It provides all its functions and constants inside the table @defid{math}. -Functions with the annotation @St{integer/float} give -integer results for integer arguments -and float results for non-integer arguments. -The rounding functions -@Lid{math.ceil}, @Lid{math.floor}, and @Lid{math.modf} -return an integer when the result fits in the range of an integer, -or a float otherwise. - -@LibEntry{math.abs (x)| - -Returns the maximum value between @id{x} and @id{-x}. (integer/float) - -} - -@LibEntry{math.acos (x)| - -Returns the arc cosine of @id{x} (in radians). - -} - -@LibEntry{math.asin (x)| - -Returns the arc sine of @id{x} (in radians). - -} - -@LibEntry{math.atan (y [, x])| - -@index{atan} @index{atan2} -Returns the arc tangent of @T{y/x} (in radians), -using the signs of both arguments to find the -quadrant of the result. -It also handles correctly the case of @id{x} being zero. - -The default value for @id{x} is 1, -so that the call @T{math.atan(y)} -returns the arc tangent of @id{y}. - -} - -@LibEntry{math.ceil (x)| - -Returns the smallest integral value greater than or equal to @id{x}. - -} - -@LibEntry{math.cos (x)| - -Returns the cosine of @id{x} (assumed to be in radians). - -} - -@LibEntry{math.deg (x)| - -Converts the angle @id{x} from radians to degrees. - -} - -@LibEntry{math.exp (x)| - -Returns the value @M{e@sp{x}} -(where @id{e} is the base of natural logarithms). - -} - -@LibEntry{math.floor (x)| - -Returns the largest integral value less than or equal to @id{x}. - -} - -@LibEntry{math.fmod (x, y)| - -Returns the remainder of the division of @id{x} by @id{y} -that rounds the quotient towards zero. (integer/float) - -} - -@LibEntry{math.huge| - -The float value @idx{HUGE_VAL}, -a value greater than any other numeric value. - -} - -@LibEntry{math.log (x [, base])| - -Returns the logarithm of @id{x} in the given base. -The default for @id{base} is @M{e} -(so that the function returns the natural logarithm of @id{x}). - -} - -@LibEntry{math.max (x, @Cdots)| - -Returns the argument with the maximum value, -according to the Lua operator @T{<}. - -} - -@LibEntry{math.maxinteger| -An integer with the maximum value for an integer. - -} - -@LibEntry{math.min (x, @Cdots)| - -Returns the argument with the minimum value, -according to the Lua operator @T{<}. - -} - -@LibEntry{math.mininteger| -An integer with the minimum value for an integer. - -} - -@LibEntry{math.modf (x)| - -Returns the integral part of @id{x} and the fractional part of @id{x}. -Its second result is always a float. - -} - -@LibEntry{math.pi| - -The value of @M{@pi}. - -} - -@LibEntry{math.rad (x)| - -Converts the angle @id{x} from degrees to radians. - -} - -@LibEntry{math.random ([m [, n]])| - -When called without arguments, -returns a pseudo-random float with uniform distribution -in the range @C{(} @M{[0,1)}. @C{]} -When called with two integers @id{m} and @id{n}, -@id{math.random} returns a pseudo-random integer -with uniform distribution in the range @M{[m, n]}. -The call @T{math.random(n)}, for a positive @id{n}, -is equivalent to @T{math.random(1,n)}. -The call @T{math.random(0)} produces an integer with -all bits (pseudo)random. - -This function uses the @idx{xoshiro256**} algorithm to produce -pseudo-random 64-bit integers, -which are the results of calls with @N{argument 0}. -Other results (ranges and floats) -are unbiased extracted from these integers. - -Lua initializes its pseudo-random generator with the equivalent of -a call to @Lid{math.randomseed} with no arguments, -so that @id{math.random} should generate -different sequences of results each time the program runs. - -} - -@LibEntry{math.randomseed ([x [, y]])| - -When called with at least one argument, -the integer parameters @id{x} and @id{y} are -joined into a 128-bit @emphx{seed} that -is used to reinitialize the pseudo-random generator; -equal seeds produce equal sequences of numbers. -The default for @id{y} is zero. - -When called with no arguments, -Lua generates a seed with -a weak attempt for randomness. - -This function returns the two seed components -that were effectively used, -so that setting them again repeats the sequence. - -To ensure a required level of randomness to the initial state -(or contrarily, to have a deterministic sequence, -for instance when debugging a program), -you should call @Lid{math.randomseed} with explicit arguments. - -} - -@LibEntry{math.sin (x)| - -Returns the sine of @id{x} (assumed to be in radians). - -} - -@LibEntry{math.sqrt (x)| - -Returns the square root of @id{x}. -(You can also use the expression @T{x^0.5} to compute this value.) - -} - -@LibEntry{math.tan (x)| - -Returns the tangent of @id{x} (assumed to be in radians). - -} - -@LibEntry{math.tointeger (x)| - -If the value @id{x} is convertible to an integer, -returns that integer. -Otherwise, returns @fail. - -} - -@LibEntry{math.type (x)| - -Returns @St{integer} if @id{x} is an integer, -@St{float} if it is a float, -or @fail if @id{x} is not a number. - -} - -@LibEntry{math.ult (m, n)| - -Returns a boolean, -@true if and only if integer @id{m} is below integer @id{n} when -they are compared as @x{unsigned integers}. - -} - -} - -@sect2{iolib| @title{Input and Output Facilities} - -The I/O library provides two different styles for file manipulation. -The first one uses implicit file handles; -that is, there are operations to set a default input file and a -default output file, -and all input/output operations are done over these default files. -The second style uses explicit file handles. - -When using implicit file handles, -all operations are supplied by table @defid{io}. -When using explicit file handles, -the operation @Lid{io.open} returns a file handle -and then all operations are supplied as methods of the file handle. - -The metatable for file handles provides metamethods -for @idx{__gc} and @idx{__close} that try -to close the file when called. - -The table @id{io} also provides -three predefined file handles with their usual meanings from C: -@defid{io.stdin}, @defid{io.stdout}, and @defid{io.stderr}. -The I/O library never closes these files. - -Unless otherwise stated, -all I/O functions return @fail on failure, -plus an error message as a second result and -a system-dependent error code as a third result, -and some non-false value on success. -On non-POSIX systems, -the computation of the error message and error code -in case of errors -may be not @x{thread safe}, -because they rely on the global C variable @id{errno}. - -@LibEntry{io.close ([file])| - -Equivalent to @T{file:close()}. -Without a @id{file}, closes the default output file. - -} - -@LibEntry{io.flush ()| - -Equivalent to @T{io.output():flush()}. - -} - -@LibEntry{io.input ([file])| - -When called with a file name, it opens the named file (in text mode), -and sets its handle as the default input file. -When called with a file handle, -it simply sets this file handle as the default input file. -When called without arguments, -it returns the current default input file. - -In case of errors this function raises the error, -instead of returning an error code. - -} - -@LibEntry{io.lines ([filename, @Cdots])| - -Opens the given file name in read mode -and returns an iterator function that -works like @T{file:lines(@Cdots)} over the opened file. -When the iterator function fails to read any value, -it automatically closes the file. -Besides the iterator function, -@id{io.lines} returns three other values: -two @nil values as placeholders, -plus the created file handle. -Therefore, when used in a generic @Rw{for} loop, -the file is closed also if the loop is interrupted by an -error or a @Rw{break}. - -The call @T{io.lines()} (with no file name) is equivalent -to @T{io.input():lines("l")}; -that is, it iterates over the lines of the default input file. -In this case, the iterator does not close the file when the loop ends. - -In case of errors opening the file, -this function raises the error, -instead of returning an error code. - -} - -@LibEntry{io.open (filename [, mode])| - -This function opens a file, -in the mode specified in the string @id{mode}. -In case of success, -it returns a new file handle. - -The @id{mode} string can be any of the following: -@description{ -@item{@St{r}| read mode (the default);} -@item{@St{w}| write mode;} -@item{@St{a}| append mode;} -@item{@St{r+}| update mode, all previous data is preserved;} -@item{@St{w+}| update mode, all previous data is erased;} -@item{@St{a+}| append update mode, previous data is preserved, - writing is only allowed at the end of file.} -} -The @id{mode} string can also have a @Char{b} at the end, -which is needed in some systems to open the file in binary mode. - -} - -@LibEntry{io.output ([file])| - -Similar to @Lid{io.input}, but operates over the default output file. - -} - -@LibEntry{io.popen (prog [, mode])| - -This function is system dependent and is not available -on all platforms. - -Starts the program @id{prog} in a separated process and returns -a file handle that you can use to read data from this program -(if @id{mode} is @T{"r"}, the default) -or to write data to this program -(if @id{mode} is @T{"w"}). - -} - -@LibEntry{io.read (@Cdots)| - -Equivalent to @T{io.input():read(@Cdots)}. - -} - -@LibEntry{io.tmpfile ()| - -In case of success, -returns a handle for a temporary file. -This file is opened in update mode -and it is automatically removed when the program ends. - -} - -@LibEntry{io.type (obj)| - -Checks whether @id{obj} is a valid file handle. -Returns the string @T{"file"} if @id{obj} is an open file handle, -@T{"closed file"} if @id{obj} is a closed file handle, -or @fail if @id{obj} is not a file handle. - -} - -@LibEntry{io.write (@Cdots)| - -Equivalent to @T{io.output():write(@Cdots)}. - - -} - -@LibEntry{file:close ()| - -Closes @id{file}. -Note that files are automatically closed when -their handles are garbage collected, -but that takes an unpredictable amount of time to happen. - -When closing a file handle created with @Lid{io.popen}, -@Lid{file:close} returns the same values -returned by @Lid{os.execute}. - -} - -@LibEntry{file:flush ()| - -Saves any written data to @id{file}. - -} - -@LibEntry{file:lines (@Cdots)| - -Returns an iterator function that, -each time it is called, -reads the file according to the given formats. -When no format is given, -uses @St{l} as a default. -As an example, the construction -@verbatim{ -for c in file:lines(1) do @rep{body} end -} -will iterate over all characters of the file, -starting at the current position. -Unlike @Lid{io.lines}, this function does not close the file -when the loop ends. - -} - -@LibEntry{file:read (@Cdots)| - -Reads the file @id{file}, -according to the given formats, which specify what to read. -For each format, -the function returns a string or a number with the characters read, -or @fail if it cannot read data with the specified format. -(In this latter case, -the function does not read subsequent formats.) -When called without arguments, -it uses a default format that reads the next line -(see below). - -The available formats are -@description{ - -@item{@St{n}| -reads a numeral and returns it as a float or an integer, -following the lexical conventions of Lua. -(The numeral may have leading whitespaces and a sign.) -This format always reads the longest input sequence that -is a valid prefix for a numeral; -if that prefix does not form a valid numeral -(e.g., an empty string, @St{0x}, or @St{3.4e-}) -or it is too long (more than 200 characters), -it is discarded and the format returns @fail. -} - -@item{@St{a}| -reads the whole file, starting at the current position. -On end of file, it returns the empty string; -this format never fails. -} - -@item{@St{l}| -reads the next line skipping the end of line, -returning @fail on end of file. -This is the default format. -} - -@item{@St{L}| -reads the next line keeping the end-of-line character (if present), -returning @fail on end of file. -} - -@item{@emph{number}| -reads a string with up to this number of bytes, -returning @fail on end of file. -If @id{number} is zero, -it reads nothing and returns an empty string, -or @fail on end of file. -} - -} -The formats @St{l} and @St{L} should be used only for text files. - -} - -@LibEntry{file:seek ([whence [, offset]])| - -Sets and gets the file position, -measured from the beginning of the file, -to the position given by @id{offset} plus a base -specified by the string @id{whence}, as follows: -@description{ -@item{@St{set}| base is position 0 (beginning of the file);} -@item{@St{cur}| base is current position;} -@item{@St{end}| base is end of file;} -} -In case of success, @id{seek} returns the final file position, -measured in bytes from the beginning of the file. -If @id{seek} fails, it returns @fail, -plus a string describing the error. - -The default value for @id{whence} is @T{"cur"}, -and for @id{offset} is 0. -Therefore, the call @T{file:seek()} returns the current -file position, without changing it; -the call @T{file:seek("set")} sets the position to the -beginning of the file (and returns 0); -and the call @T{file:seek("end")} sets the position to the -end of the file, and returns its size. - -} - -@LibEntry{file:setvbuf (mode [, size])| - -Sets the buffering mode for a file. -There are three available modes: -@description{ -@item{@St{no}| no buffering.} -@item{@St{full}| full buffering.} -@item{@St{line}| line buffering.} -} - -For the last two cases, -@id{size} is a hint for the size of the buffer, in bytes. -The default is an appropriate size. - -The specific behavior of each mode is non portable; -check the underlying @ANSI{setvbuf} in your platform for -more details. - -} - -@LibEntry{file:write (@Cdots)| - -Writes the value of each of its arguments to @id{file}. -The arguments must be strings or numbers. - -In case of success, this function returns @id{file}. - -} - -} - -@sect2{oslib| @title{Operating System Facilities} - -This library is implemented through table @defid{os}. - - -@LibEntry{os.clock ()| - -Returns an approximation of the amount in seconds of CPU time -used by the program, -as returned by the underlying @ANSI{clock}. - -} - -@LibEntry{os.date ([format [, time]])| - -Returns a string or a table containing date and time, -formatted according to the given string @id{format}. - -If the @id{time} argument is present, -this is the time to be formatted -(see the @Lid{os.time} function for a description of this value). -Otherwise, @id{date} formats the current time. - -If @id{format} starts with @Char{!}, -then the date is formatted in Coordinated Universal Time. -After this optional character, -if @id{format} is the string @St{*t}, -then @id{date} returns a table with the following fields: -@id{year}, @id{month} (1@En{}12), @id{day} (1@En{}31), -@id{hour} (0@En{}23), @id{min} (0@En{}59), -@id{sec} (0@En{}61, due to leap seconds), -@id{wday} (weekday, 1@En{}7, Sunday @N{is 1}), -@id{yday} (day of the year, 1@En{}366), -and @id{isdst} (daylight saving flag, a boolean). -This last field may be absent -if the information is not available. - -If @id{format} is not @St{*t}, -then @id{date} returns the date as a string, -formatted according to the same rules as the @ANSI{strftime}. - -If @id{format} is absent, it defaults to @St{%c}, -which gives a human-readable date and time representation -using the current locale. - -On non-POSIX systems, -this function may be not @x{thread safe} -because of its reliance on @CId{gmtime} and @CId{localtime}. - -} - -@LibEntry{os.difftime (t2, t1)| - -Returns the difference, in seconds, -from time @id{t1} to time @id{t2} -(where the times are values returned by @Lid{os.time}). -In @x{POSIX}, @x{Windows}, and some other systems, -this value is exactly @id{t2}@M{-}@id{t1}. - -} - -@LibEntry{os.execute ([command])| - -This function is equivalent to the @ANSI{system}. -It passes @id{command} to be executed by an operating system shell. -Its first result is @true -if the command terminated successfully, -or @fail otherwise. -After this first result -the function returns a string plus a number, -as follows: -@description{ - -@item{@St{exit}| -the command terminated normally; -the following number is the exit status of the command. -} - -@item{@St{signal}| -the command was terminated by a signal; -the following number is the signal that terminated the command. -} - -} - -When called without a @id{command}, -@id{os.execute} returns a boolean that is true if a shell is available. - -} - -@LibEntry{os.exit ([code [, close]])| - -Calls the @ANSI{exit} to terminate the host program. -If @id{code} is @true, -the returned status is @idx{EXIT_SUCCESS}; -if @id{code} is @false, -the returned status is @idx{EXIT_FAILURE}; -if @id{code} is a number, -the returned status is this number. -The default value for @id{code} is @true. - -If the optional second argument @id{close} is true, -the function closes the Lua state before exiting @seeF{lua_close}. - -} - -@LibEntry{os.getenv (varname)| - -Returns the value of the process environment variable @id{varname} -or @fail if the variable is not defined. - -} - -@LibEntry{os.remove (filename)| - -Deletes the file (or empty directory, on @x{POSIX} systems) -with the given name. -If this function fails, it returns @fail -plus a string describing the error and the error code. -Otherwise, it returns true. - -} - -@LibEntry{os.rename (oldname, newname)| - -Renames the file or directory named @id{oldname} to @id{newname}. -If this function fails, it returns @fail, -plus a string describing the error and the error code. -Otherwise, it returns true. - -} - -@LibEntry{os.setlocale (locale [, category])| - -Sets the current locale of the program. -@id{locale} is a system-dependent string specifying a locale; -@id{category} is an optional string describing which category to change: -@T{"all"}, @T{"collate"}, @T{"ctype"}, -@T{"monetary"}, @T{"numeric"}, or @T{"time"}; -the default category is @T{"all"}. -The function returns the name of the new locale, -or @fail if the request cannot be honored. - -If @id{locale} is the empty string, -the current locale is set to an implementation-defined native locale. -If @id{locale} is the string @St{C}, -the current locale is set to the standard C locale. - -When called with @nil as the first argument, -this function only returns the name of the current locale -for the given category. - -This function may be not @x{thread safe} -because of its reliance on @CId{setlocale}. - -} - -@LibEntry{os.time ([table])| - -Returns the current time when called without arguments, -or a time representing the local date and time specified by the given table. -This table must have fields @id{year}, @id{month}, and @id{day}, -and may have fields -@id{hour} (default is 12), -@id{min} (default is 0), -@id{sec} (default is 0), -and @id{isdst} (default is @nil). -Other fields are ignored. -For a description of these fields, see the @Lid{os.date} function. - -When the function is called, -the values in these fields do not need to be inside their valid ranges. -For instance, if @id{sec} is -10, -it means 10 seconds before the time specified by the other fields; -if @id{hour} is 1000, -it means 1000 hours after the time specified by the other fields. - -The returned value is a number, whose meaning depends on your system. -In @x{POSIX}, @x{Windows}, and some other systems, -this number counts the number -of seconds since some given start time (the @Q{epoch}). -In other systems, the meaning is not specified, -and the number returned by @id{time} can be used only as an argument to -@Lid{os.date} and @Lid{os.difftime}. - -When called with a table, -@id{os.time} also normalizes all the fields -documented in the @Lid{os.date} function, -so that they represent the same time as before the call -but with values inside their valid ranges. - -} - -@LibEntry{os.tmpname ()| - -Returns a string with a file name that can -be used for a temporary file. -The file must be explicitly opened before its use -and explicitly removed when no longer needed. - -In @x{POSIX} systems, -this function also creates a file with that name, -to avoid security risks. -(Someone else might create the file with wrong permissions -in the time between getting the name and creating the file.) -You still have to open the file to use it -and to remove it (even if you do not use it). - -When possible, -you may prefer to use @Lid{io.tmpfile}, -which automatically removes the file when the program ends. - -} - -} - -@sect2{debuglib| @title{The Debug Library} - -This library provides -the functionality of the @link{debugI|debug interface} to Lua programs. -You should exert care when using this library. -Several of its functions -violate basic assumptions about Lua code -(e.g., that variables local to a function -cannot be accessed from outside; -that userdata metatables cannot be changed by Lua code; -that Lua programs do not crash) -and therefore can compromise otherwise secure code. -Moreover, some functions in this library may be slow. - -All functions in this library are provided -inside the @defid{debug} table. -All functions that operate over a thread -have an optional first argument which is the -thread to operate over. -The default is always the current thread. - - -@LibEntry{debug.debug ()| - -Enters an interactive mode with the user, -running each string that the user enters. -Using simple commands and other debug facilities, -the user can inspect global and local variables, -change their values, evaluate expressions, and so on. -A line containing only the word @id{cont} finishes this function, -so that the caller continues its execution. - -Note that commands for @id{debug.debug} are not lexically nested -within any function and so have no direct access to local variables. - -} - -@LibEntry{debug.gethook ([thread])| - -Returns the current hook settings of the thread, as three values: -the current hook function, the current hook mask, -and the current hook count, -as set by the @Lid{debug.sethook} function. - -Returns @fail if there is no active hook. - -} - -@LibEntry{debug.getinfo ([thread,] f [, what])| - -Returns a table with information about a function. -You can give the function directly -or you can give a number as the value of @id{f}, -which means the function running at level @id{f} of the call stack -of the given thread: -@N{level 0} is the current function (@id{getinfo} itself); -@N{level 1} is the function that called @id{getinfo} -(except for tail calls, which do not count in the stack); -and so on. -If @id{f} is a number greater than the number of active functions, -then @id{getinfo} returns @fail. - -The returned table can contain all the fields returned by @Lid{lua_getinfo}, -with the string @id{what} describing which fields to fill in. -The default for @id{what} is to get all information available, -except the table of valid lines. -If present, -the option @Char{f} -adds a field named @id{func} with the function itself. -If present, -the option @Char{L} -adds a field named @id{activelines} with the table of -valid lines. - -For instance, the expression @T{debug.getinfo(1,"n").name} returns -a name for the current function, -if a reasonable name can be found, -and the expression @T{debug.getinfo(print)} -returns a table with all available information -about the @Lid{print} function. - -} - -@LibEntry{debug.getlocal ([thread,] f, local)| - -This function returns the name and the value of the local variable -with index @id{local} of the function at level @id{f} of the stack. -This function accesses not only explicit local variables, -but also parameters and temporary values. - -The first parameter or local variable has @N{index 1}, and so on, -following the order that they are declared in the code, -counting only the variables that are active -in the current scope of the function. -Compile-time constants may not appear in this listing, -if they were optimized away by the compiler. -Negative indices refer to vararg arguments; -@num{-1} is the first vararg argument. -The function returns @fail -if there is no variable with the given index, -and raises an error when called with a level out of range. -(You can call @Lid{debug.getinfo} to check whether the level is valid.) - -Variable names starting with @Char{(} (open parenthesis) @C{)} -represent variables with no known names -(internal variables such as loop control variables, -and variables from chunks saved without debug information). - -The parameter @id{f} may also be a function. -In that case, @id{getlocal} returns only the name of function parameters. - -} - -@LibEntry{debug.getmetatable (value)| - -Returns the metatable of the given @id{value} -or @nil if it does not have a metatable. - -} - -@LibEntry{debug.getregistry ()| - -Returns the registry table @see{registry}. - -} - -@LibEntry{debug.getupvalue (f, up)| - -This function returns the name and the value of the upvalue -with index @id{up} of the function @id{f}. -The function returns @fail -if there is no upvalue with the given index. - -(For Lua functions, -upvalues are the external local variables that the function uses, -and that are consequently included in its closure.) - -For @N{C functions}, this function uses the empty string @T{""} -as a name for all upvalues. - -Variable name @Char{?} (interrogation mark) -represents variables with no known names -(variables from chunks saved without debug information). - -} - -@LibEntry{debug.getuservalue (u, n)| - -Returns the @id{n}-th user value associated -to the userdata @id{u} plus a boolean, -@false if the userdata does not have that value. - -} - -@LibEntry{debug.sethook ([thread,] hook, mask [, count])| - -Sets the given function as the debug hook. -The string @id{mask} and the number @id{count} describe -when the hook will be called. -The string mask may have any combination of the following characters, -with the given meaning: -@description{ -@item{@Char{c}| the hook is called every time Lua calls a function;} -@item{@Char{r}| the hook is called every time Lua returns from a function;} -@item{@Char{l}| the hook is called every time Lua enters a new line of code.} -} -Moreover, -with a @id{count} different from zero, -the hook is called also after every @id{count} instructions. - -When called without arguments, -@Lid{debug.sethook} turns off the hook. - -When the hook is called, its first parameter is a string -describing the event that has triggered its call: -@T{"call"}, @T{"tail call"}, @T{"return"}, -@T{"line"}, and @T{"count"}. -For line events, -the hook also gets the new line number as its second parameter. -Inside a hook, -you can call @id{getinfo} with @N{level 2} to get more information about -the running function. -(@N{Level 0} is the @id{getinfo} function, -and @N{level 1} is the hook function.) - -} - -@LibEntry{debug.setlocal ([thread,] level, local, value)| - -This function assigns the value @id{value} to the local variable -with index @id{local} of the function at level @id{level} of the stack. -The function returns @fail if there is no local -variable with the given index, -and raises an error when called with a @id{level} out of range. -(You can call @id{getinfo} to check whether the level is valid.) -Otherwise, it returns the name of the local variable. - -See @Lid{debug.getlocal} for more information about -variable indices and names. - -} - -@LibEntry{debug.setmetatable (value, table)| - -Sets the metatable for the given @id{value} to the given @id{table} -(which can be @nil). -Returns @id{value}. - -} - -@LibEntry{debug.setupvalue (f, up, value)| - -This function assigns the value @id{value} to the upvalue -with index @id{up} of the function @id{f}. -The function returns @fail if there is no upvalue -with the given index. -Otherwise, it returns the name of the upvalue. - -See @Lid{debug.getupvalue} for more information about upvalues. - -} - -@LibEntry{debug.setuservalue (udata, value, n)| - -Sets the given @id{value} as -the @id{n}-th user value associated to the given @id{udata}. -@id{udata} must be a full userdata. - -Returns @id{udata}, -or @fail if the userdata does not have that value. - -} - -@LibEntry{debug.traceback ([thread,] [message [, level]])| - -If @id{message} is present but is neither a string nor @nil, -this function returns @id{message} without further processing. -Otherwise, -it returns a string with a traceback of the call stack. -The optional @id{message} string is appended -at the beginning of the traceback. -An optional @id{level} number tells at which level -to start the traceback -(default is 1, the function calling @id{traceback}). - -} - -@LibEntry{debug.upvalueid (f, n)| - -Returns a unique identifier (as a light userdata) -for the upvalue numbered @id{n} -from the given function. - -These unique identifiers allow a program to check whether different -closures share upvalues. -Lua closures that share an upvalue -(that is, that access a same external local variable) -will return identical ids for those upvalue indices. - -} - -@LibEntry{debug.upvaluejoin (f1, n1, f2, n2)| - -Make the @id{n1}-th upvalue of the Lua closure @id{f1} -refer to the @id{n2}-th upvalue of the Lua closure @id{f2}. - -} - -} - -} - - -@C{-------------------------------------------------------------------------} -@sect1{lua-sa| @title{Lua Standalone} - -Although Lua has been designed as an extension language, -to be embedded in a host @N{C program}, -it is also frequently used as a standalone language. -An interpreter for Lua as a standalone language, -called simply @id{lua}, -is provided with the standard distribution. -The @x{standalone interpreter} includes -all standard libraries. -Its usage is: -@verbatim{ -lua [options] [script [args]] -} -The options are: -@description{ -@item{@T{-e @rep{stat}}| execute string @rep{stat};} -@item{@T{-i}| enter interactive mode after running @rep{script};} -@item{@T{-l @rep{mod}}| @Q{require} @rep{mod} and assign the - result to global @rep{mod};} -@item{@T{-l @rep{g=mod}}| @Q{require} @rep{mod} and assign the - result to global @rep{g};} -@item{@T{-v}| print version information;} -@item{@T{-E}| ignore environment variables;} -@item{@T{-W}| turn warnings on;} -@item{@T{--}| stop handling options;} -@item{@T{-}| execute @id{stdin} as a file and stop handling options.} -} -(The form @T{-l @rep{g=mod}} was introduced in @N{release 5.4.4}.) - -After handling its options, @id{lua} runs the given @emph{script}. -When called without arguments, -@id{lua} behaves as @T{lua -v -i} -when the standard input (@id{stdin}) is a terminal, -and as @T{lua -} otherwise. - -When called without the option @T{-E}, -the interpreter checks for an environment variable @defid{LUA_INIT_5_4} -(or @defid{LUA_INIT} if the versioned name is not defined) -before running any argument. -If the variable content has the format @T{@At@rep{filename}}, -then @id{lua} executes the file. -Otherwise, @id{lua} executes the string itself. - -When called with the option @T{-E}, -Lua does not consult any environment variables. -In particular, -the values of @Lid{package.path} and @Lid{package.cpath} -are set with the default paths defined in @id{luaconf.h}. -To signal to the libraries that this option is on, -the stand-alone interpreter sets the field -@idx{"LUA_NOENV"} in the registry to a true value. -Other libraries may consult this field for the same purpose. - -The options @T{-e}, @T{-l}, and @T{-W} are handled in -the order they appear. -For instance, an invocation like -@verbatim{ -$ lua -e 'a=1' -llib1 script.lua -} -will first set @id{a} to 1, then require the library @id{lib1}, -and finally run the file @id{script.lua} with no arguments. -(Here @T{$} is the shell prompt. Your prompt may be different.) - -Before running any code, -@id{lua} collects all command-line arguments -in a global table called @id{arg}. -The script name goes to index 0, -the first argument after the script name goes to index 1, -and so on. -Any arguments before the script name -(that is, the interpreter name plus its options) -go to negative indices. -For instance, in the call -@verbatim{ -$ lua -la b.lua t1 t2 -} -the table is like this: -@verbatim{ -arg = { [-2] = "lua", [-1] = "-la", - [0] = "b.lua", - [1] = "t1", [2] = "t2" } -} -If there is no script in the call, -the interpreter name goes to index 0, -followed by the other arguments. -For instance, the call -@verbatim{ -$ lua -e "print(arg[1])" -} -will print @St{-e}. -If there is a script, -the script is called with arguments -@T{arg[1]}, @Cdots, @T{arg[#arg]}. -Like all chunks in Lua, -the script is compiled as a variadic function. - -In interactive mode, -Lua repeatedly prompts and waits for a line. -After reading a line, -Lua first try to interpret the line as an expression. -If it succeeds, it prints its value. -Otherwise, it interprets the line as a statement. -If you write an incomplete statement, -the interpreter waits for its completion -by issuing a different prompt. - -If the global variable @defid{_PROMPT} contains a string, -then its value is used as the prompt. -Similarly, if the global variable @defid{_PROMPT2} contains a string, -its value is used as the secondary prompt -(issued during incomplete statements). - -In case of unprotected errors in the script, -the interpreter reports the error to the standard error stream. -If the error object is not a string but -has a metamethod @idx{__tostring}, -the interpreter calls this metamethod to produce the final message. -Otherwise, the interpreter converts the error object to a string -and adds a stack traceback to it. -When warnings are on, -they are simply printed in the standard error output. - -When finishing normally, -the interpreter closes its main Lua state -@seeF{lua_close}. -The script can avoid this step by -calling @Lid{os.exit} to terminate. - -To allow the use of Lua as a -script interpreter in Unix systems, -Lua skips the first line of a file chunk if it starts with @T{#}. -Therefore, Lua scripts can be made into executable programs -by using @T{chmod +x} and @N{the @T{#!}} form, -as in -@verbatim{ -#!/usr/local/bin/lua -} -Of course, -the location of the Lua interpreter may be different in your machine. -If @id{lua} is in your @id{PATH}, -then -@verbatim{ -#!/usr/bin/env lua -} -is a more portable solution. - -} - - -@sect1{incompat| @title{Incompatibilities with the Previous Version} - -@simplesect{ - -Here we list the incompatibilities that you may find when moving a program -from @N{Lua 5.3} to @N{Lua 5.4}. - -You can avoid some incompatibilities by compiling Lua with -appropriate options (see file @id{luaconf.h}). -However, -all these compatibility options will be removed in the future. -More often than not, -compatibility issues arise when these compatibility options -are removed. -So, whenever you have the chance, -you should try to test your code with a version of Lua compiled -with all compatibility options turned off. -That will ease transitions to newer versions of Lua. - -Lua versions can always change the C API in ways that -do not imply source-code changes in a program, -such as the numeric values for constants -or the implementation of functions as macros. -Therefore, -you should never assume that binaries are compatible between -different Lua versions. -Always recompile clients of the Lua API when -using a new version. - -Similarly, Lua versions can always change the internal representation -of precompiled chunks; -precompiled chunks are not compatible between different Lua versions. - -The standard paths in the official distribution may -change between versions. - -} - -@sect2{@title{Incompatibilities in the Language} -@itemize{ - -@item{ -The coercion of strings to numbers in -arithmetic and bitwise operations -has been removed from the core language. -The string library does a similar job -for arithmetic (but not for bitwise) operations -using the string metamethods. -However, unlike in previous versions, -the new implementation preserves the implicit type of the numeral -in the string. -For instance, the result of @T{"1" + "2"} now is an integer, -not a float. -} - -@item{ -Literal decimal integer constants that overflow are read as floats, -instead of wrapping around. -You can use hexadecimal notation for such constants if you -want the old behavior -(reading them as integers with wrap around). -} - -@item{ -The use of the @idx{__lt} metamethod to emulate @idx{__le} -has been removed. -When needed, this metamethod must be explicitly defined. -} - -@item{ -The semantics of the numerical @Rw{for} loop -over integers changed in some details. -In particular, the control variable never wraps around. -} - -@item{ -A label for a @Rw{goto} cannot be declared where a label with the same -name is visible, even if this other label is declared in an enclosing -block. -} - -@item{ -When finalizing an object, -Lua does not ignore @idx{__gc} metamethods that are not functions. -Any value will be called, if present. -(Non-callable values will generate a warning, -like any other error when calling a finalizer.) -} - -} - -} - -@sect2{@title{Incompatibilities in the Libraries} -@itemize{ - -@item{ -The function @Lid{print} does not call @Lid{tostring} -to format its arguments; -instead, it has this functionality hardwired. -You should use @idx{__tostring} to modify how values are printed. -} - -@item{ -The pseudo-random number generator used by the function @Lid{math.random} -now starts with a somewhat random seed. -Moreover, it uses a different algorithm. -} - -@item{ -By default, the decoding functions in the @Lid{utf8} library -do not accept surrogates as valid code points. -An extra parameter in these functions makes them more permissive. -} - -@item{ -The options @St{setpause} and @St{setstepmul} -of the function @Lid{collectgarbage} are deprecated. -You should use the new option @St{incremental} to set them. -} - -@item{ -The function @Lid{io.lines} now returns four values, -instead of just one. -That can be a problem when it is used as the sole -argument to another function that has optional parameters, -such as in @T{load(io.lines(filename, "L"))}. -To fix that issue, -you can wrap the call into parentheses, -to adjust its number of results to one. -} - -} - -} - -@sect2{@title{Incompatibilities in the API} - -@itemize{ - -@item{ -Full userdata now has an arbitrary number of associated user values. -Therefore, the functions @id{lua_newuserdata}, -@id{lua_setuservalue}, and @id{lua_getuservalue} were -replaced by @Lid{lua_newuserdatauv}, -@Lid{lua_setiuservalue}, and @Lid{lua_getiuservalue}, -which have an extra argument. - -For compatibility, the old names still work as macros assuming -one single user value. -Note, however, that userdata with zero user values -are more efficient memory-wise. -} - -@item{ -The function @Lid{lua_resume} has an extra parameter. -This out parameter returns the number of values on -the top of the stack that were yielded or returned by the coroutine. -(In previous versions, -those values were the entire stack.) -} - -@item{ -The function @Lid{lua_version} returns the version number, -instead of an address of the version number. -The Lua core should work correctly with libraries using their -own static copies of the same core, -so there is no need to check whether they are using the same -address space. -} - -@item{ -The constant @id{LUA_ERRGCMM} was removed. -Errors in finalizers are never propagated; -instead, they generate a warning. -} - -@item{ -The options @idx{LUA_GCSETPAUSE} and @idx{LUA_GCSETSTEPMUL} -of the function @Lid{lua_gc} are deprecated. -You should use the new option @id{LUA_GCINC} to set them. -} - -} - -} - -} - - -@C{[===============================================================} - -@sect1{BNF| @title{The Complete Syntax of Lua} - -Here is the complete syntax of Lua in extended BNF. -As usual in extended BNF, -@bnfNter{{A}} means 0 or more @bnfNter{A}s, -and @bnfNter{[A]} means an optional @bnfNter{A}. -(For operator precedences, see @See{prec}; -for a description of the terminals -@bnfNter{Name}, @bnfNter{Numeral}, -and @bnfNter{LiteralString}, see @See{lexical}.) -@index{grammar} - -@Produc{ - -@producname{chunk}@producbody{block} - -@producname{block}@producbody{@bnfrep{stat} @bnfopt{retstat}} - -@producname{stat}@producbody{ - @bnfter{;} -@OrNL varlist @bnfter{=} explist -@OrNL functioncall -@OrNL label -@OrNL @Rw{break} -@OrNL @Rw{goto} Name -@OrNL @Rw{do} block @Rw{end} -@OrNL @Rw{while} exp @Rw{do} block @Rw{end} -@OrNL @Rw{repeat} block @Rw{until} exp -@OrNL @Rw{if} exp @Rw{then} block - @bnfrep{@Rw{elseif} exp @Rw{then} block} - @bnfopt{@Rw{else} block} @Rw{end} -@OrNL @Rw{for} @bnfNter{Name} @bnfter{=} exp @bnfter{,} exp @bnfopt{@bnfter{,} exp} - @Rw{do} block @Rw{end} -@OrNL @Rw{for} namelist @Rw{in} explist @Rw{do} block @Rw{end} -@OrNL @Rw{function} funcname funcbody -@OrNL @Rw{local} @Rw{function} @bnfNter{Name} funcbody -@OrNL @Rw{local} attnamelist @bnfopt{@bnfter{=} explist} -} - -@producname{attnamelist}@producbody{ - @bnfNter{Name} attrib @bnfrep{@bnfter{,} @bnfNter{Name} attrib}} - -@producname{attrib}@producbody{@bnfopt{@bnfter{<} @bnfNter{Name} @bnfter{>}}} - -@producname{retstat}@producbody{@Rw{return} - @bnfopt{explist} @bnfopt{@bnfter{;}}} - -@producname{label}@producbody{@bnfter{::} Name @bnfter{::}} - -@producname{funcname}@producbody{@bnfNter{Name} @bnfrep{@bnfter{.} @bnfNter{Name}} - @bnfopt{@bnfter{:} @bnfNter{Name}}} - -@producname{varlist}@producbody{var @bnfrep{@bnfter{,} var}} - -@producname{var}@producbody{ - @bnfNter{Name} -@Or prefixexp @bnfter{[} exp @bnfter{]} -@Or prefixexp @bnfter{.} @bnfNter{Name} -} - -@producname{namelist}@producbody{@bnfNter{Name} @bnfrep{@bnfter{,} @bnfNter{Name}}} - - -@producname{explist}@producbody{exp @bnfrep{@bnfter{,} exp}} - -@producname{exp}@producbody{ - @Rw{nil} -@Or @Rw{false} -@Or @Rw{true} -@Or @bnfNter{Numeral} -@Or @bnfNter{LiteralString} -@Or @bnfter{...} -@Or functiondef -@OrNL prefixexp -@Or tableconstructor -@Or exp binop exp -@Or unop exp -} - -@producname{prefixexp}@producbody{var @Or functioncall @Or @bnfter{(} exp @bnfter{)}} - -@producname{functioncall}@producbody{ - prefixexp args -@Or prefixexp @bnfter{:} @bnfNter{Name} args -} - -@producname{args}@producbody{ - @bnfter{(} @bnfopt{explist} @bnfter{)} -@Or tableconstructor -@Or @bnfNter{LiteralString} -} - -@producname{functiondef}@producbody{@Rw{function} funcbody} - -@producname{funcbody}@producbody{@bnfter{(} @bnfopt{parlist} @bnfter{)} block @Rw{end}} - -@producname{parlist}@producbody{namelist @bnfopt{@bnfter{,} @bnfter{...}} - @Or @bnfter{...}} - -@producname{tableconstructor}@producbody{@bnfter{@Open} @bnfopt{fieldlist} @bnfter{@Close}} - -@producname{fieldlist}@producbody{field @bnfrep{fieldsep field} @bnfopt{fieldsep}} - -@producname{field}@producbody{@bnfter{[} exp @bnfter{]} @bnfter{=} exp @Or @bnfNter{Name} @bnfter{=} exp @Or exp} - -@producname{fieldsep}@producbody{@bnfter{,} @Or @bnfter{;}} - -@producname{binop}@producbody{ - @bnfter{+} @Or @bnfter{-} @Or @bnfter{*} @Or @bnfter{/} @Or @bnfter{//} - @Or @bnfter{^} @Or @bnfter{%} - @OrNL - @bnfter{&} @Or @bnfter{~} @Or @bnfter{|} @Or @bnfter{>>} @Or @bnfter{<<} - @Or @bnfter{..} - @OrNL - @bnfter{<} @Or @bnfter{<=} @Or @bnfter{>} @Or @bnfter{>=} - @Or @bnfter{==} @Or @bnfter{~=} - @OrNL - @Rw{and} @Or @Rw{or}} - -@producname{unop}@producbody{@bnfter{-} @Or @Rw{not} @Or @bnfter{#} @Or - @bnfter{~}} - -} - -} - -@C{]===============================================================} - -} -@C{)]-------------------------------------------------------------------------} diff --git a/3rdparty/lua/onelua.c.bak b/3rdparty/lua/onelua.c.bak deleted file mode 100644 index 2a43496..0000000 --- a/3rdparty/lua/onelua.c.bak +++ /dev/null @@ -1,121 +0,0 @@ -/* -** Lua core, libraries, and interpreter in a single file. -** Compiling just this file generates a complete Lua stand-alone -** program: -** -** $ gcc -O2 -std=c99 -o lua onelua.c -lm -** -** or -** -** $ gcc -O2 -std=c89 -DLUA_USE_C89 -o lua onelua.c -lm -** -*/ - -/* default is to build the full interpreter */ -#ifndef MAKE_LIB -#ifndef MAKE_LUAC -#ifndef MAKE_LUA -#define MAKE_LUA -#endif -#endif -#endif - - -/* -** Choose suitable platform-specific features. Default is no -** platform-specific features. Some of these options may need extra -** libraries such as -ldl -lreadline -lncurses -*/ -#if 0 -#define LUA_USE_LINUX -#define LUA_USE_MACOSX -#define LUA_USE_POSIX -#define LUA_ANSI -#endif - - -/* no need to change anything below this line ----------------------------- */ - -#include "lprefix.h" - -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include - - -/* setup for luaconf.h */ -#define LUA_CORE -#define LUA_LIB -#define ltable_c -#define lvm_c -#include "luaconf.h" - -/* do not export internal symbols */ -#undef LUAI_FUNC -#undef LUAI_DDEC -#undef LUAI_DDEF -#define LUAI_FUNC static -#define LUAI_DDEC(def) /* empty */ -#define LUAI_DDEF static - -/* core -- used by all */ -#include "lzio.c" -#include "lctype.c" -#include "lopcodes.c" -#include "lmem.c" -#include "lundump.c" -#include "ldump.c" -#include "lstate.c" -#include "lgc.c" -#include "llex.c" -#include "lcode.c" -#include "lparser.c" -#include "ldebug.c" -#include "lfunc.c" -#include "lobject.c" -#include "ltm.c" -#include "lstring.c" -#include "ltable.c" -#include "ldo.c" -#include "lvm.c" -#include "lapi.c" - -/* auxiliary library -- used by all */ -#include "lauxlib.c" - -/* standard library -- not used by luac */ -#ifndef MAKE_LUAC -#include "lbaselib.c" -#include "lcorolib.c" -#include "ldblib.c" -#include "liolib.c" -#include "lmathlib.c" -#include "loadlib.c" -#include "loslib.c" -#include "lstrlib.c" -#include "ltablib.c" -#include "lutf8lib.c" -#include "linit.c" -#endif - -/* lua */ -#ifdef MAKE_LUA -#include "lua.c" -#endif - -/* luac */ -#ifdef MAKE_LUAC -#include "luac.c" -#endif diff --git a/3rdparty/lua/lapi.c b/3rdparty/lua/src/lapi.c similarity index 81% rename from 3rdparty/lua/lapi.c rename to 3rdparty/lua/src/lapi.c index f8f70cd..34e64af 100644 --- a/3rdparty/lua/lapi.c +++ b/3rdparty/lua/src/lapi.c @@ -53,45 +53,57 @@ const char lua_ident[] = #define isupvalue(i) ((i) < LUA_REGISTRYINDEX) +/* +** Convert an acceptable index to a pointer to its respective value. +** Non-valid indices return the special nil value 'G(L)->nilvalue'. +*/ static TValue *index2value (lua_State *L, int idx) { CallInfo *ci = L->ci; if (idx > 0) { - StkId o = ci->func + idx; - api_check(L, idx <= L->ci->top - (ci->func + 1), "unacceptable index"); - if (o >= L->top) return &G(L)->nilvalue; + StkId o = ci->func.p + idx; + api_check(L, idx <= ci->top.p - (ci->func.p + 1), "unacceptable index"); + if (o >= L->top.p) return &G(L)->nilvalue; else return s2v(o); } else if (!ispseudo(idx)) { /* negative index */ - api_check(L, idx != 0 && -idx <= L->top - (ci->func + 1), "invalid index"); - return s2v(L->top + idx); + api_check(L, idx != 0 && -idx <= L->top.p - (ci->func.p + 1), + "invalid index"); + return s2v(L->top.p + idx); } else if (idx == LUA_REGISTRYINDEX) return &G(L)->l_registry; else { /* upvalues */ idx = LUA_REGISTRYINDEX - idx; api_check(L, idx <= MAXUPVAL + 1, "upvalue index too large"); - if (ttislcf(s2v(ci->func))) /* light C function? */ - return &G(L)->nilvalue; /* it has no upvalues */ - else { - CClosure *func = clCvalue(s2v(ci->func)); + if (ttisCclosure(s2v(ci->func.p))) { /* C closure? */ + CClosure *func = clCvalue(s2v(ci->func.p)); return (idx <= func->nupvalues) ? &func->upvalue[idx-1] : &G(L)->nilvalue; } + else { /* light C function or Lua function (through a hook)?) */ + api_check(L, ttislcf(s2v(ci->func.p)), "caller not a C function"); + return &G(L)->nilvalue; /* no upvalues */ + } } } -static StkId index2stack (lua_State *L, int idx) { + +/* +** Convert a valid actual index (not a pseudo-index) to its address. +*/ +l_sinline StkId index2stack (lua_State *L, int idx) { CallInfo *ci = L->ci; if (idx > 0) { - StkId o = ci->func + idx; - api_check(L, o < L->top, "unacceptable index"); + StkId o = ci->func.p + idx; + api_check(L, o < L->top.p, "invalid index"); return o; } else { /* non-positive index */ - api_check(L, idx != 0 && -idx <= L->top - (ci->func + 1), "invalid index"); + api_check(L, idx != 0 && -idx <= L->top.p - (ci->func.p + 1), + "invalid index"); api_check(L, !ispseudo(idx), "invalid index"); - return L->top + idx; + return L->top.p + idx; } } @@ -102,17 +114,12 @@ LUA_API int lua_checkstack (lua_State *L, int n) { lua_lock(L); ci = L->ci; api_check(L, n >= 0, "negative 'n'"); - if (L->stack_last - L->top > n) /* stack large enough? */ + if (L->stack_last.p - L->top.p > n) /* stack large enough? */ res = 1; /* yes; check is OK */ - else { /* no; need to grow stack */ - int inuse = cast_int(L->top - L->stack) + EXTRA_STACK; - if (inuse > LUAI_MAXSTACK - n) /* can grow without overflow? */ - res = 0; /* no */ - else /* try to grow stack */ - res = luaD_growstack(L, n, 0); - } - if (res && ci->top < L->top + n) - ci->top = L->top + n; /* adjust frame top */ + else /* need to grow stack */ + res = luaD_growstack(L, n, 0); + if (res && ci->top.p < L->top.p + n) + ci->top.p = L->top.p + n; /* adjust frame top */ lua_unlock(L); return res; } @@ -124,11 +131,11 @@ LUA_API void lua_xmove (lua_State *from, lua_State *to, int n) { lua_lock(to); api_checknelems(from, n); api_check(from, G(from) == G(to), "moving among independent states"); - api_check(from, to->ci->top - to->top >= n, "stack overflow"); - from->top -= n; + api_check(from, to->ci->top.p - to->top.p >= n, "stack overflow"); + from->top.p -= n; for (i = 0; i < n; i++) { - setobjs2s(to, to->top, from->top + i); - to->top++; /* stack already checked by previous 'api_check' */ + setobjs2s(to, to->top.p, from->top.p + i); + to->top.p++; /* stack already checked by previous 'api_check' */ } lua_unlock(to); } @@ -162,12 +169,12 @@ LUA_API lua_Number lua_version (lua_State *L) { LUA_API int lua_absindex (lua_State *L, int idx) { return (idx > 0 || ispseudo(idx)) ? idx - : cast_int(L->top - L->ci->func) + idx; + : cast_int(L->top.p - L->ci->func.p) + idx; } LUA_API int lua_gettop (lua_State *L) { - return cast_int(L->top - (L->ci->func + 1)); + return cast_int(L->top.p - (L->ci->func.p + 1)); } @@ -177,24 +184,24 @@ LUA_API void lua_settop (lua_State *L, int idx) { ptrdiff_t diff; /* difference for new top */ lua_lock(L); ci = L->ci; - func = ci->func; + func = ci->func.p; if (idx >= 0) { - api_check(L, idx <= ci->top - (func + 1), "new top too large"); - diff = ((func + 1) + idx) - L->top; + api_check(L, idx <= ci->top.p - (func + 1), "new top too large"); + diff = ((func + 1) + idx) - L->top.p; for (; diff > 0; diff--) - setnilvalue(s2v(L->top++)); /* clear new slots */ + setnilvalue(s2v(L->top.p++)); /* clear new slots */ } else { - api_check(L, -(idx+1) <= (L->top - (func + 1)), "invalid new top"); + api_check(L, -(idx+1) <= (L->top.p - (func + 1)), "invalid new top"); diff = idx + 1; /* will "subtract" index (as it is negative) */ } - api_check(L, L->tbclist < L->top, "previous pop of an unclosed slot"); - newtop = L->top + diff; - if (diff < 0 && L->tbclist >= newtop) { + api_check(L, L->tbclist.p < L->top.p, "previous pop of an unclosed slot"); + newtop = L->top.p + diff; + if (diff < 0 && L->tbclist.p >= newtop) { lua_assert(hastocloseCfunc(ci->nresults)); - luaF_close(L, newtop, CLOSEKTOP, 0); + newtop = luaF_close(L, newtop, CLOSEKTOP, 0); } - L->top = newtop; /* correct top only after closing any upvalue */ + L->top.p = newtop; /* correct top only after closing any upvalue */ lua_unlock(L); } @@ -203,10 +210,9 @@ LUA_API void lua_closeslot (lua_State *L, int idx) { StkId level; lua_lock(L); level = index2stack(L, idx); - api_check(L, hastocloseCfunc(L->ci->nresults) && L->tbclist == level, + api_check(L, hastocloseCfunc(L->ci->nresults) && L->tbclist.p == level, "no variable to close at given level"); - luaF_close(L, level, CLOSEKTOP, 0); - level = index2stack(L, idx); /* stack may be moved */ + level = luaF_close(L, level, CLOSEKTOP, 0); setnilvalue(s2v(level)); lua_unlock(L); } @@ -218,7 +224,7 @@ LUA_API void lua_closeslot (lua_State *L, int idx) { ** Note that we move(copy) only the value inside the stack. ** (We do not move additional fields that may exist.) */ -static void reverse (lua_State *L, StkId from, StkId to) { +l_sinline void reverse (lua_State *L, StkId from, StkId to) { for (; from < to; from++, to--) { TValue temp; setobj(L, &temp, s2v(from)); @@ -235,7 +241,7 @@ static void reverse (lua_State *L, StkId from, StkId to) { LUA_API void lua_rotate (lua_State *L, int idx, int n) { StkId p, t, m; lua_lock(L); - t = L->top - 1; /* end of stack segment being rotated */ + t = L->top.p - 1; /* end of stack segment being rotated */ p = index2stack(L, idx); /* start of segment */ api_check(L, (n >= 0 ? n : -n) <= (t - p + 1), "invalid 'n'"); m = (n >= 0 ? t - n : p - n - 1); /* end of prefix */ @@ -254,7 +260,7 @@ LUA_API void lua_copy (lua_State *L, int fromidx, int toidx) { api_check(L, isvalid(L, to), "invalid index"); setobj(L, to, fr); if (isupvalue(toidx)) /* function upvalue? */ - luaC_barrier(L, clCvalue(s2v(L->ci->func)), fr); + luaC_barrier(L, clCvalue(s2v(L->ci->func.p)), fr); /* LUA_REGISTRYINDEX does not need gc barrier (collector revisits it before finishing collection) */ lua_unlock(L); @@ -263,7 +269,7 @@ LUA_API void lua_copy (lua_State *L, int fromidx, int toidx) { LUA_API void lua_pushvalue (lua_State *L, int idx) { lua_lock(L); - setobj2s(L, L->top, index2value(L, idx)); + setobj2s(L, L->top.p, index2value(L, idx)); api_incr_top(L); lua_unlock(L); } @@ -332,12 +338,12 @@ LUA_API void lua_arith (lua_State *L, int op) { api_checknelems(L, 2); /* all other operations expect two operands */ else { /* for unary operations, add fake 2nd operand */ api_checknelems(L, 1); - setobjs2s(L, L->top, L->top - 1); + setobjs2s(L, L->top.p, L->top.p - 1); api_incr_top(L); } /* first operand at top - 2, second at top - 1; result go to top - 2 */ - luaO_arith(L, op, s2v(L->top - 2), s2v(L->top - 1), L->top - 2); - L->top--; /* remove second operand */ + luaO_arith(L, op, s2v(L->top.p - 2), s2v(L->top.p - 1), L->top.p - 2); + L->top.p--; /* remove second operand */ lua_unlock(L); } @@ -363,7 +369,7 @@ LUA_API int lua_compare (lua_State *L, int index1, int index2, int op) { LUA_API size_t lua_stringtonumber (lua_State *L, const char *s) { - size_t sz = luaO_str2num(s, s2v(L->top)); + size_t sz = luaO_str2num(s, s2v(L->top.p)); if (sz != 0) api_incr_top(L); return sz; @@ -438,7 +444,7 @@ LUA_API lua_CFunction lua_tocfunction (lua_State *L, int idx) { } -static void *touserdata (const TValue *o) { +l_sinline void *touserdata (const TValue *o) { switch (ttype(o)) { case LUA_TUSERDATA: return getudatamem(uvalue(o)); case LUA_TLIGHTUSERDATA: return pvalue(o); @@ -490,7 +496,7 @@ LUA_API const void *lua_topointer (lua_State *L, int idx) { LUA_API void lua_pushnil (lua_State *L) { lua_lock(L); - setnilvalue(s2v(L->top)); + setnilvalue(s2v(L->top.p)); api_incr_top(L); lua_unlock(L); } @@ -498,7 +504,7 @@ LUA_API void lua_pushnil (lua_State *L) { LUA_API void lua_pushnumber (lua_State *L, lua_Number n) { lua_lock(L); - setfltvalue(s2v(L->top), n); + setfltvalue(s2v(L->top.p), n); api_incr_top(L); lua_unlock(L); } @@ -506,7 +512,7 @@ LUA_API void lua_pushnumber (lua_State *L, lua_Number n) { LUA_API void lua_pushinteger (lua_State *L, lua_Integer n) { lua_lock(L); - setivalue(s2v(L->top), n); + setivalue(s2v(L->top.p), n); api_incr_top(L); lua_unlock(L); } @@ -521,7 +527,7 @@ LUA_API const char *lua_pushlstring (lua_State *L, const char *s, size_t len) { TString *ts; lua_lock(L); ts = (len == 0) ? luaS_new(L, "") : luaS_newlstr(L, s, len); - setsvalue2s(L, L->top, ts); + setsvalue2s(L, L->top.p, ts); api_incr_top(L); luaC_checkGC(L); lua_unlock(L); @@ -532,11 +538,11 @@ LUA_API const char *lua_pushlstring (lua_State *L, const char *s, size_t len) { LUA_API const char *lua_pushstring (lua_State *L, const char *s) { lua_lock(L); if (s == NULL) - setnilvalue(s2v(L->top)); + setnilvalue(s2v(L->top.p)); else { TString *ts; ts = luaS_new(L, s); - setsvalue2s(L, L->top, ts); + setsvalue2s(L, L->top.p, ts); s = getstr(ts); /* internal copy's address */ } api_incr_top(L); @@ -573,7 +579,7 @@ LUA_API const char *lua_pushfstring (lua_State *L, const char *fmt, ...) { LUA_API void lua_pushcclosure (lua_State *L, lua_CFunction fn, int n) { lua_lock(L); if (n == 0) { - setfvalue(s2v(L->top), fn); + setfvalue(s2v(L->top.p), fn); api_incr_top(L); } else { @@ -582,13 +588,13 @@ LUA_API void lua_pushcclosure (lua_State *L, lua_CFunction fn, int n) { api_check(L, n <= MAXUPVAL, "upvalue index too large"); cl = luaF_newCclosure(L, n); cl->f = fn; - L->top -= n; + L->top.p -= n; while (n--) { - setobj2n(L, &cl->upvalue[n], s2v(L->top + n)); + setobj2n(L, &cl->upvalue[n], s2v(L->top.p + n)); /* does not need barrier because closure is white */ lua_assert(iswhite(cl)); } - setclCvalue(L, s2v(L->top), cl); + setclCvalue(L, s2v(L->top.p), cl); api_incr_top(L); luaC_checkGC(L); } @@ -599,9 +605,9 @@ LUA_API void lua_pushcclosure (lua_State *L, lua_CFunction fn, int n) { LUA_API void lua_pushboolean (lua_State *L, int b) { lua_lock(L); if (b) - setbtvalue(s2v(L->top)); + setbtvalue(s2v(L->top.p)); else - setbfvalue(s2v(L->top)); + setbfvalue(s2v(L->top.p)); api_incr_top(L); lua_unlock(L); } @@ -609,7 +615,7 @@ LUA_API void lua_pushboolean (lua_State *L, int b) { LUA_API void lua_pushlightuserdata (lua_State *L, void *p) { lua_lock(L); - setpvalue(s2v(L->top), p); + setpvalue(s2v(L->top.p), p); api_incr_top(L); lua_unlock(L); } @@ -617,7 +623,7 @@ LUA_API void lua_pushlightuserdata (lua_State *L, void *p) { LUA_API int lua_pushthread (lua_State *L) { lua_lock(L); - setthvalue(L, s2v(L->top), L); + setthvalue(L, s2v(L->top.p), L); api_incr_top(L); lua_unlock(L); return (G(L)->mainthread == L); @@ -630,20 +636,20 @@ LUA_API int lua_pushthread (lua_State *L) { */ -static int auxgetstr (lua_State *L, const TValue *t, const char *k) { +l_sinline int auxgetstr (lua_State *L, const TValue *t, const char *k) { const TValue *slot; TString *str = luaS_new(L, k); if (luaV_fastget(L, t, str, slot, luaH_getstr)) { - setobj2s(L, L->top, slot); + setobj2s(L, L->top.p, slot); api_incr_top(L); } else { - setsvalue2s(L, L->top, str); + setsvalue2s(L, L->top.p, str); api_incr_top(L); - luaV_finishget(L, t, s2v(L->top - 1), L->top - 1, slot); + luaV_finishget(L, t, s2v(L->top.p - 1), L->top.p - 1, slot); } lua_unlock(L); - return ttype(s2v(L->top - 1)); + return ttype(s2v(L->top.p - 1)); } @@ -670,13 +676,13 @@ LUA_API int lua_gettable (lua_State *L, int idx) { TValue *t; lua_lock(L); t = index2value(L, idx); - if (luaV_fastget(L, t, s2v(L->top - 1), slot, luaH_get)) { - setobj2s(L, L->top - 1, slot); + if (luaV_fastget(L, t, s2v(L->top.p - 1), slot, luaH_get)) { + setobj2s(L, L->top.p - 1, slot); } else - luaV_finishget(L, t, s2v(L->top - 1), L->top - 1, slot); + luaV_finishget(L, t, s2v(L->top.p - 1), L->top.p - 1, slot); lua_unlock(L); - return ttype(s2v(L->top - 1)); + return ttype(s2v(L->top.p - 1)); } @@ -692,27 +698,27 @@ LUA_API int lua_geti (lua_State *L, int idx, lua_Integer n) { lua_lock(L); t = index2value(L, idx); if (luaV_fastgeti(L, t, n, slot)) { - setobj2s(L, L->top, slot); + setobj2s(L, L->top.p, slot); } else { TValue aux; setivalue(&aux, n); - luaV_finishget(L, t, &aux, L->top, slot); + luaV_finishget(L, t, &aux, L->top.p, slot); } api_incr_top(L); lua_unlock(L); - return ttype(s2v(L->top - 1)); + return ttype(s2v(L->top.p - 1)); } -static int finishrawget (lua_State *L, const TValue *val) { +l_sinline int finishrawget (lua_State *L, const TValue *val) { if (isempty(val)) /* avoid copying empty items to the stack */ - setnilvalue(s2v(L->top)); + setnilvalue(s2v(L->top.p)); else - setobj2s(L, L->top, val); + setobj2s(L, L->top.p, val); api_incr_top(L); lua_unlock(L); - return ttype(s2v(L->top - 1)); + return ttype(s2v(L->top.p - 1)); } @@ -729,8 +735,8 @@ LUA_API int lua_rawget (lua_State *L, int idx) { lua_lock(L); api_checknelems(L, 1); t = gettable(L, idx); - val = luaH_get(t, s2v(L->top - 1)); - L->top--; /* remove key */ + val = luaH_get(t, s2v(L->top.p - 1)); + L->top.p--; /* remove key */ return finishrawget(L, val); } @@ -757,7 +763,7 @@ LUA_API void lua_createtable (lua_State *L, int narray, int nrec) { Table *t; lua_lock(L); t = luaH_new(L); - sethvalue2s(L, L->top, t); + sethvalue2s(L, L->top.p, t); api_incr_top(L); if (narray > 0 || nrec > 0) luaH_resize(L, t, narray, nrec); @@ -784,7 +790,7 @@ LUA_API int lua_getmetatable (lua_State *L, int objindex) { break; } if (mt != NULL) { - sethvalue2s(L, L->top, mt); + sethvalue2s(L, L->top.p, mt); api_incr_top(L); res = 1; } @@ -800,12 +806,12 @@ LUA_API int lua_getiuservalue (lua_State *L, int idx, int n) { o = index2value(L, idx); api_check(L, ttisfulluserdata(o), "full userdata expected"); if (n <= 0 || n > uvalue(o)->nuvalue) { - setnilvalue(s2v(L->top)); + setnilvalue(s2v(L->top.p)); t = LUA_TNONE; } else { - setobj2s(L, L->top, &uvalue(o)->uv[n - 1].uv); - t = ttype(s2v(L->top)); + setobj2s(L, L->top.p, &uvalue(o)->uv[n - 1].uv); + t = ttype(s2v(L->top.p)); } api_incr_top(L); lua_unlock(L); @@ -825,14 +831,14 @@ static void auxsetstr (lua_State *L, const TValue *t, const char *k) { TString *str = luaS_new(L, k); api_checknelems(L, 1); if (luaV_fastget(L, t, str, slot, luaH_getstr)) { - luaV_finishfastset(L, t, slot, s2v(L->top - 1)); - L->top--; /* pop value */ + luaV_finishfastset(L, t, slot, s2v(L->top.p - 1)); + L->top.p--; /* pop value */ } else { - setsvalue2s(L, L->top, str); /* push 'str' (to make it a TValue) */ + setsvalue2s(L, L->top.p, str); /* push 'str' (to make it a TValue) */ api_incr_top(L); - luaV_finishset(L, t, s2v(L->top - 1), s2v(L->top - 2), slot); - L->top -= 2; /* pop value and key */ + luaV_finishset(L, t, s2v(L->top.p - 1), s2v(L->top.p - 2), slot); + L->top.p -= 2; /* pop value and key */ } lua_unlock(L); /* lock done by caller */ } @@ -852,12 +858,12 @@ LUA_API void lua_settable (lua_State *L, int idx) { lua_lock(L); api_checknelems(L, 2); t = index2value(L, idx); - if (luaV_fastget(L, t, s2v(L->top - 2), slot, luaH_get)) { - luaV_finishfastset(L, t, slot, s2v(L->top - 1)); + if (luaV_fastget(L, t, s2v(L->top.p - 2), slot, luaH_get)) { + luaV_finishfastset(L, t, slot, s2v(L->top.p - 1)); } else - luaV_finishset(L, t, s2v(L->top - 2), s2v(L->top - 1), slot); - L->top -= 2; /* pop index and value */ + luaV_finishset(L, t, s2v(L->top.p - 2), s2v(L->top.p - 1), slot); + L->top.p -= 2; /* pop index and value */ lua_unlock(L); } @@ -875,14 +881,14 @@ LUA_API void lua_seti (lua_State *L, int idx, lua_Integer n) { api_checknelems(L, 1); t = index2value(L, idx); if (luaV_fastgeti(L, t, n, slot)) { - luaV_finishfastset(L, t, slot, s2v(L->top - 1)); + luaV_finishfastset(L, t, slot, s2v(L->top.p - 1)); } else { TValue aux; setivalue(&aux, n); - luaV_finishset(L, t, &aux, s2v(L->top - 1), slot); + luaV_finishset(L, t, &aux, s2v(L->top.p - 1), slot); } - L->top--; /* pop value */ + L->top.p--; /* pop value */ lua_unlock(L); } @@ -892,16 +898,16 @@ static void aux_rawset (lua_State *L, int idx, TValue *key, int n) { lua_lock(L); api_checknelems(L, n); t = gettable(L, idx); - luaH_set(L, t, key, s2v(L->top - 1)); + luaH_set(L, t, key, s2v(L->top.p - 1)); invalidateTMcache(t); - luaC_barrierback(L, obj2gco(t), s2v(L->top - 1)); - L->top -= n; + luaC_barrierback(L, obj2gco(t), s2v(L->top.p - 1)); + L->top.p -= n; lua_unlock(L); } LUA_API void lua_rawset (lua_State *L, int idx) { - aux_rawset(L, idx, s2v(L->top - 2), 2); + aux_rawset(L, idx, s2v(L->top.p - 2), 2); } @@ -917,9 +923,9 @@ LUA_API void lua_rawseti (lua_State *L, int idx, lua_Integer n) { lua_lock(L); api_checknelems(L, 1); t = gettable(L, idx); - luaH_setint(L, t, n, s2v(L->top - 1)); - luaC_barrierback(L, obj2gco(t), s2v(L->top - 1)); - L->top--; + luaH_setint(L, t, n, s2v(L->top.p - 1)); + luaC_barrierback(L, obj2gco(t), s2v(L->top.p - 1)); + L->top.p--; lua_unlock(L); } @@ -930,11 +936,11 @@ LUA_API int lua_setmetatable (lua_State *L, int objindex) { lua_lock(L); api_checknelems(L, 1); obj = index2value(L, objindex); - if (ttisnil(s2v(L->top - 1))) + if (ttisnil(s2v(L->top.p - 1))) mt = NULL; else { - api_check(L, ttistable(s2v(L->top - 1)), "table expected"); - mt = hvalue(s2v(L->top - 1)); + api_check(L, ttistable(s2v(L->top.p - 1)), "table expected"); + mt = hvalue(s2v(L->top.p - 1)); } switch (ttype(obj)) { case LUA_TTABLE: { @@ -958,7 +964,7 @@ LUA_API int lua_setmetatable (lua_State *L, int objindex) { break; } } - L->top--; + L->top.p--; lua_unlock(L); return 1; } @@ -974,11 +980,11 @@ LUA_API int lua_setiuservalue (lua_State *L, int idx, int n) { if (!(cast_uint(n) - 1u < cast_uint(uvalue(o)->nuvalue))) res = 0; /* 'n' not in [1, uvalue(o)->nuvalue] */ else { - setobj(L, &uvalue(o)->uv[n - 1].uv, s2v(L->top - 1)); - luaC_barrierback(L, gcvalue(o), s2v(L->top - 1)); + setobj(L, &uvalue(o)->uv[n - 1].uv, s2v(L->top.p - 1)); + luaC_barrierback(L, gcvalue(o), s2v(L->top.p - 1)); res = 1; } - L->top--; + L->top.p--; lua_unlock(L); return res; } @@ -990,7 +996,8 @@ LUA_API int lua_setiuservalue (lua_State *L, int idx, int n) { #define checkresults(L,na,nr) \ - api_check(L, (nr) == LUA_MULTRET || (L->ci->top - L->top >= (nr) - (na)), \ + api_check(L, (nr) == LUA_MULTRET \ + || (L->ci->top.p - L->top.p >= (nr) - (na)), \ "results from function overflow current stack size") @@ -1003,7 +1010,7 @@ LUA_API void lua_callk (lua_State *L, int nargs, int nresults, api_checknelems(L, nargs+1); api_check(L, L->status == LUA_OK, "cannot do calls on non-normal thread"); checkresults(L, nargs, nresults); - func = L->top - (nargs+1); + func = L->top.p - (nargs+1); if (k != NULL && yieldable(L)) { /* need to prepare continuation? */ L->ci->u.c.k = k; /* save continuation */ L->ci->u.c.ctx = ctx; /* save context */ @@ -1051,7 +1058,7 @@ LUA_API int lua_pcallk (lua_State *L, int nargs, int nresults, int errfunc, api_check(L, ttisfunction(s2v(o)), "error handler must be a function"); func = savestack(L, o); } - c.func = L->top - (nargs+1); /* function to be called */ + c.func = L->top.p - (nargs+1); /* function to be called */ if (k == NULL || !yieldable(L)) { /* no continuation or no yieldable? */ c.nresults = nresults; /* do a 'conventional' protected call */ status = luaD_pcall(L, f_call, &c, savestack(L, c.func), func); @@ -1086,12 +1093,12 @@ LUA_API int lua_load (lua_State *L, lua_Reader reader, void *data, luaZ_init(L, &z, reader, data); status = luaD_protectedparser(L, &z, chunkname, mode); if (status == LUA_OK) { /* no errors? */ - LClosure *f = clLvalue(s2v(L->top - 1)); /* get newly created function */ + LClosure *f = clLvalue(s2v(L->top.p - 1)); /* get new function */ if (f->nupvalues >= 1) { /* does it have an upvalue? */ /* get global table from registry */ const TValue *gt = getGtable(L); /* set global table as 1st upvalue of 'f' (may be LUA_ENV) */ - setobj(L, f->upvals[0]->v, gt); + setobj(L, f->upvals[0]->v.p, gt); luaC_barrier(L, f->upvals[0], gt); } } @@ -1105,7 +1112,7 @@ LUA_API int lua_dump (lua_State *L, lua_Writer writer, void *data, int strip) { TValue *o; lua_lock(L); api_checknelems(L, 1); - o = s2v(L->top - 1); + o = s2v(L->top.p - 1); if (isLfunction(o)) status = luaU_dump(L, getproto(o), writer, data, strip); else @@ -1126,18 +1133,19 @@ LUA_API int lua_status (lua_State *L) { LUA_API int lua_gc (lua_State *L, int what, ...) { va_list argp; int res = 0; - global_State *g; + global_State *g = G(L); + if (g->gcstp & GCSTPGC) /* internal stop? */ + return -1; /* all options are invalid when stopped */ lua_lock(L); - g = G(L); va_start(argp, what); switch (what) { case LUA_GCSTOP: { - g->gcrunning = 0; + g->gcstp = GCSTPUSR; /* stopped by the user */ break; } case LUA_GCRESTART: { luaE_setdebt(g, 0); - g->gcrunning = 1; + g->gcstp = 0; /* (GCSTPGC must be already zero here) */ break; } case LUA_GCCOLLECT: { @@ -1156,8 +1164,8 @@ LUA_API int lua_gc (lua_State *L, int what, ...) { case LUA_GCSTEP: { int data = va_arg(argp, int); l_mem debt = 1; /* =1 to signal that it did an actual step */ - lu_byte oldrunning = g->gcrunning; - g->gcrunning = 1; /* allow GC to run */ + lu_byte oldstp = g->gcstp; + g->gcstp = 0; /* allow GC to run (GCSTPGC must be zero here) */ if (data == 0) { luaE_setdebt(g, 0); /* do a basic step */ luaC_step(L); @@ -1167,7 +1175,7 @@ LUA_API int lua_gc (lua_State *L, int what, ...) { luaE_setdebt(g, debt); luaC_checkGC(L); } - g->gcrunning = oldrunning; /* restore previous state */ + g->gcstp = oldstp; /* restore previous state */ if (debt > 0 && g->gcstate == GCSpause) /* end of cycle? */ res = 1; /* signal it */ break; @@ -1185,7 +1193,7 @@ LUA_API int lua_gc (lua_State *L, int what, ...) { break; } case LUA_GCISRUNNING: { - res = g->gcrunning; + res = gcrunning(g); break; } case LUA_GCGEN: { @@ -1230,7 +1238,7 @@ LUA_API int lua_gc (lua_State *L, int what, ...) { LUA_API int lua_error (lua_State *L) { TValue *errobj; lua_lock(L); - errobj = s2v(L->top - 1); + errobj = s2v(L->top.p - 1); api_checknelems(L, 1); /* error object is the memory error message? */ if (ttisshrstring(errobj) && eqshrstr(tsvalue(errobj), G(L)->memerrmsg)) @@ -1248,12 +1256,12 @@ LUA_API int lua_next (lua_State *L, int idx) { lua_lock(L); api_checknelems(L, 1); t = gettable(L, idx); - more = luaH_next(L, t, L->top - 1); + more = luaH_next(L, t, L->top.p - 1); if (more) { api_incr_top(L); } else /* no more elements */ - L->top -= 1; /* remove key */ + L->top.p -= 1; /* remove key */ lua_unlock(L); return more; } @@ -1265,7 +1273,7 @@ LUA_API void lua_toclose (lua_State *L, int idx) { lua_lock(L); o = index2stack(L, idx); nresults = L->ci->nresults; - api_check(L, L->tbclist < o, "given index below or equal a marked one"); + api_check(L, L->tbclist.p < o, "given index below or equal a marked one"); luaF_newtbcupval(L, o); /* create new to-be-closed upvalue */ if (!hastocloseCfunc(nresults)) /* function not marked yet? */ L->ci->nresults = codeNresults(nresults); /* mark it */ @@ -1280,7 +1288,7 @@ LUA_API void lua_concat (lua_State *L, int n) { if (n > 0) luaV_concat(L, n); else { /* nothing to concatenate */ - setsvalue2s(L, L->top, luaS_newlstr(L, "", 0)); /* push empty string */ + setsvalue2s(L, L->top.p, luaS_newlstr(L, "", 0)); /* push empty string */ api_incr_top(L); } luaC_checkGC(L); @@ -1292,7 +1300,7 @@ LUA_API void lua_len (lua_State *L, int idx) { TValue *t; lua_lock(L); t = index2value(L, idx); - luaV_objlen(L, L->top, t); + luaV_objlen(L, L->top.p, t); api_incr_top(L); lua_unlock(L); } @@ -1337,7 +1345,7 @@ LUA_API void *lua_newuserdatauv (lua_State *L, size_t size, int nuvalue) { lua_lock(L); api_check(L, 0 <= nuvalue && nuvalue < USHRT_MAX, "invalid value"); u = luaS_newudata(L, size, nuvalue); - setuvalue(L, s2v(L->top), u); + setuvalue(L, s2v(L->top.p), u); api_incr_top(L); luaC_checkGC(L); lua_unlock(L); @@ -1363,7 +1371,7 @@ static const char *aux_upvalue (TValue *fi, int n, TValue **val, Proto *p = f->p; if (!(cast_uint(n) - 1u < cast_uint(p->sizeupvalues))) return NULL; /* 'n' not in [1, p->sizeupvalues] */ - *val = f->upvals[n-1]->v; + *val = f->upvals[n-1]->v.p; if (owner) *owner = obj2gco(f->upvals[n - 1]); name = p->upvalues[n-1].name; return (name == NULL) ? "(no name)" : getstr(name); @@ -1379,7 +1387,7 @@ LUA_API const char *lua_getupvalue (lua_State *L, int funcindex, int n) { lua_lock(L); name = aux_upvalue(index2value(L, funcindex), n, &val, NULL); if (name) { - setobj2s(L, L->top, val); + setobj2s(L, L->top.p, val); api_incr_top(L); } lua_unlock(L); @@ -1397,8 +1405,8 @@ LUA_API const char *lua_setupvalue (lua_State *L, int funcindex, int n) { api_checknelems(L, 1); name = aux_upvalue(fi, n, &val, &owner); if (name) { - L->top--; - setobj(L, val, s2v(L->top)); + L->top.p--; + setobj(L, val, s2v(L->top.p)); luaC_barrier(L, owner, val); } lua_unlock(L); diff --git a/3rdparty/lua/lauxlib.c b/3rdparty/lua/src/lauxlib.c similarity index 95% rename from 3rdparty/lua/lauxlib.c rename to 3rdparty/lua/src/lauxlib.c index 94835ef..4ca6c65 100644 --- a/3rdparty/lua/lauxlib.c +++ b/3rdparty/lua/src/lauxlib.c @@ -526,13 +526,14 @@ static void newbox (lua_State *L) { /* ** Compute new size for buffer 'B', enough to accommodate extra 'sz' -** bytes. +** bytes. (The test for "not big enough" also gets the case when the +** computation of 'newsize' overflows.) */ static size_t newbuffsize (luaL_Buffer *B, size_t sz) { - size_t newsize = B->size * 2; /* double buffer size */ + size_t newsize = (B->size / 2) * 3; /* buffer size * 1.5 */ if (l_unlikely(MAX_SIZET - sz < B->n)) /* overflow in (B->n + sz)? */ return luaL_error(B->L, "buffer too large"); - if (newsize < B->n + sz) /* double is not big enough? */ + if (newsize < B->n + sz) /* not big enough? */ newsize = B->n + sz; return newsize; } @@ -611,7 +612,7 @@ LUALIB_API void luaL_pushresultsize (luaL_Buffer *B, size_t sz) { ** box (if existent) is not on the top of the stack. So, instead of ** calling 'luaL_addlstring', it replicates the code using -2 as the ** last argument to 'prepbuffsize', signaling that the box is (or will -** be) bellow the string being added to the buffer. (Box creation can +** be) below the string being added to the buffer. (Box creation can ** trigger an emergency GC, so we should not remove the string from the ** stack before we have the space guaranteed.) */ @@ -739,17 +740,18 @@ static int errfile (lua_State *L, const char *what, int fnameindex) { } -static int skipBOM (LoadF *lf) { - const char *p = "\xEF\xBB\xBF"; /* UTF-8 BOM mark */ - int c; - lf->n = 0; - do { - c = getc(lf->f); - if (c == EOF || c != *(const unsigned char *)p++) return c; - lf->buff[lf->n++] = c; /* to be read by the parser */ - } while (*p != '\0'); - lf->n = 0; /* prefix matched; discard it */ - return getc(lf->f); /* return next character */ +/* +** Skip an optional BOM at the start of a stream. If there is an +** incomplete BOM (the first character is correct but the rest is +** not), returns the first character anyway to force an error +** (as no chunk can start with 0xEF). +*/ +static int skipBOM (FILE *f) { + int c = getc(f); /* read first character */ + if (c == 0xEF && getc(f) == 0xBB && getc(f) == 0xBF) /* correct BOM? */ + return getc(f); /* ignore BOM and return next char */ + else /* no (valid) BOM */ + return c; /* return first character */ } @@ -760,13 +762,13 @@ static int skipBOM (LoadF *lf) { ** first "valid" character of the file (after the optional BOM and ** a first-line comment). */ -static int skipcomment (LoadF *lf, int *cp) { - int c = *cp = skipBOM(lf); +static int skipcomment (FILE *f, int *cp) { + int c = *cp = skipBOM(f); if (c == '#') { /* first line is a comment (Unix exec. file)? */ do { /* skip first line */ - c = getc(lf->f); + c = getc(f); } while (c != EOF && c != '\n'); - *cp = getc(lf->f); /* skip end-of-line, if present */ + *cp = getc(f); /* next character after comment, if present */ return 1; /* there was a comment */ } else return 0; /* no comment */ @@ -788,12 +790,16 @@ LUALIB_API int luaL_loadfilex (lua_State *L, const char *filename, lf.f = fopen(filename, "r"); if (lf.f == NULL) return errfile(L, "open", fnameindex); } - if (skipcomment(&lf, &c)) /* read initial portion */ - lf.buff[lf.n++] = '\n'; /* add line to correct line numbers */ - if (c == LUA_SIGNATURE[0] && filename) { /* binary file? */ - lf.f = freopen(filename, "rb", lf.f); /* reopen in binary mode */ - if (lf.f == NULL) return errfile(L, "reopen", fnameindex); - skipcomment(&lf, &c); /* re-read initial portion */ + lf.n = 0; + if (skipcomment(lf.f, &c)) /* read initial portion */ + lf.buff[lf.n++] = '\n'; /* add newline to correct line numbers */ + if (c == LUA_SIGNATURE[0]) { /* binary file? */ + lf.n = 0; /* remove possible newline */ + if (filename) { /* "real" file? */ + lf.f = freopen(filename, "rb", lf.f); /* reopen in binary mode */ + if (lf.f == NULL) return errfile(L, "reopen", fnameindex); + skipcomment(lf.f, &c); /* re-read initial portion */ + } } if (c != EOF) lf.buff[lf.n++] = c; /* 'c' is the first character of the stream */ @@ -881,6 +887,7 @@ LUALIB_API lua_Integer luaL_len (lua_State *L, int idx) { LUALIB_API const char *luaL_tolstring (lua_State *L, int idx, size_t *len) { + idx = lua_absindex(L,idx); if (luaL_callmeta(L, idx, "__tostring")) { /* metafield? */ if (!lua_isstring(L, -1)) luaL_error(L, "'__tostring' must return a string"); diff --git a/3rdparty/lua/lbaselib.c b/3rdparty/lua/src/lbaselib.c similarity index 94% rename from 3rdparty/lua/lbaselib.c rename to 3rdparty/lua/src/lbaselib.c index 83ad306..1d60c9d 100644 --- a/3rdparty/lua/lbaselib.c +++ b/3rdparty/lua/src/lbaselib.c @@ -182,12 +182,20 @@ static int luaB_rawset (lua_State *L) { static int pushmode (lua_State *L, int oldmode) { - lua_pushstring(L, (oldmode == LUA_GCINC) ? "incremental" - : "generational"); + if (oldmode == -1) + luaL_pushfail(L); /* invalid call to 'lua_gc' */ + else + lua_pushstring(L, (oldmode == LUA_GCINC) ? "incremental" + : "generational"); return 1; } +/* +** check whether call to 'lua_gc' was valid (not inside a finalizer) +*/ +#define checkvalres(res) { if (res == -1) break; } + static int luaB_collectgarbage (lua_State *L) { static const char *const opts[] = {"stop", "restart", "collect", "count", "step", "setpause", "setstepmul", @@ -200,12 +208,14 @@ static int luaB_collectgarbage (lua_State *L) { case LUA_GCCOUNT: { int k = lua_gc(L, o); int b = lua_gc(L, LUA_GCCOUNTB); + checkvalres(k); lua_pushnumber(L, (lua_Number)k + ((lua_Number)b/1024)); return 1; } case LUA_GCSTEP: { int step = (int)luaL_optinteger(L, 2, 0); int res = lua_gc(L, o, step); + checkvalres(res); lua_pushboolean(L, res); return 1; } @@ -213,11 +223,13 @@ static int luaB_collectgarbage (lua_State *L) { case LUA_GCSETSTEPMUL: { int p = (int)luaL_optinteger(L, 2, 0); int previous = lua_gc(L, o, p); + checkvalres(previous); lua_pushinteger(L, previous); return 1; } case LUA_GCISRUNNING: { int res = lua_gc(L, o); + checkvalres(res); lua_pushboolean(L, res); return 1; } @@ -234,10 +246,13 @@ static int luaB_collectgarbage (lua_State *L) { } default: { int res = lua_gc(L, o); + checkvalres(res); lua_pushinteger(L, res); return 1; } } + luaL_pushfail(L); /* invalid call (inside a finalizer) */ + return 1; } @@ -261,6 +276,11 @@ static int luaB_next (lua_State *L) { } +static int pairscont (lua_State *L, int status, lua_KContext k) { + (void)L; (void)status; (void)k; /* unused */ + return 3; +} + static int luaB_pairs (lua_State *L) { luaL_checkany(L, 1); if (luaL_getmetafield(L, 1, "__pairs") == LUA_TNIL) { /* no metamethod? */ @@ -270,7 +290,7 @@ static int luaB_pairs (lua_State *L) { } else { lua_pushvalue(L, 1); /* argument 'self' to metamethod */ - lua_call(L, 1, 3); /* get 3 values from metamethod */ + lua_callk(L, 1, 3, 0, pairscont); /* get 3 values from metamethod */ } return 3; } @@ -280,7 +300,8 @@ static int luaB_pairs (lua_State *L) { ** Traversal function for 'ipairs' */ static int ipairsaux (lua_State *L) { - lua_Integer i = luaL_checkinteger(L, 2) + 1; + lua_Integer i = luaL_checkinteger(L, 2); + i = luaL_intop(+, i, 1); lua_pushinteger(L, i); return (lua_geti(L, 1, i) == LUA_TNIL) ? 1 : 2; } diff --git a/3rdparty/lua/lcode.c b/3rdparty/lua/src/lcode.c similarity index 91% rename from 3rdparty/lua/lcode.c rename to 3rdparty/lua/src/lcode.c index 80d975c..1a371ca 100644 --- a/3rdparty/lua/lcode.c +++ b/3rdparty/lua/src/lcode.c @@ -10,6 +10,7 @@ #include "lprefix.h" +#include #include #include #include @@ -580,24 +581,41 @@ static int stringK (FuncState *fs, TString *s) { /* ** Add an integer to list of constants and return its index. -** Integers use userdata as keys to avoid collision with floats with -** same value; conversion to 'void*' is used only for hashing, so there -** are no "precision" problems. */ static int luaK_intK (FuncState *fs, lua_Integer n) { - TValue k, o; - setpvalue(&k, cast_voidp(cast_sizet(n))); + TValue o; setivalue(&o, n); - return addk(fs, &k, &o); + return addk(fs, &o, &o); /* use integer itself as key */ } /* -** Add a float to list of constants and return its index. +** Add a float to list of constants and return its index. Floats +** with integral values need a different key, to avoid collision +** with actual integers. To that, we add to the number its smaller +** power-of-two fraction that is still significant in its scale. +** For doubles, that would be 1/2^52. +** (This method is not bulletproof: there may be another float +** with that value, and for floats larger than 2^53 the result is +** still an integer. At worst, this only wastes an entry with +** a duplicate.) */ static int luaK_numberK (FuncState *fs, lua_Number r) { TValue o; + lua_Integer ik; setfltvalue(&o, r); - return addk(fs, &o, &o); /* use number itself as key */ + if (!luaV_flttointeger(r, &ik, F2Ieq)) /* not an integral value? */ + return addk(fs, &o, &o); /* use number itself as key */ + else { /* must build an alternative key */ + const int nbm = l_floatatt(MANT_DIG); + const lua_Number q = l_mathop(ldexp)(l_mathop(1.0), -nbm + 1); + const lua_Number k = (ik == 0) ? q : r + r*q; /* new key */ + TValue kv; + setfltvalue(&kv, k); + /* result is not an integral value, unless value is too large */ + lua_assert(!luaV_flttointeger(k, &ik, F2Ieq) || + l_mathop(fabs)(r) >= l_mathop(1e6)); + return addk(fs, &kv, &o); + } } @@ -1333,6 +1351,35 @@ static int constfolding (FuncState *fs, int op, expdesc *e1, } +/* +** Convert a BinOpr to an OpCode (ORDER OPR - ORDER OP) +*/ +l_sinline OpCode binopr2op (BinOpr opr, BinOpr baser, OpCode base) { + lua_assert(baser <= opr && + ((baser == OPR_ADD && opr <= OPR_SHR) || + (baser == OPR_LT && opr <= OPR_LE))); + return cast(OpCode, (cast_int(opr) - cast_int(baser)) + cast_int(base)); +} + + +/* +** Convert a UnOpr to an OpCode (ORDER OPR - ORDER OP) +*/ +l_sinline OpCode unopr2op (UnOpr opr) { + return cast(OpCode, (cast_int(opr) - cast_int(OPR_MINUS)) + + cast_int(OP_UNM)); +} + + +/* +** Convert a BinOpr to a tag method (ORDER OPR - ORDER TM) +*/ +l_sinline TMS binopr2TM (BinOpr opr) { + lua_assert(OPR_ADD <= opr && opr <= OPR_SHR); + return cast(TMS, (cast_int(opr) - cast_int(OPR_ADD)) + cast_int(TM_ADD)); +} + + /* ** Emit code for unary expressions that "produce values" ** (everything but 'not'). @@ -1371,12 +1418,15 @@ static void finishbinexpval (FuncState *fs, expdesc *e1, expdesc *e2, ** Emit code for binary expressions that "produce values" over ** two registers. */ -static void codebinexpval (FuncState *fs, OpCode op, +static void codebinexpval (FuncState *fs, BinOpr opr, expdesc *e1, expdesc *e2, int line) { - int v2 = luaK_exp2anyreg(fs, e2); /* both operands are in registers */ + OpCode op = binopr2op(opr, OPR_ADD, OP_ADD); + int v2 = luaK_exp2anyreg(fs, e2); /* make sure 'e2' is in a register */ + /* 'e1' must be already in a register or it is a constant */ + lua_assert((VNIL <= e1->k && e1->k <= VKSTR) || + e1->k == VNONRELOC || e1->k == VRELOC); lua_assert(OP_ADD <= op && op <= OP_SHR); - finishbinexpval(fs, e1, e2, op, v2, 0, line, OP_MMBIN, - cast(TMS, (op - OP_ADD) + TM_ADD)); + finishbinexpval(fs, e1, e2, op, v2, 0, line, OP_MMBIN, binopr2TM(opr)); } @@ -1392,6 +1442,18 @@ static void codebini (FuncState *fs, OpCode op, } +/* +** Code binary operators with K operand. +*/ +static void codebinK (FuncState *fs, BinOpr opr, + expdesc *e1, expdesc *e2, int flip, int line) { + TMS event = binopr2TM(opr); + int v2 = e2->u.info; /* K index */ + OpCode op = binopr2op(opr, OPR_ADD, OP_ADDK); + finishbinexpval(fs, e1, e2, op, v2, flip, line, OP_MMBINK, event); +} + + /* Try to code a binary operator negating its second operand. ** For the metamethod, 2nd operand must keep its original value. */ @@ -1419,24 +1481,27 @@ static void swapexps (expdesc *e1, expdesc *e2) { } +/* +** Code binary operators with no constant operand. +*/ +static void codebinNoK (FuncState *fs, BinOpr opr, + expdesc *e1, expdesc *e2, int flip, int line) { + if (flip) + swapexps(e1, e2); /* back to original order */ + codebinexpval(fs, opr, e1, e2, line); /* use standard operators */ +} + + /* ** Code arithmetic operators ('+', '-', ...). If second operand is a ** constant in the proper range, use variant opcodes with K operands. */ static void codearith (FuncState *fs, BinOpr opr, expdesc *e1, expdesc *e2, int flip, int line) { - TMS event = cast(TMS, opr + TM_ADD); - if (tonumeral(e2, NULL) && luaK_exp2K(fs, e2)) { /* K operand? */ - int v2 = e2->u.info; /* K index */ - OpCode op = cast(OpCode, opr + OP_ADDK); - finishbinexpval(fs, e1, e2, op, v2, flip, line, OP_MMBINK, event); - } - else { /* 'e2' is neither an immediate nor a K operand */ - OpCode op = cast(OpCode, opr + OP_ADD); - if (flip) - swapexps(e1, e2); /* back to original order */ - codebinexpval(fs, op, e1, e2, line); /* use standard operators */ - } + if (tonumeral(e2, NULL) && luaK_exp2K(fs, e2)) /* K operand? */ + codebinK(fs, opr, e1, e2, flip, line); + else /* 'e2' is neither an immediate nor a K operand */ + codebinNoK(fs, opr, e1, e2, flip, line); } @@ -1453,35 +1518,27 @@ static void codecommutative (FuncState *fs, BinOpr op, flip = 1; } if (op == OPR_ADD && isSCint(e2)) /* immediate operand? */ - codebini(fs, cast(OpCode, OP_ADDI), e1, e2, flip, line, TM_ADD); + codebini(fs, OP_ADDI, e1, e2, flip, line, TM_ADD); else codearith(fs, op, e1, e2, flip, line); } /* -** Code bitwise operations; they are all associative, so the function +** Code bitwise operations; they are all commutative, so the function ** tries to put an integer constant as the 2nd operand (a K operand). */ static void codebitwise (FuncState *fs, BinOpr opr, expdesc *e1, expdesc *e2, int line) { int flip = 0; - int v2; - OpCode op; - if (e1->k == VKINT && luaK_exp2RK(fs, e1)) { + if (e1->k == VKINT) { swapexps(e1, e2); /* 'e2' will be the constant operand */ flip = 1; } - else if (!(e2->k == VKINT && luaK_exp2RK(fs, e2))) { /* no constants? */ - op = cast(OpCode, opr + OP_ADD); - codebinexpval(fs, op, e1, e2, line); /* all-register opcodes */ - return; - } - v2 = e2->u.info; /* index in K array */ - op = cast(OpCode, opr + OP_ADDK); - lua_assert(ttisinteger(&fs->f->k[v2])); - finishbinexpval(fs, e1, e2, op, v2, flip, line, OP_MMBINK, - cast(TMS, opr + TM_ADD)); + if (e2->k == VKINT && luaK_exp2K(fs, e2)) /* K operand? */ + codebinK(fs, opr, e1, e2, flip, line); + else /* no constants */ + codebinNoK(fs, opr, e1, e2, flip, line); } @@ -1489,25 +1546,27 @@ static void codebitwise (FuncState *fs, BinOpr opr, ** Emit code for order comparisons. When using an immediate operand, ** 'isfloat' tells whether the original value was a float. */ -static void codeorder (FuncState *fs, OpCode op, expdesc *e1, expdesc *e2) { +static void codeorder (FuncState *fs, BinOpr opr, expdesc *e1, expdesc *e2) { int r1, r2; int im; int isfloat = 0; + OpCode op; if (isSCnumber(e2, &im, &isfloat)) { /* use immediate operand */ r1 = luaK_exp2anyreg(fs, e1); r2 = im; - op = cast(OpCode, (op - OP_LT) + OP_LTI); + op = binopr2op(opr, OPR_LT, OP_LTI); } else if (isSCnumber(e1, &im, &isfloat)) { /* transform (A < B) to (B > A) and (A <= B) to (B >= A) */ r1 = luaK_exp2anyreg(fs, e2); r2 = im; - op = (op == OP_LT) ? OP_GTI : OP_GEI; + op = binopr2op(opr, OPR_LT, OP_GTI); } else { /* regular case, compare two registers */ r1 = luaK_exp2anyreg(fs, e1); r2 = luaK_exp2anyreg(fs, e2); + op = binopr2op(opr, OPR_LT, OP_LT); } freeexps(fs, e1, e2); e1->u.info = condjump(fs, op, r1, r2, isfloat, 1); @@ -1533,7 +1592,7 @@ static void codeeq (FuncState *fs, BinOpr opr, expdesc *e1, expdesc *e2) { op = OP_EQI; r2 = im; /* immediate operand */ } - else if (luaK_exp2RK(fs, e2)) { /* 1st expression is constant? */ + else if (luaK_exp2RK(fs, e2)) { /* 2nd expression is constant? */ op = OP_EQK; r2 = e2->u.info; /* constant index */ } @@ -1550,16 +1609,16 @@ static void codeeq (FuncState *fs, BinOpr opr, expdesc *e1, expdesc *e2) { /* ** Apply prefix operation 'op' to expression 'e'. */ -void luaK_prefix (FuncState *fs, UnOpr op, expdesc *e, int line) { +void luaK_prefix (FuncState *fs, UnOpr opr, expdesc *e, int line) { static const expdesc ef = {VKINT, {0}, NO_JUMP, NO_JUMP}; luaK_dischargevars(fs, e); - switch (op) { + switch (opr) { case OPR_MINUS: case OPR_BNOT: /* use 'ef' as fake 2nd operand */ - if (constfolding(fs, op + LUA_OPUNM, e, &ef)) + if (constfolding(fs, opr + LUA_OPUNM, e, &ef)) break; /* else */ /* FALLTHROUGH */ case OPR_LEN: - codeunexpval(fs, cast(OpCode, op + OP_UNM), e, line); + codeunexpval(fs, unopr2op(opr), e, line); break; case OPR_NOT: codenot(fs, e); break; default: lua_assert(0); @@ -1593,7 +1652,8 @@ void luaK_infix (FuncState *fs, BinOpr op, expdesc *v) { case OPR_SHL: case OPR_SHR: { if (!tonumeral(v, NULL)) luaK_exp2anyreg(fs, v); - /* else keep numeral, which may be folded with 2nd operand */ + /* else keep numeral, which may be folded or used as an immediate + operand */ break; } case OPR_EQ: case OPR_NE: { @@ -1688,30 +1748,27 @@ void luaK_posfix (FuncState *fs, BinOpr opr, /* coded as (r1 >> -I) */; } else /* regular case (two registers) */ - codebinexpval(fs, OP_SHL, e1, e2, line); + codebinexpval(fs, opr, e1, e2, line); break; } case OPR_SHR: { if (isSCint(e2)) codebini(fs, OP_SHRI, e1, e2, 0, line, TM_SHR); /* r1 >> I */ else /* regular case (two registers) */ - codebinexpval(fs, OP_SHR, e1, e2, line); + codebinexpval(fs, opr, e1, e2, line); break; } case OPR_EQ: case OPR_NE: { codeeq(fs, opr, e1, e2); break; } - case OPR_LT: case OPR_LE: { - OpCode op = cast(OpCode, (opr - OPR_EQ) + OP_EQ); - codeorder(fs, op, e1, e2); - break; - } case OPR_GT: case OPR_GE: { /* '(a > b)' <=> '(b < a)'; '(a >= b)' <=> '(b <= a)' */ - OpCode op = cast(OpCode, (opr - OPR_NE) + OP_EQ); swapexps(e1, e2); - codeorder(fs, op, e1, e2); + opr = cast(BinOpr, (opr - OPR_GT) + OPR_LT); + } /* FALLTHROUGH */ + case OPR_LT: case OPR_LE: { + codeorder(fs, opr, e1, e2); break; } default: lua_assert(0); diff --git a/3rdparty/lua/lcorolib.c b/3rdparty/lua/src/lcorolib.c similarity index 95% rename from 3rdparty/lua/lcorolib.c rename to 3rdparty/lua/src/lcorolib.c index fedbebe..c64adf0 100644 --- a/3rdparty/lua/lcorolib.c +++ b/3rdparty/lua/src/lcorolib.c @@ -76,9 +76,9 @@ static int luaB_auxwrap (lua_State *L) { if (l_unlikely(r < 0)) { /* error? */ int stat = lua_status(co); if (stat != LUA_OK && stat != LUA_YIELD) { /* error in the coroutine? */ - stat = lua_resetthread(co); /* close its tbc variables */ + stat = lua_closethread(co, L); /* close its tbc variables */ lua_assert(stat != LUA_OK); - lua_xmove(co, L, 1); /* copy error message */ + lua_xmove(co, L, 1); /* move error message to the caller */ } if (stat != LUA_ERRMEM && /* not a memory error and ... */ lua_type(L, -1) == LUA_TSTRING) { /* ... error object is a string? */ @@ -172,14 +172,14 @@ static int luaB_close (lua_State *L) { int status = auxstatus(L, co); switch (status) { case COS_DEAD: case COS_YIELD: { - status = lua_resetthread(co); + status = lua_closethread(co, L); if (status == LUA_OK) { lua_pushboolean(L, 1); return 1; } else { lua_pushboolean(L, 0); - lua_xmove(co, L, 1); /* copy error message */ + lua_xmove(co, L, 1); /* move error message */ return 2; } } diff --git a/3rdparty/lua/lctype.c b/3rdparty/lua/src/lctype.c similarity index 100% rename from 3rdparty/lua/lctype.c rename to 3rdparty/lua/src/lctype.c diff --git a/3rdparty/lua/ldblib.c b/3rdparty/lua/src/ldblib.c similarity index 100% rename from 3rdparty/lua/ldblib.c rename to 3rdparty/lua/src/ldblib.c diff --git a/3rdparty/lua/ldebug.c b/3rdparty/lua/src/ldebug.c similarity index 84% rename from 3rdparty/lua/ldebug.c rename to 3rdparty/lua/src/ldebug.c index 1feaab2..28b1caa 100644 --- a/3rdparty/lua/ldebug.c +++ b/3rdparty/lua/src/ldebug.c @@ -34,8 +34,8 @@ #define noLuaClosure(f) ((f) == NULL || (f)->c.tt == LUA_VCCL) -static const char *funcnamefromcode (lua_State *L, CallInfo *ci, - const char **name); +static const char *funcnamefromcall (lua_State *L, CallInfo *ci, + const char **name); static int currentpc (CallInfo *ci) { @@ -64,7 +64,7 @@ static int getbaseline (const Proto *f, int pc, int *basepc) { } else { int i = cast_uint(pc) / MAXIWTHABS - 1; /* get an estimate */ - /* estimate must be a lower bond of the correct base */ + /* estimate must be a lower bound of the correct base */ lua_assert(i < 0 || (i < f->sizeabslineinfo && f->abslineinfo[i].pc <= pc)); while (i + 1 < f->sizeabslineinfo && pc >= f->abslineinfo[i + 1].pc) @@ -182,10 +182,10 @@ static const char *upvalname (const Proto *p, int uv) { static const char *findvararg (CallInfo *ci, int n, StkId *pos) { - if (clLvalue(s2v(ci->func))->p->is_vararg) { + if (clLvalue(s2v(ci->func.p))->p->is_vararg) { int nextra = ci->u.l.nextraargs; if (n >= -nextra) { /* 'n' is negative */ - *pos = ci->func - nextra - (n + 1); + *pos = ci->func.p - nextra - (n + 1); return "(vararg)"; /* generic name for any vararg */ } } @@ -194,7 +194,7 @@ static const char *findvararg (CallInfo *ci, int n, StkId *pos) { const char *luaG_findlocal (lua_State *L, CallInfo *ci, int n, StkId *pos) { - StkId base = ci->func + 1; + StkId base = ci->func.p + 1; const char *name = NULL; if (isLua(ci)) { if (n < 0) /* access to vararg values? */ @@ -203,7 +203,7 @@ const char *luaG_findlocal (lua_State *L, CallInfo *ci, int n, StkId *pos) { name = luaF_getlocalname(ci_func(ci)->p, n, currentpc(ci)); } if (name == NULL) { /* no 'standard' name? */ - StkId limit = (ci == L->ci) ? L->top : ci->next->func; + StkId limit = (ci == L->ci) ? L->top.p : ci->next->func.p; if (limit - base >= n && n > 0) { /* is 'n' inside 'ci' stack? */ /* generic name for any valid slot */ name = isLua(ci) ? "(temporary)" : "(C temporary)"; @@ -221,16 +221,16 @@ LUA_API const char *lua_getlocal (lua_State *L, const lua_Debug *ar, int n) { const char *name; lua_lock(L); if (ar == NULL) { /* information about non-active function? */ - if (!isLfunction(s2v(L->top - 1))) /* not a Lua function? */ + if (!isLfunction(s2v(L->top.p - 1))) /* not a Lua function? */ name = NULL; else /* consider live variables at function start (parameters) */ - name = luaF_getlocalname(clLvalue(s2v(L->top - 1))->p, n, 0); + name = luaF_getlocalname(clLvalue(s2v(L->top.p - 1))->p, n, 0); } else { /* active function; get information through 'ar' */ StkId pos = NULL; /* to avoid warnings */ name = luaG_findlocal(L, ar->i_ci, n, &pos); if (name) { - setobjs2s(L, L->top, pos); + setobjs2s(L, L->top.p, pos); api_incr_top(L); } } @@ -245,8 +245,8 @@ LUA_API const char *lua_setlocal (lua_State *L, const lua_Debug *ar, int n) { lua_lock(L); name = luaG_findlocal(L, ar->i_ci, n, &pos); if (name) { - setobjs2s(L, pos, L->top - 1); - L->top--; /* pop value */ + setobjs2s(L, pos, L->top.p - 1); + L->top.p--; /* pop value */ } lua_unlock(L); return name; @@ -289,7 +289,7 @@ static int nextline (const Proto *p, int currentline, int pc) { static void collectvalidlines (lua_State *L, Closure *f) { if (noLuaClosure(f)) { - setnilvalue(s2v(L->top)); + setnilvalue(s2v(L->top.p)); api_incr_top(L); } else { @@ -298,10 +298,17 @@ static void collectvalidlines (lua_State *L, Closure *f) { const Proto *p = f->l.p; int currentline = p->linedefined; Table *t = luaH_new(L); /* new table to store active lines */ - sethvalue2s(L, L->top, t); /* push it on stack */ + sethvalue2s(L, L->top.p, t); /* push it on stack */ api_incr_top(L); setbtvalue(&v); /* boolean 'true' to be the value of all indices */ - for (i = 0; i < p->sizelineinfo; i++) { /* for all instructions */ + if (!p->is_vararg) /* regular function? */ + i = 0; /* consider all instructions */ + else { /* vararg function */ + lua_assert(GET_OPCODE(p->code[0]) == OP_VARARGPREP); + currentline = nextline(p, currentline, 0); + i = 1; /* skip first instruction (OP_VARARGPREP) */ + } + for (; i < p->sizelineinfo; i++) { /* for each instruction */ currentline = nextline(p, currentline, i); /* get its line */ luaH_setint(L, t, currentline, &v); /* table[line] = true */ } @@ -310,15 +317,9 @@ static void collectvalidlines (lua_State *L, Closure *f) { static const char *getfuncname (lua_State *L, CallInfo *ci, const char **name) { - if (ci == NULL) /* no 'ci'? */ - return NULL; /* no info */ - else if (ci->callstatus & CIST_FIN) { /* is this a finalizer? */ - *name = "__gc"; - return "metamethod"; /* report it as such */ - } - /* calling function is a known Lua function? */ - else if (!(ci->callstatus & CIST_TAIL) && isLua(ci->previous)) - return funcnamefromcode(L, ci->previous, name); + /* calling function is a known function? */ + if (ci != NULL && !(ci->callstatus & CIST_TAIL)) + return funcnamefromcall(L, ci->previous, name); else return NULL; /* no way to find a name */ } @@ -387,20 +388,20 @@ LUA_API int lua_getinfo (lua_State *L, const char *what, lua_Debug *ar) { lua_lock(L); if (*what == '>') { ci = NULL; - func = s2v(L->top - 1); + func = s2v(L->top.p - 1); api_check(L, ttisfunction(func), "function expected"); what++; /* skip the '>' */ - L->top--; /* pop function */ + L->top.p--; /* pop function */ } else { ci = ar->i_ci; - func = s2v(ci->func); + func = s2v(ci->func.p); lua_assert(ttisfunction(func)); } cl = ttisclosure(func) ? clvalue(func) : NULL; status = auxgetinfo(L, what, ar, cl, ci); if (strchr(what, 'f')) { - setobj2s(L, L->top, func); + setobj2s(L, L->top.p, func); api_incr_top(L); } if (strchr(what, 'L')) @@ -590,16 +591,10 @@ static const char *getobjname (const Proto *p, int lastpc, int reg, ** Returns what the name is (e.g., "for iterator", "method", ** "metamethod") and sets '*name' to point to the name. */ -static const char *funcnamefromcode (lua_State *L, CallInfo *ci, - const char **name) { +static const char *funcnamefromcode (lua_State *L, const Proto *p, + int pc, const char **name) { TMS tm = (TMS)0; /* (initial value avoids warnings) */ - const Proto *p = ci_func(ci)->p; /* calling function */ - int pc = currentpc(ci); /* calling instruction index */ Instruction i = p->code[pc]; /* calling instruction */ - if (ci->callstatus & CIST_HOOKED) { /* was it called inside a hook? */ - *name = "?"; - return "hook"; - } switch (GET_OPCODE(i)) { case OP_CALL: case OP_TAILCALL: @@ -636,23 +631,44 @@ static const char *funcnamefromcode (lua_State *L, CallInfo *ci, return "metamethod"; } + +/* +** Try to find a name for a function based on how it was called. +*/ +static const char *funcnamefromcall (lua_State *L, CallInfo *ci, + const char **name) { + if (ci->callstatus & CIST_HOOKED) { /* was it called inside a hook? */ + *name = "?"; + return "hook"; + } + else if (ci->callstatus & CIST_FIN) { /* was it called as a finalizer? */ + *name = "__gc"; + return "metamethod"; /* report it as such */ + } + else if (isLua(ci)) + return funcnamefromcode(L, ci_func(ci)->p, currentpc(ci), name); + else + return NULL; +} + /* }====================================================== */ /* -** Check whether pointer 'o' points to some value in the stack -** frame of the current function. Because 'o' may not point to a -** value in this stack, we cannot compare it with the region -** boundaries (undefined behaviour in ISO C). +** Check whether pointer 'o' points to some value in the stack frame of +** the current function and, if so, returns its index. Because 'o' may +** not point to a value in this stack, we cannot compare it with the +** region boundaries (undefined behavior in ISO C). */ -static int isinstack (CallInfo *ci, const TValue *o) { - StkId pos; - for (pos = ci->func + 1; pos < ci->top; pos++) { - if (o == s2v(pos)) - return 1; +static int instack (CallInfo *ci, const TValue *o) { + int pos; + StkId base = ci->func.p + 1; + for (pos = 0; base + pos < ci->top.p; pos++) { + if (o == s2v(base + pos)) + return pos; } - return 0; /* not found */ + return -1; /* not found */ } @@ -666,7 +682,7 @@ static const char *getupvalname (CallInfo *ci, const TValue *o, LClosure *c = ci_func(ci); int i; for (i = 0; i < c->nupvalues; i++) { - if (c->upvals[i]->v == o) { + if (c->upvals[i]->v.p == o) { *name = upvalname(c->p, i); return "upvalue"; } @@ -675,36 +691,64 @@ static const char *getupvalname (CallInfo *ci, const TValue *o, } +static const char *formatvarinfo (lua_State *L, const char *kind, + const char *name) { + if (kind == NULL) + return ""; /* no information */ + else + return luaO_pushfstring(L, " (%s '%s')", kind, name); +} + +/* +** Build a string with a "description" for the value 'o', such as +** "variable 'x'" or "upvalue 'y'". +*/ static const char *varinfo (lua_State *L, const TValue *o) { - const char *name = NULL; /* to avoid warnings */ CallInfo *ci = L->ci; + const char *name = NULL; /* to avoid warnings */ const char *kind = NULL; if (isLua(ci)) { kind = getupvalname(ci, o, &name); /* check whether 'o' is an upvalue */ - if (!kind && isinstack(ci, o)) /* no? try a register */ - kind = getobjname(ci_func(ci)->p, currentpc(ci), - cast_int(cast(StkId, o) - (ci->func + 1)), &name); + if (!kind) { /* not an upvalue? */ + int reg = instack(ci, o); /* try a register */ + if (reg >= 0) /* is 'o' a register? */ + kind = getobjname(ci_func(ci)->p, currentpc(ci), reg, &name); + } } - return (kind) ? luaO_pushfstring(L, " (%s '%s')", kind, name) : ""; + return formatvarinfo(L, kind, name); } -l_noret luaG_typeerror (lua_State *L, const TValue *o, const char *op) { +/* +** Raise a type error +*/ +static l_noret typeerror (lua_State *L, const TValue *o, const char *op, + const char *extra) { const char *t = luaT_objtypename(L, o); - luaG_runerror(L, "attempt to %s a %s value%s", op, t, varinfo(L, o)); + luaG_runerror(L, "attempt to %s a %s value%s", op, t, extra); } +/* +** Raise a type error with "standard" information about the faulty +** object 'o' (using 'varinfo'). +*/ +l_noret luaG_typeerror (lua_State *L, const TValue *o, const char *op) { + typeerror(L, o, op, varinfo(L, o)); +} + + +/* +** Raise an error for calling a non-callable object. Try to find a name +** for the object based on how it was called ('funcnamefromcall'); if it +** cannot get a name there, try 'varinfo'. +*/ l_noret luaG_callerror (lua_State *L, const TValue *o) { CallInfo *ci = L->ci; const char *name = NULL; /* to avoid warnings */ - const char *what = (isLua(ci)) ? funcnamefromcode(L, ci, &name) : NULL; - if (what != NULL) { - const char *t = luaT_objtypename(L, o); - luaG_runerror(L, "%s '%s' is not callable (a %s value)", what, name, t); - } - else - luaG_typeerror(L, o, "call"); + const char *kind = funcnamefromcall(L, ci, &name); + const char *extra = kind ? formatvarinfo(L, kind, name) : varinfo(L, o); + typeerror(L, o, "call", extra); } @@ -766,10 +810,10 @@ l_noret luaG_errormsg (lua_State *L) { if (L->errfunc != 0) { /* is there an error handling function? */ StkId errfunc = restorestack(L, L->errfunc); lua_assert(ttisfunction(s2v(errfunc))); - setobjs2s(L, L->top, L->top - 1); /* move argument */ - setobjs2s(L, L->top - 1, errfunc); /* push function */ - L->top++; /* assume EXTRA_STACK */ - luaD_callnoyield(L, L->top - 2, 1); /* call it */ + setobjs2s(L, L->top.p, L->top.p - 1); /* move argument */ + setobjs2s(L, L->top.p - 1, errfunc); /* push function */ + L->top.p++; /* assume EXTRA_STACK */ + luaD_callnoyield(L, L->top.p - 2, 1); /* call it */ } luaD_throw(L, LUA_ERRRUN); } @@ -783,8 +827,11 @@ l_noret luaG_runerror (lua_State *L, const char *fmt, ...) { va_start(argp, fmt); msg = luaO_pushvfstring(L, fmt, argp); /* format message */ va_end(argp); - if (isLua(ci)) /* if Lua function, add source:line information */ + if (isLua(ci)) { /* if Lua function, add source:line information */ luaG_addinfo(L, msg, ci_func(ci)->p->source, getcurrentline(ci)); + setobjs2s(L, L->top.p - 2, L->top.p - 1); /* remove 'msg' */ + L->top.p--; + } luaG_errormsg(L); } @@ -801,7 +848,7 @@ static int changedline (const Proto *p, int oldpc, int newpc) { if (p->lineinfo == NULL) /* no debug information? */ return 0; if (newpc - oldpc < MAXIWTHABS / 2) { /* not too far apart? */ - int delta = 0; /* line diference */ + int delta = 0; /* line difference */ int pc = oldpc; for (;;) { int lineinfo = p->lineinfo[++pc]; @@ -828,7 +875,7 @@ static int changedline (const Proto *p, int oldpc, int newpc) { ** invalid; if so, use zero as a valid value. (A wrong but valid 'oldpc' ** at most causes an extra call to a line hook.) ** This function is not "Protected" when called, so it should correct -** 'L->top' before calling anything that can run the GC. +** 'L->top.p' before calling anything that can run the GC. */ int luaG_traceexec (lua_State *L, const Instruction *pc) { CallInfo *ci = L->ci; @@ -851,7 +898,7 @@ int luaG_traceexec (lua_State *L, const Instruction *pc) { return 1; /* do not call hook again (VM yielded, so it did not move) */ } if (!isIT(*(ci->u.l.savedpc - 1))) /* top not being used? */ - L->top = ci->top; /* correct top */ + L->top.p = ci->top.p; /* correct top */ if (counthook) luaD_hook(L, LUA_HOOKCOUNT, -1, 0, 0); /* call count hook */ if (mask & LUA_MASKLINE) { diff --git a/3rdparty/lua/ldo.c b/3rdparty/lua/src/ldo.c similarity index 74% rename from 3rdparty/lua/ldo.c rename to 3rdparty/lua/src/ldo.c index 7135079..2a0017c 100644 --- a/3rdparty/lua/ldo.c +++ b/3rdparty/lua/src/ldo.c @@ -104,11 +104,11 @@ void luaD_seterrorobj (lua_State *L, int errcode, StkId oldtop) { } default: { lua_assert(errorstatus(errcode)); /* real error */ - setobjs2s(L, oldtop, L->top - 1); /* error message on current top */ + setobjs2s(L, oldtop, L->top.p - 1); /* error message on current top */ break; } } - L->top = oldtop + 1; + L->top.p = oldtop + 1; } @@ -121,7 +121,7 @@ l_noret luaD_throw (lua_State *L, int errcode) { global_State *g = G(L); errcode = luaE_resetthread(L, errcode); /* close all upvalues */ if (g->mainthread->errorJmp) { /* main thread has a handler? */ - setobjs2s(L, g->mainthread->top++, L->top - 1); /* copy error obj. */ + setobjs2s(L, g->mainthread->top.p++, L->top.p - 1); /* copy error obj. */ luaD_throw(g->mainthread, errcode); /* re-throw in main thread */ } else { /* no handler at all; abort */ @@ -157,16 +157,38 @@ int luaD_rawrunprotected (lua_State *L, Pfunc f, void *ud) { ** Stack reallocation ** =================================================================== */ -static void correctstack (lua_State *L, StkId oldstack, StkId newstack) { + + +/* +** Change all pointers to the stack into offsets. +*/ +static void relstack (lua_State *L) { CallInfo *ci; UpVal *up; - L->top = (L->top - oldstack) + newstack; - L->tbclist = (L->tbclist - oldstack) + newstack; + L->top.offset = savestack(L, L->top.p); + L->tbclist.offset = savestack(L, L->tbclist.p); for (up = L->openupval; up != NULL; up = up->u.open.next) - up->v = s2v((uplevel(up) - oldstack) + newstack); + up->v.offset = savestack(L, uplevel(up)); for (ci = L->ci; ci != NULL; ci = ci->previous) { - ci->top = (ci->top - oldstack) + newstack; - ci->func = (ci->func - oldstack) + newstack; + ci->top.offset = savestack(L, ci->top.p); + ci->func.offset = savestack(L, ci->func.p); + } +} + + +/* +** Change back all offsets into pointers. +*/ +static void correctstack (lua_State *L) { + CallInfo *ci; + UpVal *up; + L->top.p = restorestack(L, L->top.offset); + L->tbclist.p = restorestack(L, L->tbclist.offset); + for (up = L->openupval; up != NULL; up = up->u.open.next) + up->v.p = s2v(restorestack(L, up->v.offset)); + for (ci = L->ci; ci != NULL; ci = ci->previous) { + ci->top.p = restorestack(L, ci->top.offset); + ci->func.p = restorestack(L, ci->func.offset); if (isLua(ci)) ci->u.l.trap = 1; /* signal to update 'trap' in 'luaV_execute' */ } @@ -176,44 +198,45 @@ static void correctstack (lua_State *L, StkId oldstack, StkId newstack) { /* some space for error handling */ #define ERRORSTACKSIZE (LUAI_MAXSTACK + 200) - /* -** Reallocate the stack to a new size, correcting all pointers into -** it. (There are pointers to a stack from its upvalues, from its list -** of call infos, plus a few individual pointers.) The reallocation is -** done in two steps (allocation + free) because the correction must be -** done while both addresses (the old stack and the new one) are valid. -** (In ISO C, any pointer use after the pointer has been deallocated is -** undefined behavior.) +** Reallocate the stack to a new size, correcting all pointers into it. +** In ISO C, any pointer use after the pointer has been deallocated is +** undefined behavior. So, before the reallocation, all pointers are +** changed to offsets, and after the reallocation they are changed back +** to pointers. As during the reallocation the pointers are invalid, the +** reallocation cannot run emergency collections. +** ** In case of allocation error, raise an error or return false according ** to 'raiseerror'. */ int luaD_reallocstack (lua_State *L, int newsize, int raiseerror) { int oldsize = stacksize(L); int i; - StkId newstack = luaM_reallocvector(L, NULL, 0, - newsize + EXTRA_STACK, StackValue); + StkId newstack; + int oldgcstop = G(L)->gcstopem; lua_assert(newsize <= LUAI_MAXSTACK || newsize == ERRORSTACKSIZE); + relstack(L); /* change pointers to offsets */ + G(L)->gcstopem = 1; /* stop emergency collection */ + newstack = luaM_reallocvector(L, L->stack.p, oldsize + EXTRA_STACK, + newsize + EXTRA_STACK, StackValue); + G(L)->gcstopem = oldgcstop; /* restore emergency collection */ if (l_unlikely(newstack == NULL)) { /* reallocation failed? */ + correctstack(L); /* change offsets back to pointers */ if (raiseerror) luaM_error(L); else return 0; /* do not raise an error */ } - /* number of elements to be copied to the new stack */ - i = ((oldsize <= newsize) ? oldsize : newsize) + EXTRA_STACK; - memcpy(newstack, L->stack, i * sizeof(StackValue)); - for (; i < newsize + EXTRA_STACK; i++) + L->stack.p = newstack; + correctstack(L); /* change offsets back to pointers */ + L->stack_last.p = L->stack.p + newsize; + for (i = oldsize + EXTRA_STACK; i < newsize + EXTRA_STACK; i++) setnilvalue(s2v(newstack + i)); /* erase new segment */ - correctstack(L, L->stack, newstack); - luaM_freearray(L, L->stack, oldsize + EXTRA_STACK); - L->stack = newstack; - L->stack_last = L->stack + newsize; return 1; } /* -** Try to grow the stack by at least 'n' elements. when 'raiseerror' +** Try to grow the stack by at least 'n' elements. When 'raiseerror' ** is true, raises any error; otherwise, return 0 in case of errors. */ int luaD_growstack (lua_State *L, int n, int raiseerror) { @@ -227,35 +250,38 @@ int luaD_growstack (lua_State *L, int n, int raiseerror) { luaD_throw(L, LUA_ERRERR); /* error inside message handler */ return 0; /* if not 'raiseerror', just signal it */ } - else { + else if (n < LUAI_MAXSTACK) { /* avoids arithmetic overflows */ int newsize = 2 * size; /* tentative new size */ - int needed = cast_int(L->top - L->stack) + n; + int needed = cast_int(L->top.p - L->stack.p) + n; if (newsize > LUAI_MAXSTACK) /* cannot cross the limit */ newsize = LUAI_MAXSTACK; if (newsize < needed) /* but must respect what was asked for */ newsize = needed; if (l_likely(newsize <= LUAI_MAXSTACK)) return luaD_reallocstack(L, newsize, raiseerror); - else { /* stack overflow */ - /* add extra size to be able to handle the error message */ - luaD_reallocstack(L, ERRORSTACKSIZE, raiseerror); - if (raiseerror) - luaG_runerror(L, "stack overflow"); - return 0; - } } + /* else stack overflow */ + /* add extra size to be able to handle the error message */ + luaD_reallocstack(L, ERRORSTACKSIZE, raiseerror); + if (raiseerror) + luaG_runerror(L, "stack overflow"); + return 0; } +/* +** Compute how much of the stack is being used, by computing the +** maximum top of all call frames in the stack and the current top. +*/ static int stackinuse (lua_State *L) { CallInfo *ci; int res; - StkId lim = L->top; + StkId lim = L->top.p; for (ci = L->ci; ci != NULL; ci = ci->previous) { - if (lim < ci->top) lim = ci->top; + if (lim < ci->top.p) lim = ci->top.p; } - lua_assert(lim <= L->stack_last); - res = cast_int(lim - L->stack) + 1; /* part of stack in use */ + lua_assert(lim <= L->stack_last.p + EXTRA_STACK); + res = cast_int(lim - L->stack.p) + 1; /* part of stack in use */ if (res < LUA_MINSTACK) res = LUA_MINSTACK; /* ensure a minimum size */ return res; @@ -273,17 +299,13 @@ static int stackinuse (lua_State *L) { */ void luaD_shrinkstack (lua_State *L) { int inuse = stackinuse(L); - int nsize = inuse * 2; /* proposed new size */ - int max = inuse * 3; /* maximum "reasonable" size */ - if (max > LUAI_MAXSTACK) { - max = LUAI_MAXSTACK; /* respect stack limit */ - if (nsize > LUAI_MAXSTACK) - nsize = LUAI_MAXSTACK; - } + int max = (inuse > LUAI_MAXSTACK / 3) ? LUAI_MAXSTACK : inuse * 3; /* if thread is currently not handling a stack overflow and its size is larger than maximum "reasonable" size, shrink it */ - if (inuse <= LUAI_MAXSTACK && stacksize(L) > max) + if (inuse <= LUAI_MAXSTACK && stacksize(L) > max) { + int nsize = (inuse > LUAI_MAXSTACK / 2) ? LUAI_MAXSTACK : inuse * 2; luaD_reallocstack(L, nsize, 0); /* ok if that fails */ + } else /* don't change stack */ condmovestack(L,{},{}); /* (change only for debugging) */ luaE_shrinkCI(L); /* shrink CI list */ @@ -292,7 +314,7 @@ void luaD_shrinkstack (lua_State *L) { void luaD_inctop (lua_State *L) { luaD_checkstack(L, 1); - L->top++; + L->top.p++; } /* }================================================================== */ @@ -309,8 +331,8 @@ void luaD_hook (lua_State *L, int event, int line, if (hook && L->allowhook) { /* make sure there is a hook */ int mask = CIST_HOOKED; CallInfo *ci = L->ci; - ptrdiff_t top = savestack(L, L->top); /* preserve original 'top' */ - ptrdiff_t ci_top = savestack(L, ci->top); /* idem for 'ci->top' */ + ptrdiff_t top = savestack(L, L->top.p); /* preserve original 'top' */ + ptrdiff_t ci_top = savestack(L, ci->top.p); /* idem for 'ci->top' */ lua_Debug ar; ar.event = event; ar.currentline = line; @@ -320,11 +342,11 @@ void luaD_hook (lua_State *L, int event, int line, ci->u2.transferinfo.ftransfer = ftransfer; ci->u2.transferinfo.ntransfer = ntransfer; } - if (isLua(ci) && L->top < ci->top) - L->top = ci->top; /* protect entire activation register */ + if (isLua(ci) && L->top.p < ci->top.p) + L->top.p = ci->top.p; /* protect entire activation register */ luaD_checkstack(L, LUA_MINSTACK); /* ensure minimum stack size */ - if (ci->top < L->top + LUA_MINSTACK) - ci->top = L->top + LUA_MINSTACK; + if (ci->top.p < L->top.p + LUA_MINSTACK) + ci->top.p = L->top.p + LUA_MINSTACK; L->allowhook = 0; /* cannot call hooks inside a hook */ ci->callstatus |= mask; lua_unlock(L); @@ -332,8 +354,8 @@ void luaD_hook (lua_State *L, int event, int line, lua_lock(L); lua_assert(!L->allowhook); L->allowhook = 1; - ci->top = restorestack(L, ci_top); - L->top = restorestack(L, top); + ci->top.p = restorestack(L, ci_top); + L->top.p = restorestack(L, top); ci->callstatus &= ~mask; } } @@ -364,7 +386,7 @@ void luaD_hookcall (lua_State *L, CallInfo *ci) { */ static void rethook (lua_State *L, CallInfo *ci, int nres) { if (L->hookmask & LUA_MASKRET) { /* is return hook on? */ - StkId firstres = L->top - nres; /* index of first result */ + StkId firstres = L->top.p - nres; /* index of first result */ int delta = 0; /* correction for vararg functions */ int ftransfer; if (isLua(ci)) { @@ -372,10 +394,10 @@ static void rethook (lua_State *L, CallInfo *ci, int nres) { if (p->is_vararg) delta = ci->u.l.nextraargs + p->numparams + 1; } - ci->func += delta; /* if vararg, back to virtual 'func' */ - ftransfer = cast(unsigned short, firstres - ci->func); + ci->func.p += delta; /* if vararg, back to virtual 'func' */ + ftransfer = cast(unsigned short, firstres - ci->func.p); luaD_hook(L, LUA_HOOKRET, -1, ftransfer, nres); /* call it */ - ci->func -= delta; + ci->func.p -= delta; } if (isLua(ci = ci->previous)) L->oldpc = pcRel(ci->u.l.savedpc, ci_func(ci)->p); /* set 'oldpc' */ @@ -387,15 +409,18 @@ static void rethook (lua_State *L, CallInfo *ci, int nres) { ** stack, below original 'func', so that 'luaD_precall' can call it. Raise ** an error if there is no '__call' metafield. */ -void luaD_tryfuncTM (lua_State *L, StkId func) { - const TValue *tm = luaT_gettmbyobj(L, s2v(func), TM_CALL); +StkId luaD_tryfuncTM (lua_State *L, StkId func) { + const TValue *tm; StkId p; + checkstackGCp(L, 1, func); /* space for metamethod */ + tm = luaT_gettmbyobj(L, s2v(func), TM_CALL); /* (after previous GC) */ if (l_unlikely(ttisnil(tm))) luaG_callerror(L, s2v(func)); /* nothing to call */ - for (p = L->top; p > func; p--) /* open space for metamethod */ + for (p = L->top.p; p > func; p--) /* open space for metamethod */ setobjs2s(L, p, p-1); - L->top++; /* stack space pre-allocated by the caller */ + L->top.p++; /* stack space pre-allocated by the caller */ setobj2s(L, func, tm); /* metamethod is the new function to be called */ + return func; } @@ -405,33 +430,34 @@ void luaD_tryfuncTM (lua_State *L, StkId func) { ** expressions, multiple results for tail calls/single parameters) ** separated. */ -static void moveresults (lua_State *L, StkId res, int nres, int wanted) { +l_sinline void moveresults (lua_State *L, StkId res, int nres, int wanted) { StkId firstresult; int i; switch (wanted) { /* handle typical cases separately */ case 0: /* no values needed */ - L->top = res; + L->top.p = res; return; case 1: /* one value needed */ if (nres == 0) /* no results? */ setnilvalue(s2v(res)); /* adjust with nil */ else /* at least one result */ - setobjs2s(L, res, L->top - nres); /* move it to proper place */ - L->top = res + 1; + setobjs2s(L, res, L->top.p - nres); /* move it to proper place */ + L->top.p = res + 1; return; case LUA_MULTRET: wanted = nres; /* we want all results */ break; default: /* two/more results and/or to-be-closed variables */ if (hastocloseCfunc(wanted)) { /* to-be-closed variables? */ - ptrdiff_t savedres = savestack(L, res); L->ci->callstatus |= CIST_CLSRET; /* in case of yields */ L->ci->u2.nres = nres; - luaF_close(L, res, CLOSEKTOP, 1); + res = luaF_close(L, res, CLOSEKTOP, 1); L->ci->callstatus &= ~CIST_CLSRET; - if (L->hookmask) /* if needed, call hook after '__close's */ + if (L->hookmask) { /* if needed, call hook after '__close's */ + ptrdiff_t savedres = savestack(L, res); rethook(L, L->ci, nres); - res = restorestack(L, savedres); /* close and hook can move stack */ + res = restorestack(L, savedres); /* hook can move stack */ + } wanted = decodeNresults(wanted); if (wanted == LUA_MULTRET) wanted = nres; /* we want all results */ @@ -439,14 +465,14 @@ static void moveresults (lua_State *L, StkId res, int nres, int wanted) { break; } /* generic case */ - firstresult = L->top - nres; /* index of first result */ + firstresult = L->top.p - nres; /* index of first result */ if (nres > wanted) /* extra results? */ nres = wanted; /* don't need them */ for (i = 0; i < nres; i++) /* move all results to correct place */ setobjs2s(L, res + i, firstresult + i); for (; i < wanted; i++) /* complete wanted number of results */ setnilvalue(s2v(res + i)); - L->top = res + wanted; /* top points after the last result */ + L->top.p = res + wanted; /* top points after the last result */ } @@ -461,7 +487,7 @@ void luaD_poscall (lua_State *L, CallInfo *ci, int nres) { if (l_unlikely(L->hookmask && !hastocloseCfunc(wanted))) rethook(L, ci, nres); /* move results to proper place */ - moveresults(L, ci->func, nres, wanted); + moveresults(L, ci->func.p, nres, wanted); /* function cannot be in any of these cases when returning */ lua_assert(!(ci->callstatus & (CIST_HOOKED | CIST_YPCALL | CIST_FIN | CIST_TRAN | CIST_CLSRET))); @@ -473,27 +499,81 @@ void luaD_poscall (lua_State *L, CallInfo *ci, int nres) { #define next_ci(L) (L->ci->next ? L->ci->next : luaE_extendCI(L)) +l_sinline CallInfo *prepCallInfo (lua_State *L, StkId func, int nret, + int mask, StkId top) { + CallInfo *ci = L->ci = next_ci(L); /* new frame */ + ci->func.p = func; + ci->nresults = nret; + ci->callstatus = mask; + ci->top.p = top; + return ci; +} + + +/* +** precall for C functions +*/ +l_sinline int precallC (lua_State *L, StkId func, int nresults, + lua_CFunction f) { + int n; /* number of returns */ + CallInfo *ci; + checkstackGCp(L, LUA_MINSTACK, func); /* ensure minimum stack size */ + L->ci = ci = prepCallInfo(L, func, nresults, CIST_C, + L->top.p + LUA_MINSTACK); + lua_assert(ci->top.p <= L->stack_last.p); + if (l_unlikely(L->hookmask & LUA_MASKCALL)) { + int narg = cast_int(L->top.p - func) - 1; + luaD_hook(L, LUA_HOOKCALL, -1, 1, narg); + } + lua_unlock(L); + n = (*f)(L); /* do the actual call */ + lua_lock(L); + api_checknelems(L, n); + luaD_poscall(L, ci, n); + return n; +} + + /* ** Prepare a function for a tail call, building its call info on top ** of the current call info. 'narg1' is the number of arguments plus 1 -** (so that it includes the function itself). +** (so that it includes the function itself). Return the number of +** results, if it was a C function, or -1 for a Lua function. */ -void luaD_pretailcall (lua_State *L, CallInfo *ci, StkId func, int narg1) { - Proto *p = clLvalue(s2v(func))->p; - int fsize = p->maxstacksize; /* frame size */ - int nfixparams = p->numparams; - int i; - for (i = 0; i < narg1; i++) /* move down function and arguments */ - setobjs2s(L, ci->func + i, func + i); - checkstackGC(L, fsize); - func = ci->func; /* moved-down function */ - for (; narg1 <= nfixparams; narg1++) - setnilvalue(s2v(func + narg1)); /* complete missing arguments */ - ci->top = func + 1 + fsize; /* top for new function */ - lua_assert(ci->top <= L->stack_last); - ci->u.l.savedpc = p->code; /* starting point */ - ci->callstatus |= CIST_TAIL; - L->top = func + narg1; /* set top */ +int luaD_pretailcall (lua_State *L, CallInfo *ci, StkId func, + int narg1, int delta) { + retry: + switch (ttypetag(s2v(func))) { + case LUA_VCCL: /* C closure */ + return precallC(L, func, LUA_MULTRET, clCvalue(s2v(func))->f); + case LUA_VLCF: /* light C function */ + return precallC(L, func, LUA_MULTRET, fvalue(s2v(func))); + case LUA_VLCL: { /* Lua function */ + Proto *p = clLvalue(s2v(func))->p; + int fsize = p->maxstacksize; /* frame size */ + int nfixparams = p->numparams; + int i; + checkstackGCp(L, fsize - delta, func); + ci->func.p -= delta; /* restore 'func' (if vararg) */ + for (i = 0; i < narg1; i++) /* move down function and arguments */ + setobjs2s(L, ci->func.p + i, func + i); + func = ci->func.p; /* moved-down function */ + for (; narg1 <= nfixparams; narg1++) + setnilvalue(s2v(func + narg1)); /* complete missing arguments */ + ci->top.p = func + 1 + fsize; /* top for new function */ + lua_assert(ci->top.p <= L->stack_last.p); + ci->u.l.savedpc = p->code; /* starting point */ + ci->callstatus |= CIST_TAIL; + L->top.p = func + narg1; /* set top */ + return -1; + } + default: { /* not a function */ + func = luaD_tryfuncTM(L, func); /* try to get '__call' metamethod */ + /* return luaD_pretailcall(L, ci, func, narg1 + 1, delta); */ + narg1++; + goto retry; /* try again */ + } + } } @@ -506,56 +586,31 @@ void luaD_pretailcall (lua_State *L, CallInfo *ci, StkId func, int narg1) { ** original function position. */ CallInfo *luaD_precall (lua_State *L, StkId func, int nresults) { - lua_CFunction f; retry: switch (ttypetag(s2v(func))) { case LUA_VCCL: /* C closure */ - f = clCvalue(s2v(func))->f; - goto Cfunc; - case LUA_VLCF: /* light C function */ - f = fvalue(s2v(func)); - Cfunc: { - int n; /* number of returns */ - CallInfo *ci; - checkstackGCp(L, LUA_MINSTACK, func); /* ensure minimum stack size */ - L->ci = ci = next_ci(L); - ci->nresults = nresults; - ci->callstatus = CIST_C; - ci->top = L->top + LUA_MINSTACK; - ci->func = func; - lua_assert(ci->top <= L->stack_last); - if (l_unlikely(L->hookmask & LUA_MASKCALL)) { - int narg = cast_int(L->top - func) - 1; - luaD_hook(L, LUA_HOOKCALL, -1, 1, narg); - } - lua_unlock(L); - n = (*f)(L); /* do the actual call */ - lua_lock(L); - api_checknelems(L, n); - luaD_poscall(L, ci, n); + precallC(L, func, nresults, clCvalue(s2v(func))->f); + return NULL; + case LUA_VLCF: /* light C function */ + precallC(L, func, nresults, fvalue(s2v(func))); return NULL; - } case LUA_VLCL: { /* Lua function */ CallInfo *ci; Proto *p = clLvalue(s2v(func))->p; - int narg = cast_int(L->top - func) - 1; /* number of real arguments */ + int narg = cast_int(L->top.p - func) - 1; /* number of real arguments */ int nfixparams = p->numparams; int fsize = p->maxstacksize; /* frame size */ checkstackGCp(L, fsize, func); - L->ci = ci = next_ci(L); - ci->nresults = nresults; + L->ci = ci = prepCallInfo(L, func, nresults, 0, func + 1 + fsize); ci->u.l.savedpc = p->code; /* starting point */ - ci->top = func + 1 + fsize; - ci->func = func; - L->ci = ci; for (; narg < nfixparams; narg++) - setnilvalue(s2v(L->top++)); /* complete missing arguments */ - lua_assert(ci->top <= L->stack_last); + setnilvalue(s2v(L->top.p++)); /* complete missing arguments */ + lua_assert(ci->top.p <= L->stack_last.p); return ci; } default: { /* not a function */ - checkstackGCp(L, 1, func); /* space for metamethod */ - luaD_tryfuncTM(L, func); /* try to get '__call' metamethod */ + func = luaD_tryfuncTM(L, func); /* try to get '__call' metamethod */ + /* return luaD_precall(L, func, nresults); */ goto retry; /* try again with metamethod */ } } @@ -566,12 +621,17 @@ CallInfo *luaD_precall (lua_State *L, StkId func, int nresults) { ** Call a function (C or Lua) through C. 'inc' can be 1 (increment ** number of recursive invocations in the C stack) or nyci (the same ** plus increment number of non-yieldable calls). +** This function can be called with some use of EXTRA_STACK, so it should +** check the stack before doing anything else. 'luaD_precall' already +** does that. */ -static void ccall (lua_State *L, StkId func, int nResults, int inc) { +l_sinline void ccall (lua_State *L, StkId func, int nResults, l_uint32 inc) { CallInfo *ci; L->nCcalls += inc; - if (l_unlikely(getCcalls(L) >= LUAI_MAXCCALLS)) + if (l_unlikely(getCcalls(L) >= LUAI_MAXCCALLS)) { + checkstackp(L, 0, func); /* free any use of EXTRA_STACK */ luaE_checkcstack(L); + } if ((ci = luaD_precall(L, func, nResults)) != NULL) { /* Lua function? */ ci->callstatus = CIST_FRESH; /* mark that it is a "fresh" execute */ luaV_execute(L, ci); /* call it */ @@ -619,8 +679,7 @@ static int finishpcallk (lua_State *L, CallInfo *ci) { else { /* error */ StkId func = restorestack(L, ci->u2.funcidx); L->allowhook = getoah(ci->callstatus); /* restore 'allowhook' */ - luaF_close(L, func, status, 1); /* can yield or raise an error */ - func = restorestack(L, ci->u2.funcidx); /* stack may be moved */ + func = luaF_close(L, func, status, 1); /* can yield or raise an error */ luaD_seterrorobj(L, status, func); luaD_shrinkstack(L); /* restore stack size in case of overflow */ setcistrecst(ci, LUA_OK); /* clear original status */ @@ -708,8 +767,8 @@ static CallInfo *findpcall (lua_State *L) { ** coroutine error handler and should not kill the coroutine.) */ static int resume_error (lua_State *L, const char *msg, int narg) { - L->top -= narg; /* remove args from the stack */ - setsvalue2s(L, L->top, luaS_new(L, msg)); /* push error message */ + L->top.p -= narg; /* remove args from the stack */ + setsvalue2s(L, L->top.p, luaS_new(L, msg)); /* push error message */ api_incr_top(L); lua_unlock(L); return LUA_ERRRUN; @@ -725,16 +784,15 @@ static int resume_error (lua_State *L, const char *msg, int narg) { */ static void resume (lua_State *L, void *ud) { int n = *(cast(int*, ud)); /* number of arguments */ - StkId firstArg = L->top - n; /* first argument */ + StkId firstArg = L->top.p - n; /* first argument */ CallInfo *ci = L->ci; if (L->status == LUA_OK) /* starting a coroutine? */ - ccall(L, firstArg - 1, LUA_MULTRET, 1); /* just call its body */ + ccall(L, firstArg - 1, LUA_MULTRET, 0); /* just call its body */ else { /* resuming from previous yield */ lua_assert(L->status == LUA_YIELD); L->status = LUA_OK; /* mark that it is running (again) */ - luaE_incCstack(L); /* control the C stack */ if (isLua(ci)) { /* yielded inside a hook? */ - L->top = firstArg; /* discard arguments */ + L->top.p = firstArg; /* discard arguments */ luaV_execute(L, ci); /* just continue running Lua code */ } else { /* 'common' yield */ @@ -777,12 +835,15 @@ LUA_API int lua_resume (lua_State *L, lua_State *from, int nargs, if (L->status == LUA_OK) { /* may be starting a coroutine */ if (L->ci != &L->base_ci) /* not in base level? */ return resume_error(L, "cannot resume non-suspended coroutine", nargs); - else if (L->top - (L->ci->func + 1) == nargs) /* no function? */ + else if (L->top.p - (L->ci->func.p + 1) == nargs) /* no function? */ return resume_error(L, "cannot resume dead coroutine", nargs); } else if (L->status != LUA_YIELD) /* ended with errors? */ return resume_error(L, "cannot resume dead coroutine", nargs); L->nCcalls = (from) ? getCcalls(from) : 0; + if (getCcalls(L) >= LUAI_MAXCCALLS) + return resume_error(L, "C stack overflow", nargs); + L->nCcalls++; luai_userstateresume(L, nargs); api_checknelems(L, (L->status == LUA_OK) ? nargs + 1 : nargs); status = luaD_rawrunprotected(L, resume, &nargs); @@ -792,11 +853,11 @@ LUA_API int lua_resume (lua_State *L, lua_State *from, int nargs, lua_assert(status == L->status); /* normal end or yield */ else { /* unrecoverable error */ L->status = cast_byte(status); /* mark thread as 'dead' */ - luaD_seterrorobj(L, status, L->top); /* push error message */ - L->ci->top = L->top; + luaD_seterrorobj(L, status, L->top.p); /* push error message */ + L->ci->top.p = L->top.p; } *nresults = (status == LUA_YIELD) ? L->ci->u2.nyield - : cast_int(L->top - (L->ci->func + 1)); + : cast_int(L->top.p - (L->ci->func.p + 1)); lua_unlock(L); return status; } @@ -951,7 +1012,7 @@ int luaD_protectedparser (lua_State *L, ZIO *z, const char *name, p.dyd.gt.arr = NULL; p.dyd.gt.size = 0; p.dyd.label.arr = NULL; p.dyd.label.size = 0; luaZ_initbuffer(L, &p.buff); - status = luaD_pcall(L, f_parser, &p, savestack(L, L->top), L->errfunc); + status = luaD_pcall(L, f_parser, &p, savestack(L, L->top.p), L->errfunc); luaZ_freebuffer(L, &p.buff); luaM_freearray(L, p.dyd.actvar.arr, p.dyd.actvar.size); luaM_freearray(L, p.dyd.gt.arr, p.dyd.gt.size); diff --git a/3rdparty/lua/ldump.c b/3rdparty/lua/src/ldump.c similarity index 96% rename from 3rdparty/lua/ldump.c rename to 3rdparty/lua/src/ldump.c index f848b66..f231691 100644 --- a/3rdparty/lua/ldump.c +++ b/3rdparty/lua/src/ldump.c @@ -10,6 +10,7 @@ #include "lprefix.h" +#include #include #include "lua.h" @@ -55,8 +56,11 @@ static void dumpByte (DumpState *D, int y) { } -/* dumpInt Buff Size */ -#define DIBS ((sizeof(size_t) * 8 / 7) + 1) +/* +** 'dumpSize' buffer size: each byte can store up to 7 bits. (The "+6" +** rounds up the division.) +*/ +#define DIBS ((sizeof(size_t) * CHAR_BIT + 6) / 7) static void dumpSize (DumpState *D, size_t x) { lu_byte buff[DIBS]; diff --git a/3rdparty/lua/lfunc.c b/3rdparty/lua/src/lfunc.c similarity index 85% rename from 3rdparty/lua/lfunc.c rename to 3rdparty/lua/src/lfunc.c index f5889a2..0945f24 100644 --- a/3rdparty/lua/lfunc.c +++ b/3rdparty/lua/src/lfunc.c @@ -50,8 +50,8 @@ void luaF_initupvals (lua_State *L, LClosure *cl) { for (i = 0; i < cl->nupvalues; i++) { GCObject *o = luaC_newobj(L, LUA_VUPVAL, sizeof(UpVal)); UpVal *uv = gco2upv(o); - uv->v = &uv->u.value; /* make it closed */ - setnilvalue(uv->v); + uv->v.p = &uv->u.value; /* make it closed */ + setnilvalue(uv->v.p); cl->upvals[i] = uv; luaC_objbarrier(L, cl, uv); } @@ -62,12 +62,11 @@ void luaF_initupvals (lua_State *L, LClosure *cl) { ** Create a new upvalue at the given level, and link it to the list of ** open upvalues of 'L' after entry 'prev'. **/ -static UpVal *newupval (lua_State *L, int tbc, StkId level, UpVal **prev) { +static UpVal *newupval (lua_State *L, StkId level, UpVal **prev) { GCObject *o = luaC_newobj(L, LUA_VUPVAL, sizeof(UpVal)); UpVal *uv = gco2upv(o); UpVal *next = *prev; - uv->v = s2v(level); /* current value lives in the stack */ - uv->tbc = tbc; + uv->v.p = s2v(level); /* current value lives in the stack */ uv->u.open.next = next; /* link it to list of open upvalues */ uv->u.open.previous = prev; if (next) @@ -96,7 +95,7 @@ UpVal *luaF_findupval (lua_State *L, StkId level) { pp = &p->u.open.next; } /* not found: create a new upvalue after 'pp' */ - return newupval(L, 0, level, pp); + return newupval(L, level, pp); } @@ -106,12 +105,12 @@ UpVal *luaF_findupval (lua_State *L, StkId level) { ** (This function assumes EXTRA_STACK.) */ static void callclosemethod (lua_State *L, TValue *obj, TValue *err, int yy) { - StkId top = L->top; + StkId top = L->top.p; const TValue *tm = luaT_gettmbyobj(L, obj, TM_CLOSE); setobj2s(L, top, tm); /* will call metamethod... */ setobj2s(L, top + 1, obj); /* with 'self' as the 1st argument */ setobj2s(L, top + 2, err); /* and error msg. as 2nd argument */ - L->top = top + 3; /* add function and arguments */ + L->top.p = top + 3; /* add function and arguments */ if (yy) luaD_call(L, top, 0); else @@ -126,7 +125,7 @@ static void callclosemethod (lua_State *L, TValue *obj, TValue *err, int yy) { static void checkclosemth (lua_State *L, StkId level) { const TValue *tm = luaT_gettmbyobj(L, s2v(level), TM_CLOSE); if (ttisnil(tm)) { /* no metamethod? */ - int idx = cast_int(level - L->ci->func); /* variable index */ + int idx = cast_int(level - L->ci->func.p); /* variable index */ const char *vname = luaG_findlocal(L, L->ci, idx, NULL); if (vname == NULL) vname = "?"; luaG_runerror(L, "variable '%s' got a non-closable value", vname); @@ -160,23 +159,23 @@ static void prepcallclosemth (lua_State *L, StkId level, int status, int yy) { ** is used.) */ #define MAXDELTA \ - ((256ul << ((sizeof(L->stack->tbclist.delta) - 1) * 8)) - 1) + ((256ul << ((sizeof(L->stack.p->tbclist.delta) - 1) * 8)) - 1) /* ** Insert a variable in the list of to-be-closed variables. */ void luaF_newtbcupval (lua_State *L, StkId level) { - lua_assert(level > L->tbclist); + lua_assert(level > L->tbclist.p); if (l_isfalse(s2v(level))) return; /* false doesn't need to be closed */ checkclosemth(L, level); /* value must have a close method */ - while (cast_uint(level - L->tbclist) > MAXDELTA) { - L->tbclist += MAXDELTA; /* create a dummy node at maximum delta */ - L->tbclist->tbclist.delta = 0; + while (cast_uint(level - L->tbclist.p) > MAXDELTA) { + L->tbclist.p += MAXDELTA; /* create a dummy node at maximum delta */ + L->tbclist.p->tbclist.delta = 0; } - level->tbclist.delta = cast(unsigned short, level - L->tbclist); - L->tbclist = level; + level->tbclist.delta = cast(unsigned short, level - L->tbclist.p); + L->tbclist.p = level; } @@ -196,10 +195,10 @@ void luaF_closeupval (lua_State *L, StkId level) { StkId upl; /* stack index pointed by 'uv' */ while ((uv = L->openupval) != NULL && (upl = uplevel(uv)) >= level) { TValue *slot = &uv->u.value; /* new position for value */ - lua_assert(uplevel(uv) < L->top); + lua_assert(uplevel(uv) < L->top.p); luaF_unlinkupval(uv); /* remove upvalue from 'openupval' list */ - setobj(L, slot, uv->v); /* move value to upvalue slot */ - uv->v = slot; /* now current value lives here */ + setobj(L, slot, uv->v.p); /* move value to upvalue slot */ + uv->v.p = slot; /* now current value lives here */ if (!iswhite(uv)) { /* neither white nor dead? */ nw2black(uv); /* closed upvalues cannot be gray */ luaC_barrier(L, uv, slot); @@ -209,31 +208,32 @@ void luaF_closeupval (lua_State *L, StkId level) { /* -** Remove firt element from the tbclist plus its dummy nodes. +** Remove first element from the tbclist plus its dummy nodes. */ static void poptbclist (lua_State *L) { - StkId tbc = L->tbclist; + StkId tbc = L->tbclist.p; lua_assert(tbc->tbclist.delta > 0); /* first element cannot be dummy */ tbc -= tbc->tbclist.delta; - while (tbc > L->stack && tbc->tbclist.delta == 0) + while (tbc > L->stack.p && tbc->tbclist.delta == 0) tbc -= MAXDELTA; /* remove dummy nodes */ - L->tbclist = tbc; + L->tbclist.p = tbc; } /* ** Close all upvalues and to-be-closed variables up to the given stack -** level. +** level. Return restored 'level'. */ -void luaF_close (lua_State *L, StkId level, int status, int yy) { +StkId luaF_close (lua_State *L, StkId level, int status, int yy) { ptrdiff_t levelrel = savestack(L, level); luaF_closeupval(L, level); /* first, close the upvalues */ - while (L->tbclist >= level) { /* traverse tbc's down to that level */ - StkId tbc = L->tbclist; /* get variable index */ + while (L->tbclist.p >= level) { /* traverse tbc's down to that level */ + StkId tbc = L->tbclist.p; /* get variable index */ poptbclist(L); /* remove it from list */ prepcallclosemth(L, tbc, status, yy); /* close variable */ level = restorestack(L, levelrel); } + return level; } diff --git a/3rdparty/lua/lgc.c b/3rdparty/lua/src/lgc.c similarity index 97% rename from 3rdparty/lua/lgc.c rename to 3rdparty/lua/src/lgc.c index b360eed..a3094ff 100644 --- a/3rdparty/lua/lgc.c +++ b/3rdparty/lua/src/lgc.c @@ -252,12 +252,13 @@ void luaC_fix (lua_State *L, GCObject *o) { /* -** create a new collectable object (with given type and size) and link -** it to 'allgc' list. +** create a new collectable object (with given type, size, and offset) +** and link it to 'allgc' list. */ -GCObject *luaC_newobj (lua_State *L, int tt, size_t sz) { +GCObject *luaC_newobjdt (lua_State *L, int tt, size_t sz, size_t offset) { global_State *g = G(L); - GCObject *o = cast(GCObject *, luaM_newobject(L, novariant(tt), sz)); + char *p = cast_charp(luaM_newobject(L, novariant(tt), sz)); + GCObject *o = cast(GCObject *, p + offset); o->marked = luaC_white(g); o->tt = tt; o->next = g->allgc; @@ -265,6 +266,11 @@ GCObject *luaC_newobj (lua_State *L, int tt, size_t sz) { return o; } + +GCObject *luaC_newobj (lua_State *L, int tt, size_t sz) { + return luaC_newobjdt(L, tt, sz, 0); +} + /* }====================================================== */ @@ -301,7 +307,7 @@ static void reallymarkobject (global_State *g, GCObject *o) { set2gray(uv); /* open upvalues are kept gray */ else set2black(uv); /* closed upvalues are visited here */ - markvalue(g, uv->v); /* mark its content */ + markvalue(g, uv->v.p); /* mark its content */ break; } case LUA_VUSERDATA: { @@ -376,7 +382,7 @@ static int remarkupvals (global_State *g) { work++; if (!iswhite(uv)) { /* upvalue already visited? */ lua_assert(upisopen(uv) && isgray(uv)); - markvalue(g, uv->v); /* mark its value */ + markvalue(g, uv->v.p); /* mark its value */ } } } @@ -620,19 +626,19 @@ static int traverseLclosure (global_State *g, LClosure *cl) { */ static int traversethread (global_State *g, lua_State *th) { UpVal *uv; - StkId o = th->stack; + StkId o = th->stack.p; if (isold(th) || g->gcstate == GCSpropagate) linkgclist(th, g->grayagain); /* insert into 'grayagain' list */ if (o == NULL) return 1; /* stack not completely built yet */ lua_assert(g->gcstate == GCSatomic || th->openupval == NULL || isintwups(th)); - for (; o < th->top; o++) /* mark live elements in the stack */ + for (; o < th->top.p; o++) /* mark live elements in the stack */ markvalue(g, s2v(o)); for (uv = th->openupval; uv != NULL; uv = uv->u.open.next) markobject(g, uv); /* open upvalues cannot be collected */ if (g->gcstate == GCSatomic) { /* final traversal? */ - for (; o < th->stack_last + EXTRA_STACK; o++) + for (; o < th->stack_last.p + EXTRA_STACK; o++) setnilvalue(s2v(o)); /* clear dead stack slice */ /* 'remarkupvals' may have removed thread from 'twups' list */ if (!isintwups(th) && th->openupval != NULL) { @@ -892,7 +898,7 @@ static GCObject *udata2finalize (global_State *g) { static void dothecall (lua_State *L, void *ud) { UNUSED(ud); - luaD_callnoyield(L, L->top - 2, 0); + luaD_callnoyield(L, L->top.p - 2, 0); } @@ -906,19 +912,19 @@ static void GCTM (lua_State *L) { if (!notm(tm)) { /* is there a finalizer? */ int status; lu_byte oldah = L->allowhook; - int running = g->gcrunning; + int oldgcstp = g->gcstp; + g->gcstp |= GCSTPGC; /* avoid GC steps */ L->allowhook = 0; /* stop debug hooks during GC metamethod */ - g->gcrunning = 0; /* avoid GC steps */ - setobj2s(L, L->top++, tm); /* push finalizer... */ - setobj2s(L, L->top++, &v); /* ... and its argument */ + setobj2s(L, L->top.p++, tm); /* push finalizer... */ + setobj2s(L, L->top.p++, &v); /* ... and its argument */ L->ci->callstatus |= CIST_FIN; /* will run a finalizer */ - status = luaD_pcall(L, dothecall, NULL, savestack(L, L->top - 2), 0); + status = luaD_pcall(L, dothecall, NULL, savestack(L, L->top.p - 2), 0); L->ci->callstatus &= ~CIST_FIN; /* not running a finalizer anymore */ L->allowhook = oldah; /* restore hooks */ - g->gcrunning = running; /* restore state */ + g->gcstp = oldgcstp; /* restore state */ if (l_unlikely(status != LUA_OK)) { /* error while running __gc? */ - luaE_warnerror(L, "__gc metamethod"); - L->top--; /* pops error object */ + luaE_warnerror(L, "__gc"); + L->top.p--; /* pops error object */ } } } @@ -1011,7 +1017,8 @@ static void correctpointers (global_State *g, GCObject *o) { void luaC_checkfinalizer (lua_State *L, GCObject *o, Table *mt) { global_State *g = G(L); if (tofinalize(o) || /* obj. is already marked... */ - gfasttm(g, mt, TM_GC) == NULL) /* or has no finalizer? */ + gfasttm(g, mt, TM_GC) == NULL || /* or has no finalizer... */ + (g->gcstp & GCSTPCLS)) /* or closing state? */ return; /* nothing to be done */ else { /* move 'o' to 'finobj' list */ GCObject **p; @@ -1040,7 +1047,25 @@ void luaC_checkfinalizer (lua_State *L, GCObject *o, Table *mt) { ** ======================================================= */ -static void setpause (global_State *g); + +/* +** Set the "time" to wait before starting a new GC cycle; cycle will +** start when memory use hits the threshold of ('estimate' * pause / +** PAUSEADJ). (Division by 'estimate' should be OK: it cannot be zero, +** because Lua cannot even start with less than PAUSEADJ bytes). +*/ +static void setpause (global_State *g) { + l_mem threshold, debt; + int pause = getgcparam(g->gcpause); + l_mem estimate = g->GCestimate / PAUSEADJ; /* adjust 'estimate' */ + lua_assert(estimate > 0); + threshold = (pause < MAX_LMEM / estimate) /* overflow? */ + ? estimate * pause /* no overflow */ + : MAX_LMEM; /* overflow; truncate to maximum */ + debt = gettotalbytes(g) - threshold; + if (debt > 0) debt = 0; + luaE_setdebt(g, debt); +} /* @@ -1284,6 +1309,15 @@ static void atomic2gen (lua_State *L, global_State *g) { } +/* +** Set debt for the next minor collection, which will happen when +** memory grows 'genminormul'%. +*/ +static void setminordebt (global_State *g) { + luaE_setdebt(g, -(cast(l_mem, (gettotalbytes(g) / 100)) * g->genminormul)); +} + + /* ** Enter generational mode. Must go until the end of an atomic cycle ** to ensure that all objects are correctly marked and weak tables @@ -1296,6 +1330,7 @@ static lu_mem entergen (lua_State *L, global_State *g) { luaC_runtilstate(L, bitmask(GCSpropagate)); /* start new cycle */ numobjs = atomic(L); /* propagates all and then do the atomic stuff */ atomic2gen(L, g); + setminordebt(g); /* set debt assuming next cycle will be minor */ return numobjs; } @@ -1341,15 +1376,6 @@ static lu_mem fullgen (lua_State *L, global_State *g) { } -/* -** Set debt for the next minor collection, which will happen when -** memory grows 'genminormul'%. -*/ -static void setminordebt (global_State *g) { - luaE_setdebt(g, -(cast(l_mem, (gettotalbytes(g) / 100)) * g->genminormul)); -} - - /* ** Does a major collection after last collection was a "bad collection". ** @@ -1421,8 +1447,8 @@ static void genstep (lua_State *L, global_State *g) { lu_mem numobjs = fullgen(L, g); /* do a major collection */ if (gettotalbytes(g) < majorbase + (majorinc / 2)) { /* collected at least half of memory growth since last major - collection; keep doing minor collections */ - setminordebt(g); + collection; keep doing minor collections. */ + lua_assert(g->lastatomic == 0); } else { /* bad collection */ g->lastatomic = numobjs; /* signal that last collection was bad */ @@ -1448,26 +1474,6 @@ static void genstep (lua_State *L, global_State *g) { */ -/* -** Set the "time" to wait before starting a new GC cycle; cycle will -** start when memory use hits the threshold of ('estimate' * pause / -** PAUSEADJ). (Division by 'estimate' should be OK: it cannot be zero, -** because Lua cannot even start with less than PAUSEADJ bytes). -*/ -static void setpause (global_State *g) { - l_mem threshold, debt; - int pause = getgcparam(g->gcpause); - l_mem estimate = g->GCestimate / PAUSEADJ; /* adjust 'estimate' */ - lua_assert(estimate > 0); - threshold = (pause < MAX_LMEM / estimate) /* overflow? */ - ? estimate * pause /* no overflow */ - : MAX_LMEM; /* overflow; truncate to maximum */ - debt = gettotalbytes(g) - threshold; - if (debt > 0) debt = 0; - luaE_setdebt(g, debt); -} - - /* ** Enter first sweep phase. ** The call to 'sweeptolive' makes the pointer point to an object @@ -1502,12 +1508,13 @@ static void deletelist (lua_State *L, GCObject *p, GCObject *limit) { */ void luaC_freeallobjects (lua_State *L) { global_State *g = G(L); + g->gcstp = GCSTPCLS; /* no extra finalizers after here */ luaC_changemode(L, KGC_INC); separatetobefnz(g, 1); /* separate all objects with finalizers */ lua_assert(g->finobj == NULL); callallpendingfinalizers(L); deletelist(L, g->allgc, obj2gco(g->mainthread)); - deletelist(L, g->finobj, NULL); + lua_assert(g->finobj == NULL); /* no new finalizers */ deletelist(L, g->fixedgc, NULL); /* collect fixed objects */ lua_assert(g->strt.nuse == 0); } @@ -1647,6 +1654,7 @@ void luaC_runtilstate (lua_State *L, int statesmask) { } + /* ** Performs a basic incremental step. The debt and step size are ** converted from bytes to "units of work"; then the function loops @@ -1673,12 +1681,15 @@ static void incstep (lua_State *L, global_State *g) { } /* -** performs a basic GC step if collector is running +** Performs a basic GC step if collector is running. (If collector is +** not running, set a reasonable debt to avoid it being called at +** every single check.) */ void luaC_step (lua_State *L) { global_State *g = G(L); - lua_assert(!g->gcemergency); - if (g->gcrunning) { /* running? */ + if (!gcrunning(g)) /* not running? */ + luaE_setdebt(g, -2000); + else { if(isdecGCmodegen(g)) genstep(L, g); else diff --git a/3rdparty/lua/linit.c b/3rdparty/lua/src/linit.c similarity index 100% rename from 3rdparty/lua/linit.c rename to 3rdparty/lua/src/linit.c diff --git a/3rdparty/lua/liolib.c b/3rdparty/lua/src/liolib.c similarity index 100% rename from 3rdparty/lua/liolib.c rename to 3rdparty/lua/src/liolib.c diff --git a/3rdparty/lua/llex.c b/3rdparty/lua/src/llex.c similarity index 98% rename from 3rdparty/lua/llex.c rename to 3rdparty/lua/src/llex.c index e991517..5fc39a5 100644 --- a/3rdparty/lua/llex.c +++ b/3rdparty/lua/src/llex.c @@ -128,7 +128,7 @@ l_noret luaX_syntaxerror (LexState *ls, const char *msg) { ** ensuring there is only one copy of each unique string. The table ** here is used as a set: the string enters as the key, while its value ** is irrelevant. We use the string itself as the value only because it -** is a TValue readly available. Later, the code generation can change +** is a TValue readily available. Later, the code generation can change ** this value. */ TString *luaX_newstring (LexState *ls, const char *str, size_t l) { @@ -138,12 +138,12 @@ TString *luaX_newstring (LexState *ls, const char *str, size_t l) { if (!ttisnil(o)) /* string already present? */ ts = keystrval(nodefromval(o)); /* get saved copy */ else { /* not in use yet */ - TValue *stv = s2v(L->top++); /* reserve stack space for string */ + TValue *stv = s2v(L->top.p++); /* reserve stack space for string */ setsvalue(L, stv, ts); /* temporarily anchor the string */ luaH_finishset(L, ls->h, stv, o, stv); /* t[string] = string */ /* table is not a metatable, so it does not need to invalidate cache */ luaC_checkGC(L); - L->top--; /* remove string from stack */ + L->top.p--; /* remove string from stack */ } return ts; } diff --git a/3rdparty/lua/lmathlib.c b/3rdparty/lua/src/lmathlib.c similarity index 97% rename from 3rdparty/lua/lmathlib.c rename to 3rdparty/lua/src/lmathlib.c index 5f5983a..d0b1e1e 100644 --- a/3rdparty/lua/lmathlib.c +++ b/3rdparty/lua/src/lmathlib.c @@ -267,7 +267,7 @@ static int math_type (lua_State *L) { /* try to find an integer type with at least 64 bits */ -#if (ULONG_MAX >> 31 >> 31) >= 3 +#if ((ULONG_MAX >> 31) >> 31) >= 3 /* 'long' has at least 64 bits */ #define Rand64 unsigned long @@ -277,9 +277,9 @@ static int math_type (lua_State *L) { /* there is a 'long long' type (which must have at least 64 bits) */ #define Rand64 unsigned long long -#elif (LUA_MAXUNSIGNED >> 31 >> 31) >= 3 +#elif ((LUA_MAXUNSIGNED >> 31) >> 31) >= 3 -/* 'lua_Integer' has at least 64 bits */ +/* 'lua_Unsigned' has at least 64 bits */ #define Rand64 lua_Unsigned #endif @@ -475,7 +475,7 @@ static lua_Number I2d (Rand64 x) { /* 2^(-FIGS) = 1.0 / 2^30 / 2^3 / 2^(FIGS-33) */ #define scaleFIG \ - ((lua_Number)1.0 / (UONE << 30) / 8.0 / (UONE << (FIGS - 33))) + (l_mathop(1.0) / (UONE << 30) / l_mathop(8.0) / (UONE << (FIGS - 33))) /* ** use FIGS - 32 bits from lower half, throwing out the other @@ -486,7 +486,7 @@ static lua_Number I2d (Rand64 x) { /* ** higher 32 bits go after those (FIGS - 32) bits: shiftHI = 2^(FIGS - 32) */ -#define shiftHI ((lua_Number)(UONE << (FIGS - 33)) * 2.0) +#define shiftHI ((lua_Number)(UONE << (FIGS - 33)) * l_mathop(2.0)) static lua_Number I2d (Rand64 x) { @@ -500,12 +500,12 @@ static lua_Number I2d (Rand64 x) { /* convert a 'Rand64' to a 'lua_Unsigned' */ static lua_Unsigned I2UInt (Rand64 x) { - return ((lua_Unsigned)trim32(x.h) << 31 << 1) | (lua_Unsigned)trim32(x.l); + return (((lua_Unsigned)trim32(x.h) << 31) << 1) | (lua_Unsigned)trim32(x.l); } /* convert a 'lua_Unsigned' to a 'Rand64' */ static Rand64 Int2I (lua_Unsigned n) { - return packI((lu_int32)(n >> 31 >> 1), (lu_int32)n); + return packI((lu_int32)((n >> 31) >> 1), (lu_int32)n); } #endif /* } */ diff --git a/3rdparty/lua/lmem.c b/3rdparty/lua/src/lmem.c similarity index 82% rename from 3rdparty/lua/lmem.c rename to 3rdparty/lua/src/lmem.c index 9029d58..9800a86 100644 --- a/3rdparty/lua/lmem.c +++ b/3rdparty/lua/src/lmem.c @@ -22,25 +22,6 @@ #include "lstate.h" -#if defined(EMERGENCYGCTESTS) -/* -** First allocation will fail whenever not building initial state. -** (This fail will trigger 'tryagain' and a full GC cycle at every -** allocation.) -*/ -static void *firsttry (global_State *g, void *block, size_t os, size_t ns) { - if (completestate(g) && ns > 0) /* frees never fail */ - return NULL; /* fail */ - else /* normal allocation */ - return (*g->frealloc)(g->ud, block, os, ns); -} -#else -#define firsttry(g,block,os,ns) ((*g->frealloc)(g->ud, block, os, ns)) -#endif - - - - /* ** About the realloc function: @@ -60,6 +41,43 @@ static void *firsttry (global_State *g, void *block, size_t os, size_t ns) { */ +/* +** Macro to call the allocation function. +*/ +#define callfrealloc(g,block,os,ns) ((*g->frealloc)(g->ud, block, os, ns)) + + +/* +** When an allocation fails, it will try again after an emergency +** collection, except when it cannot run a collection. The GC should +** not be called while the state is not fully built, as the collector +** is not yet fully initialized. Also, it should not be called when +** 'gcstopem' is true, because then the interpreter is in the middle of +** a collection step. +*/ +#define cantryagain(g) (completestate(g) && !g->gcstopem) + + + + +#if defined(EMERGENCYGCTESTS) +/* +** First allocation will fail except when freeing a block (frees never +** fail) and when it cannot try again; this fail will trigger 'tryagain' +** and a full GC cycle at every allocation. +*/ +static void *firsttry (global_State *g, void *block, size_t os, size_t ns) { + if (ns > 0 && cantryagain(g)) + return NULL; /* fail */ + else /* normal allocation */ + return callfrealloc(g, block, os, ns); +} +#else +#define firsttry(g,block,os,ns) callfrealloc(g, block, os, ns) +#endif + + + /* @@ -132,7 +150,7 @@ l_noret luaM_toobig (lua_State *L) { void luaM_free_ (lua_State *L, void *block, size_t osize) { global_State *g = G(L); lua_assert((osize == 0) == (block == NULL)); - (*g->frealloc)(g->ud, block, osize, 0); + callfrealloc(g, block, osize, 0); g->GCdebt -= osize; } @@ -140,19 +158,15 @@ void luaM_free_ (lua_State *L, void *block, size_t osize) { /* ** In case of allocation fail, this function will do an emergency ** collection to free some memory and then try the allocation again. -** The GC should not be called while state is not fully built, as the -** collector is not yet fully initialized. Also, it should not be called -** when 'gcstopem' is true, because then the interpreter is in the -** middle of a collection step. */ static void *tryagain (lua_State *L, void *block, size_t osize, size_t nsize) { global_State *g = G(L); - if (completestate(g) && !g->gcstopem) { + if (cantryagain(g)) { luaC_fullgc(L, 1); /* try to free some memory... */ - return (*g->frealloc)(g->ud, block, osize, nsize); /* try again */ + return callfrealloc(g, block, osize, nsize); /* try again */ } - else return NULL; /* cannot free any memory without a full state */ + else return NULL; /* cannot run an emergency collection */ } diff --git a/3rdparty/lua/loadlib.c b/3rdparty/lua/src/loadlib.c similarity index 99% rename from 3rdparty/lua/loadlib.c rename to 3rdparty/lua/src/loadlib.c index 6f9fa37..d792dff 100644 --- a/3rdparty/lua/loadlib.c +++ b/3rdparty/lua/src/loadlib.c @@ -708,8 +708,13 @@ static const luaL_Reg ll_funcs[] = { static void createsearcherstable (lua_State *L) { - static const lua_CFunction searchers[] = - {searcher_preload, searcher_Lua, searcher_C, searcher_Croot, NULL}; + static const lua_CFunction searchers[] = { + searcher_preload, + searcher_Lua, + searcher_C, + searcher_Croot, + NULL + }; int i; /* create 'searchers' table */ lua_createtable(L, sizeof(searchers)/sizeof(searchers[0]) - 1, 0); diff --git a/3rdparty/lua/lobject.c b/3rdparty/lua/src/lobject.c similarity index 92% rename from 3rdparty/lua/lobject.c rename to 3rdparty/lua/src/lobject.c index 0e504be..f73ffc6 100644 --- a/3rdparty/lua/lobject.c +++ b/3rdparty/lua/src/lobject.c @@ -62,7 +62,7 @@ static lua_Integer intarith (lua_State *L, int op, lua_Integer v1, case LUA_OPBOR: return intop(|, v1, v2); case LUA_OPBXOR: return intop(^, v1, v2); case LUA_OPSHL: return luaV_shiftl(v1, v2); - case LUA_OPSHR: return luaV_shiftl(v1, -v2); + case LUA_OPSHR: return luaV_shiftr(v1, v2); case LUA_OPUNM: return intop(-, 0, v1); case LUA_OPBNOT: return intop(^, ~l_castS2U(0), v1); default: lua_assert(0); return 0; @@ -164,7 +164,7 @@ static int isneg (const char **s) { */ static lua_Number lua_strx2number (const char *s, char **endptr) { int dot = lua_getlocaledecpoint(); - lua_Number r = 0.0; /* result (accumulator) */ + lua_Number r = l_mathop(0.0); /* result (accumulator) */ int sigdig = 0; /* number of significant digits */ int nosigdig = 0; /* number of non-significant digits */ int e = 0; /* exponent correction */ @@ -174,7 +174,7 @@ static lua_Number lua_strx2number (const char *s, char **endptr) { while (lisspace(cast_uchar(*s))) s++; /* skip initial spaces */ neg = isneg(&s); /* check sign */ if (!(*s == '0' && (*(s + 1) == 'x' || *(s + 1) == 'X'))) /* check '0x' */ - return 0.0; /* invalid format (no '0x') */ + return l_mathop(0.0); /* invalid format (no '0x') */ for (s += 2; ; s++) { /* skip '0x' and read numeral */ if (*s == dot) { if (hasdot) break; /* second dot? stop loop */ @@ -184,14 +184,14 @@ static lua_Number lua_strx2number (const char *s, char **endptr) { if (sigdig == 0 && *s == '0') /* non-significant digit (zero)? */ nosigdig++; else if (++sigdig <= MAXSIGDIG) /* can read it without overflow? */ - r = (r * cast_num(16.0)) + luaO_hexavalue(*s); + r = (r * l_mathop(16.0)) + luaO_hexavalue(*s); else e++; /* too many digits; ignore, but still count for exponent */ if (hasdot) e--; /* decimal digit? correct exponent */ } else break; /* neither a dot nor a digit */ } if (nosigdig + sigdig == 0) /* no digits? */ - return 0.0; /* invalid format */ + return l_mathop(0.0); /* invalid format */ *endptr = cast_charp(s); /* valid up to here */ e *= 4; /* each digit multiplies/divides value by 2^4 */ if (*s == 'p' || *s == 'P') { /* exponent part? */ @@ -200,7 +200,7 @@ static lua_Number lua_strx2number (const char *s, char **endptr) { s++; /* skip 'p' */ neg1 = isneg(&s); /* sign */ if (!lisdigit(cast_uchar(*s))) - return 0.0; /* invalid; must have at least one digit */ + return l_mathop(0.0); /* invalid; must have at least one digit */ while (lisdigit(cast_uchar(*s))) /* read exponent */ exp1 = exp1 * 10 + *(s++) - '0'; if (neg1) exp1 = -exp1; @@ -386,29 +386,39 @@ void luaO_tostring (lua_State *L, TValue *obj) { ** =================================================================== */ -/* size for buffer space used by 'luaO_pushvfstring' */ -#define BUFVFS 200 +/* +** Size for buffer space used by 'luaO_pushvfstring'. It should be +** (LUA_IDSIZE + MAXNUMBER2STR) + a minimal space for basic messages, +** so that 'luaG_addinfo' can work directly on the buffer. +*/ +#define BUFVFS (LUA_IDSIZE + MAXNUMBER2STR + 95) /* buffer used by 'luaO_pushvfstring' */ typedef struct BuffFS { lua_State *L; - int pushed; /* number of string pieces already on the stack */ + int pushed; /* true if there is a part of the result on the stack */ int blen; /* length of partial string in 'space' */ char space[BUFVFS]; /* holds last part of the result */ } BuffFS; /* -** Push given string to the stack, as part of the buffer, and -** join the partial strings in the stack into one. +** Push given string to the stack, as part of the result, and +** join it to previous partial result if there is one. +** It may call 'luaV_concat' while using one slot from EXTRA_STACK. +** This call cannot invoke metamethods, as both operands must be +** strings. It can, however, raise an error if the result is too +** long. In that case, 'luaV_concat' frees the extra slot before +** raising the error. */ -static void pushstr (BuffFS *buff, const char *str, size_t l) { +static void pushstr (BuffFS *buff, const char *str, size_t lstr) { lua_State *L = buff->L; - setsvalue2s(L, L->top, luaS_newlstr(L, str, l)); - L->top++; /* may use one extra slot */ - buff->pushed++; - luaV_concat(L, buff->pushed); /* join partial results into one */ - buff->pushed = 1; + setsvalue2s(L, L->top.p, luaS_newlstr(L, str, lstr)); + L->top.p++; /* may use one slot from EXTRA_STACK */ + if (!buff->pushed) /* no previous string on the stack? */ + buff->pushed = 1; /* now there is one */ + else /* join previous string with new one */ + luaV_concat(L, 2); } @@ -454,7 +464,7 @@ static void addstr2buff (BuffFS *buff, const char *str, size_t slen) { /* -** Add a number to the buffer. +** Add a numeral to the buffer. */ static void addnum2buff (BuffFS *buff, TValue *num) { char *numbuff = getbuff(buff, MAXNUMBER2STR); @@ -532,7 +542,7 @@ const char *luaO_pushvfstring (lua_State *L, const char *fmt, va_list argp) { addstr2buff(&buff, fmt, strlen(fmt)); /* rest of 'fmt' */ clearbuff(&buff); /* empty buffer into the stack */ lua_assert(buff.pushed == 1); - return svalue(s2v(L->top - 1)); + return svalue(s2v(L->top.p - 1)); } diff --git a/3rdparty/lua/lopcodes.c b/3rdparty/lua/src/lopcodes.c similarity index 100% rename from 3rdparty/lua/lopcodes.c rename to 3rdparty/lua/src/lopcodes.c diff --git a/3rdparty/lua/loslib.c b/3rdparty/lua/src/loslib.c similarity index 94% rename from 3rdparty/lua/loslib.c rename to 3rdparty/lua/src/loslib.c index 3e20d62..ad5a927 100644 --- a/3rdparty/lua/loslib.c +++ b/3rdparty/lua/src/loslib.c @@ -30,23 +30,14 @@ */ #if !defined(LUA_STRFTIMEOPTIONS) /* { */ -/* options for ANSI C 89 (only 1-char options) */ -#define L_STRFTIMEC89 "aAbBcdHIjmMpSUwWxXyYZ%" - -/* options for ISO C 99 and POSIX */ -#define L_STRFTIMEC99 "aAbBcCdDeFgGhHIjmMnprRStTuUVwWxXyYzZ%" \ - "||" "EcECExEXEyEY" "OdOeOHOIOmOMOSOuOUOVOwOWOy" /* two-char options */ - -/* options for Windows */ -#define L_STRFTIMEWIN "aAbBcdHIjmMpSUwWxXyYzZ%" \ - "||" "#c#x#d#H#I#j#m#M#S#U#w#W#y#Y" /* two-char options */ - #if defined(LUA_USE_WINDOWS) -#define LUA_STRFTIMEOPTIONS L_STRFTIMEWIN -#elif defined(LUA_USE_C89) -#define LUA_STRFTIMEOPTIONS L_STRFTIMEC89 +#define LUA_STRFTIMEOPTIONS "aAbBcdHIjmMpSUwWxXyYzZ%" \ + "||" "#c#x#d#H#I#j#m#M#S#U#w#W#y#Y" /* two-char options */ +#elif defined(LUA_USE_C89) /* ANSI C 89 (only 1-char options) */ +#define LUA_STRFTIMEOPTIONS "aAbBcdHIjmMpSUwWxXyYZ%" #else /* C99 specification */ -#define LUA_STRFTIMEOPTIONS L_STRFTIMEC99 +#define LUA_STRFTIMEOPTIONS "aAbBcCdDeFgGhHIjmMnprRStTuUVwWxXyYzZ%" \ + "||" "EcECExEXEyEY" "OdOeOHOIOmOMOSOuOUOVOwOWOy" /* two-char options */ #endif #endif /* } */ @@ -138,12 +129,21 @@ /* }================================================================== */ +#if !defined(l_system) +#if defined(LUA_USE_IOS) +/* Despite claiming to be ISO C, iOS does not implement 'system'. */ +#define l_system(cmd) ((cmd) == NULL ? 0 : -1) +#else +#define l_system(cmd) system(cmd) /* default definition */ +#endif +#endif + static int os_execute (lua_State *L) { const char *cmd = luaL_optstring(L, 1, NULL); int stat; errno = 0; - stat = system(cmd); + stat = l_system(cmd); if (cmd != NULL) return luaL_execresult(L, stat); else { @@ -260,9 +260,7 @@ static int getfield (lua_State *L, const char *key, int d, int delta) { res = d; } else { - /* unsigned avoids overflow when lua_Integer has 32 bits */ - if (!(res >= 0 ? (lua_Unsigned)res <= (lua_Unsigned)INT_MAX + delta - : (lua_Integer)INT_MIN + delta <= res)) + if (!(res >= 0 ? res - delta <= INT_MAX : INT_MIN + delta <= res)) return luaL_error(L, "field '%s' is out-of-bound", key); res -= delta; } diff --git a/3rdparty/lua/lparser.c b/3rdparty/lua/src/lparser.c similarity index 97% rename from 3rdparty/lua/lparser.c rename to 3rdparty/lua/src/lparser.c index 284ef1f..b745f23 100644 --- a/3rdparty/lua/lparser.c +++ b/3rdparty/lua/src/lparser.c @@ -416,6 +416,17 @@ static void markupval (FuncState *fs, int level) { } +/* +** Mark that current block has a to-be-closed variable. +*/ +static void marktobeclosed (FuncState *fs) { + BlockCnt *bl = fs->bl; + bl->upval = 1; + bl->insidetbc = 1; + fs->needclose = 1; +} + + /* ** Find a variable with the given name 'n'. If it is an upvalue, add ** this upvalue into all intermediate functions. If it is a global, set @@ -457,6 +468,7 @@ static void singlevar (LexState *ls, expdesc *var) { expdesc key; singlevaraux(fs, ls->envn, var, 1); /* get environment variable */ lua_assert(var->k != VVOID); /* this one must exist */ + luaK_exp2anyregup(fs, var); /* but could be a constant */ codestring(&key, varname); /* key is variable name */ luaK_indexed(fs, var, &key); /* env[varname] */ } @@ -509,12 +521,12 @@ static l_noret jumpscopeerror (LexState *ls, Labeldesc *gt) { /* ** Solves the goto at index 'g' to given 'label' and removes it -** from the list of pending goto's. +** from the list of pending gotos. ** If it jumps into the scope of some variable, raises an error. */ static void solvegoto (LexState *ls, int g, Labeldesc *label) { int i; - Labellist *gl = &ls->dyd->gt; /* list of goto's */ + Labellist *gl = &ls->dyd->gt; /* list of gotos */ Labeldesc *gt = &gl->arr[g]; /* goto to be resolved */ lua_assert(eqstr(gt->name, label->name)); if (l_unlikely(gt->nactvar < label->nactvar)) /* enter some scope? */ @@ -568,7 +580,7 @@ static int newgotoentry (LexState *ls, TString *name, int line, int pc) { /* ** Solves forward jumps. Check whether new label 'lb' matches any ** pending gotos in current block and solves them. Return true -** if any of the goto's need to close upvalues. +** if any of the gotos need to close upvalues. */ static int solvegotos (LexState *ls, Labeldesc *lb) { Labellist *gl = &ls->dyd->gt; @@ -589,7 +601,7 @@ static int solvegotos (LexState *ls, Labeldesc *lb) { /* ** Create a new label with the given 'name' at the given 'line'. ** 'last' tells whether label is the last non-op statement in its -** block. Solves all pending goto's to this new label and adds +** block. Solves all pending gotos to this new label and adds ** a close instruction if necessary. ** Returns true iff it added a close instruction. */ @@ -662,19 +674,19 @@ static void leaveblock (FuncState *fs) { LexState *ls = fs->ls; int hasclose = 0; int stklevel = reglevel(fs, bl->nactvar); /* level outside the block */ - if (bl->isloop) /* fix pending breaks? */ + removevars(fs, bl->nactvar); /* remove block locals */ + lua_assert(bl->nactvar == fs->nactvar); /* back to level on entry */ + if (bl->isloop) /* has to fix pending breaks? */ hasclose = createlabel(ls, luaS_newliteral(ls->L, "break"), 0, 0); - if (!hasclose && bl->previous && bl->upval) + if (!hasclose && bl->previous && bl->upval) /* still need a 'close'? */ luaK_codeABC(fs, OP_CLOSE, stklevel, 0, 0); - fs->bl = bl->previous; - removevars(fs, bl->nactvar); - lua_assert(bl->nactvar == fs->nactvar); fs->freereg = stklevel; /* free registers */ ls->dyd->label.n = bl->firstlabel; /* remove local labels */ - if (bl->previous) /* inner block? */ - movegotosout(fs, bl); /* update pending gotos to outer block */ + fs->bl = bl->previous; /* current block now is previous one */ + if (bl->previous) /* was it a nested block? */ + movegotosout(fs, bl); /* update pending gotos to enclosing block */ else { - if (bl->firstgoto < ls->dyd->gt.n) /* pending gotos in outer block? */ + if (bl->firstgoto < ls->dyd->gt.n) /* still pending gotos? */ undefgoto(ls, &ls->dyd->gt.arr[bl->firstgoto]); /* error */ } } @@ -1599,7 +1611,7 @@ static void forlist (LexState *ls, TString *indexname) { line = ls->linenumber; adjust_assign(ls, 4, explist(ls, &e), &e); adjustlocalvars(ls, 4); /* control variables */ - markupval(fs, fs->nactvar); /* last control var. must be closed */ + marktobeclosed(fs); /* last control var. must be closed */ luaK_checkstack(fs, 3); /* extra space to call generator */ forbody(ls, base, line, nvars - 4, 1); } @@ -1703,11 +1715,9 @@ static int getlocalattribute (LexState *ls) { } -static void checktoclose (LexState *ls, int level) { +static void checktoclose (FuncState *fs, int level) { if (level != -1) { /* is there a to-be-closed variable? */ - FuncState *fs = ls->fs; - markupval(fs, level + 1); - fs->bl->insidetbc = 1; /* in the scope of a to-be-closed variable */ + marktobeclosed(fs); luaK_codeABC(fs, OP_TBC, reglevel(fs, level), 0, 0); } } @@ -1751,7 +1761,7 @@ static void localstat (LexState *ls) { adjust_assign(ls, nvars, nexps, &e); adjustlocalvars(ls, nvars); } - checktoclose(ls, toclose); + checktoclose(fs, toclose); } @@ -1776,6 +1786,7 @@ static void funcstat (LexState *ls, int line) { luaX_next(ls); /* skip FUNCTION */ ismethod = funcname(ls, &v); body(ls, &b, ismethod, line); + check_readonly(ls, &v); luaK_storevar(ls->fs, &v, &b); luaK_fixline(ls->fs, line); /* definition "happens" in the first line */ } @@ -1933,10 +1944,10 @@ LClosure *luaY_parser (lua_State *L, ZIO *z, Mbuffer *buff, LexState lexstate; FuncState funcstate; LClosure *cl = luaF_newLclosure(L, 1); /* create main closure */ - setclLvalue2s(L, L->top, cl); /* anchor it (to avoid being collected) */ + setclLvalue2s(L, L->top.p, cl); /* anchor it (to avoid being collected) */ luaD_inctop(L); lexstate.h = luaH_new(L); /* create table for scanner */ - sethvalue2s(L, L->top, lexstate.h); /* anchor it */ + sethvalue2s(L, L->top.p, lexstate.h); /* anchor it */ luaD_inctop(L); funcstate.f = cl->p = luaF_newproto(L); luaC_objbarrier(L, cl, cl->p); @@ -1950,7 +1961,7 @@ LClosure *luaY_parser (lua_State *L, ZIO *z, Mbuffer *buff, lua_assert(!funcstate.prev && funcstate.nups == 1 && !lexstate.fs); /* all scopes should be correctly finished */ lua_assert(dyd->actvar.n == 0 && dyd->gt.n == 0 && dyd->label.n == 0); - L->top--; /* remove scanner's table */ + L->top.p--; /* remove scanner's table */ return cl; /* closure is on the stack, too */ } diff --git a/3rdparty/lua/lstate.c b/3rdparty/lua/src/lstate.c similarity index 85% rename from 3rdparty/lua/lstate.c rename to 3rdparty/lua/src/lstate.c index c5e3b43..1e925e5 100644 --- a/3rdparty/lua/lstate.c +++ b/3rdparty/lua/src/lstate.c @@ -166,7 +166,7 @@ void luaE_checkcstack (lua_State *L) { if (getCcalls(L) == LUAI_MAXCCALLS) luaG_runerror(L, "C stack overflow"); else if (getCcalls(L) >= (LUAI_MAXCCALLS / 10 * 11)) - luaD_throw(L, LUA_ERRERR); /* error while handing stack error */ + luaD_throw(L, LUA_ERRERR); /* error while handling stack error */ } @@ -180,33 +180,33 @@ LUAI_FUNC void luaE_incCstack (lua_State *L) { static void stack_init (lua_State *L1, lua_State *L) { int i; CallInfo *ci; /* initialize stack array */ - L1->stack = luaM_newvector(L, BASIC_STACK_SIZE + EXTRA_STACK, StackValue); - L1->tbclist = L1->stack; + L1->stack.p = luaM_newvector(L, BASIC_STACK_SIZE + EXTRA_STACK, StackValue); + L1->tbclist.p = L1->stack.p; for (i = 0; i < BASIC_STACK_SIZE + EXTRA_STACK; i++) - setnilvalue(s2v(L1->stack + i)); /* erase new stack */ - L1->top = L1->stack; - L1->stack_last = L1->stack + BASIC_STACK_SIZE; + setnilvalue(s2v(L1->stack.p + i)); /* erase new stack */ + L1->top.p = L1->stack.p; + L1->stack_last.p = L1->stack.p + BASIC_STACK_SIZE; /* initialize first ci */ ci = &L1->base_ci; ci->next = ci->previous = NULL; ci->callstatus = CIST_C; - ci->func = L1->top; + ci->func.p = L1->top.p; ci->u.c.k = NULL; ci->nresults = 0; - setnilvalue(s2v(L1->top)); /* 'function' entry for this 'ci' */ - L1->top++; - ci->top = L1->top + LUA_MINSTACK; + setnilvalue(s2v(L1->top.p)); /* 'function' entry for this 'ci' */ + L1->top.p++; + ci->top.p = L1->top.p + LUA_MINSTACK; L1->ci = ci; } static void freestack (lua_State *L) { - if (L->stack == NULL) + if (L->stack.p == NULL) return; /* stack not completely built yet */ L->ci = &L->base_ci; /* free the entire 'ci' list */ luaE_freeCI(L); lua_assert(L->nci == 0); - luaM_freearray(L, L->stack, stacksize(L) + EXTRA_STACK); /* free stack */ + luaM_freearray(L, L->stack.p, stacksize(L) + EXTRA_STACK); /* free stack */ } @@ -236,7 +236,7 @@ static void f_luaopen (lua_State *L, void *ud) { luaS_init(L); luaT_init(L); luaX_init(L); - g->gcrunning = 1; /* allow gc */ + g->gcstp = 0; /* allow gc */ setnilvalue(&g->nilvalue); /* now state is complete */ luai_userstateopen(L); } @@ -248,7 +248,7 @@ static void f_luaopen (lua_State *L, void *ud) { */ static void preinit_thread (lua_State *L, global_State *g) { G(L) = g; - L->stack = NULL; + L->stack.p = NULL; L->ci = NULL; L->nci = 0; L->twups = L; /* thread has no upvalues */ @@ -269,8 +269,9 @@ static void preinit_thread (lua_State *L, global_State *g) { static void close_state (lua_State *L) { global_State *g = G(L); if (!completestate(g)) /* closing a partially built state? */ - luaC_freeallobjects(L); /* jucst collect its objects */ + luaC_freeallobjects(L); /* just collect its objects */ else { /* closing a fully built state */ + L->ci = &L->base_ci; /* unwind CallInfo list */ luaD_closeprotected(L, 1, LUA_OK); /* close all upvalues */ luaC_freeallobjects(L); /* collect all objects */ luai_userstateclose(L); @@ -283,20 +284,16 @@ static void close_state (lua_State *L) { LUA_API lua_State *lua_newthread (lua_State *L) { - global_State *g; + global_State *g = G(L); + GCObject *o; lua_State *L1; lua_lock(L); - g = G(L); luaC_checkGC(L); /* create new thread */ - L1 = &cast(LX *, luaM_newobject(L, LUA_TTHREAD, sizeof(LX)))->l; - L1->marked = luaC_white(g); - L1->tt = LUA_VTHREAD; - /* link it on list 'allgc' */ - L1->next = g->allgc; - g->allgc = obj2gco(L1); + o = luaC_newobjdt(L, LUA_TTHREAD, sizeof(LX), offsetof(LX, l)); + L1 = gco2th(o); /* anchor it on L stack */ - setthvalue2s(L, L->top, L1); + setthvalue2s(L, L->top.p, L1); api_incr_top(L); preinit_thread(L1, g); L1->hookmask = L->hookmask; @@ -315,7 +312,7 @@ LUA_API lua_State *lua_newthread (lua_State *L) { void luaE_freethread (lua_State *L, lua_State *L1) { LX *l = fromstate(L1); - luaF_closeupval(L1, L1->stack); /* close all upvalues */ + luaF_closeupval(L1, L1->stack.p); /* close all upvalues */ lua_assert(L1->openupval == NULL); luai_userstatefree(L, L1); freestack(L1); @@ -325,32 +322,41 @@ void luaE_freethread (lua_State *L, lua_State *L1) { int luaE_resetthread (lua_State *L, int status) { CallInfo *ci = L->ci = &L->base_ci; /* unwind CallInfo list */ - setnilvalue(s2v(L->stack)); /* 'function' entry for basic 'ci' */ - ci->func = L->stack; + setnilvalue(s2v(L->stack.p)); /* 'function' entry for basic 'ci' */ + ci->func.p = L->stack.p; ci->callstatus = CIST_C; if (status == LUA_YIELD) status = LUA_OK; + L->status = LUA_OK; /* so it can run __close metamethods */ status = luaD_closeprotected(L, 1, status); if (status != LUA_OK) /* errors? */ - luaD_seterrorobj(L, status, L->stack + 1); + luaD_seterrorobj(L, status, L->stack.p + 1); else - L->top = L->stack + 1; - ci->top = L->top + LUA_MINSTACK; - L->status = cast_byte(status); - luaD_reallocstack(L, cast_int(ci->top - L->stack), 0); + L->top.p = L->stack.p + 1; + ci->top.p = L->top.p + LUA_MINSTACK; + luaD_reallocstack(L, cast_int(ci->top.p - L->stack.p), 0); return status; } -LUA_API int lua_resetthread (lua_State *L) { +LUA_API int lua_closethread (lua_State *L, lua_State *from) { int status; lua_lock(L); + L->nCcalls = (from) ? getCcalls(from) : 0; status = luaE_resetthread(L, L->status); lua_unlock(L); return status; } +/* +** Deprecated! Use 'lua_closethread' instead. +*/ +LUA_API int lua_resetthread (lua_State *L) { + return lua_closethread(L, NULL); +} + + LUA_API lua_State *lua_newstate (lua_Alloc f, void *ud) { int i; lua_State *L; @@ -372,7 +378,7 @@ LUA_API lua_State *lua_newstate (lua_Alloc f, void *ud) { g->ud_warn = NULL; g->mainthread = L; g->seed = luai_makeseed(L); - g->gcrunning = 0; /* no GC while building state */ + g->gcstp = GCSTPGC; /* no GC while building state */ g->strt.size = g->strt.nuse = 0; g->strt.hash = NULL; setnilvalue(&g->l_registry); @@ -425,7 +431,7 @@ void luaE_warning (lua_State *L, const char *msg, int tocont) { ** Generate a warning from an error message */ void luaE_warnerror (lua_State *L, const char *where) { - TValue *errobj = s2v(L->top - 1); /* error object */ + TValue *errobj = s2v(L->top.p - 1); /* error object */ const char *msg = (ttisstring(errobj)) ? svalue(errobj) : "error object is not a string"; diff --git a/3rdparty/lua/lstring.c b/3rdparty/lua/src/lstring.c similarity index 100% rename from 3rdparty/lua/lstring.c rename to 3rdparty/lua/src/lstring.c diff --git a/3rdparty/lua/lstrlib.c b/3rdparty/lua/src/lstrlib.c similarity index 94% rename from 3rdparty/lua/lstrlib.c rename to 3rdparty/lua/src/lstrlib.c index 47e5b27..0316716 100644 --- a/3rdparty/lua/lstrlib.c +++ b/3rdparty/lua/src/lstrlib.c @@ -570,7 +570,7 @@ static const char *match_capture (MatchState *ms, const char *s, int l) { static const char *match (MatchState *ms, const char *s, const char *p) { if (l_unlikely(ms->matchdepth-- == 0)) luaL_error(ms->L, "pattern too complex"); - init: /* using goto's to optimize tail recursion */ + init: /* using goto to optimize tail recursion */ if (p != ms->p_end) { /* end of pattern? */ switch (*p) { case '(': { /* start capture */ @@ -1090,13 +1090,31 @@ static int lua_number2strx (lua_State *L, char *buff, int sz, /* valid flags in a format specification */ -#if !defined(L_FMTFLAGS) -#define L_FMTFLAGS "-+ #0" +#if !defined(L_FMTFLAGSF) + +/* valid flags for a, A, e, E, f, F, g, and G conversions */ +#define L_FMTFLAGSF "-+#0 " + +/* valid flags for o, x, and X conversions */ +#define L_FMTFLAGSX "-#0" + +/* valid flags for d and i conversions */ +#define L_FMTFLAGSI "-+0 " + +/* valid flags for u conversions */ +#define L_FMTFLAGSU "-0" + +/* valid flags for c, p, and s conversions */ +#define L_FMTFLAGSC "-" + #endif /* -** maximum size of each format specification (such as "%-099.99d") +** Maximum size of each format specification (such as "%-099.99d"): +** Initial '%', flags (up to 5), width (2), period, precision (2), +** length modifier (8), conversion specifier, and final '\0', plus some +** extra. */ #define MAX_FORMAT 32 @@ -1189,25 +1207,53 @@ static void addliteral (lua_State *L, luaL_Buffer *b, int arg) { } -static const char *scanformat (lua_State *L, const char *strfrmt, char *form) { - const char *p = strfrmt; - while (*p != '\0' && strchr(L_FMTFLAGS, *p) != NULL) p++; /* skip flags */ - if ((size_t)(p - strfrmt) >= sizeof(L_FMTFLAGS)/sizeof(char)) - luaL_error(L, "invalid format (repeated flags)"); - if (isdigit(uchar(*p))) p++; /* skip width */ - if (isdigit(uchar(*p))) p++; /* (2 digits at most) */ - if (*p == '.') { - p++; - if (isdigit(uchar(*p))) p++; /* skip precision */ - if (isdigit(uchar(*p))) p++; /* (2 digits at most) */ +static const char *get2digits (const char *s) { + if (isdigit(uchar(*s))) { + s++; + if (isdigit(uchar(*s))) s++; /* (2 digits at most) */ } - if (isdigit(uchar(*p))) - luaL_error(L, "invalid format (width or precision too long)"); + return s; +} + + +/* +** Check whether a conversion specification is valid. When called, +** first character in 'form' must be '%' and last character must +** be a valid conversion specifier. 'flags' are the accepted flags; +** 'precision' signals whether to accept a precision. +*/ +static void checkformat (lua_State *L, const char *form, const char *flags, + int precision) { + const char *spec = form + 1; /* skip '%' */ + spec += strspn(spec, flags); /* skip flags */ + if (*spec != '0') { /* a width cannot start with '0' */ + spec = get2digits(spec); /* skip width */ + if (*spec == '.' && precision) { + spec++; + spec = get2digits(spec); /* skip precision */ + } + } + if (!isalpha(uchar(*spec))) /* did not go to the end? */ + luaL_error(L, "invalid conversion specification: '%s'", form); +} + + +/* +** Get a conversion specification and copy it to 'form'. +** Return the address of its last character. +*/ +static const char *getformat (lua_State *L, const char *strfrmt, + char *form) { + /* spans flags, width, and precision ('0' is included as a flag) */ + size_t len = strspn(strfrmt, L_FMTFLAGSF "123456789."); + len++; /* adds following character (should be the specifier) */ + /* still needs space for '%', '\0', plus a length modifier */ + if (len >= MAX_FORMAT - 10) + luaL_error(L, "invalid format (too long)"); *(form++) = '%'; - memcpy(form, strfrmt, ((p - strfrmt) + 1) * sizeof(char)); - form += (p - strfrmt) + 1; - *form = '\0'; - return p; + memcpy(form, strfrmt, len * sizeof(char)); + *(form + len) = '\0'; + return strfrmt + len - 1; } @@ -1230,6 +1276,7 @@ static int str_format (lua_State *L) { size_t sfl; const char *strfrmt = luaL_checklstring(L, arg, &sfl); const char *strfrmt_end = strfrmt+sfl; + const char *flags; luaL_Buffer b; luaL_buffinit(L, &b); while (strfrmt < strfrmt_end) { @@ -1239,25 +1286,35 @@ static int str_format (lua_State *L) { luaL_addchar(&b, *strfrmt++); /* %% */ else { /* format item */ char form[MAX_FORMAT]; /* to store the format ('%...') */ - int maxitem = MAX_ITEM; - char *buff = luaL_prepbuffsize(&b, maxitem); /* to put formatted item */ - int nb = 0; /* number of bytes in added item */ + int maxitem = MAX_ITEM; /* maximum length for the result */ + char *buff = luaL_prepbuffsize(&b, maxitem); /* to put result */ + int nb = 0; /* number of bytes in result */ if (++arg > top) return luaL_argerror(L, arg, "no value"); - strfrmt = scanformat(L, strfrmt, form); + strfrmt = getformat(L, strfrmt, form); switch (*strfrmt++) { case 'c': { + checkformat(L, form, L_FMTFLAGSC, 0); nb = l_sprintf(buff, maxitem, form, (int)luaL_checkinteger(L, arg)); break; } case 'd': case 'i': - case 'o': case 'u': case 'x': case 'X': { + flags = L_FMTFLAGSI; + goto intcase; + case 'u': + flags = L_FMTFLAGSU; + goto intcase; + case 'o': case 'x': case 'X': + flags = L_FMTFLAGSX; + intcase: { lua_Integer n = luaL_checkinteger(L, arg); + checkformat(L, form, flags, 1); addlenmod(form, LUA_INTEGER_FRMLEN); nb = l_sprintf(buff, maxitem, form, (LUAI_UACINT)n); break; } case 'a': case 'A': + checkformat(L, form, L_FMTFLAGSF, 1); addlenmod(form, LUA_NUMBER_FRMLEN); nb = lua_number2strx(L, buff, maxitem, form, luaL_checknumber(L, arg)); @@ -1268,12 +1325,14 @@ static int str_format (lua_State *L) { /* FALLTHROUGH */ case 'e': case 'E': case 'g': case 'G': { lua_Number n = luaL_checknumber(L, arg); + checkformat(L, form, L_FMTFLAGSF, 1); addlenmod(form, LUA_NUMBER_FRMLEN); nb = l_sprintf(buff, maxitem, form, (LUAI_UACNUMBER)n); break; } case 'p': { const void *p = lua_topointer(L, arg); + checkformat(L, form, L_FMTFLAGSC, 0); if (p == NULL) { /* avoid calling 'printf' with argument NULL */ p = "(null)"; /* result */ form[strlen(form) - 1] = 's'; /* format it as a string */ @@ -1294,7 +1353,8 @@ static int str_format (lua_State *L) { luaL_addvalue(&b); /* keep entire string */ else { luaL_argcheck(L, l == strlen(s), arg, "string contains zeros"); - if (!strchr(form, '.') && l >= 100) { + checkformat(L, form, L_FMTFLAGSC, 1); + if (strchr(form, '.') == NULL && l >= 100) { /* no precision and string is too long to be formatted */ luaL_addvalue(&b); /* keep entire string */ } @@ -1352,15 +1412,6 @@ static const union { } nativeendian = {1}; -/* dummy structure to get native alignment requirements */ -struct cD { - char c; - union { double d; void *p; lua_Integer i; lua_Number n; } u; -}; - -#define MAXALIGN (offsetof(struct cD, u)) - - /* ** information to pack/unpack stuff */ @@ -1435,6 +1486,8 @@ static void initheader (lua_State *L, Header *h) { ** Read and classify next option. 'size' is filled with option's size. */ static KOption getoption (Header *h, const char **fmt, int *size) { + /* dummy structure to get native alignment requirements */ + struct cD { char c; union { LUAI_MAXALIGN; } u; }; int opt = *((*fmt)++); *size = 0; /* default */ switch (opt) { @@ -1465,7 +1518,11 @@ static KOption getoption (Header *h, const char **fmt, int *size) { case '<': h->islittle = 1; break; case '>': h->islittle = 0; break; case '=': h->islittle = nativeendian.little; break; - case '!': h->maxalign = getnumlimit(h, fmt, MAXALIGN); break; + case '!': { + const int maxalign = offsetof(struct cD, u); + h->maxalign = getnumlimit(h, fmt, maxalign); + break; + } default: luaL_error(h->L, "invalid format option '%c'", opt); } return Knop; diff --git a/3rdparty/lua/ltable.c b/3rdparty/lua/src/ltable.c similarity index 96% rename from 3rdparty/lua/ltable.c rename to 3rdparty/lua/src/ltable.c index 33c1ab3..3c690c5 100644 --- a/3rdparty/lua/ltable.c +++ b/3rdparty/lua/src/ltable.c @@ -84,8 +84,6 @@ #define hashstr(t,str) hashpow2(t, (str)->hash) #define hashboolean(t,p) hashpow2(t, p) -#define hashint(t,i) hashpow2(t, i) - #define hashpointer(t,p) hashmod(t, point2uint(p)) @@ -101,6 +99,20 @@ static const Node dummynode_ = { static const TValue absentkey = {ABSTKEYCONSTANT}; +/* +** Hash for integers. To allow a good hash, use the remainder operator +** ('%'). If integer fits as a non-negative int, compute an int +** remainder, which is faster. Otherwise, use an unsigned-integer +** remainder, which uses all bits and ensures a non-negative result. +*/ +static Node *hashint (const Table *t, lua_Integer i) { + lua_Unsigned ui = l_castS2U(i); + if (ui <= cast_uint(INT_MAX)) + return hashmod(t, cast_int(ui)); + else + return hashmod(t, ui); +} + /* ** Hash for floating-point numbers. @@ -134,26 +146,24 @@ static int l_hashfloat (lua_Number n) { /* ** returns the 'main' position of an element in a table (that is, -** the index of its hash value). The key comes broken (tag in 'ktt' -** and value in 'vkl') so that we can call it on keys inserted into -** nodes. +** the index of its hash value). */ -static Node *mainposition (const Table *t, int ktt, const Value *kvl) { - switch (withvariant(ktt)) { +static Node *mainpositionTV (const Table *t, const TValue *key) { + switch (ttypetag(key)) { case LUA_VNUMINT: { - lua_Integer key = ivalueraw(*kvl); - return hashint(t, key); + lua_Integer i = ivalue(key); + return hashint(t, i); } case LUA_VNUMFLT: { - lua_Number n = fltvalueraw(*kvl); + lua_Number n = fltvalue(key); return hashmod(t, l_hashfloat(n)); } case LUA_VSHRSTR: { - TString *ts = tsvalueraw(*kvl); + TString *ts = tsvalue(key); return hashstr(t, ts); } case LUA_VLNGSTR: { - TString *ts = tsvalueraw(*kvl); + TString *ts = tsvalue(key); return hashpow2(t, luaS_hashlongstr(ts)); } case LUA_VFALSE: @@ -161,26 +171,25 @@ static Node *mainposition (const Table *t, int ktt, const Value *kvl) { case LUA_VTRUE: return hashboolean(t, 1); case LUA_VLIGHTUSERDATA: { - void *p = pvalueraw(*kvl); + void *p = pvalue(key); return hashpointer(t, p); } case LUA_VLCF: { - lua_CFunction f = fvalueraw(*kvl); + lua_CFunction f = fvalue(key); return hashpointer(t, f); } default: { - GCObject *o = gcvalueraw(*kvl); + GCObject *o = gcvalue(key); return hashpointer(t, o); } } } -/* -** Returns the main position of an element given as a 'TValue' -*/ -static Node *mainpositionTV (const Table *t, const TValue *key) { - return mainposition(t, rawtt(key), valraw(key)); +l_sinline Node *mainpositionfromnode (const Table *t, Node *nd) { + TValue key; + getnodekey(cast(lua_State *, NULL), &key, nd); + return mainpositionTV(t, &key); } @@ -248,9 +257,11 @@ LUAI_FUNC unsigned int luaH_realasize (const Table *t) { size |= (size >> 2); size |= (size >> 4); size |= (size >> 8); +#if (UINT_MAX >> 14) > 3 /* unsigned int has more than 16 bits */ size |= (size >> 16); #if (UINT_MAX >> 30) > 3 size |= (size >> 32); /* unsigned int has more than 32 bits */ +#endif #endif size++; lua_assert(ispow2(size) && size/2 < t->alimit && t->alimit < size); @@ -479,7 +490,7 @@ static void setnodevector (lua_State *L, Table *t, unsigned int size) { luaG_runerror(L, "table overflow"); size = twoto(lsize); t->node = luaM_newvector(L, size, Node); - for (i = 0; i < (int)size; i++) { + for (i = 0; i < cast_int(size); i++) { Node *n = gnode(t, i); gnext(n) = 0; setnilkey(n); @@ -679,7 +690,7 @@ void luaH_newkey (lua_State *L, Table *t, const TValue *key, TValue *value) { return; } lua_assert(!isdummy(t)); - othern = mainposition(t, keytt(mp), &keyval(mp)); + othern = mainpositionfromnode(t, mp); if (othern != mp) { /* is colliding node out of its main position? */ /* yes; move colliding node into free position */ while (othern + gnext(othern) != mp) /* find previous */ @@ -966,6 +977,4 @@ Node *luaH_mainposition (const Table *t, const TValue *key) { return mainpositionTV(t, key); } -int luaH_isdummy (const Table *t) { return isdummy(t); } - #endif diff --git a/3rdparty/lua/ltablib.c b/3rdparty/lua/src/ltablib.c similarity index 98% rename from 3rdparty/lua/ltablib.c rename to 3rdparty/lua/src/ltablib.c index d80eb80..e6bc4d0 100644 --- a/3rdparty/lua/ltablib.c +++ b/3rdparty/lua/src/ltablib.c @@ -59,8 +59,9 @@ static void checktab (lua_State *L, int arg, int what) { static int tinsert (lua_State *L) { - lua_Integer e = aux_getn(L, 1, TAB_RW) + 1; /* first empty element */ lua_Integer pos; /* where to insert new element */ + lua_Integer e = aux_getn(L, 1, TAB_RW); + e = luaL_intop(+, e, 1); /* first empty element */ switch (lua_gettop(L)) { case 2: { /* called with only 2 arguments */ pos = e; /* insert new element at the end */ @@ -92,7 +93,7 @@ static int tremove (lua_State *L) { lua_Integer pos = luaL_optinteger(L, 2, size); if (pos != size) /* validate 'pos' if given */ /* check whether 'pos' is in [1, size + 1] */ - luaL_argcheck(L, (lua_Unsigned)pos - 1u <= (lua_Unsigned)size, 1, + luaL_argcheck(L, (lua_Unsigned)pos - 1u <= (lua_Unsigned)size, 2, "position out of bounds"); lua_geti(L, 1, pos); /* result = t[pos] */ for ( ; pos < size; pos++) { @@ -147,7 +148,7 @@ static void addfield (lua_State *L, luaL_Buffer *b, lua_Integer i) { lua_geti(L, 1, i); if (l_unlikely(!lua_isstring(L, -1))) luaL_error(L, "invalid value (%s) at index %I in table for 'concat'", - luaL_typename(L, -1), i); + luaL_typename(L, -1), (LUAI_UACINT)i); luaL_addvalue(b); } diff --git a/3rdparty/lua/ltm.c b/3rdparty/lua/src/ltm.c similarity index 89% rename from 3rdparty/lua/ltm.c rename to 3rdparty/lua/src/ltm.c index b657b78..07a0608 100644 --- a/3rdparty/lua/ltm.c +++ b/3rdparty/lua/src/ltm.c @@ -102,12 +102,12 @@ const char *luaT_objtypename (lua_State *L, const TValue *o) { void luaT_callTM (lua_State *L, const TValue *f, const TValue *p1, const TValue *p2, const TValue *p3) { - StkId func = L->top; + StkId func = L->top.p; setobj2s(L, func, f); /* push function (assume EXTRA_STACK) */ setobj2s(L, func + 1, p1); /* 1st argument */ setobj2s(L, func + 2, p2); /* 2nd argument */ setobj2s(L, func + 3, p3); /* 3rd argument */ - L->top = func + 4; + L->top.p = func + 4; /* metamethod may yield only when called from Lua code */ if (isLuacode(L->ci)) luaD_call(L, func, 0); @@ -119,18 +119,18 @@ void luaT_callTM (lua_State *L, const TValue *f, const TValue *p1, void luaT_callTMres (lua_State *L, const TValue *f, const TValue *p1, const TValue *p2, StkId res) { ptrdiff_t result = savestack(L, res); - StkId func = L->top; + StkId func = L->top.p; setobj2s(L, func, f); /* push function (assume EXTRA_STACK) */ setobj2s(L, func + 1, p1); /* 1st argument */ setobj2s(L, func + 2, p2); /* 2nd argument */ - L->top += 3; + L->top.p += 3; /* metamethod may yield only when called from Lua code */ if (isLuacode(L->ci)) luaD_call(L, func, 1); else luaD_callnoyield(L, func, 1); res = restorestack(L, result); - setobjs2s(L, res, --L->top); /* move result to its place */ + setobjs2s(L, res, --L->top.p); /* move result to its place */ } @@ -165,7 +165,7 @@ void luaT_trybinTM (lua_State *L, const TValue *p1, const TValue *p2, void luaT_tryconcatTM (lua_State *L) { - StkId top = L->top; + StkId top = L->top.p; if (l_unlikely(!callbinTM(L, s2v(top - 2), s2v(top - 1), top - 2, TM_CONCAT))) luaG_concaterror(L, s2v(top - 2), s2v(top - 1)); @@ -200,15 +200,15 @@ void luaT_trybiniTM (lua_State *L, const TValue *p1, lua_Integer i2, */ int luaT_callorderTM (lua_State *L, const TValue *p1, const TValue *p2, TMS event) { - if (callbinTM(L, p1, p2, L->top, event)) /* try original event */ - return !l_isfalse(s2v(L->top)); + if (callbinTM(L, p1, p2, L->top.p, event)) /* try original event */ + return !l_isfalse(s2v(L->top.p)); #if defined(LUA_COMPAT_LT_LE) else if (event == TM_LE) { /* try '!(p2 < p1)' for '(p1 <= p2)' */ L->ci->callstatus |= CIST_LEQ; /* mark it is doing 'lt' for 'le' */ - if (callbinTM(L, p2, p1, L->top, TM_LT)) { + if (callbinTM(L, p2, p1, L->top.p, TM_LT)) { L->ci->callstatus ^= CIST_LEQ; /* clear mark */ - return l_isfalse(s2v(L->top)); + return l_isfalse(s2v(L->top.p)); } /* else error will remove this 'ci'; no need to clear mark */ } @@ -238,20 +238,20 @@ int luaT_callorderiTM (lua_State *L, const TValue *p1, int v2, void luaT_adjustvarargs (lua_State *L, int nfixparams, CallInfo *ci, const Proto *p) { int i; - int actual = cast_int(L->top - ci->func) - 1; /* number of arguments */ + int actual = cast_int(L->top.p - ci->func.p) - 1; /* number of arguments */ int nextra = actual - nfixparams; /* number of extra arguments */ ci->u.l.nextraargs = nextra; luaD_checkstack(L, p->maxstacksize + 1); /* copy function to the top of the stack */ - setobjs2s(L, L->top++, ci->func); + setobjs2s(L, L->top.p++, ci->func.p); /* move fixed parameters to the top of the stack */ for (i = 1; i <= nfixparams; i++) { - setobjs2s(L, L->top++, ci->func + i); - setnilvalue(s2v(ci->func + i)); /* erase original parameter (for GC) */ + setobjs2s(L, L->top.p++, ci->func.p + i); + setnilvalue(s2v(ci->func.p + i)); /* erase original parameter (for GC) */ } - ci->func += actual + 1; - ci->top += actual + 1; - lua_assert(L->top <= ci->top && ci->top <= L->stack_last); + ci->func.p += actual + 1; + ci->top.p += actual + 1; + lua_assert(L->top.p <= ci->top.p && ci->top.p <= L->stack_last.p); } @@ -261,10 +261,10 @@ void luaT_getvarargs (lua_State *L, CallInfo *ci, StkId where, int wanted) { if (wanted < 0) { wanted = nextra; /* get all extra arguments available */ checkstackGCp(L, nextra, where); /* ensure stack space */ - L->top = where + nextra; /* next instruction will need top */ + L->top.p = where + nextra; /* next instruction will need top */ } for (i = 0; i < wanted && i < nextra; i++) - setobjs2s(L, where + i, ci->func - nextra + i); + setobjs2s(L, where + i, ci->func.p - nextra + i); for (; i < wanted; i++) /* complete required results with nil */ setnilvalue(s2v(where + i)); } diff --git a/3rdparty/lua/lua.c b/3rdparty/lua/src/lua.c similarity index 85% rename from 3rdparty/lua/lua.c rename to 3rdparty/lua/src/lua.c index 23c3f97..0ff8845 100644 --- a/3rdparty/lua/lua.c +++ b/3rdparty/lua/src/lua.c @@ -89,14 +89,15 @@ static void print_usage (const char *badoption) { lua_writestringerror( "usage: %s [options] [script [args]]\n" "Available options are:\n" - " -e stat execute string 'stat'\n" - " -i enter interactive mode after executing 'script'\n" - " -l name require library 'name' into global 'name'\n" - " -v show version information\n" - " -E ignore environment variables\n" - " -W turn warnings on\n" - " -- stop handling options\n" - " - stop handling options and execute stdin\n" + " -e stat execute string 'stat'\n" + " -i enter interactive mode after executing 'script'\n" + " -l mod require library 'mod' into global 'mod'\n" + " -l g=mod require library 'mod' into global 'g'\n" + " -v show version information\n" + " -E ignore environment variables\n" + " -W turn warnings on\n" + " -- stop handling options\n" + " - stop handling options and execute stdin\n" , progname); } @@ -176,10 +177,11 @@ static void print_version (void) { ** to the script (everything after 'script') go to positive indices; ** other arguments (before the script name) go to negative indices. ** If there is no script name, assume interpreter's name as base. +** (If there is no interpreter's name either, 'script' is -1, so +** table sizes are zero.) */ static void createargtable (lua_State *L, char **argv, int argc, int script) { int i, narg; - if (script == argc) script = 0; /* no script name? */ narg = argc - (script + 1); /* number of positive indices */ lua_createtable(L, narg, script + 1); for (i = 0; i < argc; i++) { @@ -207,16 +209,22 @@ static int dostring (lua_State *L, const char *s, const char *name) { /* -** Calls 'require(name)' and stores the result in a global variable -** with the given name. +** Receives 'globname[=modname]' and runs 'globname = require(modname)'. */ -static int dolibrary (lua_State *L, const char *name) { +static int dolibrary (lua_State *L, char *globname) { int status; + char *modname = strchr(globname, '='); + if (modname == NULL) /* no explicit name? */ + modname = globname; /* module name is equal to global name */ + else { + *modname = '\0'; /* global name ends here */ + modname++; /* module name starts after the '=' */ + } lua_getglobal(L, "require"); - lua_pushstring(L, name); - status = docall(L, 1, 1); /* call 'require(name)' */ + lua_pushstring(L, modname); + status = docall(L, 1, 1); /* call 'require(modname)' */ if (status == LUA_OK) - lua_setglobal(L, name); /* global[name] = require return */ + lua_setglobal(L, globname); /* globname = require(modname) */ return report(L, status); } @@ -261,14 +269,23 @@ static int handle_script (lua_State *L, char **argv) { /* ** Traverses all arguments from 'argv', returning a mask with those -** needed before running any Lua code (or an error code if it finds -** any invalid argument). 'first' returns the first not-handled argument -** (either the script name or a bad argument in case of error). +** needed before running any Lua code or an error code if it finds any +** invalid argument. In case of error, 'first' is the index of the bad +** argument. Otherwise, 'first' is -1 if there is no program name, +** 0 if there is no script name, or the index of the script name. */ static int collectargs (char **argv, int *first) { int args = 0; int i; - for (i = 1; argv[i] != NULL; i++) { + if (argv[0] != NULL) { /* is there a program name? */ + if (argv[0][0]) /* not empty? */ + progname = argv[0]; /* save it */ + } + else { /* no program name */ + *first = -1; + return 0; + } + for (i = 1; argv[i] != NULL; i++) { /* handle arguments */ *first = i; if (argv[i][0] != '-') /* not an option? */ return args; /* stop handling options */ @@ -309,7 +326,7 @@ static int collectargs (char **argv, int *first) { return has_error; } } - *first = i; /* no script name */ + *first = 0; /* no script name */ return args; } @@ -327,7 +344,7 @@ static int runargs (lua_State *L, char **argv, int n) { switch (option) { case 'e': case 'l': { int status; - const char *extra = argv[i] + 2; /* both options need an argument */ + char *extra = argv[i] + 2; /* both options need an argument */ if (*extra == '\0') extra = argv[++i]; lua_assert(extra != NULL); status = (option == 'e') @@ -602,8 +619,8 @@ static int pmain (lua_State *L) { char **argv = (char **)lua_touserdata(L, 2); int script; int args = collectargs(argv, &script); + int optlim = (script > 0) ? script : argc; /* first argv not an option */ luaL_checkversion(L); /* check that interpreter has correct version */ - if (argv[0] && argv[0][0]) progname = argv[0]; if (args == has_error) { /* bad arg? */ print_usage(argv[script]); /* 'script' has index of bad arg. */ return 0; @@ -616,19 +633,21 @@ static int pmain (lua_State *L) { } luaL_openlibs(L); /* open standard libraries */ createargtable(L, argv, argc, script); /* create table 'arg' */ - lua_gc(L, LUA_GCGEN, 0, 0); /* GC in generational mode */ + lua_gc(L, LUA_GCRESTART); /* start GC... */ + lua_gc(L, LUA_GCGEN, 0, 0); /* ...in generational mode */ if (!(args & has_E)) { /* no option '-E'? */ if (handle_luainit(L) != LUA_OK) /* run LUA_INIT */ return 0; /* error running LUA_INIT */ } - if (!runargs(L, argv, script)) /* execute arguments -e and -l */ + if (!runargs(L, argv, optlim)) /* execute arguments -e and -l */ return 0; /* something failed */ - if (script < argc && /* execute main script (if there is one) */ - handle_script(L, argv + script) != LUA_OK) - return 0; + if (script > 0) { /* execute main script (if there is one) */ + if (handle_script(L, argv + script) != LUA_OK) + return 0; /* interrupt in case of error */ + } if (args & has_i) /* -i option? */ doREPL(L); /* do read-eval-print loop */ - else if (script == argc && !(args & (has_e | has_v))) { /* no arguments? */ + else if (script < 1 && !(args & (has_e | has_v))) { /* no active option? */ if (lua_stdin_is_tty()) { /* running in interactive mode? */ print_version(); doREPL(L); /* do read-eval-print loop */ @@ -638,22 +657,23 @@ static int pmain (lua_State *L) { lua_pushboolean(L, 1); /* signal no errors */ return 1; } -// -// -//int main (int argc, char **argv) { -// int status, result; -// lua_State *L = luaL_newstate(); /* create state */ -// if (L == NULL) { -// l_message(argv[0], "cannot create state: not enough memory"); -// return EXIT_FAILURE; -// } -// lua_pushcfunction(L, &pmain); /* to call 'pmain' in protected mode */ -// lua_pushinteger(L, argc); /* 1st argument */ -// lua_pushlightuserdata(L, argv); /* 2nd argument */ -// status = lua_pcall(L, 2, 1, 0); /* do the call */ -// result = lua_toboolean(L, -1); /* get result */ -// report(L, status); -// lua_close(L); -// return (result && status == LUA_OK) ? EXIT_SUCCESS : EXIT_FAILURE; -//} -// + + +int main (int argc, char **argv) { + int status, result; + lua_State *L = luaL_newstate(); /* create state */ + if (L == NULL) { + l_message(argv[0], "cannot create state: not enough memory"); + return EXIT_FAILURE; + } + lua_gc(L, LUA_GCSTOP); /* stop GC while building state */ + lua_pushcfunction(L, &pmain); /* to call 'pmain' in protected mode */ + lua_pushinteger(L, argc); /* 1st argument */ + lua_pushlightuserdata(L, argv); /* 2nd argument */ + status = lua_pcall(L, 2, 1, 0); /* do the call */ + result = lua_toboolean(L, -1); /* get result */ + report(L, status); + lua_close(L); + return (result && status == LUA_OK) ? EXIT_SUCCESS : EXIT_FAILURE; +} + diff --git a/3rdparty/lua/luac/luac.c b/3rdparty/lua/src/luac.c similarity index 91% rename from 3rdparty/lua/luac/luac.c rename to 3rdparty/lua/src/luac.c index 74b3c47..5f4a141 100644 --- a/3rdparty/lua/luac/luac.c +++ b/3rdparty/lua/src/luac.c @@ -24,9 +24,7 @@ #include "lopnames.h" #include "lstate.h" #include "lundump.h" -#ifdef _WIN32 -#include -#endif + static void PrintFunction(const Proto* f, int full); #define luaU_print PrintFunction @@ -40,45 +38,26 @@ static char Output[]={ OUTPUT }; /* default output file name */ static const char* output=Output; /* actual output file name */ static const char* progname=PROGNAME; /* actual program name */ static TString **tmname; -int save_string_to_file(const char* str, const char* filename) { - FILE* file = fopen(filename, "w"); - if (file == NULL) { - perror("Error opening file"); - return -1; - } - - // 写入字符串到文件 - if (fputs(str, file) == EOF) { - perror("Error writing to file"); - fclose(file); - return -1; - } - - fclose(file); - return 0; -} static void fatal(const char* message) { - save_string_to_file(message, "error_toluac.txt"); - //fprintf(stdout,"%s: %s\n",progname,message); + fprintf(stderr,"%s: %s\n",progname,message); exit(EXIT_FAILURE); } static void cannot(const char* what) { - save_string_to_file(what, "error_toluac.txt"); - //fprintf(stdout,"%s: cannot %s %s: %s\n",progname,what,output,strerror(errno)); + fprintf(stderr,"%s: cannot %s %s: %s\n",progname,what,output,strerror(errno)); exit(EXIT_FAILURE); } static void usage(const char* message) { if (*message=='-') - fprintf(stdout,"%s: unrecognized option '%s'\n",progname,message); + fprintf(stderr,"%s: unrecognized option '%s'\n",progname,message); else - fprintf(stdout,"%s: %s\n",progname,message); - fprintf(stdout, + fprintf(stderr,"%s: %s\n",progname,message); + fprintf(stderr, "usage: %s [options] [filenames]\n" "Available options are:\n" " -l list (use -l -l for full listing)\n" @@ -142,7 +121,7 @@ static int doargs(int argc, char* argv[]) return i; } -#define FUNCTION "(function()end)();" +#define FUNCTION "(function()end)();\n" static const char* reader(lua_State* L, void* ud, size_t* size) { @@ -159,7 +138,7 @@ static const char* reader(lua_State* L, void* ud, size_t* size) } } -#define toproto(L,i) getproto(s2v(L->top+(i))) +#define toproto(L,i) getproto(s2v(L->top.p+(i))) static const Proto* combine(lua_State* L, int n) { @@ -176,7 +155,6 @@ static const Proto* combine(lua_State* L, int n) f->p[i]=toproto(L,i-n-1); if (f->p[i]->sizeupvalues>0) f->p[i]->upvalues[0].instack=0; } - f->sizelineinfo=0; return f; } } @@ -214,20 +192,21 @@ static int pmain(lua_State* L) } return 0; } + int main(int argc, char* argv[]) { - lua_State* L; - int i=doargs(argc,argv); - argc-=i; argv+=i; - if (argc<=0) usage("no input files given"); - L=luaL_newstate(); - if (L==NULL) fatal("cannot create state: not enough memory"); - lua_pushcfunction(L,&pmain); - lua_pushinteger(L,argc); - lua_pushlightuserdata(L,argv); - if (lua_pcall(L,2,0,0)!=LUA_OK) fatal(lua_tostring(L,-1)); - lua_close(L); - return EXIT_SUCCESS; + lua_State* L; + int i=doargs(argc,argv); + argc-=i; argv+=i; + if (argc<=0) usage("no input files given"); + L=luaL_newstate(); + if (L==NULL) fatal("cannot create state: not enough memory"); + lua_pushcfunction(L,&pmain); + lua_pushinteger(L,argc); + lua_pushlightuserdata(L,argv); + if (lua_pcall(L,2,0,0)!=LUA_OK) fatal(lua_tostring(L,-1)); + lua_close(L); + return EXIT_SUCCESS; } /* @@ -620,11 +599,11 @@ static void PrintCode(const Proto* f) if (c==0) printf("all out"); else printf("%d out",c-1); break; case OP_TAILCALL: - printf("%d %d %d",a,b,c); + printf("%d %d %d%s",a,b,c,ISK); printf(COMMENT "%d in",b-1); break; case OP_RETURN: - printf("%d %d %d",a,b,c); + printf("%d %d %d%s",a,b,c,ISK); printf(COMMENT); if (b==0) printf("all out"); else printf("%d out",b-1); break; @@ -639,7 +618,7 @@ static void PrintCode(const Proto* f) break; case OP_FORPREP: printf("%d %d",a,bx); - printf(COMMENT "to %d",pc+bx+2); + printf(COMMENT "exit to %d",pc+bx+3); break; case OP_TFORPREP: printf("%d %d",a,bx); diff --git a/3rdparty/lua/lundump.c b/3rdparty/lua/src/lundump.c similarity index 96% rename from 3rdparty/lua/lundump.c rename to 3rdparty/lua/src/lundump.c index 5aa55c4..02aed64 100644 --- a/3rdparty/lua/lundump.c +++ b/3rdparty/lua/src/lundump.c @@ -120,10 +120,10 @@ static TString *loadStringN (LoadState *S, Proto *p) { } else { /* long string */ ts = luaS_createlngstrobj(L, size); /* create string */ - setsvalue2s(L, L->top, ts); /* anchor it ('loadVector' can GC) */ + setsvalue2s(L, L->top.p, ts); /* anchor it ('loadVector' can GC) */ luaD_inctop(L); loadVector(S, getstr(ts), size); /* load directly in final place */ - L->top--; /* pop string */ + L->top.p--; /* pop string */ } luaC_objbarrier(L, p, ts); return ts; @@ -248,6 +248,8 @@ static void loadDebug (LoadState *S, Proto *f) { f->locvars[i].endpc = loadInt(S); } n = loadInt(S); + if (n != 0) /* does it have debug information? */ + n = f->sizeupvalues; /* must be this many */ for (i = 0; i < n; i++) f->upvalues[i].name = loadStringN(S, f); } @@ -321,7 +323,7 @@ LClosure *luaU_undump(lua_State *L, ZIO *Z, const char *name) { S.Z = Z; checkHeader(&S); cl = luaF_newLclosure(L, loadByte(&S)); - setclLvalue2s(L, L->top, cl); + setclLvalue2s(L, L->top.p, cl); luaD_inctop(L); cl->p = luaF_newproto(L); luaC_objbarrier(L, cl, cl->p); diff --git a/3rdparty/lua/lutf8lib.c b/3rdparty/lua/src/lutf8lib.c similarity index 90% rename from 3rdparty/lua/lutf8lib.c rename to 3rdparty/lua/src/lutf8lib.c index 901d985..3a5b9bc 100644 --- a/3rdparty/lua/lutf8lib.c +++ b/3rdparty/lua/src/lutf8lib.c @@ -25,6 +25,9 @@ #define MAXUTF 0x7FFFFFFFu + +#define MSGInvalid "invalid UTF-8 code" + /* ** Integer type for decoded UTF-8 values; MAXUTF needs 31 bits. */ @@ -35,7 +38,8 @@ typedef unsigned long utfint; #endif -#define iscont(p) ((*(p) & 0xC0) == 0x80) +#define iscont(c) (((c) & 0xC0) == 0x80) +#define iscontp(p) iscont(*(p)) /* from strlib */ @@ -65,7 +69,7 @@ static const char *utf8_decode (const char *s, utfint *val, int strict) { int count = 0; /* to count number of continuation bytes */ for (; c & 0x40; c <<= 1) { /* while it needs continuation bytes... */ unsigned int cc = (unsigned char)s[++count]; /* read next byte */ - if ((cc & 0xC0) != 0x80) /* not a continuation byte? */ + if (!iscont(cc)) /* not a continuation byte? */ return NULL; /* invalid byte sequence */ res = (res << 6) | (cc & 0x3F); /* add lower 6 bits from cont. byte */ } @@ -140,7 +144,7 @@ static int codepoint (lua_State *L) { utfint code; s = utf8_decode(s, &code, !lax); if (s == NULL) - return luaL_error(L, "invalid UTF-8 code"); + return luaL_error(L, MSGInvalid); lua_pushinteger(L, code); n++; } @@ -190,16 +194,16 @@ static int byteoffset (lua_State *L) { "position out of bounds"); if (n == 0) { /* find beginning of current byte sequence */ - while (posi > 0 && iscont(s + posi)) posi--; + while (posi > 0 && iscontp(s + posi)) posi--; } else { - if (iscont(s + posi)) + if (iscontp(s + posi)) return luaL_error(L, "initial position is a continuation byte"); if (n < 0) { while (n < 0 && posi > 0) { /* move back */ do { /* find beginning of previous character */ posi--; - } while (posi > 0 && iscont(s + posi)); + } while (posi > 0 && iscontp(s + posi)); n++; } } @@ -208,7 +212,7 @@ static int byteoffset (lua_State *L) { while (n > 0 && posi < (lua_Integer)len) { do { /* find beginning of next character */ posi++; - } while (iscont(s + posi)); /* (cannot pass final '\0') */ + } while (iscontp(s + posi)); /* (cannot pass final '\0') */ n--; } } @@ -224,20 +228,17 @@ static int byteoffset (lua_State *L) { static int iter_aux (lua_State *L, int strict) { size_t len; const char *s = luaL_checklstring(L, 1, &len); - lua_Integer n = lua_tointeger(L, 2) - 1; - if (n < 0) /* first iteration? */ - n = 0; /* start from here */ - else if (n < (lua_Integer)len) { - n++; /* skip current byte */ - while (iscont(s + n)) n++; /* and its continuations */ + lua_Unsigned n = (lua_Unsigned)lua_tointeger(L, 2); + if (n < len) { + while (iscontp(s + n)) n++; /* go to next character */ } - if (n >= (lua_Integer)len) + if (n >= len) /* (also handles original 'n' being negative) */ return 0; /* no more codepoints */ else { utfint code; const char *next = utf8_decode(s + n, &code, strict); - if (next == NULL) - return luaL_error(L, "invalid UTF-8 code"); + if (next == NULL || iscontp(next)) + return luaL_error(L, MSGInvalid); lua_pushinteger(L, n + 1); lua_pushinteger(L, code); return 2; @@ -256,7 +257,8 @@ static int iter_auxlax (lua_State *L) { static int iter_codes (lua_State *L) { int lax = lua_toboolean(L, 2); - luaL_checkstring(L, 1); + const char *s = luaL_checkstring(L, 1); + luaL_argcheck(L, !iscontp(s), 1, MSGInvalid); lua_pushcfunction(L, lax ? iter_auxlax : iter_auxstrict); lua_pushvalue(L, 1); lua_pushinteger(L, 0); diff --git a/3rdparty/lua/lvm.c b/3rdparty/lua/src/lvm.c similarity index 88% rename from 3rdparty/lua/lvm.c rename to 3rdparty/lua/src/lvm.c index c9729bc..8493a77 100644 --- a/3rdparty/lua/lvm.c +++ b/3rdparty/lua/src/lvm.c @@ -406,7 +406,7 @@ static int l_strcmp (const TString *ls, const TString *rs) { ** from float to int.) ** When 'f' is NaN, comparisons must result in false. */ -static int LTintfloat (lua_Integer i, lua_Number f) { +l_sinline int LTintfloat (lua_Integer i, lua_Number f) { if (l_intfitsf(i)) return luai_numlt(cast_num(i), f); /* compare them as floats */ else { /* i < f <=> i < ceil(f) */ @@ -423,7 +423,7 @@ static int LTintfloat (lua_Integer i, lua_Number f) { ** Check whether integer 'i' is less than or equal to float 'f'. ** See comments on previous function. */ -static int LEintfloat (lua_Integer i, lua_Number f) { +l_sinline int LEintfloat (lua_Integer i, lua_Number f) { if (l_intfitsf(i)) return luai_numle(cast_num(i), f); /* compare them as floats */ else { /* i <= f <=> i <= floor(f) */ @@ -440,7 +440,7 @@ static int LEintfloat (lua_Integer i, lua_Number f) { ** Check whether float 'f' is less than integer 'i'. ** See comments on previous function. */ -static int LTfloatint (lua_Number f, lua_Integer i) { +l_sinline int LTfloatint (lua_Number f, lua_Integer i) { if (l_intfitsf(i)) return luai_numlt(f, cast_num(i)); /* compare them as floats */ else { /* f < i <=> floor(f) < i */ @@ -457,7 +457,7 @@ static int LTfloatint (lua_Number f, lua_Integer i) { ** Check whether float 'f' is less than or equal to integer 'i'. ** See comments on previous function. */ -static int LEfloatint (lua_Number f, lua_Integer i) { +l_sinline int LEfloatint (lua_Number f, lua_Integer i) { if (l_intfitsf(i)) return luai_numle(f, cast_num(i)); /* compare them as floats */ else { /* f <= i <=> ceil(f) <= i */ @@ -473,7 +473,7 @@ static int LEfloatint (lua_Number f, lua_Integer i) { /* ** Return 'l < r', for numbers. */ -static int LTnum (const TValue *l, const TValue *r) { +l_sinline int LTnum (const TValue *l, const TValue *r) { lua_assert(ttisnumber(l) && ttisnumber(r)); if (ttisinteger(l)) { lua_Integer li = ivalue(l); @@ -495,7 +495,7 @@ static int LTnum (const TValue *l, const TValue *r) { /* ** Return 'l <= r', for numbers. */ -static int LEnum (const TValue *l, const TValue *r) { +l_sinline int LEnum (const TValue *l, const TValue *r) { lua_assert(ttisnumber(l) && ttisnumber(r)); if (ttisinteger(l)) { lua_Integer li = ivalue(l); @@ -608,8 +608,8 @@ int luaV_equalobj (lua_State *L, const TValue *t1, const TValue *t2) { if (tm == NULL) /* no TM? */ return 0; /* objects are different */ else { - luaT_callTMres(L, tm, t1, t2, L->top); /* call TM */ - return !l_isfalse(s2v(L->top)); + luaT_callTMres(L, tm, t1, t2, L->top.p); /* call TM */ + return !l_isfalse(s2v(L->top.p)); } } @@ -633,17 +633,17 @@ static void copy2buff (StkId top, int n, char *buff) { /* ** Main operation for concatenation: concat 'total' values in the stack, -** from 'L->top - total' up to 'L->top - 1'. +** from 'L->top.p - total' up to 'L->top.p - 1'. */ void luaV_concat (lua_State *L, int total) { if (total == 1) return; /* "all" values already concatenated */ do { - StkId top = L->top; + StkId top = L->top.p; int n = 2; /* number of elements handled in this pass (at least 2) */ if (!(ttisstring(s2v(top - 2)) || cvt2str(s2v(top - 2))) || !tostring(L, s2v(top - 1))) - luaT_tryconcatTM(L); + luaT_tryconcatTM(L); /* may invalidate 'top' */ else if (isemptystr(s2v(top - 1))) /* second operand is empty? */ cast_void(tostring(L, s2v(top - 2))); /* result is first operand */ else if (isemptystr(s2v(top - 2))) { /* first operand is empty string? */ @@ -656,8 +656,10 @@ void luaV_concat (lua_State *L, int total) { /* collect total length and number of strings */ for (n = 1; n < total && tostring(L, s2v(top - n - 1)); n++) { size_t l = vslen(s2v(top - n - 1)); - if (l_unlikely(l >= (MAX_SIZE/sizeof(char)) - tl)) + if (l_unlikely(l >= (MAX_SIZE/sizeof(char)) - tl)) { + L->top.p = top - total; /* pop strings to avoid wasting stack */ luaG_runerror(L, "string length overflow"); + } tl += l; } if (tl <= LUAI_MAXSHORTLEN) { /* is result a short string? */ @@ -671,8 +673,8 @@ void luaV_concat (lua_State *L, int total) { } setsvalue2s(L, top - n, ts); /* create result */ } - total -= n-1; /* got 'n' strings to create 1 new */ - L->top -= n-1; /* popped 'n' strings and pushed one */ + total -= n - 1; /* got 'n' strings to create one new */ + L->top.p -= n - 1; /* popped 'n' strings and pushed one */ } while (total > 1); /* repeat until only 1 result left */ } @@ -763,11 +765,10 @@ lua_Number luaV_modf (lua_State *L, lua_Number m, lua_Number n) { /* number of bits in an integer */ #define NBITS cast_int(sizeof(lua_Integer) * CHAR_BIT) + /* ** Shift left operation. (Shift right just negates 'y'.) */ -#define luaV_shiftr(x,y) luaV_shiftl(x,-(y)) - lua_Integer luaV_shiftl (lua_Integer x, lua_Integer y) { if (y < 0) { /* shift right? */ if (y <= -NBITS) return 0; @@ -807,26 +808,26 @@ static void pushclosure (lua_State *L, Proto *p, UpVal **encup, StkId base, */ void luaV_finishOp (lua_State *L) { CallInfo *ci = L->ci; - StkId base = ci->func + 1; + StkId base = ci->func.p + 1; Instruction inst = *(ci->u.l.savedpc - 1); /* interrupted instruction */ OpCode op = GET_OPCODE(inst); switch (op) { /* finish its execution */ case OP_MMBIN: case OP_MMBINI: case OP_MMBINK: { - setobjs2s(L, base + GETARG_A(*(ci->u.l.savedpc - 2)), --L->top); + setobjs2s(L, base + GETARG_A(*(ci->u.l.savedpc - 2)), --L->top.p); break; } case OP_UNM: case OP_BNOT: case OP_LEN: case OP_GETTABUP: case OP_GETTABLE: case OP_GETI: case OP_GETFIELD: case OP_SELF: { - setobjs2s(L, base + GETARG_A(inst), --L->top); + setobjs2s(L, base + GETARG_A(inst), --L->top.p); break; } case OP_LT: case OP_LE: case OP_LTI: case OP_LEI: case OP_GTI: case OP_GEI: case OP_EQ: { /* note that 'OP_EQI'/'OP_EQK' cannot yield */ - int res = !l_isfalse(s2v(L->top - 1)); - L->top--; + int res = !l_isfalse(s2v(L->top.p - 1)); + L->top.p--; #if defined(LUA_COMPAT_LT_LE) if (ci->callstatus & CIST_LEQ) { /* "<=" using "<" instead? */ ci->callstatus ^= CIST_LEQ; /* clear mark */ @@ -839,18 +840,27 @@ void luaV_finishOp (lua_State *L) { break; } case OP_CONCAT: { - StkId top = L->top - 1; /* top when 'luaT_tryconcatTM' was called */ + StkId top = L->top.p - 1; /* top when 'luaT_tryconcatTM' was called */ int a = GETARG_A(inst); /* first element to concatenate */ int total = cast_int(top - 1 - (base + a)); /* yet to concatenate */ setobjs2s(L, top - 2, top); /* put TM result in proper position */ - L->top = top - 1; /* top is one after last element (at top-2) */ + L->top.p = top - 1; /* top is one after last element (at top-2) */ luaV_concat(L, total); /* concat them (may yield again) */ break; } - case OP_CLOSE: case OP_RETURN: { /* yielded closing variables */ + case OP_CLOSE: { /* yielded closing variables */ ci->u.l.savedpc--; /* repeat instruction to close other vars. */ break; } + case OP_RETURN: { /* yielded closing variables */ + StkId ra = base + GETARG_A(inst); + /* adjust top to signal correct number of returns, in case the + return is "up to top" ('isIT') */ + L->top.p = ra + ci->u2.nres; + /* repeat instruction to close other vars. and complete the return */ + ci->u.l.savedpc--; + break; + } default: { /* only these other opcodes can yield */ lua_assert(op == OP_TFORCALL || op == OP_CALL || @@ -888,6 +898,7 @@ void luaV_finishOp (lua_State *L) { ** operation, 'fop' is the float operation. */ #define op_arithI(L,iop,fop) { \ + StkId ra = RA(i); \ TValue *v1 = vRB(i); \ int imm = GETARG_sC(i); \ if (ttisinteger(v1)) { \ @@ -916,6 +927,7 @@ void luaV_finishOp (lua_State *L) { ** Arithmetic operations over floats and others with register operands. */ #define op_arithf(L,fop) { \ + StkId ra = RA(i); \ TValue *v1 = vRB(i); \ TValue *v2 = vRC(i); \ op_arithf_aux(L, v1, v2, fop); } @@ -925,6 +937,7 @@ void luaV_finishOp (lua_State *L) { ** Arithmetic operations with K operands for floats. */ #define op_arithfK(L,fop) { \ + StkId ra = RA(i); \ TValue *v1 = vRB(i); \ TValue *v2 = KC(i); lua_assert(ttisnumber(v2)); \ op_arithf_aux(L, v1, v2, fop); } @@ -934,6 +947,7 @@ void luaV_finishOp (lua_State *L) { ** Arithmetic operations over integers and floats. */ #define op_arith_aux(L,v1,v2,iop,fop) { \ + StkId ra = RA(i); \ if (ttisinteger(v1) && ttisinteger(v2)) { \ lua_Integer i1 = ivalue(v1); lua_Integer i2 = ivalue(v2); \ pc++; setivalue(s2v(ra), iop(L, i1, i2)); \ @@ -963,6 +977,7 @@ void luaV_finishOp (lua_State *L) { ** Bitwise operations with constant operand. */ #define op_bitwiseK(L,op) { \ + StkId ra = RA(i); \ TValue *v1 = vRB(i); \ TValue *v2 = KC(i); \ lua_Integer i1; \ @@ -976,6 +991,7 @@ void luaV_finishOp (lua_State *L) { ** Bitwise operations with register operands. */ #define op_bitwise(L,op) { \ + StkId ra = RA(i); \ TValue *v1 = vRB(i); \ TValue *v2 = vRC(i); \ lua_Integer i1; lua_Integer i2; \ @@ -990,18 +1006,19 @@ void luaV_finishOp (lua_State *L) { ** integers. */ #define op_order(L,opi,opn,other) { \ - int cond; \ - TValue *rb = vRB(i); \ - if (ttisinteger(s2v(ra)) && ttisinteger(rb)) { \ - lua_Integer ia = ivalue(s2v(ra)); \ - lua_Integer ib = ivalue(rb); \ - cond = opi(ia, ib); \ - } \ - else if (ttisnumber(s2v(ra)) && ttisnumber(rb)) \ - cond = opn(s2v(ra), rb); \ - else \ - Protect(cond = other(L, s2v(ra), rb)); \ - docondjump(); } + StkId ra = RA(i); \ + int cond; \ + TValue *rb = vRB(i); \ + if (ttisinteger(s2v(ra)) && ttisinteger(rb)) { \ + lua_Integer ia = ivalue(s2v(ra)); \ + lua_Integer ib = ivalue(rb); \ + cond = opi(ia, ib); \ + } \ + else if (ttisnumber(s2v(ra)) && ttisnumber(rb)) \ + cond = opn(s2v(ra), rb); \ + else \ + Protect(cond = other(L, s2v(ra), rb)); \ + docondjump(); } /* @@ -1009,20 +1026,21 @@ void luaV_finishOp (lua_State *L) { ** always small enough to have an exact representation as a float.) */ #define op_orderI(L,opi,opf,inv,tm) { \ - int cond; \ - int im = GETARG_sB(i); \ - if (ttisinteger(s2v(ra))) \ - cond = opi(ivalue(s2v(ra)), im); \ - else if (ttisfloat(s2v(ra))) { \ - lua_Number fa = fltvalue(s2v(ra)); \ - lua_Number fim = cast_num(im); \ - cond = opf(fa, fim); \ - } \ - else { \ - int isf = GETARG_C(i); \ - Protect(cond = luaT_callorderiTM(L, s2v(ra), im, inv, isf, tm)); \ - } \ - docondjump(); } + StkId ra = RA(i); \ + int cond; \ + int im = GETARG_sB(i); \ + if (ttisinteger(s2v(ra))) \ + cond = opi(ivalue(s2v(ra)), im); \ + else if (ttisfloat(s2v(ra))) { \ + lua_Number fa = fltvalue(s2v(ra)); \ + lua_Number fim = cast_num(im); \ + cond = opf(fa, fim); \ + } \ + else { \ + int isf = GETARG_C(i); \ + Protect(cond = luaT_callorderiTM(L, s2v(ra), im, inv, isf, tm)); \ + } \ + docondjump(); } /* }================================================================== */ @@ -1051,7 +1069,7 @@ void luaV_finishOp (lua_State *L) { #define updatetrap(ci) (trap = ci->u.l.trap) -#define updatebase(ci) (base = ci->func + 1) +#define updatebase(ci) (base = ci->func.p + 1) #define updatestack(ci) \ @@ -1086,7 +1104,7 @@ void luaV_finishOp (lua_State *L) { ** Whenever code can raise errors, the global 'pc' and the global ** 'top' must be correct to report occasional errors. */ -#define savestate(L,ci) (savepc(L), L->top = ci->top) +#define savestate(L,ci) (savepc(L), L->top.p = ci->top.p) /* @@ -1099,14 +1117,14 @@ void luaV_finishOp (lua_State *L) { #define ProtectNT(exp) (savepc(L), (exp), updatetrap(ci)) /* -** Protect code that can only raise errors. (That is, it cannnot change +** Protect code that can only raise errors. (That is, it cannot change ** the stack or hooks.) */ #define halfProtect(exp) (savestate(L,ci), (exp)) /* 'c' is the limit of live values in the stack */ #define checkGC(L,c) \ - { luaC_condGC(L, (savepc(L), L->top = (c)), \ + { luaC_condGC(L, (savepc(L), L->top.p = (c)), \ updatetrap(ci)); \ luai_threadyield(L); } @@ -1118,7 +1136,6 @@ void luaV_finishOp (lua_State *L) { updatebase(ci); /* correct stack */ \ } \ i = *(pc++); \ - ra = RA(i); /* WARNING: any stack reallocation invalidates 'ra' */ \ } #define vmdispatch(o) switch(o) @@ -1138,7 +1155,7 @@ void luaV_execute (lua_State *L, CallInfo *ci) { startfunc: trap = L->hookmask; returning: /* trap already set */ - cl = clLvalue(s2v(ci->func)); + cl = clLvalue(s2v(ci->func.p)); k = cl->p->k; pc = ci->u.l.savedpc; if (l_unlikely(trap)) { @@ -1150,58 +1167,68 @@ void luaV_execute (lua_State *L, CallInfo *ci) { } ci->u.l.trap = 1; /* assume trap is on, for now */ } - base = ci->func + 1; + base = ci->func.p + 1; /* main loop of interpreter */ for (;;) { Instruction i; /* instruction being executed */ - StkId ra; /* instruction's A register */ vmfetch(); -// low-level line tracing for debugging Lua -// printf("line: %d\n", luaG_getfuncline(cl->p, pcRel(pc, cl->p))); - lua_assert(base == ci->func + 1); - lua_assert(base <= L->top && L->top < L->stack_last); + #if 0 + /* low-level line tracing for debugging Lua */ + printf("line: %d\n", luaG_getfuncline(cl->p, pcRel(pc, cl->p))); + #endif + lua_assert(base == ci->func.p + 1); + lua_assert(base <= L->top.p && L->top.p <= L->stack_last.p); /* invalidate top for instructions not expecting it */ - lua_assert(isIT(i) || (cast_void(L->top = base), 1)); + lua_assert(isIT(i) || (cast_void(L->top.p = base), 1)); vmdispatch (GET_OPCODE(i)) { vmcase(OP_MOVE) { + StkId ra = RA(i); setobjs2s(L, ra, RB(i)); vmbreak; } vmcase(OP_LOADI) { + StkId ra = RA(i); lua_Integer b = GETARG_sBx(i); setivalue(s2v(ra), b); vmbreak; } vmcase(OP_LOADF) { + StkId ra = RA(i); int b = GETARG_sBx(i); setfltvalue(s2v(ra), cast_num(b)); vmbreak; } vmcase(OP_LOADK) { + StkId ra = RA(i); TValue *rb = k + GETARG_Bx(i); setobj2s(L, ra, rb); vmbreak; } vmcase(OP_LOADKX) { + StkId ra = RA(i); TValue *rb; rb = k + GETARG_Ax(*pc); pc++; setobj2s(L, ra, rb); vmbreak; } vmcase(OP_LOADFALSE) { + StkId ra = RA(i); setbfvalue(s2v(ra)); vmbreak; } vmcase(OP_LFALSESKIP) { + StkId ra = RA(i); setbfvalue(s2v(ra)); pc++; /* skip next instruction */ vmbreak; } vmcase(OP_LOADTRUE) { + StkId ra = RA(i); setbtvalue(s2v(ra)); vmbreak; } vmcase(OP_LOADNIL) { + StkId ra = RA(i); int b = GETARG_B(i); do { setnilvalue(s2v(ra++)); @@ -1209,19 +1236,22 @@ void luaV_execute (lua_State *L, CallInfo *ci) { vmbreak; } vmcase(OP_GETUPVAL) { + StkId ra = RA(i); int b = GETARG_B(i); - setobj2s(L, ra, cl->upvals[b]->v); + setobj2s(L, ra, cl->upvals[b]->v.p); vmbreak; } vmcase(OP_SETUPVAL) { + StkId ra = RA(i); UpVal *uv = cl->upvals[GETARG_B(i)]; - setobj(L, uv->v, s2v(ra)); + setobj(L, uv->v.p, s2v(ra)); luaC_barrier(L, uv, s2v(ra)); vmbreak; } vmcase(OP_GETTABUP) { + StkId ra = RA(i); const TValue *slot; - TValue *upval = cl->upvals[GETARG_B(i)]->v; + TValue *upval = cl->upvals[GETARG_B(i)]->v.p; TValue *rc = KC(i); TString *key = tsvalue(rc); /* key must be a string */ if (luaV_fastget(L, upval, key, slot, luaH_getshortstr)) { @@ -1232,6 +1262,7 @@ void luaV_execute (lua_State *L, CallInfo *ci) { vmbreak; } vmcase(OP_GETTABLE) { + StkId ra = RA(i); const TValue *slot; TValue *rb = vRB(i); TValue *rc = vRC(i); @@ -1246,6 +1277,7 @@ void luaV_execute (lua_State *L, CallInfo *ci) { vmbreak; } vmcase(OP_GETI) { + StkId ra = RA(i); const TValue *slot; TValue *rb = vRB(i); int c = GETARG_C(i); @@ -1260,6 +1292,7 @@ void luaV_execute (lua_State *L, CallInfo *ci) { vmbreak; } vmcase(OP_GETFIELD) { + StkId ra = RA(i); const TValue *slot; TValue *rb = vRB(i); TValue *rc = KC(i); @@ -1273,7 +1306,7 @@ void luaV_execute (lua_State *L, CallInfo *ci) { } vmcase(OP_SETTABUP) { const TValue *slot; - TValue *upval = cl->upvals[GETARG_A(i)]->v; + TValue *upval = cl->upvals[GETARG_A(i)]->v.p; TValue *rb = KB(i); TValue *rc = RKC(i); TString *key = tsvalue(rb); /* key must be a string */ @@ -1285,6 +1318,7 @@ void luaV_execute (lua_State *L, CallInfo *ci) { vmbreak; } vmcase(OP_SETTABLE) { + StkId ra = RA(i); const TValue *slot; TValue *rb = vRB(i); /* key (table is in 'ra') */ TValue *rc = RKC(i); /* value */ @@ -1299,6 +1333,7 @@ void luaV_execute (lua_State *L, CallInfo *ci) { vmbreak; } vmcase(OP_SETI) { + StkId ra = RA(i); const TValue *slot; int c = GETARG_B(i); TValue *rc = RKC(i); @@ -1313,6 +1348,7 @@ void luaV_execute (lua_State *L, CallInfo *ci) { vmbreak; } vmcase(OP_SETFIELD) { + StkId ra = RA(i); const TValue *slot; TValue *rb = KB(i); TValue *rc = RKC(i); @@ -1325,6 +1361,7 @@ void luaV_execute (lua_State *L, CallInfo *ci) { vmbreak; } vmcase(OP_NEWTABLE) { + StkId ra = RA(i); int b = GETARG_B(i); /* log2(hash size) + 1 */ int c = GETARG_C(i); /* array size */ Table *t; @@ -1334,7 +1371,7 @@ void luaV_execute (lua_State *L, CallInfo *ci) { if (TESTARG_k(i)) /* non-zero extra argument? */ c += GETARG_Ax(*pc) * (MAXARG_C + 1); /* add it to size */ pc++; /* skip extra argument */ - L->top = ra + 1; /* correct top in case of emergency GC */ + L->top.p = ra + 1; /* correct top in case of emergency GC */ t = luaH_new(L); /* memory allocation */ sethvalue2s(L, ra, t); if (b != 0 || c != 0) @@ -1343,6 +1380,7 @@ void luaV_execute (lua_State *L, CallInfo *ci) { vmbreak; } vmcase(OP_SELF) { + StkId ra = RA(i); const TValue *slot; TValue *rb = vRB(i); TValue *rc = RKC(i); @@ -1372,6 +1410,7 @@ void luaV_execute (lua_State *L, CallInfo *ci) { vmbreak; } vmcase(OP_MODK) { + savestate(L, ci); /* in case of division by 0 */ op_arithK(L, luaV_mod, luaV_modf); vmbreak; } @@ -1384,6 +1423,7 @@ void luaV_execute (lua_State *L, CallInfo *ci) { vmbreak; } vmcase(OP_IDIVK) { + savestate(L, ci); /* in case of division by 0 */ op_arithK(L, luaV_idiv, luai_numidiv); vmbreak; } @@ -1400,6 +1440,7 @@ void luaV_execute (lua_State *L, CallInfo *ci) { vmbreak; } vmcase(OP_SHRI) { + StkId ra = RA(i); TValue *rb = vRB(i); int ic = GETARG_sC(i); lua_Integer ib; @@ -1409,6 +1450,7 @@ void luaV_execute (lua_State *L, CallInfo *ci) { vmbreak; } vmcase(OP_SHLI) { + StkId ra = RA(i); TValue *rb = vRB(i); int ic = GETARG_sC(i); lua_Integer ib; @@ -1430,6 +1472,7 @@ void luaV_execute (lua_State *L, CallInfo *ci) { vmbreak; } vmcase(OP_MOD) { + savestate(L, ci); /* in case of division by 0 */ op_arith(L, luaV_mod, luaV_modf); vmbreak; } @@ -1442,6 +1485,7 @@ void luaV_execute (lua_State *L, CallInfo *ci) { vmbreak; } vmcase(OP_IDIV) { /* floor division */ + savestate(L, ci); /* in case of division by 0 */ op_arith(L, luaV_idiv, luai_numidiv); vmbreak; } @@ -1466,6 +1510,7 @@ void luaV_execute (lua_State *L, CallInfo *ci) { vmbreak; } vmcase(OP_MMBIN) { + StkId ra = RA(i); Instruction pi = *(pc - 2); /* original arith. expression */ TValue *rb = vRB(i); TMS tm = (TMS)GETARG_C(i); @@ -1475,6 +1520,7 @@ void luaV_execute (lua_State *L, CallInfo *ci) { vmbreak; } vmcase(OP_MMBINI) { + StkId ra = RA(i); Instruction pi = *(pc - 2); /* original arith. expression */ int imm = GETARG_sB(i); TMS tm = (TMS)GETARG_C(i); @@ -1484,6 +1530,7 @@ void luaV_execute (lua_State *L, CallInfo *ci) { vmbreak; } vmcase(OP_MMBINK) { + StkId ra = RA(i); Instruction pi = *(pc - 2); /* original arith. expression */ TValue *imm = KB(i); TMS tm = (TMS)GETARG_C(i); @@ -1493,6 +1540,7 @@ void luaV_execute (lua_State *L, CallInfo *ci) { vmbreak; } vmcase(OP_UNM) { + StkId ra = RA(i); TValue *rb = vRB(i); lua_Number nb; if (ttisinteger(rb)) { @@ -1507,6 +1555,7 @@ void luaV_execute (lua_State *L, CallInfo *ci) { vmbreak; } vmcase(OP_BNOT) { + StkId ra = RA(i); TValue *rb = vRB(i); lua_Integer ib; if (tointegerns(rb, &ib)) { @@ -1517,6 +1566,7 @@ void luaV_execute (lua_State *L, CallInfo *ci) { vmbreak; } vmcase(OP_NOT) { + StkId ra = RA(i); TValue *rb = vRB(i); if (l_isfalse(rb)) setbtvalue(s2v(ra)); @@ -1525,21 +1575,25 @@ void luaV_execute (lua_State *L, CallInfo *ci) { vmbreak; } vmcase(OP_LEN) { + StkId ra = RA(i); Protect(luaV_objlen(L, ra, vRB(i))); vmbreak; } vmcase(OP_CONCAT) { + StkId ra = RA(i); int n = GETARG_B(i); /* number of elements to concatenate */ - L->top = ra + n; /* mark the end of concat operands */ + L->top.p = ra + n; /* mark the end of concat operands */ ProtectNT(luaV_concat(L, n)); - checkGC(L, L->top); /* 'luaV_concat' ensures correct top */ + checkGC(L, L->top.p); /* 'luaV_concat' ensures correct top */ vmbreak; } vmcase(OP_CLOSE) { + StkId ra = RA(i); Protect(luaF_close(L, ra, LUA_OK, 1)); vmbreak; } vmcase(OP_TBC) { + StkId ra = RA(i); /* create new to-be-closed upvalue */ halfProtect(luaF_newtbcupval(L, ra)); vmbreak; @@ -1549,6 +1603,7 @@ void luaV_execute (lua_State *L, CallInfo *ci) { vmbreak; } vmcase(OP_EQ) { + StkId ra = RA(i); int cond; TValue *rb = vRB(i); Protect(cond = luaV_equalobj(L, s2v(ra), rb)); @@ -1564,6 +1619,7 @@ void luaV_execute (lua_State *L, CallInfo *ci) { vmbreak; } vmcase(OP_EQK) { + StkId ra = RA(i); TValue *rb = KB(i); /* basic types do not use '__eq'; we can use raw equality */ int cond = luaV_rawequalobj(s2v(ra), rb); @@ -1571,6 +1627,7 @@ void luaV_execute (lua_State *L, CallInfo *ci) { vmbreak; } vmcase(OP_EQI) { + StkId ra = RA(i); int cond; int im = GETARG_sB(i); if (ttisinteger(s2v(ra))) @@ -1599,11 +1656,13 @@ void luaV_execute (lua_State *L, CallInfo *ci) { vmbreak; } vmcase(OP_TEST) { + StkId ra = RA(i); int cond = !l_isfalse(s2v(ra)); docondjump(); vmbreak; } vmcase(OP_TESTSET) { + StkId ra = RA(i); TValue *rb = vRB(i); if (l_isfalse(rb) == GETARG_k(i)) pc++; @@ -1614,78 +1673,74 @@ void luaV_execute (lua_State *L, CallInfo *ci) { vmbreak; } vmcase(OP_CALL) { + StkId ra = RA(i); CallInfo *newci; int b = GETARG_B(i); int nresults = GETARG_C(i) - 1; if (b != 0) /* fixed number of arguments? */ - L->top = ra + b; /* top signals number of arguments */ + L->top.p = ra + b; /* top signals number of arguments */ /* else previous instruction set top */ savepc(L); /* in case of errors */ if ((newci = luaD_precall(L, ra, nresults)) == NULL) updatetrap(ci); /* C call; nothing else to be done */ else { /* Lua call: run function in this same C frame */ ci = newci; - ci->callstatus = 0; /* call re-uses 'luaV_execute' */ goto startfunc; } vmbreak; } vmcase(OP_TAILCALL) { + StkId ra = RA(i); int b = GETARG_B(i); /* number of arguments + 1 (function) */ + int n; /* number of results when calling a C function */ int nparams1 = GETARG_C(i); /* delta is virtual 'func' - real 'func' (vararg functions) */ int delta = (nparams1) ? ci->u.l.nextraargs + nparams1 : 0; if (b != 0) - L->top = ra + b; + L->top.p = ra + b; else /* previous instruction set top */ - b = cast_int(L->top - ra); + b = cast_int(L->top.p - ra); savepc(ci); /* several calls here can raise errors */ if (TESTARG_k(i)) { luaF_closeupval(L, base); /* close upvalues from current call */ - lua_assert(L->tbclist < base); /* no pending tbc variables */ - lua_assert(base == ci->func + 1); + lua_assert(L->tbclist.p < base); /* no pending tbc variables */ + lua_assert(base == ci->func.p + 1); } - while (!ttisfunction(s2v(ra))) { /* not a function? */ - luaD_tryfuncTM(L, ra); /* try '__call' metamethod */ - b++; /* there is now one extra argument */ - checkstackGCp(L, 1, ra); - } - if (!ttisLclosure(s2v(ra))) { /* C function? */ - luaD_precall(L, ra, LUA_MULTRET); /* call it */ - updatetrap(ci); - updatestack(ci); /* stack may have been relocated */ - ci->func -= delta; /* restore 'func' (if vararg) */ - luaD_poscall(L, ci, cast_int(L->top - ra)); /* finish caller */ + if ((n = luaD_pretailcall(L, ci, ra, b, delta)) < 0) /* Lua function? */ + goto startfunc; /* execute the callee */ + else { /* C function? */ + ci->func.p -= delta; /* restore 'func' (if vararg) */ + luaD_poscall(L, ci, n); /* finish caller */ updatetrap(ci); /* 'luaD_poscall' can change hooks */ goto ret; /* caller returns after the tail call */ } - ci->func -= delta; /* restore 'func' (if vararg) */ - luaD_pretailcall(L, ci, ra, b); /* prepare call frame */ - goto startfunc; /* execute the callee */ } vmcase(OP_RETURN) { + StkId ra = RA(i); int n = GETARG_B(i) - 1; /* number of results */ int nparams1 = GETARG_C(i); if (n < 0) /* not fixed? */ - n = cast_int(L->top - ra); /* get what is available */ + n = cast_int(L->top.p - ra); /* get what is available */ savepc(ci); if (TESTARG_k(i)) { /* may there be open upvalues? */ - if (L->top < ci->top) - L->top = ci->top; + ci->u2.nres = n; /* save number of returns */ + if (L->top.p < ci->top.p) + L->top.p = ci->top.p; luaF_close(L, base, CLOSEKTOP, 1); updatetrap(ci); updatestack(ci); } if (nparams1) /* vararg function? */ - ci->func -= ci->u.l.nextraargs + nparams1; - L->top = ra + n; /* set call for 'luaD_poscall' */ + ci->func.p -= ci->u.l.nextraargs + nparams1; + L->top.p = ra + n; /* set call for 'luaD_poscall' */ luaD_poscall(L, ci, n); updatetrap(ci); /* 'luaD_poscall' can change hooks */ goto ret; } vmcase(OP_RETURN0) { if (l_unlikely(L->hookmask)) { - L->top = ra; + StkId ra = RA(i); + L->top.p = ra; savepc(ci); luaD_poscall(L, ci, 0); /* no hurry... */ trap = 1; @@ -1693,15 +1748,16 @@ void luaV_execute (lua_State *L, CallInfo *ci) { else { /* do the 'poscall' here */ int nres; L->ci = ci->previous; /* back to caller */ - L->top = base - 1; + L->top.p = base - 1; for (nres = ci->nresults; l_unlikely(nres > 0); nres--) - setnilvalue(s2v(L->top++)); /* all results are nil */ + setnilvalue(s2v(L->top.p++)); /* all results are nil */ } goto ret; } vmcase(OP_RETURN1) { if (l_unlikely(L->hookmask)) { - L->top = ra + 1; + StkId ra = RA(i); + L->top.p = ra + 1; savepc(ci); luaD_poscall(L, ci, 1); /* no hurry... */ trap = 1; @@ -1710,12 +1766,13 @@ void luaV_execute (lua_State *L, CallInfo *ci) { int nres = ci->nresults; L->ci = ci->previous; /* back to caller */ if (nres == 0) - L->top = base - 1; /* asked for no results */ + L->top.p = base - 1; /* asked for no results */ else { + StkId ra = RA(i); setobjs2s(L, base - 1, ra); /* at least this result */ - L->top = base; + L->top.p = base; for (; l_unlikely(nres > 1); nres--) - setnilvalue(s2v(L->top++)); /* complete missing results */ + setnilvalue(s2v(L->top.p++)); /* complete missing results */ } } ret: /* return from a Lua function */ @@ -1727,6 +1784,7 @@ void luaV_execute (lua_State *L, CallInfo *ci) { } } vmcase(OP_FORLOOP) { + StkId ra = RA(i); if (ttisinteger(s2v(ra + 2))) { /* integer loop? */ lua_Unsigned count = l_castS2U(ivalue(s2v(ra + 1))); if (count > 0) { /* still more iterations? */ @@ -1745,12 +1803,14 @@ void luaV_execute (lua_State *L, CallInfo *ci) { vmbreak; } vmcase(OP_FORPREP) { + StkId ra = RA(i); savestate(L, ci); /* in case of errors */ if (forprep(L, ra)) pc += GETARG_Bx(i) + 1; /* skip the loop */ vmbreak; } vmcase(OP_TFORPREP) { + StkId ra = RA(i); /* create to-be-closed upvalue (if needed) */ halfProtect(luaF_newtbcupval(L, ra + 3)); pc += GETARG_Bx(i); @@ -1759,7 +1819,8 @@ void luaV_execute (lua_State *L, CallInfo *ci) { goto l_tforcall; } vmcase(OP_TFORCALL) { - l_tforcall: + l_tforcall: { + StkId ra = RA(i); /* 'ra' has the iterator function, 'ra + 1' has the state, 'ra + 2' has the control variable, and 'ra + 3' has the to-be-closed variable. The call will use the stack after @@ -1767,29 +1828,31 @@ void luaV_execute (lua_State *L, CallInfo *ci) { */ /* push function, state, and control variable */ memcpy(ra + 4, ra, 3 * sizeof(*ra)); - L->top = ra + 4 + 3; + L->top.p = ra + 4 + 3; ProtectNT(luaD_call(L, ra + 4, GETARG_C(i))); /* do the call */ updatestack(ci); /* stack may have changed */ i = *(pc++); /* go to next instruction */ lua_assert(GET_OPCODE(i) == OP_TFORLOOP && ra == RA(i)); goto l_tforloop; - } + }} vmcase(OP_TFORLOOP) { - l_tforloop: + l_tforloop: { + StkId ra = RA(i); if (!ttisnil(s2v(ra + 4))) { /* continue loop? */ setobjs2s(L, ra + 2, ra + 4); /* save control variable */ pc -= GETARG_Bx(i); /* jump back */ } vmbreak; - } + }} vmcase(OP_SETLIST) { + StkId ra = RA(i); int n = GETARG_B(i); unsigned int last = GETARG_C(i); Table *h = hvalue(s2v(ra)); if (n == 0) - n = cast_int(L->top - ra) - 1; /* get up to the top */ + n = cast_int(L->top.p - ra) - 1; /* get up to the top */ else - L->top = ci->top; /* correct top in case of emergency GC */ + L->top.p = ci->top.p; /* correct top in case of emergency GC */ last += n; if (TESTARG_k(i)) { last += GETARG_Ax(*pc) * (MAXARG_C + 1); @@ -1806,12 +1869,14 @@ void luaV_execute (lua_State *L, CallInfo *ci) { vmbreak; } vmcase(OP_CLOSURE) { + StkId ra = RA(i); Proto *p = cl->p->p[GETARG_Bx(i)]; halfProtect(pushclosure(L, p, cl->upvals, base, ra)); checkGC(L, ra + 1); vmbreak; } vmcase(OP_VARARG) { + StkId ra = RA(i); int n = GETARG_C(i) - 1; /* required results */ Protect(luaT_getvarargs(L, ci, ra, n)); vmbreak; diff --git a/3rdparty/lua/lzio.c b/3rdparty/lua/src/lzio.c similarity index 100% rename from 3rdparty/lua/lzio.c rename to 3rdparty/lua/src/lzio.c diff --git a/CMakeLists.txt b/CMakeLists.txt index 0e41c8a..f88cf26 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -17,6 +17,13 @@ set(FASTWEBCORE ${PROJECT_NAME}core) set(CMAKE_INSTALL_ALWAYS_COPY TRUE) # 设置根目录 set(ROOT_DIR ${CMAKE_CURRENT_SOURCE_DIR}) + +# 添加三方模块 +if(MSVC) + add_subdirectory(${CMAKE_SOURCE_DIR}/3rdparty/lua) + endif() + + # Recursively get all source files file(GLOB_RECURSE SOURCE_FILES "${PROJECT_SOURCE_DIR}/src/*.cpp" @@ -40,12 +47,13 @@ endforeach() set(YLIB ${CMAKE_INSTALL_PREFIX}/../ylib) include_directories(${PROJECT_SOURCE_DIR}/src) if(MSVC) + include_directories(${PROJECT_SOURCE_DIR}/src) include_directories(${PROJECT_SOURCE_DIR}/3rdparty) - include_directories(${PROJECT_SOURCE_DIR}/3rdparty/HP-Socket/Windows/Include) - include_directories(${PROJECT_SOURCE_DIR}/3rdparty/lua) + include_directories(${PROJECT_SOURCE_DIR}/3rdparty/lua/include) include_directories(${PROJECT_SOURCE_DIR}/3rdparty/soci/include) include_directories(${PROJECT_SOURCE_DIR}/3rdparty/mysql/include/jdbc) + include_directories(${PROJECT_SOURCE_DIR}/3rdparty/HP-Socket/Windows/Include) include_directories(${YLIB}/include) add_compile_options(/W3 /wd4819) else() @@ -74,14 +82,12 @@ if(MSVC) IPHLPAPI.lib WS2_32.lib Shell32.lib + lualib ${YLIB}/lib/libcrypto_static_win64.lib - $<$:${PROJECT_SOURCE_DIR}/3rdparty/HP-Socket/Lib/HPSocket_D.lib> $<$:${PROJECT_SOURCE_DIR}/3rdparty/mysql/lib/Debug/mysqlcppconn.lib> - $<$:${YLIB}/lib/leveldb_d.lib> $<$:${YLIB}/lib/libzip_d.lib> - $<$:${YLIB}/lib/lua_d.lib> $<$:${YLIB}/lib/sqlite3_d.lib> $<$:${YLIB}/lib/ylib_d.lib> $<$:${YLIB}/lib/zlib_d.lib> @@ -141,6 +147,7 @@ foreach(MODULE ${MODULES}) endif() endforeach() + ######################## 安装 ######################## install(TARGETS ${FASTWEBCORE} DESTINATION $,bin/debug,bin/release>) install(TARGETS ${PROJECT_NAME} DESTINATION $,bin/debug,bin/release>) @@ -160,8 +167,13 @@ install(FILES config.ini DESTINATION bin/release) install(DIRECTORY ${PROJECT_SOURCE_DIR}/scripts DESTINATION bin/debug) install(DIRECTORY ${PROJECT_SOURCE_DIR}/config DESTINATION bin/debug) install(DIRECTORY ${PROJECT_SOURCE_DIR}/scripts DESTINATION bin/release) -install(DIRECTORY ${PROJECT_SOURCE_DIR}/config DESTINATION bin/release) +install(DIRECTORY ${PROJECT_SOURCE_DIR}/config DESTINATION bin/release) install(FILES ${PROJECT_SOURCE_DIR}/src/core/entry.h DESTINATION include) +if(MSVC) + install(FILES 3rdparty/luarocks.exe DESTINATION bin/debug/3rdparty) + install(FILES 3rdparty/luarocks.exe DESTINATION bin/release/3rdparty) +endif() + diff --git a/module/hello/CMakeLists.txt b/module/hello/CMakeLists.txt index 071d2b9..56bb5f6 100644 --- a/module/hello/CMakeLists.txt +++ b/module/hello/CMakeLists.txt @@ -40,12 +40,12 @@ if(MSVC) IPHLPAPI.lib WS2_32.lib Shell32.lib + lualib ${YLIB}/lib/libcrypto_static_win64.lib $<$:${ROOT_DIR}/3rdparty/HP-Socket/Lib/HPSocket_D.lib> $<$:${ROOT_DIR}/3rdparty/mysql/lib/Debug/mysqlcppconn.lib> $<$:${YLIB}/lib/leveldb_d.lib> $<$:${YLIB}/lib/libzip_d.lib> - $<$:${YLIB}/lib/lua_d.lib> $<$:${YLIB}/lib/sqlite3_d.lib> $<$:${YLIB}/lib/ylib_d.lib> $<$:${YLIB}/lib/zlib_d.lib> @@ -59,7 +59,6 @@ if(MSVC) $<$:${ROOT_DIR}/3rdparty/mysql/lib/Release/mysqlcppconn.lib> $<$:${YLIB}/lib/leveldb.lib> $<$:${YLIB}/lib/libzip.lib> - $<$:${YLIB}/lib/lua.lib> $<$:${YLIB}/lib/sqlite3.lib> $<$:${YLIB}/lib/ylib.lib> $<$:${YLIB}/lib/zlib.lib>