X-Git-Url: http://git.bitcoin.ninja/index.cgi?p=ldk-c-bindings;a=blobdiff_plain;f=c-bindings-gen%2Fsrc%2Fmain.rs;h=8bbbdf03765579e5636c49aa3dfd9e937cee8768;hp=149ae76791a9c82b94355535269e4eb5ba33d31f;hb=4e514def04a4aabea8261173311e6c747d4bd133;hpb=1b1691ff11dc335218e5fbe21c94d7b83fd1acc2 diff --git a/c-bindings-gen/src/main.rs b/c-bindings-gen/src/main.rs index 149ae76..8bbbdf0 100644 --- a/c-bindings-gen/src/main.rs +++ b/c-bindings-gen/src/main.rs @@ -33,6 +33,8 @@ mod blocks; use types::*; use blocks::*; +const DEFAULT_IMPORTS: &'static str = "\nuse std::str::FromStr;\nuse std::ffi::c_void;\nuse bitcoin::hashes::Hash;\nuse crate::c_types::*;\n"; + // ************************************* // *** Manually-expanded conversions *** // ************************************* @@ -178,7 +180,7 @@ eprintln!("{}", trait_path); // *** Per-Type Printing Logic *** // ******************************* -macro_rules! walk_supertraits { ($t: expr, $types: expr, ($( $pat: pat => $e: expr),*) ) => { { +macro_rules! walk_supertraits { ($t: expr, $types: expr, ($( $($pat: pat)|* => $e: expr),*) ) => { { if $t.colon_token.is_some() { for st in $t.supertraits.iter() { match st { @@ -192,14 +194,14 @@ macro_rules! walk_supertraits { ($t: expr, $types: expr, ($( $pat: pat => $e: ex if let Some(types) = types_opt { if let Some(path) = types.maybe_resolve_path(&supertrait.path, None) { match (&path as &str, &supertrait.path.segments.iter().last().unwrap().ident) { - $( $pat => $e, )* + $( $($pat)|* => $e, )* } continue; } } if let Some(ident) = supertrait.path.get_ident() { match (&format!("{}", ident) as &str, &ident) { - $( $pat => $e, )* + $( $($pat)|* => $e, )* } } else if types_opt.is_some() { panic!("Supertrait unresolvable and not single-ident"); @@ -219,13 +221,15 @@ macro_rules! walk_supertraits { ($t: expr, $types: expr, ($( $pat: pat => $e: ex /// a concrete Deref to the Rust trait. fn writeln_trait<'a, 'b, W: std::io::Write>(w: &mut W, t: &'a syn::ItemTrait, types: &mut TypeResolver<'b, 'a>, extra_headers: &mut File, cpp_headers: &mut File) { let trait_name = format!("{}", t.ident); + let implementable; match export_status(&t.attrs) { - ExportStatus::Export => {}, + ExportStatus::Export => { implementable = true; } + ExportStatus::NotImplementable => { implementable = false; }, ExportStatus::NoExport|ExportStatus::TestOnly => return, } writeln_docs(w, &t.attrs, ""); - let mut gen_types = GenericTypes::new(); + let mut gen_types = GenericTypes::new(None); assert!(gen_types.learn_generics(&t.generics, types)); gen_types.learn_associated_types(&t, types); @@ -245,6 +249,7 @@ fn writeln_trait<'a, 'b, W: std::io::Write>(w: &mut W, t: &'a syn::ItemTrait, ty }, ExportStatus::Export => {}, ExportStatus::TestOnly => continue, + ExportStatus::NotImplementable => panic!("(C-not implementable) must only appear on traits"), } if m.default.is_some() { unimplemented!(); } @@ -309,13 +314,13 @@ fn writeln_trait<'a, 'b, W: std::io::Write>(w: &mut W, t: &'a syn::ItemTrait, ty writeln!(w, "\tpub clone: Option *mut c_void>,").unwrap(); generated_fields.push(("clone".to_owned(), true)); }, - ("std::cmp::Eq", _) => { + ("std::cmp::Eq", _)|("core::cmp::Eq", _) => { writeln!(w, "\t/// Checks if two objects are equal given this object's this_arg pointer and another object.").unwrap(); writeln!(w, "\tpub eq: extern \"C\" fn (this_arg: *const c_void, other_arg: &{}) -> bool,", trait_name).unwrap(); writeln!(extra_headers, "typedef struct LDK{} LDK{};", trait_name, trait_name).unwrap(); generated_fields.push(("eq".to_owned(), true)); }, - ("std::hash::Hash", _) => { + ("std::hash::Hash", _)|("core::hash::Hash", _) => { writeln!(w, "\t/// Calculate a succinct non-cryptographic hash for an object given its this_arg pointer.").unwrap(); writeln!(w, "\t/// This is used, for example, for inclusion of this object in a hash map.").unwrap(); writeln!(w, "\tpub hash: extern \"C\" fn (this_arg: *const c_void) -> u64,").unwrap(); @@ -386,7 +391,7 @@ fn writeln_trait<'a, 'b, W: std::io::Write>(w: &mut W, t: &'a syn::ItemTrait, ty ident.mutability.is_some() || ident.subpat.is_some() { unimplemented!(); } - write!(w, ", {}{}: ", if $type_resolver.skip_arg(&*arg.ty, Some(&meth_gen_types)) { "_" } else { "" }, ident.ident).unwrap(); + write!(w, ", mut {}{}: ", if $type_resolver.skip_arg(&*arg.ty, Some(&meth_gen_types)) { "_" } else { "" }, ident.ident).unwrap(); } _ => unimplemented!(), } @@ -445,20 +450,21 @@ fn writeln_trait<'a, 'b, W: std::io::Write>(w: &mut W, t: &'a syn::ItemTrait, ty } } + writeln!(w, "unsafe impl Send for {} {{}}", trait_name).unwrap(); + writeln!(w, "unsafe impl Sync for {} {{}}", trait_name).unwrap(); // Implement supertraits for the C-mapped struct. walk_supertraits!(t, Some(&types), ( - ("Send", _) => writeln!(w, "unsafe impl Send for {} {{}}", trait_name).unwrap(), - ("Sync", _) => writeln!(w, "unsafe impl Sync for {} {{}}", trait_name).unwrap(), - ("std::cmp::Eq", _) => { + ("std::cmp::Eq", _)|("core::cmp::Eq", _) => { writeln!(w, "impl std::cmp::Eq for {} {{}}", trait_name).unwrap(); writeln!(w, "impl std::cmp::PartialEq for {} {{", trait_name).unwrap(); writeln!(w, "\tfn eq(&self, o: &Self) -> bool {{ (self.eq)(self.this_arg, o) }}\n}}").unwrap(); }, - ("std::hash::Hash", _) => { + ("std::hash::Hash", _)|("core::hash::Hash", _) => { writeln!(w, "impl std::hash::Hash for {} {{", trait_name).unwrap(); writeln!(w, "\tfn hash(&self, hasher: &mut H) {{ hasher.write_u64((self.hash)(self.this_arg)) }}\n}}").unwrap(); }, + ("Send", _) => {}, ("Sync", _) => {}, ("Clone", _) => { writeln!(w, "#[no_mangle]").unwrap(); writeln!(w, "/// Creates a copy of a {}", trait_name).unwrap(); @@ -490,11 +496,6 @@ fn writeln_trait<'a, 'b, W: std::io::Write>(w: &mut W, t: &'a syn::ItemTrait, ty writeln!(w, "impl {} for {} {{", s, trait_name).unwrap(); impl_trait_for_c!(supertrait, format!(".{}", i), &resolver); writeln!(w, "}}").unwrap(); - walk_supertraits!(supertrait, Some(&types), ( - ("Send", _) => writeln!(w, "unsafe impl Send for {} {{}}", trait_name).unwrap(), - ("Sync", _) => writeln!(w, "unsafe impl Sync for {} {{}}", trait_name).unwrap(), - _ => unimplemented!() - ) ); } else { do_write_impl_trait(w, s, i, &trait_name); } @@ -503,15 +504,17 @@ fn writeln_trait<'a, 'b, W: std::io::Write>(w: &mut W, t: &'a syn::ItemTrait, ty // Finally, implement the original Rust trait for the newly created mapped trait. writeln!(w, "\nuse {}::{} as rust{};", types.module_path, t.ident, trait_name).unwrap(); - write!(w, "impl rust{}", t.ident).unwrap(); - maybe_write_generics(w, &t.generics, types, false); - writeln!(w, " for {} {{", trait_name).unwrap(); - impl_trait_for_c!(t, "", types); - writeln!(w, "}}\n").unwrap(); - writeln!(w, "// We're essentially a pointer already, or at least a set of pointers, so allow us to be used").unwrap(); - writeln!(w, "// directly as a Deref trait in higher-level structs:").unwrap(); - writeln!(w, "impl std::ops::Deref for {} {{\n\ttype Target = Self;", trait_name).unwrap(); - writeln!(w, "\tfn deref(&self) -> &Self {{\n\t\tself\n\t}}\n}}").unwrap(); + if implementable { + write!(w, "impl rust{}", t.ident).unwrap(); + maybe_write_generics(w, &t.generics, types, false); + writeln!(w, " for {} {{", trait_name).unwrap(); + impl_trait_for_c!(t, "", types); + writeln!(w, "}}\n").unwrap(); + writeln!(w, "// We're essentially a pointer already, or at least a set of pointers, so allow us to be used").unwrap(); + writeln!(w, "// directly as a Deref trait in higher-level structs:").unwrap(); + writeln!(w, "impl std::ops::Deref for {} {{\n\ttype Target = Self;", trait_name).unwrap(); + writeln!(w, "\tfn deref(&self) -> &Self {{\n\t\tself\n\t}}\n}}").unwrap(); + } writeln!(w, "/// Calls the free function if one is set").unwrap(); writeln!(w, "#[no_mangle]\npub extern \"C\" fn {}_free(this_ptr: {}) {{ }}", trait_name, trait_name).unwrap(); @@ -579,7 +582,10 @@ fn writeln_struct<'a, 'b, W: std::io::Write>(w: &mut W, s: &'a syn::ItemStruct, writeln_opaque(w, &s.ident, struct_name, &s.generics, &s.attrs, types, extra_headers, cpp_headers); if let syn::Fields::Named(fields) = &s.fields { - let mut gen_types = GenericTypes::new(); + let mut self_path_segs = syn::punctuated::Punctuated::new(); + self_path_segs.push(s.ident.clone().into()); + let self_path = syn::Path { leading_colon: None, segments: self_path_segs}; + let mut gen_types = GenericTypes::new(Some((types.resolve_path(&self_path, None), &self_path))); assert!(gen_types.learn_generics(&s.generics, types)); let mut all_fields_settable = true; @@ -592,6 +598,7 @@ fn writeln_struct<'a, 'b, W: std::io::Write>(w: &mut W, s: &'a syn::ItemStruct, all_fields_settable = false; continue }, + ExportStatus::NotImplementable => panic!("(C-not implementable) must only appear on traits"), } if let Some(ident) = &field.ident { @@ -670,11 +677,12 @@ fn writeln_impl(w: &mut W, i: &syn::ItemImpl, types: &mut Typ match export_status(&i.attrs) { ExportStatus::Export => {}, ExportStatus::NoExport|ExportStatus::TestOnly => return, + ExportStatus::NotImplementable => panic!("(C-not implementable) must only appear on traits"), } if let syn::Type::Tuple(_) = &*i.self_ty { if types.understood_c_type(&*i.self_ty, None) { - let mut gen_types = GenericTypes::new(); + let mut gen_types = GenericTypes::new(None); if !gen_types.learn_generics(&i.generics, types) { eprintln!("Not implementing anything for `impl (..)` due to not understood generics"); return; @@ -701,7 +709,7 @@ fn writeln_impl(w: &mut W, i: &syn::ItemImpl, types: &mut Typ if p.qself.is_some() { unimplemented!(); } if let Some(ident) = single_ident_generic_path_to_ident(&p.path) { if let Some(resolved_path) = types.maybe_resolve_non_ignored_ident(&ident) { - let mut gen_types = GenericTypes::new(); + let mut gen_types = GenericTypes::new(Some((resolved_path.clone(), &p.path))); if !gen_types.learn_generics(&i.generics, types) { eprintln!("Not implementing anything for impl {} due to not understood generics", ident); return; @@ -734,7 +742,7 @@ fn writeln_impl(w: &mut W, i: &syn::ItemImpl, types: &mut Typ let export = export_status(&trait_obj.attrs); match export { - ExportStatus::Export => {}, + ExportStatus::Export|ExportStatus::NotImplementable => {}, ExportStatus::NoExport|ExportStatus::TestOnly => return, } @@ -771,6 +779,7 @@ fn writeln_impl(w: &mut W, i: &syn::ItemImpl, types: &mut Typ continue; }, ExportStatus::TestOnly => continue, + ExportStatus::NotImplementable => panic!("(C-not implementable) must only appear on traits"), } let mut printed = false; @@ -838,6 +847,7 @@ fn writeln_impl(w: &mut W, i: &syn::ItemImpl, types: &mut Typ match export_status(&trait_method.attrs) { ExportStatus::Export => {}, ExportStatus::NoExport|ExportStatus::TestOnly => continue, + ExportStatus::NotImplementable => panic!("(C-not implementable) must only appear on traits"), } if let syn::ReturnType::Type(_, _) = &$m.sig.output { @@ -935,6 +945,52 @@ fn writeln_impl(w: &mut W, i: &syn::ItemImpl, types: &mut Typ write!(w, "\t{} {{ inner: Box::into_raw(Box::new(Default::default())), is_owned: true }}\n", ident).unwrap(); write!(w, "}}\n").unwrap(); } else if path_matches_nongeneric(&trait_path.1, &["core", "cmp", "PartialEq"]) { + } else if path_matches_nongeneric(&trait_path.1, &["core", "cmp", "Eq"]) { + writeln!(w, "/// Checks if two {}s contain equal inner contents.", ident).unwrap(); + writeln!(w, "/// This ignores pointers and is_owned flags and looks at the values in fields.").unwrap(); + if types.c_type_has_inner_from_path(&resolved_path) { + writeln!(w, "/// Two objects with NULL inner values will be considered \"equal\" here.").unwrap(); + } + write!(w, "#[no_mangle]\npub extern \"C\" fn {}_eq(a: &{}, b: &{}) -> bool {{\n", ident, ident, ident).unwrap(); + if types.c_type_has_inner_from_path(&resolved_path) { + write!(w, "\tif a.inner == b.inner {{ return true; }}\n").unwrap(); + write!(w, "\tif a.inner.is_null() || b.inner.is_null() {{ return false; }}\n").unwrap(); + } + + let path = &p.path; + let ref_type: syn::Type = syn::parse_quote!(&#path); + assert!(!types.write_to_c_conversion_new_var(w, &format_ident!("a"), &*i.self_ty, Some(&gen_types), false), "We don't support new var conversions when comparing equality"); + + write!(w, "\tif ").unwrap(); + types.write_from_c_conversion_prefix(w, &ref_type, Some(&gen_types)); + write!(w, "a").unwrap(); + types.write_from_c_conversion_suffix(w, &ref_type, Some(&gen_types)); + write!(w, " == ").unwrap(); + types.write_from_c_conversion_prefix(w, &ref_type, Some(&gen_types)); + write!(w, "b").unwrap(); + types.write_from_c_conversion_suffix(w, &ref_type, Some(&gen_types)); + + writeln!(w, " {{ true }} else {{ false }}\n}}").unwrap(); + } else if path_matches_nongeneric(&trait_path.1, &["core", "hash", "Hash"]) { + writeln!(w, "/// Checks if two {}s contain equal inner contents.", ident).unwrap(); + write!(w, "#[no_mangle]\npub extern \"C\" fn {}_hash(o: &{}) -> u64 {{\n", ident, ident).unwrap(); + if types.c_type_has_inner_from_path(&resolved_path) { + write!(w, "\tif o.inner.is_null() {{ return 0; }}\n").unwrap(); + } + + let path = &p.path; + let ref_type: syn::Type = syn::parse_quote!(&#path); + assert!(!types.write_to_c_conversion_new_var(w, &format_ident!("a"), &*i.self_ty, Some(&gen_types), false), "We don't support new var conversions when comparing equality"); + + writeln!(w, "\t// Note that we'd love to use std::collections::hash_map::DefaultHasher but it's not in core").unwrap(); + writeln!(w, "\t#[allow(deprecated)]").unwrap(); + writeln!(w, "\tlet mut hasher = core::hash::SipHasher::new();").unwrap(); + write!(w, "\tstd::hash::Hash::hash(").unwrap(); + types.write_from_c_conversion_prefix(w, &ref_type, Some(&gen_types)); + write!(w, "o").unwrap(); + types.write_from_c_conversion_suffix(w, &ref_type, Some(&gen_types)); + writeln!(w, ", &mut hasher);").unwrap(); + writeln!(w, "\tstd::hash::Hasher::finish(&hasher)\n}}").unwrap(); } else if (path_matches_nongeneric(&trait_path.1, &["core", "clone", "Clone"]) || path_matches_nongeneric(&trait_path.1, &["Clone"])) && types.c_type_has_inner_from_path(&resolved_path) { writeln!(w, "impl Clone for {} {{", ident).unwrap(); @@ -953,6 +1009,39 @@ fn writeln_impl(w: &mut W, i: &syn::ItemImpl, types: &mut Typ writeln!(w, "/// Creates a copy of the {}", ident).unwrap(); writeln!(w, "pub extern \"C\" fn {}_clone(orig: &{}) -> {} {{", ident, ident, ident).unwrap(); writeln!(w, "\torig.clone()").unwrap(); + writeln!(w, "}}").unwrap(); + } else if path_matches_nongeneric(&trait_path.1, &["FromStr"]) { + if let Some(container) = types.get_c_mangled_container_type( + vec![&*i.self_ty, &syn::Type::Tuple(syn::TypeTuple { paren_token: Default::default(), elems: syn::punctuated::Punctuated::new() })], + Some(&gen_types), "Result") { + writeln!(w, "#[no_mangle]").unwrap(); + writeln!(w, "/// Read a {} object from a string", ident).unwrap(); + writeln!(w, "pub extern \"C\" fn {}_from_str(s: crate::c_types::Str) -> {} {{", ident, container).unwrap(); + writeln!(w, "\tmatch {}::from_str(s.into_str()) {{", resolved_path).unwrap(); + writeln!(w, "\t\tOk(r) => {{").unwrap(); + let new_var = types.write_to_c_conversion_new_var(w, &format_ident!("r"), &*i.self_ty, Some(&gen_types), false); + write!(w, "\t\t\tcrate::c_types::CResultTempl::ok(\n\t\t\t\t").unwrap(); + types.write_to_c_conversion_inline_prefix(w, &*i.self_ty, Some(&gen_types), false); + write!(w, "{}r", if new_var { "local_" } else { "" }).unwrap(); + types.write_to_c_conversion_inline_suffix(w, &*i.self_ty, Some(&gen_types), false); + writeln!(w, "\n\t\t\t)\n\t\t}},").unwrap(); + writeln!(w, "\t\tErr(e) => crate::c_types::CResultTempl::err(()),").unwrap(); + writeln!(w, "\t}}.into()\n}}").unwrap(); + } + } else if path_matches_nongeneric(&trait_path.1, &["Display"]) { + writeln!(w, "#[no_mangle]").unwrap(); + writeln!(w, "/// Get the string representation of a {} object", ident).unwrap(); + writeln!(w, "pub extern \"C\" fn {}_to_str(o: &crate::{}) -> Str {{", ident, resolved_path).unwrap(); + + let self_ty = &i.self_ty; + let ref_type: syn::Type = syn::parse_quote!(&#self_ty); + let new_var = types.write_from_c_conversion_new_var(w, &format_ident!("o"), &ref_type, Some(&gen_types)); + write!(w, "\tformat!(\"{{}}\", ").unwrap(); + types.write_from_c_conversion_prefix(w, &ref_type, Some(&gen_types)); + write!(w, "{}o", if new_var { "local_" } else { "" }).unwrap(); + types.write_from_c_conversion_suffix(w, &ref_type, Some(&gen_types)); + writeln!(w, ").into()").unwrap(); + writeln!(w, "}}").unwrap(); } else { //XXX: implement for other things like ToString @@ -968,6 +1057,7 @@ fn writeln_impl(w: &mut W, i: &syn::ItemImpl, types: &mut Typ match export_status(&m.attrs) { ExportStatus::Export => {}, ExportStatus::NoExport|ExportStatus::TestOnly => continue, + ExportStatus::NotImplementable => panic!("(C-not implementable) must only appear on traits"), } if m.defaultness.is_some() { unimplemented!(); } writeln_docs(w, &m.attrs, ""); @@ -987,10 +1077,12 @@ fn writeln_impl(w: &mut W, i: &syn::ItemImpl, types: &mut Typ write_method_var_decl_body(w, &m.sig, "", types, Some(&meth_gen_types), false); let mut takes_self = false; let mut takes_mut_self = false; + let mut takes_owned_self = false; for inp in m.sig.inputs.iter() { if let syn::FnArg::Receiver(r) = inp { takes_self = true; if r.mutability.is_some() { takes_mut_self = true; } + if r.reference.is_none() { takes_owned_self = true; } } } if !takes_mut_self && !takes_self { @@ -999,7 +1091,9 @@ fn writeln_impl(w: &mut W, i: &syn::ItemImpl, types: &mut Typ match &declared_type { DeclType::MirroredEnum => write!(w, "this_arg.to_native().{}(", m.sig.ident).unwrap(), DeclType::StructImported => { - if takes_mut_self { + if takes_owned_self { + write!(w, "(*unsafe {{ Box::from_raw(this_arg.take_inner()) }}).{}(", m.sig.ident).unwrap(); + } else if takes_mut_self { write!(w, "unsafe {{ &mut (*(this_arg.inner as *mut native{})) }}.{}(", ident, m.sig.ident).unwrap(); } else { write!(w, "unsafe {{ &*this_arg.inner }}.{}(", m.sig.ident).unwrap(); @@ -1086,6 +1180,7 @@ fn writeln_enum<'a, 'b, W: std::io::Write>(w: &mut W, e: &'a syn::ItemEnum, type match export_status(&e.attrs) { ExportStatus::Export => {}, ExportStatus::NoExport|ExportStatus::TestOnly => return, + ExportStatus::NotImplementable => panic!("(C-not implementable) must only appear on traits"), } if is_enum_opaque(e) { @@ -1095,9 +1190,8 @@ fn writeln_enum<'a, 'b, W: std::io::Write>(w: &mut W, e: &'a syn::ItemEnum, type } writeln_docs(w, &e.attrs, ""); - if e.generics.lt_token.is_some() { - unimplemented!(); - } + let mut gen_types = GenericTypes::new(None); + assert!(gen_types.learn_generics(&e.generics, types)); let mut needs_free = false; @@ -1113,21 +1207,31 @@ fn writeln_enum<'a, 'b, W: std::io::Write>(w: &mut W, e: &'a syn::ItemEnum, type if export_status(&field.attrs) == ExportStatus::TestOnly { continue; } writeln_docs(w, &field.attrs, "\t\t"); write!(w, "\t\t{}: ", field.ident.as_ref().unwrap()).unwrap(); - types.write_c_type(w, &field.ty, None, false); + types.write_c_type(w, &field.ty, Some(&gen_types), false); writeln!(w, ",").unwrap(); } write!(w, "\t}}").unwrap(); } else if let syn::Fields::Unnamed(fields) = &var.fields { - needs_free = true; - write!(w, "(").unwrap(); - for (idx, field) in fields.unnamed.iter().enumerate() { - if export_status(&field.attrs) == ExportStatus::TestOnly { continue; } - types.write_c_type(w, &field.ty, None, false); - if idx != fields.unnamed.len() - 1 { - write!(w, ",").unwrap(); + let mut empty_tuple_variant = false; + if fields.unnamed.len() == 1 { + let mut empty_check = Vec::new(); + types.write_c_type(&mut empty_check, &fields.unnamed[0].ty, Some(&gen_types), false); + if empty_check.is_empty() { + empty_tuple_variant = true; } } - write!(w, ")").unwrap(); + if !empty_tuple_variant { + needs_free = true; + write!(w, "(").unwrap(); + for (idx, field) in fields.unnamed.iter().enumerate() { + if export_status(&field.attrs) == ExportStatus::TestOnly { continue; } + types.write_c_type(w, &field.ty, Some(&gen_types), false); + if idx != fields.unnamed.len() - 1 { + write!(w, ",").unwrap(); + } + } + write!(w, ")").unwrap(); + } } if var.discriminant.is_some() { unimplemented!(); } writeln!(w, ",").unwrap(); @@ -1139,6 +1243,7 @@ fn writeln_enum<'a, 'b, W: std::io::Write>(w: &mut W, e: &'a syn::ItemEnum, type writeln!(w, "\t#[allow(unused)]\n\tpub(crate) fn {} {{\n\t\tmatch {} {{", $fn_sig, if $to_c { "native" } else { "self" }).unwrap(); for var in e.variants.iter() { write!(w, "\t\t\t{}{}::{} ", if $to_c { "native" } else { "" }, e.ident, var.ident).unwrap(); + let mut empty_tuple_variant = false; if let syn::Fields::Named(fields) = &var.fields { write!(w, "{{").unwrap(); for field in fields.named.iter() { @@ -1147,12 +1252,21 @@ fn writeln_enum<'a, 'b, W: std::io::Write>(w: &mut W, e: &'a syn::ItemEnum, type } write!(w, "}} ").unwrap(); } else if let syn::Fields::Unnamed(fields) = &var.fields { - write!(w, "(").unwrap(); - for (idx, field) in fields.unnamed.iter().enumerate() { - if export_status(&field.attrs) == ExportStatus::TestOnly { continue; } - write!(w, "{}{}, ", if $ref { "ref " } else { "mut " }, ('a' as u8 + idx as u8) as char).unwrap(); + if fields.unnamed.len() == 1 { + let mut empty_check = Vec::new(); + types.write_c_type(&mut empty_check, &fields.unnamed[0].ty, Some(&gen_types), false); + if empty_check.is_empty() { + empty_tuple_variant = true; + } + } + if !empty_tuple_variant || $to_c { + write!(w, "(").unwrap(); + for (idx, field) in fields.unnamed.iter().enumerate() { + if export_status(&field.attrs) == ExportStatus::TestOnly { continue; } + write!(w, "{}{}, ", if $ref { "ref " } else { "mut " }, ('a' as u8 + idx as u8) as char).unwrap(); + } + write!(w, ") ").unwrap(); } - write!(w, ") ").unwrap(); } write!(w, "=>").unwrap(); @@ -1162,9 +1276,9 @@ fn writeln_enum<'a, 'b, W: std::io::Write>(w: &mut W, e: &'a syn::ItemEnum, type let mut sink = ::std::io::sink(); let mut out: &mut dyn std::io::Write = if $ref { &mut sink } else { w }; let new_var = if $to_c { - types.write_to_c_conversion_new_var(&mut out, $field_ident, &$field.ty, None, false) + types.write_to_c_conversion_new_var(&mut out, $field_ident, &$field.ty, Some(&gen_types), false) } else { - types.write_from_c_conversion_new_var(&mut out, $field_ident, &$field.ty, None) + types.write_from_c_conversion_new_var(&mut out, $field_ident, &$field.ty, Some(&gen_types)) }; if $ref || new_var { if $ref { @@ -1172,9 +1286,9 @@ fn writeln_enum<'a, 'b, W: std::io::Write>(w: &mut W, e: &'a syn::ItemEnum, type if new_var { let nonref_ident = format_ident!("{}_nonref", $field_ident); if $to_c { - types.write_to_c_conversion_new_var(w, &nonref_ident, &$field.ty, None, false); + types.write_to_c_conversion_new_var(w, &nonref_ident, &$field.ty, Some(&gen_types), false); } else { - types.write_from_c_conversion_new_var(w, &nonref_ident, &$field.ty, None); + types.write_from_c_conversion_new_var(w, &nonref_ident, &$field.ty, Some(&gen_types)); } write!(w, "\n\t\t\t\t").unwrap(); } @@ -1192,7 +1306,9 @@ fn writeln_enum<'a, 'b, W: std::io::Write>(w: &mut W, e: &'a syn::ItemEnum, type } else if let syn::Fields::Unnamed(fields) = &var.fields { write!(w, " {{\n\t\t\t\t").unwrap(); for (idx, field) in fields.unnamed.iter().enumerate() { - handle_field_a!(field, &format_ident!("{}", ('a' as u8 + idx as u8) as char)); + if !empty_tuple_variant { + handle_field_a!(field, &format_ident!("{}", ('a' as u8 + idx as u8) as char)); + } } } else { write!(w, " ").unwrap(); } @@ -1202,16 +1318,16 @@ fn writeln_enum<'a, 'b, W: std::io::Write>(w: &mut W, e: &'a syn::ItemEnum, type ($field: expr, $field_ident: expr) => { { if export_status(&$field.attrs) == ExportStatus::TestOnly { continue; } if $to_c { - types.write_to_c_conversion_inline_prefix(w, &$field.ty, None, false); + types.write_to_c_conversion_inline_prefix(w, &$field.ty, Some(&gen_types), false); } else { - types.write_from_c_conversion_prefix(w, &$field.ty, None); + types.write_from_c_conversion_prefix(w, &$field.ty, Some(&gen_types)); } write!(w, "{}{}", $field_ident, if $ref { "_nonref" } else { "" }).unwrap(); if $to_c { - types.write_to_c_conversion_inline_suffix(w, &$field.ty, None, false); + types.write_to_c_conversion_inline_suffix(w, &$field.ty, Some(&gen_types), false); } else { - types.write_from_c_conversion_suffix(w, &$field.ty, None); + types.write_from_c_conversion_suffix(w, &$field.ty, Some(&gen_types)); } write!(w, ",").unwrap(); } } @@ -1227,12 +1343,14 @@ fn writeln_enum<'a, 'b, W: std::io::Write>(w: &mut W, e: &'a syn::ItemEnum, type writeln!(w, "\n\t\t\t\t}}").unwrap(); write!(w, "\t\t\t}}").unwrap(); } else if let syn::Fields::Unnamed(fields) = &var.fields { - write!(w, " (").unwrap(); - for (idx, field) in fields.unnamed.iter().enumerate() { - write!(w, "\n\t\t\t\t\t").unwrap(); - handle_field_b!(field, &format_ident!("{}", ('a' as u8 + idx as u8) as char)); + if !empty_tuple_variant || !$to_c { + write!(w, " (").unwrap(); + for (idx, field) in fields.unnamed.iter().enumerate() { + write!(w, "\n\t\t\t\t\t").unwrap(); + handle_field_b!(field, &format_ident!("{}", ('a' as u8 + idx as u8) as char)); + } + writeln!(w, "\n\t\t\t\t)").unwrap(); } - writeln!(w, "\n\t\t\t\t)").unwrap(); write!(w, "\t\t\t}}").unwrap(); } writeln!(w, ",").unwrap(); @@ -1263,10 +1381,11 @@ fn writeln_fn<'a, 'b, W: std::io::Write>(w: &mut W, f: &'a syn::ItemFn, types: & match export_status(&f.attrs) { ExportStatus::Export => {}, ExportStatus::NoExport|ExportStatus::TestOnly => return, + ExportStatus::NotImplementable => panic!("(C-not implementable) must only appear on traits"), } writeln_docs(w, &f.attrs, ""); - let mut gen_types = GenericTypes::new(); + let mut gen_types = GenericTypes::new(None); if !gen_types.learn_generics(&f.sig.generics, types) { return; } write!(w, "#[no_mangle]\npub extern \"C\" fn {}(", f.sig.ident).unwrap(); @@ -1282,6 +1401,35 @@ fn writeln_fn<'a, 'b, W: std::io::Write>(w: &mut W, f: &'a syn::ItemFn, types: & // *** File/Crate Walking Logic *** // ******************************** +fn convert_priv_mod<'a, 'b: 'a, W: std::io::Write>(w: &mut W, libast: &'b FullLibraryAST, crate_types: &CrateTypes<'b>, out_dir: &str, mod_path: &str, module: &'b syn::ItemMod) { + // We want to ignore all items declared in this module (as they are not pub), but we still need + // to give the ImportResolver any use statements, so we copy them here. + let mut use_items = Vec::new(); + for item in module.content.as_ref().unwrap().1.iter() { + if let syn::Item::Use(_) = item { + use_items.push(item); + } + } + let import_resolver = ImportResolver::from_borrowed_items(mod_path.splitn(2, "::").next().unwrap(), &libast.dependencies, mod_path, &use_items); + let mut types = TypeResolver::new(mod_path, import_resolver, crate_types); + + writeln!(w, "mod {} {{\n{}", module.ident, DEFAULT_IMPORTS).unwrap(); + for item in module.content.as_ref().unwrap().1.iter() { + match item { + syn::Item::Mod(m) => convert_priv_mod(w, libast, crate_types, out_dir, &format!("{}::{}", mod_path, module.ident), m), + syn::Item::Impl(i) => { + if let &syn::Type::Path(ref p) = &*i.self_ty { + if p.path.get_ident().is_some() { + writeln_impl(w, i, &mut types); + } + } + }, + _ => {}, + } + } + writeln!(w, "}}").unwrap(); +} + /// Do the Real Work of mapping an original file to C-callable wrappers. Creates a new file at /// `out_path` and fills it with wrapper structs/functions to allow calling the things in the AST /// at `module` from C. @@ -1326,11 +1474,13 @@ fn convert_file<'a, 'b>(libast: &'a FullLibraryAST, crate_types: &CrateTypes<'a> writeln!(out, "#![allow(unused_parens)]").unwrap(); writeln!(out, "#![allow(unused_unsafe)]").unwrap(); writeln!(out, "#![allow(unused_braces)]").unwrap(); - writeln!(out, "#![deny(missing_docs)]").unwrap(); + // TODO: We need to map deny(missing_docs) in the source crate(s) + //writeln!(out, "#![deny(missing_docs)]").unwrap(); + writeln!(out, "pub mod version;").unwrap(); writeln!(out, "pub mod c_types;").unwrap(); writeln!(out, "pub mod bitcoin;").unwrap(); } else { - writeln!(out, "\nuse std::ffi::c_void;\nuse bitcoin::hashes::Hash;\nuse crate::c_types::*;\n").unwrap(); + writeln!(out, "{}", DEFAULT_IMPORTS).unwrap(); } for m in submods { @@ -1364,7 +1514,9 @@ fn convert_file<'a, 'b>(libast: &'a FullLibraryAST, crate_types: &CrateTypes<'a> writeln_trait(&mut out, &t, &mut type_resolver, header_file, cpp_header_file); } }, - syn::Item::Mod(_) => {}, // We don't have to do anything - the top loop handles these. + syn::Item::Mod(m) => { + convert_priv_mod(&mut out, libast, crate_types, out_dir, &format!("{}::{}", module, m.ident), m); + }, syn::Item::Const(c) => { // Re-export any primitive-type constants. if let syn::Visibility::Public(_) = c.vis { @@ -1383,6 +1535,7 @@ fn convert_file<'a, 'b>(libast: &'a FullLibraryAST, crate_types: &CrateTypes<'a> match export_status(&t.attrs) { ExportStatus::Export => {}, ExportStatus::NoExport|ExportStatus::TestOnly => continue, + ExportStatus::NotImplementable => panic!("(C-not implementable) must only appear on traits"), } let mut process_alias = true; @@ -1454,6 +1607,7 @@ fn walk_ast<'a>(ast_storage: &'a FullLibraryAST, crate_types: &mut CrateTypes<'a match export_status(&s.attrs) { ExportStatus::Export => {}, ExportStatus::NoExport|ExportStatus::TestOnly => continue, + ExportStatus::NotImplementable => panic!("(C-not implementable) must only appear on traits"), } let struct_path = format!("{}::{}", module, s.ident); crate_types.opaques.insert(struct_path, &s.ident); @@ -1462,7 +1616,7 @@ fn walk_ast<'a>(ast_storage: &'a FullLibraryAST, crate_types: &mut CrateTypes<'a syn::Item::Trait(t) => { if let syn::Visibility::Public(_) = t.vis { match export_status(&t.attrs) { - ExportStatus::Export => {}, + ExportStatus::Export|ExportStatus::NotImplementable => {}, ExportStatus::NoExport|ExportStatus::TestOnly => continue, } let trait_path = format!("{}::{}", module, t.ident); @@ -1480,6 +1634,7 @@ fn walk_ast<'a>(ast_storage: &'a FullLibraryAST, crate_types: &mut CrateTypes<'a match export_status(&t.attrs) { ExportStatus::Export => {}, ExportStatus::NoExport|ExportStatus::TestOnly => continue, + ExportStatus::NotImplementable => panic!("(C-not implementable) must only appear on traits"), } let type_path = format!("{}::{}", module, t.ident); let mut process_alias = true; @@ -1514,6 +1669,7 @@ fn walk_ast<'a>(ast_storage: &'a FullLibraryAST, crate_types: &mut CrateTypes<'a match export_status(&e.attrs) { ExportStatus::Export => {}, ExportStatus::NoExport|ExportStatus::TestOnly => continue, + ExportStatus::NotImplementable => panic!("(C-not implementable) must only appear on traits"), } let enum_path = format!("{}::{}", module, e.ident); crate_types.opaques.insert(enum_path, &e.ident); @@ -1524,6 +1680,7 @@ fn walk_ast<'a>(ast_storage: &'a FullLibraryAST, crate_types: &mut CrateTypes<'a match export_status(&e.attrs) { ExportStatus::Export => {}, ExportStatus::NoExport|ExportStatus::TestOnly => continue, + ExportStatus::NotImplementable => panic!("(C-not implementable) must only appear on traits"), } let enum_path = format!("{}::{}", module, e.ident); crate_types.mirrored_enums.insert(enum_path, &e);