Add lua52compat build option instead of feature flag

Author: khvzak

Cargo.toml

@@ -11,8 +11,5 @@ description = """
 Sources of LuaJIT 2.1 (OpenResty's branch) and logic to build it.
 """
 
-[features]
-lua52compat = []
-
 [dependencies]
 cc = "1.0"

extras/msvcbuild.bat

@@ -0,0 +1,133 @@
+@rem Script to build LuaJIT with MSVC.
+@rem Copyright (C) 2005-2021 Mike Pall. See Copyright Notice in luajit.h
+@rem
+@rem Open a "Visual Studio Command Prompt" (either x86 or x64).
+@rem Then cd to this directory and run this script. Use the following
+@rem options (in order), if needed. The default is a dynamic release build.
+@rem
+@rem   nogc64   disable LJ_GC64 mode for x64
+@rem   lua52c   enable lua52 compat mode
+@rem   debug    emit debug symbols
+@rem   amalg    amalgamated build
+@rem   static   static linkage
+
+@if not defined INCLUDE goto :FAIL
+
+@setlocal
+@rem Add more debug flags here, e.g. DEBUGCFLAGS=/DLUA_USE_APICHECK
+@set DEBUGCFLAGS=
+@set LJCOMPILE=cl /nologo /c /O2 /W3 /D_CRT_SECURE_NO_DEPRECATE /D_CRT_STDIO_INLINE=__declspec(dllexport)__inline
+@set LJLINK=link /nologo
+@set LJMT=mt /nologo
+@set LJLIB=lib /nologo /nodefaultlib
+@set DASMDIR=..\dynasm
+@set DASM=%DASMDIR%\dynasm.lua
+@set DASC=vm_x64.dasc
+@set LJDLLNAME=lua51.dll
+@set LJLIBNAME=lua51.lib
+@set BUILDTYPE=release
+@set ALL_LIB=lib_base.c lib_math.c lib_bit.c lib_string.c lib_table.c lib_io.c lib_os.c lib_package.c lib_debug.c lib_jit.c lib_ffi.c lib_buffer.c
+
+%LJCOMPILE% host\minilua.c
+@if errorlevel 1 goto :BAD
+%LJLINK% /out:minilua.exe minilua.obj
+@if errorlevel 1 goto :BAD
+if exist minilua.exe.manifest^
+  %LJMT% -manifest minilua.exe.manifest -outputresource:minilua.exe
+
+@set DASMFLAGS=-D WIN -D JIT -D FFI -D P64
+@set LJARCH=x64
+@minilua
+@if errorlevel 8 goto :X64
+@set DASC=vm_x86.dasc
+@set DASMFLAGS=-D WIN -D JIT -D FFI
+@set LJARCH=x86
+@set LJCOMPILE=%LJCOMPILE% /arch:SSE2
+:X64
+@if "%1" neq "nogc64" goto :GC64
+@shift
+@set DASC=vm_x86.dasc
+@set LJCOMPILE=%LJCOMPILE% /DLUAJIT_DISABLE_GC64
+:GC64
+minilua %DASM% -LN %DASMFLAGS% -o host\buildvm_arch.h %DASC%
+@if errorlevel 1 goto :BAD
+
+@if "%1" neq "lua52c" goto :NOLUA52C
+@shift
+@set LJCOMPILE=%LJCOMPILE% /DLUAJIT_ENABLE_LUA52COMPAT
+:NOLUA52C
+
+%LJCOMPILE% /I "." /I %DASMDIR% host\buildvm*.c
+@if errorlevel 1 goto :BAD
+%LJLINK% /out:buildvm.exe buildvm*.obj
+@if errorlevel 1 goto :BAD
+if exist buildvm.exe.manifest^
+  %LJMT% -manifest buildvm.exe.manifest -outputresource:buildvm.exe
+
+buildvm -m peobj -o lj_vm.obj
+@if errorlevel 1 goto :BAD
+buildvm -m bcdef -o lj_bcdef.h %ALL_LIB%
+@if errorlevel 1 goto :BAD
+buildvm -m ffdef -o lj_ffdef.h %ALL_LIB%
+@if errorlevel 1 goto :BAD
+buildvm -m libdef -o lj_libdef.h %ALL_LIB%
+@if errorlevel 1 goto :BAD
+buildvm -m recdef -o lj_recdef.h %ALL_LIB%
+@if errorlevel 1 goto :BAD
+buildvm -m vmdef -o jit\vmdef.lua %ALL_LIB%
+@if errorlevel 1 goto :BAD
+buildvm -m folddef -o lj_folddef.h lj_opt_fold.c
+@if errorlevel 1 goto :BAD
+
+@if "%1" neq "debug" goto :NODEBUG
+@shift
+@set BUILDTYPE=debug
+@set LJCOMPILE=%LJCOMPILE% /Zi %DEBUGCFLAGS%
+@set LJLINK=%LJLINK% /opt:ref /opt:icf /incremental:no
+:NODEBUG
+@set LJLINK=%LJLINK% /%BUILDTYPE%
+@if "%1"=="amalg" goto :AMALGDLL
+@if "%1"=="static" goto :STATIC
+%LJCOMPILE% /MD /DLUA_BUILD_AS_DLL lj_*.c lib_*.c
+@if errorlevel 1 goto :BAD
+%LJLINK% /DLL /out:%LJDLLNAME% lj_*.obj lib_*.obj
+@if errorlevel 1 goto :BAD
+@goto :MTDLL
+:STATIC
+%LJCOMPILE% lj_*.c lib_*.c
+@if errorlevel 1 goto :BAD
+%LJLIB% /OUT:%LJLIBNAME% lj_*.obj lib_*.obj
+@if errorlevel 1 goto :BAD
+@goto :MTDLL
+:AMALGDLL
+%LJCOMPILE% /MD /DLUA_BUILD_AS_DLL ljamalg.c
+@if errorlevel 1 goto :BAD
+%LJLINK% /DLL /out:%LJDLLNAME% ljamalg.obj lj_vm.obj
+@if errorlevel 1 goto :BAD
+:MTDLL
+if exist %LJDLLNAME%.manifest^
+  %LJMT% -manifest %LJDLLNAME%.manifest -outputresource:%LJDLLNAME%;2
+
+%LJCOMPILE% luajit.c
+@if errorlevel 1 goto :BAD
+%LJLINK% /out:luajit.exe luajit.obj %LJLIBNAME%
+@if errorlevel 1 goto :BAD
+if exist luajit.exe.manifest^
+  %LJMT% -manifest luajit.exe.manifest -outputresource:luajit.exe
+
+@del *.obj *.manifest minilua.exe buildvm.exe
+@del host\buildvm_arch.h
+@del lj_bcdef.h lj_ffdef.h lj_libdef.h lj_recdef.h lj_folddef.h
+@echo.
+@echo === Successfully built LuaJIT for Windows/%LJARCH% ===
+
+@goto :END
+:BAD
+@echo.
+@echo *******************************************************
+@echo *** Build FAILED -- Please check the error messages ***
+@echo *******************************************************
+@goto :END
+:FAIL
+@echo You must open a "Visual Studio Command Prompt" to run this script
+:END

