Move fixed size types into ffi, Fix test cases (#243)

Author: qwreey

crates/lune-std-ffi/README.md

@@ -1,5 +1,9 @@
 # `lune-std-ffi`
 
+## Tests
+
+See [tests/ffi](../../tests/ffi/README.md)
+
 ## Code structure
 
 ### /c
@@ -83,16 +87,19 @@ Implememt type-casting for all CTypes
 
 ## TODO
 
-Add `CTypeInfo:add(target, from1, from2, ...)` and `:sub` `:mul` `:div` `:mod` `:pow` for math operation.
+- CString
+
+- Add buffer for owned data support
 
-> Luau cannot handle i64 or i128
+- Add math operation.
 
-Add bor band and such bit-related operation
+  > `CTypeInfo:add(target, from1, from2, ...)` and `:sub` `:mul` `:div` `:mod` `:pow`  
+  > Luau cannot handle f64, i64 or i128, so we should provide math operation for it
 
-> Luau only supports 32bit bit operations
+- Add bit operation
 
-wchar and wstring support
+  > Luau only supports 32bit bit operations
 
-string(null ending) / buffer support
+- Add wchar and wstring support
 
-void support
+  > For windows API

crates/lune-std-ffi/src/c/arr_info.rs

@@ -140,15 +140,17 @@ impl FfiConvert for CArrInfo {
         dst: &Ref<dyn FfiData>,
         src: &Ref<dyn FfiData>,
     ) -> LuaResult<()> {
-        dst.get_inner_pointer()
-            .byte_offset(dst_offset)
-            .copy_from(src.get_inner_pointer().byte_offset(src_offset), self.get_size());
+        dst.get_inner_pointer().byte_offset(dst_offset).copy_from(
+            src.get_inner_pointer().byte_offset(src_offset),
+            self.get_size(),
+        );
         Ok(())
     }
 }
 
 impl LuaUserData for CArrInfo {
     fn add_fields<'lua, F: LuaUserDataFields<'lua, Self>>(fields: &mut F) {
+        fields.add_meta_field(LuaMetaMethod::Type, "CArr");
         fields.add_field_method_get("size", |_, this| Ok(this.get_size()));
         fields.add_field_method_get("length", |_, this| Ok(this.get_length()));
         fields.add_field_function_get("inner", |lua, this: LuaAnyUserData| {

crates/lune-std-ffi/src/c/fn_info.rs

@@ -1,5 +1,3 @@
-use std::ptr;
-
 use libffi::middle::{Cif, Type};
 use mlua::prelude::*;
 
@@ -155,19 +153,18 @@ impl CFnInfo {
         this: &LuaAnyUserData,
         lua_function: LuaFunction<'lua>,
     ) -> LuaResult<LuaAnyUserData<'lua>> {
-        let closure = ClosureData::new(
-            ptr::from_ref(lua),
+        let closure_data = ClosureData::alloc(
+            lua,
             self.cif.as_raw_ptr(),
             self.arg_info_list.clone(),
             self.result_info.clone(),
             lua.create_registry_value(&lua_function)?,
         )?;
-        let closure_userdata = lua.create_userdata(closure)?;
 
-        association::set(lua, CLOSURE_CFN, &closure_userdata, this)?;
-        association::set(lua, CLOSURE_FUNC, &closure_userdata, lua_function)?;
+        association::set(lua, CLOSURE_CFN, &closure_data, this)?;
+        association::set(lua, CLOSURE_FUNC, &closure_data, lua_function)?;
 
-        Ok(closure_userdata)
+        Ok(closure_data)
     }
 
     pub fn create_callable<'lua>(
@@ -206,6 +203,9 @@ impl CFnInfo {
 }
 
 impl LuaUserData for CFnInfo {
+    fn add_fields<'lua, F: LuaUserDataFields<'lua, Self>>(fields: &mut F) {
+        fields.add_meta_field(LuaMetaMethod::Type, "CFn");
+    }
     fn add_methods<'lua, M: LuaUserDataMethods<'lua, Self>>(methods: &mut M) {
         // Subtype
         method_provider::provide_ptr(methods);

crates/lune-std-ffi/src/c/helper.rs

@@ -302,6 +302,8 @@ pub fn stringify(lua: &Lua, userdata: &LuaAnyUserData) -> LuaResult<String> {
         CPtrInfo::stringify(lua, userdata)
     } else if userdata.is::<CFnInfo>() {
         CFnInfo::stringify(lua, userdata)
+    } else if userdata.is::<CVoidInfo>() {
+        CVoidInfo::stringify()
     } else if let Some(name) = ctype_helper::get_name(userdata)? {
         Ok(String::from(name))
     } else {

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

@@ -17,7 +17,7 @@ pub use self::{
     ptr_info::CPtrInfo,
     struct_info::CStructInfo,
     type_info::{CTypeCast, CTypeInfo},
-    types::{ctype_helper, export_ctypes},
+    types::{ctype_helper, export_c_types, export_fixed_types},
     void_info::CVoidInfo,
 };
 
@@ -34,10 +34,10 @@ mod association_names {
     pub const CLOSURE_CFN: &str = "__closure_cfn";
 }
 
-pub fn export(lua: &Lua) -> LuaResult<LuaTable> {
+pub fn export_c(lua: &Lua) -> LuaResult<LuaTable> {
     TableBuilder::new(lua)?
         .with_value("void", CVoidInfo::new())?
-        .with_values(export_ctypes(lua)?)?
+        .with_values(export_c_types(lua)?)?
         .with_function("struct", |lua, types: LuaTable| {
             CStructInfo::from_table(lua, types)
         })?

crates/lune-std-ffi/src/c/ptr_info.rs

@@ -124,6 +124,7 @@ impl CPtrInfo {
 
 impl LuaUserData for CPtrInfo {
     fn add_fields<'lua, F: LuaUserDataFields<'lua, Self>>(fields: &mut F) {
+        fields.add_meta_field(LuaMetaMethod::Type, "CPtr");
         fields.add_field_method_get("size", |_, _| Ok(size_of::<usize>()));
         fields.add_field_function_get("inner", |lua, this| {
             let inner = association::get(lua, CPTR_INNER, this)?

crates/lune-std-ffi/src/c/struct_info.rs

@@ -182,6 +182,7 @@ impl FfiConvert for CStructInfo {
 
 impl LuaUserData for CStructInfo {
     fn add_fields<'lua, F: LuaUserDataFields<'lua, Self>>(fields: &mut F) {
+        fields.add_meta_field(LuaMetaMethod::Type, "CStruct");
         fields.add_field_method_get("size", |_, this| Ok(this.get_size()));
     }
     fn add_methods<'lua, M: LuaUserDataMethods<'lua, Self>>(methods: &mut M) {

crates/lune-std-ffi/src/c/type_info.rs

@@ -91,6 +91,7 @@ where
     Self: CTypeCast + FfiSignedness + FfiConvert + FfiSize,
 {
     fn add_fields<'lua, F: LuaUserDataFields<'lua, Self>>(fields: &mut F) {
+        fields.add_meta_field(LuaMetaMethod::Type, "CType");
         fields.add_field_method_get("size", |_, this| Ok(this.get_size()));
         fields.add_meta_field(LuaMetaMethod::Type, "CType");
         fields.add_field_method_get("signedness", |_, this| Ok(this.get_signedness()));

crates/lune-std-ffi/src/c/types/mod.rs

@@ -34,7 +34,7 @@ macro_rules! create_ctypes {
         ),)*])
     };
 }
-pub fn export_ctypes(lua: &Lua) -> LuaResult<Vec<(&'static str, LuaAnyUserData)>> {
+pub fn export_c_types(lua: &Lua) -> LuaResult<Vec<(&'static str, LuaAnyUserData)>> {
     create_ctypes!(
         lua,
         // Export Compile-time known c-types
@@ -55,6 +55,11 @@ pub fn export_ctypes(lua: &Lua) -> LuaResult<Vec<(&'static str, LuaAnyUserData)>
         ("ulong", c_ulong, Type::c_ulong()),
         ("longlong", c_longlong, Type::c_longlong()),
         ("ulonglong", c_ulonglong, Type::c_ulonglong()),
+    )
+}
+pub fn export_fixed_types(lua: &Lua) -> LuaResult<Vec<(&'static str, LuaAnyUserData)>> {
+    create_ctypes!(
+        lua,
         // Export Source-time known c-types (fixed)
         ("u8", u8, Type::u8()),
         ("u16", u16, Type::u16()),
@@ -70,10 +75,8 @@ pub fn export_ctypes(lua: &Lua) -> LuaResult<Vec<(&'static str, LuaAnyUserData)>
         ("f32", f32, Type::f32()),
         ("usize", usize, Type::usize()),
         ("isize", isize, Type::isize()),
-        // TODO: c_float and c_double sometime can be half and single,
-        // TODO: but libffi-rs doesn't support it. need work-around or drop support
-        ("float", f32, Type::f32()),
-        ("double", f64, Type::f64()),
+        ("f32", f32, Type::f32()),
+        ("f64", f64, Type::f64()),
     )
 }
 

crates/lune-std-ffi/src/c/void_info.rs

@@ -17,13 +17,25 @@ impl FfiSize for CVoidInfo {
         0
     }
 }
+
 impl CVoidInfo {
     pub fn new() -> Self {
         Self()
     }
     pub fn get_middle_type() -> Type {
         Type::void()
     }
+    pub fn stringify() -> LuaResult<String> {
+        Ok(String::from("CVoid"))
+    }
 }
 
-impl LuaUserData for CVoidInfo {}
+impl LuaUserData for CVoidInfo {
+    fn add_fields<'lua, F: LuaUserDataFields<'lua, Self>>(fields: &mut F) {
+        fields.add_meta_field(LuaMetaMethod::Type, "CVoid");
+    }
+    fn add_methods<'lua, M: LuaUserDataMethods<'lua, Self>>(methods: &mut M) {
+        method_provider::provide_to_string(methods);
+        method_provider::provide_ptr(methods);
+    }
+}