[bindings] Use == null() instead of is_null() to avoid ambiguity
[rust-lightning] / c-bindings-gen / src / types.rs
index 642a23ae41c47140660a63b231124235ce48cde9..1fe427d54f51c1bfe11ac729bd32ffd0a90e327d 100644 (file)
@@ -177,7 +177,7 @@ impl<'a> GenericTypes<'a> {
                                                                        if non_lifetimes_processed { return false; }
                                                                        non_lifetimes_processed = true;
                                                                        assert_simple_bound(&trait_bound);
-                                                                       *gen = ("crate::".to_string() + &types.resolve_path(&trait_bound.path),
+                                                                       *gen = ("crate::".to_string() + &types.resolve_path(&trait_bound.path, None),
                                                                                Some(&trait_bound.path));
                                                                }
                                                        }
@@ -653,6 +653,8 @@ impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
        fn empty_val_check_suffix_from_path(&self, full_path: &str) -> Option<&str> {
                match full_path {
                        "ln::channelmanager::PaymentSecret" => Some(".data == [0; 32]"),
+                       "bitcoin::secp256k1::key::PublicKey" => Some(".is_null()"),
+                       "bitcoin::secp256k1::Signature" => Some(".is_null()"),
                        _ => None
                }
        }
@@ -681,7 +683,7 @@ impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
        fn is_known_container(&self, full_path: &str, is_ref: bool) -> bool {
                (full_path == "Result" && !is_ref) || (full_path == "Vec" && !is_ref) || full_path.ends_with("Tuple")
        }
