Merge pull request #788 from squeek502/lua5.5

Add support for and test against Lua 5.5

Author: squeek502

.ci/setup_lua.sh

@@ -70,6 +70,9 @@ else
   elif [ "$LUA" == "lua5.4" ]; then
     curl --silent https://www.lua.org/ftp/lua-5.4.4.tar.gz | tar xz
     cd lua-5.4.4;
+  elif [ "$LUA" == "lua5.5" ]; then
+    curl --silent https://www.lua.org/ftp/lua-5.5.0.tar.gz | tar xz
+    cd lua-5.5.0;
   fi
 
   # Build Lua without backwards compatibility for testing
@@ -132,4 +135,6 @@ elif [ "$LUA" == "lua5.3" ]; then
   rm -rf lua-5.3.6;
 elif [ "$LUA" == "lua5.4" ]; then
   rm -rf lua-5.4.4;
+elif [ "$LUA" == "lua5.5" ]; then
+  rm -rf lua-5.5.0;
 fi

.ci/winmake.bat

@@ -154,33 +154,56 @@ IF NOT EXIST %LUA_H% (
    goto :EXITERROR
 )
 
-findstr /R /C:"#define[ %TABCHAR%][ %TABCHAR%]*LUA_VERSION_MAJOR"  %LUA_H% > NUL
-if NOT %ERRORLEVEL%==0 (
-   rem ECHO We've got a Lua version 5.1
-   rem findstr /R /C:"#define[ %TABCHAR%][ %TABCHAR%]*LUA_VERSION[ %TABCHAR%]"  %LUA_H%
-   SET LUA_VER=5.1
-) else (
-   rem ECHO We've got a Lua version 5.2+
-   rem findstr /R /C:"#define[ %TABCHAR%][ %TABCHAR%]*LUA_VERSION_MAJOR[ %TABCHAR%]"  %LUA_H%
-   rem findstr /R /C:"#define[ %TABCHAR%][ %TABCHAR%]*LUA_VERSION_MINOR[ %TABCHAR%]"  %LUA_H%
+findstr /R /C:"#define[ %TABCHAR%][ %TABCHAR%]*LUA_VERSION_MAJOR_N"  %LUA_H% > NUL
+if %ERRORLEVEL%==0 (
+   rem ECHO We've got a Lua version 5.5+
+   rem findstr /R /C:"#define[ %TABCHAR%][ %TABCHAR%]*LUA_VERSION_MAJOR_N[ %TABCHAR%]"  %LUA_H%
+   rem findstr /R /C:"#define[ %TABCHAR%][ %TABCHAR%]*LUA_VERSION_MINOR_N[ %TABCHAR%]"  %LUA_H%
 
-   for /F "delims=" %%a in ('findstr /R /C:"#define[ %TABCHAR%][ %TABCHAR%]*LUA_VERSION_MAJOR[ %TABCHAR%]"  %LUA_H%') do set LUA_MAJOR=%%a
+   for /F "delims=" %%a in ('findstr /R /C:"#define[ %TABCHAR%][ %TABCHAR%]*LUA_VERSION_MAJOR_N[ %TABCHAR%]"  %LUA_H%') do set LUA_MAJOR=%%a
    SET LUA_MAJOR=!LUA_MAJOR:#define=!
-   SET LUA_MAJOR=!LUA_MAJOR:LUA_VERSION_MAJOR=!
+   SET LUA_MAJOR=!LUA_MAJOR:LUA_VERSION_MAJOR_N=!
    SET LUA_MAJOR=!LUA_MAJOR: =!
    SET LUA_MAJOR=!LUA_MAJOR:%TABCHAR%=!
-   SET LUA_MAJOR=!LUA_MAJOR:"=!
    SET LUA_MAJOR=!LUA_MAJOR:~0,1!
 
-   for /F "delims=" %%a in ('findstr /R /C:"#define[ %TABCHAR%][ %TABCHAR%]*LUA_VERSION_MINOR[ %TABCHAR%]"  %LUA_H%') do set LUA_MINOR=%%a
+   for /F "delims=" %%a in ('findstr /R /C:"#define[ %TABCHAR%][ %TABCHAR%]*LUA_VERSION_MINOR_N[ %TABCHAR%]"  %LUA_H%') do set LUA_MINOR=%%a
    SET LUA_MINOR=!LUA_MINOR:#define=!
-   SET LUA_MINOR=!LUA_MINOR:LUA_VERSION_MINOR=!
+   SET LUA_MINOR=!LUA_MINOR:LUA_VERSION_MINOR_N=!
    SET LUA_MINOR=!LUA_MINOR: =!
    SET LUA_MINOR=!LUA_MINOR:%TABCHAR%=!
-   SET LUA_MINOR=!LUA_MINOR:"=!
    SET LUA_MINOR=!LUA_MINOR:~0,1!
 
    SET LUA_VER=!LUA_MAJOR!.!LUA_MINOR!
+) else (
+   findstr /R /C:"#define[ %TABCHAR%][ %TABCHAR%]*LUA_VERSION_MAJOR"  %LUA_H% > NUL
+   if NOT %ERRORLEVEL%==0 (
+      rem ECHO We've got a Lua version 5.1
+      rem findstr /R /C:"#define[ %TABCHAR%][ %TABCHAR%]*LUA_VERSION[ %TABCHAR%]"  %LUA_H%
+      SET LUA_VER=5.1
+   ) else (
+      rem ECHO We've got a Lua version 5.2+
+      rem findstr /R /C:"#define[ %TABCHAR%][ %TABCHAR%]*LUA_VERSION_MAJOR[ %TABCHAR%]"  %LUA_H%
+      rem findstr /R /C:"#define[ %TABCHAR%][ %TABCHAR%]*LUA_VERSION_MINOR[ %TABCHAR%]"  %LUA_H%
+
+      for /F "delims=" %%a in ('findstr /R /C:"#define[ %TABCHAR%][ %TABCHAR%]*LUA_VERSION_MAJOR[ %TABCHAR%]"  %LUA_H%') do set LUA_MAJOR=%%a
+      SET LUA_MAJOR=!LUA_MAJOR:#define=!
+      SET LUA_MAJOR=!LUA_MAJOR:LUA_VERSION_MAJOR=!
+      SET LUA_MAJOR=!LUA_MAJOR: =!
+      SET LUA_MAJOR=!LUA_MAJOR:%TABCHAR%=!
+      SET LUA_MAJOR=!LUA_MAJOR:"=!
+      SET LUA_MAJOR=!LUA_MAJOR:~0,1!
+
+      for /F "delims=" %%a in ('findstr /R /C:"#define[ %TABCHAR%][ %TABCHAR%]*LUA_VERSION_MINOR[ %TABCHAR%]"  %LUA_H%') do set LUA_MINOR=%%a
+      SET LUA_MINOR=!LUA_MINOR:#define=!
+      SET LUA_MINOR=!LUA_MINOR:LUA_VERSION_MINOR=!
+      SET LUA_MINOR=!LUA_MINOR: =!
+      SET LUA_MINOR=!LUA_MINOR:%TABCHAR%=!
+      SET LUA_MINOR=!LUA_MINOR:"=!
+      SET LUA_MINOR=!LUA_MINOR:~0,1!
+
+      SET LUA_VER=!LUA_MAJOR!.!LUA_MINOR!
+   )
 )
 SET LUA_SVER=!LUA_VER:.=!
 
@@ -233,6 +256,16 @@ if %LUA_SVER%==54 (
       set COMPATFLAG=-DLUA_COMPAT_5_3
    )
 )
