Add tests for ffi (#243)

Author: qwreey

crates/lune-std-ffi/src/ffi/ffi_ref/flags.rs

@@ -22,7 +22,7 @@ impl FfiRefFlag {
 pub struct FfiRefFlagList(u8);
 #[allow(unused)]
 impl FfiRefFlagList {
-    pub fn zero() -> Self {
+    pub const fn zero() -> Self {
         Self(0)
     }
     pub const fn new(flags: u8) -> Self {

crates/lune-std-ffi/src/ffi/ffi_ref/mod.rs

@@ -16,6 +16,9 @@ pub use self::{
     flags::{FfiRefFlag, FfiRefFlagList},
 };
 
+// Box:ref():ref() should not be able to modify, Only for external
+const BOX_REF_REF_FLAGS: FfiRefFlagList = FfiRefFlagList::zero();
+
 // A referenced space. It is possible to read and write through types.
 // This operation is not safe. This may cause a memory error in Lua
 // if use it incorrectly.
@@ -46,15 +49,10 @@ impl FfiRef {
         this: LuaAnyUserData<'lua>,
     ) -> LuaResult<LuaAnyUserData<'lua>> {
         let target = this.borrow::<FfiRef>()?;
-        let mut flags = target.flags.clone();
-
-        // FIXME:
-        // We cannot dereference ref which created by lua, in lua
-        flags.set_dereferenceable(false);
 
         let luaref = lua.create_userdata(FfiRef::new(
             ptr::from_ref(&target.ptr) as *mut (),
-            flags,
+            BOX_REF_REF_FLAGS,
             FfiRefBounds {
                 below: 0,
                 above: size_of::<usize>(),

tests/ffi/box-recursion-gc.luau

@@ -0,0 +1,20 @@
+--!nocheck
+--!nolint
+
+local ffi = require("@lune/ffi")
+
+local box = ffi.box(ffi.u8:ptr().size)
+local ref = box:ref()
+ffi.u8:ptr():into(box, ref)
+
+local wt = setmetatable({}, { __mode = "v" })
+
+wt[1] = box
+wt[2] = ref
+
+box = nil
+ref = nil
+
+collectgarbage("collect")
+
+assert(wt[1] == nil and wt[2] == nil, "Box - ref recursion GC test failed")

tests/ffi/cast.luau

@@ -0,0 +1,10 @@
+--!nocheck
+--!nolint
+
+local ffi = require("@lune/ffi")
+
+local int = 0b1
+local float = 0.5
+
+assert(ffi.isInteger(int) == true, "ffi.isInteger(int) == true failed")
+assert(ffi.isInteger(float) == false, "ffi.isInteger(float) == false failed")

tests/ffi/external.luau

@@ -0,0 +1,15 @@
+--!nocheck
+--!nolint
+
+local ffi = require("@lune/ffi")
+local box = ffi.box(ffi.i32.size)
+local ref = box:ref()
+
+local wt = setmetatable({}, { __mode = "v" })
+
+wt[1] = box
+box = nll
+
+collectgarbage("collect")
+
+assert(wt[1] ~= nil, "ref hold box failed")

tests/ffi/from-boundary.luau

@@ -0,0 +1,32 @@
+--!nocheck
+--!nolint
+
+local ffi = require("@lune/ffi")
+
+-- ptr size test
+assert(
+	ffi.i32:ptr().size == ffi.i64:ptr().size,
+	"All of Ptr.size must be same.\n" .. "ffi.i32:ptr().size == ffi.i64:ptr().size failed"
+)
+
+-- inner test
+local i32ptr = ffi.i32:ptr()
+assert(
+	rawequal(ffi.i32, i32ptr.inner),
+	"Ptr.inner must be same with their parent\n" .. "raweq ffi.i32 == ffi.i32:ptr().inner failed"
+)
+assert(
+	rawequal(i32ptr, i32ptr:ptr().inner),
+	"Ptr.inner must be same with their parent\n" .. "raweq i32ptr == i32ptr:ptr().inner failed"
+)
+assert(
+	rawequal(i32ptr, i32ptr:ptr().inner:ptr().inner:ptr().inner),
+	"Ptr.inner must be same with their parent\n"
+		.. "raweq i32ptr == i32ptr:ptr().inner:ptr().inner:ptr().inner failed"
+)
+
+-- deep ptr test
+local ok, err = pcall(function()
+	i32ptr:ptr():ptr():ptr():ptr():ptr():ptr():ptr()
+end)
+assert(ok, `Deep ptr test failed.\n{err}`)

tests/ffi/into-boundary.luau

@@ -0,0 +1,12 @@
+--!nocheck
+--!nolint
+
+local ffi = require("@lune/ffi")
+
+local i32ptr = ffi.i32:ptr()
+local struct = ffi.struct({ i32ptr, ffi.i32 })
+
+assert(rawequal(struct:field(0), i32ptr), "Struct get field failed")
+assert(rawequal(struct:field(1), ffi.i32), "Struct get field failed")
+
+-- offset(2) should fail