X-Git-Url: http://git.bitcoin.ninja/index.cgi?p=ldk-c-bindings;a=blobdiff_plain;f=c-bindings-gen%2Fsrc%2Fmain.rs;h=d107f3e9a6c66af726c4c84602c45c209686712c;hp=3a7bfd6c584d0d4f131ce7ea17ec2dc92487a474;hb=4b3c6041d34566b1f398cb3277482e505a6a36aa;hpb=19e04c9362c00205b6133bb4f7fd74d1b9859b48 diff --git a/c-bindings-gen/src/main.rs b/c-bindings-gen/src/main.rs index 3a7bfd6..d107f3e 100644 --- a/c-bindings-gen/src/main.rs +++ b/c-bindings-gen/src/main.rs @@ -1,3 +1,11 @@ +// This file is Copyright its original authors, visible in version control +// history. +// +// This file is licensed under the Apache License, Version 2.0 +// or the MIT license , at your option. +// You may not use this file except in accordance with one or both of these +// licenses. + //! Converts a rust crate into a rust crate containing a number of C-exported wrapper functions and //! classes (which is exportable using cbindgen). //! In general, supports convering: @@ -10,13 +18,15 @@ //! It also generates relevant memory-management functions and free-standing functions with //! parameters mapped. -use std::collections::{HashMap, hash_map, HashSet}; +use std::collections::{HashMap, hash_map}; use std::env; use std::fs::File; use std::io::{Read, Write}; use std::process; -use proc_macro2::{TokenTree, TokenStream, Span}; +use proc_macro2::Span; +use quote::format_ident; +use syn::parse_quote; mod types; mod blocks; @@ -27,38 +37,6 @@ use blocks::*; // *** Manually-expanded conversions *** // ************************************* -/// Because we don't expand macros, any code that we need to generated based on their contents has -/// to be completely manual. In this case its all just serialization, so its not too hard. -fn convert_macro(w: &mut W, macro_path: &syn::Path, stream: &TokenStream, types: &TypeResolver) { - assert_eq!(macro_path.segments.len(), 1); - match &format!("{}", macro_path.segments.iter().next().unwrap().ident) as &str { - "impl_writeable" | "impl_writeable_len_match" => { - let struct_for = if let TokenTree::Ident(i) = stream.clone().into_iter().next().unwrap() { i } else { unimplemented!(); }; - if let Some(s) = types.maybe_resolve_ident(&struct_for) { - if !types.crate_types.opaques.get(&s).is_some() { return; } - writeln!(w, "#[no_mangle]").unwrap(); - writeln!(w, "/// Serialize the {} into a byte array which can be read by {}_read", struct_for, struct_for).unwrap(); - writeln!(w, "pub extern \"C\" fn {}_write(obj: &{}) -> crate::c_types::derived::CVec_u8Z {{", struct_for, struct_for).unwrap(); - writeln!(w, "\tcrate::c_types::serialize_obj(unsafe {{ &(*(*obj).inner) }})").unwrap(); - writeln!(w, "}}").unwrap(); - writeln!(w, "#[no_mangle]").unwrap(); - writeln!(w, "pub(crate) extern \"C\" fn {}_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {{", struct_for).unwrap(); - writeln!(w, "\tcrate::c_types::serialize_obj(unsafe {{ &*(obj as *const native{}) }})", struct_for).unwrap(); - writeln!(w, "}}").unwrap(); - writeln!(w, "#[no_mangle]").unwrap(); - writeln!(w, "/// Read a {} from a byte array, created by {}_write", struct_for, struct_for).unwrap(); - writeln!(w, "pub extern \"C\" fn {}_read(ser: crate::c_types::u8slice) -> {} {{", struct_for, struct_for).unwrap(); - writeln!(w, "\tif let Ok(res) = crate::c_types::deserialize_obj(ser) {{").unwrap(); - writeln!(w, "\t\t{} {{ inner: Box::into_raw(Box::new(res)), is_owned: true }}", struct_for).unwrap(); - writeln!(w, "\t}} else {{").unwrap(); - writeln!(w, "\t\t{} {{ inner: std::ptr::null_mut(), is_owned: true }}", struct_for).unwrap(); - writeln!(w, "\t}}\n}}").unwrap(); - } - }, - _ => {}, - } -} - /// Convert "impl trait_path for for_ty { .. }" for manually-mapped types (ie (de)serialization) fn maybe_convert_trait_impl(w: &mut W, trait_path: &syn::Path, for_ty: &syn::Type, types: &mut TypeResolver, generics: &GenericTypes) { if let Some(t) = types.maybe_resolve_path(&trait_path, Some(generics)) { @@ -82,15 +60,13 @@ fn maybe_convert_trait_impl(w: &mut W, trait_path: &syn::Path } match &t as &str { - "util::ser::Writeable" => { + "lightning::util::ser::Writeable" => { writeln!(w, "#[no_mangle]").unwrap(); writeln!(w, "/// Serialize the {} object into a byte array which can be read by {}_read", for_obj, for_obj).unwrap(); writeln!(w, "pub extern \"C\" fn {}_write(obj: &{}) -> crate::c_types::derived::CVec_u8Z {{", for_obj, full_obj_path).unwrap(); - let ref_type = syn::Type::Reference(syn::TypeReference { - and_token: syn::Token!(&)(Span::call_site()), lifetime: None, mutability: None, - elem: Box::new(for_ty.clone()) }); - assert!(!types.write_from_c_conversion_new_var(w, &syn::Ident::new("obj", Span::call_site()), &ref_type, Some(generics))); + let ref_type: syn::Type = syn::parse_quote!(&#for_ty); + assert!(!types.write_from_c_conversion_new_var(w, &format_ident!("obj"), &ref_type, Some(generics))); write!(w, "\tcrate::c_types::serialize_obj(").unwrap(); types.write_from_c_conversion_prefix(w, &ref_type, Some(generics)); @@ -106,35 +82,16 @@ fn maybe_convert_trait_impl(w: &mut W, trait_path: &syn::Path writeln!(w, "}}").unwrap(); } }, - "util::ser::Readable"|"util::ser::ReadableArgs" => { + "lightning::util::ser::Readable"|"lightning::util::ser::ReadableArgs" => { // Create the Result syn::Type - let mut err_segs = syn::punctuated::Punctuated::new(); - err_segs.push(syn::PathSegment { ident: syn::Ident::new("ln", Span::call_site()), arguments: syn::PathArguments::None }); - err_segs.push(syn::PathSegment { ident: syn::Ident::new("msgs", Span::call_site()), arguments: syn::PathArguments::None }); - err_segs.push(syn::PathSegment { ident: syn::Ident::new("DecodeError", Span::call_site()), arguments: syn::PathArguments::None }); - let mut args = syn::punctuated::Punctuated::new(); - args.push(syn::GenericArgument::Type(for_ty.clone())); - args.push(syn::GenericArgument::Type(syn::Type::Path(syn::TypePath { - qself: None, path: syn::Path { - leading_colon: Some(syn::Token![::](Span::call_site())), segments: err_segs, - } - }))); - let mut res_segs = syn::punctuated::Punctuated::new(); - res_segs.push(syn::PathSegment { - ident: syn::Ident::new("Result", Span::call_site()), - arguments: syn::PathArguments::AngleBracketed(syn::AngleBracketedGenericArguments { - colon2_token: None, lt_token: syn::Token![<](Span::call_site()), args, gt_token: syn::Token![>](Span::call_site()), - }) - }); - let res_ty = syn::Type::Path(syn::TypePath { qself: None, path: syn::Path { - leading_colon: None, segments: res_segs } }); + let res_ty: syn::Type = parse_quote!(Result<#for_ty, ::ln::msgs::DecodeError>); writeln!(w, "#[no_mangle]").unwrap(); writeln!(w, "/// Read a {} from a byte array, created by {}_write", for_obj, for_obj).unwrap(); write!(w, "pub extern \"C\" fn {}_read(ser: crate::c_types::u8slice", for_obj).unwrap(); let mut arg_conv = Vec::new(); - if t == "util::ser::ReadableArgs" { + if t == "lightning::util::ser::ReadableArgs" { write!(w, ", arg: ").unwrap(); assert!(trait_path.leading_colon.is_none()); let args_seg = trait_path.segments.iter().last().unwrap(); @@ -144,7 +101,7 @@ fn maybe_convert_trait_impl(w: &mut W, trait_path: &syn::Path if let syn::GenericArgument::Type(args_ty) = args.args.iter().next().unwrap() { types.write_c_type(w, args_ty, Some(generics), false); - assert!(!types.write_from_c_conversion_new_var(&mut arg_conv, &syn::Ident::new("arg", Span::call_site()), &args_ty, Some(generics))); + assert!(!types.write_from_c_conversion_new_var(&mut arg_conv, &format_ident!("arg"), &args_ty, Some(generics))); write!(&mut arg_conv, "\tlet arg_conv = ").unwrap(); types.write_from_c_conversion_prefix(&mut arg_conv, &args_ty, Some(generics)); @@ -157,7 +114,7 @@ fn maybe_convert_trait_impl(w: &mut W, trait_path: &syn::Path types.write_c_type(w, &res_ty, Some(generics), false); writeln!(w, " {{").unwrap(); - if t == "util::ser::ReadableArgs" { + if t == "lightning::util::ser::ReadableArgs" { w.write(&arg_conv).unwrap(); write!(w, ";\n\tlet res: ").unwrap(); // At least in one case we need type annotations here, so provide them. @@ -167,7 +124,7 @@ fn maybe_convert_trait_impl(w: &mut W, trait_path: &syn::Path writeln!(w, "\tlet res = crate::c_types::deserialize_obj(ser);").unwrap(); } write!(w, "\t").unwrap(); - if types.write_to_c_conversion_new_var(w, &syn::Ident::new("res", Span::call_site()), &res_ty, Some(generics), false) { + if types.write_to_c_conversion_new_var(w, &format_ident!("res"), &res_ty, Some(generics), false) { write!(w, "\n\t").unwrap(); } types.write_to_c_conversion_inline_prefix(w, &res_ty, Some(generics), false); @@ -186,7 +143,7 @@ fn maybe_convert_trait_impl(w: &mut W, trait_path: &syn::Path /// single function (eg for serialization). fn convert_trait_impl_field(trait_path: &str) -> (&'static str, String, &'static str) { match trait_path { - "util::ser::Writeable" => ("Serialize the object into a byte array", "write".to_owned(), "crate::c_types::derived::CVec_u8Z"), + "lightning::util::ser::Writeable" => ("Serialize the object into a byte array", "write".to_owned(), "crate::c_types::derived::CVec_u8Z"), _ => unimplemented!(), } } @@ -195,7 +152,7 @@ fn convert_trait_impl_field(trait_path: &str) -> (&'static str, String, &'static /// `for_obj` which implements the the trait at `trait_path`. fn write_trait_impl_field_assign(w: &mut W, trait_path: &str, for_obj: &syn::Ident) { match trait_path { - "util::ser::Writeable" => { + "lightning::util::ser::Writeable" => { writeln!(w, "\t\twrite: {}_write_void,", for_obj).unwrap(); }, _ => unimplemented!(), @@ -203,16 +160,11 @@ fn write_trait_impl_field_assign(w: &mut W, trait_path: &str, } /// Write out the impl block for a defined trait struct which has a supertrait -fn do_write_impl_trait(w: &mut W, trait_path: &str, trait_name: &syn::Ident, for_obj: &str) { +fn do_write_impl_trait(w: &mut W, trait_path: &str, _trait_name: &syn::Ident, for_obj: &str) { +eprintln!("{}", trait_path); match trait_path { - "util::events::MessageSendEventsProvider" => { - writeln!(w, "impl lightning::{} for {} {{", trait_path, for_obj).unwrap(); - writeln!(w, "\tfn get_and_clear_pending_msg_events(&self) -> Vec {{").unwrap(); - writeln!(w, "\t\t::get_and_clear_pending_msg_events(&self.{})", trait_path, trait_path, trait_name).unwrap(); - writeln!(w, "\t}}\n}}").unwrap(); - }, - "util::ser::Writeable" => { - writeln!(w, "impl lightning::{} for {} {{", trait_path, for_obj).unwrap(); + "lightning::util::ser::Writeable" => { + writeln!(w, "impl {} for {} {{", trait_path, for_obj).unwrap(); writeln!(w, "\tfn write(&self, w: &mut W) -> Result<(), ::std::io::Error> {{").unwrap(); writeln!(w, "\t\tlet vec = (self.write)(self.this_arg);").unwrap(); writeln!(w, "\t\tw.write_all(vec.as_slice())").unwrap(); @@ -281,7 +233,7 @@ fn writeln_trait<'a, 'b, W: std::io::Write>(w: &mut W, t: &'a syn::ItemTrait, ty writeln!(w, "\t/// An opaque pointer which is passed to your function implementations as an argument.").unwrap(); writeln!(w, "\t/// This has no meaning in the LDK, and can be NULL or any other value.").unwrap(); writeln!(w, "\tpub this_arg: *mut c_void,").unwrap(); - let mut generated_fields = Vec::new(); // Every field's name except this_arg, used in Clone generation + let mut generated_fields = Vec::new(); // Every field's (name, is_clonable) except this_arg, used in Clone generation for item in t.items.iter() { match item { &syn::TraitItem::Method(ref m) => { @@ -296,8 +248,8 @@ fn writeln_trait<'a, 'b, W: std::io::Write>(w: &mut W, t: &'a syn::ItemTrait, ty } if m.default.is_some() { unimplemented!(); } - gen_types.push_ctx(); - assert!(gen_types.learn_generics(&m.sig.generics, types)); + let mut meth_gen_types = gen_types.push_ctx(); + assert!(meth_gen_types.learn_generics(&m.sig.generics, types)); writeln_docs(w, &m.attrs, "\t"); @@ -314,20 +266,19 @@ fn writeln_trait<'a, 'b, W: std::io::Write>(w: &mut W, t: &'a syn::ItemTrait, ty // happen) as well as provide an Option<>al function pointer which is // called when the trait method is called which allows updating on the fly. write!(w, "\tpub {}: ", m.sig.ident).unwrap(); - generated_fields.push(format!("{}", m.sig.ident)); - types.write_c_type(w, &*r.elem, Some(&gen_types), false); + generated_fields.push((format!("{}", m.sig.ident), true)); + types.write_c_type(w, &*r.elem, Some(&meth_gen_types), false); writeln!(w, ",").unwrap(); writeln!(w, "\t/// Fill in the {} field as a reference to it will be given to Rust after this returns", m.sig.ident).unwrap(); writeln!(w, "\t/// Note that this takes a pointer to this object, not the this_ptr like other methods do").unwrap(); writeln!(w, "\t/// This function pointer may be NULL if {} is filled in when this object is created and never needs updating.", m.sig.ident).unwrap(); writeln!(w, "\tpub set_{}: Option,", m.sig.ident, trait_name).unwrap(); - generated_fields.push(format!("set_{}", m.sig.ident)); + generated_fields.push((format!("set_{}", m.sig.ident), true)); // Note that cbindgen will now generate // typedef struct Thing {..., set_thing: (const Thing*), ...} Thing; // which does not compile since Thing is not defined before it is used. writeln!(extra_headers, "struct LDK{};", trait_name).unwrap(); writeln!(extra_headers, "typedef struct LDK{} LDK{};", trait_name, trait_name).unwrap(); - gen_types.pop_ctx(); continue; } // Sadly, this currently doesn't do what we want, but it should be easy to get @@ -336,36 +287,39 @@ fn writeln_trait<'a, 'b, W: std::io::Write>(w: &mut W, t: &'a syn::ItemTrait, ty } write!(w, "\tpub {}: extern \"C\" fn (", m.sig.ident).unwrap(); - generated_fields.push(format!("{}", m.sig.ident)); - write_method_params(w, &m.sig, "c_void", types, Some(&gen_types), true, false); + generated_fields.push((format!("{}", m.sig.ident), true)); + write_method_params(w, &m.sig, "c_void", types, Some(&meth_gen_types), true, false); writeln!(w, ",").unwrap(); - - gen_types.pop_ctx(); }, &syn::TraitItem::Type(_) => {}, _ => unimplemented!(), } } // Add functions which may be required for supertrait implementations. + let mut requires_clone = false; + walk_supertraits!(t, Some(&types), ( + ("Clone", _) => requires_clone = true, + (_, _) => {} + ) ); walk_supertraits!(t, Some(&types), ( ("Clone", _) => { writeln!(w, "\t/// Creates a copy of the object pointed to by this_arg, for a copy of this {}.", trait_name).unwrap(); writeln!(w, "\t/// Note that the ultimate copy of the {} will have all function pointers the same as the original.", trait_name).unwrap(); writeln!(w, "\t/// May be NULL if no action needs to be taken, the this_arg pointer will be copied into the new {}.", trait_name).unwrap(); writeln!(w, "\tpub clone: Option *mut c_void>,").unwrap(); - generated_fields.push("clone".to_owned()); + generated_fields.push(("clone".to_owned(), true)); }, ("std::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()); + generated_fields.push(("eq".to_owned(), true)); }, ("std::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(); - generated_fields.push("hash".to_owned()); + generated_fields.push(("hash".to_owned(), true)); }, ("Send", _) => {}, ("Sync", _) => {}, (s, i) => { @@ -373,20 +327,125 @@ fn writeln_trait<'a, 'b, W: std::io::Write>(w: &mut W, t: &'a syn::ItemTrait, ty let (docs, name, ret) = convert_trait_impl_field(s); writeln!(w, "\t/// {}", docs).unwrap(); writeln!(w, "\tpub {}: extern \"C\" fn (this_arg: *const c_void) -> {},", name, ret).unwrap(); - name + (name, true) // Assume clonable } else { // For in-crate supertraits, just store a C-mapped copy of the supertrait as a member. - writeln!(w, "/// Implementation of {} for this object.", i).unwrap(); + writeln!(w, "\t/// Implementation of {} for this object.", i).unwrap(); writeln!(w, "\tpub {}: crate::{},", i, s).unwrap(); - format!("{}", i) + let is_clonable = types.is_clonable(s); + if !is_clonable && requires_clone { + writeln!(w, "\t/// Creates a copy of the {}, for a copy of this {}.", i, trait_name).unwrap(); + writeln!(w, "\t/// Because {} doesn't natively support copying itself, you have to provide a full copy implementation here.", i).unwrap(); + writeln!(w, "\tpub {}_clone: extern \"C\" fn (orig_{}: &{}) -> {},", i, i, i, i).unwrap(); + } + (format!("{}", i), is_clonable) }); } ) ); writeln!(w, "\t/// Frees any resources associated with this object given its this_arg pointer.").unwrap(); writeln!(w, "\t/// Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.").unwrap(); writeln!(w, "\tpub free: Option,").unwrap(); - generated_fields.push("free".to_owned()); + generated_fields.push(("free".to_owned(), true)); writeln!(w, "}}").unwrap(); + + macro_rules! impl_trait_for_c { + ($t: expr, $impl_accessor: expr, $type_resolver: expr) => { + for item in $t.items.iter() { + match item { + syn::TraitItem::Method(m) => { + if let ExportStatus::TestOnly = export_status(&m.attrs) { continue; } + if m.default.is_some() { unimplemented!(); } + if m.sig.constness.is_some() || m.sig.asyncness.is_some() || m.sig.unsafety.is_some() || + m.sig.abi.is_some() || m.sig.variadic.is_some() { + unimplemented!(); + } + let mut meth_gen_types = gen_types.push_ctx(); + assert!(meth_gen_types.learn_generics(&m.sig.generics, $type_resolver)); + write!(w, "\tfn {}", m.sig.ident).unwrap(); + $type_resolver.write_rust_generic_param(w, Some(&meth_gen_types), m.sig.generics.params.iter()); + write!(w, "(").unwrap(); + for inp in m.sig.inputs.iter() { + match inp { + syn::FnArg::Receiver(recv) => { + if !recv.attrs.is_empty() || recv.reference.is_none() { unimplemented!(); } + write!(w, "&").unwrap(); + if let Some(lft) = &recv.reference.as_ref().unwrap().1 { + write!(w, "'{} ", lft.ident).unwrap(); + } + if recv.mutability.is_some() { + write!(w, "mut self").unwrap(); + } else { + write!(w, "self").unwrap(); + } + }, + syn::FnArg::Typed(arg) => { + if !arg.attrs.is_empty() { unimplemented!(); } + match &*arg.pat { + syn::Pat::Ident(ident) => { + if !ident.attrs.is_empty() || ident.by_ref.is_some() || + 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(); + } + _ => unimplemented!(), + } + $type_resolver.write_rust_type(w, Some(&meth_gen_types), &*arg.ty); + } + } + } + write!(w, ")").unwrap(); + match &m.sig.output { + syn::ReturnType::Type(_, rtype) => { + write!(w, " -> ").unwrap(); + $type_resolver.write_rust_type(w, Some(&meth_gen_types), &*rtype) + }, + _ => {}, + } + write!(w, " {{\n\t\t").unwrap(); + match export_status(&m.attrs) { + ExportStatus::NoExport => { + unimplemented!(); + }, + _ => {}, + } + if let syn::ReturnType::Type(_, rtype) = &m.sig.output { + if let syn::Type::Reference(r) = &**rtype { + assert_eq!(m.sig.inputs.len(), 1); // Must only take self! + writeln!(w, "if let Some(f) = self{}.set_{} {{", $impl_accessor, m.sig.ident).unwrap(); + writeln!(w, "\t\t\t(f)(&self{});", $impl_accessor).unwrap(); + write!(w, "\t\t}}\n\t\t").unwrap(); + $type_resolver.write_from_c_conversion_to_ref_prefix(w, &*r.elem, Some(&meth_gen_types)); + write!(w, "self{}.{}", $impl_accessor, m.sig.ident).unwrap(); + $type_resolver.write_from_c_conversion_to_ref_suffix(w, &*r.elem, Some(&meth_gen_types)); + writeln!(w, "\n\t}}").unwrap(); + continue; + } + } + write_method_var_decl_body(w, &m.sig, "\t", $type_resolver, Some(&meth_gen_types), true); + write!(w, "(self{}.{})(", $impl_accessor, m.sig.ident).unwrap(); + write_method_call_params(w, &m.sig, "\t", $type_resolver, Some(&meth_gen_types), "", true); + + writeln!(w, "\n\t}}").unwrap(); + }, + &syn::TraitItem::Type(ref t) => { + if t.default.is_some() || t.generics.lt_token.is_some() { unimplemented!(); } + let mut bounds_iter = t.bounds.iter(); + match bounds_iter.next().unwrap() { + syn::TypeParamBound::Trait(tr) => { + writeln!(w, "\ttype {} = crate::{};", t.ident, $type_resolver.resolve_path(&tr.path, Some(&gen_types))).unwrap(); + }, + _ => unimplemented!(), + } + if bounds_iter.next().is_some() { unimplemented!(); } + }, + _ => unimplemented!(), + } + } + } + } + + // Implement supertraits for the C-mapped struct. walk_supertraits!(t, Some(&types), ( ("Send", _) => writeln!(w, "unsafe impl Send for {} {{}}", trait_name).unwrap(), @@ -406,8 +465,13 @@ fn writeln_trait<'a, 'b, W: std::io::Write>(w: &mut W, t: &'a syn::ItemTrait, ty writeln!(w, "pub extern \"C\" fn {}_clone(orig: &{}) -> {} {{", trait_name, trait_name, trait_name).unwrap(); writeln!(w, "\t{} {{", trait_name).unwrap(); writeln!(w, "\t\tthis_arg: if let Some(f) = orig.clone {{ (f)(orig.this_arg) }} else {{ orig.this_arg }},").unwrap(); - for field in generated_fields.iter() { - writeln!(w, "\t\t{}: orig.{}.clone(),", field, field).unwrap(); + for (field, clonable) in generated_fields.iter() { + if *clonable { + writeln!(w, "\t\t{}: Clone::clone(&orig.{}),", field, field).unwrap(); + } else { + writeln!(w, "\t\t{}: (orig.{}_clone)(&orig.{}),", field, field, field).unwrap(); + writeln!(w, "\t\t{}_clone: orig.{}_clone,", field, field).unwrap(); + } } writeln!(w, "\t}}\n}}").unwrap(); writeln!(w, "impl Clone for {} {{", trait_name).unwrap(); @@ -416,109 +480,33 @@ fn writeln_trait<'a, 'b, W: std::io::Write>(w: &mut W, t: &'a syn::ItemTrait, ty writeln!(w, "\t}}\n}}").unwrap(); }, (s, i) => { - do_write_impl_trait(w, s, i, &trait_name); + if let Some(supertrait) = types.crate_types.traits.get(s) { + let mut module_iter = s.rsplitn(2, "::"); + module_iter.next().unwrap(); + let supertrait_module = module_iter.next().unwrap(); + let imports = ImportResolver::new(supertrait_module.splitn(2, "::").next().unwrap(), &types.crate_types.lib_ast.dependencies, + supertrait_module, &types.crate_types.lib_ast.modules.get(supertrait_module).unwrap().items); + let resolver = TypeResolver::new(&supertrait_module, imports, types.crate_types); + 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); + } } ) ); // Finally, implement the original Rust trait for the newly created mapped trait. - writeln!(w, "\nuse {}::{}::{} as rust{};", types.orig_crate, types.module_path, t.ident, trait_name).unwrap(); + 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(); - for item in t.items.iter() { - match item { - syn::TraitItem::Method(m) => { - if let ExportStatus::TestOnly = export_status(&m.attrs) { continue; } - if m.default.is_some() { unimplemented!(); } - if m.sig.constness.is_some() || m.sig.asyncness.is_some() || m.sig.unsafety.is_some() || - m.sig.abi.is_some() || m.sig.variadic.is_some() { - unimplemented!(); - } - gen_types.push_ctx(); - assert!(gen_types.learn_generics(&m.sig.generics, types)); - write!(w, "\tfn {}", m.sig.ident).unwrap(); - types.write_rust_generic_param(w, Some(&gen_types), m.sig.generics.params.iter()); - write!(w, "(").unwrap(); - for inp in m.sig.inputs.iter() { - match inp { - syn::FnArg::Receiver(recv) => { - if !recv.attrs.is_empty() || recv.reference.is_none() { unimplemented!(); } - write!(w, "&").unwrap(); - if let Some(lft) = &recv.reference.as_ref().unwrap().1 { - write!(w, "'{} ", lft.ident).unwrap(); - } - if recv.mutability.is_some() { - write!(w, "mut self").unwrap(); - } else { - write!(w, "self").unwrap(); - } - }, - syn::FnArg::Typed(arg) => { - if !arg.attrs.is_empty() { unimplemented!(); } - match &*arg.pat { - syn::Pat::Ident(ident) => { - if !ident.attrs.is_empty() || ident.by_ref.is_some() || - ident.mutability.is_some() || ident.subpat.is_some() { - unimplemented!(); - } - write!(w, ", {}{}: ", if types.skip_arg(&*arg.ty, Some(&gen_types)) { "_" } else { "" }, ident.ident).unwrap(); - } - _ => unimplemented!(), - } - types.write_rust_type(w, Some(&gen_types), &*arg.ty); - } - } - } - write!(w, ")").unwrap(); - match &m.sig.output { - syn::ReturnType::Type(_, rtype) => { - write!(w, " -> ").unwrap(); - types.write_rust_type(w, Some(&gen_types), &*rtype) - }, - _ => {}, - } - write!(w, " {{\n\t\t").unwrap(); - match export_status(&m.attrs) { - ExportStatus::NoExport => { - unimplemented!(); - }, - _ => {}, - } - if let syn::ReturnType::Type(_, rtype) = &m.sig.output { - if let syn::Type::Reference(r) = &**rtype { - assert_eq!(m.sig.inputs.len(), 1); // Must only take self! - writeln!(w, "if let Some(f) = self.set_{} {{", m.sig.ident).unwrap(); - writeln!(w, "\t\t\t(f)(self);").unwrap(); - write!(w, "\t\t}}\n\t\t").unwrap(); - types.write_from_c_conversion_to_ref_prefix(w, &*r.elem, Some(&gen_types)); - write!(w, "self.{}", m.sig.ident).unwrap(); - types.write_from_c_conversion_to_ref_suffix(w, &*r.elem, Some(&gen_types)); - writeln!(w, "\n\t}}").unwrap(); - gen_types.pop_ctx(); - continue; - } - } - write_method_var_decl_body(w, &m.sig, "\t", types, Some(&gen_types), true); - write!(w, "(self.{})(", m.sig.ident).unwrap(); - write_method_call_params(w, &m.sig, "\t", types, Some(&gen_types), "", true); - - writeln!(w, "\n\t}}").unwrap(); - gen_types.pop_ctx(); - }, - &syn::TraitItem::Type(ref t) => { - if t.default.is_some() || t.generics.lt_token.is_some() { unimplemented!(); } - let mut bounds_iter = t.bounds.iter(); - match bounds_iter.next().unwrap() { - syn::TypeParamBound::Trait(tr) => { - writeln!(w, "\ttype {} = crate::{};", t.ident, types.resolve_path(&tr.path, Some(&gen_types))).unwrap(); - }, - _ => unimplemented!(), - } - if bounds_iter.next().is_some() { unimplemented!(); } - }, - _ => unimplemented!(), - } - } + 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(); @@ -544,7 +532,7 @@ fn writeln_opaque(w: &mut W, ident: &syn::Ident, struct_name: // If we directly read the original type by its original name, cbindgen hits // https://github.com/eqrion/cbindgen/issues/286 Thus, instead, we import it as a temporary // name and then reference it by that name, which works around the issue. - write!(w, "\nuse {}::{}::{} as native{}Import;\ntype native{} = native{}Import", types.orig_crate, types.module_path, ident, ident, ident, ident).unwrap(); + write!(w, "\nuse {}::{} as native{}Import;\ntype native{} = native{}Import", types.module_path, ident, ident, ident, ident).unwrap(); maybe_write_generics(w, &generics, &types, true); writeln!(w, ";\n").unwrap(); writeln!(extra_headers, "struct native{}Opaque;\ntypedef struct native{}Opaque LDKnative{};", ident, ident, ident).unwrap(); @@ -615,7 +603,7 @@ fn writeln_struct<'a, 'b, W: std::io::Write>(w: &mut W, s: &'a syn::ItemStruct, write!(w, "#[no_mangle]\npub extern \"C\" fn {}_get_{}(this_ptr: &{}) -> ", struct_name, ident, struct_name).unwrap(); types.write_c_type(w, &ref_type, Some(&gen_types), true); write!(w, " {{\n\tlet mut inner_val = &mut unsafe {{ &mut *this_ptr.inner }}.{};\n\t", ident).unwrap(); - let local_var = types.write_to_c_conversion_new_var(w, &syn::Ident::new("inner_val", Span::call_site()), &ref_type, Some(&gen_types), true); + let local_var = types.write_to_c_conversion_new_var(w, &format_ident!("inner_val"), &ref_type, Some(&gen_types), true); if local_var { write!(w, "\n\t").unwrap(); } types.write_to_c_conversion_inline_prefix(w, &ref_type, Some(&gen_types), true); if local_var { @@ -632,7 +620,7 @@ fn writeln_struct<'a, 'b, W: std::io::Write>(w: &mut W, s: &'a syn::ItemStruct, write!(w, "#[no_mangle]\npub extern \"C\" fn {}_set_{}(this_ptr: &mut {}, mut val: ", struct_name, ident, struct_name).unwrap(); types.write_c_type(w, &field.ty, Some(&gen_types), false); write!(w, ") {{\n\t").unwrap(); - let local_var = types.write_from_c_conversion_new_var(w, &syn::Ident::new("val", Span::call_site()), &field.ty, Some(&gen_types)); + let local_var = types.write_from_c_conversion_new_var(w, &format_ident!("val"), &field.ty, Some(&gen_types)); if local_var { write!(w, "\n\t").unwrap(); } write!(w, "unsafe {{ &mut *this_ptr.inner }}.{} = ", ident).unwrap(); types.write_from_c_conversion_prefix(w, &field.ty, Some(&gen_types)); @@ -655,8 +643,8 @@ fn writeln_struct<'a, 'b, W: std::io::Write>(w: &mut W, s: &'a syn::ItemStruct, } write!(w, ") -> {} {{\n\t", struct_name).unwrap(); for field in fields.named.iter() { - let field_name = format!("{}_arg", field.ident.as_ref().unwrap()); - if types.write_from_c_conversion_new_var(w, &syn::Ident::new(&field_name, Span::call_site()), &field.ty, Some(&gen_types)) { + let field_ident = format_ident!("{}_arg", field.ident.as_ref().unwrap()); + if types.write_from_c_conversion_new_var(w, &field_ident, &field.ty, Some(&gen_types)) { write!(w, "\n\t").unwrap(); } } @@ -794,12 +782,12 @@ fn writeln_impl(w: &mut W, i: &syn::ItemImpl, types: &mut Typ if let syn::Type::Reference(r) = &**rtype { write!(w, "\n\t\t{}{}: ", $indent, $m.sig.ident).unwrap(); types.write_empty_rust_val(Some(&gen_types), w, &*r.elem); - writeln!(w, ",\n{}\t\tset_{}: Some({}_{}_set_{}),", $indent, $m.sig.ident, ident, trait_obj.ident, $m.sig.ident).unwrap(); + writeln!(w, ",\n{}\t\tset_{}: Some({}_{}_set_{}),", $indent, $m.sig.ident, ident, $trait.ident, $m.sig.ident).unwrap(); printed = true; } } if !printed { - write!(w, "{}\t\t{}: {}_{}_{},\n", $indent, $m.sig.ident, ident, trait_obj.ident, $m.sig.ident).unwrap(); + write!(w, "{}\t\t{}: {}_{}_{},\n", $indent, $m.sig.ident, ident, $trait.ident, $m.sig.ident).unwrap(); } } } @@ -811,6 +799,11 @@ fn writeln_impl(w: &mut W, i: &syn::ItemImpl, types: &mut Typ _ => {}, } } + let mut requires_clone = false; + walk_supertraits!(trait_obj, Some(&types), ( + ("Clone", _) => requires_clone = true, + (_, _) => {} + ) ); walk_supertraits!(trait_obj, Some(&types), ( ("Clone", _) => { writeln!(w, "\t\tclone: Some({}_clone_void),", ident).unwrap(); @@ -831,6 +824,9 @@ fn writeln_impl(w: &mut W, i: &syn::ItemImpl, types: &mut Typ } } write!(w, "\t\t}},\n").unwrap(); + if !types.is_clonable(s) && requires_clone { + writeln!(w, "\t\t{}_clone: {}_{}_clone,", t, ident, t).unwrap(); + } } else { write_trait_impl_field_assign(w, s, ident); } @@ -851,12 +847,12 @@ fn writeln_impl(w: &mut W, i: &syn::ItemImpl, types: &mut Typ if let syn::ReturnType::Type(_, _) = &$m.sig.output { writeln!(w, "#[must_use]").unwrap(); } - write!(w, "extern \"C\" fn {}_{}_{}(", ident, trait_obj.ident, $m.sig.ident).unwrap(); - gen_types.push_ctx(); - assert!(gen_types.learn_generics(&$m.sig.generics, types)); - write_method_params(w, &$m.sig, "c_void", types, Some(&gen_types), true, true); + write!(w, "extern \"C\" fn {}_{}_{}(", ident, $trait.ident, $m.sig.ident).unwrap(); + let mut meth_gen_types = gen_types.push_ctx(); + assert!(meth_gen_types.learn_generics(&$m.sig.generics, types)); + write_method_params(w, &$m.sig, "c_void", types, Some(&meth_gen_types), true, true); write!(w, " {{\n\t").unwrap(); - write_method_var_decl_body(w, &$m.sig, "", types, Some(&gen_types), false); + write_method_var_decl_body(w, &$m.sig, "", types, Some(&meth_gen_types), false); let mut takes_self = false; for inp in $m.sig.inputs.iter() { if let syn::FnArg::Receiver(_) = inp { @@ -870,9 +866,9 @@ fn writeln_impl(w: &mut W, i: &syn::ItemImpl, types: &mut Typ t_gen_args += "_" } if takes_self { - write!(w, ">::{}(unsafe {{ &mut *(this_arg as *mut native{}) }}, ", ident, types.orig_crate, $trait_path, t_gen_args, $m.sig.ident, ident).unwrap(); + write!(w, ">::{}(unsafe {{ &mut *(this_arg as *mut native{}) }}, ", ident, $trait_path, t_gen_args, $m.sig.ident, ident).unwrap(); } else { - write!(w, ">::{}(", ident, types.orig_crate, $trait_path, t_gen_args, $m.sig.ident).unwrap(); + write!(w, ">::{}(", ident, $trait_path, t_gen_args, $m.sig.ident).unwrap(); } let mut real_type = "".to_string(); @@ -886,19 +882,18 @@ fn writeln_impl(w: &mut W, i: &syn::ItemImpl, types: &mut Typ }, _ => {}, } - write_method_call_params(w, &$m.sig, "", types, Some(&gen_types), &real_type, false); - gen_types.pop_ctx(); + write_method_call_params(w, &$m.sig, "", types, Some(&meth_gen_types), &real_type, false); write!(w, "\n}}\n").unwrap(); if let syn::ReturnType::Type(_, rtype) = &$m.sig.output { if let syn::Type::Reference(r) = &**rtype { assert_eq!($m.sig.inputs.len(), 1); // Must only take self - writeln!(w, "extern \"C\" fn {}_{}_set_{}(trait_self_arg: &{}) {{", ident, trait_obj.ident, $m.sig.ident, trait_obj.ident).unwrap(); + writeln!(w, "extern \"C\" fn {}_{}_set_{}(trait_self_arg: &{}) {{", ident, $trait.ident, $m.sig.ident, $trait.ident).unwrap(); writeln!(w, "\t// This is a bit race-y in the general case, but for our specific use-cases today, we're safe").unwrap(); writeln!(w, "\t// Specifically, we must ensure that the first time we're called it can never be in parallel").unwrap(); write!(w, "\tif ").unwrap(); - types.write_empty_rust_val_check(Some(&gen_types), w, &*r.elem, &format!("trait_self_arg.{}", $m.sig.ident)); + types.write_empty_rust_val_check(Some(&meth_gen_types), w, &*r.elem, &format!("trait_self_arg.{}", $m.sig.ident)); writeln!(w, " {{").unwrap(); - writeln!(w, "\t\tunsafe {{ &mut *(trait_self_arg as *const {} as *mut {}) }}.{} = {}_{}_{}(trait_self_arg.this_arg);", trait_obj.ident, trait_obj.ident, $m.sig.ident, ident, trait_obj.ident, $m.sig.ident).unwrap(); + writeln!(w, "\t\tunsafe {{ &mut *(trait_self_arg as *const {} as *mut {}) }}.{} = {}_{}_{}(trait_self_arg.this_arg);", $trait.ident, $trait.ident, $m.sig.ident, ident, $trait.ident, $m.sig.ident).unwrap(); writeln!(w, "\t}}").unwrap(); writeln!(w, "}}").unwrap(); } @@ -916,15 +911,22 @@ fn writeln_impl(w: &mut W, i: &syn::ItemImpl, types: &mut Typ } } walk_supertraits!(trait_obj, Some(&types), ( - (s, _) => { - if let Some(supertrait_obj) = types.crate_types.traits.get(s).cloned() { - for item in supertrait_obj.items.iter() { - match item { - syn::TraitItem::Method(m) => { - impl_meth!(m, s, supertrait_obj, "\t"); - }, - _ => {}, + (s, t) => { + if let Some(supertrait_obj) = types.crate_types.traits.get(s) { + if !types.is_clonable(s) && requires_clone { + writeln!(w, "extern \"C\" fn {}_{}_clone(orig: &crate::{}) -> crate::{} {{", ident, t, s, s).unwrap(); + writeln!(w, "\tcrate::{} {{", s).unwrap(); + writeln!(w, "\t\tthis_arg: orig.this_arg,").unwrap(); + writeln!(w, "\t\tfree: None,").unwrap(); + for item in supertrait_obj.items.iter() { + match item { + syn::TraitItem::Method(m) => { + write_meth!(m, supertrait_obj, ""); + }, + _ => {}, + } } + write!(w, "\t}}\n}}\n").unwrap(); } } } @@ -982,11 +984,11 @@ fn writeln_impl(w: &mut W, i: &syn::ItemImpl, types: &mut Typ DeclType::StructImported => format!("{}", ident), _ => unimplemented!(), }; - gen_types.push_ctx(); - assert!(gen_types.learn_generics(&m.sig.generics, types)); - write_method_params(w, &m.sig, &ret_type, types, Some(&gen_types), false, true); + let mut meth_gen_types = gen_types.push_ctx(); + assert!(meth_gen_types.learn_generics(&m.sig.generics, types)); + write_method_params(w, &m.sig, &ret_type, types, Some(&meth_gen_types), false, true); write!(w, " {{\n\t").unwrap(); - write_method_var_decl_body(w, &m.sig, "", types, Some(&gen_types), false); + 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; for inp in m.sig.inputs.iter() { @@ -1000,10 +1002,9 @@ fn writeln_impl(w: &mut W, i: &syn::ItemImpl, types: &mut Typ } else if takes_self { write!(w, "unsafe {{ &*this_arg.inner }}.{}(", m.sig.ident).unwrap(); } else { - write!(w, "{}::{}::{}(", types.orig_crate, resolved_path, m.sig.ident).unwrap(); + write!(w, "{}::{}(", resolved_path, m.sig.ident).unwrap(); } - write_method_call_params(w, &m.sig, "", types, Some(&gen_types), &ret_type, false); - gen_types.pop_ctx(); + write_method_call_params(w, &m.sig, "", types, Some(&meth_gen_types), &ret_type, false); writeln!(w, "\n}}\n").unwrap(); } }, @@ -1127,7 +1128,7 @@ fn writeln_enum<'a, 'b, W: std::io::Write>(w: &mut W, e: &'a syn::ItemEnum, type if var.discriminant.is_some() { unimplemented!(); } writeln!(w, ",").unwrap(); } - writeln!(w, "}}\nuse {}::{}::{} as native{};\nimpl {} {{", types.orig_crate, types.module_path, e.ident, e.ident, e.ident).unwrap(); + writeln!(w, "}}\nuse {}::{} as native{};\nimpl {} {{", types.module_path, e.ident, e.ident, e.ident).unwrap(); macro_rules! write_conv { ($fn_sig: expr, $to_c: expr, $ref: expr) => { @@ -1165,7 +1166,7 @@ fn writeln_enum<'a, 'b, W: std::io::Write>(w: &mut W, e: &'a syn::ItemEnum, type if $ref { write!(w, "let mut {}_nonref = (*{}).clone();\n\t\t\t\t", $field_ident, $field_ident).unwrap(); if new_var { - let nonref_ident = syn::Ident::new(&format!("{}_nonref", $field_ident), Span::call_site()); + 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); } else { @@ -1187,7 +1188,7 @@ 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, &syn::Ident::new(&(('a' as u8 + idx as u8) as char).to_string(), Span::call_site())); + handle_field_a!(field, &format_ident!("{}", ('a' as u8 + idx as u8) as char)); } } else { write!(w, " ").unwrap(); } @@ -1225,7 +1226,7 @@ fn writeln_enum<'a, 'b, W: std::io::Write>(w: &mut W, e: &'a syn::ItemEnum, type write!(w, " (").unwrap(); for (idx, field) in fields.unnamed.iter().enumerate() { write!(w, "\n\t\t\t\t\t").unwrap(); - handle_field_b!(field, &syn::Ident::new(&(('a' as u8 + idx as u8) as char).to_string(), Span::call_site())); + handle_field_b!(field, &format_ident!("{}", ('a' as u8 + idx as u8) as char)); } writeln!(w, "\n\t\t\t\t)").unwrap(); write!(w, "\t\t\t}}").unwrap(); @@ -1268,7 +1269,7 @@ fn writeln_fn<'a, 'b, W: std::io::Write>(w: &mut W, f: &'a syn::ItemFn, types: & write_method_params(w, &f.sig, "", types, Some(&gen_types), false, true); write!(w, " {{\n\t").unwrap(); write_method_var_decl_body(w, &f.sig, "", types, Some(&gen_types), false); - write!(w, "{}::{}::{}(", types.orig_crate, types.module_path, f.sig.ident).unwrap(); + write!(w, "{}::{}(", types.module_path, f.sig.ident).unwrap(); write_method_call_params(w, &f.sig, "", types, Some(&gen_types), "", false); writeln!(w, "\n}}\n").unwrap(); } @@ -1276,58 +1277,13 @@ fn writeln_fn<'a, 'b, W: std::io::Write>(w: &mut W, f: &'a syn::ItemFn, types: & // ******************************** // *** File/Crate Walking Logic *** // ******************************** -/// A public module -struct ASTModule { - pub attrs: Vec, - pub items: Vec, - pub submods: Vec, -} -/// A struct containing the syn::File AST for each file in the crate. -struct FullLibraryAST { - modules: HashMap, -} -impl FullLibraryAST { - fn load_module(&mut self, module: String, attrs: Vec, mut items: Vec) { - let mut non_mod_items = Vec::with_capacity(items.len()); - let mut submods = Vec::with_capacity(items.len()); - for item in items.drain(..) { - match item { - syn::Item::Mod(m) if m.content.is_some() => { - if export_status(&m.attrs) == ExportStatus::Export { - if let syn::Visibility::Public(_) = m.vis { - let modident = format!("{}", m.ident); - let modname = if module != "" { - module.clone() + "::" + &modident - } else { - modident.clone() - }; - self.load_module(modname, m.attrs, m.content.unwrap().1); - submods.push(modident); - } else { - non_mod_items.push(syn::Item::Mod(m)); - } - } - }, - syn::Item::Mod(_) => panic!("--pretty=expanded output should never have non-body modules"), - _ => { non_mod_items.push(item); } - } - } - self.modules.insert(module, ASTModule { attrs, items: non_mod_items, submods }); - } - - pub fn load_lib(lib: syn::File) -> Self { - assert_eq!(export_status(&lib.attrs), ExportStatus::Export); - let mut res = Self { modules: HashMap::default() }; - res.load_module("".to_owned(), lib.attrs, lib.items); - res - } -} /// 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. -fn convert_file<'a, 'b>(libast: &'a FullLibraryAST, crate_types: &mut CrateTypes<'a>, out_dir: &str, orig_crate: &str, header_file: &mut File, cpp_header_file: &mut File) { +fn convert_file<'a, 'b>(libast: &'a FullLibraryAST, crate_types: &CrateTypes<'a>, out_dir: &str, header_file: &mut File, cpp_header_file: &mut File) { for (module, astmod) in libast.modules.iter() { + let orig_crate = module.splitn(2, "::").next().unwrap(); let ASTModule { ref attrs, ref items, ref submods } = astmod; assert_eq!(export_status(&attrs), ExportStatus::Export); @@ -1342,11 +1298,21 @@ fn convert_file<'a, 'b>(libast: &'a FullLibraryAST, crate_types: &mut CrateTypes let mut out = std::fs::OpenOptions::new().write(true).create(true).truncate(true) .open(new_file_path).expect("Unable to open new src file"); + writeln!(out, "// This file is Copyright its original authors, visible in version control").unwrap(); + writeln!(out, "// history and in the source files from which this was generated.").unwrap(); + writeln!(out, "//").unwrap(); + writeln!(out, "// This file is licensed under the license available in the LICENSE or LICENSE.md").unwrap(); + writeln!(out, "// file in the root of this repository or, if no such file exists, the same").unwrap(); + writeln!(out, "// license as that which applies to the original source files from which this").unwrap(); + writeln!(out, "// source was automatically generated.").unwrap(); + writeln!(out, "").unwrap(); + writeln_docs(&mut out, &attrs, ""); if module == "" { // Special-case the top-level lib.rs with various lint allows and a pointer to the c_types // and bitcoin hand-written modules. + writeln!(out, "//! C Bindings").unwrap(); writeln!(out, "#![allow(unknown_lints)]").unwrap(); writeln!(out, "#![allow(non_camel_case_types)]").unwrap(); writeln!(out, "#![allow(non_snake_case)]").unwrap(); @@ -1357,8 +1323,8 @@ fn convert_file<'a, 'b>(libast: &'a FullLibraryAST, crate_types: &mut CrateTypes writeln!(out, "#![allow(unused_unsafe)]").unwrap(); writeln!(out, "#![allow(unused_braces)]").unwrap(); writeln!(out, "#![deny(missing_docs)]").unwrap(); - writeln!(out, "mod c_types;").unwrap(); - writeln!(out, "mod bitcoin;").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(); } @@ -1369,8 +1335,8 @@ fn convert_file<'a, 'b>(libast: &'a FullLibraryAST, crate_types: &mut CrateTypes eprintln!("Converting {} entries...", module); - let import_resolver = ImportResolver::new(module, items); - let mut type_resolver = TypeResolver::new(orig_crate, module, import_resolver, crate_types); + let import_resolver = ImportResolver::new(orig_crate, &libast.dependencies, module, items); + let mut type_resolver = TypeResolver::new(module, import_resolver, crate_types); for item in items.iter() { match item { @@ -1403,7 +1369,7 @@ fn convert_file<'a, 'b>(libast: &'a FullLibraryAST, crate_types: &mut CrateTypes if type_resolver.is_primitive(&resolved_path) { writeln_docs(&mut out, &c.attrs, ""); writeln!(out, "\n#[no_mangle]").unwrap(); - writeln!(out, "pub static {}: {} = {}::{}::{};", c.ident, resolved_path, orig_crate, module, c.ident).unwrap(); + writeln!(out, "pub static {}: {} = {}::{};", c.ident, resolved_path, module, c.ident).unwrap(); } } } @@ -1434,11 +1400,7 @@ fn convert_file<'a, 'b>(libast: &'a FullLibraryAST, crate_types: &mut CrateTypes writeln_fn(&mut out, &f, &mut type_resolver); } }, - syn::Item::Macro(m) => { - if m.ident.is_none() { // If its not a macro definition - convert_macro(&mut out, &m.mac.path, &m.mac.tokens, &type_resolver); - } - }, + syn::Item::Macro(_) => {}, syn::Item::Verbatim(_) => {}, syn::Item::ExternCrate(_) => {}, _ => unimplemented!(), @@ -1449,11 +1411,11 @@ fn convert_file<'a, 'b>(libast: &'a FullLibraryAST, crate_types: &mut CrateTypes } } -fn walk_private_mod<'a>(module: String, items: &'a syn::ItemMod, crate_types: &mut CrateTypes<'a>) { - let import_resolver = ImportResolver::new(&module, &items.content.as_ref().unwrap().1); +fn walk_private_mod<'a>(ast_storage: &'a FullLibraryAST, orig_crate: &str, module: String, items: &'a syn::ItemMod, crate_types: &mut CrateTypes<'a>) { + let import_resolver = ImportResolver::new(orig_crate, &ast_storage.dependencies, &module, &items.content.as_ref().unwrap().1); for item in items.content.as_ref().unwrap().1.iter() { match item { - syn::Item::Mod(m) => walk_private_mod(format!("{}::{}", module, m.ident), m, crate_types), + syn::Item::Mod(m) => walk_private_mod(ast_storage, orig_crate, format!("{}::{}", module, m.ident), m, crate_types), syn::Item::Impl(i) => { if let &syn::Type::Path(ref p) = &*i.self_ty { if let Some(trait_path) = i.trait_.as_ref() { @@ -1478,7 +1440,8 @@ fn walk_ast<'a>(ast_storage: &'a FullLibraryAST, crate_types: &mut CrateTypes<'a for (module, astmod) in ast_storage.modules.iter() { let ASTModule { ref attrs, ref items, submods: _ } = astmod; assert_eq!(export_status(&attrs), ExportStatus::Export); - let import_resolver = ImportResolver::new(module, items); + let orig_crate = module.splitn(2, "::").next().unwrap(); + let import_resolver = ImportResolver::new(orig_crate, &ast_storage.dependencies, module, items); for item in items.iter() { match item { @@ -1501,7 +1464,7 @@ fn walk_ast<'a>(ast_storage: &'a FullLibraryAST, crate_types: &mut CrateTypes<'a let trait_path = format!("{}::{}", module, t.ident); walk_supertraits!(t, None, ( ("Clone", _) => { - crate_types.clonable_types.insert("crate::".to_owned() + &trait_path); + crate_types.set_clonable("crate::".to_owned() + &trait_path); }, (_, _) => {} ) ); @@ -1523,20 +1486,17 @@ fn walk_ast<'a>(ast_storage: &'a FullLibraryAST, crate_types: &mut CrateTypes<'a if process_alias { match &*t.ty { syn::Type::Path(p) => { + let t_ident = &t.ident; + // If its a path with no generics, assume we don't map the aliased type and map it opaque - let mut segments = syn::punctuated::Punctuated::new(); - segments.push(syn::PathSegment { - ident: t.ident.clone(), - arguments: syn::PathArguments::None, - }); - let path_obj = syn::Path { leading_colon: None, segments }; + let path_obj = parse_quote!(#t_ident); let args_obj = p.path.segments.last().unwrap().arguments.clone(); match crate_types.reverse_alias_map.entry(import_resolver.maybe_resolve_path(&p.path, None).unwrap()) { hash_map::Entry::Occupied(mut e) => { e.get_mut().push((path_obj, args_obj)); }, hash_map::Entry::Vacant(e) => { e.insert(vec![(path_obj, args_obj)]); }, } - crate_types.opaques.insert(type_path.clone(), &t.ident); + crate_types.opaques.insert(type_path, t_ident); }, _ => { crate_types.type_aliases.insert(type_path, import_resolver.resolve_imported_refs((*t.ty).clone())); @@ -1570,7 +1530,7 @@ fn walk_ast<'a>(ast_storage: &'a FullLibraryAST, crate_types: &mut CrateTypes<'a if let Some(trait_path) = i.trait_.as_ref() { if path_matches_nongeneric(&trait_path.1, &["core", "clone", "Clone"]) { if let Some(full_path) = import_resolver.maybe_resolve_path(&p.path, None) { - crate_types.clonable_types.insert("crate::".to_owned() + &full_path); + crate_types.set_clonable("crate::".to_owned() + &full_path); } } if let Some(tp) = import_resolver.maybe_resolve_path(&trait_path.1, None) { @@ -1584,7 +1544,7 @@ fn walk_ast<'a>(ast_storage: &'a FullLibraryAST, crate_types: &mut CrateTypes<'a } } }, - syn::Item::Mod(m) => walk_private_mod(format!("{}::{}", module, m.ident), m, crate_types), + syn::Item::Mod(m) => walk_private_mod(ast_storage, orig_crate, format!("{}::{}", module, m.ident), m, crate_types), _ => {}, } } @@ -1593,17 +1553,17 @@ fn walk_ast<'a>(ast_storage: &'a FullLibraryAST, crate_types: &mut CrateTypes<'a fn main() { let args: Vec = env::args().collect(); - if args.len() != 6 { - eprintln!("Usage: target/dir source_crate_name derived_templates.rs extra/includes.h extra/cpp/includes.hpp"); + if args.len() != 5 { + eprintln!("Usage: target/dir derived_templates.rs extra/includes.h extra/cpp/includes.hpp"); process::exit(1); } let mut derived_templates = std::fs::OpenOptions::new().write(true).create(true).truncate(true) - .open(&args[3]).expect("Unable to open new header file"); + .open(&args[2]).expect("Unable to open new header file"); let mut header_file = std::fs::OpenOptions::new().write(true).create(true).truncate(true) - .open(&args[4]).expect("Unable to open new header file"); + .open(&args[3]).expect("Unable to open new header file"); let mut cpp_header_file = std::fs::OpenOptions::new().write(true).create(true).truncate(true) - .open(&args[5]).expect("Unable to open new header file"); + .open(&args[4]).expect("Unable to open new header file"); writeln!(header_file, "#if defined(__GNUC__)").unwrap(); writeln!(header_file, "#define MUST_USE_STRUCT __attribute__((warn_unused))").unwrap(); @@ -1628,18 +1588,15 @@ fn main() { // ...then walk the ASTs tracking what types we will map, and how, so that we can resolve them // when parsing other file ASTs... - let mut libtypes = CrateTypes { traits: HashMap::new(), opaques: HashMap::new(), mirrored_enums: HashMap::new(), - type_aliases: HashMap::new(), reverse_alias_map: HashMap::new(), templates_defined: HashMap::default(), - template_file: &mut derived_templates, - clonable_types: HashSet::new(), trait_impls: HashMap::new() }; + let mut libtypes = CrateTypes::new(&mut derived_templates, &libast); walk_ast(&libast, &mut libtypes); // ... finally, do the actual file conversion/mapping, writing out types as we go. - convert_file(&libast, &mut libtypes, &args[1], &args[2], &mut header_file, &mut cpp_header_file); + convert_file(&libast, &libtypes, &args[1], &mut header_file, &mut cpp_header_file); // For container templates which we created while walking the crate, make sure we add C++ // mapped types so that C++ users can utilize the auto-destructors available. - for (ty, has_destructor) in libtypes.templates_defined.iter() { + for (ty, has_destructor) in libtypes.templates_defined.borrow().iter() { write_cpp_wrapper(&mut cpp_header_file, ty, *has_destructor); } writeln!(cpp_header_file, "}}").unwrap();