+if %LUA_SVER%==55 (
+   set FILES_CORE=lapi lcode lctype ldebug ldo ldump lfunc lgc llex lmem lobject lopcodes lparser lstate lstring ltable ltm lundump lvm lzio lauxlib
+   set FILES_LIB=lbaselib ldblib liolib lmathlib loslib ltablib lstrlib lutf8lib loadlib lcorolib linit
+   set FILES_DLL=lua
+   set FILES_OTH=luac
+   set INSTALL_H=lauxlib.h lua.h lua.hpp luaconf.h lualib.h
+   if "%COMPATFLAG%"=="" (
+      set COMPATFLAG=-DLUA_COMPAT_5_3
+   )
+)
 
 if "%NOCOMPAT%"=="TRUE" (
    set COMPATFLAG=

.github/workflows/ci.yml

@@ -119,13 +119,13 @@ jobs:
     strategy:
       matrix:
         os: [macos-latest, ubuntu-latest]
-        luarocks_version: [3.8.0]
+        luarocks_version: [3.13.0]
         lua_engine: [Lua, LuaJIT]
         include:
           - lua_engine: LuaJIT
             lua_version: luajit2.1
           - lua_engine: Lua
-            lua_version: lua5.4
+            lua_version: lua5.5
     env:
       # For LuaJIT 2.1, see https://github.com/LuaJIT/LuaJIT/commit/8961a92dd1607108760694af3486b4434602f8be
       MACOSX_DEPLOYMENT_TARGET: 10.12
@@ -172,7 +172,7 @@ jobs:
     env:
       WITH_LUA_ENGINE: LuaJIT
       LUA: luajit2.1
-      LUAROCKS: 3.8.0
+      LUAROCKS: 3.13.0
     steps:
     - uses: actions/checkout@v2
       with:

CMakeLists.txt

@@ -101,7 +101,7 @@ if (LUA)
         NO_DEFAULT_PATH)
       ELSEIF(LUA_EXEC_NAME MATCHES "lua.*")
         FIND_LIBRARY(LUA_LIBRARIES
-          NAMES lua lua54 lua53 lua52 lua51 liblua liblua54 liblua53 liblua52 liblua51
+          NAMES lua lua55 lua54 lua53 lua52 lua51 liblua liblua55 liblua54 liblua53 liblua52 liblua51
           PATHS ${LUA_LIBDIR}
           NO_DEFAULT_PATH)
       ENDIF()

