Merge pull request #40 from TheBlueMatt/main

[ldk-c-bindings] / c-bindings-gen / src / types.rs

diff --git a/c-bindings-gen/src/types.rs b/c-bindings-gen/src/types.rs
index 26a0885588f4c5e77fc00bc38cf941773c0791f7..d17148fe25d1378d2ecec2d9c1f2a4f10394f8e5 100644 (file)
--- a/c-bindings-gen/src/types.rs
+++ b/c-bindings-gen/src/types.rs
@@ -176,7 +176,7 @@ pub struct GenericTypes<'a, 'b> {
        self_ty: Option<(String, &'a syn::Path)>,
        parent: Option<&'b GenericTypes<'b, 'b>>,
        typed_generics: HashMap<&'a syn::Ident, (String, Option<&'a syn::Path>)>,
-       default_generics: HashMap<&'a syn::Ident, (&'a syn::Type, syn::Type)>,
+       default_generics: HashMap<&'a syn::Ident, (syn::Type, syn::Type)>,
 }
 impl<'a, 'p: 'a> GenericTypes<'a, 'p> {
        pub fn new(self_ty: Option<(String, &'a syn::Path)>) -> Self {
@@ -197,7 +197,7 @@ impl<'a, 'p: 'a> GenericTypes<'a, 'p> {
                        match generic {
                                syn::GenericParam::Type(type_param) => {
                                        let mut non_lifetimes_processed = false;
-                                       for bound in type_param.bounds.iter() {
+                                       'bound_loop: for bound in type_param.bounds.iter() {
                                                if let syn::TypeParamBound::Trait(trait_bound) = bound {
                                                        if let Some(ident) = single_ident_generic_path_to_ident(&trait_bound.path) {
                                                                match &format!("{}", ident) as &str { "Send" => continue, "Sync" => continue, _ => {} }
@@ -213,6 +213,26 @@ impl<'a, 'p: 'a> GenericTypes<'a, 'p> {
                                                                let new_ident = if path != "std::ops::Deref" && path != "core::ops::Deref" {
                                                                        path = "crate::".to_string() + &path;
                                                                        Some(&trait_bound.path)
+                                                               } else if trait_bound.path.segments.len() == 1 {
+                                                                       // If we're templated on Deref<Target = ConcreteThing>, store
+                                                                       // the reference type in `default_generics` which handles full
+                                                                       // types and not just paths.
+                                                                       if let syn::PathArguments::AngleBracketed(ref args) =
+                                                                                       trait_bound.path.segments[0].arguments {
+                                                                               for subargument in args.args.iter() {
+                                                                                       match subargument {
+                                                                                               syn::GenericArgument::Lifetime(_) => {},
+                                                                                               syn::GenericArgument::Binding(ref b) => {
+                                                                                                       if &format!("{}", b.ident) != "Target" { return false; }
+                                                                                                       let default = &b.ty;
+                                                                                                       self.default_generics.insert(&type_param.ident, (parse_quote!(&#default), parse_quote!(&#default)));
+                                                                                                       break 'bound_loop;
+                                                                                               },
+                                                                                               _ => unimplemented!(),
+                                                                                       }
+                                                                               }
+                                                                               None
+                                                                       } else { None }
                                                                } else { None };
                                                                self.typed_generics.insert(&type_param.ident, (path, new_ident));
                                                        } else { return false; }
@@ -220,7 +240,7 @@ impl<'a, 'p: 'a> GenericTypes<'a, 'p> {
                                        }
                                        if let Some(default) = type_param.default.as_ref() {
                                                assert!(type_param.bounds.is_empty());
-                                               self.default_generics.insert(&type_param.ident, (default, parse_quote!(&#default)));
+                                               self.default_generics.insert(&type_param.ident, (default.clone(), parse_quote!(&#default)));
                                        }
                                },
                                _ => {},
@@ -703,6 +723,14 @@ impl FullLibraryAST {
 fn initial_clonable_types() -> HashSet<String> {
        let mut res = HashSet::new();
        res.insert("crate::c_types::u5".to_owned());
+       res.insert("crate::c_types::ThirtyTwoBytes".to_owned());
+       res.insert("crate::c_types::PublicKey".to_owned());
+       res.insert("crate::c_types::Transaction".to_owned());
+       res.insert("crate::c_types::TxOut".to_owned());
+       res.insert("crate::c_types::Signature".to_owned());
+       res.insert("crate::c_types::RecoverableSignature".to_owned());
+       res.insert("crate::c_types::Secp256k1Error".to_owned());
+       res.insert("crate::c_types::IOError".to_owned());
        res
 }
 
@@ -830,9 +858,6 @@ impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
                if self.is_primitive(ty) { return true; }
                match ty {
                        "()" => true,
-                       "crate::c_types::Signature" => true,
-                       "crate::c_types::RecoverableSignature" => true,
-                       "crate::c_types::TxOut" => true,
                        _ => false,
                }
        }
@@ -865,6 +890,7 @@ impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
                        "std::io::Error" => Some("crate::c_types::IOError"),
 
                        "bech32::u5" => Some("crate::c_types::u5"),
+                       "core::num::NonZeroU8" => Some("u8"),
 
                        "bitcoin::secp256k1::key::PublicKey"|"bitcoin::secp256k1::PublicKey"|"secp256k1::key::PublicKey"
                                => Some("crate::c_types::PublicKey"),
@@ -885,6 +911,11 @@ impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
                        "bitcoin::blockdata::block::BlockHeader" if is_ref  => Some("*const [u8; 80]"),
                        "bitcoin::blockdata::block::Block" if is_ref  => Some("crate::c_types::u8slice"),
 
+                       "bitcoin::hash_types::PubkeyHash"|"bitcoin::hash_types::WPubkeyHash"|"bitcoin::hash_types::ScriptHash"
+                               if is_ref => Some("*const [u8; 20]"),
+                       "bitcoin::hash_types::WScriptHash"
+                               if is_ref => Some("*const [u8; 32]"),
+
                        // Newtypes that we just expose in their original form.
                        "bitcoin::hash_types::Txid"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"
                                if is_ref  => Some("*const [u8; 32]"),
@@ -930,6 +961,7 @@ impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
 
                        "str" if is_ref => Some(""),
                        "alloc::string::String"|"String" => Some(""),
+                       "std::io::Error" if !is_ref => Some(""),
                        // Note that we'll panic for String if is_ref, as we only have non-owned memory, we
                        // cannot create a &String.
 
@@ -937,6 +969,7 @@ impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
                        "std::time::SystemTime" => Some("(::std::time::SystemTime::UNIX_EPOCH + std::time::Duration::from_secs("),
 
                        "bech32::u5" => Some(""),
+                       "core::num::NonZeroU8" => Some("core::num::NonZeroU8::new("),
 
                        "bitcoin::secp256k1::key::PublicKey"|"bitcoin::secp256k1::PublicKey"|"secp256k1::key::PublicKey"
                                if is_ref => Some("&"),
@@ -958,6 +991,15 @@ impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
                        "bitcoin::blockdata::block::BlockHeader" => Some("&::bitcoin::consensus::encode::deserialize(unsafe { &*"),
                        "bitcoin::blockdata::block::Block" if is_ref => Some("&::bitcoin::consensus::encode::deserialize("),
 
+                       "bitcoin::hash_types::PubkeyHash" if is_ref =>
+                               Some("&bitcoin::hash_types::PubkeyHash::from_hash(bitcoin::hashes::Hash::from_inner(unsafe { *"),
+                       "bitcoin::hash_types::WPubkeyHash" if is_ref =>
+                               Some("&bitcoin::hash_types::WPubkeyHash::from_hash(bitcoin::hashes::Hash::from_inner(unsafe { *"),
+                       "bitcoin::hash_types::ScriptHash" if is_ref =>
+                               Some("&bitcoin::hash_types::ScriptHash::from_hash(bitcoin::hashes::Hash::from_inner(unsafe { *"),
+                       "bitcoin::hash_types::WScriptHash" if is_ref =>
+                               Some("&bitcoin::hash_types::WScriptHash::from_hash(bitcoin::hashes::Hash::from_inner(unsafe { *"),
+
                        // Newtypes that we just expose in their original form.
                        "bitcoin::hash_types::Txid" if is_ref => Some("&::bitcoin::hash_types::Txid::from_slice(&unsafe { &*"),
                        "bitcoin::hash_types::Txid" if !is_ref => Some("::bitcoin::hash_types::Txid::from_slice(&"),
@@ -996,11 +1038,13 @@ impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
 
                        "str" if is_ref => Some(".into_str()"),
                        "alloc::string::String"|"String" => Some(".into_string()"),
+                       "std::io::Error" if !is_ref => Some(".to_rust()"),
 
                        "std::time::Duration"|"core::time::Duration" => Some(")"),
                        "std::time::SystemTime" => Some("))"),
 
                        "bech32::u5" => Some(".into()"),
+                       "core::num::NonZeroU8" => Some(").expect(\"Value must be non-zero\")"),
 
                        "bitcoin::secp256k1::key::PublicKey"|"bitcoin::secp256k1::PublicKey"|"secp256k1::key::PublicKey"
                                => Some(".into_rust()"),
@@ -1018,6 +1062,10 @@ impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
                        "bitcoin::blockdata::block::BlockHeader" => Some(" }).unwrap()"),
                        "bitcoin::blockdata::block::Block" => Some(".to_slice()).unwrap()"),
 
+                       "bitcoin::hash_types::PubkeyHash"|"bitcoin::hash_types::WPubkeyHash"|
+                       "bitcoin::hash_types::ScriptHash"|"bitcoin::hash_types::WScriptHash"
+                               if is_ref => Some(" }.clone()))"),
+
                        // Newtypes that we just expose in their original form.
                        "bitcoin::hash_types::Txid" if is_ref => Some(" }[..]).unwrap()"),
                        "bitcoin::hash_types::Txid" => Some(".data[..]).unwrap()"),
@@ -1236,7 +1284,7 @@ impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
        }
        /// Returns true if the path is a "transparent" container, ie an Option or a container which does
        /// not require a generated continer class.
-       fn is_path_transparent_container(&self, full_path: &syn::Path, generics: Option<&GenericTypes>, is_ref: bool) -> bool {
+       pub fn is_path_transparent_container(&self, full_path: &syn::Path, generics: Option<&GenericTypes>, is_ref: bool) -> bool {
                let inner_iter = match &full_path.segments.last().unwrap().arguments {
                        syn::PathArguments::None => return false,
                        syn::PathArguments::AngleBracketed(args) => args.args.iter().map(|arg| {
@@ -1263,16 +1311,15 @@ impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
                                                        (").into(), Err(mut e) => crate::c_types::CResultTempl::err(".to_string(), "e".to_string())],
                                                ").into() }", ContainerPrefixLocation::PerConv))
                        },
-                       "Vec" if !is_ref => {
-                               Some(("Vec::new(); for mut item in ", vec![(format!(".drain(..) {{ local_{}.push(", var_name), "item".to_string())], "); }", ContainerPrefixLocation::PerConv))
-                       },
                        "Vec" => {
-                               // We should only get here if the single contained has an inner
-                               assert!(self.c_type_has_inner(single_contained.unwrap()));
-                               Some(("Vec::new(); for mut item in ", vec![(format!(".drain(..) {{ local_{}.push(", var_name), "*item".to_string())], "); }", ContainerPrefixLocation::PerConv))
+                               if is_ref {
+                                       // We should only get here if the single contained has an inner
+                                       assert!(self.c_type_has_inner(single_contained.unwrap()));
+                               }
+                               Some(("Vec::new(); for mut item in ", vec![(format!(".drain(..) {{ local_{}.push(", var_name), "item".to_string())], "); }", ContainerPrefixLocation::PerConv))
                        },
                        "Slice" => {
-                               Some(("Vec::new(); for item in ", vec![(format!(".iter() {{ local_{}.push(", var_name), "*item".to_string())], "); }", ContainerPrefixLocation::PerConv))
+                               Some(("Vec::new(); for item in ", vec![(format!(".iter() {{ local_{}.push(", var_name), "item".to_string())], "); }", ContainerPrefixLocation::PerConv))
                        },
                        "Option" => {
                                let contained_struct = if let Some(syn::Type::Path(p)) = single_contained {
@@ -1292,9 +1339,9 @@ impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
                                                let is_inner_ref = if let Some(syn::Type::Reference(_)) = single_contained { true } else { false };
                                                if is_ref {
                                                        return Some(("if ", vec![
-                                                               (".is_none() { std::ptr::null() } else { ".to_owned(),
+                                                               (".is_none() { std::ptr::null() } else { ObjOps::nonnull_ptr_to_inner(".to_owned(),
                                                                        format!("({}{}.unwrap())", var_access, if is_inner_ref { "" } else { ".as_ref()" }))
-                                                               ], " }", ContainerPrefixLocation::OutsideConv));
+                                                               ], ") }", ContainerPrefixLocation::OutsideConv));
                                                } else {
                                                        return Some(("if ", vec![
                                                                (".is_none() { std::ptr::null_mut() } else { ".to_owned(), format!("({}.unwrap())", var_access))
@@ -1819,14 +1866,14 @@ impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
                                                DeclType::MirroredEnum => write!(w, "crate::{}::native_into(", decl_path).unwrap(),
                                                DeclType::EnumIgnored|DeclType::StructImported if is_ref && ptr_for_ref && from_ptr =>
                                                        write!(w, "crate::{} {{ inner: unsafe {{ (", decl_path).unwrap(),
-                                               DeclType::EnumIgnored|DeclType::StructImported if is_ref && ptr_for_ref =>
-                                                       write!(w, "crate::{} {{ inner: unsafe {{ ( (&(*", decl_path).unwrap(),
-                                               DeclType::EnumIgnored|DeclType::StructImported if is_ref =>
-                                                       write!(w, "&crate::{} {{ inner: unsafe {{ (", decl_path).unwrap(),
+                                               DeclType::EnumIgnored|DeclType::StructImported if is_ref => {
+                                                       if !ptr_for_ref { write!(w, "&").unwrap(); }
+                                                       write!(w, "crate::{} {{ inner: unsafe {{ ObjOps::nonnull_ptr_to_inner((", decl_path).unwrap()
+                                               },
                                                DeclType::EnumIgnored|DeclType::StructImported if !is_ref && from_ptr =>
                                                        write!(w, "crate::{} {{ inner: ", decl_path).unwrap(),
                                                DeclType::EnumIgnored|DeclType::StructImported if !is_ref =>
-                                                       write!(w, "crate::{} {{ inner: Box::into_raw(Box::new(", decl_path).unwrap(),
+                                                       write!(w, "crate::{} {{ inner: ObjOps::heap_alloc(", decl_path).unwrap(),
                                                DeclType::Trait(_) if is_ref => write!(w, "").unwrap(),
                                                DeclType::Trait(_) if !is_ref => {},
                                                _ => panic!("{:?}", decl_path),
@@ -1843,13 +1890,11 @@ impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
                                        DeclType::MirroredEnum => write!(w, ")").unwrap(),
                                        DeclType::EnumIgnored|DeclType::StructImported if is_ref && ptr_for_ref && from_ptr =>
                                                write!(w, " as *const _) as *mut _ }}, is_owned: false }}").unwrap(),
-                                       DeclType::EnumIgnored|DeclType::StructImported if is_ref && ptr_for_ref =>
-                                               write!(w, ") as *const _) as *mut _) }}, is_owned: false }}").unwrap(),
                                        DeclType::EnumIgnored|DeclType::StructImported if is_ref =>
-                                               write!(w, " as *const _) as *mut _ }}, is_owned: false }}").unwrap(),
+                                               write!(w, " as *const _) as *mut _) }}, is_owned: false }}").unwrap(),
                                        DeclType::EnumIgnored|DeclType::StructImported if !is_ref && from_ptr =>
                                                write!(w, ", is_owned: true }}").unwrap(),
-                                       DeclType::EnumIgnored|DeclType::StructImported if !is_ref => write!(w, ")), is_owned: true }}").unwrap(),
+                                       DeclType::EnumIgnored|DeclType::StructImported if !is_ref => write!(w, "), is_owned: true }}").unwrap(),
                                        DeclType::Trait(_) if is_ref => {},
                                        DeclType::Trait(_) => {
                                                // This is used when we're converting a concrete Rust type into a C trait
@@ -1865,13 +1910,11 @@ impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
                self.write_to_c_conversion_inline_suffix_inner(w, t, generics, false, ptr_for_ref, false);
        }
 
-       fn write_from_c_conversion_prefix_inner<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>, is_ref: bool, ptr_for_ref: bool) {
+       fn write_from_c_conversion_prefix_inner<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>, is_ref: bool, _ptr_for_ref: bool) {
                self.write_conversion_inline_intern(w, t, generics, is_ref, false, false, "() /*", true, |_, _| "&local_".to_owned(),
                                |a, b, _c| self.from_c_conversion_prefix_from_path(a, b),
-                               |w, decl_type, _full_path, is_ref, is_mut| match decl_type {
-                                       DeclType::StructImported if is_ref && ptr_for_ref => write!(w, "unsafe {{ &*(*").unwrap(),
-                                       DeclType::StructImported if is_mut && is_ref => write!(w, "unsafe {{ &mut *").unwrap(),
-                                       DeclType::StructImported if is_ref => write!(w, "unsafe {{ &*").unwrap(),
+                               |w, decl_type, _full_path, is_ref, _is_mut| match decl_type {
+                                       DeclType::StructImported if is_ref => write!(w, "").unwrap(),
                                        DeclType::StructImported if !is_ref => write!(w, "*unsafe {{ Box::from_raw(").unwrap(),
                                        DeclType::MirroredEnum if is_ref => write!(w, "&").unwrap(),
                                        DeclType::MirroredEnum => {},
@@ -1891,9 +1934,10 @@ impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
                                        (true, Some(_)) => unreachable!(),
                                },
                                |a, b, _c| self.from_c_conversion_suffix_from_path(a, b),
-                               |w, decl_type, _full_path, is_ref, _is_mut| match decl_type {
-                                       DeclType::StructImported if is_ref && ptr_for_ref => write!(w, ").inner }}").unwrap(),
-                                       DeclType::StructImported if is_ref => write!(w, ".inner }}").unwrap(),
+                               |w, decl_type, _full_path, is_ref, is_mut| match decl_type {
+                                       DeclType::StructImported if is_ref && ptr_for_ref => write!(w, "XXX unimplemented").unwrap(),
+                                       DeclType::StructImported if is_mut && is_ref => write!(w, ".get_native_mut_ref()").unwrap(),
+                                       DeclType::StructImported if is_ref => write!(w, ".get_native_ref()").unwrap(),
                                        DeclType::StructImported if !is_ref => write!(w, ".take_inner()) }}").unwrap(),
                                        DeclType::MirroredEnum if is_ref => write!(w, ".to_native()").unwrap(),
                                        DeclType::MirroredEnum => write!(w, ".into_native()").unwrap(),
@@ -1914,7 +1958,7 @@ impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
                                        } else { None }
                                },
                                |w, decl_type, _full_path, is_ref, _is_mut| match decl_type {
-                                       DeclType::StructImported if !is_ref => write!(w, "unsafe {{ &*").unwrap(),
+                                       DeclType::StructImported if !is_ref => write!(w, "").unwrap(),
                                        _ => unimplemented!(),
                                });
        }
@@ -1928,7 +1972,7 @@ impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
                                },
                                |a, b, _c| self.from_c_conversion_suffix_from_path(a, b),
                                |w, decl_type, _full_path, is_ref, _is_mut| match decl_type {
-                                       DeclType::StructImported if !is_ref => write!(w, ".inner }}").unwrap(),
+                                       DeclType::StructImported if !is_ref => write!(w, ".get_native_ref()").unwrap(),
                                        _ => unimplemented!(),
                                });
        }
@@ -2017,14 +2061,14 @@ impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
                                                if prefix_location == ContainerPrefixLocation::PerConv {
                                                        var_prefix(w, conv_ty, generics, is_ref && ty_has_inner, ptr_for_ref, false);
                                                } else if !is_ref && !needs_ref_map && to_c && only_contained_has_inner {
-                                                       write!(w, "Box::into_raw(Box::new(").unwrap();
+                                                       write!(w, "ObjOps::heap_alloc(").unwrap();
                                                }
 
                                                write!(w, "{}{}", if contains_slice { "local_" } else { "" }, if new_var { new_var_name } else { var_access }).unwrap();
                                                if prefix_location == ContainerPrefixLocation::PerConv {
                                                        var_suffix(w, conv_ty, generics, is_ref && ty_has_inner, ptr_for_ref, false);
                                                } else if !is_ref && !needs_ref_map && to_c && only_contained_has_inner {
-                                                       write!(w, "))").unwrap();
+                                                       write!(w, ")").unwrap();
                                                }
                                                write!(w, " }}").unwrap();
                                        }