src/lib.rs

@@ -7,6 +7,7 @@ pub struct Build {
     out_dir: Option<PathBuf>,
     target: Option<String>,
     host: Option<String>,
+    options: Options,
 }
 
 pub struct Artifacts {
@@ -15,13 +16,19 @@ pub struct Artifacts {
     libs: Vec<String>,
 }
 
+#[derive(Default, Clone, Copy)]
+struct Options {
+    lua52compat: bool,
+}
+
 impl Build {
     #[allow(clippy::new_without_default)]
     pub fn new() -> Build {
         Build {
             out_dir: env::var_os("OUT_DIR").map(|s| PathBuf::from(s).join("luajit-build")),
             target: env::var("TARGET").ok(),
             host: env::var("HOST").ok(),
+            options: Options::default(),
         }
     }
 
@@ -40,6 +47,11 @@ impl Build {
         self
     }
 
+    pub fn lua52compat(&mut self, status: bool) -> &mut Build {
+        self.options.lua52compat = status;
+        self
+    }
+
     fn cmd_make(&self) -> Command {
         match &self.host.as_ref().expect("HOST dir not set")[..] {
             "x86_64-unknown-dragonfly" => Command::new("gmake"),
@@ -106,7 +118,7 @@ impl Build {
         }
 
         let mut xcflags = vec!["-fPIC"];
-        if cfg!(feature = "lua52compat") {
+        if self.options.lua52compat {
             xcflags.push("-DLUAJIT_ENABLE_LUA52COMPAT");
         }
 
@@ -134,6 +146,7 @@ impl Build {
         let target = &self.target.as_ref().expect("TARGET not set")[..];
         let out_dir = self.out_dir.as_ref().expect("OUT_DIR not set");
         let source_dir = Path::new(env!("CARGO_MANIFEST_DIR")).join("luajit2");
+        let extras_dir = Path::new(env!("CARGO_MANIFEST_DIR")).join("extras");
         let build_dir = out_dir.join("build");
         let lib_dir = out_dir.join("lib");
         let include_dir = out_dir.join("include");
@@ -147,9 +160,13 @@ impl Build {
                 .unwrap_or_else(|e| panic!("cannot create {}: {}", dir.display(), e));
         }
         cp_r(&source_dir, &build_dir);
+        cp_r(&extras_dir, &build_dir.join("src"));
 
         let mut msvcbuild = Command::new(build_dir.join("src").join("msvcbuild.bat"));
         msvcbuild.current_dir(build_dir.join("src"));
+        if self.options.lua52compat {
+            msvcbuild.arg("lua52c");
+        }
         msvcbuild.arg("static");
 
         let cl = cc::windows_registry::find_tool(&target, "cl.exe").expect("failed to find cl");

testcrate/Cargo.toml

@@ -4,7 +4,7 @@ version = "0.1.0"
 authors = ["Aleksandr Orlenko <[email protected]>"]
 
 [features]
-lua52compat = ["luajit-src/lua52compat"]
+lua52compat = []
 
 [build-dependencies]
 luajit-src = { path = ".." }

testcrate/build.rs

@@ -1,5 +1,9 @@
 fn main() {
     println!("cargo:rerun-if-changed=build.rs");
-    let artifacts = luajit_src::Build::new().build();
+    let mut builder = luajit_src::Build::new();
+    if cfg!(feature = "lua52compat") {
+        builder.lua52compat(true);
+    }
+    let artifacts = builder.build();
     artifacts.print_cargo_metadata();
 }

testcrate/src/lib.rs

@@ -5,14 +5,16 @@ extern "C" {
     pub fn luaL_openlibs(state: *mut c_void);
     pub fn lua_getfield(state: *mut c_void, index: c_int, k: *const c_char);
     pub fn lua_tolstring(state: *mut c_void, index: c_int, len: *mut c_long) -> *const c_char;
+    pub fn luaL_loadstring(state: *mut c_void, s: *const c_char) -> c_int;
+    pub fn lua_pcall(state: *mut c_void, nargs: c_int, nresults: c_int, errfunc: c_int) -> c_int;
 }
 
 pub unsafe fn lua_getglobal(state: *mut c_void, k: *const c_char) {
     lua_getfield(state, -10002 /* LUA_GLOBALSINDEX */, k);
 }
 
 #[test]
-fn lua_works() {
+fn test_lua() {
     use std::{ptr, slice};
     unsafe {
         let state = luaL_newstate();
@@ -27,6 +29,44 @@ fn lua_works() {
             slice::from_raw_parts(version_ptr as *const u8, len as usize)
         };
 
-        assert_eq!(version, "Lua 5.1".as_bytes());
+        assert_eq!(version, b"Lua 5.1");
+    }
+}
+
+#[test]
+fn test_lua52compat() {
+    use std::{ptr, slice};
+    unsafe {
+        let state = luaL_newstate();
+        assert!(state != ptr::null_mut());
+
+        luaL_openlibs(state);
+
+        let code = "
+            lua52compat = \"no\"
+            t = setmetatable({}, {
+                __pairs = function(t)
+                    lua52compat = \"yes\"
+                    return next, t, nil
+                end
+            })
+            for k,v in pairs(t) do end
+        \0";
+        let ret1 = luaL_loadstring(state, code.as_ptr().cast());
+        assert_eq!(0, ret1);
+        let ret2 = lua_pcall(state, 0, 0, 0);
+        assert_eq!(0, ret2);
+
+        let lua52compat = {
+            lua_getglobal(state, "lua52compat\0".as_ptr().cast());
+            let mut len: c_long = 0;
+            let lua52compat_ptr = lua_tolstring(state, -1, &mut len);
+            slice::from_raw_parts(lua52compat_ptr as *const u8, len as usize)
+        };
+
+        #[cfg(feature = "lua52compat")]
+        assert_eq!(lua52compat, b"yes");
+        #[cfg(not(feature = "lua52compat"))]
+        assert_eq!(lua52compat, b"no");
     }
 }