appveyor.yml

@@ -10,18 +10,18 @@ environment:
     - FROM_DEPS: true
 
     # LuaRocks 3.x
-    - LUA_VER: 5.4.4
+    - LUA_VER: 5.5.0
       NOCOMPAT: true  # with compatibility flags disabled.
-      LUAROCKS_VER: 3.8.0
+      LUAROCKS_VER: 3.13.0
     - LJ_VER: 2.1
-      LUAROCKS_VER: 3.8.0
+      LUAROCKS_VER: 3.13.0
 
 matrix:
   fast_finish: true
   exclude:
     # Skip x86 for LuaRocks tests
     - platform: x86
-      LUAROCKS_VER: 3.8.0
+      LUAROCKS_VER: 3.13.0
 
 cache:
   - c:\lua -> appveyor.yml

deps/lua

@@ -6,7 +6,7 @@
 # Redistribution and use of this file is allowed according to the terms of the MIT license.
 # Debugged and (now seriously) modified by Ronan Collobert, for Torch7
 
-#project(Lua54 C)
+#project(Lua55 C)
 
 SET(LUA_DIR ${CMAKE_CURRENT_LIST_DIR}/lua CACHE PATH "location of lua sources")
 
@@ -112,7 +112,7 @@ set_target_properties(lualib PROPERTIES
   COMPILE_DEFINITIONS MAKE_LIB=1)
 
 target_link_libraries (lualib ${LIBS} )
-set_target_properties (lualib PROPERTIES OUTPUT_NAME "lua54")
+set_target_properties (lualib PROPERTIES OUTPUT_NAME "lua55")
 
 add_executable(lua ${LUA_DIR}/lua.c)
 IF(WIN32)

deps/lua.cmake

