X-Git-Url: http://git.bitcoin.ninja/index.cgi?p=ldk-c-bindings;a=blobdiff_plain;f=c-bindings-gen%2Fsrc%2Fmain.rs;h=7e77810c361398f4f27a2cb0936ce66e2a4c8a77;hp=87ae6215ab7205a70c87f5620f9a11bc0dc82087;hb=0dcc7fcda393868ee8760fc48ac37f46b2cdf5eb;hpb=379be5837d69fe90c5802dc1fc9178933529e0c5 diff --git a/c-bindings-gen/src/main.rs b/c-bindings-gen/src/main.rs index 87ae621..7e77810 100644 --- a/c-bindings-gen/src/main.rs +++ b/c-bindings-gen/src/main.rs @@ -18,19 +18,39 @@ //! 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::Span; +use quote::format_ident; +use syn::parse_quote; mod types; mod blocks; use types::*; use blocks::*; +const DEFAULT_IMPORTS: &'static str = " +use alloc::str::FromStr; +use core::ffi::c_void; +use core::convert::Infallible; +use bitcoin::hashes::Hash; +use crate::c_types::*; +#[cfg(feature=\"no-std\")] +use alloc::{vec::Vec, boxed::Box}; +"; + + +/// str.rsplit_once but with an older MSRV +fn rsplit_once<'a>(inp: &'a str, pattern: &str) -> Option<(&'a str, &'a str)> { + let mut iter = inp.rsplitn(2, pattern); + let second_entry = iter.next().unwrap(); + Some((iter.next().unwrap(), second_entry)) +} + // ************************************* // *** Manually-expanded conversions *** // ************************************* @@ -42,11 +62,10 @@ fn maybe_convert_trait_impl(w: &mut W, trait_path: &syn::Path let full_obj_path; let mut has_inner = false; if let syn::Type::Path(ref p) = for_ty { - if let Some(ident) = single_ident_generic_path_to_ident(&p.path) { - for_obj = format!("{}", ident); - full_obj_path = for_obj.clone(); - has_inner = types.c_type_has_inner_from_path(&types.resolve_path(&p.path, Some(generics))); - } else { return; } + let resolved_path = types.resolve_path(&p.path, Some(generics)); + for_obj = format!("{}", p.path.segments.last().unwrap().ident); + full_obj_path = format!("crate::{}", resolved_path); + has_inner = types.c_type_has_inner_from_path(&resolved_path); } else { // We assume that anything that isn't a Path is somehow a generic that ends up in our // derived-types module. @@ -58,15 +77,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)); @@ -82,68 +99,80 @@ 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"|"lightning::util::ser::MaybeReadable" => { // 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 mut 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" { - write!(w, ", arg: ").unwrap(); + if t == "lightning::util::ser::ReadableArgs" { assert!(trait_path.leading_colon.is_none()); let args_seg = trait_path.segments.iter().last().unwrap(); assert_eq!(format!("{}", args_seg.ident), "ReadableArgs"); if let syn::PathArguments::AngleBracketed(args) = &args_seg.arguments { assert_eq!(args.args.len(), 1); if let syn::GenericArgument::Type(args_ty) = args.args.iter().next().unwrap() { - types.write_c_type(w, args_ty, Some(generics), false); + macro_rules! write_arg_conv { + ($ty: expr, $arg_name: expr) => { + write!(w, ", {}: ", $arg_name).unwrap(); + types.write_c_type(w, $ty, Some(generics), false); + + write!(&mut arg_conv, "\t").unwrap(); + if types.write_from_c_conversion_new_var(&mut arg_conv, &format_ident!("{}", $arg_name), &$ty, Some(generics)) { + write!(&mut arg_conv, "\n\t").unwrap(); + } - assert!(!types.write_from_c_conversion_new_var(&mut arg_conv, &syn::Ident::new("arg", Span::call_site()), &args_ty, Some(generics))); + write!(&mut arg_conv, "let {}_conv = ", $arg_name).unwrap(); + types.write_from_c_conversion_prefix(&mut arg_conv, &$ty, Some(generics)); + write!(&mut arg_conv, "{}", $arg_name).unwrap(); + types.write_from_c_conversion_suffix(&mut arg_conv, &$ty, Some(generics)); + write!(&mut arg_conv, ";\n").unwrap(); + } + } - write!(&mut arg_conv, "\tlet arg_conv = ").unwrap(); - types.write_from_c_conversion_prefix(&mut arg_conv, &args_ty, Some(generics)); - write!(&mut arg_conv, "arg").unwrap(); - types.write_from_c_conversion_suffix(&mut arg_conv, &args_ty, Some(generics)); + if let syn::Type::Tuple(tup) = args_ty { + // Crack open tuples and make them separate arguments instead of + // converting the full tuple. This makes it substantially easier to + // reason about things like references in the tuple fields. + let mut arg_conv_res = Vec::new(); + for (idx, elem) in tup.elems.iter().enumerate() { + let arg_name = format!("arg_{}", ('a' as u8 + idx as u8) as char); + write_arg_conv!(elem, arg_name); + write!(&mut arg_conv_res, "{}_conv{}", arg_name, if idx != tup.elems.len() - 1 { ", " } else { "" }).unwrap(); + } + writeln!(&mut arg_conv, "\tlet arg_conv = ({});", String::from_utf8(arg_conv_res).unwrap()).unwrap(); + } else { + write_arg_conv!(args_ty, "arg"); + } } else { unreachable!(); } } else { unreachable!(); } + } else if t == "lightning::util::ser::MaybeReadable" { + res_ty = parse_quote!(Result, ::ln::msgs::DecodeError>); } write!(w, ") -> ").unwrap(); 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. - types.write_rust_type(w, Some(generics), &res_ty); + } + + write!(w, "\tlet res: ").unwrap(); + // At least in one case we need type annotations here, so provide them. + types.write_rust_type(w, Some(generics), &res_ty); + + if t == "lightning::util::ser::ReadableArgs" { writeln!(w, " = crate::c_types::deserialize_obj_arg(ser, arg_conv);").unwrap(); + } else if t == "lightning::util::ser::MaybeReadable" { + writeln!(w, " = crate::c_types::maybe_deserialize_obj(ser);").unwrap(); } else { - writeln!(w, "\tlet res = crate::c_types::deserialize_obj(ser);").unwrap(); + writeln!(w, " = 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); @@ -162,7 +191,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!(), } } @@ -171,7 +200,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!(), @@ -180,11 +209,10 @@ 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) { -eprintln!("{}", trait_path); match trait_path { - "util::ser::Writeable" => { - writeln!(w, "impl lightning::{} for {} {{", trait_path, for_obj).unwrap(); - writeln!(w, "\tfn write(&self, w: &mut W) -> Result<(), ::std::io::Error> {{").unwrap(); + "lightning::util::ser::Writeable" => { + writeln!(w, "impl {} for {} {{", trait_path, for_obj).unwrap(); + writeln!(w, "\tfn write(&self, w: &mut W) -> Result<(), crate::c_types::io::Error> {{").unwrap(); writeln!(w, "\t\tlet vec = (self.write)(self.this_arg);").unwrap(); writeln!(w, "\t\tw.write_all(vec.as_slice())").unwrap(); writeln!(w, "\t}}\n}}").unwrap(); @@ -193,11 +221,16 @@ eprintln!("{}", trait_path); } } +/// Returns true if an instance of the given type must never exist +fn is_type_unconstructable(path: &str) -> bool { + path == "core::convert::Infallible" || path == "crate::c_types::NotConstructable" +} + // ******************************* // *** 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 { @@ -211,14 +244,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"); @@ -230,6 +263,18 @@ macro_rules! walk_supertraits { ($t: expr, $types: expr, ($( $pat: pat => $e: ex } } } } +macro_rules! get_module_type_resolver { + ($module: expr, $crate_libs: expr, $crate_types: expr) => { { + let module: &str = &$module; + let mut module_iter = module.rsplitn(2, "::"); + module_iter.next().unwrap(); + let module = module_iter.next().unwrap(); + let imports = ImportResolver::new(module.splitn(2, "::").next().unwrap(), &$crate_types.lib_ast.dependencies, + module, &$crate_types.lib_ast.modules.get(module).unwrap().items); + TypeResolver::new(module, imports, $crate_types) + } } +} + /// Prints a C-mapped trait object containing a void pointer and a jump table for each function in /// the original trait. /// Implements the native Rust trait and relevant parent traits for the new C-mapped trait. @@ -238,13 +283,31 @@ 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); + + // Add functions which may be required for supertrait implementations. + // Due to borrow checker limitations, we only support one in-crate supertrait here. + let supertrait_name; + let supertrait_resolver; + walk_supertraits!(t, Some(&types), ( + (s, _i) => { + if let Some(supertrait) = types.crate_types.traits.get(s) { + supertrait_name = s.to_string(); + supertrait_resolver = get_module_type_resolver!(supertrait_name, types.crate_libs, types.crate_types); + gen_types.learn_associated_types(&supertrait, &supertrait_resolver); + break; + } + } + ) ); + assert!(gen_types.learn_generics(&t.generics, types)); gen_types.learn_associated_types(&t, types); @@ -252,7 +315,9 @@ 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, is_clonable) except this_arg, used in Clone generation + // We store every field's (name, Option, docs) except this_arg, used in Clone generation + // docs is only set if its a function which should be callable on the object itself in C++ + let mut generated_fields = Vec::new(); for item in t.items.iter() { match item { &syn::TraitItem::Method(ref m) => { @@ -264,13 +329,13 @@ 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!(); } - 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"); + writeln_fn_docs(w, &m.attrs, "\t", types, Some(&meth_gen_types), m.sig.inputs.iter(), &m.sig.output); if let syn::ReturnType::Type(_, rtype) = &m.sig.output { if let syn::Type::Reference(r) = &**rtype { @@ -285,20 +350,18 @@ 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), true)); - types.write_c_type(w, &*r.elem, Some(&gen_types), false); + generated_fields.push((format!("{}", m.sig.ident), None, None)); + 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), true)); + generated_fields.push((format!("set_{}", m.sig.ident), None, None)); // Note that cbindgen will now generate - // typedef struct Thing {..., set_thing: (const Thing*), ...} Thing; + // typedef struct Thing {..., set_thing: (const struct 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 @@ -306,90 +369,98 @@ fn writeln_trait<'a, 'b, W: std::io::Write>(w: &mut W, t: &'a syn::ItemTrait, ty writeln!(w, "\t#[must_use]").unwrap(); } + let mut cpp_docs = Vec::new(); + writeln_fn_docs(&mut cpp_docs, &m.attrs, "\t * ", types, Some(&meth_gen_types), m.sig.inputs.iter(), &m.sig.output); + let docs_string = "\t/**\n".to_owned() + &String::from_utf8(cpp_docs).unwrap().replace("///", "") + "\t */\n"; + write!(w, "\tpub {}: extern \"C\" fn (", m.sig.ident).unwrap(); - generated_fields.push((format!("{}", m.sig.ident), true)); - write_method_params(w, &m.sig, "c_void", types, Some(&gen_types), true, false); + generated_fields.push((format!("{}", m.sig.ident), None, Some(docs_string))); + 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(), true)); + writeln!(w, "\t/// Called, if set, after this {} has been cloned into a duplicate object.", trait_name).unwrap(); + writeln!(w, "\t/// The new {} is provided, and should be mutated as needed to perform a", trait_name).unwrap(); + writeln!(w, "\t/// deep copy of the object pointed to by this_arg or avoid any double-freeing.").unwrap(); + writeln!(w, "\tpub cloned: Option,", trait_name, trait_name).unwrap(); + generated_fields.push(("cloned".to_owned(), None, None)); }, - ("std::cmp::Eq", _) => { - writeln!(w, "\t/// Checks if two objects are equal given this object's this_arg pointer and another object.").unwrap(); + ("std::cmp::Eq", _)|("core::cmp::Eq", _) => { + let eq_docs = "Checks if two objects are equal given this object's this_arg pointer and another object."; + writeln!(w, "\t/// {}", eq_docs).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)); + generated_fields.push(("eq".to_owned(), None, Some(format!("\t/** {} */\n", eq_docs)))); }, - ("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(); + ("std::hash::Hash", _)|("core::hash::Hash", _) => { + let hash_docs_a = "Calculate a succinct non-cryptographic hash for an object given its this_arg pointer."; + let hash_docs_b = "This is used, for example, for inclusion of this object in a hash map."; + writeln!(w, "\t/// {}", hash_docs_a).unwrap(); + writeln!(w, "\t/// {}", hash_docs_b).unwrap(); writeln!(w, "\tpub hash: extern \"C\" fn (this_arg: *const c_void) -> u64,").unwrap(); - generated_fields.push(("hash".to_owned(), true)); + generated_fields.push(("hash".to_owned(), None, + Some(format!("\t/**\n\t * {}\n\t * {}\n\t */\n", hash_docs_a, hash_docs_b)))); }, ("Send", _) => {}, ("Sync", _) => {}, + ("std::fmt::Debug", _)|("core::fmt::Debug", _) => { + let debug_docs = "Return a human-readable \"debug\" string describing this object"; + writeln!(w, "\t/// {}", debug_docs).unwrap(); + writeln!(w, "\tpub debug_str: extern \"C\" fn (this_arg: *const c_void) -> crate::c_types::Str,").unwrap(); + generated_fields.push(("debug_str".to_owned(), None, + Some(format!("\t/**\n\t * {}\n\t */\n", debug_docs)))); + }, (s, i) => { + // TODO: Both of the below should expose supertrait methods in C++, but doing so is + // nontrivial. generated_fields.push(if types.crate_types.traits.get(s).is_none() { 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, true) // Assume clonable + (name, None, None) // Assume clonable } else { // For in-crate supertraits, just store a C-mapped copy of the supertrait as a member. writeln!(w, "\t/// Implementation of {} for this object.", i).unwrap(); - writeln!(w, "\tpub {}: crate::{},", i, s).unwrap(); 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, "\tpub {}: crate::{},", i, s).unwrap(); + (format!("{}", i), if !is_clonable { + Some(format!("crate::{}_clone_fields", s)) + } else { None }, None) }); } ) ); 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(), true)); + generated_fields.push(("free".to_owned(), None, None)); writeln!(w, "}}").unwrap(); macro_rules! impl_trait_for_c { - ($t: expr, $impl_accessor: expr) => { + ($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!(); + panic!("1"); } - 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, $type_resolver)); + // Note that we do *not* use the method generics when printing "native" + // rust parts - if the method is generic, we need to print a generic + // method. write!(w, "\tfn {}", m.sig.ident).unwrap(); - types.write_rust_generic_param(w, Some(&gen_types), m.sig.generics.params.iter()); + $type_resolver.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!(); } + if !recv.attrs.is_empty() || recv.reference.is_none() { panic!("2"); } write!(w, "&").unwrap(); if let Some(lft) = &recv.reference.as_ref().unwrap().1 { write!(w, "'{} ", lft.ident).unwrap(); @@ -401,18 +472,18 @@ fn writeln_trait<'a, 'b, W: std::io::Write>(w: &mut W, t: &'a syn::ItemTrait, ty } }, syn::FnArg::Typed(arg) => { - if !arg.attrs.is_empty() { unimplemented!(); } + if !arg.attrs.is_empty() { panic!("3"); } 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!(); + panic!("4"); } - write!(w, ", {}{}: ", if types.skip_arg(&*arg.ty, Some(&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!(), + _ => panic!("5"), } - types.write_rust_type(w, Some(&gen_types), &*arg.ty); + $type_resolver.write_rust_type(w, Some(&gen_types), &*arg.ty); } } } @@ -420,14 +491,14 @@ fn writeln_trait<'a, 'b, W: std::io::Write>(w: &mut W, t: &'a syn::ItemTrait, ty match &m.sig.output { syn::ReturnType::Type(_, rtype) => { write!(w, " -> ").unwrap(); - types.write_rust_type(w, Some(&gen_types), &*rtype) + $type_resolver.write_rust_type(w, Some(&gen_types), &*rtype) }, _ => {}, } write!(w, " {{\n\t\t").unwrap(); match export_status(&m.attrs) { ExportStatus::NoExport => { - unimplemented!(); + panic!("6"); }, _ => {}, } @@ -437,82 +508,97 @@ fn writeln_trait<'a, 'b, W: std::io::Write>(w: &mut W, t: &'a syn::ItemTrait, ty 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(); - types.write_from_c_conversion_to_ref_prefix(w, &*r.elem, Some(&gen_types)); + $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(); - types.write_from_c_conversion_to_ref_suffix(w, &*r.elem, Some(&gen_types)); + $type_resolver.write_from_c_conversion_to_ref_suffix(w, &*r.elem, Some(&meth_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_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", types, Some(&gen_types), "", true); + let mut args = Vec::new(); + write_method_call_params(&mut args, &m.sig, "\t", $type_resolver, Some(&meth_gen_types), "", true); + w.write_all(String::from_utf8(args).unwrap().replace("self", &format!("self{}", $impl_accessor)).as_bytes()).unwrap(); 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!(); } + if t.default.is_some() || t.generics.lt_token.is_some() { panic!("10"); } 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!(), + loop { + 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(); + for bound in bounds_iter { + if let syn::TypeParamBound::Trait(_) = bound { panic!("11"); } + } + break; + }, + syn::TypeParamBound::Lifetime(_) => {}, + } } - if bounds_iter.next().is_some() { unimplemented!(); } }, - _ => unimplemented!(), + _ => panic!("12"), } } } } + writeln!(w, "unsafe impl Send for {} {{}}", trait_name).unwrap(); + writeln!(w, "unsafe impl Sync for {} {{}}", trait_name).unwrap(); + + writeln!(w, "#[no_mangle]").unwrap(); + writeln!(w, "pub(crate) extern \"C\" fn {}_clone_fields(orig: &{}) -> {} {{", trait_name, trait_name, trait_name).unwrap(); + writeln!(w, "\t{} {{", trait_name).unwrap(); + writeln!(w, "\t\tthis_arg: orig.this_arg,").unwrap(); + for (field, clone_fn, _) in generated_fields.iter() { + if let Some(f) = clone_fn { + // If the field isn't clonable, blindly assume its a trait and hope for the best. + writeln!(w, "\t\t{}: {}(&orig.{}),", field, f, field).unwrap(); + } else { + writeln!(w, "\t\t{}: Clone::clone(&orig.{}),", field, field).unwrap(); + } + } + writeln!(w, "\t}}\n}}").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", _) => { - writeln!(w, "impl std::cmp::Eq for {} {{}}", trait_name).unwrap(); - writeln!(w, "impl std::cmp::PartialEq for {} {{", trait_name).unwrap(); + ("std::cmp::Eq", _)|("core::cmp::Eq", _) => { + writeln!(w, "impl core::cmp::Eq for {} {{}}", trait_name).unwrap(); + writeln!(w, "impl core::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", _) => { - 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(); + ("std::hash::Hash", _)|("core::hash::Hash", _) => { + writeln!(w, "impl core::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(); 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, 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, "\tlet mut res = {}_clone_fields(orig);", trait_name).unwrap(); + writeln!(w, "\tif let Some(f) = orig.cloned {{ (f)(&mut res) }};").unwrap(); + writeln!(w, "\tres\n}}").unwrap(); writeln!(w, "impl Clone for {} {{", trait_name).unwrap(); writeln!(w, "\tfn clone(&self) -> Self {{").unwrap(); writeln!(w, "\t\t{}_clone(self)", trait_name).unwrap(); writeln!(w, "\t}}\n}}").unwrap(); }, + ("std::fmt::Debug", _)|("core::fmt::Debug", _) => { + writeln!(w, "impl core::fmt::Debug for {} {{", trait_name).unwrap(); + writeln!(w, "\tfn fmt(&self, f: &mut core::fmt::Formatter) -> Result<(), core::fmt::Error> {{").unwrap(); + writeln!(w, "\t\tf.write_str((self.debug_str)(self.this_arg).into_str())").unwrap(); + writeln!(w, "\t}}").unwrap(); + writeln!(w, "}}").unwrap(); + }, (s, i) => { if let Some(supertrait) = types.crate_types.traits.get(s) { - writeln!(w, "impl lightning::{} for {} {{", s, trait_name).unwrap(); // TODO: Drop hard-coded crate name here - impl_trait_for_c!(supertrait, format!(".{}", i)); + let resolver = get_module_type_resolver!(s, types.crate_libs, 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); } @@ -520,16 +606,20 @@ 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.orig_crate, 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, ""); - 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, "\nuse {}::{} as rust{};", types.module_path, t.ident, trait_name).unwrap(); + if implementable { + write!(w, "impl").unwrap(); + maybe_write_lifetime_generics(w, &t.generics, types); + write!(w, " 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 core::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(); @@ -539,7 +629,8 @@ fn writeln_trait<'a, 'b, W: std::io::Write>(w: &mut W, t: &'a syn::ItemTrait, ty writeln!(w, "\t\t\tf(self.this_arg);").unwrap(); writeln!(w, "\t\t}}\n\t}}\n}}").unwrap(); - write_cpp_wrapper(cpp_headers, &trait_name, true); + write_cpp_wrapper(cpp_headers, &trait_name, true, Some(generated_fields.drain(..) + .filter_map(|(name, _, docs)| if let Some(docs) = docs { Some((name, docs)) } else { None }).collect())); } /// Write out a simple "opaque" type (eg structs) which contain a pointer to the native Rust type @@ -550,7 +641,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;\npub(crate) type 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(); @@ -567,24 +658,30 @@ fn writeln_opaque(w: &mut W, ident: &syn::Ident, struct_name: writeln!(w, "}}\n").unwrap(); writeln!(w, "impl Drop for {} {{\n\tfn drop(&mut self) {{", struct_name).unwrap(); writeln!(w, "\t\tif self.is_owned && !<*mut native{}>::is_null(self.inner) {{", ident).unwrap(); - writeln!(w, "\t\t\tlet _ = unsafe {{ Box::from_raw(self.inner) }};\n\t\t}}\n\t}}\n}}").unwrap(); + writeln!(w, "\t\t\tlet _ = unsafe {{ Box::from_raw(ObjOps::untweak_ptr(self.inner)) }};\n\t\t}}\n\t}}\n}}").unwrap(); writeln!(w, "/// Frees any resources used by the {}, if is_owned is set and inner is non-NULL.", struct_name).unwrap(); writeln!(w, "#[no_mangle]\npub extern \"C\" fn {}_free(this_obj: {}) {{ }}", struct_name, struct_name).unwrap(); writeln!(w, "#[allow(unused)]").unwrap(); writeln!(w, "/// Used only if an object of this type is returned as a trait impl by a method").unwrap(); - writeln!(w, "extern \"C\" fn {}_free_void(this_ptr: *mut c_void) {{", struct_name).unwrap(); + writeln!(w, "pub(crate) extern \"C\" fn {}_free_void(this_ptr: *mut c_void) {{", struct_name).unwrap(); writeln!(w, "\tunsafe {{ let _ = Box::from_raw(this_ptr as *mut native{}); }}\n}}", struct_name).unwrap(); writeln!(w, "#[allow(unused)]").unwrap(); - writeln!(w, "/// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy").unwrap(); writeln!(w, "impl {} {{", struct_name).unwrap(); + writeln!(w, "\tpub(crate) fn get_native_ref(&self) -> &'static native{} {{", struct_name).unwrap(); + writeln!(w, "\t\tunsafe {{ &*ObjOps::untweak_ptr(self.inner) }}").unwrap(); + writeln!(w, "\t}}").unwrap(); + writeln!(w, "\tpub(crate) fn get_native_mut_ref(&self) -> &'static mut native{} {{", struct_name).unwrap(); + writeln!(w, "\t\tunsafe {{ &mut *ObjOps::untweak_ptr(self.inner) }}").unwrap(); + writeln!(w, "\t}}").unwrap(); + writeln!(w, "\t/// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy").unwrap(); writeln!(w, "\tpub(crate) fn take_inner(mut self) -> *mut native{} {{", struct_name).unwrap(); writeln!(w, "\t\tassert!(self.is_owned);").unwrap(); - writeln!(w, "\t\tlet ret = self.inner;").unwrap(); - writeln!(w, "\t\tself.inner = std::ptr::null_mut();").unwrap(); + writeln!(w, "\t\tlet ret = ObjOps::untweak_ptr(self.inner);").unwrap(); + writeln!(w, "\t\tself.inner = core::ptr::null_mut();").unwrap(); writeln!(w, "\t\tret").unwrap(); writeln!(w, "\t}}\n}}").unwrap(); - write_cpp_wrapper(cpp_headers, &format!("{}", ident), true); + write_cpp_wrapper(cpp_headers, &format!("{}", ident), true, None); } /// Writes out all the relevant mappings for a Rust struct, deferring to writeln_opaque to generate @@ -596,86 +693,144 @@ fn writeln_struct<'a, 'b, W: std::io::Write>(w: &mut W, s: &'a syn::ItemStruct, let struct_name = &format!("{}", s.ident); 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(); - assert!(gen_types.learn_generics(&s.generics, types)); - - let mut all_fields_settable = true; - for field in fields.named.iter() { - if let syn::Visibility::Public(_) = field.vis { - let export = export_status(&field.attrs); + 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))); + assert!(gen_types.learn_generics(&s.generics, types)); + + let mut all_fields_settable = true; + macro_rules! define_field { + ($new_name: expr, $real_name: expr, $field: expr) => { + if let syn::Visibility::Public(_) = $field.vis { + let export = export_status(&$field.attrs); match export { ExportStatus::Export => {}, ExportStatus::NoExport|ExportStatus::TestOnly => { all_fields_settable = false; continue }, + ExportStatus::NotImplementable => panic!("(C-not implementable) must only appear on traits"), } - if let Some(ident) = &field.ident { - let ref_type = syn::Type::Reference(syn::TypeReference { - and_token: syn::Token!(&)(Span::call_site()), lifetime: None, mutability: None, - elem: Box::new(field.ty.clone()) }); + if let Some(ref_type) = types.create_ownable_reference(&$field.ty, Some(&gen_types)) { if types.understood_c_type(&ref_type, Some(&gen_types)) { - writeln_docs(w, &field.attrs, ""); - write!(w, "#[no_mangle]\npub extern \"C\" fn {}_get_{}(this_ptr: &{}) -> ", struct_name, ident, struct_name).unwrap(); + writeln_arg_docs(w, &$field.attrs, "", types, Some(&gen_types), vec![].drain(..), Some(&ref_type)); + write!(w, "#[no_mangle]\npub extern \"C\" fn {}_get_{}(this_ptr: &{}) -> ", struct_name, $new_name, 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); + write!(w, " {{\n\tlet mut inner_val = &mut this_ptr.get_native_mut_ref().{};\n\t", $real_name).unwrap(); + let local_var = types.write_to_c_conversion_from_ownable_ref_new_var(w, &format_ident!("inner_val"), &ref_type, Some(&gen_types)); 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 { - write!(w, "inner_val").unwrap(); - } else { - write!(w, "(*inner_val)").unwrap(); - } + write!(w, "inner_val").unwrap(); types.write_to_c_conversion_inline_suffix(w, &ref_type, Some(&gen_types), true); writeln!(w, "\n}}").unwrap(); } + } - if types.understood_c_type(&field.ty, Some(&gen_types)) { - writeln_docs(w, &field.attrs, ""); - 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)); - 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)); - write!(w, "val").unwrap(); - types.write_from_c_conversion_suffix(w, &field.ty, Some(&gen_types)); - writeln!(w, ";\n}}").unwrap(); - } else { all_fields_settable = false; } + if types.understood_c_type(&$field.ty, Some(&gen_types)) { + writeln_arg_docs(w, &$field.attrs, "", types, Some(&gen_types), vec![("val".to_owned(), &$field.ty)].drain(..), None); + write!(w, "#[no_mangle]\npub extern \"C\" fn {}_set_{}(this_ptr: &mut {}, mut val: ", struct_name, $new_name, 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, &format_ident!("val"), &$field.ty, Some(&gen_types)); + if local_var { write!(w, "\n\t").unwrap(); } + write!(w, "unsafe {{ &mut *ObjOps::untweak_ptr(this_ptr.inner) }}.{} = ", $real_name).unwrap(); + types.write_from_c_conversion_prefix(w, &$field.ty, Some(&gen_types)); + write!(w, "val").unwrap(); + types.write_from_c_conversion_suffix(w, &$field.ty, Some(&gen_types)); + writeln!(w, ";\n}}").unwrap(); } else { all_fields_settable = false; } } else { all_fields_settable = false; } } + } - if all_fields_settable { - // Build a constructor! - writeln!(w, "/// Constructs a new {} given each field", struct_name).unwrap(); - write!(w, "#[must_use]\n#[no_mangle]\npub extern \"C\" fn {}_new(", struct_name).unwrap(); - for (idx, field) in fields.named.iter().enumerate() { - if idx != 0 { write!(w, ", ").unwrap(); } - write!(w, "mut {}_arg: ", field.ident.as_ref().unwrap()).unwrap(); - types.write_c_type(w, &field.ty, Some(&gen_types), false); - } - write!(w, ") -> {} {{\n\t", struct_name).unwrap(); + match &s.fields { + syn::Fields::Named(fields) => { 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)) { - write!(w, "\n\t").unwrap(); + if let Some(ident) = &field.ident { + define_field!(ident, ident, field); + } else { all_fields_settable = false; } + } + } + syn::Fields::Unnamed(fields) => { + for (idx, field) in fields.unnamed.iter().enumerate() { + define_field!(('a' as u8 + idx as u8) as char, ('0' as u8 + idx as u8) as char, field); + } + } + _ => unimplemented!() + } + + if all_fields_settable { + // Build a constructor! + writeln!(w, "/// Constructs a new {} given each field", struct_name).unwrap(); + write!(w, "#[must_use]\n#[no_mangle]\npub extern \"C\" fn {}_new(", struct_name).unwrap(); + + match &s.fields { + syn::Fields::Named(fields) => { + for (idx, field) in fields.named.iter().enumerate() { + if idx != 0 { write!(w, ", ").unwrap(); } + write!(w, "mut {}_arg: ", field.ident.as_ref().unwrap()).unwrap(); + types.write_c_type(w, &field.ty, Some(&gen_types), false); } } - writeln!(w, "{} {{ inner: Box::into_raw(Box::new(native{} {{", struct_name, s.ident).unwrap(); - for field in fields.named.iter() { - write!(w, "\t\t{}: ", field.ident.as_ref().unwrap()).unwrap(); - types.write_from_c_conversion_prefix(w, &field.ty, Some(&gen_types)); - write!(w, "{}_arg", field.ident.as_ref().unwrap()).unwrap(); - types.write_from_c_conversion_suffix(w, &field.ty, Some(&gen_types)); - writeln!(w, ",").unwrap(); + syn::Fields::Unnamed(fields) => { + for (idx, field) in fields.unnamed.iter().enumerate() { + if idx != 0 { write!(w, ", ").unwrap(); } + write!(w, "mut {}_arg: ", ('a' as u8 + idx as u8) as char).unwrap(); + types.write_c_type(w, &field.ty, Some(&gen_types), false); + } } - writeln!(w, "\t}})), is_owned: true }}\n}}").unwrap(); + _ => unreachable!() } + write!(w, ") -> {} {{\n\t", struct_name).unwrap(); + match &s.fields { + syn::Fields::Named(fields) => { + for field in fields.named.iter() { + 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(); + } + } + }, + syn::Fields::Unnamed(fields) => { + for (idx, field) in fields.unnamed.iter().enumerate() { + let field_ident = format_ident!("{}_arg", ('a' as u8 + idx as u8) as char); + if types.write_from_c_conversion_new_var(w, &field_ident, &field.ty, Some(&gen_types)) { + write!(w, "\n\t").unwrap(); + } + } + }, + _ => unreachable!() + } + write!(w, "{} {{ inner: ObjOps::heap_alloc(", struct_name).unwrap(); + match &s.fields { + syn::Fields::Named(fields) => { + writeln!(w, "native{} {{", s.ident).unwrap(); + for field in fields.named.iter() { + write!(w, "\t\t{}: ", field.ident.as_ref().unwrap()).unwrap(); + types.write_from_c_conversion_prefix(w, &field.ty, Some(&gen_types)); + write!(w, "{}_arg", field.ident.as_ref().unwrap()).unwrap(); + types.write_from_c_conversion_suffix(w, &field.ty, Some(&gen_types)); + writeln!(w, ",").unwrap(); + } + write!(w, "\t}}").unwrap(); + }, + syn::Fields::Unnamed(fields) => { + assert!(s.generics.lt_token.is_none()); + writeln!(w, "{} (", types.maybe_resolve_ident(&s.ident).unwrap()).unwrap(); + for (idx, field) in fields.unnamed.iter().enumerate() { + write!(w, "\t\t").unwrap(); + types.write_from_c_conversion_prefix(w, &field.ty, Some(&gen_types)); + write!(w, "{}_arg", ('a' as u8 + idx as u8) as char).unwrap(); + types.write_from_c_conversion_suffix(w, &field.ty, Some(&gen_types)); + writeln!(w, ",").unwrap(); + } + write!(w, "\t)").unwrap(); + }, + _ => unreachable!() + } + writeln!(w, "), is_owned: true }}\n}}").unwrap(); } } @@ -692,11 +847,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; @@ -721,9 +877,18 @@ fn writeln_impl(w: &mut W, i: &syn::ItemImpl, types: &mut Typ } if let &syn::Type::Path(ref p) = &*i.self_ty { 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 ident = &p.path.segments.last().unwrap().ident; + if let Some(resolved_path) = types.maybe_resolve_path(&p.path, None) { + if types.crate_types.opaques.contains_key(&resolved_path) || types.crate_types.mirrored_enums.contains_key(&resolved_path) || + // At least for core::infallible::Infallible we need to support mapping an + // out-of-crate trait implementation. + (types.understood_c_path(&p.path) && first_seg_is_stdlib(resolved_path.split("::").next().unwrap())) { + if !types.understood_c_path(&p.path) { + eprintln!("Not implementing anything for impl {} as the type is not understood (probably C-not exported)", ident); + return; + } + + let mut gen_types = GenericTypes::new(Some(resolved_path.clone())); if !gen_types.learn_generics(&i.generics, types) { eprintln!("Not implementing anything for impl {} due to not understood generics", ident); return; @@ -735,11 +900,26 @@ fn writeln_impl(w: &mut W, i: &syn::ItemImpl, types: &mut Typ if types.understood_c_path(&trait_path.1) { let full_trait_path = types.resolve_path(&trait_path.1, None); let trait_obj = *types.crate_types.traits.get(&full_trait_path).unwrap(); + + let supertrait_name; + let supertrait_resolver; + walk_supertraits!(trait_obj, Some(&types), ( + (s, _i) => { + if let Some(supertrait) = types.crate_types.traits.get(s) { + supertrait_name = s.to_string(); + supertrait_resolver = get_module_type_resolver!(supertrait_name, types.crate_libs, types.crate_types); + gen_types.learn_associated_types(&supertrait, &supertrait_resolver); + break; + } + } + ) ); // We learn the associated types maping from the original trait object. // That's great, except that they are unresolved idents, so if we learn // mappings from a trai defined in a different file, we may mis-resolve or - // fail to resolve the mapped types. - gen_types.learn_associated_types(trait_obj, types); + // fail to resolve the mapped types. Thus, we have to construct a new + // resolver for the module that the trait was defined in here first. + let trait_resolver = get_module_type_resolver!(full_trait_path, types.crate_libs, types.crate_types); + gen_types.learn_associated_types(trait_obj, &trait_resolver); let mut impl_associated_types = HashMap::new(); for item in i.items.iter() { match item { @@ -756,7 +936,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, } @@ -765,20 +945,39 @@ fn writeln_impl(w: &mut W, i: &syn::ItemImpl, types: &mut Typ // From<> implementation which does all the work to ensure free is handled // properly. This way we can call this method from deep in the // type-conversion logic without actually knowing the concrete native type. + if !resolved_path.starts_with(types.module_path) { + if !first_seg_is_stdlib(resolved_path.split("::").next().unwrap()) { + writeln!(w, "use crate::{}::native{} as native{};", resolved_path.rsplitn(2, "::").skip(1).next().unwrap(), ident, ident).unwrap(); + writeln!(w, "use crate::{};", resolved_path).unwrap(); + writeln!(w, "use crate::{}_free_void;", resolved_path).unwrap(); + } else { + writeln!(w, "use {} as native{};", resolved_path, ident).unwrap(); + } + } writeln!(w, "impl From for crate::{} {{", ident, full_trait_path).unwrap(); writeln!(w, "\tfn from(obj: native{}) -> Self {{", ident).unwrap(); - writeln!(w, "\t\tlet mut rust_obj = {} {{ inner: Box::into_raw(Box::new(obj)), is_owned: true }};", ident).unwrap(); - writeln!(w, "\t\tlet mut ret = {}_as_{}(&rust_obj);", ident, trait_obj.ident).unwrap(); - writeln!(w, "\t\t// We want to free rust_obj when ret gets drop()'d, not rust_obj, so wipe rust_obj's pointer and set ret's free() fn").unwrap(); - writeln!(w, "\t\trust_obj.inner = std::ptr::null_mut();").unwrap(); - writeln!(w, "\t\tret.free = Some({}_free_void);", ident).unwrap(); - writeln!(w, "\t\tret\n\t}}\n}}").unwrap(); + if is_type_unconstructable(&resolved_path) { + writeln!(w, "\t\tunreachable!();").unwrap(); + } else { + writeln!(w, "\t\tlet mut rust_obj = {} {{ inner: ObjOps::heap_alloc(obj), is_owned: true }};", ident).unwrap(); + writeln!(w, "\t\tlet mut ret = {}_as_{}(&rust_obj);", ident, trait_obj.ident).unwrap(); + writeln!(w, "\t\t// We want to free rust_obj when ret gets drop()'d, not rust_obj, so wipe rust_obj's pointer and set ret's free() fn").unwrap(); + writeln!(w, "\t\trust_obj.inner = core::ptr::null_mut();").unwrap(); + writeln!(w, "\t\tret.free = Some({}_free_void);", ident).unwrap(); + writeln!(w, "\t\tret").unwrap(); + } + writeln!(w, "\t}}\n}}").unwrap(); + if is_type_unconstructable(&resolved_path) { + // We don't bother with Struct_as_Trait conversion for types which must + // never be instantiated, so just return early. + return; + } writeln!(w, "/// Constructs a new {} which calls the relevant methods on this_arg.", trait_obj.ident).unwrap(); writeln!(w, "/// This copies the `inner` pointer in this_arg and thus the returned {} must be freed before this_arg is", trait_obj.ident).unwrap(); write!(w, "#[no_mangle]\npub extern \"C\" fn {}_as_{}(this_arg: &{}) -> crate::{} {{\n", ident, trait_obj.ident, ident, full_trait_path).unwrap(); writeln!(w, "\tcrate::{} {{", full_trait_path).unwrap(); - writeln!(w, "\t\tthis_arg: unsafe {{ (*this_arg).inner as *mut c_void }},").unwrap(); + writeln!(w, "\t\tthis_arg: unsafe {{ ObjOps::untweak_ptr((*this_arg).inner) as *mut c_void }},").unwrap(); writeln!(w, "\t\tfree: None,").unwrap(); macro_rules! write_meth { @@ -793,6 +992,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; @@ -818,20 +1018,18 @@ 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(); + requires_clone = true; + writeln!(w, "\t\tcloned: Some({}_{}_cloned),", trait_obj.ident, ident).unwrap(); }, ("Sync", _) => {}, ("Send", _) => {}, ("std::marker::Sync", _) => {}, ("std::marker::Send", _) => {}, + ("core::fmt::Debug", _) => {}, (s, t) => { if let Some(supertrait_obj) = types.crate_types.traits.get(s) { writeln!(w, "\t\t{}: crate::{} {{", t, s).unwrap(); - writeln!(w, "\t\t\tthis_arg: unsafe {{ (*this_arg).inner as *mut c_void }},").unwrap(); + writeln!(w, "\t\t\tthis_arg: unsafe {{ ObjOps::untweak_ptr((*this_arg).inner) as *mut c_void }},").unwrap(); writeln!(w, "\t\t\tfree: None,").unwrap(); for item in supertrait_obj.items.iter() { match item { @@ -842,9 +1040,6 @@ 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); } @@ -853,55 +1048,78 @@ fn writeln_impl(w: &mut W, i: &syn::ItemImpl, types: &mut Typ writeln!(w, "\t}}\n}}\n").unwrap(); macro_rules! impl_meth { - ($m: expr, $trait_path: expr, $trait: expr, $indent: expr) => { + ($m: expr, $trait_meth: expr, $trait_path: expr, $trait: expr, $indent: expr, $types: expr) => { let trait_method = $trait.items.iter().filter_map(|item| { if let syn::TraitItem::Method(t_m) = item { Some(t_m) } else { None } }).find(|trait_meth| trait_meth.sig.ident == $m.sig.ident).unwrap(); 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 { writeln!(w, "#[must_use]").unwrap(); } write!(w, "extern \"C\" fn {}_{}_{}(", ident, $trait.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, " {{\n\t").unwrap(); - write_method_var_decl_body(w, &$m.sig, "", types, Some(&gen_types), false); - let mut takes_self = false; + let mut meth_gen_types = gen_types.push_ctx(); + assert!(meth_gen_types.learn_generics(&$m.sig.generics, $types)); + let mut uncallable_function = false; for inp in $m.sig.inputs.iter() { - if let syn::FnArg::Receiver(_) = inp { - takes_self = true; + match inp { + syn::FnArg::Typed(arg) => { + if $types.skip_arg(&*arg.ty, Some(&meth_gen_types)) { continue; } + let mut c_type = Vec::new(); + $types.write_c_type(&mut c_type, &*arg.ty, Some(&meth_gen_types), false); + if is_type_unconstructable(&String::from_utf8(c_type).unwrap()) { + uncallable_function = true; + } + } + _ => {} } } - - let mut t_gen_args = String::new(); - for (idx, _) in $trait.generics.params.iter().enumerate() { - if idx != 0 { t_gen_args += ", " }; - 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(); + if uncallable_function { + let mut trait_resolver = get_module_type_resolver!(full_trait_path, $types.crate_libs, $types.crate_types); + write_method_params(w, &$trait_meth.sig, "c_void", &mut trait_resolver, Some(&meth_gen_types), true, true); } else { - write!(w, ">::{}(", ident, types.orig_crate, $trait_path, t_gen_args, $m.sig.ident).unwrap(); + write_method_params(w, &$m.sig, "c_void", $types, Some(&meth_gen_types), true, true); } + write!(w, " {{\n\t").unwrap(); + if uncallable_function { + write!(w, "unreachable!();").unwrap(); + } else { + 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 { + takes_self = true; + } + } - let mut real_type = "".to_string(); - match &$m.sig.output { - syn::ReturnType::Type(_, rtype) => { - if let Some(mut remaining_path) = first_seg_self(&*rtype) { - if let Some(associated_seg) = get_single_remaining_path_seg(&mut remaining_path) { - real_type = format!("{}", impl_associated_types.get(associated_seg).unwrap()); + let mut t_gen_args = String::new(); + for (idx, _) in $trait.generics.params.iter().enumerate() { + if idx != 0 { t_gen_args += ", " }; + t_gen_args += "_" + } + if takes_self { + write!(w, ">::{}(unsafe {{ &mut *(this_arg as *mut native{}) }}, ", ident, $trait_path, t_gen_args, $m.sig.ident, ident).unwrap(); + } else { + write!(w, ">::{}(", ident, $trait_path, t_gen_args, $m.sig.ident).unwrap(); + } + + let mut real_type = "".to_string(); + match &$m.sig.output { + syn::ReturnType::Type(_, rtype) => { + if let Some(mut remaining_path) = first_seg_self(&*rtype) { + if let Some(associated_seg) = get_single_remaining_path_seg(&mut remaining_path) { + real_type = format!("{}", impl_associated_types.get(associated_seg).unwrap()); + } } - } - }, - _ => {}, + }, + _ => {}, + } + write_method_call_params(w, &$m.sig, "", $types, Some(&meth_gen_types), &real_type, false); } - write_method_call_params(w, &$m.sig, "", types, Some(&gen_types), &real_type, false); - gen_types.pop_ctx(); write!(w, "\n}}\n").unwrap(); if let syn::ReturnType::Type(_, rtype) = &$m.sig.output { if let syn::Type::Reference(r) = &**rtype { @@ -910,7 +1128,7 @@ fn writeln_impl(w: &mut W, i: &syn::ItemImpl, types: &mut Typ 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.ident, $trait.ident, $m.sig.ident, ident, $trait.ident, $m.sig.ident).unwrap(); writeln!(w, "\t}}").unwrap(); @@ -920,51 +1138,114 @@ fn writeln_impl(w: &mut W, i: &syn::ItemImpl, types: &mut Typ } } - for item in i.items.iter() { - match item { - syn::ImplItem::Method(m) => { - impl_meth!(m, full_trait_path, trait_obj, ""); + 'impl_item_loop: for trait_item in trait_obj.items.iter() { + match trait_item { + syn::TraitItem::Method(meth) => { + for item in i.items.iter() { + match item { + syn::ImplItem::Method(m) => { + if meth.sig.ident == m.sig.ident { + impl_meth!(m, meth, full_trait_path, trait_obj, "", types); + continue 'impl_item_loop; + } + }, + syn::ImplItem::Type(_) => {}, + _ => unimplemented!(), + } + } + assert!(meth.default.is_some()); + let old_gen_types = gen_types; + gen_types = GenericTypes::new(Some(resolved_path.clone())); + let mut trait_resolver = get_module_type_resolver!(full_trait_path, types.crate_libs, types.crate_types); + impl_meth!(meth, meth, full_trait_path, trait_obj, "", &mut trait_resolver); + gen_types = old_gen_types; }, - syn::ImplItem::Type(_) => {}, - _ => unimplemented!(), + _ => {}, } } - walk_supertraits!(trait_obj, Some(&types), ( - (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(); + if requires_clone { + writeln!(w, "extern \"C\" fn {}_{}_cloned(new_obj: &mut crate::{}) {{", trait_obj.ident, ident, full_trait_path).unwrap(); + writeln!(w, "\tnew_obj.this_arg = {}_clone_void(new_obj.this_arg);", ident).unwrap(); + writeln!(w, "\tnew_obj.free = Some({}_free_void);", ident).unwrap(); + walk_supertraits!(trait_obj, Some(&types), ( + (s, t) => { + if types.crate_types.traits.get(s).is_some() { + assert!(!types.is_clonable(s)); // We don't currently support cloning with a clonable supertrait + writeln!(w, "\tnew_obj.{}.this_arg = new_obj.this_arg;", t).unwrap(); + writeln!(w, "\tnew_obj.{}.free = None;", t).unwrap(); } } - } - ) ); + ) ); + writeln!(w, "}}").unwrap(); + } write!(w, "\n").unwrap(); - } else if path_matches_nongeneric(&trait_path.1, &["From"]) { + return; + } + if is_type_unconstructable(&resolved_path) { + // Don't bother exposing trait implementations for objects which cannot be + // instantiated. + return; + } + if path_matches_nongeneric(&trait_path.1, &["From"]) { } else if path_matches_nongeneric(&trait_path.1, &["Default"]) { writeln!(w, "/// Creates a \"default\" {}. See struct and individual field documentaiton for details on which values are used.", ident).unwrap(); write!(w, "#[must_use]\n#[no_mangle]\npub extern \"C\" fn {}_default() -> {} {{\n", ident, ident).unwrap(); - write!(w, "\t{} {{ inner: Box::into_raw(Box::new(Default::default())), is_owned: true }}\n", ident).unwrap(); + write!(w, "\t{} {{ inner: ObjOps::heap_alloc(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 alloc::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, "\tcore::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, "\tcore::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(); writeln!(w, "\tfn clone(&self) -> Self {{").unwrap(); writeln!(w, "\t\tSelf {{").unwrap(); - writeln!(w, "\t\t\tinner: if <*mut native{}>::is_null(self.inner) {{ std::ptr::null_mut() }} else {{", ident).unwrap(); - writeln!(w, "\t\t\t\tBox::into_raw(Box::new(unsafe {{ &*self.inner }}.clone())) }},").unwrap(); + writeln!(w, "\t\t\tinner: if <*mut native{}>::is_null(self.inner) {{ core::ptr::null_mut() }} else {{", ident).unwrap(); + writeln!(w, "\t\t\t\tObjOps::heap_alloc(unsafe {{ &*ObjOps::untweak_ptr(self.inner) }}.clone()) }},").unwrap(); writeln!(w, "\t\t\tis_owned: true,").unwrap(); writeln!(w, "\t\t}}\n\t}}\n}}").unwrap(); writeln!(w, "#[allow(unused)]").unwrap(); @@ -976,6 +1257,56 @@ 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"]) { + let mut err_opt = None; + for item in i.items.iter() { + match item { + syn::ImplItem::Type(ty) if format!("{}", ty.ident) == "Err" => { + err_opt = Some(&ty.ty); + }, + _ => {} + } + } + let err_ty = err_opt.unwrap(); + if let Some(container) = types.get_c_mangled_container_type(vec![&*i.self_ty, &err_ty], 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) => {{").unwrap(); + let new_var = types.write_to_c_conversion_new_var(w, &format_ident!("e"), &err_ty, Some(&gen_types), false); + write!(w, "\t\t\tcrate::c_types::CResultTempl::err(\n\t\t\t\t").unwrap(); + types.write_to_c_conversion_inline_prefix(w, &err_ty, Some(&gen_types), false); + write!(w, "{}e", if new_var { "local_" } else { "" }).unwrap(); + types.write_to_c_conversion_inline_suffix(w, &err_ty, Some(&gen_types), false); + writeln!(w, "\n\t\t\t)\n\t\t}},").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, "\talloc::format!(\"{{}}\", ").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 @@ -983,7 +1314,8 @@ fn writeln_impl(w: &mut W, i: &syn::ItemImpl, types: &mut Typ maybe_convert_trait_impl(w, &trait_path.1, &*i.self_ty, types, &gen_types); } } else { - let declared_type = (*types.get_declared_type(&ident).unwrap()).clone(); + let is_opaque = types.crate_types.opaques.contains_key(&resolved_path); + let is_mirrored_enum = types.crate_types.mirrored_enums.contains_key(&resolved_path); for item in i.items.iter() { match item { syn::ImplItem::Method(m) => { @@ -991,40 +1323,48 @@ 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"), } + let mut meth_gen_types = gen_types.push_ctx(); + assert!(meth_gen_types.learn_generics(&m.sig.generics, types)); if m.defaultness.is_some() { unimplemented!(); } - writeln_docs(w, &m.attrs, ""); + writeln_fn_docs(w, &m.attrs, "", types, Some(&meth_gen_types), m.sig.inputs.iter(), &m.sig.output); if let syn::ReturnType::Type(_, _) = &m.sig.output { writeln!(w, "#[must_use]").unwrap(); } write!(w, "#[no_mangle]\npub extern \"C\" fn {}_{}(", ident, m.sig.ident).unwrap(); - let ret_type = match &declared_type { - DeclType::MirroredEnum => format!("{}", ident), - 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 ret_type = format!("crate::{}", resolved_path); + 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; + 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 { - write!(w, "unsafe {{ &mut (*(this_arg.inner as *mut native{})) }}.{}(", ident, m.sig.ident).unwrap(); - } else if takes_self { - write!(w, "unsafe {{ &*this_arg.inner }}.{}(", m.sig.ident).unwrap(); + if !takes_mut_self && !takes_self { + write!(w, "{}::{}(", resolved_path, m.sig.ident).unwrap(); } else { - write!(w, "{}::{}::{}(", types.orig_crate, resolved_path, m.sig.ident).unwrap(); + if is_mirrored_enum { + write!(w, "this_arg.to_native().{}(", m.sig.ident).unwrap(); + } else if is_opaque { + 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 (*ObjOps::untweak_ptr(this_arg.inner as *mut crate::{}::native{})) }}.{}(", rsplit_once(&resolved_path, "::").unwrap().0, ident, m.sig.ident).unwrap(); + } else { + write!(w, "unsafe {{ &*ObjOps::untweak_ptr(this_arg.inner) }}.{}(", m.sig.ident).unwrap(); + } + } else { + unimplemented!(); + } } - 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(); } }, @@ -1034,8 +1374,22 @@ fn writeln_impl(w: &mut W, i: &syn::ItemImpl, types: &mut Typ } } else if let Some(resolved_path) = types.maybe_resolve_ident(&ident) { if let Some(aliases) = types.crate_types.reverse_alias_map.get(&resolved_path).cloned() { - 'alias_impls: for (alias, arguments) in aliases { - let alias_resolved = types.resolve_path(&alias, None); + let mut gen_types = Some(GenericTypes::new(Some(resolved_path.clone()))); + if !gen_types.as_mut().unwrap().learn_generics(&i.generics, types) { + gen_types = None; + } + let alias_module = rsplit_once(&resolved_path, "::").unwrap().0; + + 'alias_impls: for (alias_resolved, arguments) in aliases { + let mut new_ty_generics = Vec::new(); + let mut need_generics = false; + + let alias_resolver_override; + let alias_resolver = if alias_module != types.module_path { + alias_resolver_override = ImportResolver::new(types.types.crate_name, &types.crate_types.lib_ast.dependencies, + alias_module, &types.crate_types.lib_ast.modules.get(alias_module).unwrap().items); + &alias_resolver_override + } else { &types.types };/*.maybe_resolve_path(&alias, None).unwrap();*/ for (idx, gen) in i.generics.params.iter().enumerate() { match gen { syn::GenericParam::Type(type_param) => { @@ -1044,17 +1398,27 @@ fn writeln_impl(w: &mut W, i: &syn::ItemImpl, types: &mut Typ if let syn::PathArguments::AngleBracketed(ref t) = &arguments { assert!(idx < t.args.len()); if let syn::GenericArgument::Type(syn::Type::Path(p)) = &t.args[idx] { - let generic_arg = types.resolve_path(&p.path, None); - let generic_bound = types.resolve_path(&trait_bound.path, None); - if let Some(traits_impld) = types.crate_types.trait_impls.get(&generic_arg) { - for trait_impld in traits_impld { - if *trait_impld == generic_bound { continue 'bounds_check; } + if let Some(generic_arg) = alias_resolver.maybe_resolve_path(&p.path, None) { + + new_ty_generics.push((type_param.ident.clone(), syn::Type::Path(p.clone()))); + let generic_bound = types.maybe_resolve_path(&trait_bound.path, None) + .unwrap_or_else(|| format!("{}::{}", types.module_path, single_ident_generic_path_to_ident(&trait_bound.path).unwrap())); + if let Some(traits_impld) = types.crate_types.trait_impls.get(&generic_arg) { + for trait_impld in traits_impld { + if *trait_impld == generic_bound { continue 'bounds_check; } + } + eprintln!("struct {}'s generic arg {} didn't match bound {}", alias_resolved, generic_arg, generic_bound); + continue 'alias_impls; + } else { + eprintln!("struct {}'s generic arg {} didn't match bound {}", alias_resolved, generic_arg, generic_bound); + continue 'alias_impls; } - eprintln!("struct {}'s generic arg {} didn't match bound {}", alias_resolved, generic_arg, generic_bound); - continue 'alias_impls; + } else if gen_types.is_some() { + new_ty_generics.push((type_param.ident.clone(), + gen_types.as_ref().resolve_type(&syn::Type::Path(p.clone())).clone())); + need_generics = true; } else { - eprintln!("struct {}'s generic arg {} didn't match bound {}", alias_resolved, generic_arg, generic_bound); - continue 'alias_impls; + unimplemented!(); } } else { unimplemented!(); } } else { unimplemented!(); } @@ -1065,19 +1429,55 @@ fn writeln_impl(w: &mut W, i: &syn::ItemImpl, types: &mut Typ syn::GenericParam::Const(_) => unimplemented!(), } } + let mut params = syn::punctuated::Punctuated::new(); + let alias = string_path_to_syn_path(&alias_resolved); + let real_aliased = + if need_generics { + let alias_generics = types.crate_types.opaques.get(&alias_resolved).unwrap().1; + + // If we need generics on the alias, create impl generic bounds... + assert_eq!(new_ty_generics.len(), i.generics.params.len()); + let mut args = syn::punctuated::Punctuated::new(); + for (ident, param) in new_ty_generics.drain(..) { + // TODO: We blindly assume that generics in the type alias and + // the aliased type have the same names, which we really shouldn't. + if alias_generics.params.iter().any(|generic| + if let syn::GenericParam::Type(t) = generic { t.ident == ident } else { false }) + { + args.push(parse_quote!(#ident)); + } + params.push(syn::GenericParam::Type(syn::TypeParam { + attrs: Vec::new(), + ident, + colon_token: None, + bounds: syn::punctuated::Punctuated::new(), + eq_token: Some(syn::token::Eq(Span::call_site())), + default: Some(param), + })); + } + // ... and swap the last segment of the impl self_ty to use the generic bounds. + let mut res = alias.clone(); + res.segments.last_mut().unwrap().arguments = syn::PathArguments::AngleBracketed(syn::AngleBracketedGenericArguments { + colon2_token: None, + lt_token: syn::token::Lt(Span::call_site()), + args, + gt_token: syn::token::Gt(Span::call_site()), + }); + res + } else { alias.clone() }; let aliased_impl = syn::ItemImpl { attrs: i.attrs.clone(), brace_token: syn::token::Brace(Span::call_site()), defaultness: None, generics: syn::Generics { lt_token: None, - params: syn::punctuated::Punctuated::new(), + params, gt_token: None, where_clause: None, }, impl_token: syn::Token![impl](Span::call_site()), items: i.items.clone(), - self_ty: Box::new(syn::Type::Path(syn::TypePath { qself: None, path: alias.clone() })), + self_ty: Box::new(syn::Type::Path(syn::TypePath { qself: None, path: real_aliased })), trait_: i.trait_.clone(), unsafety: None, }; @@ -1093,6 +1493,23 @@ fn writeln_impl(w: &mut W, i: &syn::ItemImpl, types: &mut Typ } } +/// Replaces upper case charachters with underscore followed by lower case except the first +/// charachter and repeated upper case characthers (which are only made lower case). +fn camel_to_snake_case(camel: &str) -> String { + let mut res = "".to_string(); + let mut last_upper = -1; + for (idx, c) in camel.chars().enumerate() { + if c.is_uppercase() { + if last_upper != idx as isize - 1 { res.push('_'); } + res.push(c.to_lowercase().next().unwrap()); + last_upper = idx as isize; + } else { + res.push(c); + } + } + res +} + /// Print a mapping of an enum. If all of the enum's fields are C-mapped in some form (or the enum /// is unitary), we generate an equivalent enum with all types replaced with their C mapped @@ -1102,6 +1519,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) { @@ -1111,50 +1529,88 @@ 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; + let mut constr = Vec::new(); writeln!(w, "#[must_use]\n#[derive(Clone)]\n#[repr(C)]\npub enum {} {{", e.ident).unwrap(); for var in e.variants.iter() { assert_eq!(export_status(&var.attrs), ExportStatus::Export); // We can't partially-export a mirrored enum writeln_docs(w, &var.attrs, "\t"); write!(w, "\t{}", var.ident).unwrap(); + writeln!(&mut constr, "#[no_mangle]\n/// Utility method to constructs a new {}-variant {}", var.ident, e.ident).unwrap(); + let constr_name = camel_to_snake_case(&format!("{}", var.ident)); + write!(&mut constr, "pub extern \"C\" fn {}_{}(", e.ident, constr_name).unwrap(); + let mut empty_tuple_variant = false; if let syn::Fields::Named(fields) = &var.fields { needs_free = true; writeln!(w, " {{").unwrap(); - for field in fields.named.iter() { + for (idx, field) in fields.named.iter().enumerate() { if export_status(&field.attrs) == ExportStatus::TestOnly { continue; } - writeln_docs(w, &field.attrs, "\t\t"); + writeln_field_docs(w, &field.attrs, "\t\t", types, Some(&gen_types), &field.ty); write!(w, "\t\t{}: ", field.ident.as_ref().unwrap()).unwrap(); - types.write_c_type(w, &field.ty, None, false); + write!(&mut constr, "{}{}: ", if idx != 0 { ", " } else { "" }, field.ident.as_ref().unwrap()).unwrap(); + types.write_c_type(w, &field.ty, Some(&gen_types), false); + types.write_c_type(&mut constr, &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(); + 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 { + needs_free = true; + write!(w, "(").unwrap(); + for (idx, field) in fields.unnamed.iter().enumerate() { + if export_status(&field.attrs) == ExportStatus::TestOnly { continue; } + write!(&mut constr, "{}: ", ('a' as u8 + idx as u8) as char).unwrap(); + types.write_c_type(w, &field.ty, Some(&gen_types), false); + types.write_c_type(&mut constr, &field.ty, Some(&gen_types), false); + if idx != fields.unnamed.len() - 1 { + write!(w, ",").unwrap(); + write!(&mut constr, ",").unwrap(); + } } + write!(w, ")").unwrap(); } - write!(w, ")").unwrap(); } if var.discriminant.is_some() { unimplemented!(); } + write!(&mut constr, ") -> {} {{\n\t{}::{}", e.ident, e.ident, var.ident).unwrap(); + if let syn::Fields::Named(fields) = &var.fields { + writeln!(&mut constr, " {{").unwrap(); + for field in fields.named.iter() { + writeln!(&mut constr, "\t\t{},", field.ident.as_ref().unwrap()).unwrap(); + } + writeln!(&mut constr, "\t}}").unwrap(); + } else if let syn::Fields::Unnamed(fields) = &var.fields { + if !empty_tuple_variant { + write!(&mut constr, "(").unwrap(); + for idx in 0..fields.unnamed.len() { + write!(&mut constr, "{}, ", ('a' as u8 + idx as u8) as char).unwrap(); + } + writeln!(&mut constr, ")").unwrap(); + } else { + writeln!(&mut constr, "").unwrap(); + } + } + writeln!(&mut constr, "}}").unwrap(); 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) => { 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() { @@ -1163,12 +1619,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(); @@ -1178,19 +1643,19 @@ 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 { 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); + 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(); } @@ -1208,7 +1673,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, &syn::Ident::new(&(('a' as u8 + idx as u8) as char).to_string(), Span::call_site())); + if !empty_tuple_variant { + handle_field_a!(field, &format_ident!("{}", ('a' as u8 + idx as u8) as char)); + } } } else { write!(w, " ").unwrap(); } @@ -1218,16 +1685,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(); } } @@ -1243,12 +1710,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, &syn::Ident::new(&(('a' as u8 + idx as u8) as char).to_string(), Span::call_site())); + 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(); @@ -1272,24 +1741,36 @@ fn writeln_enum<'a, 'b, W: std::io::Write>(w: &mut W, e: &'a syn::ItemEnum, type writeln!(w, "pub extern \"C\" fn {}_clone(orig: &{}) -> {} {{", e.ident, e.ident, e.ident).unwrap(); writeln!(w, "\torig.clone()").unwrap(); writeln!(w, "}}").unwrap(); - write_cpp_wrapper(cpp_headers, &format!("{}", e.ident), needs_free); + w.write_all(&constr).unwrap(); + write_cpp_wrapper(cpp_headers, &format!("{}", e.ident), needs_free, None); } fn writeln_fn<'a, 'b, W: std::io::Write>(w: &mut W, f: &'a syn::ItemFn, types: &mut TypeResolver<'b, 'a>) { 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; } + writeln_fn_docs(w, &f.attrs, "", types, Some(&gen_types), f.sig.inputs.iter(), &f.sig.output); + write!(w, "#[no_mangle]\npub extern \"C\" fn {}(", f.sig.ident).unwrap(); + + 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(); + + let mut function_generic_args = Vec::new(); + maybe_write_generics(&mut function_generic_args, &f.sig.generics, types, true); + if !function_generic_args.is_empty() { + write!(w, "::{}", String::from_utf8(function_generic_args).unwrap()).unwrap(); + } + write!(w, "(").unwrap(); + write_method_call_params(w, &f.sig, "", types, Some(&gen_types), "", false); writeln!(w, "\n}}\n").unwrap(); } @@ -1297,58 +1778,38 @@ 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); } - } + +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); } - self.modules.insert(module, ASTModule { attrs, items: non_mod_items, submods }); } + 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); - 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 + 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) => { + 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. -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); @@ -1377,6 +1838,7 @@ fn convert_file<'a, 'b>(libast: &'a FullLibraryAST, crate_types: &mut CrateTypes 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(); @@ -1386,11 +1848,19 @@ fn convert_file<'a, 'b>(libast: &'a FullLibraryAST, crate_types: &mut CrateTypes 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, "#![cfg_attr(not(feature = \"std\"), no_std)]").unwrap(); + writeln!(out, "#[cfg(not(any(feature = \"std\", feature = \"no-std\")))]").unwrap(); + writeln!(out, "compile_error!(\"at least one of the `std` or `no-std` features must be enabled\");").unwrap(); + writeln!(out, "extern crate alloc;").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 { @@ -1399,8 +1869,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 { @@ -1424,16 +1894,18 @@ fn convert_file<'a, 'b>(libast: &'a FullLibraryAST, crate_types: &mut CrateTypes 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 { if let syn::Type::Path(p) = &*c.ty { let resolved_path = type_resolver.resolve_path(&p.path, None); if type_resolver.is_primitive(&resolved_path) { - writeln_docs(&mut out, &c.attrs, ""); + writeln_field_docs(&mut out, &c.attrs, "", &mut type_resolver, None, &*c.ty); 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(); } } } @@ -1443,19 +1915,41 @@ fn convert_file<'a, 'b>(libast: &'a FullLibraryAST, crate_types: &mut CrateTypes 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; - for tok in t.generics.params.iter() { - if let syn::GenericParam::Lifetime(_) = tok {} - else { process_alias = false; } - } - if process_alias { - match &*t.ty { - syn::Type::Path(_) => - writeln_opaque(&mut out, &t.ident, &format!("{}", t.ident), &t.generics, &t.attrs, &type_resolver, header_file, cpp_header_file), - _ => {} - } + match &*t.ty { + syn::Type::Path(p) => { + let real_ty = type_resolver.resolve_path(&p.path, None); + let real_generic_bounds = type_resolver.crate_types.opaques.get(&real_ty).map(|t| t.1).or( + type_resolver.crate_types.priv_structs.get(&real_ty).map(|r| *r)).unwrap(); + let mut resolved_generics = t.generics.clone(); + + // Assume blindly that the bounds in the struct definition where + // clause matches any equivalent bounds on the type alias. + assert!(resolved_generics.where_clause.is_none()); + resolved_generics.where_clause = real_generic_bounds.where_clause.clone(); + + if let syn::PathArguments::AngleBracketed(real_generics) = &p.path.segments.last().unwrap().arguments { + for (real_idx, real_param) in real_generics.args.iter().enumerate() { + if let syn::GenericArgument::Type(syn::Type::Path(real_param_path)) = real_param { + for param in resolved_generics.params.iter_mut() { + if let syn::GenericParam::Type(type_param) = param { + if Some(&type_param.ident) == real_param_path.path.get_ident() { + if let syn::GenericParam::Type(real_type_param) = &real_generic_bounds.params[real_idx] { + type_param.bounds = real_type_param.bounds.clone(); + type_param.default = real_type_param.default.clone(); + + } + } + } + } + } + } + } + + writeln_opaque(&mut out, &t.ident, &format!("{}", t.ident), &resolved_generics, &t.attrs, &type_resolver, header_file, cpp_header_file)}, + _ => {} } } }, @@ -1475,11 +1969,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() { @@ -1504,30 +1998,35 @@ 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 { syn::Item::Struct(s) => { if let syn::Visibility::Public(_) = s.vis { + let struct_path = format!("{}::{}", module, s.ident); match export_status(&s.attrs) { ExportStatus::Export => {}, - ExportStatus::NoExport|ExportStatus::TestOnly => continue, + ExportStatus::NoExport|ExportStatus::TestOnly => { + crate_types.priv_structs.insert(struct_path, &s.generics); + 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); + crate_types.opaques.insert(struct_path, (&s.ident, &s.generics)); } }, 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); walk_supertraits!(t, None, ( ("Clone", _) => { - crate_types.clonable_types.insert("crate::".to_owned() + &trait_path); + crate_types.set_clonable("crate::".to_owned() + &trait_path); }, (_, _) => {} ) ); @@ -1539,34 +2038,22 @@ 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; - for tok in t.generics.params.iter() { - if let syn::GenericParam::Lifetime(_) = tok {} - else { process_alias = false; } - } - if process_alias { - match &*t.ty { - syn::Type::Path(p) => { - // 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 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.type_aliases.insert(type_path, import_resolver.resolve_imported_refs((*t.ty).clone())); + match &*t.ty { + syn::Type::Path(p) => { + // If its a path with no generics, assume we don't map the aliased type and map it opaque + 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((type_path.clone(), args_obj)); }, + hash_map::Entry::Vacant(e) => { e.insert(vec![(type_path.clone(), args_obj)]); }, } + + crate_types.opaques.insert(type_path, (&t.ident, &t.generics)); + }, + _ => { + crate_types.type_aliases.insert(type_path, import_resolver.resolve_imported_refs((*t.ty).clone())); } } } @@ -1576,9 +2063,10 @@ 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); + crate_types.opaques.insert(enum_path, (&e.ident, &e.generics)); } }, syn::Item::Enum(e) => { @@ -1586,6 +2074,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); @@ -1594,9 +2083,10 @@ fn walk_ast<'a>(ast_storage: &'a FullLibraryAST, crate_types: &mut CrateTypes<'a syn::Item::Impl(i) => { if let &syn::Type::Path(ref p) = &*i.self_ty { if let Some(trait_path) = i.trait_.as_ref() { - if path_matches_nongeneric(&trait_path.1, &["core", "clone", "Clone"]) { + if path_matches_nongeneric(&trait_path.1, &["core", "clone", "Clone"]) || + path_matches_nongeneric(&trait_path.1, &["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) { @@ -1610,7 +2100,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), _ => {}, } } @@ -1619,17 +2109,18 @@ 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"); + writeln!(&mut derived_templates, "{}", DEFAULT_IMPORTS).unwrap(); 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(); @@ -1645,6 +2136,9 @@ fn main() { writeln!(header_file, "#endif").unwrap(); writeln!(cpp_header_file, "#include \nnamespace LDK {{").unwrap(); + // Write a few manually-defined types into the C++ header file + write_cpp_wrapper(&mut cpp_header_file, "Str", true, None); + // First parse the full crate's ASTs, caching them so that we can hold references to the AST // objects in other datastructures: let mut lib_src = String::new(); @@ -1654,19 +2148,16 @@ 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() { - write_cpp_wrapper(&mut cpp_header_file, ty, *has_destructor); + for (ty, has_destructor) in libtypes.templates_defined.borrow().iter() { + write_cpp_wrapper(&mut cpp_header_file, ty, *has_destructor, None); } writeln!(cpp_header_file, "}}").unwrap();