1 // This file is Copyright its original authors, visible in version control
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE>
5 // or the MIT license <LICENSE-MIT>, at your option.
6 // You may not use this file except in accordance with one or both of these
9 //! Converts a rust crate into a rust crate containing a number of C-exported wrapper functions and
10 //! classes (which is exportable using cbindgen).
11 //! In general, supports convering:
12 //! * structs as a pointer to the underlying type (either owned or not owned),
13 //! * traits as a void-ptr plus a jump table,
14 //! * enums as an equivalent enum with all the inner fields mapped to the mapped types,
15 //! * certain containers (tuples, slices, Vecs, Options, and Results currently) to a concrete
16 //! version of a defined container template.
18 //! It also generates relevant memory-management functions and free-standing functions with
19 //! parameters mapped.
21 use std::collections::{HashMap, hash_map, HashSet};
24 use std::io::{Read, Write};
25 use std::iter::FromIterator;
28 use proc_macro2::Span;
29 use quote::format_ident;
37 const DEFAULT_IMPORTS: &'static str = "
38 use alloc::str::FromStr;
39 use alloc::string::String;
40 use core::ffi::c_void;
41 use core::convert::Infallible;
42 use bitcoin::hashes::Hash;
43 use crate::c_types::*;
44 #[cfg(feature=\"no-std\")]
45 use alloc::{vec::Vec, boxed::Box};
49 /// str.rsplit_once but with an older MSRV
50 fn rsplit_once<'a>(inp: &'a str, pattern: &str) -> Option<(&'a str, &'a str)> {
51 let mut iter = inp.rsplitn(2, pattern);
52 let second_entry = iter.next().unwrap();
53 Some((iter.next().unwrap(), second_entry))
56 // *************************************
57 // *** Manually-expanded conversions ***
58 // *************************************
60 /// Convert "impl trait_path for for_ty { .. }" for manually-mapped types (ie (de)serialization)
61 fn maybe_convert_trait_impl<W: std::io::Write>(w: &mut W, trait_path: &syn::Path, for_ty: &syn::Type, types: &mut TypeResolver, generics: &GenericTypes) {
62 if let Some(t) = types.maybe_resolve_path(&trait_path, Some(generics)) {
65 let mut has_inner = false;
66 if let syn::Type::Path(ref p) = for_ty {
67 let resolved_path = types.resolve_path(&p.path, Some(generics));
68 for_obj = format!("{}", p.path.segments.last().unwrap().ident);
69 full_obj_path = format!("crate::{}", resolved_path);
70 has_inner = types.c_type_has_inner_from_path(&resolved_path);
72 // We assume that anything that isn't a Path is somehow a generic that ends up in our
73 // derived-types module.
74 let mut for_obj_vec = Vec::new();
75 types.write_c_type(&mut for_obj_vec, for_ty, Some(generics), false);
76 full_obj_path = String::from_utf8(for_obj_vec).unwrap();
77 if !full_obj_path.starts_with(TypeResolver::generated_container_path()) { return; }
78 for_obj = full_obj_path[TypeResolver::generated_container_path().len() + 2..].into();
82 "lightning::util::ser::Writeable" => {
83 writeln!(w, "#[no_mangle]").unwrap();
84 writeln!(w, "/// Serialize the {} object into a byte array which can be read by {}_read", for_obj, for_obj).unwrap();
85 writeln!(w, "pub extern \"C\" fn {}_write(obj: &{}) -> crate::c_types::derived::CVec_u8Z {{", for_obj, full_obj_path).unwrap();
87 let ref_type: syn::Type = syn::parse_quote!(&#for_ty);
88 assert!(!types.write_from_c_conversion_new_var(w, &format_ident!("obj"), &ref_type, Some(generics)));
90 write!(w, "\tcrate::c_types::serialize_obj(").unwrap();
91 types.write_from_c_conversion_prefix(w, &ref_type, Some(generics));
92 write!(w, "unsafe {{ &*obj }}").unwrap();
93 types.write_from_c_conversion_suffix(w, &ref_type, Some(generics));
94 writeln!(w, ")").unwrap();
96 writeln!(w, "}}").unwrap();
98 writeln!(w, "#[no_mangle]").unwrap();
99 writeln!(w, "pub(crate) extern \"C\" fn {}_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {{", for_obj).unwrap();
100 writeln!(w, "\tcrate::c_types::serialize_obj(unsafe {{ &*(obj as *const native{}) }})", for_obj).unwrap();
101 writeln!(w, "}}").unwrap();
104 "lightning::util::ser::Readable"|"lightning::util::ser::ReadableArgs"|"lightning::util::ser::MaybeReadable" => {
105 // Create the Result<Object, DecodeError> syn::Type
106 let mut res_ty: syn::Type = parse_quote!(Result<#for_ty, lightning::ln::msgs::DecodeError>);
108 writeln!(w, "#[no_mangle]").unwrap();
109 writeln!(w, "/// Read a {} from a byte array, created by {}_write", for_obj, for_obj).unwrap();
110 write!(w, "pub extern \"C\" fn {}_read(ser: crate::c_types::u8slice", for_obj).unwrap();
112 let mut arg_conv = Vec::new();
113 if t == "lightning::util::ser::ReadableArgs" {
114 assert!(trait_path.leading_colon.is_none());
115 let args_seg = trait_path.segments.iter().last().unwrap();
116 assert_eq!(format!("{}", args_seg.ident), "ReadableArgs");
117 if let syn::PathArguments::AngleBracketed(args) = &args_seg.arguments {
118 assert_eq!(args.args.len(), 1);
119 if let syn::GenericArgument::Type(args_ty) = args.args.iter().next().unwrap() {
120 macro_rules! write_arg_conv {
121 ($ty: expr, $arg_name: expr) => {
122 write!(w, ", {}: ", $arg_name).unwrap();
123 types.write_c_type(w, $ty, Some(generics), false);
125 write!(&mut arg_conv, "\t").unwrap();
126 if types.write_from_c_conversion_new_var(&mut arg_conv, &format_ident!("{}", $arg_name), &$ty, Some(generics)) {
127 write!(&mut arg_conv, "\n\t").unwrap();
130 write!(&mut arg_conv, "let {}_conv = ", $arg_name).unwrap();
131 types.write_from_c_conversion_prefix(&mut arg_conv, &$ty, Some(generics));
132 write!(&mut arg_conv, "{}", $arg_name).unwrap();
133 types.write_from_c_conversion_suffix(&mut arg_conv, &$ty, Some(generics));
134 write!(&mut arg_conv, ";\n").unwrap();
138 if let syn::Type::Tuple(tup) = args_ty {
139 // Crack open tuples and make them separate arguments instead of
140 // converting the full tuple. This makes it substantially easier to
141 // reason about things like references in the tuple fields.
142 let mut arg_conv_res = Vec::new();
143 for (idx, elem) in tup.elems.iter().enumerate() {
144 let arg_name = format!("arg_{}", ('a' as u8 + idx as u8) as char);
145 write_arg_conv!(elem, arg_name);
146 write!(&mut arg_conv_res, "{}_conv{}", arg_name, if idx != tup.elems.len() - 1 { ", " } else { "" }).unwrap();
148 writeln!(&mut arg_conv, "\tlet arg_conv = ({});", String::from_utf8(arg_conv_res).unwrap()).unwrap();
150 write_arg_conv!(args_ty, "arg");
152 } else { unreachable!(); }
153 } else { unreachable!(); }
154 } else if t == "lightning::util::ser::MaybeReadable" {
155 res_ty = parse_quote!(Result<Option<#for_ty>, lightning::ln::msgs::DecodeError>);
157 write!(w, ") -> ").unwrap();
158 types.write_c_type(w, &res_ty, Some(generics), false);
159 writeln!(w, " {{").unwrap();
161 if t == "lightning::util::ser::ReadableArgs" {
162 w.write(&arg_conv).unwrap();
165 write!(w, "\tlet res: ").unwrap();
166 // At least in one case we need type annotations here, so provide them.
167 types.write_rust_type(w, Some(generics), &res_ty, false);
169 if t == "lightning::util::ser::ReadableArgs" {
170 writeln!(w, " = crate::c_types::deserialize_obj_arg(ser, arg_conv);").unwrap();
171 } else if t == "lightning::util::ser::MaybeReadable" {
172 writeln!(w, " = crate::c_types::maybe_deserialize_obj(ser);").unwrap();
174 writeln!(w, " = crate::c_types::deserialize_obj(ser);").unwrap();
176 write!(w, "\t").unwrap();
177 if types.write_to_c_conversion_new_var(w, &format_ident!("res"), &res_ty, Some(generics), false) {
178 write!(w, "\n\t").unwrap();
180 types.write_to_c_conversion_inline_prefix(w, &res_ty, Some(generics), false);
181 write!(w, "res").unwrap();
182 types.write_to_c_conversion_inline_suffix(w, &res_ty, Some(generics), false);
183 writeln!(w, "\n}}").unwrap();
190 /// Convert "TraitA : TraitB" to a single function name and return type.
192 /// This is (obviously) somewhat over-specialized and only useful for TraitB's that only require a
193 /// single function (eg for serialization).
194 fn convert_trait_impl_field(trait_path: &str) -> (&'static str, String, &'static str) {
196 "lightning::util::ser::Writeable" => ("Serialize the object into a byte array", "write".to_owned(), "crate::c_types::derived::CVec_u8Z"),
197 _ => unimplemented!(),
201 /// Companion to convert_trait_impl_field, write an assignment for the function defined by it for
202 /// `for_obj` which implements the the trait at `trait_path`.
203 fn write_trait_impl_field_assign<W: std::io::Write>(w: &mut W, trait_path: &str, for_obj: &syn::Ident) {
205 "lightning::util::ser::Writeable" => {
206 writeln!(w, "\t\twrite: {}_write_void,", for_obj).unwrap();
208 _ => unimplemented!(),
212 /// Write out the impl block for a defined trait struct which has a supertrait
213 fn do_write_impl_trait<W: std::io::Write>(w: &mut W, trait_path: &str, _trait_name: &syn::Ident, for_obj: &str) {
215 "lightning::util::ser::Writeable" => {
216 writeln!(w, "impl {} for {} {{", trait_path, for_obj).unwrap();
217 writeln!(w, "\tfn write<W: lightning::util::ser::Writer>(&self, w: &mut W) -> Result<(), crate::c_types::io::Error> {{").unwrap();
218 writeln!(w, "\t\tlet vec = (self.write)(self.this_arg);").unwrap();
219 writeln!(w, "\t\tw.write_all(vec.as_slice())").unwrap();
220 writeln!(w, "\t}}\n}}").unwrap();
226 /// Returns true if an instance of the given type must never exist
227 fn is_type_unconstructable(path: &str) -> bool {
228 path == "core::convert::Infallible" || path == "crate::c_types::NotConstructable"
231 // *******************************
232 // *** Per-Type Printing Logic ***
233 // *******************************
235 macro_rules! walk_supertraits { ($t: expr, $types: expr, ($( $($pat: pat)|* => $e: expr),*) ) => { {
236 if $t.colon_token.is_some() {
237 for st in $t.supertraits.iter() {
239 syn::TypeParamBound::Trait(supertrait) => {
240 if supertrait.paren_token.is_some() || supertrait.lifetimes.is_some() {
243 // First try to resolve path to find in-crate traits, but if that doesn't work
244 // assume its a prelude trait (eg Clone, etc) and just use the single ident.
245 let types_opt: Option<&TypeResolver> = $types;
246 if let Some(types) = types_opt {
247 if let Some(path) = types.maybe_resolve_path(&supertrait.path, None) {
248 let last_seg = supertrait.path.segments.iter().last().unwrap();
249 match (&path as &str, &last_seg.ident, &last_seg.arguments) {
250 $( $($pat)|* => $e, )*
255 if let Some(ident) = supertrait.path.get_ident() {
256 match (&format!("{}", ident) as &str, &ident, &syn::PathArguments::None) {
257 $( $($pat)|* => $e, )*
259 } else if types_opt.is_some() {
260 panic!("Supertrait unresolvable and not single-ident");
263 syn::TypeParamBound::Lifetime(_) => unimplemented!(),
269 macro_rules! get_module_type_resolver {
270 ($module: expr, $crate_libs: expr, $crate_types: expr) => { {
271 let module: &str = &$module;
272 let mut module_iter = module.rsplitn(2, "::");
273 module_iter.next().unwrap();
274 let module = module_iter.next().unwrap();
275 let imports = ImportResolver::new(module.splitn(2, "::").next().unwrap(), &$crate_types.lib_ast,
276 module, &$crate_types.lib_ast.modules.get(module).unwrap().items);
277 TypeResolver::new(module, imports, $crate_types)
281 /// Prints a C-mapped trait object containing a void pointer and a jump table for each function in
282 /// the original trait.
283 /// Implements the native Rust trait and relevant parent traits for the new C-mapped trait.
285 /// Finally, implements Deref<MappedTrait> for MappedTrait which allows its use in types which need
286 /// a concrete Deref to the Rust trait.
287 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) {
288 let trait_name = format!("{}", t.ident);
290 match export_status(&t.attrs) {
291 ExportStatus::Export => { implementable = true; }
292 ExportStatus::NotImplementable => { implementable = false; },
293 ExportStatus::NoExport|ExportStatus::TestOnly => return,
295 writeln_docs(w, &t.attrs, "");
297 let mut gen_types = GenericTypes::new(Some(format!("{}::{}", types.module_path, trait_name)));
299 // Add functions which may be required for supertrait implementations.
300 // Due to borrow checker limitations, we only support one in-crate supertrait here.
302 let supertrait_resolver;
303 walk_supertraits!(t, Some(&types), (
305 if let Some(supertrait) = types.crate_types.traits.get(s) {
306 supertrait_name = s.to_string();
307 supertrait_resolver = get_module_type_resolver!(supertrait_name, types.crate_libs, types.crate_types);
308 gen_types.learn_associated_types(&supertrait, &supertrait_resolver);
314 assert!(gen_types.learn_generics(&t.generics, types));
315 gen_types.learn_associated_types(&t, types);
317 writeln!(w, "#[repr(C)]\npub struct {} {{", trait_name).unwrap();
318 writeln!(w, "\t/// An opaque pointer which is passed to your function implementations as an argument.").unwrap();
319 writeln!(w, "\t/// This has no meaning in the LDK, and can be NULL or any other value.").unwrap();
320 writeln!(w, "\tpub this_arg: *mut c_void,").unwrap();
321 // We store every field's (name, Option<clone_fn>, docs) except this_arg, used in Clone generation
322 // docs is only set if its a function which should be callable on the object itself in C++
323 let mut generated_fields = Vec::new();
324 for item in t.items.iter() {
326 &syn::TraitItem::Method(ref m) => {
327 match export_status(&m.attrs) {
328 ExportStatus::NoExport => {
329 // NoExport in this context means we'll hit an unimplemented!() at runtime,
333 ExportStatus::Export => {},
334 ExportStatus::TestOnly => continue,
335 ExportStatus::NotImplementable => panic!("(C-not implementable) must only appear on traits"),
338 let mut meth_gen_types = gen_types.push_ctx();
339 assert!(meth_gen_types.learn_generics(&m.sig.generics, types));
341 writeln_fn_docs(w, &m.attrs, "\t", types, Some(&meth_gen_types), m.sig.inputs.iter(), &m.sig.output);
343 if let syn::ReturnType::Type(_, rtype) = &m.sig.output {
344 if let syn::Type::Reference(r) = &**rtype {
345 // We have to do quite a dance for trait functions which return references
346 // - they ultimately require us to have a native Rust object stored inside
347 // our concrete trait to return a reference to. However, users may wish to
348 // update the value to be returned each time the function is called (or, to
349 // make C copies of Rust impls equivalent, we have to be able to).
351 // Thus, we store a copy of the C-mapped type (which is just a pointer to
352 // the Rust type and a flag to indicate whether deallocation needs to
353 // happen) as well as provide an Option<>al function pointer which is
354 // called when the trait method is called which allows updating on the fly.
355 write!(w, "\tpub {}: core::cell::UnsafeCell<", m.sig.ident).unwrap();
356 generated_fields.push((format!("{}", m.sig.ident), Some(("Clone::clone(unsafe { &*core::cell::UnsafeCell::get(".to_owned(), ")}).into()")), None));
357 types.write_c_type(w, &*r.elem, Some(&meth_gen_types), false);
358 writeln!(w, ">,").unwrap();
359 writeln!(w, "\t/// Fill in the {} field as a reference to it will be given to Rust after this returns", m.sig.ident).unwrap();
360 writeln!(w, "\t/// Note that this takes a pointer to this object, not the this_ptr like other methods do").unwrap();
361 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();
362 writeln!(w, "\tpub set_{}: Option<extern \"C\" fn(&{})>,", m.sig.ident, trait_name).unwrap();
363 generated_fields.push((format!("set_{}", m.sig.ident), None, None));
364 // Note that cbindgen will now generate
365 // typedef struct Thing {..., set_thing: (const struct Thing*), ...} Thing;
366 // which does not compile since Thing is not defined before it is used.
367 writeln!(extra_headers, "struct LDK{};", trait_name).unwrap();
372 let mut cpp_docs = Vec::new();
373 writeln_fn_docs(&mut cpp_docs, &m.attrs, "\t * ", types, Some(&meth_gen_types), m.sig.inputs.iter(), &m.sig.output);
374 let docs_string = "\t/**\n".to_owned() + &String::from_utf8(cpp_docs).unwrap().replace("///", "") + "\t */\n";
376 write!(w, "\tpub {}: extern \"C\" fn (", m.sig.ident).unwrap();
377 generated_fields.push((format!("{}", m.sig.ident), None, Some(docs_string)));
378 write_method_params(w, &m.sig, "c_void", types, Some(&meth_gen_types), true, false);
379 writeln!(w, ",").unwrap();
381 &syn::TraitItem::Type(_) => {},
382 _ => unimplemented!(),
385 // Add functions which may be required for supertrait implementations.
386 walk_supertraits!(t, Some(&types), (
388 writeln!(w, "\t/// Called, if set, after this {} has been cloned into a duplicate object.", trait_name).unwrap();
389 writeln!(w, "\t/// The new {} is provided, and should be mutated as needed to perform a", trait_name).unwrap();
390 writeln!(w, "\t/// deep copy of the object pointed to by this_arg or avoid any double-freeing.").unwrap();
391 writeln!(w, "\tpub cloned: Option<extern \"C\" fn (new_{}: &mut {})>,", trait_name, trait_name).unwrap();
392 generated_fields.push(("cloned".to_owned(), None, None));
394 ("std::cmp::Eq", _, _)|("core::cmp::Eq", _, _) => {
395 let eq_docs = "Checks if two objects are equal given this object's this_arg pointer and another object.";
396 writeln!(w, "\t/// {}", eq_docs).unwrap();
397 writeln!(w, "\tpub eq: extern \"C\" fn (this_arg: *const c_void, other_arg: &{}) -> bool,", trait_name).unwrap();
398 generated_fields.push(("eq".to_owned(), None, Some(format!("\t/** {} */\n", eq_docs))));
400 ("std::hash::Hash", _, _)|("core::hash::Hash", _, _) => {
401 let hash_docs_a = "Calculate a succinct non-cryptographic hash for an object given its this_arg pointer.";
402 let hash_docs_b = "This is used, for example, for inclusion of this object in a hash map.";
403 writeln!(w, "\t/// {}", hash_docs_a).unwrap();
404 writeln!(w, "\t/// {}", hash_docs_b).unwrap();
405 writeln!(w, "\tpub hash: extern \"C\" fn (this_arg: *const c_void) -> u64,").unwrap();
406 generated_fields.push(("hash".to_owned(), None,
407 Some(format!("\t/**\n\t * {}\n\t * {}\n\t */\n", hash_docs_a, hash_docs_b))));
409 ("Send", _, _) => {}, ("Sync", _, _) => {},
410 ("std::fmt::Debug", _, _)|("core::fmt::Debug", _, _) => {
411 let debug_docs = "Return a human-readable \"debug\" string describing this object";
412 writeln!(w, "\t/// {}", debug_docs).unwrap();
413 writeln!(w, "\tpub debug_str: extern \"C\" fn (this_arg: *const c_void) -> crate::c_types::Str,").unwrap();
414 generated_fields.push(("debug_str".to_owned(), None,
415 Some(format!("\t/**\n\t * {}\n\t */\n", debug_docs))));
418 // TODO: Both of the below should expose supertrait methods in C++, but doing so is
420 generated_fields.push(if types.crate_types.traits.get(s).is_none() {
421 let (docs, name, ret) = convert_trait_impl_field(s);
422 writeln!(w, "\t/// {}", docs).unwrap();
423 writeln!(w, "\tpub {}: extern \"C\" fn (this_arg: *const c_void) -> {},", name, ret).unwrap();
424 (name, None, None) // Assume clonable
426 // For in-crate supertraits, just store a C-mapped copy of the supertrait as a member.
427 writeln!(w, "\t/// Implementation of {} for this object.", i).unwrap();
428 let is_clonable = types.is_clonable(s);
429 writeln!(w, "\tpub {}: crate::{},", i, s).unwrap();
430 (format!("{}", i), if !is_clonable {
431 Some((format!("crate::{}_clone_fields(", s), ")"))
432 } else { None }, None)
436 writeln!(w, "\t/// Frees any resources associated with this object given its this_arg pointer.").unwrap();
437 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();
438 writeln!(w, "\tpub free: Option<extern \"C\" fn(this_arg: *mut c_void)>,").unwrap();
439 generated_fields.push(("free".to_owned(), None, None));
440 writeln!(w, "}}").unwrap();
442 macro_rules! impl_trait_for_c {
443 ($t: expr, $impl_accessor: expr, $type_resolver: expr, $generic_impls: expr) => {
444 let mut trait_gen_types = gen_types.push_ctx();
445 assert!(trait_gen_types.learn_generics_with_impls(&$t.generics, $generic_impls, $type_resolver));
446 for item in $t.items.iter() {
448 syn::TraitItem::Method(m) => {
449 if let ExportStatus::TestOnly = export_status(&m.attrs) { continue; }
450 if m.sig.constness.is_some() || m.sig.asyncness.is_some() || m.sig.unsafety.is_some() ||
451 m.sig.abi.is_some() || m.sig.variadic.is_some() {
454 let mut meth_gen_types = trait_gen_types.push_ctx();
455 assert!(meth_gen_types.learn_generics(&m.sig.generics, $type_resolver));
456 // Note that we do *not* use the method generics when printing "native"
457 // rust parts - if the method is generic, we need to print a generic
459 write!(w, "\tfn {}", m.sig.ident).unwrap();
460 $type_resolver.write_rust_generic_param(w, Some(&gen_types), m.sig.generics.params.iter());
461 write!(w, "(").unwrap();
462 for inp in m.sig.inputs.iter() {
464 syn::FnArg::Receiver(recv) => {
465 if !recv.attrs.is_empty() || recv.reference.is_none() { panic!("2"); }
466 write!(w, "&").unwrap();
467 if let Some(lft) = &recv.reference.as_ref().unwrap().1 {
468 write!(w, "'{} ", lft.ident).unwrap();
470 if recv.mutability.is_some() {
471 write!(w, "mut self").unwrap();
473 write!(w, "self").unwrap();
476 syn::FnArg::Typed(arg) => {
477 if !arg.attrs.is_empty() { panic!("3"); }
479 syn::Pat::Ident(ident) => {
480 if !ident.attrs.is_empty() || ident.by_ref.is_some() ||
481 ident.mutability.is_some() || ident.subpat.is_some() {
484 write!(w, ", mut {}{}: ", if $type_resolver.skip_arg(&*arg.ty, Some(&meth_gen_types)) { "_" } else { "" }, ident.ident).unwrap();
488 $type_resolver.write_rust_type(w, Some(&gen_types), &*arg.ty, false);
492 write!(w, ")").unwrap();
493 match &m.sig.output {
494 syn::ReturnType::Type(_, rtype) => {
495 write!(w, " -> ").unwrap();
496 $type_resolver.write_rust_type(w, Some(&gen_types), &*rtype, false)
500 write!(w, " {{\n\t\t").unwrap();
501 match export_status(&m.attrs) {
502 ExportStatus::NoExport => {
507 if let syn::ReturnType::Type(_, rtype) = &m.sig.output {
508 if let syn::Type::Reference(r) = &**rtype {
509 assert_eq!(m.sig.inputs.len(), 1); // Must only take self!
510 writeln!(w, "if let Some(f) = self{}.set_{} {{", $impl_accessor, m.sig.ident).unwrap();
511 writeln!(w, "\t\t\t(f)(&self{});", $impl_accessor).unwrap();
512 write!(w, "\t\t}}\n\t\t").unwrap();
513 $type_resolver.write_from_c_conversion_to_ref_prefix(w, &*r.elem, Some(&meth_gen_types));
514 write!(w, "unsafe {{ &*self{}.{}.get() }}", $impl_accessor, m.sig.ident).unwrap();
515 $type_resolver.write_from_c_conversion_to_ref_suffix(w, &*r.elem, Some(&meth_gen_types));
516 writeln!(w, "\n\t}}").unwrap();
520 write_method_var_decl_body(w, &m.sig, "\t", $type_resolver, Some(&meth_gen_types), true);
521 write!(w, "(self{}.{})(", $impl_accessor, m.sig.ident).unwrap();
522 let mut args = Vec::new();
523 write_method_call_params(&mut args, &m.sig, "\t", $type_resolver, Some(&meth_gen_types), "", true);
524 w.write_all(String::from_utf8(args).unwrap().replace("self", &format!("self{}", $impl_accessor)).as_bytes()).unwrap();
526 writeln!(w, "\n\t}}").unwrap();
528 &syn::TraitItem::Type(ref t) => {
529 if t.default.is_some() || t.generics.lt_token.is_some() { panic!("10"); }
530 let mut bounds_iter = t.bounds.iter();
532 match bounds_iter.next().unwrap() {
533 syn::TypeParamBound::Trait(tr) => {
534 writeln!(w, "\ttype {} = crate::{};", t.ident, $type_resolver.resolve_path(&tr.path, Some(&gen_types))).unwrap();
535 for bound in bounds_iter {
536 if let syn::TypeParamBound::Trait(t) = bound {
537 // We only allow for `Sized` here.
538 assert_eq!(t.path.segments.len(), 1);
539 assert_eq!(format!("{}", t.path.segments[0].ident), "Sized");
544 syn::TypeParamBound::Lifetime(_) => {},
554 writeln!(w, "unsafe impl Send for {} {{}}", trait_name).unwrap();
555 writeln!(w, "unsafe impl Sync for {} {{}}", trait_name).unwrap();
557 writeln!(w, "pub(crate) fn {}_clone_fields(orig: &{}) -> {} {{", trait_name, trait_name, trait_name).unwrap();
558 writeln!(w, "\t{} {{", trait_name).unwrap();
559 writeln!(w, "\t\tthis_arg: orig.this_arg,").unwrap();
560 for (field, clone_fn, _) in generated_fields.iter() {
561 if let Some((pfx, sfx)) = clone_fn {
562 // If the field isn't clonable, blindly assume its a trait and hope for the best.
563 writeln!(w, "\t\t{}: {}&orig.{}{},", field, pfx, field, sfx).unwrap();
565 writeln!(w, "\t\t{}: Clone::clone(&orig.{}),", field, field).unwrap();
568 writeln!(w, "\t}}\n}}").unwrap();
570 // Implement supertraits for the C-mapped struct.
571 walk_supertraits!(t, Some(&types), (
572 ("std::cmp::Eq", _, _)|("core::cmp::Eq", _, _) => {
573 writeln!(w, "impl core::cmp::Eq for {} {{}}", trait_name).unwrap();
574 writeln!(w, "impl core::cmp::PartialEq for {} {{", trait_name).unwrap();
575 writeln!(w, "\tfn eq(&self, o: &Self) -> bool {{ (self.eq)(self.this_arg, o) }}\n}}").unwrap();
577 ("std::hash::Hash", _, _)|("core::hash::Hash", _, _) => {
578 writeln!(w, "impl core::hash::Hash for {} {{", trait_name).unwrap();
579 writeln!(w, "\tfn hash<H: core::hash::Hasher>(&self, hasher: &mut H) {{ hasher.write_u64((self.hash)(self.this_arg)) }}\n}}").unwrap();
581 ("Send", _, _) => {}, ("Sync", _, _) => {},
583 writeln!(w, "#[no_mangle]").unwrap();
584 writeln!(w, "/// Creates a copy of a {}", trait_name).unwrap();
585 writeln!(w, "pub extern \"C\" fn {}_clone(orig: &{}) -> {} {{", trait_name, trait_name, trait_name).unwrap();
586 writeln!(w, "\tlet mut res = {}_clone_fields(orig);", trait_name).unwrap();
587 writeln!(w, "\tif let Some(f) = orig.cloned {{ (f)(&mut res) }};").unwrap();
588 writeln!(w, "\tres\n}}").unwrap();
589 writeln!(w, "impl Clone for {} {{", trait_name).unwrap();
590 writeln!(w, "\tfn clone(&self) -> Self {{").unwrap();
591 writeln!(w, "\t\t{}_clone(self)", trait_name).unwrap();
592 writeln!(w, "\t}}\n}}").unwrap();
594 ("std::fmt::Debug", _, _)|("core::fmt::Debug", _, _) => {
595 writeln!(w, "impl core::fmt::Debug for {} {{", trait_name).unwrap();
596 writeln!(w, "\tfn fmt(&self, f: &mut core::fmt::Formatter) -> Result<(), core::fmt::Error> {{").unwrap();
597 writeln!(w, "\t\tf.write_str((self.debug_str)(self.this_arg).into_str())").unwrap();
598 writeln!(w, "\t}}").unwrap();
599 writeln!(w, "}}").unwrap();
601 (s, i, generic_args) => {
602 if let Some(supertrait) = types.crate_types.traits.get(s) {
603 let resolver = get_module_type_resolver!(s, types.crate_libs, types.crate_types);
604 macro_rules! impl_supertrait {
605 ($s: expr, $supertrait: expr, $i: expr, $generic_args: expr) => {
606 let resolver = get_module_type_resolver!($s, types.crate_libs, types.crate_types);
608 // Blindly assume that the same imports where `supertrait` is defined are also
609 // imported here. This will almost certainly break at some point, but it should be
610 // a compilation failure when it does so.
611 write!(w, "impl").unwrap();
612 maybe_write_lifetime_generics(w, &$supertrait.generics, types);
613 write!(w, " {}", $s).unwrap();
614 maybe_write_generics(w, &$supertrait.generics, $generic_args, types, false);
615 writeln!(w, " for {} {{", trait_name).unwrap();
617 impl_trait_for_c!($supertrait, format!(".{}", $i), &resolver, $generic_args);
618 writeln!(w, "}}").unwrap();
621 impl_supertrait!(s, supertrait, i, generic_args);
622 walk_supertraits!(supertrait, Some(&resolver), (
623 (s, supertrait_i, generic_args) => {
624 if let Some(supertrait) = types.crate_types.traits.get(s) {
625 impl_supertrait!(s, supertrait, format!("{}.{}", i, supertrait_i), generic_args);
630 do_write_impl_trait(w, s, i, &trait_name);
635 // Finally, implement the original Rust trait for the newly created mapped trait.
636 writeln!(w, "\nuse {}::{} as rust{};", types.module_path, t.ident, trait_name).unwrap();
638 write!(w, "impl").unwrap();
639 maybe_write_lifetime_generics(w, &t.generics, types);
640 write!(w, " rust{}", t.ident).unwrap();
641 maybe_write_generics(w, &t.generics, &syn::PathArguments::None, types, false);
642 writeln!(w, " for {} {{", trait_name).unwrap();
643 impl_trait_for_c!(t, "", types, &syn::PathArguments::None);
644 writeln!(w, "}}\n").unwrap();
645 writeln!(w, "// We're essentially a pointer already, or at least a set of pointers, so allow us to be used").unwrap();
646 writeln!(w, "// directly as a Deref trait in higher-level structs:").unwrap();
647 writeln!(w, "impl core::ops::Deref for {} {{\n\ttype Target = Self;", trait_name).unwrap();
648 writeln!(w, "\tfn deref(&self) -> &Self {{\n\t\tself\n\t}}\n}}").unwrap();
649 writeln!(w, "impl core::ops::DerefMut for {} {{", trait_name).unwrap();
650 writeln!(w, "\tfn deref_mut(&mut self) -> &mut Self {{\n\t\tself\n\t}}\n}}").unwrap();
653 writeln!(w, "/// Calls the free function if one is set").unwrap();
654 writeln!(w, "#[no_mangle]\npub extern \"C\" fn {}_free(this_ptr: {}) {{ }}", trait_name, trait_name).unwrap();
655 writeln!(w, "impl Drop for {} {{", trait_name).unwrap();
656 writeln!(w, "\tfn drop(&mut self) {{").unwrap();
657 writeln!(w, "\t\tif let Some(f) = self.free {{").unwrap();
658 writeln!(w, "\t\t\tf(self.this_arg);").unwrap();
659 writeln!(w, "\t\t}}\n\t}}\n}}").unwrap();
661 write_cpp_wrapper(cpp_headers, &trait_name, true, Some(generated_fields.drain(..)
662 .filter_map(|(name, _, docs)| if let Some(docs) = docs { Some((name, docs)) } else { None }).collect()));
665 /// Write out a simple "opaque" type (eg structs) which contain a pointer to the native Rust type
666 /// and a flag to indicate whether Drop'ing the mapped struct drops the underlying Rust type.
668 /// Also writes out a _free function and a C++ wrapper which handles calling _free.
669 fn writeln_opaque<W: std::io::Write>(w: &mut W, ident: &syn::Ident, struct_name: &str, generics: &syn::Generics, attrs: &[syn::Attribute], types: &TypeResolver, extra_headers: &mut File, cpp_headers: &mut File) {
670 // If we directly read the original type by its original name, cbindgen hits
671 // https://github.com/eqrion/cbindgen/issues/286 Thus, instead, we import it as a temporary
672 // name and then reference it by that name, which works around the issue.
673 write!(w, "\nuse {}::{} as native{}Import;\npub(crate) type native{} = native{}Import", types.module_path, ident, ident, ident, ident).unwrap();
674 maybe_write_generics(w, &generics, &syn::PathArguments::None, &types, true);
675 writeln!(w, ";\n").unwrap();
676 writeln!(extra_headers, "struct native{}Opaque;\ntypedef struct native{}Opaque LDKnative{};", ident, ident, ident).unwrap();
677 writeln_docs(w, &attrs, "");
678 writeln!(w, "#[must_use]\n#[repr(C)]\npub struct {} {{", struct_name).unwrap();
679 writeln!(w, "\t/// A pointer to the opaque Rust object.\n").unwrap();
680 writeln!(w, "\t/// Nearly everywhere, inner must be non-null, however in places where").unwrap();
681 writeln!(w, "\t/// the Rust equivalent takes an Option, it may be set to null to indicate None.").unwrap();
682 writeln!(w, "\tpub inner: *mut native{},", ident).unwrap();
683 writeln!(w, "\t/// Indicates that this is the only struct which contains the same pointer.\n").unwrap();
684 writeln!(w, "\t/// Rust functions which take ownership of an object provided via an argument require").unwrap();
685 writeln!(w, "\t/// this to be true and invalidate the object pointed to by inner.").unwrap();
686 writeln!(w, "\tpub is_owned: bool,").unwrap();
687 writeln!(w, "}}\n").unwrap();
688 writeln!(w, "impl Drop for {} {{\n\tfn drop(&mut self) {{", struct_name).unwrap();
689 writeln!(w, "\t\tif self.is_owned && !<*mut native{}>::is_null(self.inner) {{", ident).unwrap();
690 writeln!(w, "\t\t\tlet _ = unsafe {{ Box::from_raw(ObjOps::untweak_ptr(self.inner)) }};\n\t\t}}\n\t}}\n}}").unwrap();
691 writeln!(w, "/// Frees any resources used by the {}, if is_owned is set and inner is non-NULL.", struct_name).unwrap();
692 writeln!(w, "#[no_mangle]\npub extern \"C\" fn {}_free(this_obj: {}) {{ }}", struct_name, struct_name).unwrap();
693 writeln!(w, "#[allow(unused)]").unwrap();
694 writeln!(w, "/// Used only if an object of this type is returned as a trait impl by a method").unwrap();
695 writeln!(w, "pub(crate) extern \"C\" fn {}_free_void(this_ptr: *mut c_void) {{", struct_name).unwrap();
696 writeln!(w, "\tlet _ = unsafe {{ Box::from_raw(this_ptr as *mut native{}) }};\n}}", struct_name).unwrap();
697 writeln!(w, "#[allow(unused)]").unwrap();
698 writeln!(w, "impl {} {{", struct_name).unwrap();
699 writeln!(w, "\tpub(crate) fn get_native_ref(&self) -> &'static native{} {{", struct_name).unwrap();
700 writeln!(w, "\t\tunsafe {{ &*ObjOps::untweak_ptr(self.inner) }}").unwrap();
701 writeln!(w, "\t}}").unwrap();
702 writeln!(w, "\tpub(crate) fn get_native_mut_ref(&self) -> &'static mut native{} {{", struct_name).unwrap();
703 writeln!(w, "\t\tunsafe {{ &mut *ObjOps::untweak_ptr(self.inner) }}").unwrap();
704 writeln!(w, "\t}}").unwrap();
705 writeln!(w, "\t/// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy").unwrap();
706 writeln!(w, "\tpub(crate) fn take_inner(mut self) -> *mut native{} {{", struct_name).unwrap();
707 writeln!(w, "\t\tassert!(self.is_owned);").unwrap();
708 writeln!(w, "\t\tlet ret = ObjOps::untweak_ptr(self.inner);").unwrap();
709 writeln!(w, "\t\tself.inner = core::ptr::null_mut();").unwrap();
710 writeln!(w, "\t\tret").unwrap();
711 writeln!(w, "\t}}\n}}").unwrap();
713 write_cpp_wrapper(cpp_headers, &format!("{}", ident), true, None);
716 /// Writes out all the relevant mappings for a Rust struct, deferring to writeln_opaque to generate
717 /// the struct itself, and then writing getters and setters for public, understood-type fields and
718 /// a constructor if every field is public.
719 fn writeln_struct<'a, 'b, W: std::io::Write>(w: &mut W, s: &'a syn::ItemStruct, types: &mut TypeResolver<'b, 'a>, extra_headers: &mut File, cpp_headers: &mut File) {
720 if export_status(&s.attrs) != ExportStatus::Export { return; }
722 let struct_name = &format!("{}", s.ident);
723 writeln_opaque(w, &s.ident, struct_name, &s.generics, &s.attrs, types, extra_headers, cpp_headers);
725 let mut self_path_segs = syn::punctuated::Punctuated::new();
726 self_path_segs.push(s.ident.clone().into());
727 let self_path = syn::Path { leading_colon: None, segments: self_path_segs};
728 let mut gen_types = GenericTypes::new(Some(types.resolve_path(&self_path, None)));
729 assert!(gen_types.learn_generics(&s.generics, types));
731 let mut all_fields_settable = true;
732 macro_rules! define_field {
733 ($new_name: expr, $real_name: expr, $field: expr) => {
734 if let syn::Visibility::Public(_) = $field.vis {
735 let export = export_status(&$field.attrs);
737 ExportStatus::Export => {},
738 ExportStatus::NoExport|ExportStatus::TestOnly => {
739 all_fields_settable = false;
742 ExportStatus::NotImplementable => panic!("(C-not implementable) must only appear on traits"),
745 if let Some(ref_type) = types.create_ownable_reference(&$field.ty, Some(&gen_types)) {
746 if types.understood_c_type(&ref_type, Some(&gen_types)) {
747 writeln_arg_docs(w, &$field.attrs, "", types, Some(&gen_types), vec![].drain(..), Some(&ref_type));
748 write!(w, "#[no_mangle]\npub extern \"C\" fn {}_get_{}(this_ptr: &{}) -> ", struct_name, $new_name, struct_name).unwrap();
749 types.write_c_type(w, &ref_type, Some(&gen_types), true);
750 write!(w, " {{\n\tlet mut inner_val = &mut this_ptr.get_native_mut_ref().{};\n\t", $real_name).unwrap();
751 let local_var = types.write_to_c_conversion_from_ownable_ref_new_var(w, &format_ident!("inner_val"), &ref_type, Some(&gen_types));
752 if local_var { write!(w, "\n\t").unwrap(); }
753 types.write_to_c_conversion_inline_prefix(w, &ref_type, Some(&gen_types), true);
754 write!(w, "inner_val").unwrap();
755 types.write_to_c_conversion_inline_suffix(w, &ref_type, Some(&gen_types), true);
756 writeln!(w, "\n}}").unwrap();
758 // If the type isn't reference-able, but is clonable, export a getter that just clones
759 if types.understood_c_type(&$field.ty, Some(&gen_types)) {
760 let mut v = Vec::new();
761 types.write_c_type(&mut v, &$field.ty, Some(&gen_types), true);
762 let s = String::from_utf8(v).unwrap();
763 if types.is_clonable(&s) {
764 writeln_arg_docs(w, &$field.attrs, "", types, Some(&gen_types), vec![].drain(..), Some(&$field.ty));
765 writeln!(w, "///\n/// Returns a copy of the field.").unwrap();
766 write!(w, "#[no_mangle]\npub extern \"C\" fn {}_get_{}(this_ptr: &{}) -> {}", struct_name, $new_name, struct_name, s).unwrap();
767 write!(w, " {{\n\tlet mut inner_val = this_ptr.get_native_mut_ref().{}.clone();\n\t", $real_name).unwrap();
768 let local_var = types.write_to_c_conversion_new_var(w, &format_ident!("inner_val"), &$field.ty, Some(&gen_types), true);
769 if local_var { write!(w, "\n\t").unwrap(); }
770 types.write_to_c_conversion_inline_prefix(w, &$field.ty, Some(&gen_types), true);
771 write!(w, "inner_val").unwrap();
772 types.write_to_c_conversion_inline_suffix(w, &$field.ty, Some(&gen_types), true);
773 writeln!(w, "\n}}").unwrap();
779 if types.understood_c_type(&$field.ty, Some(&gen_types)) {
780 writeln_arg_docs(w, &$field.attrs, "", types, Some(&gen_types), vec![("val".to_owned(), &$field.ty)].drain(..), None);
781 write!(w, "#[no_mangle]\npub extern \"C\" fn {}_set_{}(this_ptr: &mut {}, mut val: ", struct_name, $new_name, struct_name).unwrap();
782 types.write_c_type(w, &$field.ty, Some(&gen_types), false);
783 write!(w, ") {{\n\t").unwrap();
784 let local_var = types.write_from_c_conversion_new_var(w, &format_ident!("val"), &$field.ty, Some(&gen_types));
785 if local_var { write!(w, "\n\t").unwrap(); }
786 write!(w, "unsafe {{ &mut *ObjOps::untweak_ptr(this_ptr.inner) }}.{} = ", $real_name).unwrap();
787 types.write_from_c_conversion_prefix(w, &$field.ty, Some(&gen_types));
788 write!(w, "val").unwrap();
789 types.write_from_c_conversion_suffix(w, &$field.ty, Some(&gen_types));
790 writeln!(w, ";\n}}").unwrap();
791 } else { all_fields_settable = false; }
792 } else { all_fields_settable = false; }
797 syn::Fields::Named(fields) => {
798 for field in fields.named.iter() {
799 if let Some(ident) = &field.ident {
800 define_field!(ident, ident, field);
801 } else { all_fields_settable = false; }
804 syn::Fields::Unnamed(fields) => {
805 for (idx, field) in fields.unnamed.iter().enumerate() {
806 define_field!(('a' as u8 + idx as u8) as char, ('0' as u8 + idx as u8) as char, field);
809 syn::Fields::Unit => {},
812 if all_fields_settable {
813 // Build a constructor!
814 writeln!(w, "/// Constructs a new {} given each field", struct_name).unwrap();
815 write!(w, "#[must_use]\n#[no_mangle]\npub extern \"C\" fn {}_new(", struct_name).unwrap();
818 syn::Fields::Named(fields) => {
819 for (idx, field) in fields.named.iter().enumerate() {
820 if idx != 0 { write!(w, ", ").unwrap(); }
821 write!(w, "mut {}_arg: ", field.ident.as_ref().unwrap()).unwrap();
822 types.write_c_type(w, &field.ty, Some(&gen_types), false);
825 syn::Fields::Unnamed(fields) => {
826 for (idx, field) in fields.unnamed.iter().enumerate() {
827 if idx != 0 { write!(w, ", ").unwrap(); }
828 write!(w, "mut {}_arg: ", ('a' as u8 + idx as u8) as char).unwrap();
829 types.write_c_type(w, &field.ty, Some(&gen_types), false);
832 syn::Fields::Unit => {},
834 write!(w, ") -> {} {{\n\t", struct_name).unwrap();
836 syn::Fields::Named(fields) => {
837 for field in fields.named.iter() {
838 let field_ident = format_ident!("{}_arg", field.ident.as_ref().unwrap());
839 if types.write_from_c_conversion_new_var(w, &field_ident, &field.ty, Some(&gen_types)) {
840 write!(w, "\n\t").unwrap();
844 syn::Fields::Unnamed(fields) => {
845 for (idx, field) in fields.unnamed.iter().enumerate() {
846 let field_ident = format_ident!("{}_arg", ('a' as u8 + idx as u8) as char);
847 if types.write_from_c_conversion_new_var(w, &field_ident, &field.ty, Some(&gen_types)) {
848 write!(w, "\n\t").unwrap();
852 syn::Fields::Unit => {},
854 write!(w, "{} {{ inner: ObjOps::heap_alloc(", struct_name).unwrap();
856 syn::Fields::Named(fields) => {
857 writeln!(w, "native{} {{", s.ident).unwrap();
858 for field in fields.named.iter() {
859 write!(w, "\t\t{}: ", field.ident.as_ref().unwrap()).unwrap();
860 types.write_from_c_conversion_prefix(w, &field.ty, Some(&gen_types));
861 write!(w, "{}_arg", field.ident.as_ref().unwrap()).unwrap();
862 types.write_from_c_conversion_suffix(w, &field.ty, Some(&gen_types));
863 writeln!(w, ",").unwrap();
865 write!(w, "\t}}").unwrap();
867 syn::Fields::Unnamed(fields) => {
868 assert!(!s.generics.params.iter()
869 .any(|gen| if let syn::GenericParam::Lifetime(_) = gen { false } else { true }));
870 writeln!(w, "{} (", types.maybe_resolve_ident(&s.ident).unwrap()).unwrap();
871 for (idx, field) in fields.unnamed.iter().enumerate() {
872 write!(w, "\t\t").unwrap();
873 types.write_from_c_conversion_prefix(w, &field.ty, Some(&gen_types));
874 write!(w, "{}_arg", ('a' as u8 + idx as u8) as char).unwrap();
875 types.write_from_c_conversion_suffix(w, &field.ty, Some(&gen_types));
876 writeln!(w, ",").unwrap();
878 write!(w, "\t)").unwrap();
880 syn::Fields::Unit => write!(w, "{}::{} {{}}", types.module_path, struct_name).unwrap(),
882 writeln!(w, "), is_owned: true }}\n}}").unwrap();
886 /// Prints a relevant conversion for impl *
888 /// For simple impl Struct {}s, this just outputs the wrapper functions as Struct_fn_name() { .. }.
890 /// For impl Trait for Struct{}s, this non-exported generates wrapper functions as
891 /// Trait_Struct_fn_name and a Struct_as_Trait(&struct) -> Trait function which returns a populated
892 /// Trait struct containing a pointer to the passed struct's inner field and the wrapper functions.
894 /// A few non-crate Traits are hard-coded including Default.
895 fn writeln_impl<W: std::io::Write>(w: &mut W, w_uses: &mut HashSet<String, NonRandomHash>, i: &syn::ItemImpl, types: &mut TypeResolver) {
896 match export_status(&i.attrs) {
897 ExportStatus::Export => {},
898 ExportStatus::NoExport|ExportStatus::TestOnly => return,
899 ExportStatus::NotImplementable => panic!("(C-not implementable) must only appear on traits"),
902 if let syn::Type::Tuple(_) = &*i.self_ty {
903 if types.understood_c_type(&*i.self_ty, None) {
904 let mut gen_types = GenericTypes::new(None);
905 if !gen_types.learn_generics(&i.generics, types) {
906 eprintln!("Not implementing anything for `impl (..)` due to not understood generics");
910 if i.defaultness.is_some() || i.unsafety.is_some() { unimplemented!(); }
911 if let Some(trait_path) = i.trait_.as_ref() {
912 if trait_path.0.is_some() { unimplemented!(); }
913 if types.understood_c_path(&trait_path.1) {
914 eprintln!("Not implementing anything for `impl Trait for (..)` - we only support manual defines");
917 // Just do a manual implementation:
918 maybe_convert_trait_impl(w, &trait_path.1, &*i.self_ty, types, &gen_types);
921 eprintln!("Not implementing anything for plain `impl (..)` block - we only support `impl Trait for (..)` blocks");
927 if let &syn::Type::Path(ref p) = &*i.self_ty {
928 if p.qself.is_some() { unimplemented!(); }
929 let ident = &p.path.segments.last().unwrap().ident;
930 if let Some(resolved_path) = types.maybe_resolve_path(&p.path, None) {
931 if types.crate_types.opaques.contains_key(&resolved_path) || types.crate_types.mirrored_enums.contains_key(&resolved_path) ||
932 // At least for core::infallible::Infallible we need to support mapping an
933 // out-of-crate trait implementation.
934 (types.understood_c_path(&p.path) && first_seg_is_stdlib(resolved_path.split("::").next().unwrap())) {
935 if !types.understood_c_path(&p.path) {
936 eprintln!("Not implementing anything for impl {} as the type is not understood (probably C-not exported)", ident);
940 let mut gen_types = GenericTypes::new(Some(resolved_path.clone()));
941 if !gen_types.learn_generics(&i.generics, types) {
942 eprintln!("Not implementing anything for impl {} due to not understood generics", ident);
946 if i.defaultness.is_some() || i.unsafety.is_some() { unimplemented!(); }
947 if let Some(trait_path) = i.trait_.as_ref() {
948 if trait_path.0.is_some() { unimplemented!(); }
949 let full_trait_path_opt = types.maybe_resolve_path(&trait_path.1, None);
950 let trait_obj_opt = full_trait_path_opt.as_ref().and_then(|path| types.crate_types.traits.get(path));
951 if types.understood_c_path(&trait_path.1) && trait_obj_opt.is_some() {
952 let full_trait_path = full_trait_path_opt.unwrap();
953 let trait_obj = *trait_obj_opt.unwrap();
956 let supertrait_resolver;
957 walk_supertraits!(trait_obj, Some(&types), (
959 if let Some(supertrait) = types.crate_types.traits.get(s) {
960 supertrait_name = s.to_string();
961 supertrait_resolver = get_module_type_resolver!(supertrait_name, types.crate_libs, types.crate_types);
962 gen_types.learn_associated_types(&supertrait, &supertrait_resolver);
967 // We learn the associated types maping from the original trait object.
968 // That's great, except that they are unresolved idents, so if we learn
969 // mappings from a trai defined in a different file, we may mis-resolve or
970 // fail to resolve the mapped types. Thus, we have to construct a new
971 // resolver for the module that the trait was defined in here first.
972 let mut trait_resolver = get_module_type_resolver!(full_trait_path, types.crate_libs, types.crate_types);
973 gen_types.learn_associated_types(trait_obj, &trait_resolver);
974 let mut impl_associated_types = HashMap::new();
975 for item in i.items.iter() {
977 syn::ImplItem::Type(t) => {
978 if let syn::Type::Path(p) = &t.ty {
979 if let Some(id) = single_ident_generic_path_to_ident(&p.path) {
980 impl_associated_types.insert(&t.ident, id);
988 let export = export_status(&trait_obj.attrs);
990 ExportStatus::Export|ExportStatus::NotImplementable => {},
991 ExportStatus::NoExport|ExportStatus::TestOnly => return,
994 // For cases where we have a concrete native object which implements a
995 // trait and need to return the C-mapped version of the trait, provide a
996 // From<> implementation which does all the work to ensure free is handled
997 // properly. This way we can call this method from deep in the
998 // type-conversion logic without actually knowing the concrete native type.
999 if !resolved_path.starts_with(types.module_path) {
1000 if !first_seg_is_stdlib(resolved_path.split("::").next().unwrap()) {
1001 w_uses.insert(format!("use crate::{}::native{} as native{};", resolved_path.rsplitn(2, "::").skip(1).next().unwrap(), ident, ident));
1002 w_uses.insert(format!("use crate::{};", resolved_path));
1003 w_uses.insert(format!("use crate::{}_free_void;", resolved_path));
1005 w_uses.insert(format!("use {} as native{};", resolved_path, ident));
1008 writeln!(w, "impl From<native{}> for crate::{} {{", ident, full_trait_path).unwrap();
1009 writeln!(w, "\tfn from(obj: native{}) -> Self {{", ident).unwrap();
1010 if is_type_unconstructable(&resolved_path) {
1011 writeln!(w, "\t\tunreachable!();").unwrap();
1013 writeln!(w, "\t\tlet mut rust_obj = {} {{ inner: ObjOps::heap_alloc(obj), is_owned: true }};", ident).unwrap();
1014 writeln!(w, "\t\tlet mut ret = {}_as_{}(&rust_obj);", ident, trait_obj.ident).unwrap();
1015 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();
1016 writeln!(w, "\t\trust_obj.inner = core::ptr::null_mut();").unwrap();
1017 writeln!(w, "\t\tret.free = Some({}_free_void);", ident).unwrap();
1018 writeln!(w, "\t\tret").unwrap();
1020 writeln!(w, "\t}}\n}}").unwrap();
1021 if is_type_unconstructable(&resolved_path) {
1022 // We don't bother with Struct_as_Trait conversion for types which must
1023 // never be instantiated, so just return early.
1027 writeln!(w, "/// Constructs a new {} which calls the relevant methods on this_arg.", trait_obj.ident).unwrap();
1028 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();
1029 write!(w, "#[no_mangle]\npub extern \"C\" fn {}_as_{}(this_arg: &{}) -> crate::{} {{\n", ident, trait_obj.ident, ident, full_trait_path).unwrap();
1030 writeln!(w, "\tcrate::{} {{", full_trait_path).unwrap();
1031 writeln!(w, "\t\tthis_arg: unsafe {{ ObjOps::untweak_ptr((*this_arg).inner) as *mut c_void }},").unwrap();
1032 writeln!(w, "\t\tfree: None,").unwrap();
1034 macro_rules! write_meth {
1035 ($m: expr, $trait: expr, $indent: expr) => {
1036 let trait_method = $trait.items.iter().filter_map(|item| {
1037 if let syn::TraitItem::Method(t_m) = item { Some(t_m) } else { None }
1038 }).find(|trait_meth| trait_meth.sig.ident == $m.sig.ident).unwrap();
1039 match export_status(&trait_method.attrs) {
1040 ExportStatus::Export => {},
1041 ExportStatus::NoExport => {
1042 write!(w, "{}\t\t//XXX: Need to export {}\n", $indent, $m.sig.ident).unwrap();
1045 ExportStatus::TestOnly => continue,
1046 ExportStatus::NotImplementable => panic!("(C-not implementable) must only appear on traits"),
1049 let mut printed = false;
1050 if let syn::ReturnType::Type(_, rtype) = &$m.sig.output {
1051 if let syn::Type::Reference(r) = &**rtype {
1052 write!(w, "\n\t\t{}{}: ", $indent, $m.sig.ident).unwrap();
1053 types.write_empty_rust_val(Some(&gen_types), w, &*r.elem);
1054 writeln!(w, ".into(),\n{}\t\tset_{}: Some({}_{}_set_{}),", $indent, $m.sig.ident, ident, $trait.ident, $m.sig.ident).unwrap();
1059 write!(w, "{}\t\t{}: {}_{}_{},\n", $indent, $m.sig.ident, ident, $trait.ident, $m.sig.ident).unwrap();
1063 for item in trait_obj.items.iter() {
1065 syn::TraitItem::Method(m) => {
1066 write_meth!(m, trait_obj, "");
1071 let mut requires_clone = false;
1072 walk_supertraits!(trait_obj, Some(&types), (
1073 ("Clone", _, _) => {
1074 requires_clone = true;
1075 writeln!(w, "\t\tcloned: Some({}_{}_cloned),", trait_obj.ident, ident).unwrap();
1077 ("Sync", _, _) => {}, ("Send", _, _) => {},
1078 ("std::marker::Sync", _, _) => {}, ("std::marker::Send", _, _) => {},
1079 ("core::fmt::Debug", _, _) => {},
1081 if let Some(supertrait_obj) = types.crate_types.traits.get(s) {
1082 macro_rules! write_impl_fields {
1083 ($s: expr, $supertrait_obj: expr, $t: expr, $pfx: expr, $resolver: expr) => {
1084 writeln!(w, "{}\t{}: crate::{} {{", $pfx, $t, $s).unwrap();
1085 writeln!(w, "{}\t\tthis_arg: unsafe {{ ObjOps::untweak_ptr((*this_arg).inner) as *mut c_void }},", $pfx).unwrap();
1086 writeln!(w, "{}\t\tfree: None,", $pfx).unwrap();
1087 for item in $supertrait_obj.items.iter() {
1089 syn::TraitItem::Method(m) => {
1090 write_meth!(m, $supertrait_obj, $pfx);
1095 walk_supertraits!($supertrait_obj, Some(&$resolver), (
1096 ("Clone", _, _) => {
1097 writeln!(w, "{}\tcloned: Some({}_{}_cloned),", $pfx, $supertrait_obj.ident, ident).unwrap();
1103 write_impl_fields!(s, supertrait_obj, t, "\t", types);
1105 let resolver = get_module_type_resolver!(s, types.crate_libs, types.crate_types);
1106 walk_supertraits!(supertrait_obj, Some(&resolver), (
1108 if let Some(supertrait_obj) = types.crate_types.traits.get(s) {
1109 write_impl_fields!(s, supertrait_obj, t, "\t\t", resolver);
1110 write!(w, "\t\t\t}},\n").unwrap();
1114 write!(w, "\t\t}},\n").unwrap();
1116 write_trait_impl_field_assign(w, s, ident);
1120 writeln!(w, "\t}}\n}}\n").unwrap();
1122 macro_rules! impl_meth {
1123 ($m: expr, $trait_meth: expr, $trait_path: expr, $trait: expr, $indent: expr, $types: expr) => {
1124 let trait_method = $trait.items.iter().filter_map(|item| {
1125 if let syn::TraitItem::Method(t_m) = item { Some(t_m) } else { None }
1126 }).find(|trait_meth| trait_meth.sig.ident == $m.sig.ident).unwrap();
1127 match export_status(&trait_method.attrs) {
1128 ExportStatus::Export => {},
1129 ExportStatus::NoExport|ExportStatus::TestOnly => continue,
1130 ExportStatus::NotImplementable => panic!("(C-not implementable) must only appear on traits"),
1133 if let syn::ReturnType::Type(_, _) = &$m.sig.output {
1134 writeln!(w, "#[must_use]").unwrap();
1136 write!(w, "extern \"C\" fn {}_{}_{}(", ident, $trait.ident, $m.sig.ident).unwrap();
1137 let mut meth_gen_types = gen_types.push_ctx();
1138 assert!(meth_gen_types.learn_generics(&$m.sig.generics, $types));
1139 let mut uncallable_function = false;
1140 for inp in $m.sig.inputs.iter() {
1142 syn::FnArg::Typed(arg) => {
1143 if $types.skip_arg(&*arg.ty, Some(&meth_gen_types)) { continue; }
1144 let mut c_type = Vec::new();
1145 $types.write_c_type(&mut c_type, &*arg.ty, Some(&meth_gen_types), false);
1146 if is_type_unconstructable(&String::from_utf8(c_type).unwrap()) {
1147 uncallable_function = true;
1153 write_method_params(w, &$trait_meth.sig, "c_void", &mut trait_resolver, Some(&meth_gen_types), true, true);
1154 write!(w, " {{\n\t").unwrap();
1155 if uncallable_function {
1156 write!(w, "unreachable!();").unwrap();
1158 write_method_var_decl_body(w, &$trait_meth.sig, "", &mut trait_resolver, Some(&meth_gen_types), false);
1159 let mut takes_self = false;
1160 for inp in $m.sig.inputs.iter() {
1161 if let syn::FnArg::Receiver(_) = inp {
1166 let mut t_gen_args = String::new();
1167 for (idx, _) in $trait.generics.params.iter().enumerate() {
1168 if idx != 0 { t_gen_args += ", " };
1171 // rustc doesn't like <_> if the _ is actually a lifetime, so
1172 // if all the parameters are lifetimes just skip it.
1173 let mut nonlifetime_param = false;
1174 for param in $trait.generics.params.iter() {
1175 if let syn::GenericParam::Lifetime(_) = param {}
1176 else { nonlifetime_param = true; }
1178 if !nonlifetime_param { t_gen_args = String::new(); }
1180 write!(w, "<native{} as {}<{}>>::{}(unsafe {{ &mut *(this_arg as *mut native{}) }}, ", ident, $trait_path, t_gen_args, $m.sig.ident, ident).unwrap();
1182 write!(w, "<native{} as {}<{}>>::{}(", ident, $trait_path, t_gen_args, $m.sig.ident).unwrap();
1185 let mut real_type = "".to_string();
1186 match &$m.sig.output {
1187 syn::ReturnType::Type(_, rtype) => {
1188 if let Some(mut remaining_path) = first_seg_self(&*rtype) {
1189 if let Some(associated_seg) = get_single_remaining_path_seg(&mut remaining_path) {
1190 real_type = format!("{}", impl_associated_types.get(associated_seg).unwrap());
1196 write_method_call_params(w, &$trait_meth.sig, "", &mut trait_resolver, Some(&meth_gen_types), &real_type, false);
1198 write!(w, "\n}}\n").unwrap();
1199 if let syn::ReturnType::Type(_, rtype) = &$m.sig.output {
1200 if let syn::Type::Reference(r) = &**rtype {
1201 assert_eq!($m.sig.inputs.len(), 1); // Must only take self
1202 writeln!(w, "extern \"C\" fn {}_{}_set_{}(trait_self_arg: &{}) {{", ident, $trait.ident, $m.sig.ident, $trait.ident).unwrap();
1203 writeln!(w, "\t// This is a bit race-y in the general case, but for our specific use-cases today, we're safe").unwrap();
1204 writeln!(w, "\t// Specifically, we must ensure that the first time we're called it can never be in parallel").unwrap();
1205 write!(w, "\tif ").unwrap();
1206 $types.write_empty_rust_val_check(Some(&meth_gen_types), w, &*r.elem, &format!("unsafe {{ &*trait_self_arg.{}.get() }}", $m.sig.ident));
1207 writeln!(w, " {{").unwrap();
1208 writeln!(w, "\t\t*unsafe {{ &mut *(&*(trait_self_arg as *const {})).{}.get() }} = {}_{}_{}(trait_self_arg.this_arg).into();", $trait.ident, $m.sig.ident, ident, $trait.ident, $m.sig.ident).unwrap();
1209 writeln!(w, "\t}}").unwrap();
1210 writeln!(w, "}}").unwrap();
1216 'impl_item_loop: for trait_item in trait_obj.items.iter() {
1218 syn::TraitItem::Method(meth) => {
1219 for item in i.items.iter() {
1221 syn::ImplItem::Method(m) => {
1222 if meth.sig.ident == m.sig.ident {
1223 impl_meth!(m, meth, full_trait_path, trait_obj, "", types);
1224 continue 'impl_item_loop;
1227 syn::ImplItem::Type(_) => {},
1228 _ => unimplemented!(),
1231 assert!(meth.default.is_some());
1232 let old_gen_types = gen_types;
1233 gen_types = GenericTypes::new(Some(resolved_path.clone()));
1234 impl_meth!(meth, meth, full_trait_path, trait_obj, "", &mut trait_resolver);
1235 gen_types = old_gen_types;
1241 writeln!(w, "extern \"C\" fn {}_{}_cloned(new_obj: &mut crate::{}) {{", trait_obj.ident, ident, full_trait_path).unwrap();
1242 writeln!(w, "\tnew_obj.this_arg = {}_clone_void(new_obj.this_arg);", ident).unwrap();
1243 writeln!(w, "\tnew_obj.free = Some({}_free_void);", ident).unwrap();
1244 walk_supertraits!(trait_obj, Some(&types), (
1246 if types.crate_types.traits.get(s).is_some() {
1247 assert!(!types.is_clonable(s)); // We don't currently support cloning with a clonable supertrait
1248 writeln!(w, "\tnew_obj.{}.this_arg = new_obj.this_arg;", t).unwrap();
1249 writeln!(w, "\tnew_obj.{}.free = None;", t).unwrap();
1253 writeln!(w, "}}").unwrap();
1255 write!(w, "\n").unwrap();
1258 if is_type_unconstructable(&resolved_path) {
1259 // Don't bother exposing trait implementations for objects which cannot be
1263 if path_matches_nongeneric(&trait_path.1, &["From"]) {
1264 } else if path_matches_nongeneric(&trait_path.1, &["Default"]) {
1265 writeln!(w, "/// Creates a \"default\" {}. See struct and individual field documentaiton for details on which values are used.", ident).unwrap();
1266 write!(w, "#[must_use]\n#[no_mangle]\npub extern \"C\" fn {}_default() -> {} {{\n", ident, ident).unwrap();
1267 write!(w, "\t{} {{ inner: ObjOps::heap_alloc(Default::default()), is_owned: true }}\n", ident).unwrap();
1268 write!(w, "}}\n").unwrap();
1269 } else if path_matches_nongeneric(&trait_path.1, &["core", "cmp", "PartialEq"]) {
1270 } else if path_matches_nongeneric(&trait_path.1, &["core", "cmp", "Eq"]) {
1271 writeln!(w, "/// Checks if two {}s contain equal inner contents.", ident).unwrap();
1272 writeln!(w, "/// This ignores pointers and is_owned flags and looks at the values in fields.").unwrap();
1273 if types.c_type_has_inner_from_path(&resolved_path) {
1274 writeln!(w, "/// Two objects with NULL inner values will be considered \"equal\" here.").unwrap();
1276 write!(w, "#[no_mangle]\npub extern \"C\" fn {}_eq(a: &{}, b: &{}) -> bool {{\n", ident, ident, ident).unwrap();
1277 if types.c_type_has_inner_from_path(&resolved_path) {
1278 write!(w, "\tif a.inner == b.inner {{ return true; }}\n").unwrap();
1279 write!(w, "\tif a.inner.is_null() || b.inner.is_null() {{ return false; }}\n").unwrap();
1283 let ref_type: syn::Type = syn::parse_quote!(&#path);
1284 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");
1286 write!(w, "\tif ").unwrap();
1287 types.write_from_c_conversion_prefix(w, &ref_type, Some(&gen_types));
1288 write!(w, "a").unwrap();
1289 types.write_from_c_conversion_suffix(w, &ref_type, Some(&gen_types));
1290 write!(w, " == ").unwrap();
1291 types.write_from_c_conversion_prefix(w, &ref_type, Some(&gen_types));
1292 write!(w, "b").unwrap();
1293 types.write_from_c_conversion_suffix(w, &ref_type, Some(&gen_types));
1295 writeln!(w, " {{ true }} else {{ false }}\n}}").unwrap();
1296 } else if path_matches_nongeneric(&trait_path.1, &["core", "hash", "Hash"]) {
1297 writeln!(w, "/// Generates a non-cryptographic 64-bit hash of the {}.", ident).unwrap();
1298 write!(w, "#[no_mangle]\npub extern \"C\" fn {}_hash(o: &{}) -> u64 {{\n", ident, ident).unwrap();
1299 if types.c_type_has_inner_from_path(&resolved_path) {
1300 write!(w, "\tif o.inner.is_null() {{ return 0; }}\n").unwrap();
1304 let ref_type: syn::Type = syn::parse_quote!(&#path);
1305 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");
1307 writeln!(w, "\t// Note that we'd love to use alloc::collections::hash_map::DefaultHasher but it's not in core").unwrap();
1308 writeln!(w, "\t#[allow(deprecated)]").unwrap();
1309 writeln!(w, "\tlet mut hasher = core::hash::SipHasher::new();").unwrap();
1310 write!(w, "\tcore::hash::Hash::hash(").unwrap();
1311 types.write_from_c_conversion_prefix(w, &ref_type, Some(&gen_types));
1312 write!(w, "o").unwrap();
1313 types.write_from_c_conversion_suffix(w, &ref_type, Some(&gen_types));
1314 writeln!(w, ", &mut hasher);").unwrap();
1315 writeln!(w, "\tcore::hash::Hasher::finish(&hasher)\n}}").unwrap();
1316 } else if (path_matches_nongeneric(&trait_path.1, &["core", "clone", "Clone"]) || path_matches_nongeneric(&trait_path.1, &["Clone"])) &&
1317 types.c_type_has_inner_from_path(&resolved_path) {
1318 writeln!(w, "impl Clone for {} {{", ident).unwrap();
1319 writeln!(w, "\tfn clone(&self) -> Self {{").unwrap();
1320 writeln!(w, "\t\tSelf {{").unwrap();
1321 writeln!(w, "\t\t\tinner: if <*mut native{}>::is_null(self.inner) {{ core::ptr::null_mut() }} else {{", ident).unwrap();
1322 writeln!(w, "\t\t\t\tObjOps::heap_alloc(unsafe {{ &*ObjOps::untweak_ptr(self.inner) }}.clone()) }},").unwrap();
1323 writeln!(w, "\t\t\tis_owned: true,").unwrap();
1324 writeln!(w, "\t\t}}\n\t}}\n}}").unwrap();
1325 writeln!(w, "#[allow(unused)]").unwrap();
1326 writeln!(w, "/// Used only if an object of this type is returned as a trait impl by a method").unwrap();
1327 writeln!(w, "pub(crate) extern \"C\" fn {}_clone_void(this_ptr: *const c_void) -> *mut c_void {{", ident).unwrap();
1328 writeln!(w, "\tBox::into_raw(Box::new(unsafe {{ (*(this_ptr as *mut native{})).clone() }})) as *mut c_void", ident).unwrap();
1329 writeln!(w, "}}").unwrap();
1330 writeln!(w, "#[no_mangle]").unwrap();
1331 writeln!(w, "/// Creates a copy of the {}", ident).unwrap();
1332 writeln!(w, "pub extern \"C\" fn {}_clone(orig: &{}) -> {} {{", ident, ident, ident).unwrap();
1333 writeln!(w, "\torig.clone()").unwrap();
1334 writeln!(w, "}}").unwrap();
1335 } else if path_matches_nongeneric(&trait_path.1, &["FromStr"]) {
1336 let mut err_opt = None;
1337 for item in i.items.iter() {
1339 syn::ImplItem::Type(ty) if format!("{}", ty.ident) == "Err" => {
1340 err_opt = Some(&ty.ty);
1345 let err_ty = err_opt.unwrap();
1346 if let Some(container) = types.get_c_mangled_container_type(vec![&*i.self_ty, &err_ty], Some(&gen_types), "Result") {
1347 writeln!(w, "#[no_mangle]").unwrap();
1348 writeln!(w, "/// Read a {} object from a string", ident).unwrap();
1349 writeln!(w, "pub extern \"C\" fn {}_from_str(s: crate::c_types::Str) -> {} {{", ident, container).unwrap();
1350 writeln!(w, "\tmatch {}::from_str(s.into_str()) {{", resolved_path).unwrap();
1352 writeln!(w, "\t\tOk(r) => {{").unwrap();
1353 let new_var = types.write_to_c_conversion_new_var(w, &format_ident!("r"), &*i.self_ty, Some(&gen_types), false);
1354 write!(w, "\t\t\tcrate::c_types::CResultTempl::ok(\n\t\t\t\t").unwrap();
1355 types.write_to_c_conversion_inline_prefix(w, &*i.self_ty, Some(&gen_types), false);
1356 write!(w, "{}r", if new_var { "local_" } else { "" }).unwrap();
1357 types.write_to_c_conversion_inline_suffix(w, &*i.self_ty, Some(&gen_types), false);
1358 writeln!(w, "\n\t\t\t)\n\t\t}},").unwrap();
1360 writeln!(w, "\t\tErr(e) => {{").unwrap();
1361 let new_var = types.write_to_c_conversion_new_var(w, &format_ident!("e"), &err_ty, Some(&gen_types), false);
1362 write!(w, "\t\t\tcrate::c_types::CResultTempl::err(\n\t\t\t\t").unwrap();
1363 types.write_to_c_conversion_inline_prefix(w, &err_ty, Some(&gen_types), false);
1364 write!(w, "{}e", if new_var { "local_" } else { "" }).unwrap();
1365 types.write_to_c_conversion_inline_suffix(w, &err_ty, Some(&gen_types), false);
1366 writeln!(w, "\n\t\t\t)\n\t\t}},").unwrap();
1368 writeln!(w, "\t}}.into()\n}}").unwrap();
1370 } else if path_matches_nongeneric(&trait_path.1, &["Display"]) {
1371 writeln!(w, "#[no_mangle]").unwrap();
1372 writeln!(w, "/// Get the string representation of a {} object", ident).unwrap();
1373 writeln!(w, "pub extern \"C\" fn {}_to_str(o: &crate::{}) -> Str {{", ident, resolved_path).unwrap();
1375 let self_ty = &i.self_ty;
1376 let ref_type: syn::Type = syn::parse_quote!(&#self_ty);
1377 let new_var = types.write_from_c_conversion_new_var(w, &format_ident!("o"), &ref_type, Some(&gen_types));
1378 write!(w, "\talloc::format!(\"{{}}\", ").unwrap();
1379 types.write_from_c_conversion_prefix(w, &ref_type, Some(&gen_types));
1380 write!(w, "{}o", if new_var { "local_" } else { "" }).unwrap();
1381 types.write_from_c_conversion_suffix(w, &ref_type, Some(&gen_types));
1382 writeln!(w, ").into()").unwrap();
1384 writeln!(w, "}}").unwrap();
1386 //XXX: implement for other things like ToString
1387 // If we have no generics, try a manual implementation:
1388 maybe_convert_trait_impl(w, &trait_path.1, &*i.self_ty, types, &gen_types);
1391 let is_opaque = types.crate_types.opaques.contains_key(&resolved_path);
1392 let is_mirrored_enum = types.crate_types.mirrored_enums.contains_key(&resolved_path);
1393 for item in i.items.iter() {
1395 syn::ImplItem::Method(m) => {
1396 if let syn::Visibility::Public(_) = m.vis {
1397 match export_status(&m.attrs) {
1398 ExportStatus::Export => {},
1399 ExportStatus::NoExport|ExportStatus::TestOnly => continue,
1400 ExportStatus::NotImplementable => panic!("(C-not implementable) must only appear on traits"),
1402 if m.sig.asyncness.is_some() { continue; }
1403 let mut meth_gen_types = gen_types.push_ctx();
1404 assert!(meth_gen_types.learn_generics(&m.sig.generics, types));
1405 if m.defaultness.is_some() { unimplemented!(); }
1406 writeln_fn_docs(w, &m.attrs, "", types, Some(&meth_gen_types), m.sig.inputs.iter(), &m.sig.output);
1407 if let syn::ReturnType::Type(_, _) = &m.sig.output {
1408 writeln!(w, "#[must_use]").unwrap();
1410 write!(w, "#[no_mangle]\npub extern \"C\" fn {}_{}(", ident, m.sig.ident).unwrap();
1411 let ret_type = format!("crate::{}", resolved_path);
1412 write_method_params(w, &m.sig, &ret_type, types, Some(&meth_gen_types), false, true);
1413 write!(w, " {{\n\t").unwrap();
1414 write_method_var_decl_body(w, &m.sig, "", types, Some(&meth_gen_types), false);
1415 let mut takes_self = false;
1416 let mut takes_mut_self = false;
1417 let mut takes_owned_self = false;
1418 for inp in m.sig.inputs.iter() {
1419 if let syn::FnArg::Receiver(r) = inp {
1421 if r.mutability.is_some() { takes_mut_self = true; }
1422 if r.reference.is_none() { takes_owned_self = true; }
1425 if !takes_mut_self && !takes_self {
1426 write!(w, "{}::{}(", resolved_path, m.sig.ident).unwrap();
1428 if is_mirrored_enum {
1429 write!(w, "this_arg.to_native().{}(", m.sig.ident).unwrap();
1430 } else if is_opaque {
1431 if takes_owned_self {
1432 write!(w, "(*unsafe {{ Box::from_raw(this_arg.take_inner()) }}).{}(", m.sig.ident).unwrap();
1433 } else if takes_mut_self {
1434 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();
1436 write!(w, "unsafe {{ &*ObjOps::untweak_ptr(this_arg.inner) }}.{}(", m.sig.ident).unwrap();
1442 write_method_call_params(w, &m.sig, "", types, Some(&meth_gen_types), &ret_type, false);
1443 writeln!(w, "\n}}\n").unwrap();
1450 } else if let Some(resolved_path) = types.maybe_resolve_ident(&ident) {
1451 create_alias_for_impl(resolved_path, i, types, move |aliased_impl, types| writeln_impl(w, w_uses, &aliased_impl, types));
1453 eprintln!("Not implementing anything for {} due to no-resolve (probably the type isn't pub)", ident);
1459 fn create_alias_for_impl<F: FnMut(syn::ItemImpl, &mut TypeResolver)>(resolved_path: String, i: &syn::ItemImpl, types: &mut TypeResolver, mut callback: F) {
1460 if let Some(aliases) = types.crate_types.reverse_alias_map.get(&resolved_path).cloned() {
1461 let mut gen_types = Some(GenericTypes::new(Some(resolved_path.clone())));
1462 if !gen_types.as_mut().unwrap().learn_generics(&i.generics, types) {
1465 let alias_module = rsplit_once(&resolved_path, "::").unwrap().0;
1467 'alias_impls: for (alias_resolved, arguments) in aliases {
1468 let mut new_ty_generics = Vec::new();
1469 let mut new_ty_bounds = Vec::new();
1470 let mut need_generics = false;
1472 let alias_resolver_override;
1473 let alias_resolver = if alias_module != types.module_path {
1474 alias_resolver_override = ImportResolver::new(types.types.crate_name, &types.crate_types.lib_ast,
1475 alias_module, &types.crate_types.lib_ast.modules.get(alias_module).unwrap().items);
1476 &alias_resolver_override
1477 } else { &types.types };
1478 let mut where_clause = syn::WhereClause { where_token: syn::Token![where](Span::call_site()),
1479 predicates: syn::punctuated::Punctuated::new()
1481 for (idx, gen) in i.generics.params.iter().enumerate() {
1483 syn::GenericParam::Type(type_param) => {
1484 'bounds_check: for bound in type_param.bounds.iter() {
1485 if let syn::TypeParamBound::Trait(trait_bound) = bound {
1486 if let syn::PathArguments::AngleBracketed(ref t) = &arguments {
1487 assert!(idx < t.args.len());
1488 if let syn::GenericArgument::Type(syn::Type::Path(p)) = &t.args[idx] {
1489 let generic_bound = types.maybe_resolve_path(&trait_bound.path, None)
1490 .unwrap_or_else(|| format!("{}::{}", types.module_path, single_ident_generic_path_to_ident(&trait_bound.path).unwrap()));
1492 if let Some(generic_arg) = alias_resolver.maybe_resolve_path(&p.path, None) {
1493 new_ty_generics.push((type_param.ident.clone(), syn::Type::Path(p.clone())));
1494 if let Some(traits_impld) = types.crate_types.trait_impls.get(&generic_arg) {
1495 for trait_impld in traits_impld {
1496 if *trait_impld == generic_bound { continue 'bounds_check; }
1498 eprintln!("struct {}'s generic arg {} didn't match bound {}", alias_resolved, generic_arg, generic_bound);
1499 continue 'alias_impls;
1501 eprintln!("struct {}'s generic arg {} didn't match bound {}", alias_resolved, generic_arg, generic_bound);
1502 continue 'alias_impls;
1504 } else if gen_types.is_some() {
1505 let resp = types.maybe_resolve_path(&p.path, gen_types.as_ref());
1506 if generic_bound == "core::ops::Deref" && resp.is_some() {
1507 new_ty_bounds.push((type_param.ident.clone(),
1508 string_path_to_syn_path("core::ops::Deref")));
1509 let mut bounds = syn::punctuated::Punctuated::new();
1510 bounds.push(syn::TypeParamBound::Trait(syn::TraitBound {
1512 modifier: syn::TraitBoundModifier::None,
1514 path: string_path_to_syn_path(&types.resolve_path(&p.path, gen_types.as_ref())),
1516 let mut path = string_path_to_syn_path(&format!("{}::Target", type_param.ident));
1517 path.leading_colon = None;
1518 where_clause.predicates.push(syn::WherePredicate::Type(syn::PredicateType {
1520 bounded_ty: syn::Type::Path(syn::TypePath { qself: None, path }),
1521 colon_token: syn::Token![:](Span::call_site()),
1525 new_ty_generics.push((type_param.ident.clone(),
1526 gen_types.as_ref().resolve_type(&syn::Type::Path(p.clone())).clone()));
1528 need_generics = true;
1532 } else { unimplemented!(); }
1533 } else { unimplemented!(); }
1534 } else { unimplemented!(); }
1537 syn::GenericParam::Lifetime(_) => {},
1538 syn::GenericParam::Const(_) => unimplemented!(),
1541 let mut params = syn::punctuated::Punctuated::new();
1542 let alias = string_path_to_syn_path(&alias_resolved);
1545 let alias_generics = types.crate_types.opaques.get(&alias_resolved).unwrap().1;
1547 // If we need generics on the alias, create impl generic bounds...
1548 assert_eq!(new_ty_generics.len() + new_ty_bounds.len(), i.generics.params.len());
1549 let mut args = syn::punctuated::Punctuated::new();
1550 for (ident, param) in new_ty_generics.drain(..) {
1551 // TODO: We blindly assume that generics in the type alias and
1552 // the aliased type have the same names, which we really shouldn't.
1553 if alias_generics.params.iter().any(|generic|
1554 if let syn::GenericParam::Type(t) = generic { t.ident == ident } else { false })
1556 args.push(parse_quote!(#ident));
1558 params.push(syn::GenericParam::Type(syn::TypeParam {
1562 bounds: syn::punctuated::Punctuated::new(),
1563 eq_token: Some(syn::token::Eq(Span::call_site())),
1564 default: Some(param),
1567 for (ident, param) in new_ty_bounds.drain(..) {
1568 // TODO: We blindly assume that generics in the type alias and
1569 // the aliased type have the same names, which we really shouldn't.
1570 if alias_generics.params.iter().any(|generic|
1571 if let syn::GenericParam::Type(t) = generic { t.ident == ident } else { false })
1573 args.push(parse_quote!(#ident));
1575 params.push(syn::GenericParam::Type(syn::TypeParam {
1578 colon_token: Some(syn::token::Colon(Span::call_site())),
1579 bounds: syn::punctuated::Punctuated::from_iter(
1580 Some(syn::TypeParamBound::Trait(syn::TraitBound {
1581 path: param, paren_token: None, lifetimes: None,
1582 modifier: syn::TraitBoundModifier::None,
1589 // ... and swap the last segment of the impl self_ty to use the generic bounds.
1590 let mut res = alias.clone();
1591 res.segments.last_mut().unwrap().arguments = syn::PathArguments::AngleBracketed(syn::AngleBracketedGenericArguments {
1593 lt_token: syn::token::Lt(Span::call_site()),
1595 gt_token: syn::token::Gt(Span::call_site()),
1598 } else { alias.clone() };
1599 callback(syn::ItemImpl {
1600 attrs: i.attrs.clone(),
1601 brace_token: syn::token::Brace(Span::call_site()),
1603 generics: syn::Generics {
1607 where_clause: Some(where_clause),
1609 impl_token: syn::Token![impl](Span::call_site()),
1610 items: i.items.clone(),
1611 self_ty: Box::new(syn::Type::Path(syn::TypePath { qself: None, path: real_aliased })),
1612 trait_: i.trait_.clone(),
1617 eprintln!("Not implementing anything for {} due to it being marked not exported", resolved_path);
1621 /// Replaces upper case charachters with underscore followed by lower case except the first
1622 /// charachter and repeated upper case characthers (which are only made lower case).
1623 fn camel_to_snake_case(camel: &str) -> String {
1624 let mut res = "".to_string();
1625 let mut last_upper = -1;
1626 for (idx, c) in camel.chars().enumerate() {
1627 if c.is_uppercase() {
1628 if last_upper != idx as isize - 1 { res.push('_'); }
1629 res.push(c.to_lowercase().next().unwrap());
1630 last_upper = idx as isize;
1639 /// Print a mapping of an enum. If all of the enum's fields are C-mapped in some form (or the enum
1640 /// is unitary), we generate an equivalent enum with all types replaced with their C mapped
1641 /// versions followed by conversion functions which map between the Rust version and the C mapped
1643 fn writeln_enum<'a, 'b, W: std::io::Write>(w: &mut W, e: &'a syn::ItemEnum, types: &mut TypeResolver<'b, 'a>, extra_headers: &mut File, cpp_headers: &mut File) {
1644 match export_status(&e.attrs) {
1645 ExportStatus::Export => {},
1646 ExportStatus::NoExport|ExportStatus::TestOnly => return,
1647 ExportStatus::NotImplementable => panic!("(C-not implementable) must only appear on traits"),
1650 if is_enum_opaque(e) {
1651 eprintln!("Skipping enum {} as it contains non-unit fields", e.ident);
1652 writeln_opaque(w, &e.ident, &format!("{}", e.ident), &e.generics, &e.attrs, types, extra_headers, cpp_headers);
1655 writeln_docs(w, &e.attrs, "");
1657 let mut gen_types = GenericTypes::new(None);
1658 assert!(gen_types.learn_generics(&e.generics, types));
1660 let mut needs_free = false;
1661 let mut constr = Vec::new();
1662 let mut is_clonable = true;
1664 for var in e.variants.iter() {
1665 if let syn::Fields::Named(fields) = &var.fields {
1667 for field in fields.named.iter() {
1668 if export_status(&field.attrs) == ExportStatus::TestOnly { continue; }
1670 let mut ty_checks = Vec::new();
1671 types.write_c_type(&mut ty_checks, &field.ty, Some(&gen_types), false);
1672 if !types.is_clonable(&String::from_utf8(ty_checks).unwrap()) {
1673 is_clonable = false;
1676 } else if let syn::Fields::Unnamed(fields) = &var.fields {
1677 for field in fields.unnamed.iter() {
1678 let mut ty_checks = Vec::new();
1679 types.write_c_type(&mut ty_checks, &field.ty, Some(&gen_types), false);
1680 let ty = String::from_utf8(ty_checks).unwrap();
1681 if ty != "" && !types.is_clonable(&ty) {
1682 is_clonable = false;
1689 writeln!(w, "#[derive(Clone)]").unwrap();
1690 types.crate_types.set_clonable(format!("{}::{}", types.module_path, e.ident));
1692 writeln!(w, "#[must_use]\n#[repr(C)]\npub enum {} {{", e.ident).unwrap();
1693 for var in e.variants.iter() {
1694 assert_eq!(export_status(&var.attrs), ExportStatus::Export); // We can't partially-export a mirrored enum
1695 writeln_docs(w, &var.attrs, "\t");
1696 write!(w, "\t{}", var.ident).unwrap();
1697 writeln!(&mut constr, "#[no_mangle]\n/// Utility method to constructs a new {}-variant {}", var.ident, e.ident).unwrap();
1698 let constr_name = camel_to_snake_case(&format!("{}", var.ident));
1699 write!(&mut constr, "pub extern \"C\" fn {}_{}(", e.ident, constr_name).unwrap();
1700 let mut empty_tuple_variant = false;
1701 if let syn::Fields::Named(fields) = &var.fields {
1703 writeln!(w, " {{").unwrap();
1704 for (idx, field) in fields.named.iter().enumerate() {
1705 if export_status(&field.attrs) == ExportStatus::TestOnly { continue; }
1706 writeln_field_docs(w, &field.attrs, "\t\t", types, Some(&gen_types), &field.ty);
1707 write!(w, "\t\t{}: ", field.ident.as_ref().unwrap()).unwrap();
1708 write!(&mut constr, "{}{}: ", if idx != 0 { ", " } else { "" }, field.ident.as_ref().unwrap()).unwrap();
1709 types.write_c_type(w, &field.ty, Some(&gen_types), true);
1710 types.write_c_type(&mut constr, &field.ty, Some(&gen_types), true);
1711 writeln!(w, ",").unwrap();
1713 write!(w, "\t}}").unwrap();
1714 } else if let syn::Fields::Unnamed(fields) = &var.fields {
1715 if fields.unnamed.len() == 1 {
1716 let mut empty_check = Vec::new();
1717 types.write_c_type(&mut empty_check, &fields.unnamed[0].ty, Some(&gen_types), true);
1718 if empty_check.is_empty() {
1719 empty_tuple_variant = true;
1722 if !empty_tuple_variant {
1724 writeln!(w, "(").unwrap();
1725 for (idx, field) in fields.unnamed.iter().enumerate() {
1726 if export_status(&field.attrs) == ExportStatus::TestOnly { continue; }
1727 writeln_field_docs(w, &field.attrs, "\t\t", types, Some(&gen_types), &field.ty);
1728 write!(w, "\t\t").unwrap();
1729 types.write_c_type(w, &field.ty, Some(&gen_types), true);
1731 write!(&mut constr, "{}: ", ('a' as u8 + idx as u8) as char).unwrap();
1732 types.write_c_type(&mut constr, &field.ty, Some(&gen_types), false);
1733 if idx != fields.unnamed.len() - 1 {
1734 writeln!(w, ",").unwrap();
1735 write!(&mut constr, ",").unwrap();
1738 write!(w, ")").unwrap();
1741 write!(&mut constr, ") -> {} {{\n\t{}::{}", e.ident, e.ident, var.ident).unwrap();
1742 if let syn::Fields::Named(fields) = &var.fields {
1743 writeln!(&mut constr, " {{").unwrap();
1744 for field in fields.named.iter() {
1745 writeln!(&mut constr, "\t\t{},", field.ident.as_ref().unwrap()).unwrap();
1747 writeln!(&mut constr, "\t}}").unwrap();
1748 } else if let syn::Fields::Unnamed(fields) = &var.fields {
1749 if !empty_tuple_variant {
1750 write!(&mut constr, "(").unwrap();
1751 for (idx, field) in fields.unnamed.iter().enumerate() {
1752 let mut ref_c_ty = Vec::new();
1753 let mut nonref_c_ty = Vec::new();
1754 types.write_c_type(&mut ref_c_ty, &field.ty, Some(&gen_types), false);
1755 types.write_c_type(&mut nonref_c_ty, &field.ty, Some(&gen_types), true);
1757 if ref_c_ty != nonref_c_ty {
1758 // We blindly assume references in field types are always opaque types, and
1759 // print out an opaque reference -> owned reference conversion here.
1760 write!(&mut constr, "{} {{ inner: {}.inner, is_owned: false }}, ", String::from_utf8(nonref_c_ty).unwrap(), ('a' as u8 + idx as u8) as char).unwrap();
1762 write!(&mut constr, "{}, ", ('a' as u8 + idx as u8) as char).unwrap();
1765 writeln!(&mut constr, ")").unwrap();
1767 writeln!(&mut constr, "").unwrap();
1770 writeln!(&mut constr, "}}").unwrap();
1771 writeln!(w, ",").unwrap();
1773 writeln!(w, "}}\nuse {}::{} as {}Import;", types.module_path, e.ident, e.ident).unwrap();
1774 write!(w, "pub(crate) type native{} = {}Import", e.ident, e.ident).unwrap();
1775 maybe_write_generics(w, &e.generics, &syn::PathArguments::None, &types, true);
1776 writeln!(w, ";\n\nimpl {} {{", e.ident).unwrap();
1778 macro_rules! write_conv {
1779 ($fn_sig: expr, $to_c: expr, $ref: expr) => {
1780 writeln!(w, "\t#[allow(unused)]\n\tpub(crate) fn {} {{\n\t\tmatch {} {{", $fn_sig, if $to_c { "native" } else { "self" }).unwrap();
1781 for var in e.variants.iter() {
1782 write!(w, "\t\t\t{}{}::{} ", if $to_c { "native" } else { "" }, e.ident, var.ident).unwrap();
1783 let mut empty_tuple_variant = false;
1784 if let syn::Fields::Named(fields) = &var.fields {
1785 write!(w, "{{").unwrap();
1786 for field in fields.named.iter() {
1787 if export_status(&field.attrs) == ExportStatus::TestOnly { continue; }
1788 write!(w, "{}{}, ", if $ref { "ref " } else { "mut " }, field.ident.as_ref().unwrap()).unwrap();
1790 write!(w, "}} ").unwrap();
1791 } else if let syn::Fields::Unnamed(fields) = &var.fields {
1792 if fields.unnamed.len() == 1 {
1793 let mut empty_check = Vec::new();
1794 types.write_c_type(&mut empty_check, &fields.unnamed[0].ty, Some(&gen_types), true);
1795 if empty_check.is_empty() {
1796 empty_tuple_variant = true;
1799 if !empty_tuple_variant || $to_c {
1800 write!(w, "(").unwrap();
1801 for (idx, field) in fields.unnamed.iter().enumerate() {
1802 if export_status(&field.attrs) == ExportStatus::TestOnly { continue; }
1803 write!(w, "{}{}, ", if $ref { "ref " } else { "mut " }, ('a' as u8 + idx as u8) as char).unwrap();
1805 write!(w, ") ").unwrap();
1808 write!(w, "=>").unwrap();
1810 macro_rules! handle_field_a {
1811 ($field: expr, $field_ident: expr) => { {
1812 if export_status(&$field.attrs) == ExportStatus::TestOnly { continue; }
1813 let mut sink = ::std::io::sink();
1814 let mut out: &mut dyn std::io::Write = if $ref { &mut sink } else { w };
1815 let new_var = if $to_c {
1816 types.write_to_c_conversion_new_var(&mut out, $field_ident, &$field.ty, Some(&gen_types), true)
1818 types.write_from_c_conversion_new_var(&mut out, $field_ident, &$field.ty, Some(&gen_types))
1820 if $ref || new_var {
1822 write!(w, "let mut {}_nonref = Clone::clone({});\n\t\t\t\t", $field_ident, $field_ident).unwrap();
1824 let nonref_ident = format_ident!("{}_nonref", $field_ident);
1826 types.write_to_c_conversion_new_var(w, &nonref_ident, &$field.ty, Some(&gen_types), true);
1828 types.write_from_c_conversion_new_var(w, &nonref_ident, &$field.ty, Some(&gen_types));
1830 write!(w, "\n\t\t\t\t").unwrap();
1833 write!(w, "\n\t\t\t\t").unwrap();
1838 if let syn::Fields::Named(fields) = &var.fields {
1839 write!(w, " {{\n\t\t\t\t").unwrap();
1840 for field in fields.named.iter() {
1841 handle_field_a!(field, field.ident.as_ref().unwrap());
1843 } else if let syn::Fields::Unnamed(fields) = &var.fields {
1844 write!(w, " {{\n\t\t\t\t").unwrap();
1845 for (idx, field) in fields.unnamed.iter().enumerate() {
1846 if !empty_tuple_variant {
1847 handle_field_a!(field, &format_ident!("{}", ('a' as u8 + idx as u8) as char));
1850 } else { write!(w, " ").unwrap(); }
1852 write!(w, "{}{}::{}", if $to_c { "" } else { "native" }, e.ident, var.ident).unwrap();
1854 macro_rules! handle_field_b {
1855 ($field: expr, $field_ident: expr) => { {
1856 if export_status(&$field.attrs) == ExportStatus::TestOnly { continue; }
1858 types.write_to_c_conversion_inline_prefix(w, &$field.ty, Some(&gen_types), true);
1860 types.write_from_c_conversion_prefix(w, &$field.ty, Some(&gen_types));
1862 write!(w, "{}{}", $field_ident,
1863 if $ref { "_nonref" } else { "" }).unwrap();
1865 types.write_to_c_conversion_inline_suffix(w, &$field.ty, Some(&gen_types), true);
1867 types.write_from_c_conversion_suffix(w, &$field.ty, Some(&gen_types));
1869 write!(w, ",").unwrap();
1873 if let syn::Fields::Named(fields) = &var.fields {
1874 write!(w, " {{").unwrap();
1875 for field in fields.named.iter() {
1876 if export_status(&field.attrs) == ExportStatus::TestOnly { continue; }
1877 write!(w, "\n\t\t\t\t\t{}: ", field.ident.as_ref().unwrap()).unwrap();
1878 handle_field_b!(field, field.ident.as_ref().unwrap());
1880 writeln!(w, "\n\t\t\t\t}}").unwrap();
1881 write!(w, "\t\t\t}}").unwrap();
1882 } else if let syn::Fields::Unnamed(fields) = &var.fields {
1883 if !empty_tuple_variant || !$to_c {
1884 write!(w, " (").unwrap();
1885 for (idx, field) in fields.unnamed.iter().enumerate() {
1886 write!(w, "\n\t\t\t\t\t").unwrap();
1887 handle_field_b!(field, &format_ident!("{}", ('a' as u8 + idx as u8) as char));
1889 writeln!(w, "\n\t\t\t\t)").unwrap();
1891 write!(w, "\t\t\t}}").unwrap();
1893 writeln!(w, ",").unwrap();
1895 writeln!(w, "\t\t}}\n\t}}").unwrap();
1900 write_conv!(format!("to_native(&self) -> native{}", e.ident), false, true);
1902 write_conv!(format!("into_native(self) -> native{}", e.ident), false, false);
1904 write_conv!(format!("from_native(native: &native{}) -> Self", e.ident), true, true);
1906 write_conv!(format!("native_into(native: native{}) -> Self", e.ident), true, false);
1907 writeln!(w, "}}").unwrap();
1910 writeln!(w, "/// Frees any resources used by the {}", e.ident).unwrap();
1911 writeln!(w, "#[no_mangle]\npub extern \"C\" fn {}_free(this_ptr: {}) {{ }}", e.ident, e.ident).unwrap();
1914 writeln!(w, "/// Creates a copy of the {}", e.ident).unwrap();
1915 writeln!(w, "#[no_mangle]").unwrap();
1916 writeln!(w, "pub extern \"C\" fn {}_clone(orig: &{}) -> {} {{", e.ident, e.ident, e.ident).unwrap();
1917 writeln!(w, "\torig.clone()").unwrap();
1918 writeln!(w, "}}").unwrap();
1920 w.write_all(&constr).unwrap();
1921 write_cpp_wrapper(cpp_headers, &format!("{}", e.ident), needs_free, None);
1924 fn writeln_fn<'a, 'b, W: std::io::Write>(w: &mut W, f: &'a syn::ItemFn, types: &mut TypeResolver<'b, 'a>) {
1925 match export_status(&f.attrs) {
1926 ExportStatus::Export => {},
1927 ExportStatus::NoExport|ExportStatus::TestOnly => return,
1928 ExportStatus::NotImplementable => panic!("(C-not implementable) must only appear on traits"),
1930 let mut gen_types = GenericTypes::new(None);
1931 if !gen_types.learn_generics(&f.sig.generics, types) { return; }
1933 writeln_fn_docs(w, &f.attrs, "", types, Some(&gen_types), f.sig.inputs.iter(), &f.sig.output);
1935 write!(w, "#[no_mangle]\npub extern \"C\" fn {}(", f.sig.ident).unwrap();
1938 write_method_params(w, &f.sig, "", types, Some(&gen_types), false, true);
1939 write!(w, " {{\n\t").unwrap();
1940 write_method_var_decl_body(w, &f.sig, "", types, Some(&gen_types), false);
1941 write!(w, "{}::{}", types.module_path, f.sig.ident).unwrap();
1943 let mut function_generic_args = Vec::new();
1944 maybe_write_generics(&mut function_generic_args, &f.sig.generics, &syn::PathArguments::None, types, true);
1945 if !function_generic_args.is_empty() {
1946 write!(w, "::{}", String::from_utf8(function_generic_args).unwrap()).unwrap();
1948 write!(w, "(").unwrap();
1950 write_method_call_params(w, &f.sig, "", types, Some(&gen_types), "", false);
1951 writeln!(w, "\n}}\n").unwrap();
1954 // ********************************
1955 // *** File/Crate Walking Logic ***
1956 // ********************************
1958 fn convert_priv_mod<'a, 'b: 'a, W: std::io::Write>(w: &mut W, w_uses: &mut HashSet<String, NonRandomHash>, libast: &'b FullLibraryAST, crate_types: &CrateTypes<'b>, out_dir: &str, mod_path: &str, module: &'b syn::ItemMod) {
1959 // We want to ignore all items declared in this module (as they are not pub), but we still need
1960 // to give the ImportResolver any use statements, so we copy them here.
1961 let mut use_items = Vec::new();
1962 for item in module.content.as_ref().unwrap().1.iter() {
1963 if let syn::Item::Use(_) = item {
1964 use_items.push(item);
1967 let import_resolver = ImportResolver::from_borrowed_items(mod_path.splitn(2, "::").next().unwrap(), libast, mod_path, &use_items);
1968 let mut types = TypeResolver::new(mod_path, import_resolver, crate_types);
1970 writeln!(w, "mod {} {{\n{}", module.ident, DEFAULT_IMPORTS).unwrap();
1971 for item in module.content.as_ref().unwrap().1.iter() {
1973 syn::Item::Mod(m) => convert_priv_mod(w, w_uses, libast, crate_types, out_dir, &format!("{}::{}", mod_path, module.ident), m),
1974 syn::Item::Impl(i) => {
1975 writeln_impl(w, w_uses, i, &mut types);
1980 writeln!(w, "}}").unwrap();
1983 /// Do the Real Work of mapping an original file to C-callable wrappers. Creates a new file at
1984 /// `out_path` and fills it with wrapper structs/functions to allow calling the things in the AST
1985 /// at `module` from C.
1986 fn convert_file<'a, 'b>(libast: &'a FullLibraryAST, crate_types: &CrateTypes<'a>, out_dir: &str, header_file: &mut File, cpp_header_file: &mut File) {
1987 for (module, astmod) in libast.modules.iter() {
1988 let orig_crate = module.splitn(2, "::").next().unwrap();
1989 let ASTModule { ref attrs, ref items, ref submods } = astmod;
1990 assert_eq!(export_status(&attrs), ExportStatus::Export);
1992 let new_file_path = if submods.is_empty() {
1993 format!("{}/{}.rs", out_dir, module.replace("::", "/"))
1994 } else if module != "" {
1995 format!("{}/{}/mod.rs", out_dir, module.replace("::", "/"))
1997 format!("{}/lib.rs", out_dir)
1999 let _ = std::fs::create_dir((&new_file_path.as_ref() as &std::path::Path).parent().unwrap());
2000 let mut out = std::fs::OpenOptions::new().write(true).create(true).truncate(true)
2001 .open(new_file_path).expect("Unable to open new src file");
2002 let mut out_uses = HashSet::default();
2004 writeln!(out, "// This file is Copyright its original authors, visible in version control").unwrap();
2005 writeln!(out, "// history and in the source files from which this was generated.").unwrap();
2006 writeln!(out, "//").unwrap();
2007 writeln!(out, "// This file is licensed under the license available in the LICENSE or LICENSE.md").unwrap();
2008 writeln!(out, "// file in the root of this repository or, if no such file exists, the same").unwrap();
2009 writeln!(out, "// license as that which applies to the original source files from which this").unwrap();
2010 writeln!(out, "// source was automatically generated.").unwrap();
2011 writeln!(out, "").unwrap();
2013 writeln_docs(&mut out, &attrs, "");
2016 // Special-case the top-level lib.rs with various lint allows and a pointer to the c_types
2017 // and bitcoin hand-written modules.
2018 writeln!(out, "//! C Bindings").unwrap();
2019 writeln!(out, "#![allow(unknown_lints)]").unwrap();
2020 writeln!(out, "#![allow(non_camel_case_types)]").unwrap();
2021 writeln!(out, "#![allow(non_snake_case)]").unwrap();
2022 writeln!(out, "#![allow(unused_imports)]").unwrap();
2023 writeln!(out, "#![allow(unused_variables)]").unwrap();
2024 writeln!(out, "#![allow(unused_mut)]").unwrap();
2025 writeln!(out, "#![allow(unused_parens)]").unwrap();
2026 writeln!(out, "#![allow(unused_unsafe)]").unwrap();
2027 writeln!(out, "#![allow(unused_braces)]").unwrap();
2028 // TODO: We need to map deny(missing_docs) in the source crate(s)
2029 //writeln!(out, "#![deny(missing_docs)]").unwrap();
2031 writeln!(out, "#![cfg_attr(not(feature = \"std\"), no_std)]").unwrap();
2032 writeln!(out, "#[cfg(not(any(feature = \"std\", feature = \"no-std\")))]").unwrap();
2033 writeln!(out, "compile_error!(\"at least one of the `std` or `no-std` features must be enabled\");").unwrap();
2034 writeln!(out, "extern crate alloc;").unwrap();
2036 writeln!(out, "pub mod version;").unwrap();
2037 writeln!(out, "pub mod c_types;").unwrap();
2038 writeln!(out, "pub mod bitcoin;").unwrap();
2040 writeln!(out, "{}", DEFAULT_IMPORTS).unwrap();
2044 writeln!(out, "pub mod {};", m).unwrap();
2047 eprintln!("Converting {} entries...", module);
2049 let import_resolver = ImportResolver::new(orig_crate, libast, module, items);
2050 let mut type_resolver = TypeResolver::new(module, import_resolver, crate_types);
2052 for item in items.iter() {
2054 syn::Item::Use(_) => {}, // Handled above
2055 syn::Item::Static(_) => {},
2056 syn::Item::Enum(e) => {
2057 if let syn::Visibility::Public(_) = e.vis {
2058 writeln_enum(&mut out, &e, &mut type_resolver, header_file, cpp_header_file);
2061 syn::Item::Impl(i) => {
2062 writeln_impl(&mut out, &mut out_uses, &i, &mut type_resolver);
2064 syn::Item::Struct(s) => {
2065 if let syn::Visibility::Public(_) = s.vis {
2066 writeln_struct(&mut out, &s, &mut type_resolver, header_file, cpp_header_file);
2069 syn::Item::Trait(t) => {
2070 if let syn::Visibility::Public(_) = t.vis {
2071 writeln_trait(&mut out, &t, &mut type_resolver, header_file, cpp_header_file);
2074 syn::Item::Mod(m) => {
2075 convert_priv_mod(&mut out, &mut out_uses, libast, crate_types, out_dir, &format!("{}::{}", module, m.ident), m);
2077 syn::Item::Const(c) => {
2078 // Re-export any primitive-type constants.
2079 if let syn::Visibility::Public(_) = c.vis {
2080 if let syn::Type::Path(p) = &*c.ty {
2081 let resolved_path = type_resolver.resolve_path(&p.path, None);
2082 if type_resolver.is_primitive(&resolved_path) {
2083 writeln_field_docs(&mut out, &c.attrs, "", &mut type_resolver, None, &*c.ty);
2084 writeln!(out, "\n#[no_mangle]").unwrap();
2085 writeln!(out, "pub static {}: {} = {}::{};", c.ident, resolved_path, module, c.ident).unwrap();
2090 syn::Item::Type(t) => {
2091 if let syn::Visibility::Public(_) = t.vis {
2092 match export_status(&t.attrs) {
2093 ExportStatus::Export => {},
2094 ExportStatus::NoExport|ExportStatus::TestOnly => continue,
2095 ExportStatus::NotImplementable => panic!("(C-not implementable) must only appear on traits"),
2099 syn::Type::Path(p) => {
2100 let real_ty = type_resolver.resolve_path(&p.path, None);
2101 let real_generic_bounds = type_resolver.crate_types.opaques.get(&real_ty).map(|t| t.1).or(
2102 type_resolver.crate_types.priv_structs.get(&real_ty).map(|r| *r)).unwrap();
2103 let mut resolved_generics = t.generics.clone();
2105 // Assume blindly that the bounds in the struct definition where
2106 // clause matches any equivalent bounds on the type alias.
2107 assert!(resolved_generics.where_clause.is_none());
2108 resolved_generics.where_clause = real_generic_bounds.where_clause.clone();
2110 if let syn::PathArguments::AngleBracketed(real_generics) = &p.path.segments.last().unwrap().arguments {
2111 for (real_idx, real_param) in real_generics.args.iter().enumerate() {
2112 if let syn::GenericArgument::Type(syn::Type::Path(real_param_path)) = real_param {
2113 for param in resolved_generics.params.iter_mut() {
2114 if let syn::GenericParam::Type(type_param) = param {
2115 if Some(&type_param.ident) == real_param_path.path.get_ident() {
2116 if let syn::GenericParam::Type(real_type_param) = &real_generic_bounds.params[real_idx] {
2117 type_param.bounds = real_type_param.bounds.clone();
2118 type_param.default = real_type_param.default.clone();
2128 writeln_opaque(&mut out, &t.ident, &format!("{}", t.ident), &resolved_generics, &t.attrs, &type_resolver, header_file, cpp_header_file)},
2133 syn::Item::Fn(f) => {
2134 if let syn::Visibility::Public(_) = f.vis {
2135 writeln_fn(&mut out, &f, &mut type_resolver);
2138 syn::Item::Macro(_) => {},
2139 syn::Item::Verbatim(_) => {},
2140 syn::Item::ExternCrate(_) => {},
2141 _ => unimplemented!(),
2145 for use_stmt in out_uses {
2146 writeln!(out, "{}", use_stmt).unwrap();
2149 out.flush().unwrap();
2154 /// Walk the FullLibraryAST, determining if impl aliases need to be marked cloneable.
2155 fn walk_ast_second_pass<'a>(ast_storage: &'a FullLibraryAST, crate_types: &CrateTypes<'a>) {
2156 for (module, astmod) in ast_storage.modules.iter() {
2157 let orig_crate = module.splitn(2, "::").next().unwrap();
2158 let ASTModule { ref attrs, ref items, .. } = astmod;
2159 assert_eq!(export_status(&attrs), ExportStatus::Export);
2161 let import_resolver = ImportResolver::new(orig_crate, ast_storage, module, items);
2162 let mut types = TypeResolver::new(module, import_resolver, crate_types);
2164 for item in items.iter() {
2166 syn::Item::Impl(i) => {
2167 match export_status(&i.attrs) {
2168 ExportStatus::Export => {},
2169 ExportStatus::NoExport|ExportStatus::TestOnly => continue,
2170 ExportStatus::NotImplementable => panic!("(C-not implementable) must only appear on traits"),
2172 if let Some(trait_path) = i.trait_.as_ref() {
2173 if path_matches_nongeneric(&trait_path.1, &["core", "clone", "Clone"]) ||
2174 path_matches_nongeneric(&trait_path.1, &["Clone"])
2176 if let &syn::Type::Path(ref p) = &*i.self_ty {
2177 if let Some(resolved_path) = types.maybe_resolve_path(&p.path, None) {
2178 create_alias_for_impl(resolved_path, i, &mut types, |aliased_impl, types| {
2179 if let &syn::Type::Path(ref p) = &*aliased_impl.self_ty {
2180 if let Some(resolved_aliased_path) = types.maybe_resolve_path(&p.path, None) {
2181 crate_types.set_clonable("crate::".to_owned() + &resolved_aliased_path);
2196 fn walk_private_mod<'a>(ast_storage: &'a FullLibraryAST, orig_crate: &str, module: String, items: &'a syn::ItemMod, crate_types: &mut CrateTypes<'a>) {
2197 let import_resolver = ImportResolver::new(orig_crate, ast_storage, &module, &items.content.as_ref().unwrap().1);
2198 for item in items.content.as_ref().unwrap().1.iter() {
2200 syn::Item::Mod(m) => walk_private_mod(ast_storage, orig_crate, format!("{}::{}", module, m.ident), m, crate_types),
2201 syn::Item::Impl(i) => {
2202 if let &syn::Type::Path(ref p) = &*i.self_ty {
2203 if let Some(trait_path) = i.trait_.as_ref() {
2204 if let Some(tp) = import_resolver.maybe_resolve_path(&trait_path.1, None) {
2205 if let Some(sp) = import_resolver.maybe_resolve_path(&p.path, None) {
2206 match crate_types.trait_impls.entry(sp.clone()) {
2207 hash_map::Entry::Occupied(mut e) => { e.get_mut().push(tp.clone()); },
2208 hash_map::Entry::Vacant(e) => { e.insert(vec![tp.clone()]); },
2210 match crate_types.traits_impld.entry(tp) {
2211 hash_map::Entry::Occupied(mut e) => { e.get_mut().push(sp); },
2212 hash_map::Entry::Vacant(e) => { e.insert(vec![sp]); },
2224 /// Walk the FullLibraryAST, deciding how things will be mapped and adding tracking to CrateTypes.
2225 fn walk_ast_first_pass<'a>(ast_storage: &'a FullLibraryAST, crate_types: &mut CrateTypes<'a>) {
2226 for (module, astmod) in ast_storage.modules.iter() {
2227 let ASTModule { ref attrs, ref items, submods: _ } = astmod;
2228 assert_eq!(export_status(&attrs), ExportStatus::Export);
2229 let orig_crate = module.splitn(2, "::").next().unwrap();
2230 let import_resolver = ImportResolver::new(orig_crate, ast_storage, module, items);
2232 for item in items.iter() {
2234 syn::Item::Struct(s) => {
2235 if let syn::Visibility::Public(_) = s.vis {
2236 let struct_path = format!("{}::{}", module, s.ident);
2237 match export_status(&s.attrs) {
2238 ExportStatus::Export => {},
2239 ExportStatus::NoExport|ExportStatus::TestOnly => {
2240 crate_types.priv_structs.insert(struct_path, &s.generics);
2243 ExportStatus::NotImplementable => panic!("(C-not implementable) must only appear on traits"),
2245 crate_types.opaques.insert(struct_path, (&s.ident, &s.generics));
2248 syn::Item::Trait(t) => {
2249 if let syn::Visibility::Public(_) = t.vis {
2250 match export_status(&t.attrs) {
2251 ExportStatus::Export|ExportStatus::NotImplementable => {},
2252 ExportStatus::NoExport|ExportStatus::TestOnly => continue,
2254 let trait_path = format!("{}::{}", module, t.ident);
2255 walk_supertraits!(t, None, (
2256 ("Clone", _, _) => {
2257 crate_types.set_clonable("crate::".to_owned() + &trait_path);
2261 crate_types.traits.insert(trait_path, &t);
2264 syn::Item::Type(t) => {
2265 if let syn::Visibility::Public(_) = t.vis {
2266 match export_status(&t.attrs) {
2267 ExportStatus::Export => {},
2268 ExportStatus::NoExport|ExportStatus::TestOnly => continue,
2269 ExportStatus::NotImplementable => panic!("(C-not implementable) must only appear on traits"),
2271 let type_path = format!("{}::{}", module, t.ident);
2273 syn::Type::Path(p) => {
2274 // If its a path with no generics, assume we don't map the aliased type and map it opaque
2275 let args_obj = p.path.segments.last().unwrap().arguments.clone();
2276 match crate_types.reverse_alias_map.entry(import_resolver.maybe_resolve_path(&p.path, None).unwrap()) {
2277 hash_map::Entry::Occupied(mut e) => { e.get_mut().push((type_path.clone(), args_obj)); },
2278 hash_map::Entry::Vacant(e) => { e.insert(vec![(type_path.clone(), args_obj)]); },
2281 crate_types.opaques.insert(type_path, (&t.ident, &t.generics));
2284 crate_types.type_aliases.insert(type_path, import_resolver.resolve_imported_refs((*t.ty).clone()));
2289 syn::Item::Enum(e) if is_enum_opaque(e) => {
2290 if let syn::Visibility::Public(_) = e.vis {
2291 match export_status(&e.attrs) {
2292 ExportStatus::Export => {},
2293 ExportStatus::NoExport|ExportStatus::TestOnly => continue,
2294 ExportStatus::NotImplementable => panic!("(C-not implementable) must only appear on traits"),
2296 let enum_path = format!("{}::{}", module, e.ident);
2297 crate_types.opaques.insert(enum_path, (&e.ident, &e.generics));
2300 syn::Item::Enum(e) => {
2301 if let syn::Visibility::Public(_) = e.vis {
2302 match export_status(&e.attrs) {
2303 ExportStatus::Export => {},
2304 ExportStatus::NoExport|ExportStatus::TestOnly => continue,
2305 ExportStatus::NotImplementable => panic!("(C-not implementable) must only appear on traits"),
2307 let enum_path = format!("{}::{}", module, e.ident);
2308 crate_types.mirrored_enums.insert(enum_path, &e);
2311 syn::Item::Impl(i) => {
2312 if let &syn::Type::Path(ref p) = &*i.self_ty {
2313 if let Some(trait_path) = i.trait_.as_ref() {
2314 if path_matches_nongeneric(&trait_path.1, &["core", "clone", "Clone"]) ||
2315 path_matches_nongeneric(&trait_path.1, &["Clone"]) {
2316 if let Some(full_path) = import_resolver.maybe_resolve_path(&p.path, None) {
2317 crate_types.set_clonable("crate::".to_owned() + &full_path);
2320 if let Some(tp) = import_resolver.maybe_resolve_path(&trait_path.1, None) {
2321 if let Some(sp) = import_resolver.maybe_resolve_path(&p.path, None) {
2322 match crate_types.trait_impls.entry(sp.clone()) {
2323 hash_map::Entry::Occupied(mut e) => { e.get_mut().push(tp.clone()); },
2324 hash_map::Entry::Vacant(e) => { e.insert(vec![tp.clone()]); },
2326 match crate_types.traits_impld.entry(tp) {
2327 hash_map::Entry::Occupied(mut e) => { e.get_mut().push(sp); },
2328 hash_map::Entry::Vacant(e) => { e.insert(vec![sp]); },
2335 syn::Item::Mod(m) => walk_private_mod(ast_storage, orig_crate, format!("{}::{}", module, m.ident), m, crate_types),
2343 let args: Vec<String> = env::args().collect();
2344 if args.len() != 5 {
2345 eprintln!("Usage: target/dir derived_templates.rs extra/includes.h extra/cpp/includes.hpp");
2349 let mut derived_templates = std::fs::OpenOptions::new().write(true).create(true).truncate(true)
2350 .open(&args[2]).expect("Unable to open new header file");
2351 writeln!(&mut derived_templates, "{}", DEFAULT_IMPORTS).unwrap();
2352 let mut header_file = std::fs::OpenOptions::new().write(true).create(true).truncate(true)
2353 .open(&args[3]).expect("Unable to open new header file");
2354 let mut cpp_header_file = std::fs::OpenOptions::new().write(true).create(true).truncate(true)
2355 .open(&args[4]).expect("Unable to open new header file");
2357 writeln!(header_file, "#if defined(__GNUC__)").unwrap();
2358 writeln!(header_file, "#define MUST_USE_STRUCT __attribute__((warn_unused))").unwrap();
2359 writeln!(header_file, "#define MUST_USE_RES __attribute__((warn_unused_result))").unwrap();
2360 writeln!(header_file, "#else").unwrap();
2361 writeln!(header_file, "#define MUST_USE_STRUCT").unwrap();
2362 writeln!(header_file, "#define MUST_USE_RES").unwrap();
2363 writeln!(header_file, "#endif").unwrap();
2364 writeln!(header_file, "#if defined(__clang__)").unwrap();
2365 writeln!(header_file, "#define NONNULL_PTR _Nonnull").unwrap();
2366 writeln!(header_file, "#else").unwrap();
2367 writeln!(header_file, "#define NONNULL_PTR").unwrap();
2368 writeln!(header_file, "#endif").unwrap();
2369 writeln!(cpp_header_file, "#include <string.h>\nnamespace LDK {{").unwrap();
2371 // Write a few manually-defined types into the C++ header file
2372 write_cpp_wrapper(&mut cpp_header_file, "Str", true, None);
2374 // First parse the full crate's ASTs, caching them so that we can hold references to the AST
2375 // objects in other datastructures:
2376 let mut lib_src = String::new();
2377 std::io::stdin().lock().read_to_string(&mut lib_src).unwrap();
2378 let lib_syntax = syn::parse_file(&lib_src).expect("Unable to parse file");
2379 let libast = FullLibraryAST::load_lib(lib_syntax);
2381 // ...then walk the ASTs tracking what types we will map, and how, so that we can resolve them
2382 // when parsing other file ASTs...
2383 let mut libtypes = CrateTypes::new(&mut derived_templates, &libast);
2384 walk_ast_first_pass(&libast, &mut libtypes);
2386 // ... using the generated data, determine a few additional fields, specifically which type
2387 // aliases are to be clone-able...
2388 walk_ast_second_pass(&libast, &libtypes);
2390 // ... finally, do the actual file conversion/mapping, writing out types as we go.
2391 convert_file(&libast, &libtypes, &args[1], &mut header_file, &mut cpp_header_file);
2393 // For container templates which we created while walking the crate, make sure we add C++
2394 // mapped types so that C++ users can utilize the auto-destructors available.
2395 for (ty, has_destructor) in libtypes.templates_defined.borrow().iter() {
2396 write_cpp_wrapper(&mut cpp_header_file, ty, *has_destructor, None);
2398 writeln!(cpp_header_file, "}}").unwrap();
2400 header_file.flush().unwrap();
2401 cpp_header_file.flush().unwrap();
2402 derived_templates.flush().unwrap();