-       fn to_c_conversion_container_new_var<'b>(&self, full_path: &str, is_ref: bool, single_contained: Option<&syn::Type>, var_name: &syn::Ident, var_access: &str)
+       fn to_c_conversion_container_new_var<'b>(&self, generics: Option<&GenericTypes>, full_path: &str, is_ref: bool, single_contained: Option<&syn::Type>, var_name: &syn::Ident, var_access: &str)
                        // Returns prefix + Vec<(prefix, var-name-to-inline-convert)> + suffix
                        // expecting one element in the vec per generic type, each of which is inline-converted
                        -> Option<(&'b str, Vec<(String, String)>, &'b str)> {
@@ -700,7 +702,7 @@ impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
                        },
                        "Option" => {
                                if let Some(syn::Type::Path(p)) = single_contained {
-                                       if self.c_type_has_inner_from_path(&self.resolve_path(&p.path)) {
+                                       if self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics)) {
                                                if is_ref {
                                                        return Some(("if ", vec![
                                                                (".is_none() { std::ptr::null() } else { ".to_owned(), format!("({}.as_ref().unwrap())", var_access))
@@ -714,7 +716,7 @@ impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
                                }
                                if let Some(t) = single_contained {
                                        let mut v = Vec::new();
-                                       self.write_empty_rust_val(&mut v, t);
+                                       self.write_empty_rust_val(generics, &mut v, t);
                                        let s = String::from_utf8(v).unwrap();
                                        return Some(("if ", vec![
                                                (format!(".is_none() {{ {} }} else {{ ", s), format!("({}.unwrap())", var_access))
@@ -727,7 +729,7 @@ impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
 
        /// only_contained_has_inner implies that there is only one contained element in the container
        /// and it has an inner field (ie is an "opaque" type we've defined).
-       fn from_c_conversion_container_new_var<'b>(&self, full_path: &str, is_ref: bool, single_contained: Option<&syn::Type>, var_name: &syn::Ident, var_access: &str)
+       fn from_c_conversion_container_new_var<'b>(&self, generics: Option<&GenericTypes>, full_path: &str, is_ref: bool, single_contained: Option<&syn::Type>, var_name: &syn::Ident, var_access: &str)
                        // Returns prefix + Vec<(prefix, var-name-to-inline-convert)> + suffix
                        // expecting one element in the vec per generic type, each of which is inline-converted
                        -> Option<(&'b str, Vec<(String, String)>, &'b str)> {
@@ -746,7 +748,7 @@ impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
                        },
                        "Option" => {
                                if let Some(syn::Type::Path(p)) = single_contained {
-                                       if self.c_type_has_inner_from_path(&self.resolve_path(&p.path)) {
+                                       if self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics)) {
                                                if is_ref {
                                                        return Some(("if ", vec![(".inner.is_null() { None } else { Some((*".to_string(), format!("{}", var_name))], ").clone()) }"))
                                                } else {
@@ -757,7 +759,7 @@ impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
 
                                if let Some(t) = single_contained {
                                        let mut v = Vec::new();
-                                       let needs_deref = self.write_empty_rust_val_check_suffix(&mut v, t);
+                                       let needs_deref = self.write_empty_rust_val_check_suffix(generics, &mut v, t);
                                        let s = String::from_utf8(v).unwrap();
                                        if needs_deref {
                                                return Some(("if ", vec![
@@ -903,8 +905,8 @@ impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
                        } else { None }
                }
        }
-       pub fn resolve_path(&self, p: &syn::Path) -> String {
-               self.maybe_resolve_path(p, None).unwrap()
+       pub fn resolve_path(&self, p: &syn::Path, generics: Option<&GenericTypes>) -> String {
+               self.maybe_resolve_path(p, generics).unwrap()
        }
 
        // ***********************************
@@ -1023,10 +1025,10 @@ impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
 
        /// Prints a constructor for something which is "uninitialized" (but obviously not actually
        /// unint'd memory).
-       pub fn write_empty_rust_val<W: std::io::Write>(&self, w: &mut W, t: &syn::Type) {
+       pub fn write_empty_rust_val<W: std::io::Write>(&self, generics: Option<&GenericTypes>, w: &mut W, t: &syn::Type) {
                match t {
                        syn::Type::Path(p) => {
-                               let resolved = self.resolve_path(&p.path);
+                               let resolved = self.resolve_path(&p.path, generics);
                                if self.crate_types.opaques.get(&resolved).is_some() {
                                        write!(w, "crate::{} {{ inner: std::ptr::null_mut(), is_owned: true }}", resolved).unwrap();
                                } else {
@@ -1056,10 +1058,10 @@ impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
        /// Prints a suffix to determine if a variable is empty (ie was set by write_empty_rust_val),
        /// returning whether we need to dereference the inner value before using it (ie it is a
        /// pointer).
-       pub fn write_empty_rust_val_check_suffix<W: std::io::Write>(&self, w: &mut W, t: &syn::Type) -> bool {
+       pub fn write_empty_rust_val_check_suffix<W: std::io::Write>(&self, generics: Option<&GenericTypes>, w: &mut W, t: &syn::Type) -> bool {
                match t {
                        syn::Type::Path(p) => {
-                               let resolved = self.resolve_path(&p.path);
+                               let resolved = self.resolve_path(&p.path, generics);
                                if self.crate_types.opaques.get(&resolved).is_some() {
                                        write!(w, ".inner.is_null()").unwrap();
                                        false
@@ -1068,7 +1070,7 @@ impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
                                                write!(w, "{}", suffix).unwrap();
                                                false // We may eventually need to allow empty_val_check_suffix_from_path to specify if we need a deref or not
                                        } else {
-                                               write!(w, ".is_null()").unwrap();
+                                               write!(w, " == std::ptr::null_mut()").unwrap();
                                                false
                                        }
                                }
@@ -1084,7 +1086,7 @@ impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
                        syn::Type::Slice(_) => {
                                // Option<[]> always implies that we want to treat len() == 0 differently from
                                // None, so we always map an Option<[]> into a pointer.
-                               write!(w, ".is_null()").unwrap();
+                               write!(w, " == std::ptr::null_mut()").unwrap();
                                true
                        },
                        _ => unimplemented!(),
@@ -1092,11 +1094,11 @@ impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
        }
 
        /// Prints a suffix to determine if a variable is empty (ie was set by write_empty_rust_val).
-       pub fn write_empty_rust_val_check<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, var_access: &str) {
+       pub fn write_empty_rust_val_check<W: std::io::Write>(&self, generics: Option<&GenericTypes>, w: &mut W, t: &syn::Type, var_access: &str) {
                match t {
                        syn::Type::Path(_) => {
                                write!(w, "{}", var_access).unwrap();
-                               self.write_empty_rust_val_check_suffix(w, t);
+                               self.write_empty_rust_val_check_suffix(generics, w, t);
                        },
                        syn::Type::Array(a) => {
                                if let syn::Expr::Lit(l) = &a.len {
@@ -1108,7 +1110,7 @@ impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
                                                        self.from_c_conversion_prefix_from_path(&arrty, false).unwrap(),
                                                        var_access,
                                                        self.from_c_conversion_suffix_from_path(&arrty, false).unwrap()).unwrap();
-                                               self.write_empty_rust_val_check_suffix(w, t);
+                                               self.write_empty_rust_val_check_suffix(generics, w, t);
                                        } else { unimplemented!(); }
                                } else { unimplemented!(); }
                        }
@@ -1164,30 +1166,7 @@ impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
                                        unimplemented!();
                                }
 
-                               if let Some(gen_types) = generics {
-                                       if let Some((_, synpath)) = gen_types.maybe_resolve_path(&p.path) {
-                                               let genpath = self.resolve_path(&synpath);
-                                               assert!(!self.is_known_container(&genpath, is_ref) && !self.is_transparent_container(&genpath, is_ref));
-                                               if let Some(c_type) = path_lookup(&genpath, is_ref, ptr_for_ref) {
-                                                       write!(w, "{}", c_type).unwrap();
-                                                       return;
-                                               } else {
-                                                       let synident = single_ident_generic_path_to_ident(synpath).unwrap();
-                                                       if let Some(t) = self.crate_types.traits.get(&genpath) {
-                                                               decl_lookup(w, &DeclType::Trait(t), &genpath, is_ref, is_mut);
-                                                               return;
-                                                       } else if let Some(_) = self.imports.get(synident) {
-                                                               // crate_types lookup has to have succeeded:
-                                                               panic!("Failed to print inline conversion for {}", synident);
-                                                       } else if let Some(decl_type) = self.declared.get(synident) {
-                                                               decl_lookup(w, decl_type, &self.maybe_resolve_path(synpath, None).unwrap(), is_ref, is_mut);
-                                                               return;
-                                                       } else { unimplemented!(); }
-                                               }
-                                       }
-                               }
-
-                               let resolved_path = self.resolve_path(&p.path);
+                               let resolved_path = self.resolve_path(&p.path, generics);
                                if let Some(c_type) = path_lookup(&resolved_path, is_ref, ptr_for_ref) {
                                        write!(w, "{}", c_type).unwrap();
                                } else if self.crate_types.opaques.get(&resolved_path).is_some() {
@@ -1195,7 +1174,10 @@ impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
                                } else if self.crate_types.mirrored_enums.get(&resolved_path).is_some() {
                                        decl_lookup(w, &DeclType::MirroredEnum, &resolved_path, is_ref, is_mut);
                                } else if let Some(ident) = single_ident_generic_path_to_ident(&p.path) {
-                                       if let Some(_) = self.imports.get(ident) {
+                                       if let Some(t) = self.crate_types.traits.get(&resolved_path) {
+                                               decl_lookup(w, &DeclType::Trait(t), &resolved_path, is_ref, is_mut);
+                                               return;
+                                       } else if let Some(_) = self.imports.get(ident) {
                                                // crate_types lookup has to have succeeded:
                                                panic!("Failed to print inline conversion for {}", ident);
                                        } else if let Some(decl_type) = self.declared.get(ident) {
@@ -1216,12 +1198,12 @@ impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
                                // We assume all slices contain only literals or references.
                                // This may result in some outputs not compiling.
                                if let syn::Type::Path(p) = &*s.elem {
-                                       let resolved = self.resolve_path(&p.path);
+                                       let resolved = self.resolve_path(&p.path, generics);
                                        assert!(self.is_primitive(&resolved));
                                        write!(w, "{}", path_lookup("[u8]", is_ref, ptr_for_ref).unwrap()).unwrap();
                                } else if let syn::Type::Reference(r) = &*s.elem {
                                        if let syn::Type::Path(p) = &*r.elem {
-                                               write!(w, "{}", sliceconv(self.c_type_has_inner_from_path(&self.resolve_path(&p.path)))).unwrap();
+                                               write!(w, "{}", sliceconv(self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics)))).unwrap();
                                        } else { unimplemented!(); }
                                } else { unimplemented!(); }
                        },
@@ -1374,10 +1356,10 @@ impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
                                        }
                                        if let syn::Type::Reference(t) = ty {
                                                if let syn::Type::Path(p) = &*t.elem {
-                                                       self.c_type_has_inner_from_path(&self.resolve_path(&p.path))
+                                                       self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics))
                                                } else { false }
                                        } else if let syn::Type::Path(p) = ty {
-                                               self.c_type_has_inner_from_path(&self.resolve_path(&p.path))
+                                               self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics))
                                        } else { false }
                                } else { true };
 
@@ -1469,16 +1451,7 @@ impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
                                if p.qself.is_some() || p.path.leading_colon.is_some() {
                                        unimplemented!();
                                }
-                               if let Some(gen_types) = generics {
-                                       if let Some(resolved) = gen_types.maybe_resolve_path(&p.path) {
-                                               assert!(!self.is_known_container(&resolved.0, is_ref) && !self.is_transparent_container(&resolved.0, is_ref));
-                                               if let Some((prefix, suffix)) = path_lookup(&resolved.0, is_ref) {
-                                                       write!(w, "let mut local_{} = {}{}{};", ident, prefix, var, suffix).unwrap();
-                                                       return true;
-                                               } else { return false; }
-                                       }
-                               }
-                               let resolved_path = self.resolve_path(&p.path);
+                               let resolved_path = self.resolve_path(&p.path, generics);
                                if self.is_known_container(&resolved_path, is_ref) || self.is_transparent_container(&resolved_path, is_ref) {
                                        if let syn::PathArguments::AngleBracketed(args) = &p.path.segments.iter().next().unwrap().arguments {
                                                convert_container!(resolved_path, args.args.len(), || args.args.iter().map(|arg| {
@@ -1506,7 +1479,7 @@ impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
                        },
                        syn::Type::Slice(s) => {
                                if let syn::Type::Path(p) = &*s.elem {
-                                       let resolved = self.resolve_path(&p.path);
+                                       let resolved = self.resolve_path(&p.path, generics);
                                        assert!(self.is_primitive(&resolved));
                                        let slice_path = format!("[{}]", resolved);
                                        if let Some((prefix, suffix)) = path_lookup(&slice_path, true) {
@@ -1543,7 +1516,7 @@ impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
                                                                // Opaque types with inner pointers shouldn't ever create new stack
                                                                // variables, so we don't handle it and just assert that it doesn't
                                                                // here.
-                                                               assert!(!self.c_type_has_inner_from_path(&self.resolve_path(&p.path)));
+                                                               assert!(!self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics)));
                                                        }
                                                }
                                        }
@@ -1558,10 +1531,10 @@ impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
                                                                }
                                                                if let syn::Type::Reference(t) = elem {
                                                                        if let syn::Type::Path(p) = &*t.elem {
-                                                                               self.c_type_has_inner_from_path(&self.resolve_path(&p.path))
+                                                                               self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics))
                                                                        } else { false }
                                                                } else if let syn::Type::Path(p) = elem {
-                                                                       self.c_type_has_inner_from_path(&self.resolve_path(&p.path))
+                                                                       self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics))
                                                                } else { false }
                                                        };
                                                if idx != 0 { write!(w, ", ").unwrap(); }
@@ -1590,7 +1563,7 @@ impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
        pub fn write_to_c_conversion_new_var_inner<W: std::io::Write>(&self, w: &mut W, ident: &syn::Ident, var_access: &str, t: &syn::Type, generics: Option<&GenericTypes>, ptr_for_ref: bool) -> bool {
                self.write_conversion_new_var_intern(w, ident, var_access, t, generics, false, ptr_for_ref, true,
                        &|a, b| self.to_c_conversion_new_var_from_path(a, b),
-                       &|a, b, c, d, e| self.to_c_conversion_container_new_var(a, b, c, d, e),
+                       &|a, b, c, d, e| self.to_c_conversion_container_new_var(generics, a, b, c, d, e),
                        // We force ptr_for_ref here since we can't generate a ref on one line and use it later
                        &|a, b, c, d, e, f| self.write_to_c_conversion_inline_prefix_inner(a, b, c, d, e, f),
                        &|a, b, c, d, e, f| self.write_to_c_conversion_inline_suffix_inner(a, b, c, d, e, f))
@@ -1601,7 +1574,7 @@ impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
        pub fn write_from_c_conversion_new_var<W: std::io::Write>(&self, w: &mut W, ident: &syn::Ident, t: &syn::Type, generics: Option<&GenericTypes>) -> bool {
                self.write_conversion_new_var_intern(w, ident, &format!("{}", ident), t, generics, false, false, false,
                        &|a, b| self.from_c_conversion_new_var_from_path(a, b),
-                       &|a, b, c, d, e| self.from_c_conversion_container_new_var(a, b, c, d, e),
+                       &|a, b, c, d, e| self.from_c_conversion_container_new_var(generics, a, b, c, d, e),
                        // We force ptr_for_ref here since we can't generate a ref on one line and use it later
                        &|a, b, c, d, e, _f| self.write_from_c_conversion_prefix_inner(a, b, c, d, e),
                        &|a, b, c, d, e, _f| self.write_from_c_conversion_suffix_inner(a, b, c, d, e))
@@ -1624,7 +1597,7 @@ impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
                                ($call: expr, $item: expr) => { {
                                        write!(w, "#[no_mangle]\npub static {}_{}: extern \"C\" fn (", mangled_container, $call).unwrap();
                                        if let syn::Type::Path(syn::TypePath { path, .. }) = $item {
-                                               let resolved = self.resolve_path(path);
+                                               let resolved = self.resolve_path(path, generics);
                                                if self.is_known_container(&resolved, is_ref) || self.is_transparent_container(&resolved, is_ref) {
                                                        self.write_c_mangled_container_path_intern(w, Self::path_to_generic_args(path), generics,
                                                                &format!("{}", single_ident_generic_path_to_ident(path).unwrap()), is_ref, false, false, false);
@@ -1679,7 +1652,7 @@ impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
                                        write!(w, ">").unwrap();
                                }
                        } else if let syn::Type::Path(p_arg) = t {
-                               let resolved_generic = self.resolve_path(&p_arg.path);
+                               let resolved_generic = self.resolve_path(&p_arg.path, None);
                                if self.is_primitive(&resolved_generic) {
                                        write!(w, "{}", resolved_generic).unwrap();
                                } else if let Some(c_type) = self.c_type_from_path(&resolved_generic, is_ref, false) {
@@ -1721,7 +1694,7 @@ impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
                                }
                        } else if let syn::Type::Reference(r_arg) = t {
                                if let syn::Type::Path(p_arg) = &*r_arg.elem {
-                                       let resolved = self.resolve_path(&p_arg.path);
+                                       let resolved = self.resolve_path(&p_arg.path, None);
                                        if single_ident_generic_path_to_ident(&p_arg.path).is_some() {
                                                if self.crate_types.opaques.get(&resolved).is_some() {
                                                        write!(w, "crate::{}", resolved).unwrap();
@@ -1730,7 +1703,7 @@ impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
                                } else { unimplemented!(); }
                        } else if let syn::Type::Array(a_arg) = t {
                                if let syn::Type::Path(p_arg) = &*a_arg.elem {
-                                       let resolved = self.resolve_path(&p_arg.path);
+                                       let resolved = self.resolve_path(&p_arg.path, None);
                                        assert!(self.is_primitive(&resolved));
                                        if let syn::Expr::Lit(syn::ExprLit { lit: syn::Lit::Int(len), .. }) = &a_arg.len {
                                                write!(w, "{}",
@@ -1775,7 +1748,7 @@ impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
                for arg in args.iter() {
                        macro_rules! write_path {
                                ($p_arg: expr, $extra_write: expr) => {
-                                       let subtype = self.resolve_path(&$p_arg.path);
+                                       let subtype = self.resolve_path(&$p_arg.path, generics);
                                        if self.is_transparent_container(ident, is_ref) {
                                                // We dont (yet) support primitives or containers inside transparent
                                                // containers, so check for that first:
@@ -1855,7 +1828,7 @@ impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
                                } else { return false; }
                        } else if let syn::Type::Array(a) = arg {
                                if let syn::Type::Path(p_arg) = &*a.elem {
-                                       let resolved = self.resolve_path(&p_arg.path);
+                                       let resolved = self.resolve_path(&p_arg.path, generics);
                                        if !self.is_primitive(&resolved) { return false; }
                                        if let syn::Expr::Lit(syn::ExprLit { lit: syn::Lit::Int(len), .. }) = &a.len {
                                                if self.c_type_from_path(&format!("[{}; {}]", resolved, len.base10_digits()), is_ref, ptr_for_ref).is_none() { return false; }
@@ -1966,7 +1939,7 @@ impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
                        syn::Type::Slice(s) => {
                                if !is_ref || is_mut { return false; }
                                if let syn::Type::Path(p) = &*s.elem {
-                                       let resolved = self.resolve_path(&p.path);
+                                       let resolved = self.resolve_path(&p.path, generics);
                                        if self.is_primitive(&resolved) {
                                                write!(w, "{}::{}slice", Self::container_templ_path(), resolved).unwrap();
                                                true
@@ -1974,7 +1947,7 @@ impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
                                } else if let syn::Type::Reference(r) = &*s.elem {
                                        if let syn::Type::Path(p) = &*r.elem {
                                                // Slices with "real types" inside are mapped as the equivalent non-ref Vec
-                                               let resolved = self.resolve_path(&p.path);
+                                               let resolved = self.resolve_path(&p.path, generics);
                                                let mangled_container = if let Some(ident) = self.crate_types.opaques.get(&resolved) {
                                                        format!("CVec_{}Z", ident)
                                                } else if let Some(en) = self.crate_types.mirrored_enums.get(&resolved) {