@@ -8,7 +8,7 @@ rockspec_format = "3.0"
 description = {
   summary = "Bare libuv bindings for lua",
   detailed = [[
-libuv bindings for luajit and lua 5.1/5.2/5.3/5.4.
+libuv bindings for luajit and lua 5.1/5.2/5.3/5.4/5.5.
 
 This library makes libuv available to lua scripts. It was made for the luvit
 project but should usable from nearly any lua project.

luv-scm-0.rockspec

@@ -251,6 +251,9 @@ static int thread_dump (lua_State *L, const void *b, size_t size, void *ud) {
     state->init = 1;
     luaL_buffinit(L, &state->B);
   }
+  // Starting with Lua 5.5.0, lua_dump calls this function with b == NULL to signal
+  // the end of the dump. We don't have to worry about that, though, because size will
+  // also be zero in that case and luaL_addlstring is a no-op when size is zero.
   luaL_addlstring(&state->B, (const char *)b, size);
   return 0;
 }
@@ -261,25 +264,34 @@ static int luv_thread_dumped(lua_State* L, int idx) {
   } else {
     int ret, top;
     struct luv_thread_Writer state;
-    top = lua_gettop(L);
     state.init = 0;
 
+    // The goal is to return from this function with the only change to the stack
+    // being the dumped thread pushed onto the top.
+    //
+    // Different Lua versions have different behaviors around how lua_dump and
+    // luaL_Buffer handle the stack, so the approach used here avoids the need to deal
+    // with those discrepencies.
+    //
+    // The idea is:
+    // - Push `nil` onto the stack as a placeholder for the resulting dumped string
+    // - Call lua_dump and let it and luaL_pushresult push/pop from the stack however
+    //   they wish (we know they will never touch our placeholder).
+    // - Move the result of luaL_pushresult to our placeholder's index and set it as
+    //   the top before returning
+    lua_pushnil(L);
+    top = lua_gettop(L);
+
     // lua_dump needs the function at the top of the stack
     luaL_checktype(L, idx, LUA_TFUNCTION);
     lua_pushvalue(L, idx);
     ret = lua_dump(L, thread_dump, &state, 1);
     if (ret==0) {
       luaL_pushresult(&state.B);
-      // The goal is to return from this function with the only change to the stack
-      // being the dumped thread pushed onto the top. In Lua >= 5.4.3, this is a bit
-      // tricky because luaL_Buffer pushes its buffer onto the stack and relies on
-      // that stack value's lifetime for its memory. This means that we can't safely
-      // pop that value off the stack until after we have fully dumped the function
-      // and pushed the result. After we push the result (luaL_pushresult), we want
-      // to get rid of any intermediate values and put the result at the new top of
-      // the stack, 1 after the top that we entered with. That's what's happening here:
-      lua_replace(L, top + 1);
-      lua_settop(L, top + 1);
+      // Move the result to our placeholder index and pop off whatever remains from
+      // the lua_dump call.
+      lua_replace(L, top);
+      lua_settop(L, top);
     } else
       luaL_error(L, "Error: unable to dump given function");
   }

src/thread.c

@@ -11,8 +11,6 @@ return require('lib/tap')(function (test)
       assert(c==250)
       uv.close(async)
     end))
-    local args = {500, 'string', nil, false, 5, "helloworld",async}
-    local unpack = unpack or table.unpack
     uv.new_thread(function(num,s,null,bool,five,hw,asy)
       local uv = require'luv'
       assert(type(num) == "number")
@@ -24,7 +22,7 @@ return require('lib/tap')(function (test)
       assert(type(asy)=='userdata')
       assert(uv.async_send(asy,'a',true,250)==0)
       uv.sleep(1000)
-    end, unpack(args)):join()
+    end, 500, 'string', nil, false, 5, "helloworld",async):join()
     local elapsed = (os.time() - before) * 1000
     assert(elapsed >= 1000, "elapsed should be at least delay ")
   end)